@tearleads/client-sdk 0.0.0-stage → 0.1.11

package/data/documents/documentContent.js

@@ -0,0 +1,124 @@
+import { compareCanonicalStrings } from "../../internal/crypto/index.js";
+import { LoroMap } from "../../internal/loro/index.js";
+const DOCUMENT_CONTENT_MAP_KEY = "content";
+const ATTACHMENT_KEY_PREFIX = "attachment:";
+function isStructuredAttachmentMap(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        "entries" in value &&
+        typeof value.entries === "function" &&
+        "get" in value &&
+        typeof value.get === "function" &&
+        "set" in value &&
+        typeof value.set === "function" &&
+        "delete" in value &&
+        typeof value.delete === "function");
+}
+function parseStructuredAttachment(slotId, value) {
+    if (!isStructuredAttachmentMap(value)) {
+        return null;
+    }
+    const contentSha256 = value.get("contentSha256");
+    const name = value.get("name");
+    const byteLength = value.get("byteLength");
+    const mimeType = value.get("mimeType");
+    const order = value.get("order");
+    if (typeof contentSha256 !== "string" ||
+        !/^[0-9a-f]{64}$/.test(contentSha256) ||
+        typeof name !== "string" ||
+        name.length === 0 ||
+        typeof byteLength !== "number" ||
+        !Number.isInteger(byteLength) ||
+        byteLength < 0 ||
+        !(mimeType === undefined ||
+            mimeType === null ||
+            typeof mimeType === "string")) {
+        return null;
+    }
+    return {
+        contentSha256,
+        byteLength,
+        mimeType: mimeType ?? null,
+        name,
+        order: typeof order === "number" && Number.isFinite(order) ? order : null,
+        slotId,
+    };
+}
+export function ensureDocumentAttachmentStructure(doc) {
+    doc.getMap(DOCUMENT_CONTENT_MAP_KEY);
+}
+function getAttachmentMapKey(slotId) {
+    return `${ATTACHMENT_KEY_PREFIX}${slotId}`;
+}
+function listStructuredDocumentAttachments(doc) {
+    const documentMap = doc.getMap(DOCUMENT_CONTENT_MAP_KEY);
+    return documentMap
+        .entries()
+        .flatMap(([key, value]) => {
+        if (!key.startsWith(ATTACHMENT_KEY_PREFIX)) {
+            return [];
+        }
+        const attachment = parseStructuredAttachment(key.slice(ATTACHMENT_KEY_PREFIX.length), value);
+        return attachment ? [attachment] : [];
+    })
+        .sort((left, right) => {
+        if (left.order !== right.order) {
+            if (left.order === null) {
+                return 1;
+            }
+            if (right.order === null) {
+                return -1;
+            }
+            return left.order - right.order;
+        }
+        return compareCanonicalStrings(left.slotId, right.slotId);
+    });
+}
+function getStructuredDocumentAttachments(doc) {
+    return listStructuredDocumentAttachments(doc).map(({ order: _order, ...attachment }) => attachment);
+}
+export function getDocumentAttachments(doc) {
+    return getStructuredDocumentAttachments(doc);
+}
+export function addDocumentAttachments(doc, attachments) {
+    if (attachments.length === 0) {
+        return;
+    }
+    const documentMap = doc.getMap(DOCUMENT_CONTENT_MAP_KEY);
+    const existingAttachments = listStructuredDocumentAttachments(doc);
+    let nextOrder = existingAttachments.reduce((highestOrder, attachment, index) => {
+        return Math.max(highestOrder, attachment.order ?? index);
+    }, -1) + 1;
+    for (const attachment of attachments) {
+        const attachmentMap = documentMap.getOrCreateContainer(getAttachmentMapKey(attachment.slotId), new LoroMap());
+        attachmentMap.set("contentSha256", attachment.contentSha256);
+        attachmentMap.set("name", attachment.name);
+        attachmentMap.set("byteLength", attachment.byteLength);
+        if (attachment.mimeType === null) {
+            attachmentMap.delete("mimeType");
+        }
+        else {
+            attachmentMap.set("mimeType", attachment.mimeType);
+        }
+        if (attachmentMap.get("order") === undefined) {
+            attachmentMap.set("order", nextOrder);
+            nextOrder += 1;
+        }
+    }
+}
+export function removeDocumentAttachment(doc, slotId) {
+    doc.getMap(DOCUMENT_CONTENT_MAP_KEY).delete(getAttachmentMapKey(slotId));
+}
+export function sameDocumentAttachments(left, right) {
+    return (left.length === right.length &&
+        left.every((attachment, index) => {
+            const nextAttachment = right[index];
+            return (nextAttachment !== undefined &&
+                attachment.slotId === nextAttachment.slotId &&
+                attachment.contentSha256 === nextAttachment.contentSha256 &&
+                attachment.name === nextAttachment.name &&
+                attachment.byteLength === nextAttachment.byteLength &&
+                attachment.mimeType === nextAttachment.mimeType);
+        }));
+}
+//# sourceMappingURL=documentContent.js.map

