twitter-openapi-typescript-generated 0.0.16 → 0.0.18

package/twitter-openapi/src/openapi/schemas/typename.yaml

@@ -14,6 +14,7 @@ components:
           TimelineUser,
           TimelineTimelineCursor,
           TweetWithVisibilityResults,
+          ContextualTweetInterstitial,
           TimelineTimelineModule,
           TweetTombstone,
           TimelinePrompt,
@@ -23,4 +24,11 @@ components:
           Tweet,
           User,
           UserUnavailable,
+          Community,
+          CommunityDeleteActionUnavailable,
+          CommunityJoinAction,
+          CommunityLeaveActionUnavailable,
+          CommunityTweetPinActionUnavailable,
+          CommunityInvitesUnavailable,
+          CommunityJoinRequestsUnavailable,
         ]

package/twitter-openapi/src/openapi/schemas/user.yaml

@@ -38,6 +38,7 @@ components:
         - "super_follow_eligible"
         - "super_followed_by"
         - "super_following"
+        - "profile_image_shape"
 
       properties:
         __typename:
@@ -73,6 +74,125 @@ components:
         super_following:
           type: boolean
           default: false
+        profile_image_shape:
+          type: string
+          enum:
+            - "Circle"
+            - "Square"
+            - "Hexagon"
+        professional:
+          $ref: "#/components/schemas/UserProfessional"
+        user_seed_tweet_count:
+          type: integer
+        highlights_info:
+          $ref: "#/components/schemas/UserHighlightsInfo"
+        creator_subscriptions_count:
+          type: integer
+        verification_info:
+          $ref: "#/components/schemas/UserVerificationInfo"
+        is_profile_translatable:
+          type: boolean
+
+    UserProfessional:
+      required:
+        - "rest_id"
+        - "professional_type"
+        - "category"
+      properties:
+        rest_id:
+          type: string
+          pattern: "^[0-9]+$"
+        professional_type:
+          type: string
+          enum: ["Business", "Creator"]
+        category:
+          type: array
+          items:
+            $ref: "#/components/schemas/UserProfessionalCategory"
+
+    UserProfessionalCategory:
+      required:
+        - "id"
+        - "name"
+        - "icon_name"
+      properties:
+        id:
+          type: integer
+        name:
+          type: string # enum
+        icon_name:
+          type: string # IconBriefcaseStroke ?
+
+    UserHighlightsInfo:
+      required:
+        - "can_highlight_tweets"
+        - "highlighted_tweets"
+      properties:
+        can_highlight_tweets:
+          type: boolean
+        highlighted_tweets:
+          type: string
+
+    UserVerificationInfo:
+      required:
+        - "is_identity_verified"
+      properties:
+        is_identity_verified:
+          type: boolean
+          default: false
+        reason:
+          $ref: "#/components/schemas/UserVerificationInfoReason"
+
+    UserVerificationInfoReason:
+      required:
+        - "description"
+        - "verified_since_msec"
+        - "override_verified_year"
+      properties:
+        description:
+          $ref: "#/components/schemas/UserVerificationInfoReasonDescription"
+        verified_since_msec:
+          type: string
+          pattern: "^-?[0-9]+$"
+        override_verified_year:
+          type: integer
+
+    UserVerificationInfoReasonDescription:
+      required:
+        - "text"
+        - "entities"
+      properties:
+        text:
+          type: string
+        entities:
+          type: array
+          items:
+            $ref: "#/components/schemas/UserVerificationInfoReasonDescriptionEntities"
+
+    UserVerificationInfoReasonDescriptionEntities:
+      required:
+        - "from_index"
+        - "to_index"
+        - "ref"
+      properties:
+        from_index:
+          type: integer
+        to_index:
+          type: integer
+        ref:
+          $ref: "#/components/schemas/UserVerificationInfoReasonDescriptionEntitiesRef"
+
+    UserVerificationInfoReasonDescriptionEntitiesRef:
+      required:
+        - "url"
+        - "url_type"
+      properties:
+        url:
+          type: string
+          format: uri
+        url_type:
+          type: string
+          enum: ["ExternalUrl"]
 
     UserLegacy:
       required:
@@ -219,6 +339,13 @@ components:
         want_retweets:
           type: boolean
           default: false
+        verified_type:
+          type: string
+          enum: ["Business", "Government"]
+        withheld_in_countries:
+          type: array
+          items:
+            type: string # enum DE
 
     UserUnavailable:
       required:
@@ -229,3 +356,5 @@ components:
           $ref: "./typename.yaml#/components/schemas/TypeName" # UserUnavailable
         reason:
           type: string
+        message:
+          type: string

package/twitter-openapi/test/python/openapi-generator-config.yaml

@@ -1,4 +1,4 @@
-inputSpec: dist/compatible/openapi-3.0.yaml
+inputSpec: dist/compatible_discriminator/openapi-3.0.yaml
 outputDir: python_generated
 
 useOneOfDiscriminatorLookup: true

package/twitter-openapi/test/python/test_serialize.py

@@ -1,16 +1,18 @@
+import base64
+import concurrent.futures
+import glob
 import json
-import os
 import logging
-import base64
-import openapi_client as pt
-from pathlib import Path
+import os
 import time
-import glob
-import aenum
-import concurrent.futures
 import traceback
+import warnings
+from pathlib import Path
 
+import aenum
+import openapi_client as pt
 
+warnings.filterwarnings("ignore")
 logging.basicConfig(level=logging.DEBUG, format="%(asctime)s %(levelname)s %(message)s")
 logger = logging.getLogger("test_serialize")
 
@@ -19,6 +21,7 @@ ERROR_UNCATCHED = os.environ.get("ERROR_UNCATCHED", "false").lower() == "true"
 SLEEP_TIME = float(os.environ.get("SLEEP", "0"))
 CUESOR_TEST_COUNT = int(os.environ.get("CUESOR_TEST_COUNT", "3"))
 STRICT_MODE = os.environ.get("STRICT_MODE", "false").lower() == "true"
+MULTI_THREAD = os.environ.get("MULTI_THREAD", "true").lower() == "true"
 
 
 def get_key(snake_str):
@@ -28,14 +31,14 @@ def get_key(snake_str):
 
 def get_cursor(obj, fn):
     res = []
-    if type(obj) == dict:
+    if isinstance(obj, dict):
         callback = fn(obj)
         if callback is not None:
             res.extend(callback)
         else:
             for v in obj.values():
                 res.extend(get_cursor(v, fn))
-    elif type(obj) == list:
+    elif isinstance(obj, list):
         for v in obj:
             res.extend(get_cursor(v, fn))
     return res
@@ -62,13 +65,25 @@ def get_kwargs(key, additional):
     return kwargs
 
 
-def match_rate_zero(key):
+def match_rate_zero(a, b, base, key):
+    def get(obj, key):
+        if isinstance(obj, list):
+            return get(obj[key[0]], key[1:])
+        if obj.__dict__.get("actual_instance") is not None:
+            return get(obj.actual_instance, key)
+        if len(key) == 0:
+            return obj
+        return get(super_get(obj.__dict__, key[0]), key[1:])
+
     if STRICT_MODE:
-        raise Exception(f"Strict mode: {key}")
+        obj_name = type(get(base, key[:-1]))
+        obj_key = f"{obj_name.__name__}.{key[-1]}"
+        raise Exception(f"Not defined: {obj_key}\nContents: {b}")
+
     return 0
 
 
-def match_rate(a, b, key=""):
+def match_rate(a, b, base, key=""):
     if isinstance(a, aenum.Enum):
         a = a.value
     if isinstance(b, aenum.Enum):
@@ -77,27 +92,30 @@ def match_rate(a, b, key=""):
         return 1
     if a is False and b is None:
         return 1
-    if type(a) != type(b):
-        return match_rate_zero(key)
-    if type(a) == dict and type(b) == dict:
+    if a is None and isinstance(b, list) and len(b) == 0:
+        return 1
+    if isinstance(a, list) and b is None and len(a) == 0:
+        return 1
+    if a is None and isinstance(b, dict) and len(b) == 0:
+        return 1
+    if isinstance(a, dict) and b is None and len(a) == 0:
+        return 1
+    if isinstance(a, dict) and isinstance(b, dict):
         if len(a) == 0 and len(b) == 0:
             return 1
-        if len(a) == 0 or len(b) == 0:
-            return match_rate_zero(key)
-
-        data = [match_rate(a.get(k), b.get(k), key=f"{key}.{k}") for k in a.keys()]
-
-        return sum(data) / len(a)
-    if type(a) == list and type(b) == list:
+        marge_key = set(a.keys()) | set(b.keys())
+        data = [match_rate(a.get(k), b.get(k), base, [*key, k]) for k in marge_key]
+        return sum(data) / len(b)
+    if isinstance(a, list) and isinstance(b, list):
         if len(a) == 0 and len(b) == 0:
             return 1
         if len(a) != len(b):
