@crosspost/sdk 0.1.6 → 0.1.8

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { NearAuthData } from 'near-sign-verify';
-import { ActivityLeaderboardQuery, ActivityLeaderboardResponse, AccountActivityQuery, AccountActivityResponse, AccountPostsQuery, AccountPostsResponse, NearAuthorizationResponse, Platform, EnhancedApiResponse, AuthStatusResponse, AuthRevokeResponse, ConnectedAccountsResponse, CreatePostRequest, CreatePostResponse, RepostRequest, RepostResponse, QuotePostRequest, QuotePostResponse, ReplyToPostRequest, ReplyToPostResponse, LikePostRequest, LikePostResponse, UnlikePostRequest, UnlikePostResponse, DeletePostRequest, DeletePostResponse, RateLimitResponse, EndpointRateLimitResponse, ApiError, ApiErrorCode, PlatformError, CompositeApiError } from '@crosspost/types';
+import { ActivityLeaderboardQuery, ActivityLeaderboardResponse, AccountActivityQuery, AccountActivityResponse, AccountPostsQuery, AccountPostsResponse, NearAuthorizationResponse, Platform, AuthInitRequest, AuthUrlResponse, AuthCallbackResponse, ConnectedAccount, AuthStatusResponse, NearUnauthorizationResponse, AuthRevokeResponse, ConnectedAccountsResponse, CreatePostRequest, CreatePostResponse, RepostRequest, RepostResponse, QuotePostRequest, QuotePostResponse, ReplyToPostRequest, ReplyToPostResponse, LikePostRequest, LikePostResponse, UnlikePostRequest, UnlikePostResponse, DeletePostRequest, DeletePostResponse, RateLimitResponse, EndpointRateLimitResponse, HealthStatus, ApiErrorCode, StatusCode, ErrorDetails } from '@crosspost/types';
 export * from '@crosspost/types';
 
 /**
@@ -12,9 +12,14 @@ interface RequestOptions {
     baseUrl: string;
     /**
      * NEAR authentication data for generating auth tokens
-     * Can be undefined if not authorize yet
+     * Required for non-GET requests, optional for GET requests
      */
     nearAuthData?: NearAuthData;
+    /**
+     * NEAR account ID for simplified GET request authentication
+     * If not provided, will use account_id from nearAuthData
+     */
+    nearAccount?: string;
     /**
      * Request timeout in milliseconds
      */
@@ -84,34 +89,37 @@ declare class AuthApi {
      * @param options Optional success and error redirect URLs.
      * @returns A promise resolving with the response from the service (might indicate success/failure or redirect info).
      */
-    loginToPlatform(platform: Platform, options?: {
-        successUrl?: string;
-        errorUrl?: string;
-    }): Promise<EnhancedApiResponse<any>>;
+    loginToPlatform(platform: Platform, options?: AuthInitRequest): Promise<AuthUrlResponse>;
     /**
      * Refreshes the authentication token for the specified platform.
      * @param platform The target platform.
-     * @returns A promise resolving with the refresh response.
+     * @returns A promise resolving with the refresh response containing updated auth details.
      */
-    refreshToken(platform: Platform): Promise<EnhancedApiResponse<any>>;
+    refreshToken(platform: Platform, userId: string): Promise<AuthCallbackResponse>;
     /**
      * Refreshes the user's profile information from the specified platform.
      * @param platform The target platform.
-     * @returns A promise resolving with the profile refresh response.
+     * @param userId The user ID on the platform
+     * @returns A promise resolving with the updated account profile information.
      */
-    refreshProfile(platform: Platform): Promise<EnhancedApiResponse<any>>;
+    refreshProfile(platform: Platform, userId: string): Promise<ConnectedAccount>;
     /**
      * Gets the authentication status for the specified platform.
      * @param platform The target platform.
      * @returns A promise resolving with the authentication status response.
      */
-    getAuthStatus(platform: Platform): Promise<AuthStatusResponse>;
+    getAuthStatus(platform: Platform, userId: string): Promise<AuthStatusResponse>;
+    /**
+     * Unauthorizes a NEAR account from using the service
+     * @returns A promise resolving with the unauthorized response
+     */
+    unauthorizeNear(): Promise<NearUnauthorizationResponse>;
     /**
      * Revokes the authentication token for the specified platform.
      * @param platform The target platform.
      * @returns A promise resolving with the revocation response.
      */
-    revokeAuth(platform: Platform): Promise<AuthRevokeResponse>;
+    revokeAuth(platform: Platform, userId: string): Promise<AuthRevokeResponse>;
     /**
      * Lists all accounts connected to the NEAR account.
      * @returns A promise resolving with the list of connected accounts.
@@ -199,9 +207,7 @@ declare class SystemApi {
      * Gets the health status of the API
      * @returns A promise resolving with the health status
      */
-    getHealthStatus(): Promise<{
-        status: string;
-    }>;
+    getHealthStatus(): Promise<HealthStatus>;
 }
 
 /**
@@ -245,140 +251,115 @@ declare class CrosspostClient {
     constructor(config?: CrosspostClientConfig);
     /**
      * Sets the authentication data (signature) for the client
+     * Required for non-GET requests
      * @param nearAuthData The NEAR authentication data
      */
     setAuthentication(nearAuthData: NearAuthData): void;
