@camox/api-contract 0.74.1 → 0.76.0

package/dist/drafts.d.ts

@@ -136,6 +136,23 @@ export type EndedDraft = {
   };
   endedAt: number;
 };
+/**
+ * A draft set aside without ending it (ADR 0046): who archived it, a member or Camox, and when.
+ * It keeps its id, changes, thread and code until it's restored or deleted.
+ */
+export type ArchivedDraft = {
+  draftId: string;
+  archivedBy: {
+    id: string;
+    name: string;
+  };
+  archivedAt: number;
+};
+/**
+ * The oRPC error code a request naming an archived draft fails with: its `data` is an
+ * `ArchivedDraft`. Nothing reads or writes the draft until it's restored.
+ */
+export declare const DRAFT_ARCHIVED_ERROR_CODE = "DRAFT_ARCHIVED";
 /**
  * The oRPC error code a request naming an ended draft fails with. Its `data` is an `EndedDraft`,
  * so a page can render Live and say who published or deleted the draft.

package/dist/drafts.js

@@ -86,6 +86,11 @@ const DRAFT_CREATE_HEADER = "x-camox-draft-create";
 /** URL search param carrying the current draft's id in the studio and the rendered site. */
 const DRAFT_SEARCH_PARAM = "camox-draft";
 /**
+* The oRPC error code a request naming an archived draft fails with: its `data` is an
+* `ArchivedDraft`. Nothing reads or writes the draft until it's restored.
+*/
+const DRAFT_ARCHIVED_ERROR_CODE = "DRAFT_ARCHIVED";
+/**
 * The oRPC error code a request naming an ended draft fails with. Its `data` is an `EndedDraft`,
 * so a page can render Live and say who published or deleted the draft.
 */
@@ -230,4 +235,4 @@ function isContentWrite(path) {
 }
 
 //#endregion
-export { ARTIFACT_FIELD_ATTRIBUTE, ARTIFACT_ITEM_ATTRIBUTE, CAMOX_ACTOR, CAMOX_NAME, DRAFT_CREATE_HEADER, DRAFT_ENDED_ERROR_CODE, DRAFT_HEADER, DRAFT_SEARCH_PARAM, LIVE_READ_ONLY_ERROR, LOCALE_HEADER, LOOK_ARTIFACT_CAPTURE, LOOK_BLOCKS_PARAM, LOOK_BLOCK_DEFINITION_PARAM, LOOK_CONTENT_PARAM, LOOK_DOCUMENT_PATH, LOOK_LAYOUT_DEFINITION_PARAM, LOOK_LOCALE_PARAM, LOOK_PATH_PARAM, LOOK_PLACEHOLDER_HEIGHTS, LOOK_PLACEHOLDER_PARAM, LOOK_SETTINGS_PARAM, LOOK_TOKEN_COOKIE, LOOK_TOKEN_HEADER, NOT_PUBLISHED_CODES, PUBLISHING_DRAFT_HEADER, PUBLISHING_DRAFT_VAR, PUBLISH_ABORT_REASONS, PUBLISH_BLOCKED_ERROR, REVISION_CHANGED_ERROR, UNPLACED_BLOCK_ID, isContentWrite, lookArtifactSelector };
+export { ARTIFACT_FIELD_ATTRIBUTE, ARTIFACT_ITEM_ATTRIBUTE, CAMOX_ACTOR, CAMOX_NAME, DRAFT_ARCHIVED_ERROR_CODE, DRAFT_CREATE_HEADER, DRAFT_ENDED_ERROR_CODE, DRAFT_HEADER, DRAFT_SEARCH_PARAM, LIVE_READ_ONLY_ERROR, LOCALE_HEADER, LOOK_ARTIFACT_CAPTURE, LOOK_BLOCKS_PARAM, LOOK_BLOCK_DEFINITION_PARAM, LOOK_CONTENT_PARAM, LOOK_DOCUMENT_PATH, LOOK_LAYOUT_DEFINITION_PARAM, LOOK_LOCALE_PARAM, LOOK_PATH_PARAM, LOOK_PLACEHOLDER_HEIGHTS, LOOK_PLACEHOLDER_PARAM, LOOK_SETTINGS_PARAM, LOOK_TOKEN_COOKIE, LOOK_TOKEN_HEADER, NOT_PUBLISHED_CODES, PUBLISHING_DRAFT_HEADER, PUBLISHING_DRAFT_VAR, PUBLISH_ABORT_REASONS, PUBLISH_BLOCKED_ERROR, REVISION_CHANGED_ERROR, UNPLACED_BLOCK_ID, isContentWrite, lookArtifactSelector };

package/dist/query-keys.d.ts

@@ -1,4 +1,4 @@
-import { EndedDraft } from "./drafts.js";
+import { ArchivedDraft, EndedDraft } from "./drafts.js";
 //#region src/query-keys.d.ts
 /**
  * Use TypeScript to enforce 'camox' as the first query key to ensure they're all namespaced.
@@ -39,6 +39,12 @@ export declare const queryKeys: {
     all: ["camox", string];
     list: ["camox", string, string];
     get: ["camox", string, string];
+    archived: ["camox", string, string];
+  };
+  publications: {
+    all: ["camox", string];
+    list: ["camox", string, string];
+    get: ["camox", string, string];
   };
   specialists: {
     get: ["camox", string];
@@ -71,6 +77,10 @@ export type InvalidationMessage = {
 export type DraftEndedMessage = {
   type: "draftEnded";
 } & EndedDraft;
+/** A draft was archived: its viewers go back to Live (ADR 0046). */
+export type DraftArchivedMessage = {
+  type: "draftArchived";
+} & ArchivedDraft;
 /** A draft with code has a new revision, built with Camox's `sdkVersion`. */
 export type RevisionAnnouncement = {
   draftId: string;
@@ -82,5 +92,5 @@ export type RevisionMessage = {
   type: "revision";
 } & RevisionAnnouncement;
 /** Everything the project room broadcasts. */
-export type ProjectRoomMessage = InvalidationMessage | DraftEndedMessage | RevisionMessage;
+export type ProjectRoomMessage = InvalidationMessage | DraftEndedMessage | DraftArchivedMessage | RevisionMessage;
 //#endregion

package/dist/query-keys.js

@@ -97,6 +97,24 @@ const queryKeys = {
 			"camox",
 			"drafts",
 			"get"
+		],
+		archived: [
+			"camox",
+			"drafts",
+			"archived"
+		]
+	},
+	publications: {
+		all: ["camox", "publications"],
+		list: [
+			"camox",
+			"publications",
+			"list"
+		],
+		get: [
+			"camox",
+			"publications",
+			"get"
 		]
 	},
 	specialists: { get: ["camox", "specialists"] },