twitter-openapi-typescript-generated 0.0.8 → 0.0.9

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

@@ -0,0 +1,99 @@
+openapi: 3.0.3
+info:
+  title: Twitter OpenAPI
+  version: 0.0.1
+
+paths: {}
+components:
+  schemas:
+    Errors:
+      type: object
+      required:
+        - errors
+      properties:
+        errors:
+          type: array
+          items:
+            $ref: "#/components/schemas/Error"
+
+    Error:
+      type: object
+      required:
+        - message
+        - locations
+        - path
+        - extensions
+        - code
+        - kind
+        - name
+        - source
+        - retry_after
+        - tracing
+      properties:
+        message:
+          type: string
+        locations:
+          type: array
+          items:
+            $ref: "#/components/schemas/Location"
+        path:
+          type: array
+          items:
+            type: string
+        extensions:
+          $ref: "#/components/schemas/ErrorExtensions"
+        code:
+          type: integer
+        kind:
+          type: string
+        name:
+          type: string
+        source:
+          type: string
+        retry_after:
+          type: integer
+        tracing:
+          $ref: "#/components/schemas/Tracing"
+
+    Location:
+      type: object
+      required:
+        - line
+        - column
+      properties:
+        line:
+          type: integer
+        column:
+          type: integer
+
+    ErrorExtensions:
+      type: object
+      required:
+        - name
+        - source
+        - retry_after
+        - code
+        - kind
+        - tracing
+      properties:
+        name:
+          type: string
+        source:
+          type: string
+        retry_after:
+          type: integer
+        code:
+          type: integer
+        kind:
+          type: string
+        tracing:
+          $ref: "#/components/schemas/Tracing"
+
+    Tracing:
+      type: object
+      required:
+        - trace_id
+      properties:
+        trace_id:
+          type: string
+          pattern: "^[0-9a-f]{16}$"

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

@@ -45,7 +45,6 @@ components:
         - entries
       properties:
         type:
-          type: string
           $ref: "#/components/schemas/InstructionType" # TimelineAddEntries
         entries:
           type: array
@@ -59,7 +58,6 @@ components:
         - moduleEntryId
       properties:
         type:
-          type: string
           $ref: "#/components/schemas/InstructionType" # TimelineAddToModule
         moduleItems:
           type: array
@@ -75,7 +73,6 @@ components:
         - type
       properties:
         type:
-          type: string
           $ref: "#/components/schemas/InstructionType" # TimelineClearCache
 
     TimelinePinEntry:
@@ -84,7 +81,6 @@ components:
         - entry
       properties:
         type:
-          type: string
           $ref: "#/components/schemas/InstructionType" # TimelinePinEntry
         entry:
           $ref: "#/components/schemas/TimelineAddEntry"
@@ -96,7 +92,6 @@ components:
         - entry
       properties:
         type:
-          type: string
           $ref: "#/components/schemas/InstructionType" # TimelineReplaceEntry
         entry_id_to_replace:
           type: string
@@ -110,7 +105,6 @@ components:
         - richText
       properties:
         type:
-          type: string
           $ref: "#/components/schemas/InstructionType" # TimelineShowAlert
         alertType:
           type: string
@@ -131,11 +125,14 @@ components:
             entities:
               type: array
               items:
-                type: object # todo
+                type: object
+                additionalProperties: true # todo
         iconDisplayInfo:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
         colorConfig:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
         displayLocation:
           type: string
           enum: [Top] # which else?
@@ -146,7 +143,6 @@ components:
         - direction
       properties:
         type:
-          type: string
           $ref: "#/components/schemas/InstructionType" # TimelineTerminateTimeline
         direction:
           type: string
@@ -162,7 +158,7 @@ components:
           $ref: "./content.yaml#/components/schemas/ContentUnion"
         entryId:
           type: string
-          pattern: '^[a-z\-]+[0-9]+$'
+          pattern: "^(([a-z]+|[0-9]+|[0-9a-f]+)(-|$))+"
         sortIndex:
           type: string
           pattern: "[0-9]+$"

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

@@ -22,6 +22,8 @@ components:
           items:
             $ref: "./../schemas/instruction.yaml#/components/schemas/InstructionUnion"
         metadata:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
         responseObjects:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo

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

@@ -33,14 +33,14 @@ components:
       properties:
         __typename:
           $ref: "./typename.yaml#/components/schemas/TypeName" # TweetWithVisibilityResults
-        # todo
+      additionalProperties: true # todo
 
     Tweet:
       required:
         - "rest_id"
         - "core"
         - "edit_control"
-        - "edit_prespective"
+        # - "edit_prespective"
         - "is_translatable"
         - "legacy"
         - "views"
@@ -93,7 +93,8 @@ components:
                           type:
                             type: string
         unmention_data:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
         edit_control:
           type: object
           properties:
@@ -241,11 +242,14 @@ components:
             $ref: "#/components/schemas/Media"
 
     Hashtag:
-      type: object # todo
+      type: object
+      additionalProperties: true # todo
     Symbol:
-      type: object # todo
+      type: object
+      additionalProperties: true # todo
     UserMention:
-      type: object # todo
+      type: object
+      additionalProperties: true # todo
     Url:
       type: object
       required:
@@ -310,7 +314,8 @@ components:
         type:
           type: string # enum
         sizes:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
         original_info:
           type: object
           properties:
@@ -321,9 +326,11 @@ components:
             focus_rects:
               type: array
               items:
-                type: object # todo
+                type: object
+                additionalProperties: true # todo
         media_key:
           type: string
           pattern: "^[0-9]+_[0-9]+$"
         ext_media_availability:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo

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

@@ -16,6 +16,9 @@ components:
           TweetWithVisibilityResults,
           TimelineTimelineModule,
           TweetTombstone,
+          TimelinePrompt,
+          TimelineMessagePrompt,
           Tweet,
           User,
+          UserUnavailable,
         ]

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

@@ -17,7 +17,17 @@ components:
         - "result"
       properties:
         result:
-          $ref: "#/components/schemas/User"
+          $ref: "#/components/schemas/UserUnion"
+
+    UserUnion:
+      oneOf:
+        - $ref: "#/components/schemas/User"
+        - $ref: "#/components/schemas/UserUnavailable"
+      discriminator:
+        propertyName: __typename
+        mapping": # deprecated
+          User: "#/components/schemas/User"
+          UserUnavailable: "#/components/schemas/UserUnavailable"
 
     User:
       required:
@@ -35,7 +45,8 @@ components:
         __typename:
           $ref: "./typename.yaml#/components/schemas/TypeName" # User
         affiliates_highlighted_label:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
         has_graduated_access:
           type: boolean
         has_nft_avatar:
@@ -43,7 +54,7 @@ components:
           default: false
         id:
           type: string
-          pattern: '^[a-z\-]+[0-9]+$'
+          pattern: "^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$" # base64
         is_blue_verified:
           type: boolean
           default: false
@@ -53,7 +64,8 @@ components:
           type: string
           pattern: "^[0-9]+$"
         business_account:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
         super_follow_eligible:
           type: boolean
           default: false
@@ -77,10 +89,10 @@ components:
         - "entities"
         - "fast_followers_count"
         - "favourites_count"
-        - "follow_request_sent"
-        - "followed_by"
+        # 31 # - "follow_request_sent"
+        # 31 #  - "followed_by"
         - "followers_count"
-        - "following"
+        # 31 #  - "following"
         - "friends_count"
         - "has_custom_timelines"
         - "is_translator"
@@ -90,12 +102,12 @@ components:
         - "muting"
         - "name"
         - "normal_followers_count"
-        - "notifications"
+        # 31 #  - "notifications"
         - "pinned_tweet_ids_str"
         - "possibly_sensitive"
         - "profile_image_url_https"
         - "profile_interstitial_type"
-        - "protected"
+        # 31 #  - "protected"
         - "screen_name"
         - "status"
         - "statuses_count"
@@ -126,7 +138,8 @@ components:
         description:
           type: string
         entities:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
         fast_followers_count:
           type: integer
         favourites_count:
@@ -208,3 +221,13 @@ components:
         want_retweets:
           type: boolean
           default: false
+
+    UserUnavailable:
+      required:
+        - "__typename"
+        - "reason"
+      properties:
+        __typename:
+          $ref: "./typename.yaml#/components/schemas/TypeName" # UserUnavailable
+        reason:
+          type: string

package/twitter-openapi/test/dart-dio/openapi-generator-config.yaml

@@ -0,0 +1,2 @@
+inputSpec: dist/compatible/openapi-3.0.yaml
+outputDir: dart_dio_generated

package/twitter-openapi/test/local.sh

@@ -0,0 +1,6 @@
+
+
+python3 tools/build.py
+java -jar openapi-generator-cli.jar generate -c test/python/openapi-generator-config.yaml -g python
+python3 -m pip install ./python_generated
+python3 test/python/test_serialize.py

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

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

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

@@ -0,0 +1,160 @@
+import json
+import os
+import logging
+import base64
+import openapi_client as pt
+from pathlib import Path
+import time
+
+
+logging.basicConfig(level=logging.DEBUG, format="%(asctime)s %(levelname)s %(message)s")
+logger = logging.getLogger("test_serialize")
+
+TWITTER_SESSION = os.environ.get("TWITTER_SESSION", None)
+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"))
+
+
+if Path("cookie.json").exists():
+    with open("cookie.json", "r") as f:
+        cookies = json.load(f)
+elif TWITTER_SESSION is not None:
+    data = base64.b64decode(TWITTER_SESSION).decode("utf-8")
+    cookies = json.loads(data)
+else:
+    commands = ["python -m pip install tweepy_authlib", "python tools/login.py"]
+    raise Exception(f'cookie.json not found. Please run `{"; ".join(commands)}` first.')
+
+cookies_str = "; ".join([f"{k}={v}" for k, v in cookies.items()])
+
+
+with open("src/config/placeholder.json", "r") as f:
+    placeholder = json.load(f)
+
+
+def get_key(snake_str):
+    components = snake_str.split("_")
+    return "".join(x.title() for x in components[1:])
+
+
+def get_cursor(obj, fn):
+    res = []
+    if type(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:
+        for v in obj:
+            res.extend(get_cursor(v, fn))
+    return res
+
+
+def find_cursor(x):
+    if x.get("__typename") is pt.TypeName.TIMELINETIMELINECURSOR:
+        return [x["value"]]
+
+
+def find_name(x):
+    if x.get("name") is not None:
+        return [x["name"]]
+
+
+def get_kwargs(key, additional):
+    kwargs = {"path_query_id": placeholder[key]["queryId"]}
+    if placeholder[key].get("variables") is not None:
+        kwargs["variables"] = json.dumps(placeholder[key]["variables"] | additional)
+    if placeholder[key].get("features") is not None:
+        kwargs["features"] = json.dumps(placeholder[key]["features"])
+    if placeholder[key].get("fieldToggles") is not None:
+        kwargs["field_toggles"] = json.dumps(placeholder[key]["fieldToggles"])
+    return kwargs
+
+
+def error_dump(e):
+    if ERROR_UNCATCHED:
+        raise
+    import traceback
+
+    logger.error("==========[STACK TRACE]==========")
+    for trace in traceback.format_exc().split("\n"):
+        logger.error(trace)
+    logger.info("================================")
+
+
+api_conf = pt.Configuration(
+    api_key={
+        "ClientLanguage": "en",
+        "ActiveUser": "yes",
+        "AuthType": "OAuth2Session",
+        "CsrfToken": cookies["ct0"],
+    },
+)
+
+api_conf.access_token = "AAAAAAAAAAAAAAAAAAAAANRILgAAAAAAnNwIzUejRCOuH5E6I8xnZz4puTs%3D1Zv7ttfk8LF81IUq16cHjhLTvJu4FA33AGWWjCpTnA"
+
+api_client = pt.ApiClient(configuration=api_conf, cookie=cookies_str)
+api_client.user_agent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36"
+
+error_count = 0
+
+for x in [pt.DefaultApi, pt.TweetApi, pt.UserApi, pt.UsersApi, pt.UserListApi]:
+    for props, fn in x.__dict__.items():
+        if not callable(fn):
+            continue
+        if props.startswith("__") or props.endswith("_with_http_info"):
+            continue
+
+        key = get_key(props)
+        cursor_list = set([None])
+        cursor_history = set()
+
+        try:
+            for _ in range(CUESOR_TEST_COUNT):
+                cursor = cursor_list.pop()
+                cursor_history.add(cursor)
+                logger.info(f"Try: {key} {cursor}")
+
+                kwargs = get_kwargs(key, {} if cursor is None else {"cursor": cursor})
+                res: dict = getattr(x(api_client), props)(**kwargs).to_dict()
+
+                new_cursor = set(get_cursor(res, find_cursor)) - cursor_history
+                cursor_list.update(new_cursor)
+                # logger.info(f"Find cursor: {len(new_cursor)}")
+
+                if res.get("errors") is not None:
+                    logger.error(res)
+                    error_count += 1
+
+                if len(cursor_list) == 0:
+                    break
+                time.sleep(SLEEP_TIME)
+
+        except Exception as e:
+            error_dump(e)
+            error_count += 1
+
+
+try:
+    logger.info(f"Try: Self UserByScreenName Test")
+    kwargs = get_kwargs("UserByScreenName", {"screen_name": "a810810931931"})
+    res = pt.UserApi(api_client).get_user_by_screen_name(**kwargs).to_dict()
+    if not res["data"]["user"]["result"]["legacy"]["screen_name"] == "a810810931931":
+        raise Exception("UserByScreenName failed")
+except Exception as e:
+    error_dump(e)
+    error_count += 1
+
+try:
+    logger.info(f"Try: Self UserTweets Test")
+    kwargs = get_kwargs("UserTweets", {"userId": "1180389371481976833"})
+    pt.TweetApi(api_client).get_user_tweets(**kwargs)
+except Exception as e:
+    error_dump(e)
+    error_count += 1
+
+if error_count > 0:
+    exit(1)

package/twitter-openapi/test/typescript-fetch/openapi-generator-config.yaml

@@ -0,0 +1,4 @@
+inputSpec: dist/compatible/openapi-3.0.yaml
+outputDir: typescript_fetch_generated
+
+legacyDiscriminatorBehavior: false

package/twitter-openapi/tools/build_config.py

@@ -39,7 +39,7 @@ class Config:
                     AddPathQueryIdOnParameters(split=-1),
                     getParamHook,
                 ]
-                for key in ["default", "user", "user-list", "tweet"]
+                for key in ["default", "user", "users", "user-list", "tweet"]
             }
             | {
                 key: [

package/twitter-openapi/tools/hooks.py

@@ -109,6 +109,29 @@ class RemoveDiscriminator(SchemasHookBase):
         return value
 
 
+class SchemasCheck(SchemasHookBase):
+    def hook(self, value: dict):
+        if value.get("allOf") is not None:
+            print(f"allOf is used")
+        if value.get("type") is None:
+            print("Type is None")
+        return value
+
+
+class RequiredCheck(SchemasHookBase):
+    def hook(self, value: dict):
+        required = value.get("required", [])
+
+        for key, property in value.get("properties", {}).items():
+            if key in required and property.get("default") is not None:
+                print(f"{key} is required and has default value")
+            d = property.get("default") is None and property.get("nullable", False)
+            if property not in required and d:
+                print(f"{key} is not required and has no default value")
+
+        return value
+
+
 # RequestHookBase extends
 
 

package/twitter-openapi/tools/login.py

@@ -0,0 +1,17 @@
+import json
+import base64
+from tweepy_authlib import CookieSessionUserHandler
+
+auth_handler = CookieSessionUserHandler(
+    screen_name=input("screen_name: "),
+    password=input("password: "),
+)
+
+
+cookies = auth_handler.get_cookies()
+
+data = json.dumps(cookies.get_dict())
+print(base64.b64encode(data.encode("utf-8")).decode("utf-8"))
+
+with open("cookie.json", "w") as f:
+    f.write(data)