@cimplify/sdk 0.3.5 → 0.3.6

package/dist/index.d.mts

@@ -796,22 +796,6 @@ interface SearchOptions {
     limit?: number;
     category?: string;
 }
-/**
- * Catalogue queries with explicit error handling via Result type.
- *
- * All methods return `Result<T, CimplifyError>` - no exceptions thrown.
- *
- * @example
- * ```typescript
- * const result = await client.catalogue.getProducts({ category: "burgers" });
- *
- * if (result.ok) {
- *   console.log("Products:", result.value);
- * } else {
- *   console.error("Failed:", result.error.code);
- * }
- * ```
- */
 declare class CatalogueQueries {
     private client;
     constructor(client: CimplifyClient);
@@ -1333,59 +1317,15 @@ interface CartSummary {
     currency: string;
 }
 
-/**
- * Cart operations with explicit error handling via Result type.
- *
- * All methods return `Result<T, CimplifyError>` - no exceptions thrown.
- *
- * @example
- * ```typescript
- * const result = await client.cart.addItem({ item_id: "prod_123" });
- *
- * if (result.ok) {
- *   console.log("Added!", result.value);
- * } else {
- *   console.error("Failed:", result.error.code);
- * }
- * ```
- */
 declare class CartOperations {
     private client;
     constructor(client: CimplifyClient);
-    /**
-     * Get the enriched cart with product names, images, and details.
-     * This is the main method for storefront display.
-     */
     get(): Promise<Result<UICart, CimplifyError>>;
     getRaw(): Promise<Result<Cart, CimplifyError>>;
     getItems(): Promise<Result<CartItem[], CimplifyError>>;
     getCount(): Promise<Result<number, CimplifyError>>;
     getTotal(): Promise<Result<string, CimplifyError>>;
     getSummary(): Promise<Result<CartSummary, CimplifyError>>;
-    /**
-     * Add an item to the cart.
-     *
-     * @example
-     * ```typescript
-     * const result = await client.cart.addItem({
-     *   item_id: "prod_burger",
-     *   quantity: 2,
-     *   variant_id: "var_large",
-     *   add_on_options: ["addon_cheese", "addon_bacon"],
-     * });
-     *
-     * if (!result.ok) {
-     *   switch (result.error.code) {
-     *     case ErrorCode.ITEM_UNAVAILABLE:
-     *       toast.error("Item no longer available");
-     *       break;
-     *     case ErrorCode.VARIANT_OUT_OF_STOCK:
-     *       toast.error("Selected option is out of stock");
-     *       break;
-     *   }
-     * }
-     * ```
-     */
     addItem(input: AddToCartInput): Promise<Result<Cart, CimplifyError>>;
     updateItem(cartItemId: string, updates: UpdateCartItemInput): Promise<Result<Cart, CimplifyError>>;
     updateQuantity(cartItemId: string, quantity: number): Promise<Result<Cart, CimplifyError>>;
@@ -2064,64 +2004,10 @@ interface CheckoutResult {
     public_key?: string;
 }
 
-/**
- * Generate a cryptographically secure idempotency key.
- * Uses crypto.randomUUID if available, falls back to timestamp + random.
- */
 declare function generateIdempotencyKey(): string;
-/**
- * Checkout service with explicit error handling via Result type.
- *
- * All methods return `Result<T, CimplifyError>` - no exceptions thrown.
- *
- * @example
- * ```typescript
- * const result = await client.checkout.process(formData);
- *
- * if (result.ok) {
- *   const checkout = result.value;
- *   if (checkout.requires_authorization) {
- *     // Handle OTP flow
- *   } else if (checkout.client_secret) {
- *     // Open Paystack popup
- *   }
- * } else {
- *   toast.error(result.error.message);
- * }
- * ```
- */
 declare class CheckoutService {
     private client;
     constructor(client: CimplifyClient);
-    /**
-     * Process checkout with cart data.
-     *
-     * Automatically generates an idempotency key if not provided to ensure
-     * payment safety. The same key is used across retries, preventing
-     * duplicate charges if a network error occurs after payment processing.
-     *
-     * @example
-     * ```typescript
-     * const result = await client.checkout.process({
-     *   cart_id: cart.id,
-     *   customer: { name, email, phone, save_details: true },
-     *   order_type: "pickup",
-     *   payment_method: "mobile_money",
-     *   mobile_money_details: { phone_number, provider: "mtn" },
-     * });
-     *
-     * if (!result.ok) {
-     *   switch (result.error.code) {
-     *     case ErrorCode.CART_EMPTY:
-     *       toast.error("Your cart is empty");
-     *       break;
-     *     case ErrorCode.PAYMENT_FAILED:
-     *       toast.error("Payment failed. Please try again.");
-     *       break;
-     *   }
-     * }
-     * ```
-     */
     process(data: CheckoutFormData): Promise<Result<CheckoutResult, CimplifyError>>;
     initializePayment(orderId: string, method: PaymentMethod): Promise<Result<InitializePaymentResult, CimplifyError>>;
     submitAuthorization(input: SubmitAuthorizationInput): Promise<Result<CheckoutResult, CimplifyError>>;
@@ -2228,24 +2114,6 @@ interface ChangePasswordInput {
 interface SuccessResult$1 {
     success: boolean;
 }
-/**
- * Auth service with explicit error handling via Result type.
- *
- * All methods return `Result<T, CimplifyError>` - no exceptions thrown.
- *
- * @example
- * ```typescript
- * const result = await client.auth.verifyOtp("123456");
- *
- * if (result.ok) {
- *   console.log("Logged in as:", result.value.customer.name);
- * } else {
- *   if (result.error.code === "INVALID_OTP") {
- *     toast.error("Invalid code. Please try again.");
- *   }
- * }
- * ```
- */
 declare class AuthService {
     private client;
     constructor(client: CimplifyClient);
@@ -2944,7 +2812,6 @@ declare class CimplifyClient {
     private maxRetries;
     private retryDelay;
     private hooks;
-    /** In-flight request deduplication map */
     private inflightRequests;
     private _catalogue?;
     private _cart?;
@@ -2964,30 +2831,10 @@ declare class CimplifyClient {
     private saveSessionToken;
     private getHeaders;
     private updateSessionFromResponse;
-    /**
-     * Resilient fetch with timeout, automatic retries, and observability hooks.
-     * Uses exponential backoff: 1s, 2s, 4s between retries.
-     */
     private resilientFetch;
-    /**
-     * Generate a deduplication key for a request.
-     * Same query + variables = same key = deduplicated.
-     */
     private getDedupeKey;
-    /**
-     * Execute a request with deduplication.
-     * If an identical request is already in-flight, return the same promise.
-     * This prevents redundant network calls when multiple components request the same data.
-     */
     private deduplicatedRequest;
-    /**
-     * Execute a query with deduplication.
-     * Multiple identical queries made simultaneously will share a single network request.
-     */
     query<T = unknown>(query: string, variables?: Record<string, unknown>): Promise<T>;
-    /**
-     * Execute a mutation. NOT deduplicated - mutations have side effects.
-     */
     call<T = unknown>(method: string, args?: unknown): Promise<T>;
     get<T = unknown>(path: string): Promise<T>;
     post<T = unknown>(path: string, body?: unknown): Promise<T>;

package/dist/index.d.ts

@@ -796,22 +796,6 @@ interface SearchOptions {
     limit?: number;
     category?: string;
 }
-/**
- * Catalogue queries with explicit error handling via Result type.
- *
- * All methods return `Result<T, CimplifyError>` - no exceptions thrown.
- *
- * @example
- * ```typescript
- * const result = await client.catalogue.getProducts({ category: "burgers" });
- *
- * if (result.ok) {
- *   console.log("Products:", result.value);
- * } else {
- *   console.error("Failed:", result.error.code);
- * }
- * ```
- */
 declare class CatalogueQueries {
     private client;
     constructor(client: CimplifyClient);
@@ -1333,59 +1317,15 @@ interface CartSummary {
     currency: string;
 }
 
-/**
- * Cart operations with explicit error handling via Result type.
- *
- * All methods return `Result<T, CimplifyError>` - no exceptions thrown.
- *
- * @example
- * ```typescript
- * const result = await client.cart.addItem({ item_id: "prod_123" });
- *
- * if (result.ok) {
- *   console.log("Added!", result.value);
- * } else {
- *   console.error("Failed:", result.error.code);
- * }
- * ```
- */
 declare class CartOperations {
     private client;
     constructor(client: CimplifyClient);
-    /**
-     * Get the enriched cart with product names, images, and details.
-     * This is the main method for storefront display.
-     */
     get(): Promise<Result<UICart, CimplifyError>>;
     getRaw(): Promise<Result<Cart, CimplifyError>>;
     getItems(): Promise<Result<CartItem[], CimplifyError>>;
     getCount(): Promise<Result<number, CimplifyError>>;
     getTotal(): Promise<Result<string, CimplifyError>>;
     getSummary(): Promise<Result<CartSummary, CimplifyError>>;
-    /**
-     * Add an item to the cart.
-     *
-     * @example
-     * ```typescript
-     * const result = await client.cart.addItem({
-     *   item_id: "prod_burger",
-     *   quantity: 2,
-     *   variant_id: "var_large",
-     *   add_on_options: ["addon_cheese", "addon_bacon"],
-     * });
-     *
-     * if (!result.ok) {
-     *   switch (result.error.code) {
-     *     case ErrorCode.ITEM_UNAVAILABLE:
-     *       toast.error("Item no longer available");
-     *       break;
-     *     case ErrorCode.VARIANT_OUT_OF_STOCK:
-     *       toast.error("Selected option is out of stock");
-     *       break;
-     *   }
-     * }
-     * ```
-     */
     addItem(input: AddToCartInput): Promise<Result<Cart, CimplifyError>>;
     updateItem(cartItemId: string, updates: UpdateCartItemInput): Promise<Result<Cart, CimplifyError>>;
     updateQuantity(cartItemId: string, quantity: number): Promise<Result<Cart, CimplifyError>>;
@@ -2064,64 +2004,10 @@ interface CheckoutResult {
     public_key?: string;
 }
 
-/**
- * Generate a cryptographically secure idempotency key.
- * Uses crypto.randomUUID if available, falls back to timestamp + random.
- */
 declare function generateIdempotencyKey(): string;
-/**
- * Checkout service with explicit error handling via Result type.
- *
- * All methods return `Result<T, CimplifyError>` - no exceptions thrown.
- *
- * @example
- * ```typescript
- * const result = await client.checkout.process(formData);
- *
- * if (result.ok) {
- *   const checkout = result.value;
- *   if (checkout.requires_authorization) {
- *     // Handle OTP flow
- *   } else if (checkout.client_secret) {
- *     // Open Paystack popup
- *   }
- * } else {
- *   toast.error(result.error.message);
- * }
- * ```
- */
 declare class CheckoutService {
     private client;
     constructor(client: CimplifyClient);
-    /**
-     * Process checkout with cart data.
-     *
-     * Automatically generates an idempotency key if not provided to ensure
-     * payment safety. The same key is used across retries, preventing
-     * duplicate charges if a network error occurs after payment processing.
-     *
-     * @example
-     * ```typescript
-     * const result = await client.checkout.process({
-     *   cart_id: cart.id,
-     *   customer: { name, email, phone, save_details: true },
-     *   order_type: "pickup",
-     *   payment_method: "mobile_money",
-     *   mobile_money_details: { phone_number, provider: "mtn" },
-     * });
-     *
-     * if (!result.ok) {
-     *   switch (result.error.code) {
-     *     case ErrorCode.CART_EMPTY:
-     *       toast.error("Your cart is empty");
-     *       break;
-     *     case ErrorCode.PAYMENT_FAILED:
-     *       toast.error("Payment failed. Please try again.");
-     *       break;
-     *   }
-     * }
-     * ```
-     */
     process(data: CheckoutFormData): Promise<Result<CheckoutResult, CimplifyError>>;
     initializePayment(orderId: string, method: PaymentMethod): Promise<Result<InitializePaymentResult, CimplifyError>>;
     submitAuthorization(input: SubmitAuthorizationInput): Promise<Result<CheckoutResult, CimplifyError>>;
@@ -2228,24 +2114,6 @@ interface ChangePasswordInput {
 interface SuccessResult$1 {
     success: boolean;
 }
-/**
- * Auth service with explicit error handling via Result type.
- *
- * All methods return `Result<T, CimplifyError>` - no exceptions thrown.
- *
- * @example
- * ```typescript
- * const result = await client.auth.verifyOtp("123456");
- *
- * if (result.ok) {
- *   console.log("Logged in as:", result.value.customer.name);
- * } else {
- *   if (result.error.code === "INVALID_OTP") {
- *     toast.error("Invalid code. Please try again.");
- *   }
- * }
- * ```
- */
 declare class AuthService {
     private client;
     constructor(client: CimplifyClient);
@@ -2944,7 +2812,6 @@ declare class CimplifyClient {
     private maxRetries;
     private retryDelay;
     private hooks;
-    /** In-flight request deduplication map */
     private inflightRequests;
     private _catalogue?;
     private _cart?;
@@ -2964,30 +2831,10 @@ declare class CimplifyClient {
     private saveSessionToken;
     private getHeaders;
     private updateSessionFromResponse;
-    /**
-     * Resilient fetch with timeout, automatic retries, and observability hooks.
-     * Uses exponential backoff: 1s, 2s, 4s between retries.
-     */
     private resilientFetch;
-    /**
-     * Generate a deduplication key for a request.
-     * Same query + variables = same key = deduplicated.
-     */
     private getDedupeKey;
-    /**
-     * Execute a request with deduplication.
-     * If an identical request is already in-flight, return the same promise.
-     * This prevents redundant network calls when multiple components request the same data.
-     */
     private deduplicatedRequest;
-    /**
-     * Execute a query with deduplication.
-     * Multiple identical queries made simultaneously will share a single network request.
-     */
     query<T = unknown>(query: string, variables?: Record<string, unknown>): Promise<T>;
-    /**
-     * Execute a mutation. NOT deduplicated - mutations have side effects.
-     */
     call<T = unknown>(method: string, args?: unknown): Promise<T>;
     get<T = unknown>(path: string): Promise<T>;
     post<T = unknown>(path: string, body?: unknown): Promise<T>;