+    /**
+     * Sets the NEAR account ID for simplified GET request authentication
+     * If not set, will use account_id from nearAuthData
+     * @param nearAccount The NEAR account ID
+     */
+    setNearAccount(nearAccount: string): void;
+    /**
+     * Gets the current NEAR account ID being used for authentication
+     * @returns The NEAR account ID from nearAccount or nearAuthData
+     */
+    getNearAccount(): string | undefined;
     /**
      * Checks if authentication data (signature) exists on client
-     * @param signature The NEAR authentication data
+     * @returns true if nearAuthData is set (required for non-GET requests)
      */
     isAuthenticated(): boolean;
+    /**
+     * Checks if a NEAR account is set for GET request authentication
+     * @returns true if either nearAccount or nearAuthData.account_id is set
+     */
+    hasNearAccount(): boolean;
+    /**
+     * Clears all authentication data from the client
+     * This will prevent all requests from working until new authentication is set
+     */
+    clear(): void;
 }
 
 /**
- * Error categories grouped by type
- */
-declare const ERROR_CATEGORIES: {
-    AUTH: ApiErrorCode[];
-    VALIDATION: ApiErrorCode[];
-    NETWORK: ApiErrorCode[];
-    PLATFORM: ApiErrorCode[];
-    CONTENT: ApiErrorCode[];
-    RATE_LIMIT: ApiErrorCode[];
-    POST: ApiErrorCode[];
-    MEDIA: ApiErrorCode[];
-};
-/**
- * Check if an error belongs to a specific category
- *
- * @param error The error to check
- * @param category The category to check against
- * @returns True if the error belongs to the category, false otherwise
+ * CrosspostError class for SDK error handling
  */
