x-twitter-scraper 0.5.5 → 0.7.0

data/rbi/x_twitter_scraper/models/paginated_tweets.rbi

@@ -24,11 +24,10 @@ module XTwitterScraper
       sig { returns(T::Array[XTwitterScraper::SearchTweet]) }
       attr_accessor :tweets
 
-      # Paginated tweet results. The item count can be lower than pageSize when the
-      # source returns fewer tweets, filters remove tweets, or remaining credits cover
-      # fewer results. Follow next_cursor while has_next_page is true. An empty page can
-      # still have has_next_page true after filtering. Zero affordable results returns
-      # 402 insufficient_credits.
+      # Paginated tweets. Source visibility, filters, or remaining credits can reduce
+      # results. An empty filtered page can still have has_next_page true. Follow
+      # next_cursor while has_next_page is true. Zero affordable results returns 402
+      # insufficient_credits.
       sig do
         params(
           has_next_page: T::Boolean,

data/rbi/x_twitter_scraper/models/radar_item.rbi

@@ -22,12 +22,24 @@ module XTwitterScraper
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # BCP-47 language code. und means the source did not identify a language.
       sig { returns(String) }
       attr_accessor :language
 
       # Source-specific fields. Shape varies per source:
       #
-      # - reddit: { subreddit: string, author: string }
+      # - reddit: { author, authorId?, subreddit, subredditId?, subredditSubscribers?,
+      #   sourceFormat, score?, upvoteRatio?, estimatedUpvotes?, estimatedDownvotes?,
+      #   numberComments?, numberCrossposts?, selftext?, contentUrl?, domain?,
+      #   postHint?, linkFlairText?, distinguished?, totalAwardsReceived?, viewCount?,
+      #   editedAt?, galleryImageUrls?, redditVideo?, archived?, contestMode?,
+      #   isCrosspostable?, isMeta?, isNsfw?, isOriginalContent?, isRobotIndexable?,
+      #   isSelf?, isSpoiler?, isVideo?, locked?, stickied? }. `score` is Reddit's
+      #   public net score. Exact public upvote and downvote counts are not available.
+      #   Estimated counts derive from the public score and upvote ratio, which Reddit
+      #   may fuzz. Comment bodies are not included. Current items combine public
+      #   listing discovery with server-rendered post data and use `sourceFormat: html`;
+      #   `json` and `rss` remain for legacy rows.
       # - github: { starsToday: number }
       # - hacker_news: { points: number, numberComments: number }
       # - google_trends: { approxTraffic: number }
@@ -35,9 +47,19 @@ module XTwitterScraper
       # - wikipedia: { views: number }
       # - trustmrr: { mrr, growthPercent, last30Days, total, customers,
       #   activeSubscriptions, onSale, xHandle?, category?, askingPrice?, country?,
-      #   growthMrrPercent?, multiple?, paymentProvider?, rank? }
-      sig { returns(T::Hash[Symbol, T.anything]) }
-      attr_accessor :metadata
+      #   foundedDate?, googleSearchImpressionsLast30Days?, growthMrrPercent?,
+      #   multiple?, paymentProvider?, profitMarginLast30Days?, rank?,
+      #   revenuePerVisitor?, targetAudience?, visitorsLast30Days? } For the startup
+      #   growth source, xHandle is the founder's X username without @. The rank field
+      #   is the source's revenue rank. Result order represents reported 30-day
+      #   revenue-growth rank.
+      sig { returns(XTwitterScraper::RadarItem::Metadata) }
+      attr_reader :metadata
+
+      sig do
+        params(metadata: XTwitterScraper::RadarItem::Metadata::OrHash).void
+      end
+      attr_writer :metadata
 
       sig { returns(Time) }
       attr_accessor :published_at
@@ -64,6 +86,7 @@ module XTwitterScraper
       sig { params(description: String).void }
       attr_writer :description
 
+      # Source image. Startup growth items return the logo here.
       sig { returns(T.nilable(String)) }
       attr_reader :image_url
 
@@ -84,7 +107,7 @@ module XTwitterScraper
           category: XTwitterScraper::RadarItem::Category::OrSymbol,
           created_at: Time,
           language: String,
-          metadata: T::Hash[Symbol, T.anything],
+          metadata: XTwitterScraper::RadarItem::Metadata::OrHash,
           published_at: Time,
           region: String,
           score: Float,
@@ -101,10 +124,22 @@ module XTwitterScraper
         id:,
         category:,
         created_at:,
+        # BCP-47 language code. und means the source did not identify a language.
         language:,
         # Source-specific fields. Shape varies per source:
         #
-        # - reddit: { subreddit: string, author: string }
+        # - reddit: { author, authorId?, subreddit, subredditId?, subredditSubscribers?,
+        #   sourceFormat, score?, upvoteRatio?, estimatedUpvotes?, estimatedDownvotes?,
+        #   numberComments?, numberCrossposts?, selftext?, contentUrl?, domain?,
+        #   postHint?, linkFlairText?, distinguished?, totalAwardsReceived?, viewCount?,
+        #   editedAt?, galleryImageUrls?, redditVideo?, archived?, contestMode?,
+        #   isCrosspostable?, isMeta?, isNsfw?, isOriginalContent?, isRobotIndexable?,
+        #   isSelf?, isSpoiler?, isVideo?, locked?, stickied? }. `score` is Reddit's
+        #   public net score. Exact public upvote and downvote counts are not available.
+        #   Estimated counts derive from the public score and upvote ratio, which Reddit
+        #   may fuzz. Comment bodies are not included. Current items combine public
+        #   listing discovery with server-rendered post data and use `sourceFormat: html`;
+        #   `json` and `rss` remain for legacy rows.
         # - github: { starsToday: number }
         # - hacker_news: { points: number, numberComments: number }
         # - google_trends: { approxTraffic: number }
@@ -112,7 +147,12 @@ module XTwitterScraper
         # - wikipedia: { views: number }
         # - trustmrr: { mrr, growthPercent, last30Days, total, customers,
         #   activeSubscriptions, onSale, xHandle?, category?, askingPrice?, country?,
-        #   growthMrrPercent?, multiple?, paymentProvider?, rank? }
+        #   foundedDate?, googleSearchImpressionsLast30Days?, growthMrrPercent?,
+        #   multiple?, paymentProvider?, profitMarginLast30Days?, rank?,
+        #   revenuePerVisitor?, targetAudience?, visitorsLast30Days? } For the startup
+        #   growth source, xHandle is the founder's X username without @. The rank field
+        #   is the source's revenue rank. Result order represents reported 30-day
+        #   revenue-growth rank.
         metadata:,
         published_at:,
         region:,
@@ -122,6 +162,7 @@ module XTwitterScraper
         source_id:,
         title:,
         description: nil,
+        # Source image. Startup growth items return the logo here.
         image_url: nil,
         url: nil
       )
