@knkcs/contenthub-ui 0.4.0 → 0.6.0

package/dist/testing.d.ts

@@ -21,15 +21,27 @@ 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;
 }
 
-/** A content Blueprint, as the `BlueprintSource` port names it. */
+/** A Blueprint, as the `BlueprintSource` port names it. */
 declare interface BlueprintInfo {
     id: string;
     /** What editors call it. */
     name: string;
+    /**
+     * Its accessor, unique in the workspace for good: what workspace
+     * configuration names it by (ADR 0023).
+     */
+    accessor: string;
+    /**
+     * Whether it is archived. Search never offers an archived Blueprint;
+     * naming one by id or accessor does, marked. Absent means not archived.
+     */
+    archived?: boolean;
 }
 
 /** One page of `BlueprintSource.searchBlueprints`. */
@@ -57,8 +69,8 @@ declare interface BlueprintReleaseInfo {
 }
 
 /**
- * The workspace's content Blueprints and their Releases, for New Content and
- * the Library's Blueprint filter. contenthub serves them itself
+ * The workspace's content Blueprints and their Releases, for New Content, the
+ * Library's Blueprint filter and the configuration that names Blueprints. contenthub serves them itself
  * (`BlueprintCatalogService`, #238): blueprinthub is its direct dependency,
  * not a port a host fills (ADR 0020 as amended), so every screen builds this
  * from its `ContenthubClient` unless a host passes its own, which only tests
@@ -66,16 +78,24 @@ declare interface BlueprintReleaseInfo {
  */
 declare interface BlueprintSource {
     /**
-     * Unarchived content Blueprints whose name holds `query` (every one for
-     * ""), by name. `signal` aborts a search the user has moved on from.
+     * Unarchived content Blueprints with a Release whose name holds `query`
+     * (every one for ""), by name; with `includeWithoutRelease`, those
+     * without a Release too. `signal` aborts a search the user has moved on
+     * from.
      */
     searchBlueprints(input: {
         query: string;
         pageToken?: string;
+        includeWithoutRelease?: boolean;
         signal?: AbortSignal;
     }): Promise<BlueprintPage>;
     /** The Blueprints of these ids, archived ones too; an unknown id is left out. */
     getBlueprints(ids: string[]): Promise<BlueprintInfo[]>;
+    /**
+     * The Blueprints of these accessors, archived ones too; an accessor of no
+     * Blueprint is left out.
+     */
+    getBlueprintsByAccessor(accessors: string[]): Promise<BlueprintInfo[]>;
     /** Every Release of a Blueprint, newest first; empty while none has been cut. */
     listReleases(blueprintId: string): Promise<BlueprintReleaseInfo[]>;
 }
@@ -83,6 +103,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 +355,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;
 }
 
 /**
@@ -552,11 +581,18 @@ declare interface ContenthubClient {
     listRequiredChecks(): Promise<RequiredCheck[]>;
     /**
      * Declares a Required Check; it gates every open Change Set at once.
-     * Rejects with `NameTakenError` when another check has the name, and
-     * `InvalidInputError` for anything else the service refuses.
+     * Rejects with `NameTakenError` when another check has the name,
+     * `BlueprintAccessorsRefusedError` for accessors naming no content
+     * Blueprint taking new work, `ServiceUnavailableError` while they can't
+     * be checked, and `InvalidInputError` for anything else the service
+     * refuses.
      */
     createRequiredCheck(input: RequiredCheckInput): Promise<RequiredCheck>;
-    /** Replaces every field of a Required Check; its id stays. Rejects as create does. */
+    /**
+     * Replaces every field of a Required Check; its id stays. Rejects as
+     * create does, checking only the accessors it adds: one the check names
+     * already passes whatever its Blueprint's state now.
+     */
     updateRequiredCheck(input: RequiredCheckInput & {
         id: string;
     }): Promise<RequiredCheck>;