-            return match_rate_zero(a, b, key=key)
-        data = [match_rate(a[i], b[i], key=f"{key}[{i}]") for i in range(len(a))]
+            return match_rate_zero(a, b, base, key)
+        data = [match_rate(a[i], b[i], base, [*key, i]) for i in range(len(a))]
         return sum(data) / len(a)
     if a == b:
         return 1
-    return match_rate_zero(a, b, key=key)
+    return match_rate_zero(a, b, base, key)
 
 
 def save_cache(data):
@@ -107,14 +125,31 @@ def save_cache(data):
         json.dump(data, f, indent=4)
 
 
+def super_get(obj: dict, key: str):
+    keys = [
+        key,
+        "".join(["_" + c.lower() if c.isupper() else c for c in key]).lstrip("_"),
+    ]
+
+    for k in keys:
+        if obj.get(k) is not None:
+            return obj[k]
+    raise KeyError(key)
+
+
 def task_callback(file, thread=True):
     try:
         with open(file, "r") as f:
             cache = json.load(f)
         data = pt.__dict__[cache["type"]].from_json(cache["raw"])
-        rate = match_rate(data.to_dict(), json.loads(cache["raw"]))
+
+        rate = match_rate(
+            data.to_dict(),
+            json.loads(cache["raw"]),
+            base=data,
+        )
         return rate, file
-    except Exception as e:
+    except Exception:
         if thread:
             return 0, file
         else:
@@ -150,10 +185,18 @@ if __name__ == "__main__":
         placeholder = json.load(f)
 
     fail = []
-    with concurrent.futures.ProcessPoolExecutor() as executor:
-        tasks = [executor.submit(task_callback, x) for x in glob.glob("cache/*.json")]
-        for task in concurrent.futures.as_completed(tasks):
-            rate, file = task.result()
+    files = glob.glob("cache/*.json")
+    if MULTI_THREAD:
+        with concurrent.futures.ProcessPoolExecutor() as executor:
+            tasks = [executor.submit(task_callback, x) for x in files]
+            for task in concurrent.futures.as_completed(tasks):
+                rate, file = task.result()
+                if rate < 1:
+                    fail.append(file)
+                logger.info(f"Match rate: {rate}")
+    else:
+        for file in files:
+            rate, file = task_callback(file, thread=False)
             if rate < 1:
                 fail.append(file)
             logger.info(f"Match rate: {rate}")
@@ -205,7 +248,7 @@ if __name__ == "__main__":
 
                     save_cache(
                         {
-                            "raw": res.raw_data,
+                            "raw": res.raw_data.decode("utf-8"),
                             "type": res.data.__class__.__name__,
                         }
                     )
@@ -213,7 +256,11 @@ if __name__ == "__main__":
                     new_cursor = set(get_cursor(data, find_cursor)) - cursor_history
                     cursor_list.update(new_cursor)
 
-                    rate = match_rate(data, json.loads(res.raw_data))
+                    rate = match_rate(
+                        data,
+                        json.loads(res.raw_data),
+                        res.data,
+                    )
                     logger.info(f"Match rate: {rate}")
 
                     if data.get("errors") is not None:
@@ -229,12 +276,16 @@ if __name__ == "__main__":
                 error_count += 1
 
     try:
-        logger.info(f"Try: Self UserByScreenName Test")
+        logger.info("Try: Self UserByScreenName Test")
         kwargs = get_kwargs("UserByScreenName", {"screen_name": "a810810931931"})
         res = pt.UserApi(api_client).get_user_by_screen_name_with_http_info(**kwargs)
         data = res.data.to_dict()
 
-        rate = match_rate(data, json.loads(res.raw_data))
+        rate = match_rate(
+            data,
+            json.loads(res.raw_data),
+            res.data,
+        )
         logger.info(f"Match rate: {rate}")
         screen_name = data["data"]["user"]["result"]["legacy"]["screen_name"]
         if not screen_name == "a810810931931":
@@ -243,23 +294,39 @@ if __name__ == "__main__":
         error_dump(e)
         error_count += 1
 