package/data/documents/documentContent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentContent.js","sourceRoot":"","sources":["documentContent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAkB1C,MAAM,wBAAwB,GAAG,SAAS,CAAC;AAC3C,MAAM,qBAAqB,GAAG,aAAa,CAAC;AAE5C,SAAS,yBAAyB,CAChC,KAAc;IAEd,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,SAAS,IAAI,KAAK;QAClB,OAAO,KAAK,CAAC,OAAO,KAAK,UAAU;QACnC,KAAK,IAAI,KAAK;QACd,OAAO,KAAK,CAAC,GAAG,KAAK,UAAU;QAC/B,KAAK,IAAI,KAAK;QACd,OAAO,KAAK,CAAC,GAAG,KAAK,UAAU;QAC/B,QAAQ,IAAI,KAAK;QACjB,OAAO,KAAK,CAAC,MAAM,KAAK,UAAU,CACnC,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAChC,MAAc,EACd,KAAc;IAEd,IAAI,CAAC,yBAAyB,CAAC,KAAK,CAAC,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,aAAa,GAAG,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/B,MAAM,UAAU,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC3C,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAEjC,IACE,OAAO,aAAa,KAAK,QAAQ;QACjC,CAAC,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC;QACrC,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,CAAC,MAAM,KAAK,CAAC;QACjB,OAAO,UAAU,KAAK,QAAQ;QAC9B,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC;QAC7B,UAAU,GAAG,CAAC;QACd,CAAC,CACC,QAAQ,KAAK,SAAS;YACtB,QAAQ,KAAK,IAAI;YACjB,OAAO,QAAQ,KAAK,QAAQ,CAC7B,EACD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,aAAa;QACb,UAAU;QACV,QAAQ,EAAE,QAAQ,IAAI,IAAI;QAC1B,IAAI;QACJ,KAAK,EAAE,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;QACzE,MAAM;KACP,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iCAAiC,CAC/C,GAA4B;IAE5B,GAAG,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAc;IACzC,OAAO,GAAG,qBAAqB,GAAG,MAAM,EAAE,CAAC;AAC7C,CAAC;AAED,SAAS,iCAAiC,CACxC,GAA4B;IAE5B,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;IACzD,OAAO,WAAW;SACf,OAAO,EAAE;SACT,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACxB,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,qBAAqB,CAAC,EAAE,CAAC;YAC3C,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,UAAU,GAAG,yBAAyB,CAC1C,GAAG,CAAC,KAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,EACvC,KAAK,CACN,CAAC;QACF,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxC,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QACpB,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;YAC/B,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;gBACxB,OAAO,CAAC,CAAC;YACX,CAAC;YAED,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;gBACzB,OAAO,CAAC,CAAC,CAAC;YACZ,CAAC;YAED,OAAO,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAClC,CAAC;QAED,OAAO,uBAAuB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,gCAAgC,CACvC,GAA4B;IAE5B,OAAO,iCAAiC,CAAC,GAAG,CAAC,CAAC,GAAG,CAC/C,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,EAAE,EAAE,CAAC,UAAU,CACjD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,GAA4B;IAE5B,OAAO,gCAAgC,CAAC,GAAG,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,GAA4B,EAC5B,WAA8C;IAE9C,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO;IACT,CAAC;IAED,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;IACzD,MAAM,mBAAmB,GAAG,iCAAiC,CAAC,GAAG,CAAC,CAAC;IACnE,IAAI,SAAS,GACX,mBAAmB,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE;QAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,UAAU,CAAC,KAAK,IAAI,KAAK,CAAC,CAAC;IAC3D,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAEb,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,MAAM,aAAa,GAAG,WAAW,CAAC,oBAAoB,CACpD,mBAAmB,CAAC,UAAU,CAAC,MAAM,CAAC,EACtC,IAAI,OAAO,EAAE,CACd,CAAC;QACF,aAAa,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC;QAC7D,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;QAC3C,aAAa,CAAC,GAAG,CAAC,YAAY,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;QACvD,IAAI,UAAU,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YACjC,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,aAAa,CAAC,GAAG,CAAC,UAAU,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;QACrD,CAAC;QACD,IAAI,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,SAAS,EAAE,CAAC;YAC7C,aAAa,CAAC,GAAG,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YACtC,SAAS,IAAI,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,GAA4B,EAC5B,MAAc;IAEd,GAAG,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,IAAuC,EACvC,KAAwC;IAExC,OAAO,CACL,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;QAC5B,IAAI,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE;YAC/B,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;YACpC,OAAO,CACL,cAAc,KAAK,SAAS;gBAC5B,UAAU,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM;gBAC3C,UAAU,CAAC,aAAa,KAAK,cAAc,CAAC,aAAa;gBACzD,UAAU,CAAC,IAAI,KAAK,cAAc,CAAC,IAAI;gBACvC,UAAU,CAAC,UAAU,KAAK,cAAc,CAAC,UAAU;gBACnD,UAAU,CAAC,QAAQ,KAAK,cAAc,CAAC,QAAQ,CAChD,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;AACJ,CAAC","sourcesContent":["import { compareCanonicalStrings } from \"@tearleads/crypto\";\nimport { LoroMap } from \"@tearleads/loro\";\nimport type {\n  StructuredDocumentShape as FullStructuredDocumentShape,\n  StructuredDocumentMap,\n} from \"./documentKinds\";\n\nexport interface DocumentAttachment {\n  contentSha256: string;\n  slotId: string;\n  name: string;\n  byteLength: number;\n  mimeType: string | null;\n}\n\n// Attachment helpers only read/write maps, so callers may pass any shape that\n// provides `getMap` (a full structured document included).\ntype StructuredDocumentShape = Pick<FullStructuredDocumentShape, \"getMap\">;\n\nconst DOCUMENT_CONTENT_MAP_KEY = \"content\";\nconst ATTACHMENT_KEY_PREFIX = \"attachment:\";\n\nfunction isStructuredAttachmentMap(\n  value: unknown,\n): value is StructuredDocumentMap {\n  return (\n    typeof value === \"object\" &&\n    value !== null &&\n    \"entries\" in value &&\n    typeof value.entries === \"function\" &&\n    \"get\" in value &&\n    typeof value.get === \"function\" &&\n    \"set\" in value &&\n    typeof value.set === \"function\" &&\n    \"delete\" in value &&\n    typeof value.delete === \"function\"\n  );\n}\n\nfunction parseStructuredAttachment(\n  slotId: string,\n  value: unknown,\n): (DocumentAttachment & { order: number | null }) | null {\n  if (!isStructuredAttachmentMap(value)) {\n    return null;\n  }\n\n  const contentSha256 = value.get(\"contentSha256\");\n  const name = value.get(\"name\");\n  const byteLength = value.get(\"byteLength\");\n  const mimeType = value.get(\"mimeType\");\n  const order = value.get(\"order\");\n\n  if (\n    typeof contentSha256 !== \"string\" ||\n    !/^[0-9a-f]{64}$/.test(contentSha256) ||\n    typeof name !== \"string\" ||\n    name.length === 0 ||\n    typeof byteLength !== \"number\" ||\n    !Number.isInteger(byteLength) ||\n    byteLength < 0 ||\n    !(\n      mimeType === undefined ||\n      mimeType === null ||\n      typeof mimeType === \"string\"\n    )\n  ) {\n    return null;\n  }\n\n  return {\n    contentSha256,\n    byteLength,\n    mimeType: mimeType ?? null,\n    name,\n    order: typeof order === \"number\" && Number.isFinite(order) ? order : null,\n    slotId,\n  };\n}\n\nexport function ensureDocumentAttachmentStructure(\n  doc: StructuredDocumentShape,\n): void {\n  doc.getMap(DOCUMENT_CONTENT_MAP_KEY);\n}\n\nfunction getAttachmentMapKey(slotId: string): string {\n  return `${ATTACHMENT_KEY_PREFIX}${slotId}`;\n}\n\nfunction listStructuredDocumentAttachments(\n  doc: StructuredDocumentShape,\n): Array<DocumentAttachment & { order: number | null }> {\n  const documentMap = doc.getMap(DOCUMENT_CONTENT_MAP_KEY);\n  return documentMap\n    .entries()\n    .flatMap(([key, value]) => {\n      if (!key.startsWith(ATTACHMENT_KEY_PREFIX)) {\n        return [];\n      }\n\n      const attachment = parseStructuredAttachment(\n        key.slice(ATTACHMENT_KEY_PREFIX.length),\n        value,\n      );\n      return attachment ? [attachment] : [];\n    })\n    .sort((left, right) => {\n      if (left.order !== right.order) {\n        if (left.order === null) {\n          return 1;\n        }\n\n        if (right.order === null) {\n          return -1;\n        }\n\n        return left.order - right.order;\n      }\n\n      return compareCanonicalStrings(left.slotId, right.slotId);\n    });\n}\n\nfunction getStructuredDocumentAttachments(\n  doc: StructuredDocumentShape,\n): DocumentAttachment[] {\n  return listStructuredDocumentAttachments(doc).map(\n    ({ order: _order, ...attachment }) => attachment,\n  );\n}\n\nexport function getDocumentAttachments(\n  doc: StructuredDocumentShape,\n): DocumentAttachment[] {\n  return getStructuredDocumentAttachments(doc);\n}\n\nexport function addDocumentAttachments(\n  doc: StructuredDocumentShape,\n  attachments: ReadonlyArray<DocumentAttachment>,\n): void {\n  if (attachments.length === 0) {\n    return;\n  }\n\n  const documentMap = doc.getMap(DOCUMENT_CONTENT_MAP_KEY);\n  const existingAttachments = listStructuredDocumentAttachments(doc);\n  let nextOrder =\n    existingAttachments.reduce((highestOrder, attachment, index) => {\n      return Math.max(highestOrder, attachment.order ?? index);\n    }, -1) + 1;\n\n  for (const attachment of attachments) {\n    const attachmentMap = documentMap.getOrCreateContainer(\n      getAttachmentMapKey(attachment.slotId),\n      new LoroMap(),\n    );\n    attachmentMap.set(\"contentSha256\", attachment.contentSha256);\n    attachmentMap.set(\"name\", attachment.name);\n    attachmentMap.set(\"byteLength\", attachment.byteLength);\n    if (attachment.mimeType === null) {\n      attachmentMap.delete(\"mimeType\");\n    } else {\n      attachmentMap.set(\"mimeType\", attachment.mimeType);\n    }\n    if (attachmentMap.get(\"order\") === undefined) {\n      attachmentMap.set(\"order\", nextOrder);\n      nextOrder += 1;\n    }\n  }\n}\n\nexport function removeDocumentAttachment(\n  doc: StructuredDocumentShape,\n  slotId: string,\n): void {\n  doc.getMap(DOCUMENT_CONTENT_MAP_KEY).delete(getAttachmentMapKey(slotId));\n}\n\nexport function sameDocumentAttachments(\n  left: ReadonlyArray<DocumentAttachment>,\n  right: ReadonlyArray<DocumentAttachment>,\n): boolean {\n  return (\n    left.length === right.length &&\n    left.every((attachment, index) => {\n      const nextAttachment = right[index];\n      return (\n        nextAttachment !== undefined &&\n        attachment.slotId === nextAttachment.slotId &&\n        attachment.contentSha256 === nextAttachment.contentSha256 &&\n        attachment.name === nextAttachment.name &&\n        attachment.byteLength === nextAttachment.byteLength &&\n        attachment.mimeType === nextAttachment.mimeType\n      );\n    })\n  );\n}\n"]}

