@artu-ai/compliance-sdk 0.0.6 → 0.3.0

package/dist/resources/bank-accounts.d.ts

@@ -0,0 +1,174 @@
+/**
+ * Bank Accounts Resource
+ *
+ * Manages bank account information for clients.
+ *
+ * This is the base (unscoped) resource. For jurisdiction-scoped SDKs, use:
+ * - MexBankAccountsResource - Mexico-scoped with flattened CLABE fields
+ */
+import type { CreateBankAccountInput, UpdateBankAccountInput, BankAccountFilter, BankAccountSort, PaginatedResponse, ListOptions, AtomicBatchResult, PartialBatchResult, SyncItem, SyncResult } from "@artu-ai/shared";
+import { BaseResource } from "./base";
+import { BankAccount, type BankAccountData } from "../models/BankAccount";
+/**
+ * Base resource for managing client bank accounts.
+ *
+ * @example
+ * ```typescript
+ * // Create a bank account with full nested format
+ * const account = await sdk.bankAccounts.create("client_123", {
+ *   accountNumber: "1234567890",
+ *   bankName: "BBVA México",
+ *   type: BankAccountType.Checking,
+ *   currency: Currency.MXN,
+ *   jurisdictions: {
+ *     MX: {
+ *       clabe: "012345678901234567",
+ *     },
+ *   },
+ * });
+ *
+ * // List accounts for a client
+ * const accounts = await sdk.bankAccounts.list("client_123");
+ * ```
+ */
+export declare class BankAccountsResource<TSort = BankAccountSort> extends BaseResource<BankAccount, CreateBankAccountInput, UpdateBankAccountInput, BankAccountFilter, TSort> {
+    /**
+     * Creates a new bank account for a client.
+     *
+     * @param data - Bank account creation data (includes clientId)
+     * @returns The created bank account model
+     */
+    create(data: CreateBankAccountInput): Promise<BankAccount>;
+    /**
+     * Retrieves a bank account by ID.
+     */
+    retrieve(id: string): Promise<BankAccount>;
+    /**
+     * Retrieves a bank account by metadata key/value.
+     */
+    retrieveByMetadata(key: string, value: string): Promise<BankAccount>;
+    /**
+     * Retrieves a bank account by externalId.
+     */
+    retrieveByExternalId(externalId: string): Promise<BankAccount>;
+    /**
+     * Updates a bank account.
+     */
+    update(id: string, data: UpdateBankAccountInput): Promise<BankAccount>;
+    /**
+     * Deletes a bank account.
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * Lists bank accounts with optional filtering.
+     */
+    list(options?: ListOptions<BankAccountFilter, TSort>): Promise<PaginatedResponse<BankAccount>>;
+    /**
+     * Lists all bank accounts for a specific client.
+     */
+    listByClient(clientId: string, options?: {
+        cursor?: string;
+        limit?: number;
+    }): Promise<PaginatedResponse<BankAccount>>;
+    /**
+     * Returns an async iterator over all bank accounts matching the filter.
+     */
+    iterate(filter?: BankAccountFilter): AsyncGenerator<BankAccount, void, undefined>;
+    /**
+     * Gets the primary bank account for a client.
+     *
+     * @param clientId - The client ID
+     * @returns The primary bank account, or null if none is marked as primary
+     */
+    getPrimary(clientId: string): Promise<BankAccount | null>;
+    /**
+     * Sets a bank account as the primary account for a client.
+     */
+    setPrimary(id: string): Promise<BankAccount>;
+    /**
+     * Activates a bank account.
+     */
+    activate(id: string): Promise<BankAccount>;
+    /**
+     * Deactivates a bank account.
+     */
+    deactivate(id: string): Promise<BankAccount>;
+    /**
+     * Creates multiple bank accounts in a single request.
+     *
+     * @param accounts - Array of bank account creation data (each includes clientId)
+     * @param options - Batch options (atomic: true by default)
+     * @returns Atomic result with data array, or partial result with succeeded/failed
+     */
+    createMany(accounts: CreateBankAccountInput[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<BankAccount>>;
+    createMany(accounts: CreateBankAccountInput[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<BankAccount>>;
+    /**
+     * Updates multiple bank accounts in a single request.
+     *
+     * @param updates - Array of { id, data } updates
+     * @param options - Batch options (atomic: true by default)
+     * @returns Atomic result with data array, or partial result with succeeded/failed
+     */
+    updateMany(updates: {
+        id: string;
+        data: UpdateBankAccountInput;
+    }[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<BankAccount>>;
+    updateMany(updates: {
+        id: string;
+        data: UpdateBankAccountInput;
+    }[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<BankAccount>>;
+    /**
+     * Syncs bank accounts for a client - handles create, update, and delete in bulk.
+     *
+     * This is the most efficient way to reconcile a set of bank accounts for a client.
+     *
+     * @param clientId - The client ID
+     * @param items - Array of sync items:
+     *   - Without `id`: create new bank account
+     *   - With `id` and `_delete: true`: delete existing bank account
+     *   - With `id` (no `_delete`): update existing bank account
+     * @param options - Sync options
+     * @param options.replaceMode - When true, items not in the array are deleted (default: false)
+     * @returns Sync result with created, updated, and deleted arrays
+     *
+     * @example
+     * ```typescript
+     * // Patch mode (default) - only mentioned items are affected
+     * const result = await sdk.bankAccounts.sync("client_123", [
+     *   // Create new account (no id)
+     *   { accountNumber: "1234567890", bankName: "BBVA", country: "MX" },
+     *   // Update existing account (has id)
+     *   { id: "ba_456", bankName: "BBVA México" },
+     *   // Delete account (has id and _delete: true)
+     *   { id: "ba_789", _delete: true },
+     * ]);
+     *
+     * // Replace mode - provided array becomes the complete set (requires full create input for new items)
+     * const result = await sdk.bankAccounts.sync("client_123", accounts, { replaceMode: true });
+     *
+     * console.log(result.created);  // newly created accounts
+     * console.log(result.updated);  // updated accounts
+     * console.log(result.deleted);  // array of deleted IDs
+     * ```
+     */
+    sync(clientId: string, items: SyncItem<CreateBankAccountInput>[], options: {
+        replaceMode: true;
+    }): Promise<SyncResult<BankAccount>>;
+    sync(clientId: string, items: SyncItem<UpdateBankAccountInput>[], options?: {
+        replaceMode?: boolean;
+    }): Promise<SyncResult<BankAccount>>;
+    /**
+     * Instantiates a BankAccount model from API response data.
+     * Subclasses override this to return their specific model type.
+     */
+    protected instantiate(data: BankAccountData): BankAccount;
+}
+//# sourceMappingURL=bank-accounts.d.ts.map

package/dist/resources/bank-accounts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bank-accounts.d.ts","sourceRoot":"","sources":["../../src/resources/bank-accounts.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,OAAO,KAAK,EACV,sBAAsB,EACtB,sBAAsB,EACtB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,kBAAkB,EAClB,QAAQ,EACR,UAAU,EACX,MAAM,iBAAiB,CAAC;AAOzB,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAM1E;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,oBAAoB,CAC/B,KAAK,GAAG,eAAe,CACvB,SAAQ,YAAY,CACpB,WAAW,EACX,sBAAsB,EACtB,sBAAsB,EACtB,iBAAiB,EACjB,KAAK,CACN;IAKC;;;;;OAKG;IACG,MAAM,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC;IAUhE;;OAEG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAOhD;;OAEG;IACG,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAO1E;;OAEG;IACG,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAOpE;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC;IAS5E;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQvC;;OAEG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,WAAW,CAAC,iBAAiB,EAAE,KAAK,CAAC,GAC9C,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAW1C;;OAEG;IACG,YAAY,CAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAW1C;;OAEG;IACH,OAAO,CACL,MAAM,CAAC,EAAE,iBAAiB,GACzB,cAAc,CAAC,WAAW,EAAE,IAAI,EAAE,SAAS,CAAC;IAQ/C;;;;;OAKG;IACG,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAQ/D;;OAEG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAOlD;;OAEG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAOhD;;OAEG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAWlD;;;;;;OAMG;IACG,UAAU,CACd,QAAQ,EAAE,sBAAsB,EAAE,EAClC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IACpC,UAAU,CACd,QAAQ,EAAE,sBAAsB,EAAE,EAClC,OAAO,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GACzB,OAAO,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAgC3C;;;;;;OAMG;IACG,UAAU,CACd,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,sBAAsB,CAAA;KAAE,EAAE,EACvD,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IACpC,UAAU,CACd,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,sBAAsB,CAAA;KAAE,EAAE,EACvD,OAAO,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GACzB,OAAO,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAsC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,IAAI,CACR,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,EAAE,EACzC,OAAO,EAAE;QAAE,WAAW,EAAE,IAAI,CAAA;KAAE,GAC7B,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAC7B,IAAI,CACR,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,EAAE,EACzC,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAA;KAAE,GAClC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAmCnC;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,WAAW;CAG1D"}

package/dist/resources/bank-accounts.js

@@ -0,0 +1,220 @@
+/**
+ * Bank Accounts Resource
+ *
+ * Manages bank account information for clients.
+ *
+ * This is the base (unscoped) resource. For jurisdiction-scoped SDKs, use:
+ * - MexBankAccountsResource - Mexico-scoped with flattened CLABE fields
+ */
+import { z } from "zod";
+import { createBankAccountInputSchema, updateBankAccountInputSchema, replaceSyncItemSchema, } from "@artu-ai/shared";
+import { BaseResource } from "./base";
+import { BankAccount } from "../models/BankAccount";
+// ===========================
+// BankAccountsResource
+// ===========================
+/**
+ * Base resource for managing client bank accounts.
+ *
+ * @example
+ * ```typescript
+ * // Create a bank account with full nested format
+ * const account = await sdk.bankAccounts.create("client_123", {
+ *   accountNumber: "1234567890",
+ *   bankName: "BBVA México",
+ *   type: BankAccountType.Checking,
+ *   currency: Currency.MXN,
+ *   jurisdictions: {
+ *     MX: {
+ *       clabe: "012345678901234567",
+ *     },
+ *   },
+ * });
+ *
+ * // List accounts for a client
+ * const accounts = await sdk.bankAccounts.list("client_123");
+ * ```
+ */
+export class BankAccountsResource extends BaseResource {
+    // ─────────────────────────────────────────────────────────────────
+    // CRUD Operations
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Creates a new bank account for a client.
+     *
+     * @param data - Bank account creation data (includes clientId)
+     * @returns The created bank account model
+     */
+    async create(data) {
+        const validated = this.validate(createBankAccountInputSchema, data);
+        const response = await this.execute(() => this.trpc.bankAccounts.create.mutate(validated));
+        return this.instantiate(response);
+    }
+    /**
+     * Retrieves a bank account by ID.
+     */
+    async retrieve(id) {
+        const response = await this.execute(() => this.trpc.bankAccounts.retrieve.query({ id }));
+        return this.instantiate(response);
+    }
+    /**
+     * Retrieves a bank account by metadata key/value.
+     */
+    async retrieveByMetadata(key, value) {
+        const response = await this.execute(() => this.trpc.bankAccounts.retrieveByMetadata.query({ key, value }));
+        return this.instantiate(response);
+    }
+    /**
+     * Retrieves a bank account by externalId.
+     */
+    async retrieveByExternalId(externalId) {
+        const response = await this.execute(() => this.trpc.bankAccounts.retrieveByExternalId.query({ externalId }));
+        return this.instantiate(response);
+    }
+    /**
+     * Updates a bank account.
+     */
+    async update(id, data) {
+        const validated = this.validate(updateBankAccountInputSchema, data);
+        const response = await this.execute(() => this.trpc.bankAccounts.update.mutate({ id, data: validated }));
+        return this.instantiate(response);
+    }
+    /**
+     * Deletes a bank account.
+     */
+    async delete(id) {
+        await this.execute(() => this.trpc.bankAccounts.delete.mutate({ id }));
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // List & Pagination
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Lists bank accounts with optional filtering.
+     */
+    async list(options) {
+        const response = await this.execute(() => this.trpc.bankAccounts.list.query(options));
+        return {
+            data: response.data.map((a) => this.instantiate(a)),
+            pagination: response.pagination,
+        };
+    }
+    /**
+     * Lists all bank accounts for a specific client.
+     */
+    async listByClient(clientId, options) {
+        const response = await this.execute(() => this.trpc.bankAccounts.listByClient.query({ clientId, ...options }));
+        return {
+            data: response.data.map((a) => this.instantiate(a)),
+            pagination: response.pagination,
+        };
+    }
+    /**
+     * Returns an async iterator over all bank accounts matching the filter.
+     */
+    iterate(filter) {
+        return this.createIterator({ filter });
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Convenience Methods
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Gets the primary bank account for a client.
+     *
+     * @param clientId - The client ID
+     * @returns The primary bank account, or null if none is marked as primary
+     */
+    async getPrimary(clientId) {
+        const response = await this.execute(() => this.trpc.bankAccounts.getPrimary.query({ clientId }));
+        return response ? this.instantiate(response) : null;
+    }
+    /**
+     * Sets a bank account as the primary account for a client.
+     */
+    async setPrimary(id) {
+        const response = await this.execute(() => this.trpc.bankAccounts.update.mutate({ id, data: { isPrimary: true } }));
+        return this.instantiate(response);
+    }
+    /**
+     * Activates a bank account.
+     */
+    async activate(id) {
+        const response = await this.execute(() => this.trpc.bankAccounts.update.mutate({ id, data: { isActive: true } }));
+        return this.instantiate(response);
+    }
+    /**
+     * Deactivates a bank account.
+     */
+    async deactivate(id) {
+        const response = await this.execute(() => this.trpc.bankAccounts.update.mutate({ id, data: { isActive: false } }));
+        return this.instantiate(response);
+    }
+    async createMany(accounts, options = {}) {
+        const atomic = options.atomic ?? true;
+        const validated = this.validate(z.array(createBankAccountInputSchema), accounts);
+        const response = await this.execute(() => this.trpc.bankAccounts.createMany.mutate({ items: validated, atomic }));
+        if (response.atomic) {
+            return {
+                atomic: true,
+                data: response.data.map((a) => this.instantiate(a)),
+            };
+        }
+        else {
+            return {
+                atomic: false,
+                succeeded: response.succeeded.map((item) => ({
+                    index: item.index,
+                    data: this.instantiate(item.data),
+                })),
+                failed: response.failed,
+            };
+        }
+    }
+    async updateMany(updates, options = {}) {
+        const atomic = options.atomic ?? true;
+        const updateItemSchema = z.object({
+            id: z.uuid(),
+            data: updateBankAccountInputSchema,
+        });
+        const validated = this.validate(z.array(updateItemSchema), updates);
+        const response = await this.execute(() => this.trpc.bankAccounts.updateMany.mutate({ items: validated, atomic }));
+        if (response.atomic) {
+            return {
+                atomic: true,
+                data: response.data.map((a) => this.instantiate(a)),
+            };
+        }
+        else {
+            return {
+                atomic: false,
+                succeeded: response.succeeded.map((item) => ({
+                    index: item.index,
+                    data: this.instantiate(item.data),
+                })),
+                failed: response.failed,
+            };
+        }
+    }
+    async sync(clientId, items, options) {
+        const validated = this.validate(z.array(replaceSyncItemSchema(createBankAccountInputSchema, updateBankAccountInputSchema)), items);
+        const response = await this.execute(() => this.trpc.bankAccounts.sync.mutate({
+            clientId,
+            items: validated,
+            replaceMode: options?.replaceMode,
+        }));
+        return {
+            created: response.created.map((a) => this.instantiate(a)),
+            updated: response.updated.map((a) => this.instantiate(a)),
+            deleted: response.deleted,
+        };
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Instantiation (protected for subclasses to override)
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Instantiates a BankAccount model from API response data.
+     * Subclasses override this to return their specific model type.
+     */
+    instantiate(data) {
+        return new BankAccount(data);
+    }
+}

package/dist/resources/base.d.ts

@@ -0,0 +1,192 @@
+/**
+ * Base Resource Class
+ *
+ * Abstract base class for all resource managers.
+ * Provides common patterns: validation, error mapping, pagination.
+ */
+import type { ZodType } from "zod";
+import type { PaginatedResponse, ListOptions, IterateOptions } from "@artu-ai/shared";
+import { type CodigoActividad } from "@artu-ai/shared";
+import type { TRPCClient } from "../utils/trpc-client";
+import { type SDKScope, type Environment } from "../sdk/types";
+/**
+ * Configuration for creating a resource manager
+ */
+export interface ResourceConfig {
+    /**
+     * tRPC client instance for API communication
+     */
+    trpc: TRPCClient;
+    /**
+     * Optional SDK scope for jurisdiction/activity scoping
+     */
+    scope?: SDKScope;
+    /**
+     * SDK environment (test or live)
+     */
+    environment?: Environment;
+}
+/**
+ * Abstract base class for all resource managers.
+ *
+ * Provides:
+ * - Input validation with Zod schemas
+ * - Automatic error mapping from tRPC to SDK errors
+ * - Pagination iterator factory
+ *
+ * @typeParam TModel - The model type returned by this resource
+ * @typeParam TCreateInput - Input type for create operations
+ * @typeParam TUpdateInput - Input type for update operations
+ * @typeParam TFilter - Filter type for list operations
+ *
+ * @example
+ * ```typescript
+ * class ClientsResource extends BaseResource<
+ *   Client,
+ *   CreateClientInput,
+ *   UpdateClientInput,
+ *   ClientFilter
+ * > {
+ *   async create(data: CreateClientInput): Promise<Client> {
+ *     const validated = this.validate(createClientInputSchema, data);
+ *     return this.execute(() =>
+ *       this.trpc.clients.create.mutate(validated)
+ *     );
+ *   }
+ * }
+ * ```
+ */
+export declare abstract class BaseResource<TModel, TCreateInput, TUpdateInput, TFilter = Record<string, unknown>, TSort = unknown, TCreateResult = TModel> {
+    /**
+     * tRPC client for API communication
+     */
+    protected readonly trpc: TRPCClient;
+    /**
+     * SDK scope (jurisdiction and actividadVulnerable)
+     */
+    protected readonly scope: SDKScope;
+    constructor(config: ResourceConfig);
+    /**
+     * Whether this resource is scoped to a jurisdiction
+     */
+    protected get isScoped(): boolean;
+    /**
+     * Whether this resource is scoped to Mexico
+     */
+    protected get isMexicoScoped(): boolean;
+    /**
+     * Whether this resource is scoped to an Actividad Vulnerable activity
+     */
+    protected get isActivityScoped(): boolean;
+    /**
+     * Gets the actividadVulnerable code if scoped, undefined otherwise
+     */
+    protected get scopedActivity(): CodigoActividad | undefined;
+    /**
+     * Creates a new resource
+     * @param data - Creation data
+     * @returns The created model (or custom result type)
+     */
+    abstract create(data: TCreateInput): Promise<TCreateResult>;
+    /**
+     * Retrieves a resource by ID
+     * @param id - Resource ID
+     * @returns The retrieved model
+     */
+    abstract retrieve(id: string): Promise<TModel>;
+    /**
+     * Updates an existing resource
+     * @param id - Resource ID
+     * @param data - Update data
+     * @returns The updated model
+     */
+    abstract update(id: string, data: TUpdateInput): Promise<TModel>;
+    /**
+     * Deletes a resource by ID
+     * @param id - Resource ID
+     */
+    abstract delete(id: string): Promise<void>;
+    /**
+     * Lists resources with optional filtering and pagination
+     * @param options - List options
+     * @returns Paginated response
+     */
+    abstract list(options?: ListOptions<TFilter, TSort>): Promise<PaginatedResponse<TModel>>;
+    /**
+     * Validates input against a Zod schema.
+     * Throws ValidationError if validation fails.
+     *
+     * @param schema - Zod schema to validate against
+     * @param data - Data to validate
+     * @returns Validated and typed data
+     * @throws ValidationError if validation fails
+     *
+     * @example
+     * ```typescript
+     * const validated = this.validate(createClientSchema, data);
+     * // validated is now typed as CreateClientInput
+     * ```
+     */
+    protected validate<T>(schema: ZodType<T>, data: unknown): T;
+    /**
+     * Wraps a tRPC operation with error mapping.
+     * Converts tRPC errors to SDK-specific errors.
+     *
+     * @param operation - Async operation to execute
+     * @returns Result of the operation
+     * @throws SDK-specific error if operation fails
+     *
+     * @example
+     * ```typescript
+     * const result = await this.execute(() =>
+     *   this.trpc.clients.create.mutate(data)
+     * );
+     * ```
+     */
+    protected execute<T>(operation: () => Promise<T>): Promise<T>;
+    /**
+     * Creates an async iterator for paginated results.
+     * Automatically fetches subsequent pages as you iterate.
+     *
+     * @typeParam T - The model type to return (defaults to TModel, can be overridden by subclasses)
+     * @param options - Iterator options
+     * @returns Async generator yielding individual items
+     *
+     * @example
+     * ```typescript
+     * for await (const client of this.iterate({ filter: { type: "individual" } })) {
+     *   console.log(client.name);
+     * }
+     * ```
+     */
+    protected createIterator<T = TModel>(options?: IterateOptions<TFilter, TSort>): AsyncGenerator<T, void, undefined>;
+}
+/**
+ * Base class for read-only resources (no create/update/delete).
+ * Useful for resources that are managed elsewhere.
+ *
+ * @typeParam TModel - The model type returned by this resource
+ * @typeParam TFilter - Filter type for list operations
+ * @typeParam TSort - Sort type for list operations
+ */
+export declare abstract class ReadOnlyResource<TModel, TFilter = Record<string, unknown>, TSort = unknown> {
+    protected readonly trpc: TRPCClient;
+    constructor(config: ResourceConfig);
+    /**
+     * Retrieves a resource by ID
+     */
+    abstract retrieve(id: string): Promise<TModel>;
+    /**
+     * Lists resources with optional filtering and pagination
+     */
+    abstract list(options?: ListOptions<TFilter, TSort>): Promise<PaginatedResponse<TModel>>;
+    /**
+     * Wraps a tRPC operation with error mapping
+     */
+    protected execute<T>(operation: () => Promise<T>): Promise<T>;
+    /**
+     * Creates an async iterator for paginated results
+     */
+    protected createIterator<T = TModel>(options?: IterateOptions<TFilter, TSort>): AsyncGenerator<T, void, undefined>;
+}
+//# sourceMappingURL=base.d.ts.map

package/dist/resources/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/resources/base.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AAEnC,OAAO,KAAK,EACV,iBAAiB,EACjB,WAAW,EACX,cAAc,EACf,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAgB,KAAK,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACrE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAIvD,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAiB,MAAM,cAAc,CAAC;AAU9E;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAKD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,8BAAsB,YAAY,CAChC,MAAM,EACN,YAAY,EACZ,YAAY,EACZ,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,KAAK,GAAG,OAAO,EACf,aAAa,GAAG,MAAM;IAEtB;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAEpC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;gBAEvB,MAAM,EAAE,cAAc;IAKlC;;OAEG;IACH,SAAS,KAAK,QAAQ,IAAI,OAAO,CAEhC;IAED;;OAEG;IACH,SAAS,KAAK,cAAc,IAAI,OAAO,CAEtC;IAED;;OAEG;IACH,SAAS,KAAK,gBAAgB,IAAI,OAAO,CAIxC;IAED;;OAEG;IACH,SAAS,KAAK,cAAc,IAAI,eAAe,GAAG,SAAS,CAI1D;IAMD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC;IAE3D;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAE9C;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAEhE;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAE1C;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CACX,OAAO,CAAC,EAAE,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,GACpC,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAMrC;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,GAAG,CAAC;IAQ3D;;;;;;;;;;;;;;OAcG;cACa,OAAO,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAWnE;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,cAAc,CAAC,CAAC,GAAG,MAAM,EACjC,OAAO,CAAC,EAAE,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,GACvC,cAAc,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC;CAWtC;AAMD;;;;;;;GAOG;AACH,8BAAsB,gBAAgB,CACpC,MAAM,EACN,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,KAAK,GAAG,OAAO;IAEf,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;gBAExB,MAAM,EAAE,cAAc;IAIlC;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAE9C;;OAEG;IACH,QAAQ,CAAC,IAAI,CACX,OAAO,CAAC,EAAE,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,GACpC,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAErC;;OAEG;cACa,OAAO,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAWnE;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,CAAC,GAAG,MAAM,EACjC,OAAO,CAAC,EAAE,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,GACvC,cAAc,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC;CAWtC"}