@knkcs/contenthub-ui 0.5.0 → 0.6.0

package/dist/testing.d.ts

@@ -27,11 +27,21 @@ declare interface BlueprintEditingOverride {
     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`. */
@@ -59,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
@@ -68,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[]>;
 }
@@ -563,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>;
@@ -630,7 +655,10 @@ 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;
@@ -744,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>;
     /**
@@ -767,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
@@ -1510,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;
 }
 
@@ -1732,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.
@@ -1749,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. */