@takeal/cusfront-sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,149 @@
+import { T as TokenStore, F as FetchLike } from './http-BkZZZI8K.cjs';
+export { d as defaultBrowserStore, i as inMemoryStore } from './http-BkZZZI8K.cjs';
+import { AuthResource } from './resources/auth.cjs';
+import { DepositsResource } from './resources/deposits.cjs';
+export { CreateDepositRefundInput, CreateQuoteInput, Deposit, DepositMethod, DepositStatus, FundingQuote, InitiateDepositInput, Refund } from './resources/deposits.cjs';
+import { CardsResource } from './resources/cards.cjs';
+export { Card, CardBalance, CardStatus, CardType, CreateCardInput, RevealCardInput, RevealedCard } from './resources/cards.cjs';
+import { BalanceResource } from './resources/balance.cjs';
+export { Balance } from './resources/balance.cjs';
+import { BrandingResource } from './resources/branding.cjs';
+export { Branding } from './resources/branding.cjs';
+import { BlogResource } from './resources/blog.cjs';
+export { BlogBlock, BlogList, BlogListInput, BlogPost } from './resources/blog.cjs';
+import { SubscriptionsResource } from './resources/subscriptions.cjs';
+export { BroadcastChannel, Subscriptions } from './resources/subscriptions.cjs';
+export { A as Address, C as CustomerInfo } from './customer-CoxPwe5o.cjs';
+
+/**
+ * Brand config — runtime-passed, not build-time-baked.
+ *
+ * Whitelabel customers swap brand without forking the SDK. The SDK
+ * exposes `client.brand` for the UI layer to read; nothing else inside
+ * the SDK depends on the brand.
+ *
+ * Optional. When omitted, `client.brand` is `undefined` and the
+ * consumer is expected to render its own brand surface independently.
+ */
+interface BrandConfig {
+    /** Display name shown in headers / titles / footer. */
+    name: string;
+    /** Absolute or root-relative URL to a logo asset. */
+    logoUrl?: string;
+    /** CSS colour token consumed by the Cusfront's theme provider.
+     *  Hex, rgb(), or any CSS-valid colour string. */
+    primaryColor?: string;
+    /** Deep link to a support channel (Telegram, email, etc.). When set
+     *  the Cusfront's footer renders a "Need help?" link. */
+    supportUrl?: string;
+    /** Label for the end-user's balance ("Wallet", "Acme Wallet").
+     *  Build-time fallback; `client.branding.get()` returns the live value. */
+    walletLabel?: string;
+}
+
+/**
+ * Errors surfaced by the SDK. All HTTP failures map onto `ApiError`;
+ * network-level / abort / serialisation failures get the generic
+ * `NetworkError`. Consumers catch on the discriminator field
+ * (`isApiError` / `isNetworkError`) rather than `instanceof` — works
+ * across bundler boundaries where multiple copies of the class can
+ * coexist.
+ */
+declare class ApiError extends Error {
+    /** HTTP status code returned by the Takeal API. */
+    readonly status: number;
+    /** Stable machine-readable code (e.g. `"insufficient_funds"`,
+     *  `"permission_required"`, `"validation"`). Same enum the
+     *  TypeScript types pin via openapi-typescript. */
+    readonly code: string;
+    /** Full parsed response body when available. Carries field-level
+     *  validation details for `code = "validation"`. */
+    readonly body?: unknown | undefined;
+    readonly isApiError: true;
+    constructor(
+    /** HTTP status code returned by the Takeal API. */
+    status: number, 
+    /** Stable machine-readable code (e.g. `"insufficient_funds"`,
+     *  `"permission_required"`, `"validation"`). Same enum the
+     *  TypeScript types pin via openapi-typescript. */
+    code: string, 
+    /** Human-readable message. English; the consumer maps to its
+     *  own i18n layer before showing to end-users. */
+    message: string, 
+    /** Full parsed response body when available. Carries field-level
+     *  validation details for `code = "validation"`. */
+    body?: unknown | undefined);
+}
+declare class NetworkError extends Error {
+    readonly cause?: unknown | undefined;
+    readonly isNetworkError: true;
+    constructor(message: string, cause?: unknown | undefined);
+}
+/** Type guard — preferred over `instanceof` (bundler-safe). */
+declare function isApiError(e: unknown): e is ApiError;
+declare function isNetworkError(e: unknown): e is NetworkError;
+
+/**
+ * `@takeal/cusfront-sdk` — typed client for the Takeal end-user API.
+ *
+ * Entry point: `createClient({ baseUrl, brand?, tokenStore?, fetch? })`.
+ * Resources are accessed off the returned client (`client.auth.login`,
+ * `client.cards.list`, …). Sub-exports under `@takeal/cusfront-sdk/<resource>`
+ * publish each resource independently so a Cusfront only pulls what
+ * it imports.
+ *
+ * Brand-neutral by design. No customer / deployment names embedded.
+ * Brand swap happens at runtime via `BrandConfig`.
+ */
+
+interface CreateClientOptions {
+    /** Absolute origin of the Takeal API deployment, no trailing slash.
+     *  e.g. `"https://api.takeal.example.com"`. */
+    baseUrl: string;
+    /** Runtime brand config. Optional; consumer renders its own brand
+     *  if omitted. */
+    brand?: BrandConfig;
+    /** Token persistence. Defaults to `defaultBrowserStore()` when
+     *  `window.localStorage` is present, else `inMemoryStore()`. */
+    tokenStore?: TokenStore;
+    /** Override the `fetch` implementation — useful for Node < 18,
+     *  React Native < 0.74, MSW intercept layers, etc. */
+    fetch?: FetchLike;
+    /** When true, the SDK runs every response through a zod schema
+     *  before handing it to the caller. Requires `zod` >= 3.22 as a
+     *  peer dep. Off by default; types-only validation is sufficient
+     *  for the steady-state case. */
+    validate?: boolean;
+}
+interface CusfrontClient {
+    /** Read-only brand config — pass through from createClient args. */
+    readonly brand: BrandConfig | undefined;
+    /** Auth resource: login, refresh, current user, logout. */
+    readonly auth: AuthResource;
+    /** Deposits (money IN via a funder connector): initiate, get, list, refund. */
+    readonly deposits: DepositsResource;
+    /** Cards (money OUT via an issuer connector): create, get, list, balance. */
+    readonly cards: CardsResource;
+    /** Wallet balance lookup, per currency. */
+    readonly balance: BalanceResource;
+    /** Runtime white-label config (`GET /branding`, public): names, logo, wallet label. */
+    readonly branding: BrandingResource;
+    /** Public blog posts, returned as structured blocks to render in your own style. */
+    readonly blog: BlogResource;
+    /** The user's announcement channel subscriptions. */
+    readonly subscriptions: SubscriptionsResource;
+    /** Direct access to the token store (e.g. for an explicit sign-out
+     *  on Capacitor's lifecycle "app pausing" event). */
+    readonly tokens: TokenStore;
+}
+/**
+ * Build a new client. Stateless across calls — multiple clients can
+ * coexist (e.g. an admin Cusfront with a different baseUrl than the
+ * end-user one). Each gets its own `TokenStore`.
+ *
+ * `validate: true` is honoured by individual resources that ship
+ * matching zod schemas; resources without a schema ignore it.
+ */
+declare function createClient(opts: CreateClientOptions): CusfrontClient;
+
+export { ApiError, type BrandConfig, type CreateClientOptions, type CusfrontClient, NetworkError, TokenStore, createClient, isApiError, isNetworkError };

package/dist/index.d.ts

@@ -0,0 +1,149 @@
+import { T as TokenStore, F as FetchLike } from './http-BkZZZI8K.js';
+export { d as defaultBrowserStore, i as inMemoryStore } from './http-BkZZZI8K.js';
+import { AuthResource } from './resources/auth.js';
+import { DepositsResource } from './resources/deposits.js';
+export { CreateDepositRefundInput, CreateQuoteInput, Deposit, DepositMethod, DepositStatus, FundingQuote, InitiateDepositInput, Refund } from './resources/deposits.js';
+import { CardsResource } from './resources/cards.js';
+export { Card, CardBalance, CardStatus, CardType, CreateCardInput, RevealCardInput, RevealedCard } from './resources/cards.js';
+import { BalanceResource } from './resources/balance.js';
+export { Balance } from './resources/balance.js';
+import { BrandingResource } from './resources/branding.js';
+export { Branding } from './resources/branding.js';
+import { BlogResource } from './resources/blog.js';
+export { BlogBlock, BlogList, BlogListInput, BlogPost } from './resources/blog.js';
+import { SubscriptionsResource } from './resources/subscriptions.js';
+export { BroadcastChannel, Subscriptions } from './resources/subscriptions.js';
+export { A as Address, C as CustomerInfo } from './customer-CoxPwe5o.js';
+
+/**
+ * Brand config — runtime-passed, not build-time-baked.
+ *
+ * Whitelabel customers swap brand without forking the SDK. The SDK
+ * exposes `client.brand` for the UI layer to read; nothing else inside
+ * the SDK depends on the brand.
+ *
+ * Optional. When omitted, `client.brand` is `undefined` and the
+ * consumer is expected to render its own brand surface independently.
+ */
+interface BrandConfig {
+    /** Display name shown in headers / titles / footer. */
+    name: string;
+    /** Absolute or root-relative URL to a logo asset. */
+    logoUrl?: string;
+    /** CSS colour token consumed by the Cusfront's theme provider.
+     *  Hex, rgb(), or any CSS-valid colour string. */
+    primaryColor?: string;
+    /** Deep link to a support channel (Telegram, email, etc.). When set
+     *  the Cusfront's footer renders a "Need help?" link. */
+    supportUrl?: string;
+    /** Label for the end-user's balance ("Wallet", "Acme Wallet").
+     *  Build-time fallback; `client.branding.get()` returns the live value. */
+    walletLabel?: string;
+}
+
+/**
+ * Errors surfaced by the SDK. All HTTP failures map onto `ApiError`;
+ * network-level / abort / serialisation failures get the generic
+ * `NetworkError`. Consumers catch on the discriminator field
+ * (`isApiError` / `isNetworkError`) rather than `instanceof` — works
+ * across bundler boundaries where multiple copies of the class can
+ * coexist.
+ */
+declare class ApiError extends Error {
+    /** HTTP status code returned by the Takeal API. */
+    readonly status: number;
+    /** Stable machine-readable code (e.g. `"insufficient_funds"`,
+     *  `"permission_required"`, `"validation"`). Same enum the
+     *  TypeScript types pin via openapi-typescript. */
+    readonly code: string;
+    /** Full parsed response body when available. Carries field-level
+     *  validation details for `code = "validation"`. */
+    readonly body?: unknown | undefined;
+    readonly isApiError: true;
+    constructor(
+    /** HTTP status code returned by the Takeal API. */
+    status: number, 
+    /** Stable machine-readable code (e.g. `"insufficient_funds"`,
+     *  `"permission_required"`, `"validation"`). Same enum the
+     *  TypeScript types pin via openapi-typescript. */
+    code: string, 
+    /** Human-readable message. English; the consumer maps to its
+     *  own i18n layer before showing to end-users. */
+    message: string, 
+    /** Full parsed response body when available. Carries field-level
+     *  validation details for `code = "validation"`. */
+    body?: unknown | undefined);
+}
+declare class NetworkError extends Error {
+    readonly cause?: unknown | undefined;
+    readonly isNetworkError: true;
+    constructor(message: string, cause?: unknown | undefined);
+}
+/** Type guard — preferred over `instanceof` (bundler-safe). */
+declare function isApiError(e: unknown): e is ApiError;
+declare function isNetworkError(e: unknown): e is NetworkError;
+
+/**
+ * `@takeal/cusfront-sdk` — typed client for the Takeal end-user API.
+ *
+ * Entry point: `createClient({ baseUrl, brand?, tokenStore?, fetch? })`.
+ * Resources are accessed off the returned client (`client.auth.login`,
+ * `client.cards.list`, …). Sub-exports under `@takeal/cusfront-sdk/<resource>`
+ * publish each resource independently so a Cusfront only pulls what
+ * it imports.
+ *
+ * Brand-neutral by design. No customer / deployment names embedded.
+ * Brand swap happens at runtime via `BrandConfig`.
+ */
+
+interface CreateClientOptions {
+    /** Absolute origin of the Takeal API deployment, no trailing slash.
+     *  e.g. `"https://api.takeal.example.com"`. */
+    baseUrl: string;
+    /** Runtime brand config. Optional; consumer renders its own brand
+     *  if omitted. */
+    brand?: BrandConfig;
+    /** Token persistence. Defaults to `defaultBrowserStore()` when
+     *  `window.localStorage` is present, else `inMemoryStore()`. */
+    tokenStore?: TokenStore;
+    /** Override the `fetch` implementation — useful for Node < 18,
+     *  React Native < 0.74, MSW intercept layers, etc. */
+    fetch?: FetchLike;
+    /** When true, the SDK runs every response through a zod schema
+     *  before handing it to the caller. Requires `zod` >= 3.22 as a
+     *  peer dep. Off by default; types-only validation is sufficient
+     *  for the steady-state case. */
+    validate?: boolean;
+}
+interface CusfrontClient {
+    /** Read-only brand config — pass through from createClient args. */
+    readonly brand: BrandConfig | undefined;
+    /** Auth resource: login, refresh, current user, logout. */
+    readonly auth: AuthResource;
+    /** Deposits (money IN via a funder connector): initiate, get, list, refund. */
+    readonly deposits: DepositsResource;
+    /** Cards (money OUT via an issuer connector): create, get, list, balance. */
+    readonly cards: CardsResource;
+    /** Wallet balance lookup, per currency. */
+    readonly balance: BalanceResource;
+    /** Runtime white-label config (`GET /branding`, public): names, logo, wallet label. */
+    readonly branding: BrandingResource;
+    /** Public blog posts, returned as structured blocks to render in your own style. */
+    readonly blog: BlogResource;
+    /** The user's announcement channel subscriptions. */
+    readonly subscriptions: SubscriptionsResource;
+    /** Direct access to the token store (e.g. for an explicit sign-out
+     *  on Capacitor's lifecycle "app pausing" event). */
+    readonly tokens: TokenStore;
+}
+/**
+ * Build a new client. Stateless across calls — multiple clients can
+ * coexist (e.g. an admin Cusfront with a different baseUrl than the
+ * end-user one). Each gets its own `TokenStore`.
+ *
+ * `validate: true` is honoured by individual resources that ship
+ * matching zod schemas; resources without a schema ignore it.
+ */
+declare function createClient(opts: CreateClientOptions): CusfrontClient;
+
+export { ApiError, type BrandConfig, type CreateClientOptions, type CusfrontClient, NetworkError, TokenStore, createClient, isApiError, isNetworkError };