@camox/api-contract 0.51.0 → 0.52.2

package/dist/drafts.d.ts

@@ -6,6 +6,20 @@ export declare const DRAFT_HEADER = "x-camox-draft";
  * 0015). Absent means the project's default locale.
  */
 export declare const LOCALE_HEADER = "x-camox-locale";
+/**
+ * Request header the Worker a publish with code uploaded sends on its public reads, naming
+ * the draft it publishes (spec #560, section 13). While that draft is in its publishing state, a
+ * read naming it sees Live overlaid with the draft, with no session, so the new code serves the
+ * content it was previewed with from its first request. Once the draft has ended, or if it isn't
+ * publishing, the read is Live's. A request naming a draft with `DRAFT_HEADER` ignores it.
+ */
+export declare const PUBLISHING_DRAFT_HEADER = "x-camox-publishing-draft";
+/**
+ * The Worker variable carrying the publishing draft's ID, which the publish sets on the Worker it
+ * uploads (apps/api/src/domains/publishes/scripts.ts). The website's Worker sends it as
+ * `PUBLISHING_DRAFT_HEADER`.
+ */
+export declare const PUBLISHING_DRAFT_VAR = "CAMOX_PUBLISHING_DRAFT";
 /**
  * Request header asking the API to create the draft named by `DRAFT_HEADER` if it doesn't
  * exist yet. Its value is `"1"`.
@@ -47,6 +61,21 @@ export declare const DRAFT_ENDED_ERROR_CODE = "DRAFT_ENDED";
  * preview, so nothing was applied and the caller reviews the new preview.
  */
 export declare const CONFLICTS_CHANGED_ERROR = "CONFLICTS_CHANGED";
+/**
+ * oRPC error code for a publish of a draft with code whose revision isn't the one the review
+ * showed: the agent left a newer one, or the draft is already publishing. The caller reviews
+ * the new preview.
+ */
+export declare const REVISION_CHANGED_ERROR = "REVISION_CHANGED";
+/**
+ * Why a publish with code went back to the review instead of landing: the agent left a revision
+ * after the one the review showed, Live's conflicts changed, the draft got a blocker, Live's code
+ * moved and the draft's merge of it clashed (the "doesn't merge with Live's" blocker, which
+ * Camox's turn fixes), Live's code moved and the draft took too long to merge it, or the publish
+ * failed on Camox's side.
+ */
+export declare const PUBLISH_ABORT_REASONS: readonly ["revisionChanged", "conflictsChanged", "blocked", "codeDoesNotMerge", "liveCodeMoved", "failed"];
+export type PublishAbortReason = (typeof PUBLISH_ABORT_REASONS)[number];
 /** oRPC error code for a publish refused because the draft still has blockers. */
 export declare const PUBLISH_BLOCKED_ERROR = "PUBLISH_BLOCKED";
 /**
@@ -57,12 +86,13 @@ export declare const TRANSLATIONS_PENDING_ERROR = "TRANSLATIONS_PENDING";
 /**
  * Why the publish tool published nothing of a draft with changes, and returned a fresh preview to
  * review again, by the error code of each: Live changed since the preview, the draft has blockers,
- * or translations are still running.
+ * translations are still running, or the draft's code changed since the preview.
  */
 export declare const NOT_PUBLISHED_CODES: {
   readonly conflictsChanged: "CONFLICTS_CHANGED";
   readonly blocked: "PUBLISH_BLOCKED";
   readonly translating: "TRANSLATIONS_PENDING";
+  readonly revisionChanged: "REVISION_CHANGED";
 };
 export type NotPublishedReason = keyof typeof NOT_PUBLISHED_CODES;
 /**

package/dist/drafts.js

@@ -7,6 +7,20 @@ const DRAFT_HEADER = "x-camox-draft";
 */
 const LOCALE_HEADER = "x-camox-locale";
 /**
+* Request header the Worker a publish with code uploaded sends on its public reads, naming
+* the draft it publishes (spec #560, section 13). While that draft is in its publishing state, a
+* read naming it sees Live overlaid with the draft, with no session, so the new code serves the
+* content it was previewed with from its first request. Once the draft has ended, or if it isn't
+* publishing, the read is Live's. A request naming a draft with `DRAFT_HEADER` ignores it.
+*/
+const PUBLISHING_DRAFT_HEADER = "x-camox-publishing-draft";
+/**
+* The Worker variable carrying the publishing draft's ID, which the publish sets on the Worker it
+* uploads (apps/api/src/domains/publishes/scripts.ts). The website's Worker sends it as
+* `PUBLISHING_DRAFT_HEADER`.
+*/
+const PUBLISHING_DRAFT_VAR = "CAMOX_PUBLISHING_DRAFT";
+/**
 * Request header asking the API to create the draft named by `DRAFT_HEADER` if it doesn't
 * exist yet. Its value is `"1"`.
 */
