@crosspost/sdk 0.1.6 → 0.1.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crosspost/sdk",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "SDK for interacting with the Crosspost API",
   "type": "module",
   "main": "dist/index.cjs",

package/src/api/activity.ts

@@ -28,7 +28,7 @@ export class ActivityApi {
    * @returns A promise resolving with the leaderboard response
    */
   async getLeaderboard(query?: ActivityLeaderboardQuery): Promise<ActivityLeaderboardResponse> {
-    return makeRequest<ActivityLeaderboardResponse>(
+    return makeRequest<ActivityLeaderboardResponse, never, ActivityLeaderboardQuery>(
       'GET',
       '/api/activity',
       this.options,
@@ -47,7 +47,7 @@ export class ActivityApi {
     signerId: string,
     query?: AccountActivityQuery,
   ): Promise<AccountActivityResponse> {
-    return makeRequest<AccountActivityResponse>(
+    return makeRequest<AccountActivityResponse, never, AccountActivityQuery>(
       'GET',
       `/api/activity/${signerId}`,
       this.options,
@@ -66,7 +66,7 @@ export class ActivityApi {
     signerId: string,
     query?: AccountPostsQuery,
   ): Promise<AccountPostsResponse> {
-    return makeRequest<AccountPostsResponse>(
+    return makeRequest<AccountPostsResponse, never, AccountPostsQuery>(
       'GET',
       `/api/activity/${signerId}/posts`,
       this.options,

package/src/api/auth.ts

@@ -1,9 +1,16 @@
 import type {
+  AuthCallbackResponse,
+  AuthInitRequest,
   AuthRevokeResponse,
+  AuthStatusParams,
   AuthStatusResponse,
+  AuthTokenRequest,
+  AuthUrlResponse,
+  ConnectedAccount,
   ConnectedAccountsResponse,
-  EnhancedApiResponse,
+  NearAuthorizationRequest,
   NearAuthorizationResponse,
+  NearUnauthorizationResponse,
   Platform,
 } from '@crosspost/types';
 import { makeRequest, type RequestOptions } from '../core/request.ts';
@@ -27,7 +34,7 @@ export class AuthApi {
    * @returns A promise resolving with the authorization response.
    */
   async authorizeNearAccount(): Promise<NearAuthorizationResponse> {
-    return makeRequest<NearAuthorizationResponse>(
+    return makeRequest<NearAuthorizationResponse, NearAuthorizationRequest>(
       'POST',
       '/auth/authorize/near',
       this.options,
@@ -40,7 +47,7 @@ export class AuthApi {
    * @returns A promise resolving with the authorization status response.
    */
   async getNearAuthorizationStatus(): Promise<NearAuthorizationResponse> {
-    return makeRequest<NearAuthorizationResponse>(
+    return makeRequest<NearAuthorizationResponse, never>(
       'GET',
       '/auth/authorize/near/status',
       this.options,
@@ -56,9 +63,9 @@ export class AuthApi {
    */
   async loginToPlatform(
     platform: Platform,
-    options?: { successUrl?: string; errorUrl?: string },
-  ): Promise<EnhancedApiResponse<any>> { // TODO: Refine response type based on actual API
-    return makeRequest<EnhancedApiResponse<any>>(
+    options?: AuthInitRequest,
+  ): Promise<AuthUrlResponse> {
+    return makeRequest<AuthUrlResponse, AuthInitRequest>(
       'POST',
       `/auth/${platform}/login`,
       this.options,
@@ -69,26 +76,29 @@ export class AuthApi {
   /**
    * 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.
    */
-  async refreshToken(platform: Platform): Promise<EnhancedApiResponse<any>> { // TODO: Refine response type
-    return makeRequest<EnhancedApiResponse<any>>(
+  async refreshToken(platform: Platform, userId: string): Promise<AuthCallbackResponse> {
+    return makeRequest<AuthCallbackResponse, AuthTokenRequest>(
       'POST',
       `/auth/${platform}/refresh`,
       this.options,
+      { userId },
     );
   }
 
   /**
    * 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.
    */
-  async refreshProfile(platform: Platform): Promise<EnhancedApiResponse<any>> { // TODO: Refine response type
-    return makeRequest<EnhancedApiResponse<any>>(
+  async refreshProfile(platform: Platform, userId: string): Promise<ConnectedAccount> {
+    return makeRequest<ConnectedAccount, AuthTokenRequest>(
       'POST',
       `/auth/${platform}/refresh-profile`,
       this.options,
+      { userId },
     );
   }
 
@@ -97,11 +107,26 @@ export class AuthApi {
    * @param platform The target platform.
    * @returns A promise resolving with the authentication status response.
    */
-  async getAuthStatus(platform: Platform): Promise<AuthStatusResponse> {
-    return makeRequest<AuthStatusResponse>(
+  async getAuthStatus(platform: Platform, userId: string): Promise<AuthStatusResponse> {
+    return makeRequest<AuthStatusResponse, never, AuthStatusParams>(
       'GET',
-      `/auth/${platform}/status`,
+      `/auth/${platform}/status/${userId}`,
       this.options,
+      undefined,
+      { platform, userId },
+    );
+  }
+
+  /**
+   * Unauthorizes a NEAR account from using the service
+   * @returns A promise resolving with the unauthorized response
+   */
+  async unauthorizeNear(): Promise<NearUnauthorizationResponse> {
+    return makeRequest<NearUnauthorizationResponse, NearAuthorizationRequest>(
+      'DELETE',
+      '/auth/unauthorize/near',
+      this.options,
+      {},
     );
   }
 
@@ -110,11 +135,12 @@ export class AuthApi {
    * @param platform The target platform.
    * @returns A promise resolving with the revocation response.
    */
-  async revokeAuth(platform: Platform): Promise<AuthRevokeResponse> {
-    return makeRequest<AuthRevokeResponse>(
+  async revokeAuth(platform: Platform, userId: string): Promise<AuthRevokeResponse> {
+    return makeRequest<AuthRevokeResponse, AuthTokenRequest>(
       'DELETE',
       `/auth/${platform}/revoke`,
       this.options,
+      { userId },
     );
   }
 
@@ -123,7 +149,7 @@ export class AuthApi {
    * @returns A promise resolving with the list of connected accounts.
    */
   async getConnectedAccounts(): Promise<ConnectedAccountsResponse> {
-    return makeRequest<ConnectedAccountsResponse>(
+    return makeRequest<ConnectedAccountsResponse, never>(
       'GET',
       '/auth/accounts',
       this.options,

package/src/api/post.ts

@@ -14,7 +14,6 @@ import type {
   UnlikePostRequest,
   UnlikePostResponse,
 } from '@crosspost/types';
-import { ApiError, ApiErrorCode } from '@crosspost/types';
 import { makeRequest, type RequestOptions } from '../core/request.ts';
 
 /**
@@ -37,7 +36,7 @@ export class PostApi {
    * @returns A promise resolving with the post creation response.
    */
   async createPost(request: CreatePostRequest): Promise<CreatePostResponse> {
-    return makeRequest<CreatePostResponse>(
+    return makeRequest<CreatePostResponse, CreatePostRequest>(
       'POST',
       '/api/post',
       this.options,
@@ -51,7 +50,7 @@ export class PostApi {
    * @returns A promise resolving with the repost response.
    */
   async repost(request: RepostRequest): Promise<RepostResponse> {
-    return makeRequest<RepostResponse>(
+    return makeRequest<RepostResponse, RepostRequest>(
       'POST',
       '/api/post/repost',
       this.options,
@@ -65,7 +64,7 @@ export class PostApi {
    * @returns A promise resolving with the quote post response.
    */
   async quotePost(request: QuotePostRequest): Promise<QuotePostResponse> {
-    return makeRequest<QuotePostResponse>(
+    return makeRequest<QuotePostResponse, QuotePostRequest>(
       'POST',
       '/api/post/quote',
       this.options,
@@ -79,7 +78,7 @@ export class PostApi {
    * @returns A promise resolving with the reply response.
    */
   async replyToPost(request: ReplyToPostRequest): Promise<ReplyToPostResponse> {
-    return makeRequest<ReplyToPostResponse>(
+    return makeRequest<ReplyToPostResponse, ReplyToPostRequest>(
       'POST',
       '/api/post/reply',
       this.options,
@@ -93,10 +92,9 @@ export class PostApi {
    * @returns A promise resolving with the like response.
    */
   async likePost(request: LikePostRequest): Promise<LikePostResponse> {
-    // API endpoint uses postId in the path
-    return makeRequest<LikePostResponse>(
+    return makeRequest<LikePostResponse, LikePostRequest>(
       'POST',
-      `/api/post/like/${request.postId}`,
+      `/api/post/like`,
       this.options,
       request,
     );
@@ -108,10 +106,9 @@ export class PostApi {
    * @returns A promise resolving with the unlike response.
    */
   async unlikePost(request: UnlikePostRequest): Promise<UnlikePostResponse> {
-    // API endpoint uses postId in the path
-    return makeRequest<UnlikePostResponse>(
+    return makeRequest<UnlikePostResponse, UnlikePostRequest>(
       'DELETE',
-      `/api/post/like/${request.postId}`,
+      `/api/post/like`,
       this.options,
       request,
     );
@@ -123,18 +120,9 @@ export class PostApi {
    * @returns A promise resolving with the delete response.
    */
   async deletePost(request: DeletePostRequest): Promise<DeletePostResponse> {
-    // API endpoint uses postId in the path, assuming the first post ID for the URL
-    const postId = request.posts[0]?.postId || '';
-    if (!postId) {
-      throw new ApiError(
-        'Post ID is required for deletion path',
-        ApiErrorCode.VALIDATION_ERROR,
-        400,
-      );
-    }
-    return makeRequest<DeletePostResponse>(
+    return makeRequest<DeletePostResponse, DeletePostRequest>(
       'DELETE',
-      `/api/post/${postId}`,
+      `/api/post`,
       this.options,
       request,
     );

package/src/api/system.ts

@@ -1,4 +1,9 @@
-import type { EndpointRateLimitResponse, RateLimitResponse } from '@crosspost/types';
+import type {
+  EndpointRateLimitResponse,
+  HealthStatus,
+  RateLimitEndpointParam,
+  RateLimitResponse,
+} from '@crosspost/types';
 import { makeRequest, type RequestOptions } from '../core/request.ts';
 
 /**
@@ -21,7 +26,7 @@ export class SystemApi {
    * @returns A promise resolving with the rate limit response
    */
   async getRateLimits(): Promise<RateLimitResponse> {
-    return makeRequest<RateLimitResponse>(
+    return makeRequest<RateLimitResponse, never>(
       'GET',
       '/api/rate-limit',
       this.options,
@@ -34,10 +39,12 @@ export class SystemApi {
    * @returns A promise resolving with the endpoint rate limit response
    */
   async getEndpointRateLimit(endpoint: string): Promise<EndpointRateLimitResponse> {
-    return makeRequest<EndpointRateLimitResponse>(
+    return makeRequest<EndpointRateLimitResponse, never, RateLimitEndpointParam>(
       'GET',
       `/api/rate-limit/${endpoint}`,
       this.options,
+      undefined,
+      { endpoint },
     );
   }
 
@@ -45,8 +52,8 @@ export class SystemApi {
    * Gets the health status of the API
    * @returns A promise resolving with the health status
    */
-  async getHealthStatus(): Promise<{ status: string }> {
-    return makeRequest<{ status: string }>(
+  async getHealthStatus(): Promise<HealthStatus> {
+    return makeRequest<HealthStatus, never>(
       'GET',
       '/health',
       this.options,

package/src/core/client.ts

@@ -43,17 +43,56 @@ export class CrosspostClient {
 
   /**
    * Sets the authentication data (signature) for the client
+   * Required for non-GET requests
    * @param nearAuthData The NEAR authentication data
    */
   public setAuthentication(nearAuthData: NearAuthData): void {
     this.options.nearAuthData = nearAuthData;
+    // Also set nearAccount from nearAuthData if not already set
+    if (!this.options.nearAccount) {
+      this.options.nearAccount = nearAuthData.account_id;
+    }
+  }
+
+  /**
+   * 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
+   */
+  public setNearAccount(nearAccount: string): void {
+    this.options.nearAccount = nearAccount;
+  }
+
+  /**
+   * Gets the current NEAR account ID being used for authentication
+   * @returns The NEAR account ID from nearAccount or nearAuthData
+   */
+  public getNearAccount(): string | undefined {
+    return this.options.nearAccount || this.options.nearAuthData?.account_id;
   }
 
   /**
    * 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)
    */
   public isAuthenticated(): boolean {
     return !!this.options.nearAuthData;
   }
+
+  /**
+   * Checks if a NEAR account is set for GET request authentication
+   * @returns true if either nearAccount or nearAuthData.account_id is set
+   */
+  public hasNearAccount(): boolean {
+    return !!(this.options.nearAccount || this.options.nearAuthData?.account_id);
+  }
+
+  /**
+   * Clears all authentication data from the client
+   * This will prevent all requests from working until new authentication is set
+   */
+  public clear(): void {
+    this.options.nearAuthData = undefined;
+    this.options.nearAccount = undefined;
+  }
 }

package/src/core/request.ts

@@ -1,6 +1,11 @@
-import { ApiError, ApiErrorCode } from '@crosspost/types';
+import { ApiErrorCode, type StatusCode } from '@crosspost/types';
 import { createAuthToken, type NearAuthData } from 'near-sign-verify';
-import { apiWrapper, createNetworkError, handleErrorResponse } from '../utils/error.ts';
+import {
+  apiWrapper,
+  createNetworkError,
+  CrosspostError,
+  handleErrorResponse,
+} from '../utils/error.ts';
 
 /**
  * Options for making a request to the API
@@ -12,9 +17,14 @@ export 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
    */
@@ -34,17 +44,21 @@ export interface RequestOptions {
  * @param data Optional request data
  * @returns A promise resolving with the response data
  */
-export async function makeRequest<T>(
+export async function makeRequest<
+  TResponse,
+  TRequest = unknown,
+  TQuery = unknown,
+>(
   method: string,
   path: string,
   options: RequestOptions,
-  data?: any,
-  query?: Record<string, any>,
-): Promise<T> {
+  data?: TRequest,
+  query?: TQuery,
+): Promise<TResponse> {
   let url = `${options.baseUrl}${path.startsWith('/') ? path : `/${path}`}`;
 
   // Add query parameters if provided
-  if (query && Object.keys(query).length > 0) {
+  if (query && typeof query === 'object' && Object.keys(query).length > 0) {
     const queryParams = new URLSearchParams();
     for (const [key, value] of Object.entries(query)) {
       if (value !== undefined && value !== null) {
@@ -56,10 +70,6 @@ export async function makeRequest<T>(
       url += `?${queryString}`;
     }
   }
-  // Check if authentication data is available
-  if (!options.nearAuthData) {
-    throw ApiError.unauthorized('Authentication required. Please provide NEAR signature.');
-  }
 
   // Create a context object for error enrichment
   const context = {
@@ -80,9 +90,31 @@ export async function makeRequest<T>(
         const headers: Record<string, string> = {
           'Content-Type': 'application/json',
           'Accept': 'application/json',
-          'Authorization': `Bearer ${createAuthToken(options.nearAuthData!)}`,
         };
 
+        // For GET requests, use X-Near-Account header if available
+        if (method === 'GET') {
+          const nearAccount = options.nearAccount || options.nearAuthData?.account_id;
+          if (!nearAccount) {
+            throw new CrosspostError(
+              'No NEAR account provided for GET request',
+              ApiErrorCode.UNAUTHORIZED,
+              401,
+            );
+          }
+          headers['X-Near-Account'] = nearAccount;
+        } else {
+          // For non-GET requests, require nearAuthData
+          if (!options.nearAuthData) {
+            throw new CrosspostError(
+              'NEAR authentication data required for non-GET request',
+              ApiErrorCode.UNAUTHORIZED,
+              401,
+            );
+          }
+          headers['Authorization'] = `Bearer ${createAuthToken(options.nearAuthData)}`;
+        }
+
         const requestOptions: RequestInit = {
           method,
           headers,
@@ -97,32 +129,30 @@ export async function makeRequest<T>(
         try {
           responseData = await response.json();
         } catch (jsonError) {
-          // If JSON parsing fails, throw a specific error or handle based on status
+          // If JSON parsing fails, did API throw an error?
           if (!response.ok) {
-            throw new ApiError(
+            throw new CrosspostError(
               `API request failed with status ${response.status} and non-JSON response`,
               ApiErrorCode.NETWORK_ERROR,
-              response.status as any,
+              response.status as StatusCode,
               { originalStatusText: response.statusText },
             );
           }
-          // If response was ok but JSON failed, maybe it was an empty 204 response?
-          if (response.status === 204) return {} as T; // Handle No Content
           // Otherwise, throw a custom error
-          throw new ApiError(
+          throw new CrosspostError(
             `Failed to parse JSON response: ${
               jsonError instanceof Error ? jsonError.message : String(jsonError)
             }`,
             ApiErrorCode.INTERNAL_ERROR,
-            response.status as any,
+            response.status as StatusCode,
           );
         }
 
         if (!response.ok) {
           lastError = handleErrorResponse(responseData, response.status);
-          // Retry only on 5xx errors or potentially recoverable errors if defined
-          const shouldRetry = response.status >= 500 ||
-            (lastError instanceof ApiError && lastError.recoverable);
+          // Only retry rate limit errors
+          const shouldRetry = lastError instanceof CrosspostError &&
+            lastError.code === ApiErrorCode.RATE_LIMITED;
           if (shouldRetry && attempt < options.retries) {
             await new Promise((resolve) => setTimeout(resolve, 1000 * Math.pow(2, attempt))); // Exponential backoff
             continue; // Retry
@@ -130,22 +160,24 @@ export async function makeRequest<T>(
           throw lastError; // Throw error if not retrying or retries exhausted
         }
 
-        // Handle cases where API indicates failure within a 2xx response
-        if (
-          responseData && typeof responseData === 'object' && 'success' in responseData &&
-          !responseData.success && responseData.error
-        ) {
-          lastError = handleErrorResponse(responseData, response.status);
-          // Decide if this specific type of "successful" response with an error payload should be retried
-          const shouldRetry = lastError instanceof ApiError && lastError.recoverable;
-          if (shouldRetry && attempt < options.retries) {
-            await new Promise((resolve) => setTimeout(resolve, 1000 * Math.pow(2, attempt))); // Exponential backoff
-            continue; // Retry
+        // Handle response based on success flag
+        if (responseData && typeof responseData === 'object' && 'success' in responseData) {
+          if (responseData.success) {
+            // Success response - return the data
+            return responseData.data as TResponse;
+          } else {
+            // Error response - handle with our error utilities
+            lastError = handleErrorResponse(responseData, response.status);
+            // Only retry rate limit errors
+            const shouldRetry = lastError instanceof CrosspostError &&
+              lastError.code === ApiErrorCode.RATE_LIMITED;
+            if (shouldRetry && attempt < options.retries) {
+              await new Promise((resolve) => setTimeout(resolve, 1000 * Math.pow(2, attempt))); // Exponential backoff
+              continue; // Retry
+            }
+            throw lastError;
           }
-          throw lastError;
         }
-
-        return responseData as T;
       } catch (error) {
         clearTimeout(timeoutId); // Clear timeout on error
         lastError = error instanceof Error ? error : new Error(String(error)); // Store the error
@@ -159,7 +191,7 @@ export async function makeRequest<T>(
         }
 
         // If it's not a known ApiError/PlatformError, wrap it
-        if (!(error instanceof ApiError)) {
+        if (!(error instanceof CrosspostError)) {
           throw createNetworkError(error, url, options.timeout);
         }
 
@@ -169,6 +201,6 @@ export async function makeRequest<T>(
 
     // Should not be reachable if retries >= 0, but needed for type safety
     throw lastError ||
-      new ApiError('Request failed after multiple retries', ApiErrorCode.INTERNAL_ERROR, 500);
+      new CrosspostError('Request failed after multiple retries', ApiErrorCode.INTERNAL_ERROR, 500);
   }, context);
 }

package/src/index.ts

@@ -1,30 +1,20 @@
-/**
- * @crosspost/sdk
- * SDK for interacting with the Crosspost API
- */
-
-// Export main client
 export { CrosspostClient } from './core/client.ts';
 export type { CrosspostClientConfig } from './core/config.ts';
 
-// Export API modules for advanced usage
 export { ActivityApi } from './api/activity.ts';
 export { AuthApi } from './api/auth.ts';
 export { PostApi } from './api/post.ts';
 export { SystemApi } from './api/system.ts';
 
-// Export utility functions
 export {
   apiWrapper,
   createNetworkError,
   enrichErrorWithContext,
-  ERROR_CATEGORIES,
   getErrorDetails,
   getErrorMessage,
   handleErrorResponse,
   isAuthError,
   isContentError,
-  isErrorOfCategory,
   isMediaError,
   isNetworkError,
   isPlatformError,