-declare function isErrorOfCategory(error: unknown, category: ApiErrorCode[]): boolean;
+declare class CrosspostError extends Error {
+    readonly code: ApiErrorCode;
+    readonly status: StatusCode;
+    readonly details?: ErrorDetails;
+    readonly recoverable: boolean;
+    constructor(message: string, code: ApiErrorCode, status: StatusCode, details?: ErrorDetails, recoverable?: boolean);
+    /**
+     * Get platform from details if available
+     */
+    get platform(): string | undefined;
+    /**
+     * Get userId from details if available
+     */
+    get userId(): string | undefined;
+}
 /**
  * Check if an error is an authentication error
- *
- * @param error The error to check
- * @returns True if the error is an authentication error, false otherwise
  */
 declare function isAuthError(error: unknown): boolean;
 /**
  * Check if an error is a validation error
- *
- * @param error The error to check
- * @returns True if the error is a validation error, false otherwise
  */
 declare function isValidationError(error: unknown): boolean;
 /**
  * Check if an error is a network error
- *
- * @param error The error to check
- * @returns True if the error is a network error, false otherwise
  */
 declare function isNetworkError(error: unknown): boolean;
 /**
  * Check if an error is a platform error
- *
- * @param error The error to check
- * @returns True if the error is a platform error, false otherwise
  */
 declare function isPlatformError(error: unknown): boolean;
 /**
  * Check if an error is a content policy error
- *
- * @param error The error to check
- * @returns True if the error is a content policy error, false otherwise
  */
 declare function isContentError(error: unknown): boolean;
 /**
  * Check if an error is a rate limit error
- *
- * @param error The error to check
- * @returns True if the error is a rate limit error, false otherwise
  */
 declare function isRateLimitError(error: unknown): boolean;
 /**
  * Check if an error is a post-related error
- *
- * @param error The error to check
- * @returns True if the error is a post-related error, false otherwise
  */
 declare function isPostError(error: unknown): boolean;
 /**
  * Check if an error is a media-related error
- *
- * @param error The error to check
- * @returns True if the error is a media-related error, false otherwise
  */
 declare function isMediaError(error: unknown): boolean;
 /**
  * Check if an error is recoverable
- *
- * @param error The error to check
- * @returns True if the error is recoverable, false otherwise
  */
 declare function isRecoverableError(error: unknown): boolean;
 /**
  * Get a user-friendly error message
- *
- * @param error The error to get the message from
- * @param defaultMessage The default message to return if no message is found
- * @returns The error message
  */
 declare function getErrorMessage(error: unknown, defaultMessage?: string): string;
 /**
- * Extract error details if available
- *
- * @param error The error to extract details from
- * @returns The error details or undefined if none are found
+ * Get error details if available
  */
-declare function getErrorDetails(error: unknown): Record<string, any> | undefined;
+declare function getErrorDetails(error: unknown): ErrorDetails | undefined;
 /**
  * Enrich an error with additional context
- *
- * @param error The error to enrich
- * @param context The context to add to the error
- * @returns The enriched error
  */
-declare function enrichErrorWithContext(error: unknown, context: Record<string, any>): Error;
+declare function enrichErrorWithContext(error: unknown, context: Record<string, unknown>): Error;
 /**
  * Wrapper for API calls with consistent error handling
- *
- * @param apiCall The API call to wrap
- * @param context Optional context to add to any errors
- * @returns The result of the API call
- * @throws An enriched error if the API call fails
  */
-declare function apiWrapper<T>(apiCall: () => Promise<T>, context?: Record<string, any>): Promise<T>;
+declare function apiWrapper<T>(apiCall: () => Promise<T>, context?: Record<string, unknown>): Promise<T>;
 /**
  * Handles error responses from the API and converts them to appropriate error objects.
- *
- * @param data The error response data
- * @param status The HTTP status code
- * @returns An ApiError or PlatformError instance
  */
-declare function handleErrorResponse(data: any, status: number): ApiError | PlatformError | CompositeApiError;
-declare function createNetworkError(error: unknown, url: string, timeout: number): ApiError;
+declare function handleErrorResponse(data: any, status: number): CrosspostError;
+/**
+ * Creates a network error with appropriate details
+ */
+declare function createNetworkError(error: unknown, url: string, timeout: number): CrosspostError;
 
