@camox/api-contract 0.57.0 → 0.58.0

package/dist/index.d.ts

@@ -10,6 +10,12 @@ export declare const UNTITLED_ARTIFACT = "Untitled artifact";
 export declare function artifactSourceTitle(source: string): string | undefined;
 /** The artifact's name: its source's `<title>`, or "Untitled artifact". */
 export declare function artifactTitle(source: string): string;
+/**
+ * The hash an artifact source is stored and served under: the SHA-256 of its UTF-8 bytes, in
+ * URL-safe base64 without padding. Shared by the API, which stores sources under it, and the SDK,
+ * which names the URLs public pages load artifacts from.
+ */
+export declare function artifactSourceHash(source: string): Promise<string>;
 //#endregion
 //#region src/record-templates.d.ts
 /**

package/dist/index.js

@@ -31,6 +31,17 @@ function artifactSourceTitle(source) {
 function artifactTitle(source) {
 	return artifactSourceTitle(source) ?? "Untitled artifact";
 }
+/**
+* The hash an artifact source is stored and served under: the SHA-256 of its UTF-8 bytes, in
+* URL-safe base64 without padding. Shared by the API, which stores sources under it, and the SDK,
+* which names the URLs public pages load artifacts from.
+*/
+async function artifactSourceHash(source) {
+	const digest = await crypto.subtle.digest("SHA-256", new TextEncoder().encode(source));
+	let binary = "";
+	for (const byte of new Uint8Array(digest)) binary += String.fromCharCode(byte);
+	return btoa(binary).replaceAll("+", "-").replaceAll("/", "_").replace(/=+$/, "");
+}
 
 //#endregion
 //#region src/record-templates.ts
@@ -133,4 +144,4 @@ function isSettingCondition(value) {
 }
 
 //#endregion
-export { ARTICLE_TYPES, ICON_CATALOG_VERSION, PAGE_TEXT_LINK_PREFIX, QUERY_LIMIT_CAP, SYSTEM_ORDER_KEYS, UNTITLED_ARTIFACT, artifactSourceTitle, artifactTitle, generateUuidv7, isPageUrlMarker, isQueryBacked, isSettingCondition, isSystemOrderKey, linkedRecordId, nonStringTemplateFields, projectIdSchema, recordLink, recordText, referenceQueryProblem, scopeIconSvgIds, templateFields, uuidv7JsonSchema, uuidv7Schema, validateIconValue };
+export { ARTICLE_TYPES, ICON_CATALOG_VERSION, PAGE_TEXT_LINK_PREFIX, QUERY_LIMIT_CAP, SYSTEM_ORDER_KEYS, UNTITLED_ARTIFACT, artifactSourceHash, artifactSourceTitle, artifactTitle, generateUuidv7, isPageUrlMarker, isQueryBacked, isSettingCondition, isSystemOrderKey, linkedRecordId, nonStringTemplateFields, projectIdSchema, recordLink, recordText, referenceQueryProblem, scopeIconSvgIds, templateFields, uuidv7JsonSchema, uuidv7Schema, validateIconValue };

package/dist/router.d.ts

@@ -6904,6 +6904,8 @@ type BlockRow = typeof blocks.$inferSelect;
 type ShownBlock = Conformed<BlockRow> & {
   summary: string;
   title: string;
+  /** The hash of each artifact source in its content, by field (`artifactHashesOf`). */
+  artifactHashes: Record<string, string>;
 };
 //#endregion
 //#region ../../apps/api/src/domains/content/structured-data.d.ts
