twitter-openapi-typescript-generated 0.0.1 → 0.0.3

package/twitter-openapi/tools/build_config.py

@@ -0,0 +1,200 @@
+from hooks import *
+
+
+class Config:
+    OUTPUT_DIR = "dist/{0}"
+    INPUT_DIR = "src/openapi"
+
+    def main(self):
+        return {
+            "docs": {
+                "openapi": [AddSecuritySchemesOnSecuritySchemes()],
+                "schemas": [],
+                "other":[],
+                "request": {
+                    key: [
+                        ReplaceQueryIdPlaceholder(split=-1),
+                        SetResponsesHeader(suffix=None),
+                        AddParametersOnContent(
+                            split=-1, contentType="application/json"
+                        ),
+                    ]
+                    for key in ["default", "user", "user-list", "tweet"]
+                }
+                | {
+                    key: [
+                        ReplaceQueryIdPlaceholder(split=-1),
+                        SetResponsesHeader(suffix=None),
+                        AddParametersOnParameters(
+                            split=-1,
+                            schemaType=None,
+                        ),
+                    ]
+                    for key in ["post"]
+                }
+                | {
+                    key: [
+                        SetResponsesHeader(suffix="legacy"),
+                        AddParametersOnParameters(
+                            split=2,
+                            schemaType=None,
+                        ),
+                    ]
+                    for key in ["v1.1-get", "v2.0-get"]
+                }
+                | {
+                    key: [
+                        SetResponsesHeader(suffix="legacy"),
+                        AddParametersOnBody(
+                            split=2,
+                            schemaType=None,
+                            contentType="application/x-www-form-urlencoded",
+                        ),
+                    ]
+                    for key in ["v1.1-post", "v2.0-post"]
+                }
+                | {"other": []},
+            },
+            "dart": {
+                "openapi": [],
+                "schemas": [],
+                "other":[],
+                "request": {
+                    key: [
+                        ReplaceQueryIdPlaceholder(split=-1),
+                        AddSecuritySchemesOnHeader(split=-1),
+                        SetResponsesHeader(suffix=None),
+                        AddParametersOnParameters(
+                            split=-1,
+                            schemaType="string",
+                        ),
+                    ]
+                    for key in ["default", "user", "user-list", "tweet"]
+                }
+                | {
+                    key: [
+                        ReplaceQueryIdPlaceholder(split=-1),
+                        AddSecuritySchemesOnHeader(split=-1),
+                        SetResponsesHeader(suffix=None),
+                        AddParametersOnBody(
+                            split=-1,
+                            schemaType=None,
+                            contentType="application/json",
+                        ),
+                    ]
+                    for key in ["post"]
+                }
+                | {
+                    key: [
+                        SetResponsesHeader(suffix="legacy"),
+                        AddSecuritySchemesOnHeader(split=-1),
+                        AddParametersOnParameters(
+                            split=2,
+                            schemaType=None,
+                        ),
+                    ]
+                    for key in ["v1.1-get", "v2.0-get"]
+                }
+                | {
+                    key: [
+                        SetResponsesHeader(suffix="legacy"),
+                        AddSecuritySchemesOnHeader(split=-1),
+                        AddParametersOnBody(
+                            split=2,
+                            schemaType=None,
+                            contentType="application/x-www-form-urlencoded",
+                        ),
+                    ]
+                    for key in ["v1.1-post", "v2.0-post"]
+                }
+                | {"other": []},
+            },
+            "typescript": {
+                "openapi": [AddSecuritySchemesOnSecuritySchemes()],
+                "schemas": [],
+                "other":[],
+                "request": {
+                    key: [
+                        ReplaceQueryIdPlaceholder(split=-1),
+                        SetResponsesHeader(suffix=None),
+                        AddParametersOnParameters(
+                            split=-1,
+                            schemaType="string",
+                        ),
+                    ]
+                    for key in ["default", "user", "user-list", "tweet"]
+                }
+                | {
+                    key: [
+                        ReplaceQueryIdPlaceholder(split=-1),
+                        SetResponsesHeader(suffix=None),
+                        AddParametersOnBody(
+                            split=-1,
+                            schemaType=None,
+                            contentType="application/json",
+                        ),
+                    ]
+                    for key in ["post"]
+                }
+                | {
+                    key: [
+                        SetResponsesHeader(suffix="legacy"),
+                        AddParametersOnParameters(
+                            split=2,
+                            schemaType=None,
+                        ),
+                    ]
+                    for key in ["v1.1-get", "v2.0-get"]
+                }
+                | {
+                    key: [
+                        SetResponsesHeader(suffix="legacy"),
+                        AddParametersOnBody(
+                            split=2,
+                            schemaType=None,
+                            contentType="application/x-www-form-urlencoded",
+                        ),
+                    ]
+                    for key in ["v1.1-post", "v2.0-post"]
+                }
+                | {"other": []},
+            },
+            "test": {
+                "openapi": [AddSecuritySchemesOnSecuritySchemes()],
+                "schemas": [],
+                "other":[],
+                "request": {
+                    key: [
+                        ReplaceQueryIdPlaceholder(split=-1),
+                        SetResponsesHeader(suffix=None),
+                        AddParametersOnParameters(
+                            split=-1,
+                            schemaType="string",
+                        ),
+                    ]
+                    for key in ["default", "user", "user-list", "tweet"]
+                }
+                | {
+                    key: [
+                        ReplaceQueryIdPlaceholder(split=-1),
+                        SetResponsesHeader(suffix=None),
+                        AddParametersOnParameters(
+                            split=-1,
+                            schemaType="string",
+                        ),
+                    ]
+                    for key in ["post"]
+                }
+                | {
+                    key: [
+                        SetResponsesHeader(suffix="legacy"),
+                        AddParametersOnParameters(
+                            split=2,
+                            schemaType="object",
+                        ),
+                    ]
+                    for key in ["v1.1-get", "v1.1-post", "v2.0-get", "v2.0-post"]
+                }
+                | {"other": []},
+            },
+        }

