@knkcs/contenthub-ui 0.1.0 → 0.3.0

package/dist/testing.d.ts

@@ -36,14 +36,22 @@ declare interface BlueprintReleaseInfo {
     name: string;
     /** ISO 8601: when it was cut. */
     releaseTime: string;
+    /**
+     * Why contenthub refuses to pin it, as `CheckBlueprintRelease` answers;
+     * empty or absent when Content can pin it. A Release is offered either
+     * way, a refused one disabled with its reasons, so a Blueprint author sees
+     * why it can't be used rather than where it went.
+     */
+    refusals?: RefusalReason[];
 }
 
 /**
- * The port a host fills with blueprinthub (ADR 0020): the workspace's
- * content Blueprints and their Releases, for New Content and the Library's
- * Blueprint filter. contenthub-ui depends on no blueprinthub package. A host
- * without blueprinthub leaves the port empty: the Library then names
- * Blueprints by id, offers no Blueprint filter and cannot create Content.
+ * The workspace's content Blueprints and their Releases, for New Content and
+ * the Library's Blueprint filter. 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
+ * need.
  */
 declare interface BlueprintSource {
     /**
@@ -634,6 +642,32 @@ declare interface ContenthubClient {
         pageSize?: number;
         pageToken?: string;
     }): Promise<ContentList>;
+    /**
+     * 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.
+     */
+    searchBlueprints(input: {
+        query: string;
+        pageToken?: string;
+        signal?: AbortSignal;
+    }): Promise<BlueprintPage>;
+    /**
+     * Every Release of a Blueprint, newest first, each with contenthub's
+     * answer: `refusals` is empty when Content can pin it. Empty for a
+     * Blueprint the workspace doesn't have. Rejects with
+     * `ServiceUnavailableError` while blueprinthub gives no answer.
+     */
+    listBlueprintReleases(blueprintId: string): Promise<BlueprintReleaseInfo[]>;
+    /**
+     * Names the Blueprints of these ids, archived ones and ones without a
+     * Release included, so existing Content stays readable after its
+     * Blueprint is retired (#241). An unknown id, or one of another
+     * workspace, is left out. At most `MAX_BLUEPRINT_IDS`. Rejects with
+     * `ServiceUnavailableError` while blueprinthub gives no answer.
+     */
+    getBlueprints(ids: 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
@@ -1152,6 +1186,16 @@ declare interface ReferrerList {
     nextPageToken: string;
 }
 
+/** One reason contenthub refused a write, as the rule's owner gave it. */
+declare interface RefusalReason {
+    /** Whose rule: "fieldkit", "knkeditor", "format" or "contenthub". */
+    source: string;
+    /** The rule's own code, such as fieldkit's "required". */
+    code: string;
+    /** A /-separated location, such as "/title"; "" for the whole. */
+    path: string;
+}
+
 /** A Release a Publish cut, or would cut. */
 declare interface Release {
     id: string;
@@ -1303,8 +1347,9 @@ export declare function stubBlockReasons(): BlockReason[];
 export declare function stubBlueprintReleases(): BlueprintReleaseInfo[];
 
 /**
- * The workspace's content Blueprints, as the `BlueprintSource` port answers,
- * by name. Commentary has had no Release cut yet.
+ * The workspace's content Blueprints, as a `BlueprintSource` answers, by
+ * name. Commentary has had no Release cut yet, so contenthub's catalog
+ * (the stub client's `searchBlueprints`) leaves it out.
  */
 export declare function stubBlueprints(): BlueprintInfo[];
 
@@ -1397,13 +1442,20 @@ export declare interface StubContenthubClientOptions {
     /** The workspace's Content, every way it can be read; the fixtures' by default. */
     contents?: StubContent[];
     /**
-     * The Blueprint Releases contenthub can load, which `createContent`
-     * accepts; the fixtures' by default.
+     * 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.
      */
-    blueprintReleases?: {
-        id: string;
-        blueprintId: string;
-    }[];
+    blueprints?: (BlueprintInfo & {
+        archived?: boolean;
+    })[];
+    /**
+     * The Blueprint Releases, newest first per Blueprint, as
+     * `listBlueprintReleases` lists them; the fixtures' by default.
+     * `createContent` pins one without `refusals` and refuses the rest, as
+     * contenthub refuses a Release it can't load.
+     */
+    blueprintReleases?: (Pick<BlueprintReleaseInfo, "id" | "blueprintId"> & Partial<BlueprintReleaseInfo>)[];
     /** The Resolved Releases `getContent` answers with, by Blueprint Release id; the fixtures' by default. */
     resolvedReleases?: Record<string, ResolvedBlueprintRelease>;
     /**