@crosspost/sdk 0.1.2

package/dist/index.d.cts

@@ -0,0 +1,236 @@
+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';
+export * from '@crosspost/types';
+
+/**
+ * Options for making a request to the API
+ */
+interface RequestOptions {
+    /**
+     * Base URL for the API
+     */
+    baseUrl: string;
+    /**
+     * NEAR authentication data for generating auth tokens
+     * Can be undefined if not authorize yet
+     */
+    signature?: NearAuthData;
+    /**
+     * Request timeout in milliseconds
+     */
+    timeout: number;
+    /**
+     * Number of retries for failed requests
+     */
+    retries: number;
+}
+
+/**
+ * Authentication-related API operations
+ */
+declare class AuthApi {
+    private options;
+    /**
+     * Creates an instance of AuthApi
+     * @param options Request options
+     */
+    constructor(options: RequestOptions);
+    /**
+     * Authorizes the NEAR account associated with the provided nearAuthData with the Crosspost service.
+     * @returns A promise resolving with the authorization response.
+     */
+    authorizeNearAccount(): Promise<NearAuthorizationResponse>;
+    /**
+     * Checks the authorization status of the NEAR account with the Crosspost service.
+     * @returns A promise resolving with the authorization status response.
+     */
+    getNearAuthorizationStatus(): Promise<NearAuthorizationResponse>;
+    /**
+     * Initiates the login process for a specific platform.
+     * The service handles the OAuth flow; this method triggers it.
+     * @param platform The target platform.
+     * @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>>;
+    /**
+     * Refreshes the authentication token for the specified platform.
+     * @param platform The target platform.
+     * @returns A promise resolving with the refresh response.
+     */
+    refreshToken(platform: Platform): Promise<EnhancedApiResponse<any>>;
+    /**
+     * Refreshes the user's profile information from the specified platform.
+     * @param platform The target platform.
+     * @returns A promise resolving with the profile refresh response.
+     */
+    refreshProfile(platform: Platform): Promise<EnhancedApiResponse<any>>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * Lists all accounts connected to the NEAR account.
+     * @returns A promise resolving with the list of connected accounts.
+     */
+    getConnectedAccounts(): Promise<ConnectedAccountsResponse>;
+}
+
+/**
+ * Post-related API operations
+ */
+declare class PostApi {
+    private options;
+    /**
+     * Creates an instance of PostApi
+     * @param options Request options
+     */
+    constructor(options: RequestOptions);
+    /**
+     * Creates a new post on the specified target platforms.
+     * @param request The post creation request details.
+     * @returns A promise resolving with the post creation response.
+     */
+    createPost(request: CreatePostRequest): Promise<CreatePostResponse>;
+    /**
+     * Reposts an existing post on the specified target platforms.
+     * @param request The repost request details.
+     * @returns A promise resolving with the repost response.
+     */
+    repost(request: RepostRequest): Promise<RepostResponse>;
+    /**
+     * Quotes an existing post on the specified target platforms.
+     * @param request The quote post request details.
+     * @returns A promise resolving with the quote post response.
+     */
+    quotePost(request: QuotePostRequest): Promise<QuotePostResponse>;
+    /**
+     * Replies to an existing post on the specified target platforms.
+     * @param request The reply request details.
+     * @returns A promise resolving with the reply response.
+     */
+    replyToPost(request: ReplyToPostRequest): Promise<ReplyToPostResponse>;
+    /**
+     * Likes a post on the specified target platforms.
+     * @param request The like request details.
+     * @returns A promise resolving with the like response.
+     */
+    likePost(request: LikePostRequest): Promise<LikePostResponse>;
+    /**
+     * Unlikes a post on the specified target platforms.
+     * @param request The unlike request details.
+     * @returns A promise resolving with the unlike response.
+     */
+    unlikePost(request: UnlikePostRequest): Promise<UnlikePostResponse>;
+    /**
+     * Deletes one or more posts.
+     * @param request The delete request details.
+     * @returns A promise resolving with the delete response.
+     */
+    deletePost(request: DeletePostRequest): Promise<DeletePostResponse>;
+}
+
+/**
+ * Configuration options for the CrosspostClient
+ */
+interface CrosspostClientConfig {
+    /**
+     * Base URL for the Crosspost API
+     * @default 'https://api.opencrosspost.com'
+     */
+    baseUrl?: string;
+    /**
+     * NEAR authentication data obtained from near-sign-verify
+     */
+    signature?: NearAuthData;
+    /**
+     * Request timeout in milliseconds
+     * @default 30000
+     */
+    timeout?: number;
+    /**
+     * Number of retries for failed requests (specifically for network errors or 5xx status codes)
+     * @default 2
+     */
+    retries?: number;
+}
+
+/**
+ * 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;
+    private readonly options;
+    /**
+     * Creates an instance of CrosspostClient.
+     * @param config Configuration options for the client.
+     */
+    constructor(config?: CrosspostClientConfig);
+    /**
+     * 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>;
+}
+
+/**
+ * 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;
+/**
+ * Creates a network error with appropriate details
+ *
+ * @param error The original error
+ * @param url The request URL
+ * @param timeout The request timeout
+ * @returns An ApiError instance
+ */
+declare function createNetworkError(error: unknown, url: string, timeout: number): ApiError;
+
+declare const AUTH_COOKIE_NAME = "__crosspost_auth";
+declare const CSRF_COOKIE_NAME = "XSRF-TOKEN";
+declare const CSRF_HEADER_NAME = "X-CSRF-Token";
+declare const AUTH_COOKIE_OPTIONS: Cookies.CookieAttributes;
+/**
+ * Gets authentication data from the cookie
+ * @returns The NearAuthData object or undefined if not found
+ */
+declare function getAuthFromCookie(): NearAuthData | undefined;
+/**
+ * Stores authentication data in a secure cookie
+ * @param authData The NearAuthData object to store
+ */
+declare function storeAuthInCookie(authData: NearAuthData): void;
+/**
+ * Clears the authentication cookie
+ */
+declare function clearAuthCookie(): void;
+/**
+ * Gets the CSRF token from the cookie
+ * @returns The CSRF token or undefined if not found
+ */
+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 };