-export { ActivityApi, AuthApi, CrosspostClient, type CrosspostClientConfig, ERROR_CATEGORIES, PostApi, SystemApi, apiWrapper, createNetworkError, enrichErrorWithContext, getErrorDetails, getErrorMessage, handleErrorResponse, isAuthError, isContentError, isErrorOfCategory, isMediaError, isNetworkError, isPlatformError, isPostError, isRateLimitError, isRecoverableError, isValidationError };
+export { ActivityApi, AuthApi, CrosspostClient, type CrosspostClientConfig, PostApi, SystemApi, apiWrapper, createNetworkError, enrichErrorWithContext, getErrorDetails, getErrorMessage, handleErrorResponse, isAuthError, isContentError, isMediaError, isNetworkError, isPlatformError, isPostError, isRateLimitError, isRecoverableError, isValidationError };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { NearAuthData } from 'near-sign-verify';
-import { ActivityLeaderboardQuery, ActivityLeaderboardResponse, AccountActivityQuery, AccountActivityResponse, AccountPostsQuery, AccountPostsResponse, NearAuthorizationResponse, Platform, EnhancedApiResponse, AuthStatusResponse, AuthRevokeResponse, ConnectedAccountsResponse, CreatePostRequest, CreatePostResponse, RepostRequest, RepostResponse, QuotePostRequest, QuotePostResponse, ReplyToPostRequest, ReplyToPostResponse, LikePostRequest, LikePostResponse, UnlikePostRequest, UnlikePostResponse, DeletePostRequest, DeletePostResponse, RateLimitResponse, EndpointRateLimitResponse, ApiError, ApiErrorCode, PlatformError, CompositeApiError } from '@crosspost/types';
+import { ActivityLeaderboardQuery, ActivityLeaderboardResponse, AccountActivityQuery, AccountActivityResponse, AccountPostsQuery, AccountPostsResponse, NearAuthorizationResponse, Platform, AuthInitRequest, AuthUrlResponse, AuthCallbackResponse, ConnectedAccount, AuthStatusResponse, NearUnauthorizationResponse, AuthRevokeResponse, ConnectedAccountsResponse, CreatePostRequest, CreatePostResponse, RepostRequest, RepostResponse, QuotePostRequest, QuotePostResponse, ReplyToPostRequest, ReplyToPostResponse, LikePostRequest, LikePostResponse, UnlikePostRequest, UnlikePostResponse, DeletePostRequest, DeletePostResponse, RateLimitResponse, EndpointRateLimitResponse, HealthStatus, ApiErrorCode, StatusCode, ErrorDetails } from '@crosspost/types';
 export * from '@crosspost/types';
 
 /**
@@ -12,9 +12,14 @@ interface RequestOptions {
     baseUrl: string;
     /**
      * NEAR authentication data for generating auth tokens
-     * Can be undefined if not authorize yet
+     * Required for non-GET requests, optional for GET requests
      */
     nearAuthData?: NearAuthData;
+    /**
+     * NEAR account ID for simplified GET request authentication
+     * If not provided, will use account_id from nearAuthData
+     */
+    nearAccount?: string;
     /**
      * Request timeout in milliseconds
      */
@@ -84,34 +89,37 @@ declare class AuthApi {
      * @param options Optional success and error redirect URLs.
      * @returns A promise resolving with the response from the service (might indicate success/failure or redirect info).
      */
-    loginToPlatform(platform: Platform, options?: {
-        successUrl?: string;
-        errorUrl?: string;
-    }): Promise<EnhancedApiResponse<any>>;
+    loginToPlatform(platform: Platform, options?: AuthInitRequest): Promise<AuthUrlResponse>;
     /**
      * Refreshes the authentication token for the specified platform.
      * @param platform The target platform.
-     * @returns A promise resolving with the refresh response.
+     * @returns A promise resolving with the refresh response containing updated auth details.
      */
-    refreshToken(platform: Platform): Promise<EnhancedApiResponse<any>>;
+    refreshToken(platform: Platform, userId: string): Promise<AuthCallbackResponse>;
     /**
      * Refreshes the user's profile information from the specified platform.
      * @param platform The target platform.
-     * @returns A promise resolving with the profile refresh response.
+     * @param userId The user ID on the platform
+     * @returns A promise resolving with the updated account profile information.
      */
-    refreshProfile(platform: Platform): Promise<EnhancedApiResponse<any>>;
+    refreshProfile(platform: Platform, userId: string): Promise<ConnectedAccount>;
     /**
      * Gets the authentication status for the specified platform.
      * @param platform The target platform.
      * @returns A promise resolving with the authentication status response.
      */
-    getAuthStatus(platform: Platform): Promise<AuthStatusResponse>;
+    getAuthStatus(platform: Platform, userId: string): Promise<AuthStatusResponse>;
+    /**
+     * Unauthorizes a NEAR account from using the service
+     * @returns A promise resolving with the unauthorized response
+     */
+    unauthorizeNear(): Promise<NearUnauthorizationResponse>;
     /**
      * Revokes the authentication token for the specified platform.
      * @param platform The target platform.
      * @returns A promise resolving with the revocation response.
      */
-    revokeAuth(platform: Platform): Promise<AuthRevokeResponse>;
+    revokeAuth(platform: Platform, userId: string): Promise<AuthRevokeResponse>;
     /**
      * Lists all accounts connected to the NEAR account.
      * @returns A promise resolving with the list of connected accounts.
@@ -199,9 +207,7 @@ declare class SystemApi {
      * Gets the health status of the API
      * @returns A promise resolving with the health status
      */
-    getHealthStatus(): Promise<{
-        status: string;
-    }>;
+    getHealthStatus(): Promise<HealthStatus>;
 }
 
 /**
@@ -245,140 +251,115 @@ declare class CrosspostClient {
     constructor(config?: CrosspostClientConfig);
     /**
      * Sets the authentication data (signature) for the client
+     * Required for non-GET requests
      * @param nearAuthData The NEAR authentication data
      */
     setAuthentication(nearAuthData: NearAuthData): void;
