[DOCUMENTATION]: Environment Variables

Author: amadolid

README.md

@@ -11,6 +11,4 @@ pre-commit install
 ```
 # **REFERENCES**
 ### [**Jaseci**](./docs/Jaseci.md)
-### [**Jaseci**](./docs/Jaseci.md)
-### [**Jaseci**](./docs/Jaseci.md)
-### [**Jaseci**](./docs/Jaseci.md)
+### [**Environment Variables**](./docs/Environment-Variables.md)

docs/Environment-Variables.md

@@ -0,0 +1,63 @@
+[<< back to main](../README.md)
+# **Supported Environment Variable**
+
+| **NAME**  | **DESCRIPTION**   | **DEFAULT**   |
+|-----------|-------------------|---------------|
+| HOST      | FastAPI's host argument | 0.0.0.0 |
+| PORT      | FastAPI's port argument | 8000    |
+| DATABASE_HOST | MongoDB connection string | mongodb://localhost/?retryWrites=true&w=majority |
+| DATABASE_NAME | MongoDB database name | jaseci |
+| REDIS_HOST | Redis connection host | redis://localhost |
+| REDIS_PORT | Redis connection port | 6379     |
+| REDIS_USER | Redis connection username | null |
+| REDIS_PASS | Redis connection password | null |
+| DISABLE_AUTO_CLEANUP | Disable auto deletion of nodes that doesn't connect to anything | false |
+| SINGLE_QUERY | Every edge_ref will trigger query per anchor if not already cached instead of consolidating non cached anchor before querying. | false |
+| SESSION_MAX_TRANSACTION_RETRY | MongoDB's transactional retry | 1 |
+| DISABLE_AUTO_ENDPOINT | Disable auto convertion of walker to api. It will now require inner class __specs__ or @specs decorator. | false |
+| SHOW_ENDPOINT_RETURNS | Include per visit return on api response | false |
+| SESSION_MAX_COMMIT_RETRY | MongoDB's transaction commit retry | 1 |
+| RESTRICT_UNVERIFIED_USER | Rstrict user's login until it has verified | false |
+| TOKEN_SECRET | Random string used to encrypt token | 50 random characters |
+| TOKEN_ALGORITHM | Algorithm used to encrypt token | HS256 |
+| TOKEN_TIMEOUT | Token expiration in hours | 12 |
+| VERIFICATION_CODE_TIMEOUT | Verification code expiration in hours | 24 |
+| RESET_CODE_TIMEOUT | Password reset code expiration in hours | 24 |
+| SENDGRID_HOST | Sendgrid host used for hyperlinking verification/reset code | http://localhost:8000 |
+| SENDGRID_API_KEY | Sendgrid api key | null    |
+
+# **SSO Supported Enviroment Variable**
+## Supported Platform
+ - APPLE
+ - FACEBOOK
+ - FITBIT
+ - GITHUB
+ - GITLAB
+ - GOOGLE
+ - KAKAO
+ - LINE
+ - LINKEDIN
+ - MICROSOFT
+ - NAVER
+ - NOTION
+ - TWITTER
+ - YANDEX
+
+| **NAME**  | **DESCRIPTION**   |
+|-----------|-------------------|
+| SSO_`{PLATFORM}`_CLIENT_ID | platform's client id |
+| SSO_`{PLATFORM}`_CLIENT_SECRET | platform's client secret |
+| SSO_`{PLATFORM}`_ALLOW_INSECURE_HTTP | set if platform allow insecure http connection |
+| SSO_GITLAB_BASE_ENDPOINT_URL | gitlab base endpoint url |
+| SSO_MICROSOFT_TENANT | microsoft tenant |
+
+## Apple Client Secret Auto Generation
+- for certificate: Just use either SSO_APPLE_CLIENT_CERTIFICATE_PATH or SSO_APPLE_CLIENT_CERTIFICATE
+
+| **NAME**  | **DESCRIPTION**   |
+|-----------|-------------------|
+| SSO_APPLE_CLIENT_ID | apple's client id |
+| SSO_APPLE_CLIENT_TEAM_ID | apple's client team id |
+| SSO_APPLE_CLIENT_KEY | apple's client key |
+| SSO_APPLE_CLIENT_CERTIFICATE_PATH | apple's client certificate path |
+| SSO_APPLE_CLIENT_CERTIFICATE | apple's client certificate raw content |

docs/Jaseci.md

@@ -145,4 +145,25 @@ with entry:__main__ {
         port=8001
     );
 }
+```
+
+## **Walker Response Structure**
+- Response support auto serialization of walker/edge/node architypes and obj as long as it's attributes is also serializable (ex: nested dataclass)
+
+```python
+{
+    "status": {{ int : http status code }},
+    "reports": {{ list : jac reports }},
+
+    # optional via SHOW_ENDPOINT_RETURNS=true environment variable
+    "returns" {{ list : jac per visit return }}
+}
+```
+
+## **Walker/Edge/Node Serialization**
+```python
+{
+    "id": {{ str : anchor ref_id }},
+    "context": {{ dict : anchor architype data }}
+}
 ```

