twitter-openapi-typescript-generated 0.0.6 → 0.0.8

package/twitter-openapi/tools/build_config.py

@@ -5,196 +5,73 @@ class Config:
     OUTPUT_DIR = "dist/{0}"
     INPUT_DIR = "src/openapi"
 
+    def hooks_generator(self, queryParameterJson=True):
+        # https://stackoverflow.com/questions/34820064/defining-an-api-with-swagger-get-call-that-uses-json-in-parameters/45223964
+        if queryParameterJson:
+            getParamHook = AddParametersOnContent(
+                split=-1,
+                contentType="application/json",
+                ignoreKeys=["queryId"],
+            )
+            postParamHook = AddParametersOnParameters(
+                split=-1,
+                schemaType=None,
+            )
+        else:
+            getParamHook = AddParametersOnParameters(
+                split=-1,
+                schemaType="string",
+                ignoreKeys=["queryId"],
+            )
+            postParamHook = AddParametersOnBody(
+                split=-1,
+                schemaType=None,
+                contentType="application/json",
+            )
+
+        return {
+            "openapi": [AddSecuritySchemesOnSecuritySchemes()],
+            "schemas": [],
+            "other": [],
+            "request": {
+                key: [
+                    SetResponsesHeader(suffix=None),
+                    AddPathQueryIdOnParameters(split=-1),
+                    getParamHook,
+                ]
+                for key in ["default", "user", "user-list", "tweet"]
+            }
+            | {
+                key: [
+                    SetResponsesHeader(suffix=None),
+                    AddPathQueryIdOnParameters(split=-1),
+                    postParamHook,
+                ]
+                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": []},
+        }
+
     def main(self):
         return {
-            "docs": {
-                "openapi": [AddSecuritySchemesOnSecuritySchemes()],
-                "schemas": [],
-                "other": [],
-                "request": {
-                    key: [
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        AddParametersOnContent(
-                            split=-1, contentType="application/json"
-                        ),
-                    ]
-                    for key in ["default", "user", "user-list", "tweet"]
-                }
-                | {
-                    key: [
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        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: [
-                        AddSecuritySchemesOnHeader(split=-1),
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        AddParametersOnParameters(
-                            split=-1,
-                            schemaType="string",
-                        ),
-                    ]
-                    for key in ["default", "user", "user-list", "tweet"]
-                }
-                | {
-                    key: [
-                        AddSecuritySchemesOnHeader(split=-1),
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        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: [
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        AddParametersOnParameters(
-                            split=-1,
-                            schemaType="string",
-                        ),
-                    ]
-                    for key in ["default", "user", "user-list", "tweet"]
-                }
-                | {
-                    key: [
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        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: [
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        AddParametersOnParameters(
-                            split=-1,
-                            schemaType="string",
-                        ),
-                    ]
-                    for key in ["default", "user", "user-list", "tweet"]
-                }
-                | {
-                    key: [
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        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": []},
-            },
+            "docs": self.hooks_generator(),
+            "compatible": self.hooks_generator(queryParameterJson=False),
         }

package/twitter-openapi/tools/hooks.py

@@ -169,24 +169,33 @@ class AddPathQueryIdOnParameters(RequestHookBase):
 
 class AddParametersOnParameters(RequestHookBase):
     schemaType: str | None
+    ignoreKeys: list[str]
 
-    def __init__(self, split: str = 1, schemaType: str | None = None):
+    def __init__(
+        self,
+        split: str = 1,
+        schemaType: str | None = None,
+        ignoreKeys: list[str] | None = None,
+    ):
         super().__init__(split=split)
         self.schemaType = schemaType
+        self.ignoreKeys = ignoreKeys or []
 
     def hook(self, path: str, value: dict):
         path, value = super().hook(path, value)
         data = self.PLACEHOLDER[self.path_name]
+        data = {key: data[key] for key in data.keys() if key not in self.ignoreKeys}
+
         for key in data.keys():
             if self.schemaType == "string":
-                example = json.dumps(data[key])
+                example = data[key] if type(data[key]) is str else json.dumps(data[key])
                 schema = {
                     "type": "string",
                     "default": example,
                     "example": example,
                 }
             elif self.schemaType == "object":
-                example = json.dumps(data[key])
+                example = data[key] if type(data[key]) is str else json.dumps(data[key])
                 schema = {
                     "type": "object",
                     "default": example,
@@ -211,30 +220,34 @@ class AddParametersOnParameters(RequestHookBase):
 class AddParametersOnBody(RequestHookBase):
     schemaType: str | None
     contentType: str | None
+    ignoreKeys: list[str]
 
     def __init__(
         self,
         split: str = 1,
         contentType: str = "application/json",
         schemaType: str | None = None,
+        ignoreKeys: list[str] | None = None,
     ):
         super().__init__(split)
         self.schemaType = schemaType
         self.contentType = contentType
+        self.ignoreKeys = ignoreKeys or []
 
     def hook(self, path: str, value: dict):
         path, value = super().hook(path, value)
         data = self.PLACEHOLDER[self.path_name]
+        data = {key: data[key] for key in data.keys() if key not in self.ignoreKeys}
 
         if self.schemaType == "string":
-            example = json.dumps(data)
+            example = data if type(data) is str else json.dumps(data)
             schema = {
                 "type": "string",
                 "default": example,
                 "example": example,
             }
         elif self.schemaType == "object":
-            example = json.dumps(data)
+            example = data if type(data) is str else json.dumps(data)
             schema = {
                 "type": "object",
                 "default": example,
@@ -264,14 +277,23 @@ class AddParametersOnBody(RequestHookBase):
 
 class AddParametersOnContent(RequestHookBase):
     contentType: str
+    ignoreKeys: list[str]
 
-    def __init__(self, split: str = 1, contentType: str = "application/json"):
+    def __init__(
+        self,
+        split: str = 1,
+        contentType: str = "application/json",
+        ignoreKeys: list[str] | None = None,
+    ):
         super().__init__(split=split)
         self.contentType = contentType
+        self.ignoreKeys = ignoreKeys or []
 
     def hook(self, path: str, value: dict):
         path, value = super().hook(path, value)
         data = self.PLACEHOLDER[self.path_name]
+        data = {key: data[key] for key in data.keys() if key not in self.ignoreKeys}
+
         for key in data.keys():
             value["parameters"].append(
                 {
@@ -281,7 +303,6 @@ class AddParametersOnContent(RequestHookBase):
                     "content": {
                         self.contentType: {
                             "schema": self.placeholder_to_yaml(data[key]),
-                            "required": [i for i in data[key]],
                         }
                     },
                 }

package/dist/models/ListTweetsTimelineResponse.d.ts

@@ -1,33 +0,0 @@
-/**
- * Twitter OpenAPI
- * Twitter OpenAPI(Swagger) specification
- *
- * The version of the OpenAPI document: 0.0.1
- * Contact: yuki@yuki0311.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { ListTweetsTimelineData } from './ListTweetsTimelineData';
-/**
- *
- * @export
- * @interface ListTweetsTimelineResponse
- */
-export interface ListTweetsTimelineResponse {
-    /**
-     *
-     * @type {ListTweetsTimelineData}
-     * @memberof ListTweetsTimelineResponse
-     */
-    data: ListTweetsTimelineData;
-}
-/**
- * Check if a given object implements the ListTweetsTimelineResponse interface.
- */
-export declare function instanceOfListTweetsTimelineResponse(value: object): boolean;
-export declare function ListTweetsTimelineResponseFromJSON(json: any): ListTweetsTimelineResponse;
-export declare function ListTweetsTimelineResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListTweetsTimelineResponse;
-export declare function ListTweetsTimelineResponseToJSON(value?: ListTweetsTimelineResponse | null): any;
-//# sourceMappingURL=ListTweetsTimelineResponse.d.ts.map

package/dist/models/ListTweetsTimelineResponse.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ListTweetsTimelineResponse.d.ts","sourceRoot":"","sources":["../../src/models/ListTweetsTimelineResponse.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAOvE;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACvC;;;;OAIG;IACH,IAAI,EAAE,sBAAsB,CAAC;CAChC;AAED;;GAEG;AACH,wBAAgB,oCAAoC,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAK3E;AAED,wBAAgB,kCAAkC,CAAC,IAAI,EAAE,GAAG,GAAG,0BAA0B,CAExF;AAED,wBAAgB,uCAAuC,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,0BAA0B,CAQ3H;AAED,wBAAgB,gCAAgC,CAAC,KAAK,CAAC,EAAE,0BAA0B,GAAG,IAAI,GAAG,GAAG,CAW/F"}

package/dist/models/ListTweetsTimelineResponse.js

@@ -1,52 +0,0 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Twitter OpenAPI
- * Twitter OpenAPI(Swagger) specification
- *
- * The version of the OpenAPI document: 0.0.1
- * Contact: yuki@yuki0311.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListTweetsTimelineResponseToJSON = exports.ListTweetsTimelineResponseFromJSONTyped = exports.ListTweetsTimelineResponseFromJSON = exports.instanceOfListTweetsTimelineResponse = void 0;
-var ListTweetsTimelineData_1 = require("./ListTweetsTimelineData");
-/**
- * Check if a given object implements the ListTweetsTimelineResponse interface.
- */
-function instanceOfListTweetsTimelineResponse(value) {
-    var isInstance = true;
-    isInstance = isInstance && "data" in value;
-    return isInstance;
-}
-exports.instanceOfListTweetsTimelineResponse = instanceOfListTweetsTimelineResponse;
-function ListTweetsTimelineResponseFromJSON(json) {
-    return ListTweetsTimelineResponseFromJSONTyped(json, false);
-}
-exports.ListTweetsTimelineResponseFromJSON = ListTweetsTimelineResponseFromJSON;
-function ListTweetsTimelineResponseFromJSONTyped(json, ignoreDiscriminator) {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        'data': (0, ListTweetsTimelineData_1.ListTweetsTimelineDataFromJSON)(json['data']),
-    };
-}
-exports.ListTweetsTimelineResponseFromJSONTyped = ListTweetsTimelineResponseFromJSONTyped;
-function ListTweetsTimelineResponseToJSON(value) {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        'data': (0, ListTweetsTimelineData_1.ListTweetsTimelineDataToJSON)(value.data),
-    };
-}
-exports.ListTweetsTimelineResponseToJSON = ListTweetsTimelineResponseToJSON;
-//# sourceMappingURL=ListTweetsTimelineResponse.js.map

package/dist/models/ListTweetsTimelineResponse.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ListTweetsTimelineResponse.js","sourceRoot":"","sources":["../../src/models/ListTweetsTimelineResponse.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAIH,mEAIkC;AAgBlC;;GAEG;AACH,SAAgB,oCAAoC,CAAC,KAAa;IAC9D,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,UAAU,GAAG,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC;IAE3C,OAAO,UAAU,CAAC;AACtB,CAAC;AALD,oFAKC;AAED,SAAgB,kCAAkC,CAAC,IAAS;IACxD,OAAO,uCAAuC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAChE,CAAC;AAFD,gFAEC;AAED,SAAgB,uCAAuC,CAAC,IAAS,EAAE,mBAA4B;IAC3F,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE;QACzC,OAAO,IAAI,CAAC;KACf;IACD,OAAO;QAEH,MAAM,EAAE,IAAA,uDAA8B,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KACvD,CAAC;AACN,CAAC;AARD,0FAQC;AAED,SAAgB,gCAAgC,CAAC,KAAyC;IACtF,IAAI,KAAK,KAAK,SAAS,EAAE;QACrB,OAAO,SAAS,CAAC;KACpB;IACD,IAAI,KAAK,KAAK,IAAI,EAAE;QAChB,OAAO,IAAI,CAAC;KACf;IACD,OAAO;QAEH,MAAM,EAAE,IAAA,qDAA4B,EAAC,KAAK,CAAC,IAAI,CAAC;KACnD,CAAC;AACN,CAAC;AAXD,4EAWC"}

package/twitter-openapi/dist/dart/openapi-3.0.yaml

@@ -1,117 +0,0 @@
-components:
-  schemas: {}
-  securitySchemes:
-    AuthType:
-      description: OAuth2Session if you are logged in
-      in: header
-      name: x-twitter-auth-type
-      type: apiKey
-    CookieAuthToken:
-      description: HttpOnly cookie
-      in: cookie
-      name: auth_token
-      type: apiKey
-    CookieCt0:
-      description: document.cookie.split('; ').find(row => row.startsWith('ct0='));
-      in: cookie
-      name: ct0
-      type: apiKey
-    CsrfToken:
-      description: ''
-      in: header
-      name: x-csrf-token
-      type: apiKey
-    GuestToken:
-      description: document.cookie.split('; ').find(row => row.startsWith('gt='));
-      in: header
-      name: x-guest-token
-      type: apiKey
-info:
-  contact:
-    email: yuki@yuki0311.com
-  description: Twitter OpenAPI(Swagger) specification
-  license:
-    name: GNU Affero General Public License v3.
-    url: https://raw.githubusercontent.com/fa0311/twitter-openapi/main/LICENSE.txt
-  termsOfService: https://github.com/fa0311
-  title: Twitter OpenAPI
-  version: 0.0.1
-openapi: 3.0.3
-paths:
-  /1.1/friends/following/list.json:
-    $ref: ./paths/v1.1-get.yaml#/paths/~11.1~1friends~1following~1list.json
-  /1.1/friendships/create.json:
-    $ref: ./paths/v1.1-post.yaml#/paths/~11.1~1friendships~1create.json
-  /1.1/friendships/destroy.json:
-    $ref: ./paths/v1.1-post.yaml#/paths/~11.1~1friendships~1destroy.json
-  /1.1/search/typeahead.json:
-    $ref: ./paths/v1.1-get.yaml#/paths/~11.1~1search~1typeahead.json
-  /2/search/adaptive.json:
-    $ref: ./paths/v2.0-get.yaml#/paths/~12~1search~1adaptive.json
-  /graphql/{pathQueryId}/Bookmarks:
-    $ref: ./paths/bookmarks.yaml#/paths/~1graphql~1{pathQueryId}~1Bookmarks
-  /graphql/{pathQueryId}/CreateRetweet:
-    $ref: ./paths/post.yaml#/paths/~1graphql~1{pathQueryId}~1CreateRetweet
-  /graphql/{pathQueryId}/CreateTweet:
-    $ref: ./paths/post.yaml#/paths/~1graphql~1{pathQueryId}~1CreateTweet
-  /graphql/{pathQueryId}/DeleteRetweet:
-    $ref: ./paths/post.yaml#/paths/~1graphql~1{pathQueryId}~1DeleteRetweet
-  /graphql/{pathQueryId}/DeleteTweet:
-    $ref: ./paths/post.yaml#/paths/~1graphql~1{pathQueryId}~1DeleteTweet
-  /graphql/{pathQueryId}/FavoriteTweet:
-    $ref: ./paths/post.yaml#/paths/~1graphql~1{pathQueryId}~1FavoriteTweet
-  /graphql/{pathQueryId}/Followers:
-    $ref: ./paths/follow.yaml#/paths/~1graphql~1{pathQueryId}~1Followers
-  /graphql/{pathQueryId}/Following:
-    $ref: ./paths/follow.yaml#/paths/~1graphql~1{pathQueryId}~1Following
-  /graphql/{pathQueryId}/HomeLatestTimeline:
-    $ref: ./paths/timeline.yaml#/paths/~1graphql~1{pathQueryId}~1HomeLatestTimeline
-  /graphql/{pathQueryId}/HomeTimeline:
-    $ref: ./paths/timeline.yaml#/paths/~1graphql~1{pathQueryId}~1HomeTimeline
-  /graphql/{pathQueryId}/Likes:
-    $ref: ./paths/usertweets.yaml#/paths/~1graphql~1{pathQueryId}~1Likes
-  /graphql/{pathQueryId}/ListLatestTweetsTimeline:
-    $ref: ./paths/timeline.yaml#/paths/~1graphql~1{pathQueryId}~1ListLatestTweetsTimeline
-  /graphql/{pathQueryId}/ProfileSpotlightsQuery:
-    $ref: ./paths/profile.yaml#/paths/~1graphql~1{pathQueryId}~1ProfileSpotlightsQuery
-  /graphql/{pathQueryId}/TweetDetail:
-    $ref: ./paths/tweet.yaml#/paths/~1graphql~1{pathQueryId}~1TweetDetail
-  /graphql/{pathQueryId}/UnfavoriteTweet:
-    $ref: ./paths/post.yaml#/paths/~1graphql~1{pathQueryId}~1UnfavoriteTweet
-  /graphql/{pathQueryId}/UserByScreenName:
-    $ref: ./paths/user.yaml#/paths/~1graphql~1{pathQueryId}~1UserByScreenName
-  /graphql/{pathQueryId}/UserMedia:
-    $ref: ./paths/usertweets.yaml#/paths/~1graphql~1{pathQueryId}~1UserMedia
-  /graphql/{pathQueryId}/UserTweets:
-    $ref: ./paths/usertweets.yaml#/paths/~1graphql~1{pathQueryId}~1UserTweets
-  /graphql/{pathQueryId}/UserTweetsAndReplies:
-    $ref: ./paths/usertweets.yaml#/paths/~1graphql~1{pathQueryId}~1UserTweetsAndReplies
-  /other:
-    $ref: ./paths/other.yaml#/paths/~1other
-security:
-- CsrfToken: []
-- CookieCt0: []
-- GuestToken: []
-- CookieAuthToken: []
-- AuthType: []
-servers:
-- url: https://twitter.com/i/api
-tags:
-- description: response User
-  name: user
-- description: response User list
-  name: user-list
-- description: response tweet
-  name: tweet
-- description: post
-  name: post
-- description: legacy APIs get
-  name: v1.1-get
-- description: legacy APIs post
-  name: v1.1-post
-- description: legacy APIs get
-  name: v2.0-get
-- description: legacy APIs post
-  name: v2.0-post
-- description: other
-  name: other