package/data/documents/documentKinds.d.ts

@@ -0,0 +1,100 @@
+import type { LoroList, LoroMap } from "../../internal/loro/index.js";
+import type { ExecSql, SqlTableSchema } from "../sqlite/sqlSchema.js";
+import { type DocumentRowSummary } from "./documentRowList.js";
+export type StoredDocumentKind = string;
+export interface DocumentFieldValidationIssue {
+    field: string;
+    message: string;
+    value: unknown;
+}
+export interface ValidatedDocumentFields<TFields> {
+    fields: TFields;
+    issues: DocumentFieldValidationIssue[];
+}
+export interface StoredDocumentState {
+    documentKind: StoredDocumentKind;
+    fieldValidationIssues: DocumentFieldValidationIssue[];
+    structuredFields: Record<string, string>;
+    text: string;
+    title: string;
+}
+export interface StructuredDocumentMap {
+    delete: (key: string) => void;
+    entries: () => Array<[string, unknown]>;
+    get: (key: string) => unknown;
+    getOrCreateContainer: (key: string, container: LoroMap<Record<string, unknown>>) => StructuredDocumentMap;
+    set: (key: string, value: string | number) => void;
+}
+export interface StructuredDocumentText {
+    toString: () => string;
+}
+export interface StructuredDocumentShape {
+    getList: (key: string) => LoroList;
+    getMap: (key: string) => StructuredDocumentMap;
+    getText: (key: string) => StructuredDocumentText;
+}
+export interface DocumentProjectorInput {
+    documentKind: StoredDocumentKind;
+    structuredFields: Readonly<Record<string, unknown>>;
+    text: string;
+    rows?: ReadonlyArray<DocumentRowSummary> | undefined;
+}
+export interface DocumentProjection {
+    fieldValidationIssues: ReadonlyArray<DocumentFieldValidationIssue>;
+    structuredFields: Readonly<Record<string, string>>;
+    title: string;
+}
+export interface DocumentClientProjectionSaveInput {
+    containerId: string | null;
+    documentId: string | null;
+    documentKind: StoredDocumentKind;
+    execSql: ExecSql;
+    localId: string;
+    structuredFields: Readonly<Record<string, string>>;
+    text: string;
+    title: string;
+    updatedAt: string;
+}
+export interface DocumentClientProjectionDeleteInput {
+    documentKind: StoredDocumentKind;
+    execSql: ExecSql;
+    localId: string;
+}
+export interface DocumentClientProjectionDefinition {
+    delete?: (input: DocumentClientProjectionDeleteInput) => Promise<void> | void;
+    save: (input: DocumentClientProjectionSaveInput) => Promise<void> | void;
+    tables: ReadonlyArray<SqlTableSchema>;
+}
+export interface DocumentProjectorDefinition {
+    kind: StoredDocumentKind;
+    label?: string | undefined;
+    schemaVersion?: number | undefined;
+    untitledTitle?: string | undefined;
+    clientProjection?: DocumentClientProjectionDefinition | undefined;
+    initialize?: ((doc: StructuredDocumentShape) => void) | undefined;
+    project?: ((input: DocumentProjectorInput) => DocumentProjection) | undefined;
+}
+export interface DocumentProjectorRegistry {
+    getDefinition: (kind: StoredDocumentKind) => DocumentProjectorDefinition | undefined;
+    getStoredDocumentTypeLabel: (kind: StoredDocumentKind) => string;
+    getClientProjectionTables: () => ReadonlyArray<SqlTableSchema>;
+    getUntitledDocumentTitle: (kind: StoredDocumentKind) => string;
+    initializeStoredDocumentKind: (doc: StructuredDocumentShape, kind: StoredDocumentKind) => void;
+    projectStoredDocumentState: (input: DocumentProjectorInput) => StoredDocumentState;
+    deleteStoredDocumentClientProjection: (input: DocumentClientProjectionDeleteInput) => Promise<void>;
+    saveStoredDocumentClientProjection: (input: DocumentClientProjectionSaveInput) => Promise<void>;
+}
+export type DocumentProjectorRegistryInput = DocumentProjectorRegistry | ReadonlyArray<DocumentProjectorDefinition>;
+export declare const DOCUMENT_FIELDS_MAP_KEY = "fields";
+export declare function readStringDocumentField(source: Readonly<Record<string, unknown>>, field: string, issues: DocumentFieldValidationIssue[]): string;
+export declare function createDocumentProjectorRegistry(definitions?: ReadonlyArray<DocumentProjectorDefinition>): DocumentProjectorRegistry;
+export declare const defaultDocumentProjectorRegistry: DocumentProjectorRegistry;
+export declare function resolveDocumentProjectorRegistry(input: DocumentProjectorRegistryInput | null | undefined): DocumentProjectorRegistry;
+export declare function getDocumentClientProjectionTables(registry?: DocumentProjectorRegistryInput | undefined): ReadonlyArray<SqlTableSchema>;
+export declare function getUntitledDocumentTitle(kind: StoredDocumentKind, registry?: DocumentProjectorRegistryInput): string;
+export declare function getStoredDocumentTypeLabel(kind: StoredDocumentKind, registry?: DocumentProjectorRegistryInput): string;
+export declare function deriveStoredDocumentTitle(text: string): string;
+export declare function projectStoredDocumentState(input: DocumentProjectorInput, registry?: DocumentProjectorRegistryInput): StoredDocumentState;
+export declare function readStoredDocumentState(doc: StructuredDocumentShape, registry?: DocumentProjectorRegistryInput): StoredDocumentState;
+export declare function initializeStoredDocumentKind(doc: StructuredDocumentShape, kind: StoredDocumentKind, registry?: DocumentProjectorRegistryInput): void;
+export declare function writeStoredDocumentFields(doc: StructuredDocumentShape, kind: Exclude<StoredDocumentKind, "note">, patch: Readonly<Record<string, string | number | undefined>>, registry?: DocumentProjectorRegistryInput): void;

