@commercengine/storefront-sdk 0.3.11 → 0.4.0

package/dist/lib/client.d.ts

@@ -1,113 +0,0 @@
-import createClient from "openapi-fetch";
-import type { paths } from "../types/storefront";
-import { ApiErrorResponse, ApiResult } from "../types/storefront-api-types";
-import type { StorefrontSDKOptions } from "../index";
-/**
- * Available API environments
- */
-export declare enum Environment {
-    /**
-     * Staging environment
-     */
-    Staging = "staging",
-    /**
-     * Production environment
-     */
-    Production = "production"
-}
-/**
- * Base API client for Storefront API
- */
-export declare class StorefrontAPIClient {
-    protected client: ReturnType<typeof createClient<paths>>;
-    protected config: StorefrontSDKOptions;
-    private readonly baseUrl;
-    private initializationPromise;
-    /**
-     * Create a new StorefrontAPIClient
-     *
-     * @param config - Configuration for the API client
-     */
-    constructor(config: StorefrontSDKOptions);
-    /**
-     * Set up timeout middleware
-     */
-    private setupTimeoutMiddleware;
-    /**
-     * Constructs the base URL from the configuration
-     *
-     * @param config - The client configuration
-     * @returns The constructed base URL
-     */
-    private getBaseUrlFromConfig;
-    /**
-     * Get the base URL of the API
-     *
-     * @returns The base URL of the API
-     */
-    getBaseUrl(): string;
-    /**
-     * Get the authorization header value
-     * If using token storage, gets the current token from storage
-     * Otherwise returns the manual token
-     *
-     * @returns The Authorization header value or empty string if no token is set
-     */
-    getAuthorizationHeader(): Promise<string>;
-    /**
-     * Set authentication tokens
-     *
-     * @param accessToken - The access token (required)
-     * @param refreshToken - The refresh token (optional)
-     *
-     * Behavior:
-     * - If tokenStorage is provided: Stores tokens for automatic management
-     * - If tokenStorage is not provided: Only stores access token for manual management
-     */
-    setTokens(accessToken: string, refreshToken?: string): Promise<void>;
-    /**
-     * Clear all authentication tokens
-     *
-     * Behavior:
-     * - If tokenStorage is provided: Clears both access and refresh tokens from storage
-     * - If tokenStorage is not provided: Clears the manual access token
-     */
-    clearTokens(): Promise<void>;
-    /**
-     * Set the X-Api-Key header
-     *
-     * @param apiKey - The API key to set
-     */
-    setApiKey(apiKey: string): void;
-    /**
-     * Clear the X-Api-Key header
-     */
-    clearApiKey(): void;
-    /**
-     * Execute a request and handle the response
-     *
-     * @param apiCall - Function that executes the API request
-     * @returns Promise with the API response
-     */
-    protected executeRequest<T>(apiCall: () => Promise<{
-        data?: {
-            message?: string;
-            success?: boolean;
-            content?: T;
-        };
-        error?: ApiErrorResponse;
-        response: Response;
-    }>): Promise<ApiResult<T>>;
-    /**
-     * Initialize tokens in storage (private helper method)
-     */
-    private initializeTokens;
-    /**
-     * Merge default headers with method-level headers
-     * Method-level headers take precedence over default headers
-     *
-     * @param methodHeaders - Headers passed to the specific method call
-     * @returns Merged headers object with proper HTTP header names
-     */
-    protected mergeHeaders<T extends Record<string, any> = Record<string, any>>(methodHeaders?: T): T;
-}

package/dist/lib/client.js