@@ -8097,6 +8099,7 @@ declare const router: {
         afterBlockIds: string[];
       } | null;
       blocks: (Omit<{
+        type: string;
         draftId: string | null;
         id: string;
         deleted: boolean;
@@ -8104,7 +8107,6 @@ declare const router: {
         locale: string;
         pageId: string | null;
         layoutId: string | null;
-        type: string;
         content: unknown;
         createdAt: number;
         updatedAt: number;
@@ -8122,6 +8124,7 @@ declare const router: {
       } & {
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       })[];
@@ -8152,6 +8155,7 @@ declare const router: {
         blockId: string;
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       })[];
@@ -8202,6 +8206,7 @@ declare const router: {
         afterBlockIds: string[];
       } | null;
       blocks: (Omit<{
+        type: string;
         draftId: string | null;
         id: string;
         deleted: boolean;
@@ -8209,7 +8214,6 @@ declare const router: {
         locale: string;
         pageId: string | null;
         layoutId: string | null;
-        type: string;
         content: unknown;
         createdAt: number;
         updatedAt: number;
@@ -8227,6 +8231,7 @@ declare const router: {
       } & {
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       })[];
@@ -8257,6 +8262,7 @@ declare const router: {
         blockId: string;
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       })[];
@@ -9450,6 +9456,7 @@ declare const router: {
       id: import("zod").ZodUUID;
     }, import("zod/v4/core").$strip>, import("@orpc/server").Schema<{
       block: Omit<{
+        type: string;
         draftId: string | null;
         id: string;
         deleted: boolean;
@@ -9457,7 +9464,6 @@ declare const router: {
         locale: string;
         pageId: string | null;
         layoutId: string | null;
-        type: string;
         content: unknown;
         createdAt: number;
         updatedAt: number;
@@ -9475,6 +9481,7 @@ declare const router: {
       } & {
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       };
@@ -9505,12 +9512,14 @@ declare const router: {
         blockId: string;
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       })[];
       files: FileView[];
     }, {
       block: Omit<{
+        type: string;
         draftId: string | null;
         id: string;
         deleted: boolean;
@@ -9518,7 +9527,6 @@ declare const router: {
         locale: string;
         pageId: string | null;
         layoutId: string | null;
-        type: string;
         content: unknown;
         createdAt: number;
         updatedAt: number;
@@ -9536,6 +9544,7 @@ declare const router: {
       } & {
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       };
@@ -9566,6 +9575,7 @@ declare const router: {
         blockId: string;
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       })[];
@@ -9646,6 +9656,7 @@ declare const router: {
       type: import("zod").ZodString;
     }, import("zod/v4/core").$strip>, import("@orpc/server").Schema<{
       block: Omit<{
+        type: string;
         draftId: string | null;
         id: string;
         deleted: boolean;
@@ -9653,7 +9664,6 @@ declare const router: {
         locale: string;
         pageId: string | null;
         layoutId: string | null;
-        type: string;
         content: unknown;
         createdAt: number;
         updatedAt: number;
@@ -9671,6 +9681,7 @@ declare const router: {
       } & {
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       };
@@ -9701,12 +9712,14 @@ declare const router: {
         blockId: string;
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       })[];
       files: FileView[];
     } | null, {
       block: Omit<{
+        type: string;
         draftId: string | null;
         id: string;
         deleted: boolean;
@@ -9714,7 +9727,6 @@ declare const router: {
         locale: string;
         pageId: string | null;
         layoutId: string | null;
-        type: string;
         content: unknown;
         createdAt: number;
         updatedAt: number;
@@ -9732,6 +9744,7 @@ declare const router: {
       } & {
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       };
@@ -9762,6 +9775,7 @@ declare const router: {
         blockId: string;
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       })[];
@@ -9866,6 +9880,7 @@ declare const router: {
         position: import("zod").ZodString;
       }, import("zod/v4/core").$strip>>>;
     }, import("zod/v4/core").$strip>, import("@orpc/server").Schema<Omit<{
+      type: string;
       draftId: string | null;
       id: string;
       deleted: boolean;
@@ -9873,7 +9888,6 @@ declare const router: {
       locale: string;
       pageId: string | null;
       layoutId: string | null;
-      type: string;
       content: unknown;
       createdAt: number;
       updatedAt: number;
@@ -9891,9 +9905,11 @@ declare const router: {
     } & {
       summary: string;
       title: string;
+      artifactHashes: Record<string, string>;
     } & {
       warnings?: string[];
     }, Omit<{
+      type: string;
       draftId: string | null;
       id: string;
       deleted: boolean;
@@ -9901,7 +9917,6 @@ declare const router: {
       locale: string;
       pageId: string | null;
       layoutId: string | null;
-      type: string;
       content: unknown;
       createdAt: number;
       updatedAt: number;
@@ -9919,6 +9934,7 @@ declare const router: {
     } & {
       summary: string;
       title: string;
+      artifactHashes: Record<string, string>;
     } & {
       warnings?: string[];
     }>, Record<never, never>, Record<never, never>>;
@@ -10508,6 +10524,7 @@ declare const router: {
         afterBlockIds: string[];
       };
       blocks: (Omit<{
+        type: string;
         draftId: string | null;
         id: string;
         deleted: boolean;
@@ -10515,7 +10532,6 @@ declare const router: {
         locale: string;
         pageId: string | null;
         layoutId: string | null;
-        type: string;
         content: unknown;
         createdAt: number;
         updatedAt: number;
@@ -10533,6 +10549,7 @@ declare const router: {
       } & {
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       })[];
@@ -10563,6 +10580,7 @@ declare const router: {
         blockId: string;
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       })[];
@@ -10585,6 +10603,7 @@ declare const router: {
         afterBlockIds: string[];
       };
       blocks: (Omit<{
+        type: string;
         draftId: string | null;
         id: string;
         deleted: boolean;
@@ -10592,7 +10611,6 @@ declare const router: {
         locale: string;
         pageId: string | null;
         layoutId: string | null;
-        type: string;
         content: unknown;
         createdAt: number;
         updatedAt: number;
@@ -10610,6 +10628,7 @@ declare const router: {
       } & {
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       })[];
@@ -10640,6 +10659,7 @@ declare const router: {
         blockId: string;
         summary: string;
         title: string;
+        artifactHashes: Record<string, string>;
       } & {
         references: ResolvedReferences;
       })[];
@@ -11912,6 +11932,9 @@ declare const router: {
         blockId: string | null;
         summary: string;
         title: string;
+        artifactHashes: {
+          [k: string]: string;
+        };
         references: ResolvedReferences;
         draftId: string | null;
         id: string;
@@ -11939,6 +11962,9 @@ declare const router: {
         blockId: string | null;
         summary: string;
         title: string;
+        artifactHashes: {
+          [k: string]: string;
+        };
         references: ResolvedReferences;
         draftId: string | null;
         id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camox/api-contract",
-  "version": "0.57.0",
+  "version": "0.58.0",
   "license": "MIT",
   "files": [
     "src",

package/src/artifact.ts

@@ -36,3 +36,15 @@ export function artifactSourceTitle(source: string): string | undefined {
 export function artifactTitle(source: string): string {
   return artifactSourceTitle(source) ?? UNTITLED_ARTIFACT;
 }
+
+/**
+ * The hash an artifact source is stored and served under: the SHA-256 of its UTF-8 bytes, in
+ * URL-safe base64 without padding. Shared by the API, which stores sources under it, and the SDK,
+ * which names the URLs public pages load artifacts from.
+ */
+export async function artifactSourceHash(source: string): Promise<string> {
+  const digest = await crypto.subtle.digest("SHA-256", new TextEncoder().encode(source));
+  let binary = "";
+  for (const byte of new Uint8Array(digest)) binary += String.fromCharCode(byte);
+  return btoa(binary).replaceAll("+", "-").replaceAll("/", "_").replace(/=+$/, "");
+}