@dossier-wiki/cloud-sdk 0.1.0 → 0.2.0-staging.3dda5e6

package/dist/types/resources/kyc/workflows.d.ts

@@ -0,0 +1,135 @@
+import type { DossiersHttp } from '../../http.js';
+import type { CreateKycWorkflowInput, KycWorkflow, UpdateKycWorkflowInput, WorkflowStepDefault } from '../../api.js';
+/**
+ * KYC workflow management — define the ordered steps customers go through
+ * during a verification session.
+ *
+ * Access via `service.kyc.workflows`.
+ *
+ * A workflow is a reusable template of verification steps (e.g. identity
+ * verification → liveness → form collection). Each step has a type, routing
+ * rules, and an optional config that controls its behavior. When creating a
+ * session, you reference a workflow ID to apply that step sequence.
+ *
+ * Use {@link stepDefaults} to fetch pre-built step configurations for each
+ * step type before building your workflow.
+ *
+ * @example
+ * ```ts
+ * const defaults = await service.kyc.workflows.stepDefaults();
+ * const idStep = defaults.find(d => d.type === 'id_verification');
+ *
+ * const workflow = await service.kyc.workflows.create({
+ *   name: 'Standard KYC',
+ *   steps: [
+ *     {
+ *       stepId: idStep.defaultStepId,
+ *       type: 'id_verification',
+ *       input: idStep.defaultInput,
+ *       output: { schema: idStep.schema },
+ *       rules: idStep.defaultRules as WorkflowRules,
+ *       locales: idStep.defaultLocales,
+ *       skippable: idStep.skippable,
+ *     },
+ *   ],
+ * });
+ * ```
+ */
+export declare class KycWorkflowsResource {
+    private readonly http;
+    /** @internal */
+    constructor(http: DossiersHttp);
+    /**
+     * Create a new KYC workflow.
+     *
+     * Use the {@link schemas.CreateWorkflowSchema} Zod schema to validate your
+     * input before calling this method — it enforces the discriminated-union
+     * constraint on each step's `type` and `input.config`.
+     *
+     * @param input - Workflow name, description, and ordered array of steps.
+     * @returns The created workflow.
+     *
+     * @example
+     * ```ts
+     * import { schemas } from '@dossier-wiki/cloud-sdk';
+     *
+     * const parsed = schemas.CreateWorkflowSchema.parse(rawInput);
+     * const workflow = await service.kyc.workflows.create(parsed);
+     * ```
+     */
+    create(input: CreateKycWorkflowInput): Promise<KycWorkflow>;
+    /**
+     * List all KYC workflows available to your organization (own + public).
+     *
+     * @returns An array of workflows.
+     *
+     * @example
+     * ```ts
+     * const workflows = await service.kyc.workflows.list();
+     * workflows.forEach(wf => console.log(wf.id, wf.name, wf.version));
+     * ```
+     */
+    list(): Promise<KycWorkflow[]>;
+    /**
+     * Retrieve a single KYC workflow by ID.
+     *
+     * @param id - The workflow ID.
+     * @returns The full workflow including all steps.
+     *
+     * @example
+     * ```ts
+     * const wf = await service.kyc.workflows.get('wf_abc123');
+     * console.log(wf.steps.map(s => s.type));
+     * ```
+     */
+    get(id: string): Promise<KycWorkflow>;
+    /**
+     * Update an existing KYC workflow.
+     *
+     * Updating a workflow creates a new version — existing sessions referencing
+     * the old version are not affected.
+     *
+     * @param id - The workflow ID to update.
+     * @param input - Fields to update (all optional).
+     * @returns The updated workflow.
+     *
+     * @example
+     * ```ts
+     * const updated = await service.kyc.workflows.update('wf_abc123', {
+     *   name: 'Enhanced KYC v2',
+     * });
+     * console.log(updated.version); // incremented
+     * ```
+     */
+    update(id: string, input: UpdateKycWorkflowInput): Promise<KycWorkflow>;
+    /**
+     * Delete a KYC workflow.
+     *
+     * Only the owning organization can delete a workflow. Workflows referenced
+     * by active sessions cannot be deleted.
+     *
+     * @param id - The workflow ID to delete.
+     *
+     * @example
+     * ```ts
+     * await service.kyc.workflows.delete('wf_old123');
+     * ```
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * Get the default configuration for every available step type.
+     *
+     * Use this to bootstrap a new workflow — each default includes the step's
+     * suggested `input`, `rules`, `locales`, and output `schema`.
+     *
+     * @returns An array of step defaults, one per step type.
+     *
+     * @example
+     * ```ts
+     * const defaults = await service.kyc.workflows.stepDefaults();
+     * const livenessDefault = defaults.find(d => d.type === 'liveness');
+     * ```
+     */
+    stepDefaults(): Promise<WorkflowStepDefault[]>;
+}
+//# sourceMappingURL=workflows.d.ts.map

