@camox/api-contract 0.72.0 → 0.75.0

package/dist/claim-links.d.ts

@@ -0,0 +1,17 @@
+//#region src/claim-links.d.ts
+/** URL search param carrying a Claim Link's token on the website it links to. */
+export declare const CLAIM_LINK_SEARCH_PARAM = "camox-claim";
+/**
+ * Where a Claim Link stands: `open` until it's claimed, revoked by an operator, or blocked, when a
+ * claim was refused because someone who isn't an operator joined its organization (ADR 0041).
+ */
+export type ClaimLinkState = "open" | "claimed" | "revoked" | "blocked";
+/**
+ * A Claim Link: the project's address, its Custom Domain if it has one, else its `camox.site`
+ * subdomain, with the link's token.
+ */
+export declare function claimLinkUrl(project: {
+  slug: string;
+  customDomain: string | null;
+}, token: string): string;
+//#endregion

package/dist/claim-links.js

@@ -0,0 +1,17 @@
+import { projectWebsiteUrl } from "./projects.js";
+
+//#region src/claim-links.ts
+/** URL search param carrying a Claim Link's token on the website it links to. */
+const CLAIM_LINK_SEARCH_PARAM = "camox-claim";
+/**
+* A Claim Link: the project's address, its Custom Domain if it has one, else its `camox.site`
+* subdomain, with the link's token.
+*/
+function claimLinkUrl(project, token) {
+	const url = new URL("/", projectWebsiteUrl(project));
+	url.searchParams.set(CLAIM_LINK_SEARCH_PARAM, token);
+	return url.toString();
+}
+
+//#endregion
+export { CLAIM_LINK_SEARCH_PARAM, claimLinkUrl };

package/dist/drafts.d.ts

