simstudioai--sim/apps/sim/tools/reddit/get_posts.ts

import { validateEnum } from '@/lib/core/security/input-validation'
import type { RedditPostsParams, RedditPostsResponse } from '@/tools/reddit/types'
import { normalizeSubreddit } from '@/tools/reddit/utils'
import type { ToolConfig } from '@/tools/types'

const ALLOWED_SORT_OPTIONS = ['hot', 'new', 'top', 'controversial', 'rising'] as const

export const getPostsTool: ToolConfig<RedditPostsParams, RedditPostsResponse> = {
  id: 'reddit_get_posts',
  name: 'Get Reddit Posts',
  description: 'Fetch posts from a subreddit with different sorting options',
  version: '1.0.0',

  oauth: {
    required: true,
    provider: 'reddit',
  },

  params: {
    accessToken: {
      type: 'string',
      required: true,
      visibility: 'hidden',
      description: 'Access token for Reddit API',
    },
    subreddit: {
      type: 'string',
      required: true,
      visibility: 'user-or-llm',
      description: 'The subreddit to fetch posts from (e.g., "technology", "news")',
    },
    sort: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description:
        'Sort method for posts (e.g., "hot", "new", "top", "rising", "controversial"). Default: "hot"',
    },
    limit: {
      type: 'number',
      required: false,
      visibility: 'user-or-llm',
      description: 'Maximum number of posts to return (e.g., 25). Default: 10, max: 100',
    },
    time: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description:
        'Time filter for "top" sorted posts: "day", "week", "month", "year", or "all" (default: "all")',
    },
    after: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Fullname of a thing to fetch items after (for pagination)',
    },
    before: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Fullname of a thing to fetch items before (for pagination)',
    },
    count: {
      type: 'number',
      required: false,
      visibility: 'user-or-llm',
      description: 'A count of items already seen in the listing (used for numbering)',
    },
    show: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Show items that would normally be filtered (e.g., "all")',
    },
    sr_detail: {
      type: 'boolean',
      required: false,
      visibility: 'user-or-llm',
      description: 'Expand subreddit details in the response',
    },
    g: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Geo filter for posts (e.g., "GLOBAL", "US", "AR", etc.)',
    },
  },

  request: {
    url: (params: RedditPostsParams) => {
      const subreddit = normalizeSubreddit(params.subreddit)
      const sort = params.sort || 'hot'
      const sortValidation = validateEnum(sort, ALLOWED_SORT_OPTIONS, 'sort')
      if (!sortValidation.isValid) {
        throw new Error(sortValidation.error)
      }
      const limit = Math.min(Math.max(1, params.limit ?? 10), 100)

      const urlParams = new URLSearchParams({
        limit: limit.toString(),
        raw_json: '1',
      })

      if (
        (sort === 'top' || sort === 'controversial') &&
        params.time !== undefined &&
        params.time !== null
      ) {
        urlParams.append('t', params.time)
      }

      if (params.after !== undefined && params.after !== null && params.after !== '')
        urlParams.append('after', params.after)
      if (params.before !== undefined && params.before !== null && params.before !== '')
        urlParams.append('before', params.before)
      if (params.count !== undefined && params.count !== null)
        urlParams.append('count', params.count.toString())
      if (params.show !== undefined && params.show !== null && params.show !== '')
        urlParams.append('show', params.show)
      if (params.sr_detail !== undefined && params.sr_detail !== null)
        urlParams.append('sr_detail', params.sr_detail.toString())
      if (params.g) urlParams.append('g', params.g)

      return `https://oauth.reddit.com/r/${subreddit}/${sort}?${urlParams.toString()}`
    },
    method: 'GET',
    headers: (params: RedditPostsParams) => {
      if (!params.accessToken) {
        throw new Error('Access token is required for Reddit API')
      }

      return {
        Authorization: `Bearer ${params.accessToken}`,
        'User-Agent': 'sim-studio/1.0 (https://github.com/simstudioai/sim)',
        Accept: 'application/json',
      }
    },
  },

  transformResponse: async (response: Response, requestParams?: RedditPostsParams) => {
    const data = await response.json()

    const subredditName =
      data.data?.children?.[0]?.data?.subreddit || requestParams?.subreddit || 'unknown'

    const posts =
      data.data?.children?.map((child: any) => {
        const post = child.data || {}
        return {
          id: post.id ?? '',
          name: post.name ?? '',
          title: post.title ?? '',
          author: post.author || '[deleted]',
          url: post.url ?? '',
          permalink: post.permalink ? `https://www.reddit.com${post.permalink}` : '',
          created_utc: post.created_utc ?? 0,
          score: post.score ?? 0,
          num_comments: post.num_comments ?? 0,
          is_self: !!post.is_self,
          selftext: post.selftext ?? '',
          thumbnail: post.thumbnail ?? '',
          subreddit: post.subreddit ?? subredditName,
        }
      }) || []

    return {
      success: true,
      output: {
        subreddit: subredditName,
        posts,
        after: data.data?.after ?? null,
        before: data.data?.before ?? null,
      },
    }
  },

  outputs: {
    subreddit: {
      type: 'string',
      description: 'Name of the subreddit where posts were fetched from',
    },
    posts: {
      type: 'array',
      description: 'Array of posts with title, author, URL, score, comments count, and metadata',
      items: {
        type: 'object',
        properties: {
          id: { type: 'string', description: 'Post ID' },
          name: { type: 'string', description: 'Thing fullname (t3_xxxxx)' },
          title: { type: 'string', description: 'Post title' },
          author: { type: 'string', description: 'Author username' },
          url: { type: 'string', description: 'Post URL' },
          permalink: { type: 'string', description: 'Reddit permalink' },
          score: { type: 'number', description: 'Post score (upvotes - downvotes)' },
          num_comments: { type: 'number', description: 'Number of comments' },
          created_utc: { type: 'number', description: 'Creation timestamp (UTC)' },
          is_self: { type: 'boolean', description: 'Whether this is a text post' },
          selftext: { type: 'string', description: 'Text content for self posts' },
          thumbnail: { type: 'string', description: 'Thumbnail URL' },
          subreddit: { type: 'string', description: 'Subreddit name' },
        },
      },
    },
    after: {
      type: 'string',
      description: 'Fullname of the last item for forward pagination',
      optional: true,
    },
    before: {
      type: 'string',
      description: 'Fullname of the first item for backward pagination',
      optional: true,
    },
  },
}