@@ -1,297 +0,0 @@
-import createClient from "openapi-fetch";
-import { createDefaultAuthMiddleware } from "./middleware";
-import { getPathnameFromUrl, isAnonymousAuthEndpoint } from "./auth-utils";
-import { createDebugMiddleware } from "./logger-utils";
-import { mergeHeaders } from "./header-utils";
-/**
- * Available API environments
- */
-export var Environment;
-(function (Environment) {
-    /**
-     * Staging environment
-     */
-    Environment["Staging"] = "staging";
-    /**
-     * Production environment
-     */
-    Environment["Production"] = "production";
-})(Environment || (Environment = {}));
-/**
- * Base API client for Storefront API
- */
-export class StorefrontAPIClient {
-    client;
-    config;
-    baseUrl;
-    initializationPromise = null;
-    /**
-     * Create a new StorefrontAPIClient
-     *
-     * @param config - Configuration for the API client
-     */
-    constructor(config) {
-        this.config = { ...config };
-        // Determine base URL from environment or use custom URL if provided
-        this.baseUrl = this.getBaseUrlFromConfig(this.config);
-        this.client = createClient({
-            baseUrl: this.baseUrl,
-        });
-        // Set up auth middleware if token storage is provided
-        if (this.config.tokenStorage) {
-            const authMiddleware = createDefaultAuthMiddleware({
-                apiKey: this.config.apiKey,
-                baseUrl: this.baseUrl,
-                tokenStorage: this.config.tokenStorage,
-                onTokensUpdated: this.config.onTokensUpdated,
-                onTokensCleared: this.config.onTokensCleared,
-            });
-            this.client.use(authMiddleware);
-            // If initial tokens were provided, store them in tokenStorage
-            if (this.config.accessToken) {
-                this.initializationPromise = this.initializeTokens(this.config.accessToken, this.config.refreshToken);
-                // Clear the manual tokens since we're using storage
-                this.config.accessToken = undefined;
-                this.config.refreshToken = undefined;
-            }
-        }
-        else {
-            // For manual token management, add simple header injection middleware
-            this.client.use({
-                onRequest: async ({ request }) => {
-                    const pathname = getPathnameFromUrl(request.url);
-                    // Handle anonymous auth endpoint - use API key
-                    if (isAnonymousAuthEndpoint(pathname)) {
-                        if (this.config.apiKey) {
-                            request.headers.set("X-Api-Key", this.config.apiKey);
-                        }
-                        // Also send existing access token if available for continuity
-                        if (this.config.accessToken) {
-                            request.headers.set("Authorization", `Bearer ${this.config.accessToken}`);
-                        }
-                        return request;
-                    }
-                    // For all other endpoints, use access token
-                    if (this.config.accessToken) {
-                        request.headers.set("Authorization", `Bearer ${this.config.accessToken}`);
-                    }
-                    return request;
-                },
-            });
-        }
-        // Set up timeout middleware if configured
-        if (this.config.timeout) {
-            this.setupTimeoutMiddleware();
-        }
-        // Set up debug middleware if enabled
-        if (this.config.debug) {
-            const debugMiddleware = createDebugMiddleware(this.config.logger);
-            this.client.use(debugMiddleware);
-        }
-    }
-    /**
-     * Set up timeout middleware
-     */
-    setupTimeoutMiddleware() {
-        this.client.use({
-            onRequest: async ({ request }) => {
-                // Add timeout signal
-                const controller = new AbortController();
-                const timeoutId = setTimeout(() => controller.abort(), this.config.timeout);
-                // Merge with existing signal if present
-                if (request.signal) {
-                    request.signal.addEventListener("abort", () => controller.abort());
-                }
-                // Create new request with timeout signal
-                const newRequest = new Request(request, {
-                    signal: controller.signal,
-                });
-                // Clean up timeout when request completes
-                controller.signal.addEventListener("abort", () => clearTimeout(timeoutId));
-                return newRequest;
-            },
-        });
-    }
-    /**
-     * Constructs the base URL from the configuration
-     *
-     * @param config - The client configuration
-     * @returns The constructed base URL
-     */
-    getBaseUrlFromConfig(config) {
-        // If explicit baseUrl is provided, use it
-        if (config.baseUrl) {
-            return config.baseUrl;
-        }
-        // Otherwise construct URL based on environment and storeId
-        const env = config.environment || Environment.Production;
-        switch (env) {
-            case Environment.Staging:
-                return `https://staging.api.commercengine.io/api/v1/${config.storeId}/storefront`;
-            case Environment.Production:
-            default:
-                return `https://prod.api.commercengine.io/api/v1/${config.storeId}/storefront`;
-        }
-    }
-    /**
-     * Get the base URL of the API
-     *
-     * @returns The base URL of the API
-     */
-    getBaseUrl() {
-        return this.baseUrl;
-    }
-    /**
-     * Get the authorization header value
-     * If using token storage, gets the current token from storage
-     * Otherwise returns the manual token
-     *
-     * @returns The Authorization header value or empty string if no token is set
-     */
-    async getAuthorizationHeader() {
-        // Wait for initialization to complete if using token storage
-        if (this.config.tokenStorage && this.initializationPromise) {
-            await this.initializationPromise;
-        }
-        if (this.config.tokenStorage) {
-            const token = await this.config.tokenStorage.getAccessToken();
-            return token ? `Bearer ${token}` : "";
-        }
-        return this.config.accessToken ? `Bearer ${this.config.accessToken}` : "";
-    }
-    /**
-     * Set authentication tokens
-     *
-     * @param accessToken - The access token (required)
-     * @param refreshToken - The refresh token (optional)
-     *
-     * Behavior:
-     * - If tokenStorage is provided: Stores tokens for automatic management
-     * - If tokenStorage is not provided: Only stores access token for manual management
-     */
-    async setTokens(accessToken, refreshToken) {
-        if (this.config.tokenStorage) {
-            // Automatic token management
-            await this.config.tokenStorage.setAccessToken(accessToken);
-            if (refreshToken) {
-                await this.config.tokenStorage.setRefreshToken(refreshToken);
-            }
-        }
-        else {
-            // Manual token management - only access token
-            this.config.accessToken = accessToken;
-            if (refreshToken) {
-                console.warn("Refresh token provided but ignored in manual token management mode. Use tokenStorage for automatic management.");
-            }
-        }
-    }
-    /**
-     * Clear all authentication tokens
-     *
-     * Behavior:
-     * - If tokenStorage is provided: Clears both access and refresh tokens from storage
-     * - If tokenStorage is not provided: Clears the manual access token
-     */
-    async clearTokens() {
-        if (this.config.tokenStorage) {
-            await this.config.tokenStorage.clearTokens();
-        }
-        else {
-            this.config.accessToken = undefined;
-        }
-    }
-    /**
-     * Set the X-Api-Key header
-     *
-     * @param apiKey - The API key to set
-     */
-    setApiKey(apiKey) {
-        this.config.apiKey = apiKey;
-    }
-    /**
-     * Clear the X-Api-Key header
-     */
-    clearApiKey() {
-        this.config.apiKey = undefined;
-    }
-    /**
-     * Execute a request and handle the response
-     *
-     * @param apiCall - Function that executes the API request
-     * @returns Promise with the API response
-     */
-    async executeRequest(apiCall) {
-        try {
-            const { data, error, response } = await apiCall();
-            // Debug logging is now handled by middleware
-            // openapi-fetch returns error for 4xx/5xx, data for 2xx
-            if (error) {
-                return {
-                    data: null,
-                    error,
-                    response,
-                };
-            }
-            // If response has content, return it directly
-            if (data && data.content !== undefined) {
-                return {
-                    data: data.content,
-                    error: null,
-                    response,
-                };
-            }
-            // If no content, return the response object (with message, success, etc.)
-            return {
-                data: data,
-                error: null,
-                response,
-            };
-        }
-        catch (err) {
-            // This handles network errors or other unexpected errors
-            // Network errors don't have Response objects, so we create a mock response
-            const mockResponse = new Response(null, {
-                status: 0,
-                statusText: "Network Error",
-            });
-            const errorResult = {
-                data: null,
-                error: {
-                    success: false,
-                    code: "NETWORK_ERROR",
-                    message: "Network error occurred",
-                    error: err,
-                },
-                response: mockResponse,
-            };
-            // Network errors are logged by middleware if debug is enabled
-            return errorResult;
-        }
-    }
-    /**
-     * Initialize tokens in storage (private helper method)
-     */
-    async initializeTokens(accessToken, refreshToken) {
-        try {
-            if (this.config.tokenStorage) {
-                await this.config.tokenStorage.setAccessToken(accessToken);
-                if (refreshToken) {
-                    await this.config.tokenStorage.setRefreshToken(refreshToken);
-                }
-            }
-        }
-        catch (error) {
-            console.warn("Failed to initialize tokens in storage:", error);
-        }
-    }
-    /**
-     * Merge default headers with method-level headers
-     * Method-level headers take precedence over default headers
-     *
-     * @param methodHeaders - Headers passed to the specific method call
-     * @returns Merged headers object with proper HTTP header names
-     */
-    mergeHeaders(methodHeaders) {
-        return mergeHeaders(this.config.defaultHeaders, methodHeaders);
-    }
-}

