npm - @alfadocs/ui-kit - Versions diffs - 0.72.2 → 0.75.0 - Mend

@alfadocs/ui-kit 0.72.2 → 0.75.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (398) hide show

package/dist/patterns/signature-request/signature-request.d.ts ADDED Viewed

@@ -0,0 +1,81 @@
+/**
+ * SignatureRequestModal — the practice-side "Documenti firmati" modal that
+ * dispatches a document-signature request: assign the operator who must
+ * counter-sign (or leave the request unassigned), build the patient-side
+ * signer roster (up to `maxSigners`, each with their own delivery channel
+ * and, for on-device signing, an OTP waiver), and send.
+ *
+ * Runtime pattern: real consuming apps mount this in production (surfaced via
+ * `src/patterns/index.ts` and the `./patterns/signature-request` subpath).
+ * The component owns the form state — re-seeded from the `initial*` props
+ * every time `open` flips back to `true` — while the host owns `open`, the
+ * option lists, and what happens on submit. Multiple on-device signers sign
+ * sequentially in roster order — the execution side is the Signing pattern's
+ * multi-signer flow; this modal only encodes the intents.
+ */
+import { type ComponentPropsWithoutRef } from 'react';
+/** Delivery channel for one signer's signature request. */
+export type SignatureChannel = 'sms' | 'email' | 'whatsapp' | 'on-device';
+/** One selectable person/role for the operator or signer selects. */
+export interface SignerOption {
+    value: string;
+    label: string;
+}
+/** One patient-side signer row in the submission. */
+export interface SignerRequest {
+    signerId: string;
+    channel: SignatureChannel;
+    /** Only meaningful when `channel` is `'on-device'`. */
+    skipOtp?: boolean;
+}
+/** Payload handed to `onRequestSignature`. */
+export interface SignatureRequestSubmission {
+    /** `null` when the counter-signing operator is left unassigned. */
+    operatorId: string | null;
+    /** 1..N signers; on-device signers sign sequentially in this order. */
+    signers: SignerRequest[];
+}
+export interface SignatureRequestModalProps {
+    /** Controlled open state. Reopening re-seeds the form from `initial*`. */
+    open: boolean;
+    /**
+     * Fires when the dialog requests a state change (<kbd>Esc</kbd> or the
+     * footer Close button). `false` is the dismiss signal — hosts typically
+     * persist a "dismissed this session" flag there.
+     */
+    onOpenChange: (open: boolean) => void;
+    /** Operators offered as the counter-signing signer. */
+    operators: SignerOption[];
+    /** Patient-side people/roles offered in each signer row. */
+    signerOptions: SignerOption[];
+    /** Enables the "Assign to me" shortcut targeting this operator. */
+    currentOperatorId?: string;
+    /** Offer an "Assign later" option in the operator select. Default `true`. */
+    allowAssignLater?: boolean;
+    /**
+     * Preselected operator; `null` preselects "Assign later" (honoured only
+     * while `allowAssignLater` — otherwise the first operator is seeded).
+     */
+    initialOperatorId?: string | null;
+    /** Seed the signer roster. Defaults to the first option, on-device. */
+    initialSigners?: SignerRequest[];
+    /** Cap on roster size. Default `2`. */
+    maxSigners?: number;
+    /** Disables all inputs and shows the primary action as loading. */
+    busy?: boolean;
+    /** Consumer-translated error shown above the footer (e.g. server failure). */
+    error?: string;
+    /** Override the dialog title. Defaults to the `ui.*` string. */
+    title?: string;
+    /** Override the dialog description. Defaults to the `ui.*` string. */
+    description?: string;
+    /** Receives the completed submission. The host closes via `onOpenChange`. */
+    onRequestSignature: (submission: SignatureRequestSubmission) => void;
+    /**
+     * Extra attributes for the portaled dialog surface (e.g. `dir`/`lang`
+     * when the host pins a locale below `<html>`, or a test id).
+     */
+    contentProps?: ComponentPropsWithoutRef<'div'>;
+}
+export declare const SignatureRequestModal: import("react").ForwardRefExoticComponent<SignatureRequestModalProps & import("react").RefAttributes<HTMLDivElement>>;
+//# sourceMappingURL=signature-request.d.ts.map