@crosspost/sdk 0.1.2 → 0.1.3

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { NearAuthData } from 'near-sign-verify';
-import { NearAuthorizationResponse, Platform, EnhancedApiResponse, AuthStatusResponse, AuthRevokeResponse, ConnectedAccountsResponse, CreatePostRequest, CreatePostResponse, RepostRequest, RepostResponse, QuotePostRequest, QuotePostResponse, ReplyToPostRequest, ReplyToPostResponse, LikePostRequest, LikePostResponse, UnlikePostRequest, UnlikePostResponse, DeletePostRequest, DeletePostResponse, ApiError, PlatformError } from '@crosspost/types';
+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, PlatformError, ApiErrorCode } from '@crosspost/types';
 export * from '@crosspost/types';
 
 /**
@@ -14,7 +14,7 @@ interface RequestOptions {
      * NEAR authentication data for generating auth tokens
      * Can be undefined if not authorize yet
      */
-    signature?: NearAuthData;
+    nearAuthData?: NearAuthData;
     /**
      * Request timeout in milliseconds
      */
@@ -25,6 +25,38 @@ interface RequestOptions {
     retries: number;
 }
 
+/**
+ * Activity-related API operations
+ */
+declare class ActivityApi {
+    private options;
+    /**
+     * Creates an instance of ActivityApi
+     * @param options Request options
+     */
+    constructor(options: RequestOptions);
+    /**
+     * Gets the global activity leaderboard
+     * @param query Optional query parameters
+     * @returns A promise resolving with the leaderboard response
+     */
+    getLeaderboard(query?: ActivityLeaderboardQuery): Promise<ActivityLeaderboardResponse>;
+    /**
+     * Gets activity for a specific account
+     * @param signerId The NEAR account ID
+     * @param query Optional query parameters
+     * @returns A promise resolving with the account activity response
+     */
+    getAccountActivity(signerId: string, query?: AccountActivityQuery): Promise<AccountActivityResponse>;
+    /**
+     * Gets posts for a specific account
+     * @param signerId The NEAR account ID
+     * @param query Optional query parameters
+     * @returns A promise resolving with the account posts response
+     */
+    getAccountPosts(signerId: string, query?: AccountPostsQuery): Promise<AccountPostsResponse>;
+}
+
 /**
  * Authentication-related API operations
  */
@@ -141,19 +173,50 @@ declare class PostApi {
     deletePost(request: DeletePostRequest): Promise<DeletePostResponse>;
 }
 
