@crosspost/types 0.1.2 → 0.1.4

package/dist/index.js

@@ -1,18 +1,20 @@
 // src/common.ts
 import { z } from "zod";
-var PlatformSchema = z.enum([
-  "unknown",
-  "twitter"
-  // Add more platforms as they're implemented
-  // 'linkedin',
-  // 'facebook',
-  // 'instagram',
-]).describe("Social media platform");
 var Platform = /* @__PURE__ */ ((Platform2) => {
   Platform2["UNKNOWN"] = "unknown";
   Platform2["TWITTER"] = "twitter";
   return Platform2;
 })(Platform || {});
+var PlatformSchema = z.nativeEnum(Platform).describe("Social media platform");
+var SUPPORTED_PLATFORMS = [
+  "twitter" /* TWITTER */
+  // Add more platforms here as they're implemented
+];
+var SupportedPlatformSchema = SUPPORTED_PLATFORMS.length > 0 ? z.enum(SUPPORTED_PLATFORMS) : z.never();
+SupportedPlatformSchema.describe("Currently supported social media platforms");
+function isPlatformSupported(platform) {
+  return SUPPORTED_PLATFORMS.includes(platform);
+}
 
 // src/response.ts
 import { z as z2 } from "zod";
@@ -639,15 +641,23 @@ var EndpointRateLimitResponseSchema = z5.object({
   signerId: z5.string().describe("NEAR account ID")
 }).describe("Endpoint rate limit response");
 
-// src/leaderboard.ts
+// src/activity.ts
 import { z as z6 } from "zod";