package/data/documents/documentKinds.js

@@ -0,0 +1,231 @@
+import { DEFAULT_DOCUMENT_KIND, ORGANIZATION_PROFILE_DOCUMENT_KIND, } from "./documentConstants.js";
+import { listDocumentRows } from "./documentRowList.js";
+const DOCUMENT_METADATA_MAP_KEY = "metadata";
+export const DOCUMENT_FIELDS_MAP_KEY = "fields";
+const DOCUMENT_KIND_KEY = "kind";
+const DOCUMENT_SCHEMA_VERSION_KEY = "schemaVersion";
+const STRUCTURED_DOCUMENT_SCHEMA_VERSION = 1;
+function isStoredDocumentKind(value) {
+    return typeof value === "string" && value.trim().length > 0;
+}
+function isStructuredDocumentKind(value) {
+    return isStoredDocumentKind(value) && value !== DEFAULT_DOCUMENT_KIND;
+}
+function getDocumentText(doc) {
+    return doc.getText("text").toString();
+}
+function getMetadataMap(doc) {
+    return doc.getMap(DOCUMENT_METADATA_MAP_KEY);
+}
+function getFieldsMap(doc) {
+    return doc.getMap(DOCUMENT_FIELDS_MAP_KEY);
+}
+function readDocumentKind(doc) {
+    const kind = getMetadataMap(doc).get(DOCUMENT_KIND_KEY);
+    return isStoredDocumentKind(kind) ? kind : DEFAULT_DOCUMENT_KIND;
+}
+function readStructuredFields(doc) {
+    return Object.fromEntries(getFieldsMap(doc).entries());
+}
+function humanizeDocumentKind(kind) {
+    const label = kind
+        .trim()
+        .split(/[\s_-]+/u)
+        .filter((part) => part.length > 0)
+        .join(" ")
+        .toLowerCase();
+    return label.length > 0 ? label : "document";
+}
+export function readStringDocumentField(source, field, issues) {
+    const value = source[field];
+    if (value === undefined || value === null) {
+        return "";
+    }
+    if (typeof value === "string") {
+        return value;
+    }
+    issues.push({
+        field,
+        message: "Expected a string value.",
+        value,
+    });
+    return "";
+}
+function readGenericStructuredFieldsFromRecord(source) {
+    const issues = [];
+    const fields = {};
+    for (const field of Object.keys(source)) {
+        fields[field] = readStringDocumentField(source, field, issues);
+    }
+    return { fields, issues };
+}
+function deriveNoteTitle(text) {
+    for (const line of text.split(/\r?\n/u)) {
+        const trimmed = line.trim();
+        if (trimmed.length > 0) {
+            return trimmed;
+        }
+    }
+    return "Untitled note";
+}
+function projectDefaultDocumentState(input, registry) {
+    if (input.documentKind === DEFAULT_DOCUMENT_KIND) {
+        return {
+            documentKind: DEFAULT_DOCUMENT_KIND,
+            fieldValidationIssues: [],
+            structuredFields: {},
+            text: input.text,
+            title: deriveNoteTitle(input.text),
+        };
+    }
+    const validated = readGenericStructuredFieldsFromRecord(input.structuredFields);
+    return {
+        documentKind: input.documentKind,
+        fieldValidationIssues: validated.issues,
+        structuredFields: { ...validated.fields },
+        text: input.text,
+        title: registry.getUntitledDocumentTitle(input.documentKind),
+    };
+}
+function createStoredDocumentState(input, projection) {
+    return {
+        documentKind: input.documentKind,
+        fieldValidationIssues: [...projection.fieldValidationIssues],
+        structuredFields: { ...projection.structuredFields },
+        text: input.text,
+        title: projection.title,
+    };
+}
+export function createDocumentProjectorRegistry(definitions = []) {
+    const definitionsByKind = new Map();
+    for (const definition of definitions) {
+        if (!isStoredDocumentKind(definition.kind)) {
+            throw new Error("Document projector definitions require a non-empty kind.");
+        }
+        definitionsByKind.set(definition.kind, definition);
+    }
+    const registry = {
+        getDefinition(kind) {
+            return definitionsByKind.get(kind);
+        },
+        getClientProjectionTables() {
+            return definitions.flatMap((definition) => definition.clientProjection?.tables ?? []);
+        },
+        getStoredDocumentTypeLabel(kind) {
+            return definitionsByKind.get(kind)?.label ?? humanizeDocumentKind(kind);
+        },
+        getUntitledDocumentTitle(kind) {
+            const definition = definitionsByKind.get(kind);
+            if (definition?.untitledTitle) {
+                return definition.untitledTitle;
+            }
+            if (kind === DEFAULT_DOCUMENT_KIND) {
+                return "Untitled note";
+            }
+            // The SDK provisions this kind itself, so hosts that never register a
+            // projector for it still get its stable title instead of the
+            // humanized generic form.
+            if (kind === ORGANIZATION_PROFILE_DOCUMENT_KIND) {
+                return "Organization Profile";
+            }
+            return `Untitled ${registry.getStoredDocumentTypeLabel(kind)}`;
+        },
+        initializeStoredDocumentKind(doc, kind) {
+            if (!isStructuredDocumentKind(kind)) {
+                return;
+            }
+            const metadata = getMetadataMap(doc);
+            const definition = definitionsByKind.get(kind);
+            metadata.set(DOCUMENT_KIND_KEY, kind);
+            metadata.set(DOCUMENT_SCHEMA_VERSION_KEY, definition?.schemaVersion ?? STRUCTURED_DOCUMENT_SCHEMA_VERSION);
+            getFieldsMap(doc);
+            definition?.initialize?.(doc);
+        },
+        projectStoredDocumentState(input) {
+            const definition = definitionsByKind.get(input.documentKind);
+            if (definition?.project) {
+                return createStoredDocumentState(input, definition.project(input));
+            }
+            return projectDefaultDocumentState(input, registry);
+        },
+        async deleteStoredDocumentClientProjection(input) {
+            await definitionsByKind
+                .get(input.documentKind)
+                ?.clientProjection?.delete?.(input);
+        },
+        async saveStoredDocumentClientProjection(input) {
+            await definitionsByKind
+                .get(input.documentKind)
+                ?.clientProjection?.save(input);
+        },
+    };
+    return registry;
+}
+export const defaultDocumentProjectorRegistry = createDocumentProjectorRegistry();
+const documentProjectorRegistryCache = new WeakMap();
+function isDocumentProjectorRegistry(input) {
+    return ("getClientProjectionTables" in input &&
+        typeof input.getClientProjectionTables === "function");
+}
+export function resolveDocumentProjectorRegistry(input) {
+    if (input == null) {
+        return defaultDocumentProjectorRegistry;
+    }
+    if (isDocumentProjectorRegistry(input)) {
+        return input;
+    }
+    const cached = documentProjectorRegistryCache.get(input);
+    if (cached) {
+        return cached;
+    }
+    const registry = createDocumentProjectorRegistry(input);
+    documentProjectorRegistryCache.set(input, registry);
+    return registry;
+}
+export function getDocumentClientProjectionTables(registry = defaultDocumentProjectorRegistry) {
+    return resolveDocumentProjectorRegistry(registry).getClientProjectionTables();
+}
+export function getUntitledDocumentTitle(kind, registry = defaultDocumentProjectorRegistry) {
+    return resolveDocumentProjectorRegistry(registry).getUntitledDocumentTitle(kind);
+}
+export function getStoredDocumentTypeLabel(kind, registry = defaultDocumentProjectorRegistry) {
+    return resolveDocumentProjectorRegistry(registry).getStoredDocumentTypeLabel(kind);
+}
+export function deriveStoredDocumentTitle(text) {
+    return deriveNoteTitle(text);
+}
+export function projectStoredDocumentState(input, registry = defaultDocumentProjectorRegistry) {
+    return resolveDocumentProjectorRegistry(registry).projectStoredDocumentState(input);
+}
+export function readStoredDocumentState(doc, registry = defaultDocumentProjectorRegistry) {
+    const resolvedRegistry = resolveDocumentProjectorRegistry(registry);
+    const documentKind = readDocumentKind(doc);
+    const text = getDocumentText(doc);
+    const structuredFields = isStructuredDocumentKind(documentKind)
+        ? readStructuredFields(doc)
+        : {};
+    const rows = isStructuredDocumentKind(documentKind)
+        ? listDocumentRows(doc).map((row) => ({ id: row.id, fields: row.fields }))
+        : [];
+    return resolvedRegistry.projectStoredDocumentState({
+        documentKind,
+        structuredFields,
+        text,
+        rows,
+    });
+}
+export function initializeStoredDocumentKind(doc, kind, registry = defaultDocumentProjectorRegistry) {
+    resolveDocumentProjectorRegistry(registry).initializeStoredDocumentKind(doc, kind);
+}
+export function writeStoredDocumentFields(doc, kind, patch, registry = defaultDocumentProjectorRegistry) {
+    resolveDocumentProjectorRegistry(registry).initializeStoredDocumentKind(doc, kind);
+    const fields = getFieldsMap(doc);
+    for (const [key, value] of Object.entries(patch)) {
+        if (value === undefined) {
+            fields.delete(key);
+            continue;
+        }
+        fields.set(key, value);
+    }
+}
+//# sourceMappingURL=documentKinds.js.map