+/**
+ * System-related API operations
+ * Includes rate limits, health checks, and other system-related functionality
+ */
+declare class SystemApi {
+    private options;
+    /**
+     * Creates an instance of SystemApi
+     * @param options Request options
+     */
+    constructor(options: RequestOptions);
+    /**
+     * Gets the current rate limit status
+     * @returns A promise resolving with the rate limit response
+     */
+    getRateLimits(): Promise<RateLimitResponse>;
+    /**
+     * Gets the rate limit status for a specific endpoint
+     * @param endpoint The endpoint to get rate limit for
+     * @returns A promise resolving with the endpoint rate limit response
+     */
+    getEndpointRateLimit(endpoint: string): Promise<EndpointRateLimitResponse>;
+    /**
+     * Gets the health status of the API
+     * @returns A promise resolving with the health status
+     */
+    getHealthStatus(): Promise<{
+        status: string;
+    }>;
+}
+
 /**
  * Configuration options for the CrosspostClient
  */
 interface CrosspostClientConfig {
     /**
      * Base URL for the Crosspost API
-     * @default 'https://api.opencrosspost.com'
+     * @default 'https://open-crosspost-proxy.deno.dev'
      */
     baseUrl?: string;
     /**
      * NEAR authentication data obtained from near-sign-verify
      */
-    signature?: NearAuthData;
+    nearAuthData?: NearAuthData;
     /**
      * Request timeout in milliseconds
      * @default 30000
@@ -170,14 +233,10 @@ interface CrosspostClientConfig {
  * Main client for interacting with the Crosspost API service.
  */
 declare class CrosspostClient {
-    /**
-     * Authentication-related API operations
-     */
     readonly auth: AuthApi;
-    /**
-     * Post-related API operations
-     */
     readonly post: PostApi;
+    readonly activity: ActivityApi;
+    readonly system: SystemApi;
     private readonly options;
     /**
      * Creates an instance of CrosspostClient.
@@ -188,7 +247,12 @@ declare class CrosspostClient {
      * Sets the authentication data (signature) for the client and stores it in a cookie
      * @param signature The NEAR authentication data
      */
-    setAuthentication(signature: NearAuthData): Promise<void>;
+    setAuthentication(nearAuthData: NearAuthData): void;
+    /**
+     * Checks if authentication data (signature) exists on client
+     * @param signature The NEAR authentication data
+     */
+    isAuthenticated(): boolean;
 }
 
 /**
@@ -209,6 +273,123 @@ declare function handleErrorResponse(data: any, status: number): ApiError | Plat
  */
 declare function createNetworkError(error: unknown, url: string, timeout: number): ApiError;
 
+/**
+ * Error categories grouped by type for better organization and usage
+ */
+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
+ */
+declare function isErrorOfCategory(error: unknown, category: ApiErrorCode[]): boolean;
+/**
+ * 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
+ */
+declare function getErrorDetails(error: unknown): Record<string, any> | 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;
+/**
+ * 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 const AUTH_COOKIE_NAME = "__crosspost_auth";
 declare const CSRF_COOKIE_NAME = "XSRF-TOKEN";
 declare const CSRF_HEADER_NAME = "X-CSRF-Token";
@@ -233,4 +414,4 @@ declare function clearAuthCookie(): void;
  */
 declare function getCsrfToken(): string | undefined;
 
-export { AUTH_COOKIE_NAME, AUTH_COOKIE_OPTIONS, AuthApi, CSRF_COOKIE_NAME, CSRF_HEADER_NAME, CrosspostClient, type CrosspostClientConfig, PostApi, clearAuthCookie, createNetworkError, getAuthFromCookie, getCsrfToken, handleErrorResponse, storeAuthInCookie };
+export { AUTH_COOKIE_NAME, AUTH_COOKIE_OPTIONS, ActivityApi, AuthApi, CSRF_COOKIE_NAME, CSRF_HEADER_NAME, CrosspostClient, type CrosspostClientConfig, ERROR_CATEGORIES, PostApi, SystemApi, apiWrapper, clearAuthCookie, createNetworkError, enrichErrorWithContext, getAuthFromCookie, getCsrfToken, getErrorDetails, getErrorMessage, handleErrorResponse, isAuthError, isContentError, isErrorOfCategory, isMediaError, isNetworkError, isPlatformError, isPostError, isRateLimitError, isRecoverableError, isValidationError, storeAuthInCookie };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { NearAuthData } from 'near-sign-verify';
-import { NearAuthorizationResponse, Platform, EnhancedApiResponse, AuthStatusResponse, AuthRevokeResponse, ConnectedAccountsResponse, CreatePostRequest, CreatePostResponse, RepostRequest, RepostResponse, QuotePostRequest, QuotePostResponse, ReplyToPostRequest, ReplyToPostResponse, LikePostRequest, LikePostResponse, UnlikePostRequest, UnlikePostResponse, DeletePostRequest, DeletePostResponse, ApiError, PlatformError } from '@crosspost/types';
+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, PlatformError, ApiErrorCode } from '@crosspost/types';
 export * from '@crosspost/types';
 
 /**
@@ -14,7 +14,7 @@ interface RequestOptions {
      * NEAR authentication data for generating auth tokens
      * Can be undefined if not authorize yet
      */
-    signature?: NearAuthData;
+    nearAuthData?: NearAuthData;
     /**
      * Request timeout in milliseconds
      */
@@ -25,6 +25,38 @@ interface RequestOptions {
     retries: number;
 }
 
+/**
+ * Activity-related API operations
+ */
+declare class ActivityApi {
+    private options;
+    /**
+     * Creates an instance of ActivityApi
+     * @param options Request options
+     */
+    constructor(options: RequestOptions);
+    /**
+     * Gets the global activity leaderboard
+     * @param query Optional query parameters
+     * @returns A promise resolving with the leaderboard response
+     */
+    getLeaderboard(query?: ActivityLeaderboardQuery): Promise<ActivityLeaderboardResponse>;
+    /**
+     * Gets activity for a specific account
+     * @param signerId The NEAR account ID
+     * @param query Optional query parameters
+     * @returns A promise resolving with the account activity response
+     */
+    getAccountActivity(signerId: string, query?: AccountActivityQuery): Promise<AccountActivityResponse>;
+    /**
+     * Gets posts for a specific account
+     * @param signerId The NEAR account ID
+     * @param query Optional query parameters
+     * @returns A promise resolving with the account posts response
+     */
+    getAccountPosts(signerId: string, query?: AccountPostsQuery): Promise<AccountPostsResponse>;
+}
+
 /**
  * Authentication-related API operations
  */