-    try:
-        logger.info(f"Try: Self UserTweets Test")
-        kwargs = get_kwargs("UserTweets", {"userId": "1180389371481976833"})
-        res = pt.TweetApi(api_client).get_user_tweets_with_http_info(**kwargs)
-        data = res.data.to_dict()
+    ids = [
+        "1180389371481976833",
+        "900282258736545792",
+        "1212617657003859968",
+        "2455740283",
+        "2326837940",
+    ]
+    for id in ids:
+        try:
+            logger.info("Try: Self UserTweets Test")
+            kwargs = get_kwargs("UserTweets", {"userId": id})
+            res = pt.TweetApi(api_client).get_user_tweets_with_http_info(**kwargs)
+            data = res.data.to_dict()
 
-        rate = match_rate(data, json.loads(res.raw_data))
-        logger.info(f"Match rate: {rate}")
+            rate = match_rate(
+                data,
+                json.loads(res.raw_data),
+                res.data,
+            )
+            logger.info(f"Match rate: {rate}")
 
-    except Exception as e:
-        error_dump(e)
-        error_count += 1
+        except Exception as e:
+            error_dump(e)
+            error_count += 1
 
     ids = [
         "1720975693524377759",
         "1721006592303251551",
-        "1606661809075019776",
+        "1739194269477331076",
+        "1697450269259522256",
+        "1697450278742884799",
+        "1749500209061663043",
+        "1759056048764469303",
     ]
     for id in ids:
         try:
@@ -268,7 +335,11 @@ if __name__ == "__main__":
             res = pt.TweetApi(api_client).get_tweet_detail_with_http_info(**kwargs)
             data = res.data.to_dict()
 
-            rate = match_rate(data, json.loads(res.raw_data))
+            rate = match_rate(
+                data,
+                json.loads(res.raw_data),
+                res.data,
+            )
             logger.info(f"Match rate: {rate}")
         except Exception as e:
             error_dump(e)

package/twitter-openapi/tools/build_config.py

@@ -1,11 +1,23 @@
-from hooks import *
+from hooks import (
+    AddParametersOnBody,
+    AddParametersOnContent,
+    AddParametersOnParameters,
+    AddPathQueryIdOnParameters,
+    AddSecuritySchemesOnSecuritySchemes,
+    RemoveErrorHandle,
+    SetResponsesHeader,
+)
 
 
 class Config:
     OUTPUT_DIR = "dist/{0}"
     INPUT_DIR = "src/openapi"
 
-    def hooks_generator(self, queryParameterJson=True):
+    def hooks_generator(
+        self,
+        queryParameterJson=True,
+        removeLegacyDiscriminatorBehavior=False,
+    ):
         # https://stackoverflow.com/questions/34820064/defining-an-api-with-swagger-get-call-that-uses-json-in-parameters/45223964
         if queryParameterJson:
             # ["parameters"][0]["content"]["application/json"]["schema"]
@@ -22,6 +34,11 @@ class Config:
                 ignoreKeys=["queryId"],
             )
 
+        # https://github.com/OpenAPITools/openapi-generator/issues/15373
+        additionalHooks = []
+        if removeLegacyDiscriminatorBehavior:
+            additionalHooks.append(RemoveErrorHandle())
+
         return {
             "openapi": [AddSecuritySchemesOnSecuritySchemes()],
             "schemas": [],
@@ -31,6 +48,7 @@ class Config:
                     SetResponsesHeader(suffix=None),
                     AddPathQueryIdOnParameters(split=-1),
                     getParamHook,
+                    *additionalHooks,
                 ]
                 for key in ["default", "user", "users", "user-list", "tweet"]
             }
@@ -43,6 +61,7 @@ class Config:
                         schemaType=None,
                         contentType="application/json",
                     ),
+                    *additionalHooks,
                 ]
                 for key in ["post"]
             }
@@ -70,5 +89,11 @@ class Config:
     def main(self):
         return {
             "docs": self.hooks_generator(),
-            "compatible": self.hooks_generator(queryParameterJson=False),
+            "compatible": self.hooks_generator(
+                queryParameterJson=False,
+            ),
+            "compatible_discriminator": self.hooks_generator(
+                queryParameterJson=False,
+                removeLegacyDiscriminatorBehavior=True,
+            ),
         }

package/twitter-openapi/tools/hooks.py

@@ -1,6 +1,7 @@
-import yaml
 import json
 
+import yaml
+
 
 class HookBase:
     PLACEHOLDER: dict
@@ -193,6 +194,13 @@ class AddPathQueryIdOnParameters(RequestHookBase):
         return path, value
 
 
+class RemoveErrorHandle(RequestHookBase):
+    def hook(self, path: str, value: dict):
+        content = value["responses"]["200"]["content"]["application/json"]
+        content["schema"] = content["schema"]["oneOf"][0]
+        return path, value
+
+
 # OnParameters
 
 