package/data/documents/documentKinds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentKinds.js","sourceRoot":"","sources":["documentKinds.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,qBAAqB,EACrB,kCAAkC,GACnC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAA2B,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAuH9E,MAAM,yBAAyB,GAAG,UAAU,CAAC;AAC7C,MAAM,CAAC,MAAM,uBAAuB,GAAG,QAAQ,CAAC;AAChD,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACjC,MAAM,2BAA2B,GAAG,eAAe,CAAC;AACpD,MAAM,kCAAkC,GAAG,CAAC,CAAC;AAE7C,SAAS,oBAAoB,CAAC,KAAc;IAC1C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;AAC9D,CAAC;AAED,SAAS,wBAAwB,CAC/B,KAAc;IAEd,OAAO,oBAAoB,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,qBAAqB,CAAC;AACxE,CAAC;AAED,SAAS,eAAe,CAAC,GAA4B;IACnD,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;AACxC,CAAC;AAED,SAAS,cAAc,CAAC,GAA4B;IAClD,OAAO,GAAG,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,YAAY,CAAC,GAA4B;IAChD,OAAO,GAAG,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,gBAAgB,CAAC,GAA4B;IACpD,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACxD,OAAO,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC;AACnE,CAAC;AAED,SAAS,oBAAoB,CAC3B,GAA4B;IAE5B,OAAO,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAwB;IACpD,MAAM,KAAK,GAAG,IAAI;SACf,IAAI,EAAE;SACN,KAAK,CAAC,UAAU,CAAC;SACjB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;SACjC,IAAI,CAAC,GAAG,CAAC;SACT,WAAW,EAAE,CAAC;IACjB,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,MAAyC,EACzC,KAAa,EACb,MAAsC;IAEtC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC5B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAC1C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,CAAC,IAAI,CAAC;QACV,KAAK;QACL,OAAO,EAAE,0BAA0B;QACnC,KAAK;KACN,CAAC,CAAC;IACH,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,qCAAqC,CAC5C,MAAyC;IAEzC,MAAM,MAAM,GAAmC,EAAE,CAAC;IAClD,MAAM,MAAM,GAA2B,EAAE,CAAC;IAE1C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACxC,MAAM,CAAC,KAAK,CAAC,GAAG,uBAAuB,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AAC5B,CAAC;AAED,SAAS,eAAe,CAAC,IAAY;IACnC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5B,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAED,SAAS,2BAA2B,CAClC,KAA6B,EAC7B,QAAmC;IAEnC,IAAI,KAAK,CAAC,YAAY,KAAK,qBAAqB,EAAE,CAAC;QACjD,OAAO;YACL,YAAY,EAAE,qBAAqB;YACnC,qBAAqB,EAAE,EAAE;YACzB,gBAAgB,EAAE,EAAE;YACpB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC;SACnC,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAAG,qCAAqC,CACrD,KAAK,CAAC,gBAAgB,CACvB,CAAC;IACF,OAAO;QACL,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,qBAAqB,EAAE,SAAS,CAAC,MAAM;QACvC,gBAAgB,EAAE,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE;QACzC,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,KAAK,EAAE,QAAQ,CAAC,wBAAwB,CAAC,KAAK,CAAC,YAAY,CAAC;KAC7D,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAChC,KAA6B,EAC7B,UAA8B;IAE9B,OAAO;QACL,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,qBAAqB,EAAE,CAAC,GAAG,UAAU,CAAC,qBAAqB,CAAC;QAC5D,gBAAgB,EAAE,EAAE,GAAG,UAAU,CAAC,gBAAgB,EAAE;QACpD,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,KAAK,EAAE,UAAU,CAAC,KAAK;KACxB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,+BAA+B,CAC7C,cAA0D,EAAE;IAE5D,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAG9B,CAAC;IACJ,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;QACJ,CAAC;QAED,iBAAiB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,QAAQ,GAA8B;QAC1C,aAAa,CAAC,IAAI;YAChB,OAAO,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC;QACD,yBAAyB;YACvB,OAAO,WAAW,CAAC,OAAO,CACxB,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,MAAM,IAAI,EAAE,CAC1D,CAAC;QACJ,CAAC;QACD,0BAA0B,CAAC,IAAI;YAC7B,OAAO,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAC1E,CAAC;QACD,wBAAwB,CAAC,IAAI;YAC3B,MAAM,UAAU,GAAG,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC/C,IAAI,UAAU,EAAE,aAAa,EAAE,CAAC;gBAC9B,OAAO,UAAU,CAAC,aAAa,CAAC;YAClC,CAAC;YAED,IAAI,IAAI,KAAK,qBAAqB,EAAE,CAAC;gBACnC,OAAO,eAAe,CAAC;YACzB,CAAC;YAED,sEAAsE;YACtE,6DAA6D;YAC7D,0BAA0B;YAC1B,IAAI,IAAI,KAAK,kCAAkC,EAAE,CAAC;gBAChD,OAAO,sBAAsB,CAAC;YAChC,CAAC;YAED,OAAO,YAAY,QAAQ,CAAC,0BAA0B,CAAC,IAAI,CAAC,EAAE,CAAC;QACjE,CAAC;QACD,4BAA4B,CAAC,GAAG,EAAE,IAAI;YACpC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpC,OAAO;YACT,CAAC;YAED,MAAM,QAAQ,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;YACrC,MAAM,UAAU,GAAG,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC/C,QAAQ,CAAC,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;YACtC,QAAQ,CAAC,GAAG,CACV,2BAA2B,EAC3B,UAAU,EAAE,aAAa,IAAI,kCAAkC,CAChE,CAAC;YACF,YAAY,CAAC,GAAG,CAAC,CAAC;YAClB,UAAU,EAAE,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC;QAChC,CAAC;QACD,0BAA0B,CAAC,KAAK;YAC9B,MAAM,UAAU,GAAG,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC7D,IAAI,UAAU,EAAE,OAAO,EAAE,CAAC;gBACxB,OAAO,yBAAyB,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;YACrE,CAAC;YAED,OAAO,2BAA2B,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACtD,CAAC;QACD,KAAK,CAAC,oCAAoC,CAAC,KAAK;YAC9C,MAAM,iBAAiB;iBACpB,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC;gBACxB,EAAE,gBAAgB,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QACD,KAAK,CAAC,kCAAkC,CAAC,KAAK;YAC5C,MAAM,iBAAiB;iBACpB,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC;gBACxB,EAAE,gBAAgB,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;KACF,CAAC;IAEF,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,CAAC,MAAM,gCAAgC,GAC3C,+BAA+B,EAAE,CAAC;AAEpC,MAAM,8BAA8B,GAAG,IAAI,OAAO,EAG/C,CAAC;AAEJ,SAAS,2BAA2B,CAClC,KAAqC;IAErC,OAAO,CACL,2BAA2B,IAAI,KAAK;QACpC,OAAO,KAAK,CAAC,yBAAyB,KAAK,UAAU,CACtD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gCAAgC,CAC9C,KAAwD;IAExD,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,gCAAgC,CAAC;IAC1C,CAAC;IAED,IAAI,2BAA2B,CAAC,KAAK,CAAC,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,MAAM,GAAG,8BAA8B,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACzD,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,QAAQ,GAAG,+BAA+B,CAAC,KAAK,CAAC,CAAC;IACxD,8BAA8B,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACpD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,iCAAiC,CAC/C,WAEgB,gCAAgC;IAEhD,OAAO,gCAAgC,CAAC,QAAQ,CAAC,CAAC,yBAAyB,EAAE,CAAC;AAChF,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,IAAwB,EACxB,WAA2C,gCAAgC;IAE3E,OAAO,gCAAgC,CAAC,QAAQ,CAAC,CAAC,wBAAwB,CACxE,IAAI,CACL,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,IAAwB,EACxB,WAA2C,gCAAgC;IAE3E,OAAO,gCAAgC,CAAC,QAAQ,CAAC,CAAC,0BAA0B,CAC1E,IAAI,CACL,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,IAAY;IACpD,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,KAA6B,EAC7B,WAA2C,gCAAgC;IAE3E,OAAO,gCAAgC,CAAC,QAAQ,CAAC,CAAC,0BAA0B,CAC1E,KAAK,CACN,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,GAA4B,EAC5B,WAA2C,gCAAgC;IAE3E,MAAM,gBAAgB,GAAG,gCAAgC,CAAC,QAAQ,CAAC,CAAC;IACpE,MAAM,YAAY,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAC3C,MAAM,IAAI,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;IAClC,MAAM,gBAAgB,GAAG,wBAAwB,CAAC,YAAY,CAAC;QAC7D,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC;QAC3B,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,IAAI,GAAG,wBAAwB,CAAC,YAAY,CAAC;QACjD,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1E,CAAC,CAAC,EAAE,CAAC;IAEP,OAAO,gBAAgB,CAAC,0BAA0B,CAAC;QACjD,YAAY;QACZ,gBAAgB;QAChB,IAAI;QACJ,IAAI;KACL,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,4BAA4B,CAC1C,GAA4B,EAC5B,IAAwB,EACxB,WAA2C,gCAAgC;IAE3E,gCAAgC,CAAC,QAAQ,CAAC,CAAC,4BAA4B,CACrE,GAAG,EACH,IAAI,CACL,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yBAAyB,CACvC,GAA4B,EAC5B,IAAyC,EACzC,KAA4D,EAC5D,WAA2C,gCAAgC;IAE3E,gCAAgC,CAAC,QAAQ,CAAC,CAAC,4BAA4B,CACrE,GAAG,EACH,IAAI,CACL,CAAC;IACF,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;IAEjC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACnB,SAAS;QACX,CAAC;QAED,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACzB,CAAC;AACH,CAAC","sourcesContent":["import type { LoroList, LoroMap } from \"@tearleads/loro\";\nimport type { ExecSql, SqlTableSchema } from \"../sqlite/sqlSchema\";\nimport {\n  DEFAULT_DOCUMENT_KIND,\n  ORGANIZATION_PROFILE_DOCUMENT_KIND,\n} from \"./documentConstants\";\nimport { type DocumentRowSummary, listDocumentRows } from \"./documentRowList\";\n\nexport type StoredDocumentKind = string;\n\nexport interface DocumentFieldValidationIssue {\n  field: string;\n  message: string;\n  value: unknown;\n}\n\nexport interface ValidatedDocumentFields<TFields> {\n  fields: TFields;\n  issues: DocumentFieldValidationIssue[];\n}\n\nexport interface StoredDocumentState {\n  documentKind: StoredDocumentKind;\n  fieldValidationIssues: DocumentFieldValidationIssue[];\n  structuredFields: Record<string, string>;\n  text: string;\n  title: string;\n}\n\nexport interface StructuredDocumentMap {\n  delete: (key: string) => void;\n  entries: () => Array<[string, unknown]>;\n  get: (key: string) => unknown;\n  getOrCreateContainer: (\n    key: string,\n    container: LoroMap<Record<string, unknown>>,\n  ) => StructuredDocumentMap;\n  set: (key: string, value: string | number) => void;\n}\n\nexport interface StructuredDocumentText {\n  toString: () => string;\n}\n\nexport interface StructuredDocumentShape {\n  getList: (key: string) => LoroList;\n  getMap: (key: string) => StructuredDocumentMap;\n  getText: (key: string) => StructuredDocumentText;\n}\n\nexport interface DocumentProjectorInput {\n  documentKind: StoredDocumentKind;\n  structuredFields: Readonly<Record<string, unknown>>;\n  text: string;\n  // The document's repeated rows (variables, readings, …), so a projector can\n  // derive a count-based title. Absent for kinds that carry no row list.\n  rows?: ReadonlyArray<DocumentRowSummary> | undefined;\n}\n\nexport interface DocumentProjection {\n  fieldValidationIssues: ReadonlyArray<DocumentFieldValidationIssue>;\n  structuredFields: Readonly<Record<string, string>>;\n  title: string;\n}\n\nexport interface DocumentClientProjectionSaveInput {\n  containerId: string | null;\n  documentId: string | null;\n  documentKind: StoredDocumentKind;\n  execSql: ExecSql;\n  localId: string;\n  structuredFields: Readonly<Record<string, string>>;\n  text: string;\n  title: string;\n  updatedAt: string;\n}\n\nexport interface DocumentClientProjectionDeleteInput {\n  documentKind: StoredDocumentKind;\n  execSql: ExecSql;\n  localId: string;\n}\n\nexport interface DocumentClientProjectionDefinition {\n  delete?: (input: DocumentClientProjectionDeleteInput) => Promise<void> | void;\n  save: (input: DocumentClientProjectionSaveInput) => Promise<void> | void;\n  tables: ReadonlyArray<SqlTableSchema>;\n}\n\nexport interface DocumentProjectorDefinition {\n  kind: StoredDocumentKind;\n  label?: string | undefined;\n  schemaVersion?: number | undefined;\n  untitledTitle?: string | undefined;\n  clientProjection?: DocumentClientProjectionDefinition | undefined;\n  initialize?: ((doc: StructuredDocumentShape) => void) | undefined;\n  project?: ((input: DocumentProjectorInput) => DocumentProjection) | undefined;\n}\n\nexport interface DocumentProjectorRegistry {\n  getDefinition: (\n    kind: StoredDocumentKind,\n  ) => DocumentProjectorDefinition | undefined;\n  getStoredDocumentTypeLabel: (kind: StoredDocumentKind) => string;\n  getClientProjectionTables: () => ReadonlyArray<SqlTableSchema>;\n  getUntitledDocumentTitle: (kind: StoredDocumentKind) => string;\n  initializeStoredDocumentKind: (\n    doc: StructuredDocumentShape,\n    kind: StoredDocumentKind,\n  ) => void;\n  projectStoredDocumentState: (\n    input: DocumentProjectorInput,\n  ) => StoredDocumentState;\n  deleteStoredDocumentClientProjection: (\n    input: DocumentClientProjectionDeleteInput,\n  ) => Promise<void>;\n  saveStoredDocumentClientProjection: (\n    input: DocumentClientProjectionSaveInput,\n  ) => Promise<void>;\n}\n\nexport type DocumentProjectorRegistryInput =\n  | DocumentProjectorRegistry\n  | ReadonlyArray<DocumentProjectorDefinition>;\n\nconst DOCUMENT_METADATA_MAP_KEY = \"metadata\";\nexport const DOCUMENT_FIELDS_MAP_KEY = \"fields\";\nconst DOCUMENT_KIND_KEY = \"kind\";\nconst DOCUMENT_SCHEMA_VERSION_KEY = \"schemaVersion\";\nconst STRUCTURED_DOCUMENT_SCHEMA_VERSION = 1;\n\nfunction isStoredDocumentKind(value: unknown): value is StoredDocumentKind {\n  return typeof value === \"string\" && value.trim().length > 0;\n}\n\nfunction isStructuredDocumentKind(\n  value: unknown,\n): value is Exclude<StoredDocumentKind, \"note\"> {\n  return isStoredDocumentKind(value) && value !== DEFAULT_DOCUMENT_KIND;\n}\n\nfunction getDocumentText(doc: StructuredDocumentShape): string {\n  return doc.getText(\"text\").toString();\n}\n\nfunction getMetadataMap(doc: StructuredDocumentShape): StructuredDocumentMap {\n  return doc.getMap(DOCUMENT_METADATA_MAP_KEY);\n}\n\nfunction getFieldsMap(doc: StructuredDocumentShape): StructuredDocumentMap {\n  return doc.getMap(DOCUMENT_FIELDS_MAP_KEY);\n}\n\nfunction readDocumentKind(doc: StructuredDocumentShape): StoredDocumentKind {\n  const kind = getMetadataMap(doc).get(DOCUMENT_KIND_KEY);\n  return isStoredDocumentKind(kind) ? kind : DEFAULT_DOCUMENT_KIND;\n}\n\nfunction readStructuredFields(\n  doc: StructuredDocumentShape,\n): Record<string, unknown> {\n  return Object.fromEntries(getFieldsMap(doc).entries());\n}\n\nfunction humanizeDocumentKind(kind: StoredDocumentKind): string {\n  const label = kind\n    .trim()\n    .split(/[\\s_-]+/u)\n    .filter((part) => part.length > 0)\n    .join(\" \")\n    .toLowerCase();\n  return label.length > 0 ? label : \"document\";\n}\n\nexport function readStringDocumentField(\n  source: Readonly<Record<string, unknown>>,\n  field: string,\n  issues: DocumentFieldValidationIssue[],\n): string {\n  const value = source[field];\n  if (value === undefined || value === null) {\n    return \"\";\n  }\n\n  if (typeof value === \"string\") {\n    return value;\n  }\n\n  issues.push({\n    field,\n    message: \"Expected a string value.\",\n    value,\n  });\n  return \"\";\n}\n\nfunction readGenericStructuredFieldsFromRecord(\n  source: Readonly<Record<string, unknown>>,\n): ValidatedDocumentFields<Record<string, string>> {\n  const issues: DocumentFieldValidationIssue[] = [];\n  const fields: Record<string, string> = {};\n\n  for (const field of Object.keys(source)) {\n    fields[field] = readStringDocumentField(source, field, issues);\n  }\n\n  return { fields, issues };\n}\n\nfunction deriveNoteTitle(text: string): string {\n  for (const line of text.split(/\\r?\\n/u)) {\n    const trimmed = line.trim();\n    if (trimmed.length > 0) {\n      return trimmed;\n    }\n  }\n\n  return \"Untitled note\";\n}\n\nfunction projectDefaultDocumentState(\n  input: DocumentProjectorInput,\n  registry: DocumentProjectorRegistry,\n): StoredDocumentState {\n  if (input.documentKind === DEFAULT_DOCUMENT_KIND) {\n    return {\n      documentKind: DEFAULT_DOCUMENT_KIND,\n      fieldValidationIssues: [],\n      structuredFields: {},\n      text: input.text,\n      title: deriveNoteTitle(input.text),\n    };\n  }\n\n  const validated = readGenericStructuredFieldsFromRecord(\n    input.structuredFields,\n  );\n  return {\n    documentKind: input.documentKind,\n    fieldValidationIssues: validated.issues,\n    structuredFields: { ...validated.fields },\n    text: input.text,\n    title: registry.getUntitledDocumentTitle(input.documentKind),\n  };\n}\n\nfunction createStoredDocumentState(\n  input: DocumentProjectorInput,\n  projection: DocumentProjection,\n): StoredDocumentState {\n  return {\n    documentKind: input.documentKind,\n    fieldValidationIssues: [...projection.fieldValidationIssues],\n    structuredFields: { ...projection.structuredFields },\n    text: input.text,\n    title: projection.title,\n  };\n}\n\nexport function createDocumentProjectorRegistry(\n  definitions: ReadonlyArray<DocumentProjectorDefinition> = [],\n): DocumentProjectorRegistry {\n  const definitionsByKind = new Map<\n    StoredDocumentKind,\n    DocumentProjectorDefinition\n  >();\n  for (const definition of definitions) {\n    if (!isStoredDocumentKind(definition.kind)) {\n      throw new Error(\n        \"Document projector definitions require a non-empty kind.\",\n      );\n    }\n\n    definitionsByKind.set(definition.kind, definition);\n  }\n\n  const registry: DocumentProjectorRegistry = {\n    getDefinition(kind) {\n      return definitionsByKind.get(kind);\n    },\n    getClientProjectionTables() {\n      return definitions.flatMap(\n        (definition) => definition.clientProjection?.tables ?? [],\n      );\n    },\n    getStoredDocumentTypeLabel(kind) {\n      return definitionsByKind.get(kind)?.label ?? humanizeDocumentKind(kind);\n    },\n    getUntitledDocumentTitle(kind) {\n      const definition = definitionsByKind.get(kind);\n      if (definition?.untitledTitle) {\n        return definition.untitledTitle;\n      }\n\n      if (kind === DEFAULT_DOCUMENT_KIND) {\n        return \"Untitled note\";\n      }\n\n      // The SDK provisions this kind itself, so hosts that never register a\n      // projector for it still get its stable title instead of the\n      // humanized generic form.\n      if (kind === ORGANIZATION_PROFILE_DOCUMENT_KIND) {\n        return \"Organization Profile\";\n      }\n\n      return `Untitled ${registry.getStoredDocumentTypeLabel(kind)}`;\n    },\n    initializeStoredDocumentKind(doc, kind) {\n      if (!isStructuredDocumentKind(kind)) {\n        return;\n      }\n\n      const metadata = getMetadataMap(doc);\n      const definition = definitionsByKind.get(kind);\n      metadata.set(DOCUMENT_KIND_KEY, kind);\n      metadata.set(\n        DOCUMENT_SCHEMA_VERSION_KEY,\n        definition?.schemaVersion ?? STRUCTURED_DOCUMENT_SCHEMA_VERSION,\n      );\n      getFieldsMap(doc);\n      definition?.initialize?.(doc);\n    },\n    projectStoredDocumentState(input) {\n      const definition = definitionsByKind.get(input.documentKind);\n      if (definition?.project) {\n        return createStoredDocumentState(input, definition.project(input));\n      }\n\n      return projectDefaultDocumentState(input, registry);\n    },\n    async deleteStoredDocumentClientProjection(input) {\n      await definitionsByKind\n        .get(input.documentKind)\n        ?.clientProjection?.delete?.(input);\n    },\n    async saveStoredDocumentClientProjection(input) {\n      await definitionsByKind\n        .get(input.documentKind)\n        ?.clientProjection?.save(input);\n    },\n  };\n\n  return registry;\n}\n\nexport const defaultDocumentProjectorRegistry =\n  createDocumentProjectorRegistry();\n\nconst documentProjectorRegistryCache = new WeakMap<\n  ReadonlyArray<DocumentProjectorDefinition>,\n  DocumentProjectorRegistry\n>();\n\nfunction isDocumentProjectorRegistry(\n  input: DocumentProjectorRegistryInput,\n): input is DocumentProjectorRegistry {\n  return (\n    \"getClientProjectionTables\" in input &&\n    typeof input.getClientProjectionTables === \"function\"\n  );\n}\n\nexport function resolveDocumentProjectorRegistry(\n  input: DocumentProjectorRegistryInput | null | undefined,\n): DocumentProjectorRegistry {\n  if (input == null) {\n    return defaultDocumentProjectorRegistry;\n  }\n\n  if (isDocumentProjectorRegistry(input)) {\n    return input;\n  }\n\n  const cached = documentProjectorRegistryCache.get(input);\n  if (cached) {\n    return cached;\n  }\n\n  const registry = createDocumentProjectorRegistry(input);\n  documentProjectorRegistryCache.set(input, registry);\n  return registry;\n}\n\nexport function getDocumentClientProjectionTables(\n  registry:\n    | DocumentProjectorRegistryInput\n    | undefined = defaultDocumentProjectorRegistry,\n): ReadonlyArray<SqlTableSchema> {\n  return resolveDocumentProjectorRegistry(registry).getClientProjectionTables();\n}\n\nexport function getUntitledDocumentTitle(\n  kind: StoredDocumentKind,\n  registry: DocumentProjectorRegistryInput = defaultDocumentProjectorRegistry,\n): string {\n  return resolveDocumentProjectorRegistry(registry).getUntitledDocumentTitle(\n    kind,\n  );\n}\n\nexport function getStoredDocumentTypeLabel(\n  kind: StoredDocumentKind,\n  registry: DocumentProjectorRegistryInput = defaultDocumentProjectorRegistry,\n): string {\n  return resolveDocumentProjectorRegistry(registry).getStoredDocumentTypeLabel(\n    kind,\n  );\n}\n\nexport function deriveStoredDocumentTitle(text: string): string {\n  return deriveNoteTitle(text);\n}\n\nexport function projectStoredDocumentState(\n  input: DocumentProjectorInput,\n  registry: DocumentProjectorRegistryInput = defaultDocumentProjectorRegistry,\n): StoredDocumentState {\n  return resolveDocumentProjectorRegistry(registry).projectStoredDocumentState(\n    input,\n  );\n}\n\nexport function readStoredDocumentState(\n  doc: StructuredDocumentShape,\n  registry: DocumentProjectorRegistryInput = defaultDocumentProjectorRegistry,\n): StoredDocumentState {\n  const resolvedRegistry = resolveDocumentProjectorRegistry(registry);\n  const documentKind = readDocumentKind(doc);\n  const text = getDocumentText(doc);\n  const structuredFields = isStructuredDocumentKind(documentKind)\n    ? readStructuredFields(doc)\n    : {};\n  const rows = isStructuredDocumentKind(documentKind)\n    ? listDocumentRows(doc).map((row) => ({ id: row.id, fields: row.fields }))\n    : [];\n\n  return resolvedRegistry.projectStoredDocumentState({\n    documentKind,\n    structuredFields,\n    text,\n    rows,\n  });\n}\n\nexport function initializeStoredDocumentKind(\n  doc: StructuredDocumentShape,\n  kind: StoredDocumentKind,\n  registry: DocumentProjectorRegistryInput = defaultDocumentProjectorRegistry,\n): void {\n  resolveDocumentProjectorRegistry(registry).initializeStoredDocumentKind(\n    doc,\n    kind,\n  );\n}\n\nexport function writeStoredDocumentFields(\n  doc: StructuredDocumentShape,\n  kind: Exclude<StoredDocumentKind, \"note\">,\n  patch: Readonly<Record<string, string | number | undefined>>,\n  registry: DocumentProjectorRegistryInput = defaultDocumentProjectorRegistry,\n): void {\n  resolveDocumentProjectorRegistry(registry).initializeStoredDocumentKind(\n    doc,\n    kind,\n  );\n  const fields = getFieldsMap(doc);\n\n  for (const [key, value] of Object.entries(patch)) {\n    if (value === undefined) {\n      fields.delete(key);\n      continue;\n    }\n\n    fields.set(key, value);\n  }\n}\n"]}