+    /**
+     * Sets the NEAR account ID for simplified GET request authentication
+     * If not set, will use account_id from nearAuthData
+     * @param nearAccount The NEAR account ID
+     */
+    setNearAccount(nearAccount: string): void;
+    /**
+     * Gets the current NEAR account ID being used for authentication
+     * @returns The NEAR account ID from nearAccount or nearAuthData
+     */
+    getNearAccount(): string | undefined;
     /**
      * Checks if authentication data (signature) exists on client
-     * @param signature The NEAR authentication data
+     * @returns true if nearAuthData is set (required for non-GET requests)
      */
     isAuthenticated(): boolean;
+    /**
+     * Checks if a NEAR account is set for GET request authentication
+     * @returns true if either nearAccount or nearAuthData.account_id is set
+     */
+    hasNearAccount(): boolean;
+    /**
+     * Clears all authentication data from the client
+     * This will prevent all requests from working until new authentication is set
+     */
+    clear(): void;
 }
 
 /**
- * Error categories grouped by type
- */
-declare const ERROR_CATEGORIES: {
-    AUTH: ApiErrorCode[];
-    VALIDATION: ApiErrorCode[];
-    NETWORK: ApiErrorCode[];
-    PLATFORM: ApiErrorCode[];
-    CONTENT: ApiErrorCode[];
-    RATE_LIMIT: ApiErrorCode[];
-    POST: ApiErrorCode[];
-    MEDIA: ApiErrorCode[];
-};
-/**
- * Check if an error belongs to a specific category
- *
- * @param error The error to check
- * @param category The category to check against
- * @returns True if the error belongs to the category, false otherwise
+ * CrosspostError class for SDK error handling
  */
