@crosspost/types 0.1.6 → 0.1.8

package/src/post.ts

@@ -1,25 +1,13 @@
-/**
- * Post Schemas and Types
- * Defines Zod schemas for post-related requests and responses
- * TypeScript types are derived from Zod schemas for type safety
- */
-
 import { z } from 'zod';
 import { PlatformSchema } from './common.ts';
-import { EnhancedResponseSchema, ErrorDetailSchema } from './response.ts';
+import { ErrorDetailSchema } from './errors.ts';
 
-/**
- * Media content schema
- */
 export const MediaContentSchema = z.object({
   data: z.union([z.string(), z.instanceof(Blob)]).describe('Media data as string or Blob'),
   mimeType: z.string().optional().describe('Media MIME type'),
   altText: z.string().optional().describe('Alt text for the media'),
 }).describe('Media content object');
 
-/**
- * Media schema
- */
 export const MediaSchema = z.object({
   id: z.string().describe('Media ID'),
   type: z.enum(['image', 'video', 'gif']).describe('Media type'),
@@ -27,9 +15,6 @@ export const MediaSchema = z.object({
   altText: z.string().optional().describe('Alt text for the media'),
 }).describe('Media object');
 
-/**
- * Post metrics schema
- */
 export const PostMetricsSchema = z.object({
   retweets: z.number().describe('Number of retweets'),
   quotes: z.number().describe('Number of quotes'),
@@ -37,9 +22,6 @@ export const PostMetricsSchema = z.object({
   replies: z.number().describe('Number of replies'),
 }).describe('Post metrics');
 
-/**
- * Post schema
- */
 export const PostSchema = z.object({
   id: z.string().describe('Post ID'),
   text: z.string().describe('Post text content'),
@@ -51,17 +33,11 @@ export const PostSchema = z.object({
   quotedPostId: z.string().optional().describe('ID of the post this is quoting'),
 }).describe('Post object');
 
-/**
- * Post content schema
- */
 export const PostContentSchema = z.object({
   text: z.string().optional().describe('Text content for the post'),
   media: z.array(MediaContentSchema).optional().describe('Media attachments for the post'),
 }).describe('Post content');
 
-/**
- * Post result schema
- */
 export const PostResultSchema = z.object({
   id: z.string().describe('Post ID'),
   text: z.string().optional().describe('Post text content'),
@@ -73,25 +49,16 @@ export const PostResultSchema = z.object({
   success: z.boolean().optional().describe('Whether the operation was successful'),
 }).catchall(z.any()).describe('Post result');
 
-/**
- * Delete result schema
- */
 export const DeleteResultSchema = z.object({
   success: z.boolean().describe('Whether the deletion was successful'),
   id: z.string().describe('ID of the deleted post'),
 }).describe('Delete result');
 
-/**
- * Like result schema
- */
 export const LikeResultSchema = z.object({
   success: z.boolean().describe('Whether the like was successful'),
   id: z.string().describe('ID of the liked post'),
 }).describe('Like result');
 
-/**
- * Success detail schema for post operations
- */
 export const PostSuccessDetailSchema = z.object({
   platform: PlatformSchema,
   userId: z.string().describe('User ID'),
@@ -100,21 +67,11 @@ export const PostSuccessDetailSchema = z.object({
   postUrl: z.string().optional().describe('URL to the post'),
 }).catchall(z.any()).describe('Post success detail');
 
-/**
- * Request schemas
- */
-
-/**
- * Target schema - common for all operations
- */
 export const TargetSchema = z.object({
   platform: PlatformSchema.describe('The platform to post to (e.g., "twitter")'),
   userId: z.string().describe('User ID on the platform'),
 }).describe('Target for posting operations');
 
-/**
- * Create post request schema
- */
 export const CreatePostRequestSchema = z.object({
   targets: z.array(TargetSchema).describe('Array of targets to post to (can be a single target)'),
   content: z.array(PostContentSchema).describe(
@@ -122,18 +79,12 @@ export const CreatePostRequestSchema = z.object({
   ),
 }).describe('Create post request');
 
-/**
- * Repost request schema
- */
 export const RepostRequestSchema = z.object({
   targets: z.array(TargetSchema).describe('Array of targets to post to'),
   platform: PlatformSchema.describe('Platform of the post being reposted'),
   postId: z.string().describe('ID of the post to repost'),
 }).describe('Repost request');
 
-/**
- * Quote post request schema
- */
 export const QuotePostRequestSchema = z.object({
   targets: z.array(TargetSchema).describe(
     'Array of targets to post to (must be on the same platform as the post being quoted)',
@@ -145,9 +96,6 @@ export const QuotePostRequestSchema = z.object({
   ),
 }).describe('Quote post request');
 
-/**
- * Reply to post request schema
- */
 export const ReplyToPostRequestSchema = z.object({
   targets: z.array(TargetSchema).describe(
     'Array of targets to post to (must be on the same platform as the post being replied to)',
@@ -159,26 +107,17 @@ export const ReplyToPostRequestSchema = z.object({
   ),
 }).describe('Reply to post request');
 
-/**
- * Post to delete schema
- */
 export const PostToDeleteSchema = z.object({
   platform: PlatformSchema.describe('Platform of the post to delete'),
   userId: z.string().describe('User ID on the platform'),
   postId: z.string().describe('ID of the post to delete'),
 }).describe('Post to delete');
 
-/**
- * Delete post request schema
- */
 export const DeletePostRequestSchema = z.object({
   targets: z.array(TargetSchema).describe('Array of targets to delete posts'),
   posts: z.array(PostToDeleteSchema).describe('Array of posts to delete'),
 }).describe('Delete post request');
 
-/**
- * Like post request schema
- */
 export const LikePostRequestSchema = z.object({
   targets: z.array(TargetSchema).describe(
     'Array of targets to like the post (must be on the same platform as the post being liked)',
@@ -187,9 +126,6 @@ export const LikePostRequestSchema = z.object({
   postId: z.string().describe('ID of the post to like'),
 }).describe('Like post request');
 
-/**
- * Unlike post request schema
- */
 export const UnlikePostRequestSchema = z.object({
   targets: z.array(TargetSchema).describe(
     'Array of targets to unlike the post (must be on the same platform as the post being unliked)',
@@ -198,86 +134,42 @@ export const UnlikePostRequestSchema = z.object({
   postId: z.string().describe('ID of the post to unlike'),
 }).describe('Unlike post request');
 
-/**
- * Response schemas
- */
-
-/**
- * Post response schema
- */
-export const PostResponseSchema = EnhancedResponseSchema(
-  z.union([PostSchema, z.array(PostSchema)]),
-).describe('Post response');
+export const PostResponseSchema = z.union([PostSchema, z.array(PostSchema)]).describe(
+  'Post response',
+);
 
-/**
- * Create post response schema (legacy)
- */
-export const CreatePostResponseLegacySchema = PostResponseSchema.describe(
-  'Create post response (legacy)',
+export const CreatePostResponseSchema = PostResponseSchema.describe(
+  'Create post response',
 );
 
-/**
- * Repost response schema
- */
 export const RepostResponseSchema = PostResponseSchema.describe('Repost response');
 
-/**
- * Quote post response schema
- */
 export const QuotePostResponseSchema = PostResponseSchema.describe('Quote post response');
 
-/**
- * Reply to post response schema
- */
 export const ReplyToPostResponseSchema = PostResponseSchema.describe('Reply to post response');
 
-/**
- * Delete post response schema
- */
-export const DeletePostResponseSchema = EnhancedResponseSchema(
-  z.object({
-    success: z.boolean().describe('Whether the deletion was successful'),
-    id: z.string().describe('ID of the deleted post'),
-  }),
-).describe('Delete post response');
+export const DeletePostResponseSchema = z.object({
+  id: z.string().describe('ID of the deleted post'),
+}).describe('Delete post response');
 
-/**
- * Like post response schema
- */
-export const LikePostResponseSchema = EnhancedResponseSchema(
-  z.object({
-    success: z.boolean().describe('Whether the like was successful'),
-    id: z.string().describe('ID of the liked post'),
-  }),
-).describe('Like post response');
+export const LikePostResponseSchema = z.object({
+  id: z.string().describe('ID of the liked post'),
+}).describe('Like post response');
 
-/**
- * Unlike post response schema
- */
-export const UnlikePostResponseSchema = EnhancedResponseSchema(
-  z.object({
-    success: z.boolean().describe('Whether the unlike was successful'),
-    id: z.string().describe('ID of the unliked post'),
-  }),
-).describe('Unlike post response');
+export const UnlikePostResponseSchema = z.object({
+  id: z.string().describe('ID of the unliked post'),
+}).describe('Unlike post response');
 
-/**
- * Multi-status response schema for batch operations
- */
 export const PostMultiStatusResponseSchema = z.object({
-  success: z.boolean().describe('Whether the operation was partially or fully successful'),
-  data: z.object({
-    summary: z.object({
-      total: z.number().describe('Total number of operations'),
-      succeeded: z.number().describe('Number of successful operations'),
-      failed: z.number().describe('Number of failed operations'),
-    }),
-    results: z.array(PostSuccessDetailSchema).describe('Successful operations'),
-    errors: z.array(ErrorDetailSchema).describe('Failed operations'),
+  summary: z.object({
+    total: z.number().describe('Total number of operations'),
+    succeeded: z.number().describe('Number of successful operations'),
+    failed: z.number().describe('Number of failed operations'),
   }),
+  results: z.array(PostSuccessDetailSchema).describe('Successful operations'),
+  errors: z.array(ErrorDetailSchema).describe('Failed operations'),
 }).describe('Multi-status response for post operations');
 
-// Derive TypeScript types from Zod schemas
 export type Media = z.infer<typeof MediaSchema>;
 export type MediaContent = z.infer<typeof MediaContentSchema>;
 export type PostMetrics = z.infer<typeof PostMetricsSchema>;
@@ -290,7 +182,6 @@ export type PostSuccessDetail = z.infer<typeof PostSuccessDetailSchema>;
 export type Target = z.infer<typeof TargetSchema>;
 export type PostToDelete = z.infer<typeof PostToDeleteSchema>;
 
-// Request types
 export type CreatePostRequest = z.infer<typeof CreatePostRequestSchema>;
 export type RepostRequest = z.infer<typeof RepostRequestSchema>;
 export type QuotePostRequest = z.infer<typeof QuotePostRequestSchema>;
@@ -299,9 +190,8 @@ export type DeletePostRequest = z.infer<typeof DeletePostRequestSchema>;
 export type LikePostRequest = z.infer<typeof LikePostRequestSchema>;
 export type UnlikePostRequest = z.infer<typeof UnlikePostRequestSchema>;
 
-// Response types
 export type PostResponse = z.infer<typeof PostResponseSchema>;
-export type CreatePostResponse = z.infer<typeof CreatePostResponseLegacySchema>;
+export type CreatePostResponse = z.infer<typeof CreatePostResponseSchema>;
 export type RepostResponse = z.infer<typeof RepostResponseSchema>;
 export type QuotePostResponse = z.infer<typeof QuotePostResponseSchema>;
 export type ReplyToPostResponse = z.infer<typeof ReplyToPostResponseSchema>;
@@ -309,39 +199,3 @@ export type DeletePostResponse = z.infer<typeof DeletePostResponseSchema>;
 export type LikePostResponse = z.infer<typeof LikePostResponseSchema>;
 export type UnlikePostResponse = z.infer<typeof UnlikePostResponseSchema>;
 export type PostMultiStatusResponse = z.infer<typeof PostMultiStatusResponseSchema>;
-
-/**
- * Create post target result schema
- */
-export const CreatePostTargetResultSchema = z.object({
-  platform: PlatformSchema.describe('The platform the post was created on'),
-  userId: z.string().describe('The user ID on the platform'),
-  result: z.array(z.any()).describe('The result of the post creation'),
-}).describe('Create post target result');
-
-/**
- * Create post target error schema
- */
-export const CreatePostTargetErrorSchema = z.object({
-  platform: PlatformSchema.optional().describe(
-    'The platform where the error occurred (if applicable)',
-  ),
-  userId: z.string().optional().describe('The user ID where the error occurred (if applicable)'),
-  error: z.string().describe('The error message'),
-}).describe('Create post target error');
-
-/**
- * Create post response schema
- */
-export const CreatePostResponseSchema = EnhancedResponseSchema(
-  z.object({
-    results: z.array(CreatePostTargetResultSchema).describe('Array of successful post results'),
-    errors: z.array(CreatePostTargetErrorSchema).optional().describe(
-      'Array of errors that occurred (if any)',
-    ),
-  }),
-).describe('Create post response');
-
-// Additional derived types
-export type CreatePostTargetResult = z.infer<typeof CreatePostTargetResultSchema>;
-export type CreatePostTargetError = z.infer<typeof CreatePostTargetErrorSchema>;

package/src/rate-limit.ts

@@ -1,25 +1,12 @@
-/**
- * Rate Limit Schemas and Types
- * Defines Zod schemas for rate limit-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';
 
-/**
- * Rate limit endpoint parameter schema
- */
 export const RateLimitEndpointParamSchema = z.object({
   endpoint: z.string().optional().describe(
     'Specific endpoint to get rate limit information for (optional)',
   ),
 }).describe('Rate limit endpoint parameter');
 
-/**
- * Rate limit endpoint schema
- */
 export const RateLimitEndpointSchema = z.object({
   endpoint: z.string().describe('API endpoint'),
   method: z.enum(['GET', 'POST', 'PUT', 'DELETE']).describe('HTTP method'),
@@ -29,9 +16,6 @@ export const RateLimitEndpointSchema = z.object({
   resetDate: z.string().describe('Reset date (ISO string)'),
 }).describe('Rate limit endpoint');
 
-/**
- * Rate limit status schema
- */
 export const RateLimitStatusSchema = z.object({
   endpoint: z.string().describe('API endpoint or action'),
   limit: z.number().describe('Maximum number of requests allowed in the time window'),
@@ -40,9 +24,6 @@ export const RateLimitStatusSchema = z.object({
   resetSeconds: z.number().describe('Seconds until the rate limit will reset'),
 }).describe('Rate limit status');
 
-/**
- * Platform-specific rate limit schema
- */
 export const PlatformRateLimitSchema = z.object({
   platform: PlatformSchema,
   endpoints: z.record(z.string(), RateLimitStatusSchema).describe(
@@ -50,9 +31,6 @@ export const PlatformRateLimitSchema = z.object({
   ),
 }).describe('Platform-specific rate limit');
 
-/**
- * Usage rate limit schema
- */
 export const UsageRateLimitSchema = z.object({
   endpoint: z.string().describe('API endpoint or action'),
   limit: z.number().describe('Maximum number of requests allowed in the time window'),
@@ -62,54 +40,41 @@ export const UsageRateLimitSchema = z.object({
   timeWindow: z.string().describe('Time window for the rate limit'),
 }).describe('Usage rate limit');
 
-/**
- * Rate limit status response schema
- */
-export const RateLimitStatusResponseSchema = EnhancedResponseSchema(
-  z.object({
-    platform: PlatformSchema,
-    userId: z.string().optional().describe('User ID'),
-    endpoints: z.array(RateLimitEndpointSchema).describe('Rate limits for specific endpoints'),
-    app: z.object({
-      limit: z.number().describe('App-wide rate limit'),
-      remaining: z.number().describe('Remaining requests'),
-      reset: z.number().describe('Reset timestamp (Unix timestamp in seconds)'),
-      resetDate: z.string().describe('Reset date (ISO string)'),
-    }).optional().describe('App-wide rate limits'),
-  }),
-).describe('Rate limit status response');
+export const RateLimitStatusResponseSchema = z.object({
+  platform: PlatformSchema,
+  userId: z.string().optional().describe('User ID'),
+  endpoints: z.array(RateLimitEndpointSchema).describe('Rate limits for specific endpoints'),
+  app: z.object({
+    limit: z.number().describe('App-wide rate limit'),
+    remaining: z.number().describe('Remaining requests'),
+    reset: z.number().describe('Reset timestamp (Unix timestamp in seconds)'),
+    resetDate: z.string().describe('Reset date (ISO string)'),
+  }).optional().describe('App-wide rate limits'),
+}).describe('Rate limit status response');
 
-/**
- * All rate limits response schema
- */
-export const AllRateLimitsResponseSchema = EnhancedResponseSchema(
-  z.object({
-    platforms: z.record(
-      PlatformSchema,
-      z.object({
-        users: z.record(
-          z.string(),
-          z.object({
-            endpoints: z.array(RateLimitEndpointSchema).describe(
-              'Rate limits for specific endpoints',
-            ),
-            lastUpdated: z.string().describe('Last updated date (ISO string)'),
-          }),
-        ).describe('User-specific rate limits'),
-        app: z.object({
-          limit: z.number().describe('App-wide rate limit'),
-          remaining: z.number().describe('Remaining requests'),
-          reset: z.number().describe('Reset timestamp (Unix timestamp in seconds)'),
-          resetDate: z.string().describe('Reset date (ISO string)'),
-        }).optional().describe('App-wide rate limits'),
-      }),
-    ).describe('Rate limits by platform'),
-  }),
-).describe('All rate limits response');
+export const AllRateLimitsResponseSchema = z.object({
+  platforms: z.record(
+    PlatformSchema,
+    z.object({
+      users: z.record(
+        z.string(),
+        z.object({
+          endpoints: z.array(RateLimitEndpointSchema).describe(
+            'Rate limits for specific endpoints',
+          ),
+          lastUpdated: z.string().describe('Last updated date (ISO string)'),
+        }),
+      ).describe('User-specific rate limits'),
+      app: z.object({
+        limit: z.number().describe('App-wide rate limit'),
+        remaining: z.number().describe('Remaining requests'),
+        reset: z.number().describe('Reset timestamp (Unix timestamp in seconds)'),
+        resetDate: z.string().describe('Reset date (ISO string)'),
+      }).optional().describe('App-wide rate limits'),
+    }),
+  ).describe('Rate limits by platform'),
+}).describe('All rate limits response');
 
-/**
- * Rate limit response schema
- */
 export const RateLimitResponseSchema = z.object({
   platformLimits: z.array(PlatformRateLimitSchema).describe('Platform-specific rate limits'),
   usageLimits: z.record(z.string(), UsageRateLimitSchema).describe(
@@ -118,9 +83,6 @@ export const RateLimitResponseSchema = z.object({
   signerId: z.string().describe('NEAR account ID'),
 }).describe('Rate limit response');
 
-/**
- * Single endpoint rate limit response schema
- */
 export const EndpointRateLimitResponseSchema = z.object({
   platformLimits: z.array(
     z.object({
@@ -133,7 +95,6 @@ export const EndpointRateLimitResponseSchema = z.object({
   signerId: z.string().describe('NEAR account ID'),
 }).describe('Endpoint rate limit response');
 
-// Derive TypeScript types from Zod schemas
 export type RateLimitEndpointParam = z.infer<typeof RateLimitEndpointParamSchema>;
 export type RateLimitEndpoint = z.infer<typeof RateLimitEndpointSchema>;
 export type RateLimitStatus = z.infer<typeof RateLimitStatusSchema>;