@crosspost/types 0.1.3 → 0.1.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Open Crosspost
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,11 +1,10 @@
 # @crosspost/types
 
-Shared type definitions for the Crosspost API ecosystem.
+Shared type definitions for the Crosspost API and SDK.
 
 ## Overview
 
-This package contains TypeScript type definitions used across the Crosspost API ecosystem,
-including:
+This package contains TypeScript type definitions, including:
 
 - Common types (PlatformName, ApiErrorCode, etc.)
 - Request types for all API endpoints
@@ -13,20 +12,10 @@ including:
 
 ## Installation
 
-### Node.js / npm
+### Node.js
 
 ```bash
-# Using npm
 npm install @crosspost/types
-
-# Using yarn
-yarn add @crosspost/types
-
-# Using pnpm
-pnpm add @crosspost/types
-
-# Using bun
-bun add @crosspost/types
 ```
 
 ### Deno
@@ -48,6 +37,7 @@ import { CreatePostRequest, CreatePostResponse, PlatformName } from '@crosspost/
 const platform: PlatformName = 'twitter';
 
 const request: CreatePostRequest = {
+  targets: [{ platform: 'twitter', userId: 'your-twitter-id' }],
   content: {
     text: 'Hello, world!',
   },
@@ -105,21 +95,3 @@ const errorResponse = createEnhancedErrorResponse([
   ),
 ]);
 ```
-
-### Request Types
-
-- Authentication requests
-- Post creation and management requests
-- Media upload requests
-- Rate limit requests
-
-### Response Types
-
-- Authentication responses
-- Post creation and management responses
-- Media upload responses
-- Rate limit responses
-
-## License
-
-MIT

package/dist/index.cjs

@@ -93,7 +93,9 @@ __export(index_exports, {
   ReplyToPostResponseSchema: () => ReplyToPostResponseSchema,
   RepostRequestSchema: () => RepostRequestSchema,
   RepostResponseSchema: () => RepostResponseSchema,
+  SUPPORTED_PLATFORMS: () => SUPPORTED_PLATFORMS,
   SuccessDetailSchema: () => SuccessDetailSchema,
+  SupportedPlatformSchema: () => SupportedPlatformSchema,
   TargetSchema: () => TargetSchema,
   TimePeriod: () => TimePeriod,
   UnlikePostRequestSchema: () => UnlikePostRequestSchema,
@@ -106,25 +108,28 @@ __export(index_exports, {
   createErrorDetail: () => createErrorDetail,
   createErrorResponse: () => createErrorResponse,
   createMultiStatusResponse: () => createMultiStatusResponse,
-  createSuccessDetail: () => createSuccessDetail
+  createSuccessDetail: () => createSuccessDetail,
+  isPlatformSupported: () => isPlatformSupported
 });
 module.exports = __toCommonJS(index_exports);
 
 // src/common.ts
 var import_zod = require("zod");
-var PlatformSchema = import_zod.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 = import_zod.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 ? import_zod.z.enum(SUPPORTED_PLATFORMS) : import_zod.z.never();
+SupportedPlatformSchema.describe("Currently supported social media platforms");
+function isPlatformSupported(platform) {
+  return SUPPORTED_PLATFORMS.includes(platform);
+}
 
 // src/response.ts
 var import_zod2 = require("zod");
@@ -754,15 +759,15 @@ var EndpointRateLimitResponseSchema = import_zod5.z.object({
 // src/activity.ts
 var import_zod6 = require("zod");
 var TimePeriod = /* @__PURE__ */ ((TimePeriod2) => {
-  TimePeriod2["ALL_TIME"] = "all";
-  TimePeriod2["YEARLY"] = "yearly";
-  TimePeriod2["MONTHLY"] = "monthly";
-  TimePeriod2["WEEKLY"] = "weekly";
-  TimePeriod2["DAILY"] = "daily";
+  TimePeriod2["ALL"] = "all";
+  TimePeriod2["YEARLY"] = "year";
+  TimePeriod2["MONTHLY"] = "month";
+  TimePeriod2["WEEKLY"] = "week";
+  TimePeriod2["DAILY"] = "day";
   return TimePeriod2;
 })(TimePeriod || {});
 var ActivityLeaderboardQuerySchema = import_zod6.z.object({
-  timeframe: import_zod6.z.enum(["day", "week", "month", "all"]).optional().describe(
+  timeframe: import_zod6.z.nativeEnum(TimePeriod).optional().describe(
     "Timeframe for the leaderboard"
   ),
   limit: import_zod6.z.string().optional().transform((val) => val ? parseInt(val, 10) : void 0).pipe(import_zod6.z.number().min(1).max(100).optional()).describe("Maximum number of results to return (1-100)"),
@@ -781,7 +786,7 @@ var AccountActivityEntrySchema = import_zod6.z.object({
 }).describe("Account activity entry");
 var ActivityLeaderboardResponseSchema = EnhancedResponseSchema(
   import_zod6.z.object({
-    timeframe: import_zod6.z.enum(["day", "week", "month", "all"]).describe("Timeframe for the leaderboard"),
+    timeframe: import_zod6.z.nativeEnum(TimePeriod).describe("Timeframe for the leaderboard"),
     entries: import_zod6.z.array(AccountActivityEntrySchema).describe("Leaderboard entries"),
     total: import_zod6.z.number().describe("Total number of entries in the leaderboard"),
     limit: import_zod6.z.number().describe("Maximum number of results returned"),
@@ -793,7 +798,7 @@ var AccountActivityParamsSchema = import_zod6.z.object({
   signerId: import_zod6.z.string().describe("NEAR account ID")
 }).describe("Account activity params");
 var AccountActivityQuerySchema = import_zod6.z.object({
-  timeframe: import_zod6.z.enum(["day", "week", "month", "all"]).optional().describe(
+  timeframe: import_zod6.z.nativeEnum(TimePeriod).optional().describe(
     "Timeframe for the activity"
   )
 }).describe("Account activity query");
@@ -810,7 +815,7 @@ var PlatformActivitySchema = import_zod6.z.object({
 var AccountActivityResponseSchema = EnhancedResponseSchema(
   import_zod6.z.object({
     signerId: import_zod6.z.string().describe("NEAR account ID"),
-    timeframe: import_zod6.z.enum(["day", "week", "month", "all"]).describe("Timeframe for the activity"),
+    timeframe: import_zod6.z.nativeEnum(TimePeriod).describe("Timeframe for the activity"),
     totalPosts: import_zod6.z.number().describe("Total number of posts across all platforms"),
     totalLikes: import_zod6.z.number().describe("Total number of likes across all platforms"),
     totalReposts: import_zod6.z.number().describe("Total number of reposts across all platforms"),
@@ -957,7 +962,9 @@ var ProfileRefreshResponseSchema = EnhancedResponseSchema(
   ReplyToPostResponseSchema,
   RepostRequestSchema,
   RepostResponseSchema,
+  SUPPORTED_PLATFORMS,
   SuccessDetailSchema,
+  SupportedPlatformSchema,
   TargetSchema,
   TimePeriod,
   UnlikePostRequestSchema,
@@ -970,5 +977,6 @@ var ProfileRefreshResponseSchema = EnhancedResponseSchema(
   createErrorDetail,
   createErrorResponse,
   createMultiStatusResponse,
-  createSuccessDetail
+  createSuccessDetail,
+  isPlatformSupported
 });