-declare function isErrorOfCategory(error: unknown, category: ApiErrorCode[]): boolean;
+declare class CrosspostError extends Error {
+    readonly code: ApiErrorCode;
+    readonly status: StatusCode;
+    readonly details?: ErrorDetails;
+    readonly recoverable: boolean;
+    constructor(message: string, code: ApiErrorCode, status: StatusCode, details?: ErrorDetails, recoverable?: boolean);
+    /**
+     * Get platform from details if available
+     */
+    get platform(): string | undefined;
+    /**
+     * Get userId from details if available
+     */
+    get userId(): string | undefined;
+}
 /**
  * Check if an error is an authentication error
- *
- * @param error The error to check
- * @returns True if the error is an authentication error, false otherwise
  */
 declare function isAuthError(error: unknown): boolean;
 /**
  * Check if an error is a validation error
- *
- * @param error The error to check
- * @returns True if the error is a validation error, false otherwise
  */
 declare function isValidationError(error: unknown): boolean;
 /**
  * Check if an error is a network error
- *
- * @param error The error to check
- * @returns True if the error is a network error, false otherwise
  */
 declare function isNetworkError(error: unknown): boolean;
 /**
  * Check if an error is a platform error
- *
- * @param error The error to check
- * @returns True if the error is a platform error, false otherwise
  */
 declare function isPlatformError(error: unknown): boolean;
 /**
  * Check if an error is a content policy error
- *
- * @param error The error to check
- * @returns True if the error is a content policy error, false otherwise
  */
 declare function isContentError(error: unknown): boolean;
 /**
  * Check if an error is a rate limit error
- *
- * @param error The error to check
- * @returns True if the error is a rate limit error, false otherwise
  */
 declare function isRateLimitError(error: unknown): boolean;
 /**
  * Check if an error is a post-related error
- *
- * @param error The error to check
- * @returns True if the error is a post-related error, false otherwise
  */
 declare function isPostError(error: unknown): boolean;
 /**
  * Check if an error is a media-related error
- *
- * @param error The error to check
- * @returns True if the error is a media-related error, false otherwise
  */
 declare function isMediaError(error: unknown): boolean;
 /**
  * Check if an error is recoverable
- *
- * @param error The error to check
- * @returns True if the error is recoverable, false otherwise
  */
 declare function isRecoverableError(error: unknown): boolean;
 /**
  * Get a user-friendly error message
- *
- * @param error The error to get the message from
- * @param defaultMessage The default message to return if no message is found
- * @returns The error message
  */
 declare function getErrorMessage(error: unknown, defaultMessage?: string): string;
 /**
- * Extract error details if available
- *
- * @param error The error to extract details from
- * @returns The error details or undefined if none are found
+ * Get error details if available
  */
-declare function getErrorDetails(error: unknown): Record<string, any> | undefined;
+declare function getErrorDetails(error: unknown): ErrorDetails | undefined;
 /**
  * Enrich an error with additional context
- *
- * @param error The error to enrich
- * @param context The context to add to the error
- * @returns The enriched error
  */
-declare function enrichErrorWithContext(error: unknown, context: Record<string, any>): Error;
+declare function enrichErrorWithContext(error: unknown, context: Record<string, unknown>): Error;
 /**
  * Wrapper for API calls with consistent error handling
- *
- * @param apiCall The API call to wrap
- * @param context Optional context to add to any errors
- * @returns The result of the API call
- * @throws An enriched error if the API call fails
  */
-declare function apiWrapper<T>(apiCall: () => Promise<T>, context?: Record<string, any>): Promise<T>;
+declare function apiWrapper<T>(apiCall: () => Promise<T>, context?: Record<string, unknown>): Promise<T>;
 /**
  * Handles error responses from the API and converts them to appropriate error objects.
- *
- * @param data The error response data
- * @param status The HTTP status code
- * @returns An ApiError or PlatformError instance
  */
-declare function handleErrorResponse(data: any, status: number): ApiError | PlatformError | CompositeApiError;
-declare function createNetworkError(error: unknown, url: string, timeout: number): ApiError;
+declare function handleErrorResponse(data: any, status: number): CrosspostError;
+/**
+ * Creates a network error with appropriate details
+ */
+declare function createNetworkError(error: unknown, url: string, timeout: number): CrosspostError;
 
-export { ActivityApi, AuthApi, CrosspostClient, type CrosspostClientConfig, ERROR_CATEGORIES, PostApi, SystemApi, apiWrapper, createNetworkError, enrichErrorWithContext, getErrorDetails, getErrorMessage, handleErrorResponse, isAuthError, isContentError, isErrorOfCategory, isMediaError, isNetworkError, isPlatformError, isPostError, isRateLimitError, isRecoverableError, isValidationError };
+export { ActivityApi, AuthApi, CrosspostClient, type CrosspostClientConfig, PostApi, SystemApi, apiWrapper, createNetworkError, enrichErrorWithContext, getErrorDetails, getErrorMessage, handleErrorResponse, isAuthError, isContentError, isMediaError, isNetworkError, isPlatformError, isPostError, isRateLimitError, isRecoverableError, isValidationError };