@@ -134,7 +175,7 @@ module XTwitterScraper
             category: XTwitterScraper::RadarItem::Category::TaggedSymbol,
             created_at: Time,
             language: String,
-            metadata: T::Hash[Symbol, T.anything],
+            metadata: XTwitterScraper::RadarItem::Metadata,
             published_at: Time,
             region: String,
             score: Float,
@@ -184,6 +225,202 @@ module XTwitterScraper
         end
       end
 
+      class Metadata < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::RadarItem::Metadata,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :author
+
+        sig { params(author: String).void }
+        attr_writer :author
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :content_url
+
+        sig { params(content_url: String).void }
+        attr_writer :content_url
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :estimated_downvotes
+
+        sig { params(estimated_downvotes: Integer).void }
+        attr_writer :estimated_downvotes
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :estimated_upvotes
+
+        sig { params(estimated_upvotes: Integer).void }
+        attr_writer :estimated_upvotes
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :number_comments
+
+        sig { params(number_comments: Integer).void }
+        attr_writer :number_comments
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :score
+
+        sig { params(score: Integer).void }
+        attr_writer :score
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :selftext
+
+        sig { params(selftext: String).void }
+        attr_writer :selftext
+
+        # Current items use html. json and rss are retained for legacy rows.
+        sig do
+          returns(
+            T.nilable(
+              XTwitterScraper::RadarItem::Metadata::SourceFormat::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :source_format
+
+        sig do
+          params(
+            source_format:
+              XTwitterScraper::RadarItem::Metadata::SourceFormat::OrSymbol
+          ).void
+        end
+        attr_writer :source_format
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :subreddit
+
+        sig { params(subreddit: String).void }
+        attr_writer :subreddit
+
+        sig { returns(T.nilable(Float)) }
+        attr_reader :upvote_ratio
+
+        sig { params(upvote_ratio: Float).void }
+        attr_writer :upvote_ratio
+
+        # Source-specific fields. Shape varies per source:
+        #
+        # - reddit: { author, authorId?, subreddit, subredditId?, subredditSubscribers?,
+        #   sourceFormat, score?, upvoteRatio?, estimatedUpvotes?, estimatedDownvotes?,
+        #   numberComments?, numberCrossposts?, selftext?, contentUrl?, domain?,
+        #   postHint?, linkFlairText?, distinguished?, totalAwardsReceived?, viewCount?,
+        #   editedAt?, galleryImageUrls?, redditVideo?, archived?, contestMode?,
+        #   isCrosspostable?, isMeta?, isNsfw?, isOriginalContent?, isRobotIndexable?,
+        #   isSelf?, isSpoiler?, isVideo?, locked?, stickied? }. `score` is Reddit's
+        #   public net score. Exact public upvote and downvote counts are not available.
+        #   Estimated counts derive from the public score and upvote ratio, which Reddit
+        #   may fuzz. Comment bodies are not included. Current items combine public
+        #   listing discovery with server-rendered post data and use `sourceFormat: html`;
+        #   `json` and `rss` remain for legacy rows.
+        # - github: { starsToday: number }
+        # - hacker_news: { points: number, numberComments: number }
+        # - google_trends: { approxTraffic: number }
+        # - polymarket: { volume24hr: number }
+        # - wikipedia: { views: number }
+        # - trustmrr: { mrr, growthPercent, last30Days, total, customers,
+        #   activeSubscriptions, onSale, xHandle?, category?, askingPrice?, country?,
+        #   foundedDate?, googleSearchImpressionsLast30Days?, growthMrrPercent?,
+        #   multiple?, paymentProvider?, profitMarginLast30Days?, rank?,
+        #   revenuePerVisitor?, targetAudience?, visitorsLast30Days? } For the startup
+        #   growth source, xHandle is the founder's X username without @. The rank field
+        #   is the source's revenue rank. Result order represents reported 30-day
+        #   revenue-growth rank.
+        sig do
+          params(
+            author: String,
+            content_url: String,
+            estimated_downvotes: Integer,
+            estimated_upvotes: Integer,
+            number_comments: Integer,
+            score: Integer,
+            selftext: String,
+            source_format:
+              XTwitterScraper::RadarItem::Metadata::SourceFormat::OrSymbol,
+            subreddit: String,
+            upvote_ratio: Float
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          author: nil,
+          content_url: nil,
+          estimated_downvotes: nil,
+          estimated_upvotes: nil,
+          number_comments: nil,
+          score: nil,
+          selftext: nil,
+          # Current items use html. json and rss are retained for legacy rows.
+          source_format: nil,
+          subreddit: nil,
+          upvote_ratio: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              author: String,
+              content_url: String,
+              estimated_downvotes: Integer,
+              estimated_upvotes: Integer,
+              number_comments: Integer,
+              score: Integer,
+              selftext: String,
+              source_format:
+                XTwitterScraper::RadarItem::Metadata::SourceFormat::TaggedSymbol,
+              subreddit: String,
+              upvote_ratio: Float
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Current items use html. json and rss are retained for legacy rows.
+        module SourceFormat
+          extend XTwitterScraper::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, XTwitterScraper::RadarItem::Metadata::SourceFormat)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HTML =
+            T.let(
+              :html,
+              XTwitterScraper::RadarItem::Metadata::SourceFormat::TaggedSymbol
+            )
+          JSON =
+            T.let(
+              :json,
+              XTwitterScraper::RadarItem::Metadata::SourceFormat::TaggedSymbol
+            )
+          RSS =
+            T.let(
+              :rss,
+              XTwitterScraper::RadarItem::Metadata::SourceFormat::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                XTwitterScraper::RadarItem::Metadata::SourceFormat::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       module Source
         extend XTwitterScraper::Internal::Type::Enum