@@ -33,6 +47,27 @@ const DRAFT_ENDED_ERROR_CODE = "DRAFT_ENDED";
 * preview, so nothing was applied and the caller reviews the new preview.
 */
 const CONFLICTS_CHANGED_ERROR = "CONFLICTS_CHANGED";
+/**
+* oRPC error code for a publish of a draft with code whose revision isn't the one the review
+* showed: the agent left a newer one, or the draft is already publishing. The caller reviews
+* the new preview.
+*/
+const REVISION_CHANGED_ERROR = "REVISION_CHANGED";
+/**
+* Why a publish with code went back to the review instead of landing: the agent left a revision
+* after the one the review showed, Live's conflicts changed, the draft got a blocker, Live's code
+* moved and the draft's merge of it clashed (the "doesn't merge with Live's" blocker, which
+* Camox's turn fixes), Live's code moved and the draft took too long to merge it, or the publish
+* failed on Camox's side.
+*/
+const PUBLISH_ABORT_REASONS = [
+	"revisionChanged",
+	"conflictsChanged",
+	"blocked",
+	"codeDoesNotMerge",
+	"liveCodeMoved",
+	"failed"
+];
 /** oRPC error code for a publish refused because the draft still has blockers. */
 const PUBLISH_BLOCKED_ERROR = "PUBLISH_BLOCKED";
 /**
@@ -43,12 +78,13 @@ const TRANSLATIONS_PENDING_ERROR = "TRANSLATIONS_PENDING";
 /**
 * Why the publish tool published nothing of a draft with changes, and returned a fresh preview to
 * review again, by the error code of each: Live changed since the preview, the draft has blockers,
-* or translations are still running.
+* translations are still running, or the draft's code changed since the preview.
 */
 const NOT_PUBLISHED_CODES = {
 	conflictsChanged: CONFLICTS_CHANGED_ERROR,
 	blocked: PUBLISH_BLOCKED_ERROR,
-	translating: TRANSLATIONS_PENDING_ERROR
+	translating: TRANSLATIONS_PENDING_ERROR,
+	revisionChanged: REVISION_CHANGED_ERROR
 };
 /**
 * Who Camox's own work is by: the creator of the drafts it opens to catch translations up, their
@@ -143,4 +179,4 @@ function isContentWrite(path) {
 }
 
 //#endregion
-export { CAMOX_ACTOR, CAMOX_NAME, CONFLICTS_CHANGED_ERROR, DEVELOPMENT_DRAFT, DRAFT_CREATE_HEADER, DRAFT_ENDED_ERROR_CODE, DRAFT_HEADER, DRAFT_SEARCH_PARAM, LIVE_READ_ONLY_ERROR, LOCALE_HEADER, NOT_PUBLISHED_CODES, NO_DEVELOPMENT_DRAFT_ERROR, PUBLISH_BLOCKED_ERROR, TRANSLATIONS_PENDING_ERROR, isContentWrite };
+export { CAMOX_ACTOR, CAMOX_NAME, CONFLICTS_CHANGED_ERROR, DEVELOPMENT_DRAFT, DRAFT_CREATE_HEADER, DRAFT_ENDED_ERROR_CODE, DRAFT_HEADER, DRAFT_SEARCH_PARAM, LIVE_READ_ONLY_ERROR, LOCALE_HEADER, NOT_PUBLISHED_CODES, NO_DEVELOPMENT_DRAFT_ERROR, PUBLISHING_DRAFT_HEADER, PUBLISHING_DRAFT_VAR, PUBLISH_ABORT_REASONS, PUBLISH_BLOCKED_ERROR, REVISION_CHANGED_ERROR, TRANSLATIONS_PENDING_ERROR, isContentWrite };

package/dist/query-keys.d.ts

@@ -65,6 +65,16 @@ export type InvalidationMessage = {
 export type DraftEndedMessage = {
   type: "draftEnded";
 } & EndedDraft;
+/** A draft with code has a new revision, built with Camox's `sdkVersion`. */
+export type RevisionAnnouncement = {
+  draftId: string;
+  revisionId: string;
+  sdkVersion: string;
+};
+/** A draft's new revision: its viewers' frames load it. */
+export type RevisionMessage = {
+  type: "revision";
+} & RevisionAnnouncement;
 /** Everything the project room broadcasts. */
-export type ProjectRoomMessage = InvalidationMessage | DraftEndedMessage;
+export type ProjectRoomMessage = InvalidationMessage | DraftEndedMessage | RevisionMessage;
 //#endregion