@knkcs/contenthub-ui 0.4.0 → 0.5.0

package/dist/index.d.ts

@@ -64,6 +64,8 @@ export declare interface BlueprintEditingOverride {
     editingMode: EditingMode | null;
     /** null follows the workspace's. */
     editingBlock: boolean | null;
+    /** The people beside the admins; null follows the workspace's, [] is the admins alone. */
+    forceGroup: string[] | null;
     /** What applies to the Blueprint's Content: this override over the workspace's. */
     effective: EditingSettings;
 }
@@ -166,6 +168,13 @@ export declare interface BranchEditorProps {
 /** What a Branch is for: one an editor works on, or a Carry-forward link. */
 export declare type BranchKind = "editorial" | "carry_forward";
 
+/** Whether a Direct Edit's change carries forward into one later wording (#270). */
+export declare interface CarryForwardAnswer {
+    /** The later wording: the Release a Carry-forward link carries. */
+    releaseId: string;
+    carry: boolean;
+}
+
 /** What a Chain on Dated Content, effective on a date, would be and meet (PreviewChain). */
 export declare interface ChainPreview {
     /** The Release it would fork from; "" in a gap. */
@@ -509,6 +518,8 @@ export declare interface ContentAttributes {
     block?: ContentBlock;
     /** When it was archived, ISO 8601; absent while it is not Archived. */
     archiveTime?: string;
+    /** Its Editing Block; absent while no open Direct Edit holds one. */
+    editingBlock?: EditingBlock;
 }
 
 /**
@@ -822,6 +833,8 @@ export declare interface ContenthubClient {
         blueprintAccessor: string;
         editingMode: EditingMode | null;
         editingBlock: boolean | null;
+        /** null follows the workspace's; [] is the admins alone. */
+        forceGroup: string[] | null;
     }): Promise<BlueprintEditingOverride>;
     /** Removes one Blueprint's override, so it follows the workspace's; admin only. */
     deleteBlueprintEditingOverride(input: {
@@ -1086,11 +1099,20 @@ export declare interface ContenthubClient {
      * or answers the one the caller has open on it, with `reopened`. Answers
      * the Direct Edit and the Content as read on its Branch. Rejects with
      * `EditingModeRefusedError` where the Editing Mode is "Change Sets only",
-     * `DirectEditRefusedError` where the Content is Dated, `ContentBlockedError`, `ContentArchivedError`,
-     * and `InvalidInputError` for anything else the service refuses.
+     * `DirectEditRefusedError` where another editor's Direct Edit holds its
+     * Editing Block (naming them), `ContentBlockedError`, `ContentArchivedError`,
+     * and `InvalidInputError` for anything else the service refuses (a day
+     * for undated Content among it).
      */
     openDirectEdit(input: {
         contentId: string;
+        /**
+         * Dated Content only (#270): the day the change takes effect, as
+         * YYYY-MM-DD; absent is today. Its Branch forks from the Release In
+         * Force that day: on today it corrects that Release, on a later day
+         * it is a new wording.
+         */
+        effectiveOn?: string;
         /** Makes a retry safe (CONTEXT.md, Idempotency Key). */
         idempotencyKey?: string;
     }): Promise<{
@@ -1098,17 +1120,63 @@ export declare interface ContenthubClient {
         content: Content;
         reopened: boolean;
     }>;
+    /**
+     * What a Direct Edit's Publish of Dated Content would plan (#270): its
+     * Release's Validity Period with `validityLastDay` as Publish takes it,
+     * the Release it corrects, the date-only Releases contenthub derives and
+     * the later wordings Publish asks about. Writes nothing. Rejects with
+     * `CoversReleaseError` (`changeSetRequired`) when the period would cover
+     * a Release entirely.
+     */
+    previewDirectEditPublish(input: {
+        id: string;
+        validityLastDay?: string;
+    }): Promise<DirectEditPublishPreview>;
     /**
      * Publishes a Direct Edit at `expectedHeadId`, the head of its Branch the
-     * editor saw: one Release, In Force from its Publish. Rejects as
-     * `publish` does, and with `DirectEditRefusedError` for a Change Set that
-     * is not a Direct Edit.
+     * editor saw: one Release, In Force from its Publish, carrying
+     * `releaseSpec`. Rejects as `publish` does, with `ContentRefusedError`
+     * for Release Spec values the Blueprint Release refuses (a required one
+     * missing among them), and with `DirectEditRefusedError` for a Change
+     * Set that is not a Direct Edit. On Dated Content (#270) it takes the
+     * Validity Period's last day and one carry-forward answer per later
+     * wording, and rejects with `CoversReleaseError` (`changeSetRequired`)
+     * when the period would cover a Release entirely.
      */
     publishDirectEdit(input: {
         id: string;
         expectedHeadId: string;
+        /** The Release's Release Spec values; absent is none. */
+        releaseSpec?: Record<string, unknown>;
+        /** Dated Content: the period's last day, "" for an open end; absent keeps the default. */
+        validityLastDay?: string;
+        /** Dated Content: whether the change carries into each later wording. */
+        carryForward?: CarryForwardAnswer[];
         idempotencyKey?: string;
     }): Promise<PublishOutcome>;
+    /**
+     * Saves on a Direct Edit's Branch on top of `expectedHeadId`, as
+     * `saveRevision` does, and publishes the Revision saved, as
+     * `publishDirectEdit` does, in one request (ADR 0022). Refused as a
+     * whole, with nothing saved: rejects as either does (`StaleHeadError`,
+     * `ContentRefusedError` for the data or the Release Spec values,
+     * `PublishRefusedError` with every blocker).
+     */
+    saveAndPublishDirectEdit(input: {
+        id: string;
+        expectedHeadId: string;
+        data: Record<string, unknown>;
+        /** Top-level field accessors; absent saves `data` as the whole Revision. */
+        fieldMask?: string[];
+        releaseSpec?: Record<string, unknown>;
+        /** As `publishDirectEdit`'s. */
+        validityLastDay?: string;
+        carryForward?: CarryForwardAnswer[];
+        idempotencyKey?: string;
+    }): Promise<{
+        content: Content;
+        outcome: PublishOutcome;
+    }>;
     /**
      * Discards a Direct Edit: its work is dropped, Main and the Releases stay.
      * Rejects as `discardChangeSet` does, and with `DirectEditRefusedError`
@@ -1118,6 +1186,23 @@ export declare interface ContenthubClient {
         id: string;
         idempotencyKey?: string;
     }): Promise<ChangeSet>;
+    /**
+     * Forces an Editing Block (ADR 0022): hands the Direct Edit `id` holding
+     * it, with its work and its Editing Block, to the caller. Answers it with
+     * the caller as its editor, the Content as read on its Branch, and who
+     * edited it until now. Rejects with `AccessDeniedError` outside the
+     * Force Group, `DirectEditRefusedError` where the caller has a Direct
+     * Edit of the Content of their own or it holds no Editing Block any more,
+     * and as `discardDirectEdit` does otherwise.
+     */
+    forceDirectEdit(input: {
+        id: string;
+        idempotencyKey?: string;
+    }): Promise<{
+        changeSet: ChangeSet;
+        content: Content;
+        previousEditorId: string;
+    }>;
     startEditing(input: {
         contentId: string;
         changeSetId?: string;
@@ -1422,6 +1507,7 @@ export declare const contenthubTranslations: {
                         mode: string;
                         block: string;
                         actions: string;
+                        force: string;
                     };
                     fromWorkspace: string;
                     createOverride: string;
@@ -1451,6 +1537,11 @@ export declare const contenthubTranslations: {
                         save: string;
                         denied: string;
                         failed: string;
+                        force: string;
+                        forceHelp: string;
+                        forcePeople: string;
+                        forceNobody: string;
+                        forceOwn: string;
                     };
                     removeDialog: {
                         title: string;
@@ -1458,6 +1549,10 @@ export declare const contenthubTranslations: {
                         confirm: string;
                         failed: string;
                     };
+                    force: {
+                        adminsOnly: string;
+                        adminsAnd: string;
+                    };
                 };
                 requiredChecks: {
                     create: string;
@@ -2379,6 +2474,18 @@ export declare const contenthubTranslations: {
                         message: string;
                         confirm: string;
                     };
+                    editingBlock: {
+                        beingEdited: string;
+                        force: string;
+                        forceConfirm: {
+                            title: string;
+                            message: string;
+                            confirm: string;
+                            failed: string;
+                            denied: string;
+                        };
+                        forced: string;
+                    };
                     directEdit: {
                         unpublished: string;
                         continue: string;
@@ -2423,13 +2530,64 @@ export declare const contenthubTranslations: {
                     refused_one: string;
                     refused_other: string;
                     refusedBecause: {
-                        dated_content: string;
                         one_branch: string;
                         not_a_direct_edit: string;
+                        editing_blocked: string;
+                        not_the_editor: string;
+                        own_direct_edit: string;
+                        no_editing_block: string;
                         unknown: string;
                     };
+                    updateFromMain: string;
+                    resolveMerge: string;
+                    behind: {
+                        title: string;
+                        message: string;
+                    };
+                    pendingMerge: {
+                        title: string;
+                        message: string;
+                    };
                     saveFirst: string;
                     changeSetsOnly: string;
+                    saveAndPublish: string;
+                    publishDialog: {
+                        title: string;
+                        publishHint: string;
+                        saveAndPublishHint: string;
+                        specHint: string;
+                        refusedValues_one: string;
+                        refusedValues_other: string;
+                        datedPublishHint: string;
+                        datedSaveAndPublishHint: string;
+                        period: string;
+                        correction: string;
+                        newWording: string;
+                        firstDay: string;
+                        lastDay: string;
+                        lastDayHelp: string;
+                        computed: string;
+                        computedHint: string;
+                        computedRow: string;
+                        noComputed: string;
+                        carryForward: string;
+                        carryForwardHint: string;
+                        wording: string;
+                        wordingUntil: string;
+                        carryYes: string;
+                        carryNo: string;
+                        unanswered: string;
+                        previewFailed: string;
+                        covers: string;
+                    };
+                    effective: {
+                        title: string;
+                        hint: string;
+                        label: string;
+                        help: string;
+                        required: string;
+                        submit: string;
+                    };
                 };
             };
         };
@@ -2504,6 +2662,7 @@ export declare const contenthubTranslations: {
                         mode: string;
                         block: string;
                         actions: string;
+                        force: string;
                     };
                     fromWorkspace: string;
                     createOverride: string;
@@ -2533,6 +2692,11 @@ export declare const contenthubTranslations: {
                         save: string;
                         denied: string;
                         failed: string;
+                        force: string;
+                        forceHelp: string;
+                        forcePeople: string;
+                        forceNobody: string;
+                        forceOwn: string;
                     };
                     removeDialog: {
                         title: string;
@@ -2540,6 +2704,10 @@ export declare const contenthubTranslations: {
                         confirm: string;
                         failed: string;
                     };
+                    force: {
+                        adminsOnly: string;
+                        adminsAnd: string;
+                    };
                 };
                 requiredChecks: {
                     create: string;
@@ -3461,6 +3629,18 @@ export declare const contenthubTranslations: {
                         message: string;
                         confirm: string;
                     };
+                    editingBlock: {
+                        beingEdited: string;
+                        force: string;
+                        forceConfirm: {
+                            title: string;
+                            message: string;
+                            confirm: string;
+                            failed: string;
+                            denied: string;
+                        };
+                        forced: string;
+                    };
                     directEdit: {
                         unpublished: string;
                         continue: string;
@@ -3505,13 +3685,64 @@ export declare const contenthubTranslations: {
                     refused_one: string;
                     refused_other: string;
                     refusedBecause: {
-                        dated_content: string;
                         one_branch: string;
                         not_a_direct_edit: string;
+                        editing_blocked: string;
+                        not_the_editor: string;
+                        own_direct_edit: string;
+                        no_editing_block: string;
                         unknown: string;
                     };
+                    updateFromMain: string;
+                    resolveMerge: string;
+                    behind: {
+                        title: string;
+                        message: string;
+                    };
+                    pendingMerge: {
+                        title: string;
+                        message: string;
+                    };
                     saveFirst: string;
                     changeSetsOnly: string;
+                    saveAndPublish: string;
+                    publishDialog: {
+                        title: string;
+                        publishHint: string;
+                        saveAndPublishHint: string;
+                        specHint: string;
+                        refusedValues_one: string;
+                        refusedValues_other: string;
+                        datedPublishHint: string;
+                        datedSaveAndPublishHint: string;
+                        period: string;
+                        correction: string;
+                        newWording: string;
+                        firstDay: string;
+                        lastDay: string;
+                        lastDayHelp: string;
+                        computed: string;
+                        computedHint: string;
+                        computedRow: string;
+                        noComputed: string;
+                        carryForward: string;
+                        carryForwardHint: string;
+                        wording: string;
+                        wordingUntil: string;
+                        carryYes: string;
+                        carryNo: string;
+                        unanswered: string;
+                        previewFailed: string;
+                        covers: string;
+                    };
+                    effective: {
+                        title: string;
+                        hint: string;
+                        label: string;
+                        help: string;
+                        required: string;
+                        submit: string;
+                    };
                 };
             };
         };
@@ -3697,14 +3928,35 @@ export declare interface DirectEditPageProps {
     onDiscarded?: (changeSetId: string) => void;
 }
 
+/**
+ * What a Direct Edit's Publish of Dated Content would plan (#270), for its
+ * Publish dialog: nothing of it is written.
+ */
+export declare interface DirectEditPublishPreview {
+    /** Its Release's Validity Period; an empty last day is an open end. */
+    validityPeriod?: ValidityPeriod;
+    /** The Release it corrects and Supersedes; "" for a new wording. */
+    correctsReleaseId: string;
+    /** The date-only Releases contenthub derives, read-only. */
+    dateOnlyReleases: PlannedRelease[];
+    /** The later wordings Publish asks about, by first day. */
+    laterWordings: LaterWording[];
+}
+
 /** Why contenthub refused a Direct Edit (`DirectEditRefusedError.reason`). */
 export declare type DirectEditRefusal = 
-/** The Content is Dated, which a Direct Edit can't take yet. */
-"dated_content"
 /** A Direct Edit takes no second Chain, Branch, dependency or Source. */
-| "one_branch"
+"one_branch"
 /** The Change Set named is not a Direct Edit. */
 | "not_a_direct_edit"
+/** Another editor's Direct Edit holds the Content's Editing Block. */
+| "editing_blocked"
+/** The Direct Edit is someone else's: `editorId` names them. */
+| "not_the_editor"
+/** Force by a caller who has a Direct Edit of the Content of their own. */
+| "own_direct_edit"
+/** Force of a Direct Edit that holds no Editing Block any more. */
+| "no_editing_block"
 /** A reason this build doesn't know. */
 | "unknown";
 
@@ -3716,7 +3968,12 @@ export declare class DirectEditRefusedError extends Error {
     readonly reason: DirectEditRefusal;
     /** The Content it is about; "" where the refusal names none. */
     readonly contentId: string;
-    constructor(reason: DirectEditRefusal, message: string, contentId?: string);
+    /**
+     * For `editing_blocked`: the editor holding the Editing Block; for
+     * `not_the_editor`: the Direct Edit's editor; "" otherwise.
+     */
+    readonly editorId: string;
+    constructor(reason: DirectEditRefusal, message: string, contentId?: string, editorId?: string);
 }
 
 /** One edge of one Revision. */
@@ -3737,6 +3994,21 @@ export declare interface Edge {
 /** What kind of edge of the Content Graph (ADR 0009). */
 export declare type EdgeKind = "reference" | "toc" | "include" | "exclude" | "replace" | "annotate" | "link" | "footnote" | "anchor" | "media" | "blueprint" | "unspecified";
 
+/**
+ * The Block a Direct Edit sets on its Content (CONTEXT.md, Editing Block):
+ * "being edited by" its editor. It keeps out only other editors' Direct
+ * Edits, ends with its Direct Edit's Publish or Discard, and can't be
+ * lifted. It is independent of `block`: a Content can hold both.
+ */
+export declare interface EditingBlock {
+    /** The Direct Edit's editor, an odon user id. */
+    editorId: string;
+    /** The Direct Edit holding it. */
+    changeSetId: string;
+    /** ISO 8601. */
+    blockTime: string;
+}
+
 /**
  * Which ways of changing a Blueprint's Content the workspace offers (ADR
  * 0022, CONTEXT.md Editing Mode): Direct Edits only, Change Sets only, or
@@ -3762,6 +4034,12 @@ export declare interface EditingSettings {
     editingMode: EditingMode;
     /** Whether opening a Direct Edit sets an Editing Block on its Content. */
     editingBlock: boolean;
+    /**
+     * The Force Group: who may force an Editing Block (ADR 0022). The
+     * workspace's admins always may; these are the people beside them, by
+     * odon user id, sorted. Empty is the admins alone.
+     */
+    forceGroup: string[];
 }
 
 /** The editing settings in effect for one Blueprint, and which its override decides. */
@@ -3769,6 +4047,13 @@ export declare interface EffectiveEditingSettings {
     effective: EditingSettings;
     editingModeOverridden: boolean;
     editingBlockOverridden: boolean;
+    forceGroupOverridden: boolean;
+    /**
+     * Whether the caller is in the effective Force Group: an admin, or named
+     * by it. It is how a screen knows to offer Force (#269); the service
+     * asks the same when it is used.
+     */
+    callerInForceGroup: boolean;
 }
 
 /** One field that differs between two Revisions. */
@@ -3883,6 +4168,7 @@ export declare const i18nResources: {
                     mode: string;
                     block: string;
                     actions: string;
+                    force: string;
                 };
                 fromWorkspace: string;
                 createOverride: string;
@@ -3912,6 +4198,11 @@ export declare const i18nResources: {
                     save: string;
                     denied: string;
                     failed: string;
+                    force: string;
+                    forceHelp: string;
+                    forcePeople: string;
+                    forceNobody: string;
+                    forceOwn: string;
                 };
                 removeDialog: {
                     title: string;
@@ -3919,6 +4210,10 @@ export declare const i18nResources: {
                     confirm: string;
                     failed: string;
                 };
+                force: {
+                    adminsOnly: string;
+                    adminsAnd: string;
+                };
             };
             requiredChecks: {
                 create: string;
@@ -4840,6 +5135,18 @@ export declare const i18nResources: {
                     message: string;
                     confirm: string;
                 };
+                editingBlock: {
+                    beingEdited: string;
+                    force: string;
+                    forceConfirm: {
+                        title: string;
+                        message: string;
+                        confirm: string;
+                        failed: string;
+                        denied: string;
+                    };
+                    forced: string;
+                };
                 directEdit: {
                     unpublished: string;
                     continue: string;
@@ -4884,13 +5191,64 @@ export declare const i18nResources: {
                 refused_one: string;
                 refused_other: string;
                 refusedBecause: {
-                    dated_content: string;
                     one_branch: string;
                     not_a_direct_edit: string;
+                    editing_blocked: string;
+                    not_the_editor: string;
+                    own_direct_edit: string;
+                    no_editing_block: string;
                     unknown: string;
                 };
+                updateFromMain: string;
+                resolveMerge: string;
+                behind: {
+                    title: string;
+                    message: string;
+                };
+                pendingMerge: {
+                    title: string;
+                    message: string;
+                };
                 saveFirst: string;
                 changeSetsOnly: string;
+                saveAndPublish: string;
+                publishDialog: {
+                    title: string;
+                    publishHint: string;
+                    saveAndPublishHint: string;
+                    specHint: string;
+                    refusedValues_one: string;
+                    refusedValues_other: string;
+                    datedPublishHint: string;
+                    datedSaveAndPublishHint: string;
+                    period: string;
+                    correction: string;
+                    newWording: string;
+                    firstDay: string;
+                    lastDay: string;
+                    lastDayHelp: string;
+                    computed: string;
+                    computedHint: string;
+                    computedRow: string;
+                    noComputed: string;
+                    carryForward: string;
+                    carryForwardHint: string;
+                    wording: string;
+                    wordingUntil: string;
+                    carryYes: string;
+                    carryNo: string;
+                    unanswered: string;
+                    previewFailed: string;
+                    covers: string;
+                };
+                effective: {
+                    title: string;
+                    hint: string;
+                    label: string;
+                    help: string;
+                    required: string;
+                    submit: string;
+                };
             };
         };
     };
@@ -4965,6 +5323,7 @@ export declare const i18nResources: {
                     mode: string;
                     block: string;
                     actions: string;
+                    force: string;
                 };
                 fromWorkspace: string;
                 createOverride: string;
@@ -4994,6 +5353,11 @@ export declare const i18nResources: {
                     save: string;
                     denied: string;
                     failed: string;
+                    force: string;
+                    forceHelp: string;
+                    forcePeople: string;
+                    forceNobody: string;
+                    forceOwn: string;
                 };
                 removeDialog: {
                     title: string;
@@ -5001,6 +5365,10 @@ export declare const i18nResources: {
                     confirm: string;
                     failed: string;
                 };
+                force: {
+                    adminsOnly: string;
+                    adminsAnd: string;
+                };
             };
             requiredChecks: {
                 create: string;
@@ -5922,6 +6290,18 @@ export declare const i18nResources: {
                     message: string;
                     confirm: string;
                 };
+                editingBlock: {
+                    beingEdited: string;
+                    force: string;
+                    forceConfirm: {
+                        title: string;
+                        message: string;
+                        confirm: string;
+                        failed: string;
+                        denied: string;
+                    };
+                    forced: string;
+                };
                 directEdit: {
                     unpublished: string;
                     continue: string;
@@ -5966,13 +6346,64 @@ export declare const i18nResources: {
                 refused_one: string;
                 refused_other: string;
                 refusedBecause: {
-                    dated_content: string;
                     one_branch: string;
                     not_a_direct_edit: string;
+                    editing_blocked: string;
+                    not_the_editor: string;
+                    own_direct_edit: string;
+                    no_editing_block: string;
                     unknown: string;
                 };
+                updateFromMain: string;
+                resolveMerge: string;
+                behind: {
+                    title: string;
+                    message: string;
+                };
+                pendingMerge: {
+                    title: string;
+                    message: string;
+                };
                 saveFirst: string;
                 changeSetsOnly: string;
+                saveAndPublish: string;
+                publishDialog: {
+                    title: string;
+                    publishHint: string;
+                    saveAndPublishHint: string;
+                    specHint: string;
+                    refusedValues_one: string;
+                    refusedValues_other: string;
+                    datedPublishHint: string;
+                    datedSaveAndPublishHint: string;
+                    period: string;
+                    correction: string;
+                    newWording: string;
+                    firstDay: string;
+                    lastDay: string;
+                    lastDayHelp: string;
+                    computed: string;
+                    computedHint: string;
+                    computedRow: string;
+                    noComputed: string;
+                    carryForward: string;
+                    carryForwardHint: string;
+                    wording: string;
+                    wordingUntil: string;
+                    carryYes: string;
+                    carryNo: string;
+                    unanswered: string;
+                    previewFailed: string;
+                    covers: string;
+                };
+                effective: {
+                    title: string;
+                    hint: string;
+                    label: string;
+                    help: string;
+                    required: string;
+                    submit: string;
+                };
             };
         };
     };
@@ -5983,6 +6414,12 @@ export declare class InvalidInputError extends Error {
     constructor(message: string);
 }
 
+/** A later wording a Direct Edit's change may carry into (#270). */
+export declare interface LaterWording {
+    releaseId: string;
+    validityPeriod?: ValidityPeriod;
+}
+
 /**
  * The port a host fills with mediahub (ADR 0020), in fieldkit's
  * media-adapter shape: a media field's picker browses and uploads through