@voplus/morpho-csp 11.2.8 → 11.3.0-dev.0

package/es/modules/corporate/legal-generation/form/legalGenerationSubmit.d.ts

@@ -0,0 +1,637 @@
+import { ApiEndPoint } from "@voplus/api";
+import type { IIdentityShape } from "@voplus/morpho-compliance/es/data/identityShape";
+import type { IAddress } from "@voplus/morpho-ui/es/data";
+import type { Dayjs } from "dayjs";
+import type { IIdentityCapture } from "../fields/state";
+/** The route a legal-generation form's composed payload is posted to (spec:3850). */
+export declare const LEGAL_GENERATION_SUBMIT_ROUTE = "/api/document-assistants/legal-generation/submit";
+/** The existing gallery templates support exactly these appointment positions. */
+export declare const SUPPORTED_OFFICER_POSITIONS: readonly ["Director", "Secretary"];
+/** Reports whether an input position is supported by the existing gallery templates. */
+export declare function isSupportedOfficerPosition(position?: string): boolean;
+/** The two branches a legal-generation form can submit (spec:1930). */
+export type LegalGenerationMode = "select-existing" | "manual";
+/**
+ * The frozen identity-shape snapshot as the submit contract carries it: the shape's `source`,
+ * `name`, `family`, `subject` and its three per-field policies, copied onto the payload at capture
+ * time. It is built from the capture, never from a catalog lookup (spec:3848).
+ */
+export interface ILegalGenerationShapeSnapshot {
+    /** The shape's `source` — built-ins are 1-3 (spec:3712). */
+    sourceNumber: number;
+    /** The frozen display name shown for the captured shape. */
+    name: string;
+    /** The frozen document family. */
+    family: IIdentityShape["family"];
+    /** The frozen subject applicability. */
+    subject: IIdentityShape["subject"];
+    /** The frozen alias policy. */
+    aliasPolicy: IIdentityShape["policies"]["alias"];
+    /** The frozen issuing-country policy. */
+    issuingCountryPolicy: IIdentityShape["policies"]["issuingCountry"];
+    /** The frozen expiry-date policy. */
+    expiryPolicy: IIdentityShape["policies"]["expiryDate"];
+}
+/** The identity values a manual person supplied, honouring the captured shape's policies. */
+export interface ILegalGenerationIdentityValues {
+    /** The typed full name. */
+    fullName?: string;
+    /** The typed document number. */
+    number?: string;
+    /** The typed nationality / issuing country of the document. */
+    country?: string;
+    /**
+     * Captured alias — present only where the captured shape does not omit it. A save writes `null`
+     * to clear an alias the replacement shape no longer captures (spec:3713).
+     */
+    alias?: string | null;
+    /** Captured issuing country — present only where the captured shape does not omit it. */
+    issuingCountry?: string | null;
+    /** Captured expiry date — present only where the captured shape does not omit it. */
+    expiryDate?: string | null;
+}
+/** The manual branch's person, as the submit contract carries it. */
+export interface ILegalGenerationSubmitPerson {
+    /** The typed full name. */
+    name?: string;
+    /** The captured representative name used by the existing CHO template. */
+    representative?: string;
+    /** The captured representative document number used by the existing CHO template. */
+    representativePassport?: string;
+    /** The typed email. */
+    email?: string;
+    /** The typed contact number. */
+    phone?: string;
+    /** The person kind this manual branch captures. */
+    type?: "Person" | "Organization";
+    /** The officer types the manual branch picked. */
+    types?: string[];
+    /** The typed address. */
+    address?: IAddress;
+    /** The typed identity values plus the values captured under the shape's policies. */
+    identity: ILegalGenerationIdentityValues;
+    /** The complete captured snapshot; omitted by a mode that captures no document type. */
+    identityShape?: ILegalGenerationShapeSnapshot;
+}
+/** 仅属于本份文书的母公司显示补丁：null/缺属性保留，空串清空。 */
+export interface ILegalGenerationParentDetails {
+    /** 文书中的母公司名称。 */
+    name?: string | null;
+    /** 文书中的注册或证件号码。 */
+    number?: string | null;
+    /** 文书中的自由文本地址。 */
+    address?: string | null;
+    /** 文书中的邮箱显示值。 */
+    email?: string | null;
+    /** 文书中的电话显示值。 */
+    phone?: string | null;
+}
+/** 保存响应中用于重新编辑的母公司副本；身份成员与联系人 id 分开。 */
+export interface ILegalGenerationParentData {
+    /** 已保存名称。 */
+    name?: string | null;
+    /** 已保存自由文本地址。 */
+    address?: string | null;
+    /** 已保存邮箱显示值。 */
+    email?: string | null;
+    /** 已保存电话显示值。 */
+    phone?: string | null;
+    /** 仅从转换后的身份对象读取号码。 */
+    identity?: {
+        number?: string | null;
+    } | null;
+}
+/** The submit request body. */
+export interface ILegalGenerationSubmitBody {
+    /** The gallery document name, e.g. `"Appoint Officer"`. */
+    documentName: string;
+    /** The branch the user submitted. */
+    mode: LegalGenerationMode;
+    /** The picked entity's id in select-existing mode; `null` in manual mode. */
+    entityId: string | null;
+    /** The company the document is composed for. */
+    company?: {
+        id: string;
+        name: string;
+    };
+    /** The foreign parent, separate from the Singapore company and representative. */
+    parentCompany?: {
+        id: string;
+        name: string;
+    };
+    /** The country of the foreign parent. */
+    parentCompanyCountry?: string;
+    /** 仅包含用户编辑的文书显示值，不携带原始 ParentCompanyData。 */
+    parentCompanyDetails?: ILegalGenerationParentDetails | null;
+    /** The date printed on the document (`YYYY-MM-DD`). */
+    documentDate: string | null;
+    /** The date the document takes effect (`YYYY-MM-DD`). */
+    effectiveDate: string | null;
+    /** The typed person in manual mode; `undefined` in select-existing mode. */
+    person?: ILegalGenerationSubmitPerson;
+}
+/**
+ * The branch-composed payload one legal-generation form's `onFinish` builds (spec:1930).
+ *
+ * Select-existing carries exactly one of the id members and no typed person value; manual carries
+ * the typed person values plus the capture seam's complete `Identity` snapshot and no id.
+ */
+export interface ILegalGenerationBranchValues {
+    /** The picked officer's id (AppointOfficer / PowerOfAttroney / ShareTransfer). */
+    OfficerId?: string;
+    /** The picked contact identity's id (CorporateRepresentative). */
+    IdentityId?: string;
+    /** The typed full name; the AppointOfficer branch calls it `FullName`. */
+    FullName?: string;
+    /** The typed full name; the CorporateRepresentative branch calls it `IdentityName`. */
+    IdentityName?: string;
+    /** The typed nationality of the person, where the branch captures one. */
+    Country?: string;
+    /** The officer type the manual branch picked. */
+    OfficerType?: string;
+    /** The typed email. */
+    Email?: string;
+    /** The typed contact number. */
+    Contact?: string;
+    /** The typed document number. */
+    IdentityNumber?: string | number;
+    /** The typed address. */
+    Address?: IAddress;
+    /** The picked shape's `source` number, mirrored from the capture seam (spec:1929). */
+    IdentityShape?: number;
+    /** The complete capture the seam wrote: the frozen shape plus the values captured under its policies (spec:3848). */
+    Identity?: IIdentityCapture;
+}
+/**
+ * The company one submission is composed for: the camelCase `ICorporate` a form's Company picker
+ * hands over, or the PascalCase pair a reopened document's restore seeds.
+ */
+export interface ILegalGenerationCompany {
+    /** The corporate's id, as the picker's `ICorporate` carries it. */
+    id?: string;
+    /** The corporate's name, as the picker's `ICorporate` carries it. */
+    name?: string;
+    /** The corporate's id, as {@link ILegalGenerationRestoreValues.Company} carries it. */
+    Id?: string;
+    /** The corporate's name, as {@link ILegalGenerationRestoreValues.Company} carries it. */
+    Name?: string;
+}
+/** One legal-generation form submission: the document it is composed for plus the branch payload. */
+export interface ILegalGenerationSubmission {
+    /** The gallery document name, e.g. `"Appoint Officer"`. */
+    documentName: string;
+    /** The branch the user submitted (spec:1930). */
+    mode: LegalGenerationMode;
+    /** The branch-composed payload (spec:1930). */
+    branch: ILegalGenerationBranchValues;
+    /** The company the document is composed for. */
+    company?: ILegalGenerationCompany;
+    /** The foreign parent, separate from the Singapore company and representative. */
+    parentCompany?: ILegalGenerationCompany;
+    /** The country of the foreign parent. */
+    parentCompanyCountry?: string;
+    /** 仅包含用户编辑的文书显示值，不携带原始 ParentCompanyData。 */
+    parentCompanyDetails?: ILegalGenerationParentDetails | null;
+    /** The date printed on the document, already normalised to `YYYY-MM-DD`. */
+    documentDate?: string;
+    /** The date the document takes effect, already normalised to `YYYY-MM-DD`. */
+    effectiveDate?: string;
+}
+/** The document the conversion produced, as the client needs it for the download action. */
+export interface ILegalGenerationDocument {
+    /** The id of the persisted legal-generation form. */
+    id: string;
+    /** The document name. */
+    name: string;
+    /** The document's content type. */
+    contentType: string;
+    /** The relative route the document is downloaded from. */
+    downloadUrl: string;
+}
+/** The submit endpoint's success body. */
+export interface ILegalGenerationSubmitResult {
+    /** The id of the persisted legal-generation form. */
+    id: string;
+    /** The CLDA meta key the backend resolved from the document name. */
+    metaKey: string;
+    /** The echoed document name. */
+    documentName: string;
+    /** The echoed branch. */
+    mode: LegalGenerationMode;
+    /** The persisted form content. */
+    content: ILegalGenerationFormContent;
+    /** The generated document. */
+    document: ILegalGenerationDocument;
+}
+/** The outcome of a submit handoff: the generated document, or the failure the form re-renders. */
+export type ILegalGenerationHandoff = {
+    ok: true;
+    result: ILegalGenerationSubmitResult;
+    document: ILegalGenerationDocument;
+} | {
+    ok: false;
+    message: string;
+    result?: ILegalGenerationSubmitResult;
+    document?: ILegalGenerationDocument;
+};
+/** The CLDA meta key every legal-generation submission persists under (contract §1). */
+export declare const LEGAL_GENERATION_META_KEY = "CHO";
+/** One form person as the persisted content carries it (camelCase read model of `FormPeopleOptions`). */
+export interface ILegalGenerationFormPerson {
+    /** The form person's id — a contact id the document addresses its people by. */
+    id?: string;
+    /** `"NewId"` for a person the composition entered, `"ExistingContactId"` for one it picked. */
+    idType?: string;
+    /** The original picker id; distinct from the contact owner id. */
+    selectedEntityId?: string | null;
+    /** The exact identity captured for an existing selection. */
+    selectedIdentityId?: string | null;
+    /** The person's name. */
+    name?: string;
+    /** The person's email. */
+    email?: string;
+    /** The person's contact number. */
+    phone?: string;
+    /** The person kind. */
+    type?: string;
+    /** The officer types. */
+    types?: string[];
+    /** The person's representative, where one was captured. */
+    representative?: string;
+    /** The picked identity's number, carried as the representative's passport. */
+    representativePassport?: string | null;
+    /** The person's address. */
+    address?: IAddress;
+    /** The identity values. */
+    identity?: ILegalGenerationIdentityValues;
+    /** The frozen identity-shape snapshot. */
+    identityShape?: ILegalGenerationShapeSnapshot;
+}
+/** One officer appointment the persisted `NewOfficerAppointments` section carries. */
+export interface ILegalGenerationOfficerPosition {
+    /** The positions the officer is appointed to. */
+    positions?: string[];
+    /** The appointed contact's id — always the id of an entry in `contacts` (contract §3). */
+    officerId?: string;
+}
+/** One officer appointment as the PascalCase `NewOfficerAppointmentDetails` save payload carries it. */
+export interface ILegalGenerationOfficerEdit {
+    /** The positions the officer is appointed to. */
+    Positions: string[];
+    /** The appointed contact's id. */
+    OfficerId?: string;
+}
+/**
+ * The persisted `CompanyGeneral.SGP.Models.FormContent` a submit composes and a load returns
+ * (camelCase read model, contract §1/§2): the people the composition supplied, the officers the
+ * Appoint Officer section appoints, the company and the document date.
+ *
+ * The document name identifies the gallery item; `idType` identifies the captured branch.
+ * Dates, parent organization and owned template keys travel beside the captured people.
+ */
+export interface ILegalGenerationFormContent {
+    /** Gallery-owned template keys; absent on an identifiable standalone legacy form. */
+    generationTemplateKeys?: string[] | null;
+    /** The separately captured foreign parent organization. */
+    parentCompany?: {
+        id?: string;
+        name?: string;
+    } | null;
+    /** The separately captured foreign parent country. */
+    parentCompanyCountry?: string | null;
+    /** Server-captured parent organization data, retained by the server on regeneration. */
+    parentCompanyData?: ILegalGenerationParentData | null;
+    /** The people the composition supplied. */
+    contacts?: ILegalGenerationFormPerson[];
+    /** The company the document is composed for; never written back on save (contract §4). */
+    corporate?: {
+        id?: string;
+        name?: string;
+    } | null;
+    /** The document date the shared contact content carries. */
+    date?: string | null;
+    /** The editable appointment effective date. */
+    effectiveDate?: string | null;
+    /** The officers the document appoints — Appoint Officer only. */
+    newOfficerAppointments?: {
+        officers?: ILegalGenerationOfficerPosition[];
+    } | null;
+}
+/**
+ * The persisted form document as the platform load route answers it (contract §4): the document's
+ * own members plus the `FormContent` above.
+ */
+export interface ILegalGenerationFormDocument {
+    /** A legacy form with an existing host cannot be adopted by the gallery. */
+    parentNode?: {
+        id?: string;
+    } | null;
+    /** The document read model may carry the host as an id alone. */
+    parentNodeId?: string | null;
+    /** The persisted form document's id. */
+    id: string;
+    /** The document's name. */
+    name?: string;
+    /** Always {@link LEGAL_GENERATION_META_KEY} for a document this endpoint composed. */
+    metaKey?: string;
+    /** Always `"SGP"` for the Company General document these forms compose. */
+    country?: string;
+    /** The composed content. */
+    content?: ILegalGenerationFormContent;
+}
+/** One person as the PascalCase `FormPeopleOptions` save payload carries it (contract §2). */
+export interface ILegalGenerationPersonEdit {
+    Id: string;
+    IdType: string;
+    /** Server-authoritative owner selected for this loaded contact, when it is not manual. */
+    SelectedEntityId: string | null;
+    /** Server-authoritative identity selected for this loaded contact, when it is not manual. */
+    SelectedIdentityId: string | null;
+    Name: string;
+    Email: string | null;
+    Phone: string | null;
+    Type: string | null;
+    Types: string[] | null;
+    Representative: string | null;
+    RepresentativePassport: string | null;
+    Address: {
+        Line1: string | undefined;
+        Line2: string | null;
+        City: string | null;
+        State: string | null;
+        PostalCode: string | null;
+        Country: string | undefined;
+    } | null;
+    Identity: {
+        FullName: string | null;
+        Number: string | null;
+        Country: string | null;
+        Alias: string | null;
+        IssuingCountry: string | null;
+        ExpiryDate: string | null;
+    } | null;
+    IdentityShape: {
+        SourceNumber: number;
+        Name: string;
+        Family: IIdentityShape["family"];
+        Subject: IIdentityShape["subject"];
+        AliasPolicy: IIdentityShape["policies"]["alias"];
+        IssuingCountryPolicy: IIdentityShape["policies"]["issuingCountry"];
+        ExpiryPolicy: IIdentityShape["policies"]["expiryDate"];
+    } | null;
+}
+/**
+ * The PascalCase `Morpho.CSP.DocumentAssistants.CompanyGeneral.SGP.FormEditOptions` members a
+ * reopened document's save writes (contract §4). `Corporate` is deliberately absent — sending one
+ * tells the document it moved to another company and unions the whole roster into `Contacts`.
+ */
+export interface ILegalGenerationFormEditOptions {
+    /** The document date the shared contact content carries. */
+    Date: string | null;
+    /** Every person the loaded content carried, each copied unchanged; replaced wholesale. */
+    Contacts?: ILegalGenerationPersonEdit[];
+    /** The officer appointments, mapped onto the contract's PascalCase members — Appoint Officer only. */
+    NewOfficerAppointments?: {
+        Officers: ILegalGenerationOfficerEdit[];
+    };
+}
+/**
+ * The frozen snapshot of `shape` as the payload carries it (spec:3848): a copy of the members a
+ * snapshot owns, taken from the capture's own shape and never resolved against the shared catalog.
+ *
+ * @param shape the capture's frozen shape.
+ * @returns the snapshot the submit body and the form-content JSON column carry.
+ */
+export declare function toIdentityShapeSnapshot(shape: IIdentityShape): ILegalGenerationShapeSnapshot;
+/**
+ * Builds the submit request body from one form's composed submission (spec:1930): select-existing
+ * carries the picked entity's id and omits every typed person field, manual carries the typed
+ * person with its captured snapshot and omits the id.
+ *
+ * @param submission the document name plus the branch the form composed.
+ * @returns the body the conversion endpoint reads.
+ */
+export declare function buildLegalGenerationSubmitBody(submission: ILegalGenerationSubmission): ILegalGenerationSubmitBody;
+/**
+ * The message a failed submit carries (spec:3850). `ApiEndPoint` rejects with
+ * `` `${status} - ${bodyText}` `` and the conversion endpoint answers its failure message as a JSON
+ * string literal, so the body is unwrapped and anything else falls back to the raw text.
+ *
+ * @param error the rejection the endpoint raised.
+ * @returns the message the form shows.
+ */
+export declare function legalGenerationFailureMessage(error: unknown): string;
+/** Per-field validation errors from the captured snapshot, never the live catalog. */
+export type LegalGenerationIdentityErrors = Partial<Record<keyof IIdentityCapture["values"], string>>;
+/** Validate required and omitted values against the immutable policies before create or same-id save. */
+export declare function validateLegalGenerationCapture(capture?: IIdentityCapture): LegalGenerationIdentityErrors;
+/** Fetch the ZIP with a bearer header and open a short-lived local URL, keeping credentials out of browser URLs. */
+export declare function downloadLegalGenerationDocument(document: ILegalGenerationDocument, accessToken: string, endpoint: ApiEndPoint, open?: (url: string) => void): Promise<void>;
+/**
+ * Submits a legal-generation form's composed payload to the document conversion and delivers both
+ * continuations (spec:3850): on success the generated document is opened for download, and on
+ * failure the endpoint's message is shown and nothing is downloaded or reset — the caller's entered
+ * values and captured snapshot stay exactly as they were, so the form stays open for a correction
+ * and a retry.
+ *
+ * @param options the endpoint, the caller's access token and the composed submission.
+ * @returns the handoff outcome.
+ */
+export declare function submitLegalGeneration(options: {
+    /** The CSP web area endpoint the payload is posted to. */
+    endpoint: ApiEndPoint;
+    /** The caller's bearer token for the authenticated ZIP request. */
+    accessToken: string;
+    /** The composed submission the form built. */
+    submission: ILegalGenerationSubmission;
+    /** Opens the generated document; defaults to a new browser tab. */
+    open?: (url: string) => void;
+}): Promise<ILegalGenerationHandoff>;
+/**
+ * Restores the capture a saved form value holds, from the frozen snapshot alone: no catalog lookup
+ * runs, so a source shape later renamed, re-policied or deleted still restores exactly what was
+ * captured (spec:3848). The snapshot omits the catalog's `builtIn` flag and its concurrency token,
+ * so the restored shape marks itself built-in from its `source` — built-ins are 1-3 (spec:3712).
+ *
+ * @param person the form person a load route returned.
+ * @returns the capture the manual-entry block reopens on, or undefined for a legacy value.
+ */
+export declare function toIdentityCapture(person: ILegalGenerationFormPerson): IIdentityCapture | undefined;
+/** The two gallery items this endpoint composes (contract §3). */
+export type LegalGenerationDocumentName = "Appoint Officer" | "Corporate Representative";
+/** The typed values a reopened document seeds its gallery form's fields with. */
+export interface ILegalGenerationRestoreValues {
+    /** The Appoint Officer branch's typed name (`FullName`). */
+    FullName?: string;
+    /** The Corporate Representative branch's typed name (`IdentityName`). */
+    IdentityName?: string;
+    /** The typed email. */
+    Email?: string;
+    /** The Appoint Officer branch's typed contact number (`Contact`). */
+    Contact?: string;
+    /** The officer type the manual branch picked. */
+    OfficerType?: string;
+    /** The typed document number. */
+    IdentityNumber?: string;
+    /** Appointment identity country, or the representative form's parent company country. */
+    Country?: string;
+    /** The representative's independently persisted identity country. */
+    RepresentativeCountry?: string;
+    /** The typed address. */
+    Address?: IAddress;
+    /** The company the document is composed for. */
+    Company?: {
+        Id: string;
+        Name: string;
+    };
+    /** The separately persisted foreign parent organization. */
+    ParentCompany?: {
+        Id: string;
+        Name: string;
+    };
+    /** The Appoint Officer branch's document date, as the UTC picker reads it. */
+    DocumentDate?: Dayjs;
+    /** The saved appointment effective date, in the picker format. */
+    EffectiveDate?: Dayjs;
+    /** The restored officer picker value, retaining its picker id. */
+    Officer?: {
+        id: string;
+        name: string;
+    };
+    /** The restored representative picker value, retaining the exact identity id. */
+    LegalContact?: {
+        id: string;
+        name: string;
+    };
+    /** The Corporate Representative branch's document date (`Date`), as the UTC picker reads it. */
+    Date?: Dayjs;
+}
+/** What a persisted legal-generation document restores into the gallery form that composed it. */
+export interface ILegalGenerationRestore {
+    /** 已保存母公司显示基线，与 touched 字段补丁分离。 */
+    parentCompanyBaseline?: {
+        parentId: string;
+        details: ILegalGenerationParentDetails;
+    };
+    /** The gallery item the populated section identifies (contract §1). */
+    documentName: LegalGenerationDocumentName;
+    /** The branch the document's contact carries: a composed person, or one the endpoint resolved. */
+    mode: LegalGenerationMode;
+    /** The section's person, as the persisted content carries it. */
+    person: ILegalGenerationFormPerson;
+    /** The capture the person's snapshot restores, or undefined for a person with no snapshot. */
+    identity?: IIdentityCapture;
+    /** The typed values the reopened form seeds its fields with. */
+    values: ILegalGenerationRestoreValues;
+}
+/** The persisted document one gallery form was reopened on. */
+export interface ILegalGenerationReopened extends ILegalGenerationRestore {
+    /** The persisted form document's id — what its save is written back to. */
+    id: string;
+    /** The document's own content, the base a save re-writes. */
+    content: ILegalGenerationFormContent;
+}
+/** The route a persisted form document is loaded from and written back to (contract §4). */
+export declare function legalGenerationFormRoute(id: string): string;
+/**
+ * Maps a supported named gallery document onto its first relevant captured person (spec:3848).
+ * The frozen snapshot restores its shape and values verbatim without a catalog lookup.
+ * The foreign parent remains separate from the Singapore company and representative identity.
+ *
+ * @param content the camelCase content a loaded Company General document carries.
+ * @returns what the gallery form reopens with, or undefined when no section of this endpoint's two
+ * is populated (a document another surface composed).
+ */
+export declare function toLegalGenerationRestore(content: ILegalGenerationFormContent, documentName?: string): ILegalGenerationRestore | undefined;
+/** 用规范模板识别逻辑类型；未标记旧文书仍需原有名称及独立内容证据。 */
+export declare function resolveGalleryDocumentKind(document: ILegalGenerationFormDocument): "Appoint Officer" | "Corporate Representative" | undefined;
+/**
+ * The document a legal-generation page was opened on, when the id it carries names a persisted
+ * Company General document this endpoint composed (contract §1/§4). Anything else — another id, a
+ * document family this gallery does not compose, a content whose sections are both empty — answers
+ * undefined; the saved-id load gate treats unsupported responses as a failure.
+ *
+ * @param document the document a load returned, when one was loaded at all.
+ * @returns the reopened document, or undefined when the page composes a new one.
+ */
+export declare function toReopenedLegalGeneration(document?: ILegalGenerationFormDocument): ILegalGenerationReopened | undefined;
+/**
+ * Maps the form content a load route returned onto the PascalCase
+ * `CompanyGeneral.SGP.FormEditOptions` the platform save route reads (contract §4). Every value is
+ * copied unchanged — in particular the frozen `IdentityShape` snapshot — so save → reopen → resubmit
+ * round-trips the snapshot byte-identically, with no catalog resolution and no dependence on the
+ * source shape still existing (spec:3848).
+ *
+ * Two members are deliberately shaped by the route's own semantics: `Corporate` is never sent,
+ * because a company whose id differs from the stored one reads as "the document moved company" and
+ * unions the whole roster into `Contacts`; and `Contacts` carries the **complete** list, because a
+ * sent list replaces the stored one wholesale — omitting an entry would delete it.
+ *
+ * @param content the camelCase content a loaded legal-generation form carries.
+ * @returns the payload the double-encoded save body carries.
+ */
+export declare function toFormContentEditPayload(content: ILegalGenerationFormContent): ILegalGenerationFormEditOptions;
+/**
+ * The content a reopened form's save writes back (contract §4): the document's own content with the
+ * branch the user re-composed folded into the section's contact, and every other contact, the officer
+ * appointments and the document date copied unchanged — so the list the save replaces wholesale is
+ * still the complete one (spec:3848).
+ *
+ * Only a manual branch folds. A select-existing save keeps the contact the endpoint resolved when it
+ * composed the document: the id the picker posts is an officer / legal-contact id, and only the
+ * server can resolve it to the contact id the document addresses its people by (contract §3.1).
+ *
+ * @param reopened the document the form was reopened on.
+ * @param branch the branch the form re-composed.
+ * @param documentDate the date the form carries, already normalised to `YYYY-MM-DD`.
+ * @returns the content {@link toFormContentEditPayload} writes back.
+ */
+export declare function toLegalGenerationSavedContent(reopened: ILegalGenerationReopened, branch: ILegalGenerationBranchValues, documentDate?: string): ILegalGenerationFormContent;
+/** The message a load failure other than a missing document surfaces (spec:3848). */
+export declare const LEGAL_GENERATION_LOAD_FAILURE_MESSAGE = "Failed to load the saved document. Please reopen it from the document list and try again.";
+/** Load a saved CHO composition; only 404 is missing, other failures remain failures. */
+export declare function loadLegalGenerationForm(options: {
+    /** The endpoint that owns the saved form. */
+    endpoint: ApiEndPoint;
+    /** The exact persisted form being opened. */
+    id: string;
+    /** Cancels a load after navigation or unmount. */
+    signal?: AbortSignal;
+}): Promise<ILegalGenerationFormDocument | undefined>;
+/**
+ * Fixture/legacy generic-save helper writing re-composed content to its existing document
+ * (contract §4): the PascalCase payload of {@link toFormContentEditPayload}, sent as the JSON **text**
+ * the platform save route binds with case-sensitive `System.Text.Json`.
+ *
+ * This generic route remains for fixture/legacy callers. Production gallery editors call
+ * saveLegalGeneration, whose dedicated /save route owns selected composition and regeneration.
+ *
+ * @param options the endpoint, the persisted document's id and the content to write back.
+ * @returns the save outcome; a failure is surfaced through the same channel the submit uses.
+ */
+export declare function saveLegalGenerationContent(options: {
+    /** The CSP web area endpoint the payload is posted to. */
+    endpoint: ApiEndPoint;
+    /** The persisted form document's id. */
+    id: string;
+    /** The complete content the save replaces the document's own with. */
+    content: ILegalGenerationFormContent;
+}): Promise<{
+    ok: true;
+} | {
+    ok: false;
+    message: string;
+}>;
+/** Production gallery save: resolve the complete edited branch through the dedicated /save route, then download the regenerated existing ZIP. */
+export declare function saveLegalGeneration(options: {
+    /** The endpoint owning the saved document. */
+    endpoint: ApiEndPoint;
+    /** The same persisted id, never a create request. */
+    id: string;
+    /** The current user's download access token. */
+    accessToken: string;
+    /** The complete form composition, including mode, selected id, company and dates. */
+    submission: ILegalGenerationSubmission;
+    /** Optional browser opener used by hosts and tests. */
+    open?: (url: string) => void;
+}): Promise<ILegalGenerationHandoff>;