jaclang_jaseci/core/architype.py

@@ -80,7 +80,7 @@ class BulkWrite:
     """Bulk Write builder."""
 
     SESSION_MAX_TRANSACTION_RETRY: ClassVar[int] = int(
-        getenv("SESSION_TRANSACTION_MAX_RETRY") or "1"
+        getenv("SESSION_MAX_TRANSACTION_RETRY") or "1"
     )
     SESSION_MAX_COMMIT_RETRY: ClassVar[int] = int(
         getenv("SESSION_MAX_COMMIT_RETRY") or "1"

jaclang_jaseci/jaseci/routers/sso.py

@@ -58,19 +58,19 @@
 SSO_HOST = getenv("SSO_HOST", "http://localhost:8000/sso")
 
 for platform, cls in SUPPORTED_PLATFORMS.items():
-    if client_id := getenv(f"{platform}_CLIENT_ID"):
+    if client_id := getenv(f"SSO_{platform}_CLIENT_ID"):
         options: dict[str, Any] = {
             "client_id": client_id,
-            "client_secret": getenv(f"{platform}_CLIENT_SECRET"),
+            "client_secret": getenv(f"SSO_{platform}_CLIENT_SECRET"),
         }
 
-        if base_endpoint_url := getenv(f"{platform}_BASE_ENDPOINT_URL"):
+        if base_endpoint_url := getenv(f"SSO_{platform}_BASE_ENDPOINT_URL"):
             options["base_endpoint_url"] = base_endpoint_url
 
-        if tenant := getenv(f"{platform}_TENANT"):
+        if tenant := getenv(f"SSO_{platform}_TENANT"):
             options["tenant"] = tenant
 
-        if allow_insecure_http := getenv(f"{platform}_ALLOW_INSECURE_HTTP"):
+        if allow_insecure_http := getenv(f"SSO_{platform}_ALLOW_INSECURE_HTTP"):
             options["allow_insecure_http"] = allow_insecure_http == "true"
 
         if cls in CUSTOM_PLATFORMS:

jaclang_jaseci/jaseci/sso/apple.py

@@ -45,16 +45,20 @@ def __init__(
         """Apple SSO init."""
         if not client_secret:
             if (
-                (client_team_id := getenv(f"{platform}_CLIENT_TEAM_ID"))
-                and (client_team_id := getenv(f"{platform}_CLIENT_TEAM_ID"))
-                and (client_key := getenv(f"{platform}_CLIENT_KEY"))
+                (client_team_id := getenv(f"SSO_{platform}_CLIENT_TEAM_ID"))
+                and (client_team_id := getenv(f"SSO_{platform}_CLIENT_TEAM_ID"))
+                and (client_key := getenv(f"SSO_{platform}_CLIENT_KEY"))
                 and (
                     (
                         client_certificate_path := getenv(
-                            f"{platform}_CLIENT_CERTIFICATE_PATH"
+                            f"SSO_{platform}_CLIENT_CERTIFICATE_PATH"
+                        )
+                    )
+                    or (
+                        client_certificate := getenv(
+                            f"SSO_{platform}_CLIENT_CERTIFICATE"
                         )
                     )
-                    or (client_certificate := getenv(f"{platform}_CLIENT_CERTIFICATE"))
                 )
             ):
                 self.client_team_id = client_team_id
@@ -65,10 +69,10 @@ def __init__(
                 self.client_certificate = client_certificate
             else:
                 raise AttributeError(
-                    f"Please provide {platform}_CLIENT_SECRET or all required fields to auto generate secret!\n"
-                    f"{platform}_CLIENT_TEAM_ID\n"
-                    f"{platform}_CLIENT_KEY\n"
-                    f"{platform}_CLIENT_CERTIFICATE_PATH or {platform}_CLIENT_CERTIFICATE"
+                    f"Please provide SSO_{platform}_CLIENT_SECRET or all required fields to auto generate secret!\n"
+                    f"SSO_{platform}_CLIENT_TEAM_ID\n"
+                    f"SSO_{platform}_CLIENT_KEY\n"
+                    f"SSO_{platform}_CLIENT_CERTIFICATE_PATH or SSO_{platform}_CLIENT_CERTIFICATE"
                 )
 
         super().__init__(

jaclang_jaseci/jaseci/utils/mail.py

@@ -60,7 +60,7 @@ def send_reset_code(cls, code: str, email: str) -> None:
 class SendGridEmailer(Emailer):
     """SendGrid Handler."""
 
-    __host__: str = getenv("HOST") or "http://localhost:8000"
+    __host__: str = getenv("SENDGRID_HOST") or "http://localhost:8000"
 
     @classmethod
     def generate_client(cls) -> SendGridAPIClient | None: