twitter-openapi-typescript-generated 0.0.1 → 0.0.2

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

@@ -0,0 +1,264 @@
+openapi: 3.0.3
+info:
+  title: Twitter OpenAPI
+  version: 0.0.1
+
+paths: {}
+
+components:
+  schemas:
+    TweetUnion:
+      oneOf:
+        - $ref: "#/components/schemas/Tweet"
+        - $ref: "#/components/schemas/TweetWithVisibilityResults"
+        - $ref: "#/components/schemas/TweetTombstone"
+      discriminator:
+        propertyName: __typename
+        mapping": # deprecated
+          Tweet: "#/components/schemas/Tweet"
+          TweetWithVisibilityResults: "#/components/schemas/TweetWithVisibilityResults"
+          TweetTombstone: "#/components/schemas/TweetTombstone"
+
+    TweetWithVisibilityResults:
+      required:
+        - "__typename"
+        - "tweet"
+      properties:
+        __typename:
+          $ref: "./typename.yaml#/components/schemas/TypeName" # TweetWithVisibilityResults
+        tweet:
+          $ref: "#/components/schemas/Tweet"
+
+    TweetTombstone: #remove tweet
+      properties:
+        __typename:
+          $ref: "./typename.yaml#/components/schemas/TypeName" # TweetWithVisibilityResults
+        # todo
+
+    Tweet:
+      required:
+        - "rest_id"
+        - "core"
+        - "edit_control"
+        - "edit_prespective"
+        - "is_translatable"
+        - "legacy"
+        - "views"
+
+      properties:
+        __typename:
+          $ref: "./typename.yaml#/components/schemas/TypeName" # null | Tweet
+        rest_id:
+          type: string
+          pattern: "^[0-9]+$"
+        core:
+          $ref: "./user.yaml#/components/schemas/UserResultCore"
+        unmention_data:
+          type: object # todo
+        edit_control:
+          type: object
+          properties:
+            edit_tweet_ids:
+              type: array
+              items:
+                type: string
+                pattern: "^[0-9]+$"
+            editable_until_msecs:
+              type: string
+              pattern: "^[0-9]+$"
+            is_edit_eligible:
+              type: boolean
+            edits_remaining:
+              type: string
+              pattern: "^[0-9]+$"
+        edit_prespective:
+          type: object
+          properties:
+            favorited:
+              type: boolean
+            retweeted:
+              type: boolean
+        is_translatable:
+          type: boolean
+          default: false
+        legacy:
+          $ref: "#/components/schemas/TweetLegacy"
+        views:
+          type: object
+          properties:
+            count:
+              type: string
+              pattern: "^[0-9]+$"
+            state:
+              type: string # enum
+        quoted_status_result:
+          $ref: "./content.yaml#/components/schemas/ItemResult"
+
+    TweetLegacy:
+      required:
+        - "bookmark_count"
+        - "bookmarked"
+        - "conversation_id_str"
+        - "created_at"
+        - "display_text_range"
+        - "entities"
+        - "favorite_count"
+        - "favorited"
+        - "full_text"
+        - "is_quote_status"
+        - "lang"
+        - "quote_count"
+        - "reply_count"
+        - "retweet_count"
+        - "retweeted"
+        - "user_id_str"
+        - "id_str"
+      properties:
+        bookmark_count:
+          type: integer
+        bookmarked:
+          type: boolean
+        created_at:
+          $ref: "./general.yaml#/components/schemas/TwitterTimeFormat"
+        conversation_id_str:
+          type: string
+          pattern: "^[0-9]+$"
+        display_text_range:
+          type: array
+          items:
+            type: integer
+        entities:
+          $ref: "#/components/schemas/Entities"
+        favorite_count:
+          type: integer
+        favorited:
+          type: boolean
+        full_text:
+          type: string
+        is_quote_status:
+          type: boolean
+        lang:
+          type: string # enum
+        possibly_sensitive:
+          type: boolean
+          default: false
+        possibly_sensitive_editable:
+          type: boolean
+          default: false
+        quote_count:
+          type: integer
+        reply_count:
+          type: integer
+        retweet_count:
+          type: integer
+        retweeted:
+          type: boolean
+        retweeted_status_result:
+          $ref: "./content.yaml#/components/schemas/ItemResult"
+        user_id_str:
+          type: string
+          pattern: "^[0-9]+$"
+        id_str:
+          type: string
+          pattern: "^[0-9]+$"
+        extended_entities:
+          $ref: "#/components/schemas/ExtendedEntities"
+
+    Entities:
+      required:
+        - "hashtags"
+        - "symbols"
+        - "user_mentions"
+        - "urls"
+        # - "media"
+      properties:
+        hashtags:
+          type: array
+          items:
+            $ref: "#/components/schemas/Hashtag"
+        symbols:
+          type: array
+          items:
+            $ref: "#/components/schemas/Symbol"
+        user_mentions:
+          type: array
+          items:
+            $ref: "#/components/schemas/UserMention"
+        urls:
+          type: array
+          items:
+            $ref: "#/components/schemas/Url"
+        media:
+          type: array
+          items:
+            $ref: "#/components/schemas/Media"
+
+    Hashtag:
+      type: object # todo
+    Symbol:
+      type: object # todo
+    UserMention:
+      type: object # todo
+    Url:
+      type: object # todo
+
+    ExtendedEntities:
+      required:
+        - "media"
+      properties:
+        media:
+          type: array
+          items:
+            $ref: "#/components/schemas/Media"
+
+    Media:
+      required:
+        - "id_str"
+        - "indices"
+        - "media_url_https"
+        - "url"
+        - "display_url"
+        - "expanded_url"
+        - "type"
+        - "sizes"
+        - "original_info"
+      properties:
+        id_str:
+          type: string
+          pattern: "^[0-9]+$"
+        indices:
+          type: array
+          items:
+            type: integer
+        media_url_https:
+          type: string
+          format: uri
+        url:
+          type: string
+          format: uri
+        display_url:
+          type: string
+          format: uri
+        expanded_url:
+          type: string
+          format: uri
+        type:
+          type: string # enum
+        sizes:
+          type: object # todo
+        original_info:
+          type: object
+          properties:
+            height:
+              type: integer
+            width:
+              type: integer
+            focus_rects:
+              type: array
+              items:
+                type: object # todo
+        media_key:
+          type: string
+          pattern: "^[0-9]+_[0-9]+$"
+        ext_media_availability:
+          type: object # todo

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

@@ -0,0 +1,21 @@
+openapi: 3.0.3
+info:
+  title: Twitter OpenAPI
+  version: 0.0.1
+paths: {}
+components:
+  schemas:
+    TypeName:
+      type: string
+      enum:
+        [
+          TimelineTweet,
+          TimelineTimelineItem,
+          TimelineUser,
+          TimelineTimelineCursor,
+          TweetWithVisibilityResults,
+          TimelineTimelineModule,
+          TweetTombstone,
+          Tweet,
+          User,
+        ]

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

@@ -0,0 +1,210 @@
+openapi: 3.0.3
+info:
+  title: Twitter OpenAPI
+  version: 0.0.1
+paths: {}
+components:
+  schemas:
+    UserResultCore:
+      required:
+        - "user_results"
+      properties:
+        user_results:
+          $ref: "#/components/schemas/UserResults"
+
+    UserResults:
+      required:
+        - "result"
+      properties:
+        result:
+          $ref: "#/components/schemas/User"
+
+    User:
+      required:
+        - "__typename"
+        - "affiliates_highlighted_label"
+        - "id"
+        - "is_blue_verified"
+        - "legacy"
+        - "rest_id"
+        - "super_follow_eligible"
+        - "super_followed_by"
+        - "super_following"
+
+      properties:
+        __typename:
+          $ref: "./typename.yaml#/components/schemas/TypeName" # User
+        affiliates_highlighted_label:
+          type: object # todo
+        has_graduated_access:
+          type: boolean
+        has_nft_avatar:
+          type: boolean
+          default: false
+        id:
+          type: string
+          pattern: '^[a-z\-]+[0-9]+$'
+        is_blue_verified:
+          type: boolean
+          default: false
+        legacy:
+          $ref: "#/components/schemas/UserLegacy"
+        rest_id:
+          type: string
+          pattern: "^[0-9]+$"
+        business_account:
+          type: object # todo
+        super_follow_eligible:
+          type: boolean
+          default: false
+        super_followed_by:
+          type: boolean
+          default: false
+        super_following:
+          type: boolean
+          default: false
+
+    UserLegacy:
+      required:
+        - "blocked_by"
+        - "blocking"
+        - "can_dm"
+        - "can_media_tag"
+        - "created_at"
+        - "default_profile"
+        - "default_profile_image"
+        - "description"
+        - "entities"
+        - "fast_followers_count"
+        - "favourites_count"
+        - "follow_request_sent"
+        - "followed_by"
+        - "followers_count"
+        - "following"
+        - "friends_count"
+        - "has_custom_timelines"
+        - "is_translator"
+        - "listed_count"
+        - "location"
+        - "media_count"
+        - "muting"
+        - "name"
+        - "normal_followers_count"
+        - "notifications"
+        - "pinned_tweet_ids_str"
+        - "possibly_sensitive"
+        - "profile_image_url_https"
+        - "profile_interstitial_type"
+        - "protected"
+        - "screen_name"
+        - "status"
+        - "statuses_count"
+        - "translator_type"
+        - "verified"
+        - "want_retweets"
+      properties:
+        blocked_by:
+          type: boolean
+          default: false
+        blocking:
+          type: boolean
+          default: false
+        can_dm:
+          type: boolean
+          default: false
+        can_media_tag:
+          type: boolean
+          default: false
+        created_at:
+          $ref: "./general.yaml#/components/schemas/TwitterTimeFormat"
+        default_profile:
+          type: boolean
+          default: false
+        default_profile_image:
+          type: boolean
+          default: false
+        description:
+          type: string
+        entities:
+          type: object # todo
+        fast_followers_count:
+          type: integer
+        favourites_count:
+          type: integer
+          default: 0
+        follow_request_sent:
+          type: boolean
+          default: false
+        followed_by:
+          type: boolean
+          default: false
+        followers_count:
+          type: integer
+          default: 0
+        following:
+          type: boolean
+          default: false
+        friends_count:
+          type: integer
+          default: 0
+        has_custom_timelines:
+          type: boolean
+          default: false
+        is_translator:
+          type: boolean
+          default: false
+        listed_count:
+          type: integer
+          default: 0
+        location:
+          type: string
+        media_count:
+          type: integer
+          default: 0
+        muting:
+          type: boolean
+          default: false
+        name:
+          type: string
+        normal_followers_count:
+          type: integer
+          default: 0
+        notifications:
+          type: boolean
+          default: false
+        pinned_tweet_ids_str:
+          type: array
+          items:
+            type: string
+        possibly_sensitive:
+          type: boolean
+          default: false
+        profile_banner_extensions:
+          type: object
+        profile_banner_url:
+          type: string
+          format: uri
+        profile_image_extensions:
+          type: object
+        profile_image_url_https:
+          type: string
+          format: uri
+        profile_interstitial_type:
+          type: string
+        protected:
+          type: boolean
+          default: false
+        screen_name:
+          type: string
+        statuses_count:
+          type: integer
+          default: 0
+        translator_type:
+          type: string
+        url:
+          type: string
+        verified:
+          type: boolean
+        want_retweets:
+          type: boolean
+          default: false

package/twitter-openapi/tools/build.py

@@ -0,0 +1,79 @@
+import os
+import glob
+import json
+import yaml
+import shutil
+import copy
+import re
+from build_config import Config
+from hooks import OpenapiHookBase, RequestHookBase, SchemasHookBase,OtherHookBase
+from tqdm import tqdm
+
+
+print("=== Build Start ===")
+
+
+config = Config()
+
+
+try:
+    shutil.rmtree("dist")
+except:
+    pass
+
+for lang, profile in tqdm(config.main().items(), leave=False):
+    dist_replace = lambda x: x.replace(
+        config.INPUT_DIR, config.OUTPUT_DIR.format(lang), 1
+    )
+
+    for dir in glob.glob(os.path.join(config.INPUT_DIR, "**/")):
+        os.makedirs(dist_replace(dir), exist_ok=True)
+
+    paths = {}
+    files = glob.glob(os.path.join(config.INPUT_DIR, "**/*.yaml"))
+    for file in tqdm(files, leave=False):
+        file = file.replace(os.path.sep, "/")
+        with open(file, mode="r", encoding="utf-8") as f:
+            load = yaml.safe_load(f)
+        for path in list(load["paths"]):
+            for method in list(load["paths"][path]):
+                for tag in list(load["paths"][path][method].get("tags", ["default"])):
+                    key, value = path, load["paths"][path][method]
+                    for hook in profile["request"][tag]:
+                        hook: RequestHookBase
+                        key, value = hook.hook(key, value)
+                    load["paths"][path][method] = value
+                    load["paths"][key] = load["paths"].pop(path)
+
+                    escape = key.replace("/", "~1")
+                    relative = file.replace(config.INPUT_DIR, "", 1)
+                    paths.update({key: {"$ref": f".{relative}#/paths/{escape}"}})
+        for name in list(load.get("components", {}).get("schemas", {})):
+            value = load["components"]["schemas"][name]
+            for hook in profile["schemas"]:
+                hook: SchemasHookBase
+                value = hook.hook(value)
+            load["components"]["schemas"][name] = value
+        if file == "src/openapi/paths/other.yaml":
+            for hook in profile["other"]:
+                hook: OtherHookBase
+                key, value = hook.hook()
+                load["components"]["schemas"][key] = value
+                load["components"]["schemas"]["OtherResponse"]["properties"][key] = {
+                    "$ref": f"#/components/schemas/{key}"
+                }
+        with open(dist_replace(file), mode="w+", encoding="utf-8") as f:
+            f.write(yaml.dump(load))
+
+    file = "src/openapi/openapi-3.0.yaml"
+    with open(file, mode="r", encoding="utf-8") as f:
+        openapi = yaml.safe_load(f)
+    for path in paths:
+        openapi["paths"] = paths
+    for hook in profile["openapi"]:
+        hook: OpenapiHookBase
+        openapi = hook.hook(openapi)
+    with open(dist_replace(file), mode="w+", encoding="utf-8") as f:
+        f.write(yaml.dump(openapi))
+
+print("=== Build End ===")