@@ -141,11 +141,6 @@ export type EndedDraft = {
  * so a page can render Live and say who published or deleted the draft.
  */
 export declare const DRAFT_ENDED_ERROR_CODE = "DRAFT_ENDED";
-/**
- * oRPC error code for a publish whose token no longer matches Live: Live changed since the
- * 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
@@ -154,42 +149,22 @@ export declare const CONFLICTS_CHANGED_ERROR = "CONFLICTS_CHANGED";
 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.
+ * after the one the review showed, 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.
+ * `conflictsChanged` is only stored by publishes before ADR 0043, which aborted when Live changed.
  */
-export declare const PUBLISH_ABORT_REASONS: readonly ["revisionChanged", "conflictsChanged", "blocked", "codeDoesNotMerge", "liveCodeMoved", "failed"];
+export declare const PUBLISH_ABORT_REASONS: readonly ["revisionChanged", "conflictsChanged", "blocked", "codeDoesNotBuild", "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";
-/**
- * oRPC error code for a publish refused because the draft still has pending translations: every
- * locale goes live together, and there is no publishing anyway (ADR 0033).
- */
-export declare const TRANSLATIONS_PENDING_ERROR = "TRANSLATIONS_PENDING";
-/**
- * oRPC error code for a publish refused because the draft has open findings, each to fix or for a
- * member to dismiss: there is no publishing past them (ADR 0033).
- */
-export declare const FINDINGS_OPEN_ERROR = "FINDINGS_OPEN";
-/**
- * oRPC error code for a publish refused because a patroller's check at publish hasn't read the
- * draft's latest changes yet: publishing waits for it (ADR 0033).
- */
-export declare const CHECKS_RUNNING_ERROR = "CHECKS_RUNNING";
 /**
  * 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,
- * translations are still running, the draft has open findings, a check at publish is still
- * running, or the draft's code changed since the preview.
+ * review again, by the error code of each: the draft has blockers, 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 findings: "FINDINGS_OPEN";
-  readonly checking: "CHECKS_RUNNING";
   readonly revisionChanged: "REVISION_CHANGED";
 };
 export type NotPublishedReason = keyof typeof NOT_PUBLISHED_CODES;

package/dist/drafts.js

@@ -91,11 +91,6 @@ const DRAFT_SEARCH_PARAM = "camox-draft";
 */
 const DRAFT_ENDED_ERROR_CODE = "DRAFT_ENDED";
 /**
-* oRPC error code for a publish whose token no longer matches Live: Live changed since the
-* 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.
@@ -103,15 +98,16 @@ const CONFLICTS_CHANGED_ERROR = "CONFLICTS_CHANGED";
 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.
+* after the one the review showed, 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.
+* `conflictsChanged` is only stored by publishes before ADR 0043, which aborted when Live changed.
 */
 const PUBLISH_ABORT_REASONS = [
 	"revisionChanged",
 	"conflictsChanged",
 	"blocked",
+	"codeDoesNotBuild",
 	"codeDoesNotMerge",
 	"liveCodeMoved",
 	"failed"
@@ -119,32 +115,12 @@ const PUBLISH_ABORT_REASONS = [
 /** oRPC error code for a publish refused because the draft still has blockers. */
 const PUBLISH_BLOCKED_ERROR = "PUBLISH_BLOCKED";
 /**
-* oRPC error code for a publish refused because the draft still has pending translations: every
-* locale goes live together, and there is no publishing anyway (ADR 0033).
-*/
-const TRANSLATIONS_PENDING_ERROR = "TRANSLATIONS_PENDING";
-/**
-* oRPC error code for a publish refused because the draft has open findings, each to fix or for a
-* member to dismiss: there is no publishing past them (ADR 0033).
-*/
-const FINDINGS_OPEN_ERROR = "FINDINGS_OPEN";
-/**
-* oRPC error code for a publish refused because a patroller's check at publish hasn't read the
-* draft's latest changes yet: publishing waits for it (ADR 0033).
-*/
-const CHECKS_RUNNING_ERROR = "CHECKS_RUNNING";
-/**
 * 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,
-* translations are still running, the draft has open findings, a check at publish is still
-* running, or the draft's code changed since the preview.
+* review again, by the error code of each: the draft has blockers, 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,
-	findings: FINDINGS_OPEN_ERROR,
-	checking: CHECKS_RUNNING_ERROR,
 	revisionChanged: REVISION_CHANGED_ERROR
 };
 /**
@@ -159,85 +135,93 @@ const CAMOX_NAME = "Camox";
 * changes reach it only by publishing a draft, or through a release.
 */
 const LIVE_READ_ONLY_ERROR = "LIVE_READ_ONLY";
+const BLOCK_WRITES = {
+	get: false,
+	getPageMarkdown: false,
+	getLayoutMarkdown: false,
+	getUsageCounts: false,
+	getPagesUsing: false,
+	getSyncedContent: false,
+	getUnplaced: false,
+	create: true,
+	updateContent: true,
+	updateSettings: true,
+	updatePosition: true,
+	delete: true,
+	deleteMany: true,
+	generateSummary: false,
+	duplicate: true
+};
+const COLLECTION_WRITES = {
+	list: false,
+	get: false,
+	listRecords: false,
+	getRecord: false,
+	getRecordUsageCount: false,
+	findRecordsByField: false,
+	listRecordPageValues: false,
+	recordMarkdown: false,
+	createRecord: true,
+	editRecord: true,
+	deleteRecord: true
+};
+const FILE_WRITES = {
+	list: false,
+	get: false,
+	getUsageCount: false,
+	setAlt: true,
+	setFilename: true,
+	delete: true,
+	deleteMany: true,
+	setAiMetadata: true,
+	generateMetadata: false
+};
+const PAGE_WRITES = {
+	getByPath: false,
+	getStructure: false,
+	getMarkdown: false,
+	list: false,
+	listBySlug: false,
+	get: false,
+	create: true,
+	update: true,
+	delete: true,
+	setSeo: true,
+	setLayout: true,
+	generateSeo: false
+};
+const ITEM_WRITES = {
+	get: false,
+	create: true,
+	updateContent: true,
+	updateSettings: true,
+	updatePosition: true,
+	duplicate: true,
+	generateSummary: false,
+	delete: true
+};
+const LOCALE_WRITES = {
+	list: false,
+	add: true,
+	remove: true,
+	setDefaultTag: false,
+	listMissing: false,
+	addBack: true
+};
+const SPECIALISTS_WRITES = {
+	get: false,
+	applyFix: true,
+	dismissFinding: false
+};
 const CONTENT_WRITES = {
-	blocks: {
-		get: false,
-		getPageMarkdown: false,
-		getLayoutMarkdown: false,
-		getUsageCounts: false,
-		getPagesUsing: false,
-		getSyncedContent: false,
-		getUnplaced: false,
-		create: true,
-		updateContent: true,
-		updateSettings: true,
-		updatePosition: true,
-		delete: true,
-		deleteMany: true,
-		generateSummary: false,
-		duplicate: true
-	},
-	locales: {
-		list: false,
-		add: true,
-		remove: true,
-		setDefaultTag: false,
-		listMissing: false,
-		addBack: true
-	},
-	collectionDefinitions: {
-		list: false,
-		get: false,
-		listRecords: false,
-		getRecord: false,
-		getRecordUsageCount: false,
-		findRecordsByField: false,
-		listRecordPageValues: false,
-		recordMarkdown: false,
-		createRecord: true,
-		editRecord: true,
-		deleteRecord: true
-	},
-	files: {
-		list: false,
-		get: false,
-		getUsageCount: false,
-		setAlt: true,
-		setFilename: true,
-		delete: true,
-		deleteMany: true,
-		setAiMetadata: true,
-		generateMetadata: false
-	},
-	pages: {
-		getByPath: false,
-		getStructure: false,
-		getMarkdown: false,
-		list: false,
-		listBySlug: false,
-		get: false,
-		create: true,
-		update: true,
-		delete: true,
-		setSeo: true,
-		setLayout: true,
-		generateSeo: false
-	},
-	patrol: {
-		get: false,
-		applyFix: true,
-		dismissFinding: false
-	},
-	repeatableItems: {
-		get: false,
-		create: true,
-		updateContent: true,
-		updateSettings: true,
-		updatePosition: true,
-		duplicate: true,
-		generateSummary: false,
-		delete: true
-	}
+	blocks: BLOCK_WRITES,
+	locales: LOCALE_WRITES,
+	collectionDefinitions: COLLECTION_WRITES,
+	files: FILE_WRITES,
+	pages: PAGE_WRITES,
+	specialists: SPECIALISTS_WRITES,
+	patrol: SPECIALISTS_WRITES,
+	repeatableItems: ITEM_WRITES
 };
 /** Whether the procedure at `path` (`[router, procedure]`) writes content. */
 function isContentWrite(path) {
@@ -246,4 +230,4 @@ function isContentWrite(path) {
 }
 
 //#endregion
-export { ARTIFACT_FIELD_ATTRIBUTE, ARTIFACT_ITEM_ATTRIBUTE, CAMOX_ACTOR, CAMOX_NAME, CHECKS_RUNNING_ERROR, CONFLICTS_CHANGED_ERROR, DRAFT_CREATE_HEADER, DRAFT_ENDED_ERROR_CODE, DRAFT_HEADER, DRAFT_SEARCH_PARAM, FINDINGS_OPEN_ERROR, 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, TRANSLATIONS_PENDING_ERROR, UNPLACED_BLOCK_ID, isContentWrite, lookArtifactSelector };
+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 };

package/dist/query-keys.d.ts

@@ -40,6 +40,9 @@ export declare const queryKeys: {
     list: ["camox", string, string];
     get: ["camox", string, string];
   };
+  specialists: {
+    get: ["camox", string];
+  };
   patrol: {
     get: ["camox", string];
   };

package/dist/query-keys.js

@@ -99,6 +99,7 @@ const queryKeys = {
 			"get"
 		]
 	},
+	specialists: { get: ["camox", "specialists"] },
 	patrol: { get: ["camox", "patrol"] }
 };
 /** The last segment of a query key: what the query reads, Live or a draft (ADR 0011). */