package/twitter-openapi/tools/hooks.py

@@ -0,0 +1,265 @@
+import yaml
+import json
+
+
+class HookBase:
+    PLACEHOLDER: dict
+
+    def __init__(self):
+        with open("src/config/placeholder.json", mode="r", encoding="utf-8") as f:
+            self.PLACEHOLDER = json.load(f)
+
+    def placeholder_to_yaml(self, obj, default=False, example=False) -> dict:
+        fn = lambda x: self.placeholder_to_yaml(x, default=default, example=example)
+        if type(obj) is dict:
+            properties = {i: fn(obj[i]) for i in obj}
+            value = {
+                "type": "object",
+                "properties": properties,
+            }
+            value.update({"required": [i for i in obj]} if len(obj) > 0 else {})
+            value.update({"default": properties} if default else {})
+            value.update({"example": properties} if example else {})
+            return value
+        elif type(obj) is list and len(obj) > 0:
+            properties = fn(obj[0])
+            value = {
+                "type": "array",
+                "items": properties,
+            }
+            value.update({"default": [properties]} if default else {})
+            value.update({"example": [properties]} if example else {})
+            return value
+        elif type(obj) is list and len(obj) == 0:
+            value = {
+                "type": "array",
+                "items": {"type": "object"},
+            }
+            value.update({"default": []} if default else {})
+            value.update({"example": []} if example else {})
+            return value
+        elif type(obj) is str:
+            return {"type": "string", "example": obj, "default": obj}
+        elif type(obj) is bool:
+            return {"type": "boolean", "example": obj, "default": obj}
+        elif type(obj) is int:
+            return {"type": "integer", "example": obj, "default": obj}
+
+    def load_component(self, name: str) -> dict:
+        with open(f"src/config/component/{name}.yaml", mode="r", encoding="utf-8") as f:
+            return yaml.safe_load(f)
+
+    def load_placeholder(self) -> dict:
+        with open("src/config/placeholder.json", mode="r", encoding="utf-8") as f:
+            return yaml.safe_load(f)
+
+
+# HookBase extends
+
+
+class OpenapiHookBase(HookBase):
+    def hook(self, value: dict)->dict:
+        return value
+
+class OtherHookBase(HookBase):
+    def hook(self)->tuple[str, dict]:
+        return  "", {}
+
+class SchemasHookBase(HookBase):
+    def hook(self, value: dict)->dict:
+        return value
+
+
+class RequestHookBase(HookBase):
+    split: int
+    path_name: str
+
+    def __init__(self, split=1):
+        super().__init__()
+        self.split = split
+
+    def hook(self, path: str, value: dict)->tuple[str, dict]:
+        value["parameters"] = value.get("parameters", [])
+        self.path_name = "/".join(path.split("/")[self.split :])
+        return path, value
+
+
+# OpenapiHookBase extends
+
+
+class AddSecuritySchemesOnSecuritySchemes(OpenapiHookBase):
+    def hook(self, value: dict):
+        value = super().hook(value)
+        component = self.load_component("security_schemes")
+        param = component["components"]["securitySchemes"]
+        value["components"]["securitySchemes"].update(param)
+        value["security"].extend(component["security"])
+        return value
+
+
+# SchemasHookBase extends
+
+
+class RemoveDiscriminator(SchemasHookBase):
+    def hook(self, value: dict):
+        if value.get("discriminator") is not None:
+            del value["discriminator"]
+        return value
+
+
+# RequestHookBase extends
+
+
+class AddSecuritySchemesOnHeader(RequestHookBase):
+    def hook(self, path: str, value: dict):
+        path, value = super().hook(path, value)
+        component = self.load_component("security_schemes")
+        param = component["paths"]["/parameters"]["get"]["parameters"]
+        value["parameters"].extend(param)
+        return path, value
+
+
+class ReplaceQueryIdPlaceholder(RequestHookBase):
+    def hook(self, path: str, value: dict):
+        path, value = super().hook(path, value)
+        new = self.PLACEHOLDER[self.path_name]["queryId"]
+        return path.replace(r"{{queryId}}", new), value
+
+
+class SetResponsesHeader(RequestHookBase):
+    suffix: str
+
+    def __init__(self, suffix: str | None = None):
+        super().__init__()
+        self.suffix = "" if suffix is None else "_" + suffix
+
+    def hook(self, path: str, value: dict):
+        path, value = super().hook(path, value)
+        component = self.load_component("response_header" + self.suffix)
+        value["responses"]["200"]["headers"] = component["components"]["headers"]
+        return path, value
+
+
+# OnParameters
+
+
+class AddParametersOnParameters(RequestHookBase):
+    schemaType: str | None
+
+    def __init__(self, split: str = 1, schemaType: str | None = None):
+        super().__init__(split=split)
+        self.schemaType = schemaType
+
+    def hook(self, path: str, value: dict):
+        path, value = super().hook(path, value)
+        data = self.PLACEHOLDER[self.path_name]
+        for key in data.keys():
+            if self.schemaType == "string":
+                example = json.dumps(data[key])
+                schema = {
+                    "type": "string",
+                    "default": example,
+                    "example": example,
+                }
+            elif self.schemaType == "object":
+                example = json.dumps(data[key])
+                schema = {
+                    "type": "object",
+                    "default": example,
+                    "example": example,
+                }
+            else:
+                schema = self.placeholder_to_yaml(data[key])
+            value["parameters"].append(
+                {
+                    "name": key,
+                    "in": "query",
+                    "required": True,
+                    "schema": schema,
+                }
+            )
+        return path, value
+
+
+# OnBody
+
+
+class AddParametersOnBody(RequestHookBase):
+    schemaType: str | None
+    contentType: str | None
+
+    def __init__(
+        self,
+        split: str = 1,
+        contentType: str = "application/json",
+        schemaType: str | None = None,
+    ):
+        super().__init__(split)
+        self.schemaType = schemaType
+        self.contentType = contentType
+
+    def hook(self, path: str, value: dict):
+        path, value = super().hook(path, value)
+        data = self.PLACEHOLDER[self.path_name]
+
+        if self.schemaType == "string":
+            example = json.dumps(data)
+            schema = {
+                "type": "string",
+                "default": example,
+                "example": example,
+            }
+        elif self.schemaType == "object":
+            example = json.dumps(data)
+            schema = {
+                "type": "object",
+                "default": example,
+                "example": example,
+            }
+        else:
+            schema = {
+                "properties": {
+                    i: self.placeholder_to_yaml(data[i]) for i in data.keys()
+                },
+                "required": [i for i in data.keys()],
+            }
+        value["requestBody"] = {
+            "description": "body",
+            "required": True,
+            "content": {
+                self.contentType: {
+                    "schema": schema,
+                }
+            },
+        }
+        return path, value
+
+
+# OnContent
+
+
+class AddParametersOnContent(RequestHookBase):
+    contentType: str
+
+    def __init__(self, split: str = 1, contentType: str = "application/json"):
+        super().__init__(split=split)
+        self.contentType = contentType
+
+    def hook(self, path: str, value: dict):
+        path, value = super().hook(path, value)
+        data = self.PLACEHOLDER[self.path_name]
+        for key in data.keys():
+            value["parameters"].append(
+                {
+                    "name": key,
+                    "in": "query",
+                    "required": True,
+                    "content": {
+                        self.contentType: {
+                            "schema": self.placeholder_to_yaml(data[key]),
+                            "required": [i for i in data[key]],
+                        }
+                    },
+                }
+            )
+        return path, value