package/dist/lib/customer.d.ts

@@ -1,87 +0,0 @@
-import type { ApiResult, CreateCustomerBody, CreateAddressBody, CreateAddressContent, CreateAddressPathParams, CreateCustomerContent, DeleteAddressPathParams, DeleteAddressResponse, GetAddressDetailContent, GetAddressDetailPathParams, GetCustomerDetailContent, GetCustomerDetailPathParams, GetLoyaltyDetailsContent, GetLoyaltyDetailsPathParams, ListAddressesContent, ListAddressesPathParams, ListLoyaltyActivitiesContent, ListLoyaltyActivitiesPathParams, ListUserReviewsContent, ListUserReviewsPathParams, UpdateAddressDetailBody, UpdateAddressDetailContent, UpdateAddressDetailPathParams, UpdateCustomerBody, UpdateCustomerContent, UpdateCustomerPathParams } from "../types/storefront-api-types";
-import { StorefrontAPIClient } from "./client";
-/**
- * Client for interacting with customer endpoints
- */
-export declare class CustomerClient extends StorefrontAPIClient {
-    /**
-     * Create a customer
-     *
-     * @param body - Customer creation body
-     * @returns Promise with customer details
-     */
-    createCustomer(body: CreateCustomerBody): Promise<ApiResult<CreateCustomerContent>>;
-    /**
-     * Get customer details
-     *
-     * @param pathParams - Path parameters
-     * @returns Promise with customer details
-     */
-    getCustomer(pathParams: GetCustomerDetailPathParams): Promise<ApiResult<GetCustomerDetailContent>>;
-    /**
-     * Update a customer
-     *
-     * @param pathParams - Path parameters
-     * @param body - Customer update body
-     * @returns Promise with customer details
-     */
-    updateCustomer(pathParams: UpdateCustomerPathParams, body: UpdateCustomerBody): Promise<ApiResult<UpdateCustomerContent>>;
-    /**
-     * Get all saved addresses for a customer
-     *
-     * @param pathParams - Path parameters
-     * @returns Promise with addresses
-     */
-    listAddresses(pathParams: ListAddressesPathParams): Promise<ApiResult<ListAddressesContent>>;
-    /**
-     * Create a new address for a customer
-     *
-     * @param pathParams - Path parameters
-     * @param body - Address creation body
-     * @returns Promise with address details
-     */
-    createAddress(pathParams: CreateAddressPathParams, body: CreateAddressBody): Promise<ApiResult<CreateAddressContent>>;
-    /**
-     * Get an address for a customer
-     *
-     * @param pathParams - Path parameters
-     * @returns Promise with address details
-     */
-    getAddress(pathParams: GetAddressDetailPathParams): Promise<ApiResult<GetAddressDetailContent>>;
-    /**
-     * Update an address for a customer
-     *
-     * @param pathParams - Path parameters
-     * @param body - Address update body
-     * @returns Promise with address details
-     */
-    updateAddress(pathParams: UpdateAddressDetailPathParams, body: UpdateAddressDetailBody): Promise<ApiResult<UpdateAddressDetailContent>>;
-    /**
-     * Delete an address for a customer
-     *
-     * @param pathParams - Path parameters
-     * @returns Promise with address details
-     */
-    deleteAddress(pathParams: DeleteAddressPathParams): Promise<ApiResult<DeleteAddressResponse>>;
-    /**
-     * Get customer loyalty details
-     *
-     * @param pathParams - Path parameters
-     * @returns Promise with loyalty details
-     */
-    getLoyaltyDetails(pathParams: GetLoyaltyDetailsPathParams): Promise<ApiResult<GetLoyaltyDetailsContent>>;
-    /**
-     * List all loyalty points activity for a customer
-     *
-     * @param pathParams - Path parameters
-     * @returns Promise with loyalty points activity
-     */
-    listLoyaltyPointsActivity(pathParams: ListLoyaltyActivitiesPathParams): Promise<ApiResult<ListLoyaltyActivitiesContent>>;
-    /**
-     * List all reviews left by a customer
-     *
-     * @param pathParams - Path parameters
-     * @returns Promise with reviews
-     */
-    listCustomerReviews(pathParams: ListUserReviewsPathParams): Promise<ApiResult<ListUserReviewsContent>>;
-}

