@knkcs/contenthub-ui 0.4.0 → 0.5.0

package/dist/testing.d.ts

@@ -21,6 +21,8 @@ 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;
 }
@@ -83,6 +85,13 @@ declare interface BlueprintSource {
 /** What a Branch is for: one an editor works on, or a Carry-forward link. */
 declare type BranchKind = "editorial" | "carry_forward";
 
+/** Whether a Direct Edit's change carries forward into one later wording (#270). */
+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). */
 declare interface ChainPreview {
     /** The Release it would fork from; "" in a gap. */
@@ -328,6 +337,8 @@ 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;
 }
 
 /**
@@ -625,6 +636,8 @@ 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: {
@@ -889,11 +902,20 @@ 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<{
@@ -901,17 +923,63 @@ 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`
@@ -921,6 +989,23 @@ 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;
@@ -1081,6 +1166,21 @@ export declare function createStubContenthubClient(options?: StubContenthubClien
 
 export declare function createStubStatusSource(statuses?: ChangeSetStatusInfo[]): StatusSource;
 
+/**
+ * What a Direct Edit's Publish of Dated Content would plan (#270), for its
+ * Publish dialog: nothing of it is written.
+ */
+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[];
+}
+
 /** One edge of one Revision. */
 declare interface Edge {
     sourceContentId: string;
@@ -1099,6 +1199,21 @@ declare interface Edge {
 /** What kind of edge of the Content Graph (ADR 0009). */
 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.
+ */
+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
@@ -1112,6 +1227,12 @@ 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. */
@@ -1119,6 +1240,13 @@ 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. */
@@ -1147,6 +1275,12 @@ declare interface GapReferrer {
     releaseId: string;
 }
 
+/** A later wording a Direct Edit's change may carry into (#270). */
+declare interface LaterWording {
+    releaseId: string;
+    validityPeriod?: ValidityPeriod;
+}
+
 /** One field a merge resolution must decide, with each side's value. */
 declare interface MergeField {
     /** "/" and the field's accessor, as a Violation spells it. */
@@ -1552,6 +1686,8 @@ export declare interface StubContent {
     assigneeIds?: string[];
     /** Its Block; absent while it is not blocked. */
     block?: ContentBlock;
+    /** Its Editing Block; absent while no open Direct Edit holds one. */
+    editingBlock?: EditingBlock;
     /** When it was archived, ISO 8601; absent while it is not Archived. */
     archiveTime?: string;
     /** Its Main head; absent while it was born in an open Change Set. */
@@ -1629,6 +1765,13 @@ export declare interface StubContenthubClientOptions {
      * derive (moved_head, the dependencies', outstanding_check).
      */
     publishBlockers?: Record<string, PublishBlocker[]>;
+    /**
+     * The Branches behind their base, by id, as a Change Set published past
+     * them leaves them (#268): `validatePublish` and `publish` report
+     * behind_base for each until `updateFromMain` merges it or a resolution
+     * of its Pending Merge does. An aborted merge leaves it behind.
+     */
+    behind?: string[];
     /** The Pending Merges `updateFromMain` leaves, by Change Set id; none by default. */
     pendingMerges?: Record<string, PendingMergeRef[]>;
     /**
@@ -1673,9 +1816,12 @@ export declare interface StubContenthubClientOptions {
     now?: () => string;
     /**
      * The workspace's own editing settings; "Change Sets only" without an
-     * Editing Block by default, as for a workspace that never set them.
+     * Editing Block by default, as for a workspace that never set them. A
+     * Force Group left out is the admins alone.
      */
-    editingSettings?: EditingSettings;
+    editingSettings?: Omit<EditingSettings, "forceGroup"> & {
+        forceGroup?: string[];
+    };
     /** The per-Blueprint overrides of the editing settings; none by default. */
     editingOverrides?: StubEditingOverride[];
 }
@@ -1693,6 +1839,8 @@ export declare interface StubEditingOverride {
     blueprintAccessor: string;
     editingMode: EditingMode | null;
     editingBlock: boolean | null;
+    /** The people beside the admins; null follows the workspace's. Absent is null. */
+    forceGroup?: string[] | null;
 }
 
 /** One head of a Content: its Revision, data and when it was written. */