package/dist/types/resources/kyc/workflows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflows.d.ts","sourceRoot":"","sources":["../../../../src/resources/kyc/workflows.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EACR,sBAAsB,EACtB,WAAW,EACX,sBAAsB,EACtB,mBAAmB,EACtB,MAAM,cAAc,CAAC;AAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,oBAAoB;IAEjB,OAAO,CAAC,QAAQ,CAAC,IAAI;IADjC,gBAAgB;gBACa,IAAI,EAAE,YAAY;IAE/C;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI3D;;;;;;;;;;OAUG;IACH,IAAI,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAI9B;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIrC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC;IAIvE;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjC;;;;;;;;;;;;;OAaG;IACH,YAAY,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;CAGjD"}

package/dist/types/resources/media.d.ts

@@ -0,0 +1,56 @@
+import type { DossiersHttp } from '../http.js';
+/**
+ * Signed media file access.
+ *
+ * Access via `service.media`.
+ *
+ * Media tokens are short-lived signed URLs embedded in session results, document
+ * processing instances, and submission records. Pass the token to {@link get}
+ * to stream the original file bytes.
+ *
+ * @example
+ * ```ts
+ * // Extract a media token from a session step submission
+ * const token = session.result.steps[0].summary?.media[0]?.key;
+ * if (token) {
+ *   const res = await service.media.get(token);
+ *   const blob = await res.blob();
+ * }
+ * ```
+ */
+export declare class MediaResource {
+    private readonly http;
+    /** @internal */
+    constructor(http: DossiersHttp);
+    /**
+     * Fetch a signed media file by its storage token.
+     *
+     * Returns the raw `Response` so the caller can stream or buffer the binary
+     * payload — e.g. save to disk, pipe to an upload, or convert to a `Blob`.
+     *
+     * Tokens are single-use and expire after a short window. Fetch the token
+     * from a session result or document processing instance immediately before
+     * calling this method.
+     *
+     * @param token - The signed media token from a session or processing result.
+     * @param init - Optional fetch init options (e.g. `signal` for cancellation).
+     * @returns The raw `Response` with binary body.
+     *
+     * @example
+     * ```ts
+     * const res = await service.media.get(token);
+     * if (!res.ok) throw new Error(`Media fetch failed: ${res.status}`);
+     *
+     * // Save to disk (Node.js)
+     * const { Writable } = await import('stream');
+     * const dest = createWriteStream('./document-front.jpg');
+     * Readable.fromWeb(res.body!).pipe(dest);
+     *
+     * // Convert to Blob (browser)
+     * const blob = await res.blob();
+     * const url = URL.createObjectURL(blob);
+     * ```
+     */
+    get(token: string, init?: RequestInit): Promise<Response>;
+}
+//# sourceMappingURL=media.d.ts.map

package/dist/types/resources/media.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"media.d.ts","sourceRoot":"","sources":["../../../src/resources/media.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,aAAa;IAEV,OAAO,CAAC,QAAQ,CAAC,IAAI;IADjC,gBAAgB;gBACa,IAAI,EAAE,YAAY;IAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;CAG5D"}

package/dist/types/schemas/index.d.ts

@@ -0,0 +1,3 @@
+export { WorkflowStepSchema, KycStepTypeSchema, CreateWorkflowSchema, UpdateWorkflowSchema, } from './kyc/workflow-steps.js';
+export type { WorkflowStep, CreateWorkflowInput, UpdateWorkflowInput } from './kyc/workflow-steps.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/schemas/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/schemas/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,kBAAkB,EAClB,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,GACvB,MAAM,yBAAyB,CAAC;AAEjC,YAAY,EAAE,YAAY,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC"}