package/dist/lib/customer.js

@@ -1,153 +0,0 @@
-import { StorefrontAPIClient } from "./client";
-/**
- * Client for interacting with customer endpoints
- */
-export class CustomerClient extends StorefrontAPIClient {
-    /**
-     * Create a customer
-     *
-     * @param body - Customer creation body
-     * @returns Promise with customer details
-     */
-    async createCustomer(body) {
-        return this.executeRequest(() => this.client.POST("/customers", {
-            body: body,
-        }));
-    }
-    /**
-     * Get customer details
-     *
-     * @param pathParams - Path parameters
-     * @returns Promise with customer details
-     */
-    async getCustomer(pathParams) {
-        return this.executeRequest(() => this.client.GET("/customers/{id}", {
-            params: {
-                path: pathParams,
-            },
-        }));
-    }
-    /**
-     * Update a customer
-     *
-     * @param pathParams - Path parameters
-     * @param body - Customer update body
-     * @returns Promise with customer details
-     */
-    async updateCustomer(pathParams, body) {
-        return this.executeRequest(() => this.client.PUT("/customers/{id}", {
-            params: {
-                path: pathParams,
-            },
-            body: body,
-        }));
-    }
-    /**
-     * Get all saved addresses for a customer
-     *
-     * @param pathParams - Path parameters
-     * @returns Promise with addresses
-     */
-    async listAddresses(pathParams) {
-        return this.executeRequest(() => this.client.GET("/customers/{user_id}/addresses", {
-            params: {
-                path: pathParams,
-            },
-        }));
-    }
-    /**
-     * Create a new address for a customer
-     *
-     * @param pathParams - Path parameters
-     * @param body - Address creation body
-     * @returns Promise with address details
-     */
-    async createAddress(pathParams, body) {
-        return this.executeRequest(() => this.client.POST("/customers/{user_id}/addresses", {
-            params: {
-                path: pathParams,
-            },
-            body: body,
-        }));
-    }
-    /**
-     * Get an address for a customer
-     *
-     * @param pathParams - Path parameters
-     * @returns Promise with address details
-     */
-    async getAddress(pathParams) {
-        return this.executeRequest(() => this.client.GET("/customers/{user_id}/addresses/{address_id}", {
-            params: {
-                path: pathParams,
-            },
-        }));
-    }
-    /**
-     * Update an address for a customer
-     *
-     * @param pathParams - Path parameters
-     * @param body - Address update body
-     * @returns Promise with address details
-     */
-    async updateAddress(pathParams, body) {
-        return this.executeRequest(() => this.client.PUT("/customers/{user_id}/addresses/{address_id}", {
-            params: {
-                path: pathParams,
-            },
-            body: body,
-        }));
-    }
-    /**
-     * Delete an address for a customer
-     *
-     * @param pathParams - Path parameters
-     * @returns Promise with address details
-     */
-    async deleteAddress(pathParams) {
-        return this.executeRequest(() => this.client.DELETE("/customers/{user_id}/addresses/{address_id}", {
-            params: {
-                path: pathParams,
-            },
-        }));
-    }
-    /**
-     * Get customer loyalty details
-     *
-     * @param pathParams - Path parameters
-     * @returns Promise with loyalty details
-     */
-    async getLoyaltyDetails(pathParams) {
-        return this.executeRequest(() => this.client.GET("/customers/{user_id}/loyalty", {
-            params: {
-                path: pathParams,
-            },
-        }));
-    }
-    /**
-     * List all loyalty points activity for a customer
-     *
-     * @param pathParams - Path parameters
-     * @returns Promise with loyalty points activity
-     */
-    async listLoyaltyPointsActivity(pathParams) {
-        return this.executeRequest(() => this.client.GET("/customers/{user_id}/loyalty-points-activity", {
-            params: {
-                path: pathParams,
-            },
-        }));
-    }
-    /**
-     * List all reviews left by a customer
-     *
-     * @param pathParams - Path parameters
-     * @returns Promise with reviews
-     */
-    async listCustomerReviews(pathParams) {
-        return this.executeRequest(() => this.client.GET("/customers/{user_id}/reviews", {
-            params: {
-                path: pathParams,
-            },
-        }));
-    }
-}

package/dist/lib/header-utils.d.ts

@@ -1,26 +0,0 @@
-import type { SupportedDefaultHeaders } from "../index";
-/**
- * Transform SDK header parameters to actual HTTP header names
- * Headers not in the transformation map are passed through unchanged
- *
- * @param headers - Headers object with SDK parameter names
- * @returns Headers object with actual HTTP header names
- */
-export declare function transformHeaders(headers: SupportedDefaultHeaders): Record<string, string>;
-/**
- * Merge default headers with method-level headers
- * Method-level headers take precedence over default headers
- * Automatically transforms SDK parameter names to HTTP header names
- *
- * @param defaultHeaders - Default headers from SDK configuration
- * @param methodHeaders - Headers passed to the specific method call
- * @returns Merged headers object with proper HTTP header names
- */
-export declare function mergeHeaders<T extends Record<string, any> = Record<string, any>>(defaultHeaders?: SupportedDefaultHeaders, methodHeaders?: T): T;
-/**
- * Get the list of supported header transformations
- * Useful for debugging or documentation purposes
- *
- * @returns Copy of the header transformations mapping
- */
-export declare function getHeaderTransformations(): Record<string, string>;