-var LeaderboardQuerySchema = z6.object({
+var TimePeriod = /* @__PURE__ */ ((TimePeriod2) => {
+  TimePeriod2["ALL_TIME"] = "all";
+  TimePeriod2["YEARLY"] = "yearly";
+  TimePeriod2["MONTHLY"] = "monthly";
+  TimePeriod2["WEEKLY"] = "weekly";
+  TimePeriod2["DAILY"] = "daily";
+  return TimePeriod2;
+})(TimePeriod || {});
+var ActivityLeaderboardQuerySchema = z6.object({
   timeframe: z6.enum(["day", "week", "month", "all"]).optional().describe(
     "Timeframe for the leaderboard"
   ),
   limit: z6.string().optional().transform((val) => val ? parseInt(val, 10) : void 0).pipe(z6.number().min(1).max(100).optional()).describe("Maximum number of results to return (1-100)"),
   offset: z6.string().optional().transform((val) => val ? parseInt(val, 10) : void 0).pipe(z6.number().min(0).optional()).describe("Offset for pagination")
-}).describe("Leaderboard query");
+}).describe("Activity leaderboard query");
 var AccountActivityEntrySchema = z6.object({
   signerId: z6.string().describe("NEAR account ID"),
   totalPosts: z6.number().describe("Total number of posts"),
@@ -659,7 +669,7 @@ var AccountActivityEntrySchema = z6.object({
   rank: z6.number().describe("Rank on the leaderboard"),
   lastActive: z6.string().datetime().describe("Timestamp of last activity")
 }).describe("Account activity entry");
-var LeaderboardResponseSchema = EnhancedResponseSchema(
+var ActivityLeaderboardResponseSchema = EnhancedResponseSchema(
   z6.object({
     timeframe: z6.enum(["day", "week", "month", "all"]).describe("Timeframe for the leaderboard"),
     entries: z6.array(AccountActivityEntrySchema).describe("Leaderboard entries"),
@@ -668,7 +678,7 @@ var LeaderboardResponseSchema = EnhancedResponseSchema(
     offset: z6.number().describe("Offset for pagination"),
     generatedAt: z6.string().datetime().describe("Timestamp when the leaderboard was generated")
   })
-).describe("Leaderboard response");
+).describe("Activity leaderboard response");
 var AccountActivityParamsSchema = z6.object({
   signerId: z6.string().describe("NEAR account ID")
 }).describe("Account activity params");
@@ -771,6 +781,8 @@ export {
   AccountPostsParamsSchema,
   AccountPostsQuerySchema,
   AccountPostsResponseSchema,
+  ActivityLeaderboardQuerySchema,
+  ActivityLeaderboardResponseSchema,
   AllRateLimitsResponseSchema,
   ApiError,
   ApiErrorCode,
@@ -798,8 +810,6 @@ export {
   EnhancedResponseSchema,
   ErrorDetailSchema,
   ErrorResponseSchema,
-  LeaderboardQuerySchema,
-  LeaderboardResponseSchema,
   LikePostRequestSchema,
   LikePostResponseSchema,
   LikeResultSchema,
@@ -836,8 +846,11 @@ export {
   ReplyToPostResponseSchema,
   RepostRequestSchema,
   RepostResponseSchema,
+  SUPPORTED_PLATFORMS,
   SuccessDetailSchema,
+  SupportedPlatformSchema,
   TargetSchema,
+  TimePeriod,
   UnlikePostRequestSchema,
   UnlikePostResponseSchema,
   UsageRateLimitSchema,
@@ -848,5 +861,6 @@ export {
   createErrorDetail,
   createErrorResponse,
   createMultiStatusResponse,
-  createSuccessDetail
+  createSuccessDetail,
+  isPlatformSupported
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crosspost/types",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Shared type definitions for Crosspost API",
   "type": "module",
   "main": "dist/index.cjs",

package/src/activity.ts

@@ -0,0 +1,247 @@
+/**
+ * Activity Schemas and Types
+ * Defines Zod schemas for activity-related requests and responses
+ * TypeScript types are derived from Zod schemas for type safety
+ */
+
+import { z } from 'zod';
+import { EnhancedResponseSchema } from './response.ts';
+import { PlatformSchema } from './common.ts';
+
+/**
+ * Time periods for activity filtering
+ */
+export enum TimePeriod {
+  ALL_TIME = 'all',
+  YEARLY = 'yearly',
+  MONTHLY = 'monthly',
+  WEEKLY = 'weekly',
+  DAILY = 'daily',
+}
+
+/**
+ * Activity leaderboard query schema
+ */
+export const ActivityLeaderboardQuerySchema = z.object({
+  timeframe: z.enum(['day', 'week', 'month', 'all']).optional().describe(
+    'Timeframe for the leaderboard',
+  ),
+  limit: z.string().optional()
+    .transform((val) => val ? parseInt(val, 10) : undefined)
+    .pipe(z.number().min(1).max(100).optional())
+    .describe('Maximum number of results to return (1-100)'),
+  offset: z.string().optional()
+    .transform((val) => val ? parseInt(val, 10) : undefined)
+    .pipe(z.number().min(0).optional())
+    .describe('Offset for pagination'),
+}).describe('Activity leaderboard query');
+
+/**
+ * Account activity entry schema
+ */
+export const AccountActivityEntrySchema = z.object({
+  signerId: z.string().describe('NEAR account ID'),
+  totalPosts: z.number().describe('Total number of posts'),
+  totalLikes: z.number().describe('Total number of likes'),
+  totalReposts: z.number().describe('Total number of reposts'),
+  totalReplies: z.number().describe('Total number of replies'),
+  totalQuotes: z.number().describe('Total number of quote posts'),
+  totalScore: z.number().describe('Total activity score'),
+  rank: z.number().describe('Rank on the leaderboard'),
+  lastActive: z.string().datetime().describe('Timestamp of last activity'),
+}).describe('Account activity entry');
+
+/**
+ * Activity leaderboard response schema
+ */
+export const ActivityLeaderboardResponseSchema = EnhancedResponseSchema(
+  z.object({
+    timeframe: z.enum(['day', 'week', 'month', 'all']).describe('Timeframe for the leaderboard'),
+    entries: z.array(AccountActivityEntrySchema).describe('Leaderboard entries'),
+    total: z.number().describe('Total number of entries in the leaderboard'),
+    limit: z.number().describe('Maximum number of results returned'),
+    offset: z.number().describe('Offset for pagination'),
+    generatedAt: z.string().datetime().describe('Timestamp when the leaderboard was generated'),
+  }),
+).describe('Activity leaderboard response');
+
+/**
+ * Account activity params schema
+ */
+export const AccountActivityParamsSchema = z.object({
+  signerId: z.string().describe('NEAR account ID'),
+}).describe('Account activity params');
+
+/**
+ * Account activity query schema
+ */
+export const AccountActivityQuerySchema = z.object({
+  timeframe: z.enum(['day', 'week', 'month', 'all']).optional().describe(
+    'Timeframe for the activity',
+  ),
+}).describe('Account activity query');
+
+/**
+ * Platform activity schema
+ */
+export const PlatformActivitySchema = z.object({
+  platform: PlatformSchema,
+  posts: z.number().describe('Number of posts on this platform'),
+  likes: z.number().describe('Number of likes on this platform'),
+  reposts: z.number().describe('Number of reposts on this platform'),
+  replies: z.number().describe('Number of replies on this platform'),
+  quotes: z.number().describe('Number of quote posts on this platform'),
+  score: z.number().describe('Activity score on this platform'),
+  lastActive: z.string().datetime().describe('Timestamp of last activity on this platform'),
+}).describe('Platform activity');
+
+/**
+ * Account activity response schema
+ */
+export const AccountActivityResponseSchema = EnhancedResponseSchema(
+  z.object({
+    signerId: z.string().describe('NEAR account ID'),
+    timeframe: z.enum(['day', 'week', 'month', 'all']).describe('Timeframe for the activity'),
+    totalPosts: z.number().describe('Total number of posts across all platforms'),
+    totalLikes: z.number().describe('Total number of likes across all platforms'),
+    totalReposts: z.number().describe('Total number of reposts across all platforms'),
+    totalReplies: z.number().describe('Total number of replies across all platforms'),
+    totalQuotes: z.number().describe('Total number of quote posts across all platforms'),
+    totalScore: z.number().describe('Total activity score across all platforms'),
+    rank: z.number().describe('Rank on the leaderboard'),
+    lastActive: z.string().datetime().describe('Timestamp of last activity across all platforms'),
+    platforms: z.array(PlatformActivitySchema).describe('Activity breakdown by platform'),
+  }),
+).describe('Account activity response');
+
+/**
+ * Account posts params schema
+ */
+export const AccountPostsParamsSchema = z.object({
+  signerId: z.string().describe('NEAR account ID'),
+}).describe('Account posts params');
+
+/**
+ * Account posts query schema
+ */
+export const AccountPostsQuerySchema = z.object({
+  platform: z.string().optional().describe('Filter by platform (optional)'),
+  limit: z.string().optional()
+    .transform((val) => val ? parseInt(val, 10) : undefined)
+    .pipe(z.number().min(1).max(100).optional())
+    .describe('Maximum number of results to return (1-100)'),
+  offset: z.string().optional()
+    .transform((val) => val ? parseInt(val, 10) : undefined)
+    .pipe(z.number().min(0).optional())
+    .describe('Offset for pagination'),
+  type: z.enum(['post', 'repost', 'reply', 'quote', 'like', 'all']).optional().describe(
+    'Filter by post type (optional)',
+  ),
+}).describe('Account posts query');
+
+/**
+ * Account post schema
+ */
+export const AccountPostSchema = z.object({
+  id: z.string().describe('Post ID'),
+  platform: PlatformSchema,
+  type: z.enum(['post', 'repost', 'reply', 'quote', 'like']).describe('Type of post'),
+  content: z.string().optional().describe('Post content (if available)'),
+  url: z.string().url().optional().describe('URL to the post on the platform (if available)'),
+  createdAt: z.string().datetime().describe('Timestamp when the post was created'),
+  metrics: z.object({
+    likes: z.number().optional().describe('Number of likes (if available)'),
+    reposts: z.number().optional().describe('Number of reposts (if available)'),
+    replies: z.number().optional().describe('Number of replies (if available)'),
+    quotes: z.number().optional().describe('Number of quotes (if available)'),
+  }).optional().describe('Post metrics (if available)'),
+  inReplyToId: z.string().optional().describe('ID of the post this is a reply to (if applicable)'),
+  quotedPostId: z.string().optional().describe('ID of the post this is quoting (if applicable)'),
+}).describe('Account post');
+
+/**
+ * Account posts response schema
+ */
+export const AccountPostsResponseSchema = EnhancedResponseSchema(
+  z.object({
+    signerId: z.string().describe('NEAR account ID'),
+    posts: z.array(AccountPostSchema).describe('List of posts'),
+    total: z.number().describe('Total number of posts matching the query'),
+    limit: z.number().describe('Maximum number of results returned'),
+    offset: z.number().describe('Offset for pagination'),
+    platform: z.string().optional().describe('Platform filter (if applied)'),
+    type: z.enum(['post', 'repost', 'reply', 'quote', 'like', 'all']).optional().describe(
+      'Post type filter (if applied)',
+    ),
+  }),
+).describe('Account posts response');
+
+/**
+ * Interface for account activity data
+ */
+export interface AccountActivity {
+  signerId: string;
+  postCount: number;
+  firstPostTimestamp: number;
+  lastPostTimestamp: number;
+}
+
+/**
+ * Interface for platform-specific account activity data
+ */
+export interface PlatformAccountActivity extends AccountActivity {
+  platform: string;
+}
+
+/**
+ * Interface for post record data (storage optimized)
+ */
+export interface PostRecord {
+  id: string; // postId
+  p: string; // platform
+  t: number; // timestamp
+  u: string; // userId
+}
+
+/**
+ * Interface for post record data (API response)
+ */
+export interface PostRecordResponse {
+  postId: string;
+  platform: string;
+  timestamp: string;
+  userId: string;
+}
+
+/**
+ * Interface for leaderboard entry
+ */
+export interface LeaderboardEntry {
+  signerId: string;
+  postCount: number;
+  lastPostTimestamp: number;
+}
+
+/**
+ * Interface for platform-specific leaderboard entry
+ */
+export interface PlatformLeaderboardEntry extends LeaderboardEntry {
+  platform: string;
+}
+
+// Derive TypeScript types from Zod schemas
+export type ActivityLeaderboardQuery = z.infer<typeof ActivityLeaderboardQuerySchema>;
+export type AccountActivityEntry = z.infer<typeof AccountActivityEntrySchema>;
+export type ActivityLeaderboardResponse = z.infer<typeof ActivityLeaderboardResponseSchema>;
+export type AccountActivityParams = z.infer<typeof AccountActivityParamsSchema>;
+export type AccountActivityQuery = z.infer<typeof AccountActivityQuerySchema>;
+export type PlatformActivity = z.infer<typeof PlatformActivitySchema>;
+export type AccountActivityResponse = z.infer<typeof AccountActivityResponseSchema>;
+export type AccountPostsParams = z.infer<typeof AccountPostsParamsSchema>;
+export type AccountPostsQuery = z.infer<typeof AccountPostsQuerySchema>;
+export type AccountPost = z.infer<typeof AccountPostSchema>;
+export type AccountPostsResponse = z.infer<typeof AccountPostsResponseSchema>;
+
+// Legacy type aliases for backward compatibility
+export type LeaderboardQuery = ActivityLeaderboardQuery;
+export type LeaderboardResponse = ActivityLeaderboardResponse;

package/src/common.ts

@@ -6,22 +6,7 @@
 import { z } from 'zod';
 
 /**
- * Platform schema
- */
-export const PlatformSchema = z.enum([
-  'unknown',
-  'twitter',
-  // Add more platforms as they're implemented
-  // 'linkedin',
-  // 'facebook',
-  // 'instagram',
-]).describe('Social media platform');
-
-// Derive TypeScript types from Zod schemas
-export type PlatformName = z.infer<typeof PlatformSchema>;
-
-/**
- * Enum for supported platforms (for backward compatibility)
+ * Platform enum - All platforms (including planned ones)
  */
 export enum Platform {
   UNKNOWN = 'unknown',
@@ -31,3 +16,34 @@ export enum Platform {
   // FACEBOOK = 'facebook',
   // INSTAGRAM = 'instagram',
 }
+
+export const PlatformSchema = z.nativeEnum(Platform)
+  .describe('Social media platform');
+
+/**
+ * Platform type - Derived from the Platform enum
+ */
+export type PlatformName = Platform;
+
+/**
+ * Array of currently supported platforms
+ */
+export const SUPPORTED_PLATFORMS = [
+  Platform.TWITTER,
+  // Add more platforms here as they're implemented
+] as const;
+
+export type SupportedPlatformName = typeof SUPPORTED_PLATFORMS[number];
+
+export const SupportedPlatformSchema = SUPPORTED_PLATFORMS.length > 0
+  ? z.enum(SUPPORTED_PLATFORMS)
+  : z.never();
+
+SupportedPlatformSchema.describe('Currently supported social media platforms');
+
+/**
+ * Check if a platform is currently supported
+ */
+export function isPlatformSupported(platform: Platform): platform is SupportedPlatformName {
+  return (SUPPORTED_PLATFORMS as readonly Platform[]).includes(platform);
+}

package/src/index.ts

@@ -16,5 +16,5 @@ export * from './errors/index.ts';
 export * from './auth.ts';
 export * from './post.ts';
 export * from './rate-limit.ts';
-export * from './leaderboard.ts';
+export * from './activity.ts';
 export * from './user-profile.ts';