package/dist/index.d.ts

@@ -0,0 +1,236 @@
+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';
+export * from '@crosspost/types';
+
+/**
+ * Options for making a request to the API
+ */
+interface RequestOptions {
+    /**
+     * Base URL for the API
+     */
+    baseUrl: string;
+    /**
+     * NEAR authentication data for generating auth tokens
+     * Can be undefined if not authorize yet
+     */
+    signature?: NearAuthData;
+    /**
+     * Request timeout in milliseconds
+     */
+    timeout: number;
+    /**
+     * Number of retries for failed requests
+     */
+    retries: number;
+}
+
+/**
+ * Authentication-related API operations
+ */
+declare class AuthApi {
+    private options;
+    /**
+     * Creates an instance of AuthApi
+     * @param options Request options
+     */
+    constructor(options: RequestOptions);
+    /**
+     * Authorizes the NEAR account associated with the provided nearAuthData with the Crosspost service.
+     * @returns A promise resolving with the authorization response.
+     */
+    authorizeNearAccount(): Promise<NearAuthorizationResponse>;
+    /**
+     * Checks the authorization status of the NEAR account with the Crosspost service.
+     * @returns A promise resolving with the authorization status response.
+     */
+    getNearAuthorizationStatus(): Promise<NearAuthorizationResponse>;
+    /**
+     * Initiates the login process for a specific platform.
+     * The service handles the OAuth flow; this method triggers it.
+     * @param platform The target platform.
+     * @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>>;
+    /**
+     * Refreshes the authentication token for the specified platform.
+     * @param platform The target platform.
+     * @returns A promise resolving with the refresh response.
+     */
+    refreshToken(platform: Platform): Promise<EnhancedApiResponse<any>>;
+    /**
+     * Refreshes the user's profile information from the specified platform.
+     * @param platform The target platform.
+     * @returns A promise resolving with the profile refresh response.
+     */
+    refreshProfile(platform: Platform): Promise<EnhancedApiResponse<any>>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * Lists all accounts connected to the NEAR account.
+     * @returns A promise resolving with the list of connected accounts.
+     */
+    getConnectedAccounts(): Promise<ConnectedAccountsResponse>;
+}
+
+/**
+ * Post-related API operations
+ */
+declare class PostApi {
+    private options;
+    /**
+     * Creates an instance of PostApi
+     * @param options Request options
+     */
+    constructor(options: RequestOptions);
+    /**
+     * Creates a new post on the specified target platforms.
+     * @param request The post creation request details.
+     * @returns A promise resolving with the post creation response.
+     */
+    createPost(request: CreatePostRequest): Promise<CreatePostResponse>;
+    /**
+     * Reposts an existing post on the specified target platforms.
+     * @param request The repost request details.
+     * @returns A promise resolving with the repost response.
+     */
+    repost(request: RepostRequest): Promise<RepostResponse>;
+    /**
+     * Quotes an existing post on the specified target platforms.
+     * @param request The quote post request details.
+     * @returns A promise resolving with the quote post response.
+     */
+    quotePost(request: QuotePostRequest): Promise<QuotePostResponse>;
+    /**
+     * Replies to an existing post on the specified target platforms.
+     * @param request The reply request details.
+     * @returns A promise resolving with the reply response.
+     */
+    replyToPost(request: ReplyToPostRequest): Promise<ReplyToPostResponse>;
+    /**
+     * Likes a post on the specified target platforms.
+     * @param request The like request details.
+     * @returns A promise resolving with the like response.
+     */
+    likePost(request: LikePostRequest): Promise<LikePostResponse>;
+    /**
+     * Unlikes a post on the specified target platforms.
+     * @param request The unlike request details.
+     * @returns A promise resolving with the unlike response.
+     */
+    unlikePost(request: UnlikePostRequest): Promise<UnlikePostResponse>;
+    /**
+     * Deletes one or more posts.
+     * @param request The delete request details.
+     * @returns A promise resolving with the delete response.
+     */
+    deletePost(request: DeletePostRequest): Promise<DeletePostResponse>;
+}
+
+/**
+ * Configuration options for the CrosspostClient
+ */
+interface CrosspostClientConfig {
+    /**
+     * Base URL for the Crosspost API
+     * @default 'https://api.opencrosspost.com'
+     */
+    baseUrl?: string;
+    /**
+     * NEAR authentication data obtained from near-sign-verify
+     */
+    signature?: NearAuthData;
+    /**
+     * Request timeout in milliseconds
+     * @default 30000
+     */
+    timeout?: number;
+    /**
+     * Number of retries for failed requests (specifically for network errors or 5xx status codes)
+     * @default 2
+     */
+    retries?: number;
+}
+
+/**
+ * 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;
+    private readonly options;
+    /**
+     * Creates an instance of CrosspostClient.
+     * @param config Configuration options for the client.
+     */
+    constructor(config?: CrosspostClientConfig);
+    /**
+     * 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>;
+}
+
+/**
+ * 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;
+/**
+ * Creates a network error with appropriate details
+ *
+ * @param error The original error
+ * @param url The request URL
+ * @param timeout The request timeout
+ * @returns An ApiError instance
+ */
+declare function createNetworkError(error: unknown, url: string, timeout: number): ApiError;
+
+declare const AUTH_COOKIE_NAME = "__crosspost_auth";
+declare const CSRF_COOKIE_NAME = "XSRF-TOKEN";
+declare const CSRF_HEADER_NAME = "X-CSRF-Token";
+declare const AUTH_COOKIE_OPTIONS: Cookies.CookieAttributes;
+/**
+ * Gets authentication data from the cookie
+ * @returns The NearAuthData object or undefined if not found
+ */
+declare function getAuthFromCookie(): NearAuthData | undefined;
+/**
+ * Stores authentication data in a secure cookie
+ * @param authData The NearAuthData object to store
+ */
+declare function storeAuthInCookie(authData: NearAuthData): void;
+/**
+ * Clears the authentication cookie
+ */
+declare function clearAuthCookie(): void;
+/**
+ * Gets the CSRF token from the cookie
+ * @returns The CSRF token or undefined if not found
+ */
+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 };