@@ -141,19 +173,50 @@ declare class PostApi {
     deletePost(request: DeletePostRequest): Promise<DeletePostResponse>;
 }
 
+/**
+ * System-related API operations
+ * Includes rate limits, health checks, and other system-related functionality
+ */
+declare class SystemApi {
+    private options;
+    /**
+     * Creates an instance of SystemApi
+     * @param options Request options
+     */
+    constructor(options: RequestOptions);
+    /**
+     * Gets the current rate limit status
+     * @returns A promise resolving with the rate limit response
+     */
+    getRateLimits(): Promise<RateLimitResponse>;
+    /**
+     * Gets the rate limit status for a specific endpoint
+     * @param endpoint The endpoint to get rate limit for
+     * @returns A promise resolving with the endpoint rate limit response
+     */
+    getEndpointRateLimit(endpoint: string): Promise<EndpointRateLimitResponse>;
+    /**
+     * Gets the health status of the API
+     * @returns A promise resolving with the health status
+     */
+    getHealthStatus(): Promise<{
+        status: string;
+    }>;
+}
+
 /**
  * Configuration options for the CrosspostClient
  */
 interface CrosspostClientConfig {
     /**
      * Base URL for the Crosspost API
-     * @default 'https://api.opencrosspost.com'
+     * @default 'https://open-crosspost-proxy.deno.dev'
      */
     baseUrl?: string;
     /**
      * NEAR authentication data obtained from near-sign-verify
      */
-    signature?: NearAuthData;
+    nearAuthData?: NearAuthData;
     /**
      * Request timeout in milliseconds
      * @default 30000
@@ -170,14 +233,10 @@ interface CrosspostClientConfig {
  * Main client for interacting with the Crosspost API service.
  */
 declare class CrosspostClient {
-    /**
-     * Authentication-related API operations
-     */
     readonly auth: AuthApi;
-    /**
-     * Post-related API operations
-     */
     readonly post: PostApi;
+    readonly activity: ActivityApi;
+    readonly system: SystemApi;
     private readonly options;
     /**
      * Creates an instance of CrosspostClient.
@@ -188,7 +247,12 @@ declare class CrosspostClient {
      * Sets the authentication data (signature) for the client and stores it in a cookie
      * @param signature The NEAR authentication data
      */
-    setAuthentication(signature: NearAuthData): Promise<void>;
+    setAuthentication(nearAuthData: NearAuthData): void;
+    /**
+     * Checks if authentication data (signature) exists on client
+     * @param signature The NEAR authentication data
+     */
+    isAuthenticated(): boolean;
 }
 
 /**
@@ -209,6 +273,123 @@ declare function handleErrorResponse(data: any, status: number): ApiError | Plat
  */
 declare function createNetworkError(error: unknown, url: string, timeout: number): ApiError;
 
+/**
+ * Error categories grouped by type for better organization and usage
+ */
+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
+ */
+declare function isErrorOfCategory(error: unknown, category: ApiErrorCode[]): boolean;
+/**
+ * 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
+ */
+declare function getErrorDetails(error: unknown): Record<string, any> | 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;
+/**
+ * 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 const AUTH_COOKIE_NAME = "__crosspost_auth";
 declare const CSRF_COOKIE_NAME = "XSRF-TOKEN";
 declare const CSRF_HEADER_NAME = "X-CSRF-Token";
@@ -233,4 +414,4 @@ declare function clearAuthCookie(): void;
  */
 declare function getCsrfToken(): string | undefined;
 
-export { AUTH_COOKIE_NAME, AUTH_COOKIE_OPTIONS, AuthApi, CSRF_COOKIE_NAME, CSRF_HEADER_NAME, CrosspostClient, type CrosspostClientConfig, PostApi, clearAuthCookie, createNetworkError, getAuthFromCookie, getCsrfToken, handleErrorResponse, storeAuthInCookie };
+export { AUTH_COOKIE_NAME, AUTH_COOKIE_OPTIONS, ActivityApi, AuthApi, CSRF_COOKIE_NAME, CSRF_HEADER_NAME, CrosspostClient, type CrosspostClientConfig, ERROR_CATEGORIES, PostApi, SystemApi, apiWrapper, clearAuthCookie, createNetworkError, enrichErrorWithContext, getAuthFromCookie, getCsrfToken, getErrorDetails, getErrorMessage, handleErrorResponse, isAuthError, isContentError, isErrorOfCategory, isMediaError, isNetworkError, isPlatformError, isPostError, isRateLimitError, isRecoverableError, isValidationError, storeAuthInCookie };