@@ -619,12 +655,17 @@ declare interface ContenthubClient {
     /**
      * Replaces one Blueprint's override; admin only. A null field follows the
      * workspace's, and at least one must be set. Rejects as
-     * `setEditingSettings` does.
+     * `setEditingSettings` does, and adding an override with
+     * `BlueprintAccessorsRefusedError` for an accessor naming no content
+     * Blueprint taking new work, `ServiceUnavailableError` while it can't be
+     * checked.
      */
     setBlueprintEditingOverride(input: {
         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: {
@@ -731,12 +772,16 @@ declare interface ContenthubClient {
     /**
      * A page of the workspace's content Blueprints Content can be made from:
      * not archived, with at least one Release, whose accessor or name holds
-     * `query`. contenthub asks blueprinthub as the caller (#238). Rejects
-     * with `ServiceUnavailableError` while blueprinthub gives no answer.
+     * `query`. With `includeWithoutRelease`, those without a Release too, for
+     * configuration that names a Blueprint before its first Release (ADR
+     * 0023); never an archived one. contenthub asks blueprinthub as the
+     * caller (#238). Rejects with `ServiceUnavailableError` while blueprinthub
+     * gives no answer.
      */
     searchBlueprints(input: {
         query: string;
         pageToken?: string;
+        includeWithoutRelease?: boolean;
         signal?: AbortSignal;
     }): Promise<BlueprintPage>;
     /**
@@ -754,6 +799,14 @@ declare interface ContenthubClient {
      * `ServiceUnavailableError` while blueprinthub gives no answer.
      */
     getBlueprints(ids: string[]): Promise<BlueprintInfo[]>;
+    /**
+     * Names the Blueprints of these accessors, as workspace configuration
+     * names them (ADR 0023): archived ones and ones without a Release
+     * included. An accessor of no Blueprint, or of one of another workspace,
+     * is left out. At most `MAX_BLUEPRINT_IDS`. Rejects with
+     * `ServiceUnavailableError` while blueprinthub gives no answer.
+     */
+    getBlueprintsByAccessor(accessors: string[]): Promise<BlueprintInfo[]>;
     /**
      * Creates a Content in an open Change Set, pinning a Blueprint Release,
      * with empty data: its one Chain has one Branch, opened in the Branch
@@ -889,11 +942,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 +963,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 +1029,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 +1206,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 +1239,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 +1267,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 +1280,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 +1315,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. */
@@ -1376,8 +1550,18 @@ declare interface RequiredCheck {
 declare interface RequiredCheckInput {
     name: string;
     scope: CheckScope;
-    /** Blueprint accessors; empty for every Blueprint. */
+    /**
+     * Blueprint accessors, empty exactly when `everyBlueprint` is set. Each
+     * one the write adds must name a content Blueprint of the workspace that
+     * is not archived (ADR 0023).
+     */
     blueprintAccessors: string[];
+    /**
+     * Applies the check to every Blueprint. A switch of its own: no accessors
+     * without it is refused, so clearing the last Blueprint never widens a
+     * check to every Publish.
+     */
+    everyBlueprint: boolean;
     independent: boolean;
 }
 
@@ -1552,6 +1736,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. */
@@ -1596,13 +1782,13 @@ export declare interface StubContenthubClientOptions {
     /** The workspace's Content, every way it can be read; the fixtures' by default. */
     contents?: StubContent[];
     /**
-     * The workspace's content Blueprints, as `getBlueprints` names them;
-     * the fixtures' by default. `searchBlueprints` lists those Content can
-     * be made from: not `archived`, with a Release.
+     * The workspace's content Blueprints, as `getBlueprints` and
+     * `getBlueprintsByAccessor` name them; the fixtures' by default.
+     * `searchBlueprints` lists those Content can be made from: not
+     * `archived`, with a Release — or, with `includeWithoutRelease`, any not
+     * `archived`.
      */
-    blueprints?: (BlueprintInfo & {
-        archived?: boolean;
-    })[];
+    blueprints?: BlueprintInfo[];
     /**
      * The Blueprint Releases, newest first per Blueprint, as
      * `listBlueprintReleases` lists them; the fixtures' by default.
@@ -1613,9 +1799,9 @@ export declare interface StubContenthubClientOptions {
     /** The Resolved Releases `getContent` answers with, by Blueprint Release id; the fixtures' by default. */
     resolvedReleases?: Record<string, ResolvedBlueprintRelease>;
     /**
-     * The workspace's Required Checks; the fixtures' by default. The stub
-     * reads `blueprintAccessors` as Blueprint ids, the one name its Content
-     * carries.
+     * The workspace's Required Checks; the fixtures' by default. A check
+     * covers a Content whose Blueprint (in `blueprints`) has one of its
+     * `blueprintAccessors`.
      */
     requiredChecks?: RequiredCheck[];
     /** Check Results recorded before, in the order they were recorded. */
@@ -1629,6 +1815,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 +1866,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 +1889,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. */