package/data/documents/documentRowList.d.ts

@@ -0,0 +1,31 @@
+import { type LoroList } from "../../internal/loro/index.js";
+export interface DocumentRowAttribution {
+    userId: string;
+    at: string;
+}
+export interface DocumentRow {
+    id: string;
+    fields: Record<string, string>;
+    createdBy: string;
+    createdAt: string;
+    updatedBy: string;
+    updatedAt: string;
+    updatedByPeer: string | null;
+    createdByPeer: string | null;
+    fieldEditors: Record<string, string | null>;
+}
+export interface DocumentRowSummary {
+    id: string;
+    fields: Readonly<Record<string, string>>;
+}
+interface RowListDocumentShape {
+    getList: (key: string) => LoroList;
+}
+export declare function createDocumentRowId(): string;
+export declare function ensureDocumentRowsStructure(doc: RowListDocumentShape): void;
+export declare function listDocumentRows(doc: RowListDocumentShape): DocumentRow[];
+export declare function addDocumentRow(doc: RowListDocumentShape, id: string, fields: Readonly<Record<string, string>>, attribution: DocumentRowAttribution): void;
+export declare function setDocumentRowFields(doc: RowListDocumentShape, id: string, patch: Readonly<Record<string, string>>, attribution: DocumentRowAttribution): boolean;
+export declare function removeDocumentRow(doc: RowListDocumentShape, id: string): boolean;
+export declare function sameDocumentRows(left: ReadonlyArray<DocumentRow>, right: ReadonlyArray<DocumentRow>): boolean;
+export {};