package/dist/models/SocialContext.d.ts

@@ -1,44 +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.
- */
-/**
- *
- * @export
- * @interface SocialContext
- */
-export interface SocialContext {
-    /**
-     *
-     * @type {string}
-     * @memberof SocialContext
-     */
-    contextType?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof SocialContext
-     */
-    text?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof SocialContext
-     */
-    type?: string;
-}
-/**
- * Check if a given object implements the SocialContext interface.
- */
-export declare function instanceOfSocialContext(value: object): boolean;
-export declare function SocialContextFromJSON(json: any): SocialContext;
-export declare function SocialContextFromJSONTyped(json: any, ignoreDiscriminator: boolean): SocialContext;
-export declare function SocialContextToJSON(value?: SocialContext | null): any;
-//# sourceMappingURL=SocialContext.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"SocialContext.d.ts","sourceRoot":"","sources":["../../src/models/SocialContext.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAI9D;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,GAAG,GAAG,aAAa,CAE9D;AAED,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,aAAa,CAUjG;AAED,wBAAgB,mBAAmB,CAAC,KAAK,CAAC,EAAE,aAAa,GAAG,IAAI,GAAG,GAAG,CAarE"}

package/dist/models/SocialContext.js

@@ -1,55 +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.SocialContextToJSON = exports.SocialContextFromJSONTyped = exports.SocialContextFromJSON = exports.instanceOfSocialContext = void 0;
-var runtime_1 = require("../runtime");
-/**
- * Check if a given object implements the SocialContext interface.
- */
-function instanceOfSocialContext(value) {
-    var isInstance = true;
-    return isInstance;
-}
-exports.instanceOfSocialContext = instanceOfSocialContext;
-function SocialContextFromJSON(json) {
-    return SocialContextFromJSONTyped(json, false);
-}
-exports.SocialContextFromJSON = SocialContextFromJSON;
-function SocialContextFromJSONTyped(json, ignoreDiscriminator) {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        'contextType': !(0, runtime_1.exists)(json, 'contextType') ? undefined : json['contextType'],
-        'text': !(0, runtime_1.exists)(json, 'text') ? undefined : json['text'],
-        'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
-    };
-}
-exports.SocialContextFromJSONTyped = SocialContextFromJSONTyped;
-function SocialContextToJSON(value) {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        'contextType': value.contextType,
-        'text': value.text,
-        'type': value.type,
-    };
-}
-exports.SocialContextToJSON = SocialContextToJSON;
-//# sourceMappingURL=SocialContext.js.map

package/dist/models/SocialContext.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SocialContext.js","sourceRoot":"","sources":["../../src/models/SocialContext.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAEH,sCAA+C;AA2B/C;;GAEG;AACH,SAAgB,uBAAuB,CAAC,KAAa;IACjD,IAAI,UAAU,GAAG,IAAI,CAAC;IAEtB,OAAO,UAAU,CAAC;AACtB,CAAC;AAJD,0DAIC;AAED,SAAgB,qBAAqB,CAAC,IAAS;IAC3C,OAAO,0BAA0B,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACnD,CAAC;AAFD,sDAEC;AAED,SAAgB,0BAA0B,CAAC,IAAS,EAAE,mBAA4B;IAC9E,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE;QACzC,OAAO,IAAI,CAAC;KACf;IACD,OAAO;QAEH,aAAa,EAAE,CAAC,IAAA,gBAAM,EAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;QAC7E,MAAM,EAAE,CAAC,IAAA,gBAAM,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QACxD,MAAM,EAAE,CAAC,IAAA,gBAAM,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;KAC3D,CAAC;AACN,CAAC;AAVD,gEAUC;AAED,SAAgB,mBAAmB,CAAC,KAA4B;IAC5D,IAAI,KAAK,KAAK,SAAS,EAAE;QACrB,OAAO,SAAS,CAAC;KACpB;IACD,IAAI,KAAK,KAAK,IAAI,EAAE;QAChB,OAAO,IAAI,CAAC;KACf;IACD,OAAO;QAEH,aAAa,EAAE,KAAK,CAAC,WAAW;QAChC,MAAM,EAAE,KAAK,CAAC,IAAI;QAClB,MAAM,EAAE,KAAK,CAAC,IAAI;KACrB,CAAC;AACN,CAAC;AAbD,kDAaC"}