@milaboratories/pl-middle-layer 1.71.15 → 1.72.0

package/dist/mutator/sharing.js.map

@@ -1 +1 @@
-{"version":3,"file":"sharing.js","names":[],"sources":["../../src/mutator/sharing.ts"],"sourcesContent":["import type { PlTransaction, ResourceRef, SignedResourceId } from \"@milaboratories/pl-client\";\nimport { field, isNotNullSignedResourceId, resourceIdToString } from \"@milaboratories/pl-client\";\nimport { randomUUID } from \"node:crypto\";\nimport type { ProjectMeta } from \"@milaboratories/pl-model-middle-layer\";\nimport type { ProjectId, ProjectTemplateV1 } from \"@milaboratories/pl-model-common\";\nimport { ProjectMetaKey } from \"../model/project_model\";\nimport { duplicateProject } from \"./project\";\nimport type {\n  EnvelopeData,\n  EnvelopeAcceptance,\n  EnvelopeMode,\n  EnvelopeProject,\n  ProjectFieldUuid,\n  ShareId,\n  SharingDecision,\n} from \"../model/sharing_model\";\nimport {\n  EnvelopeSchemaVersionCurrent,\n  SharedEnvelopeResourceType,\n  acceptanceField,\n  decisionField,\n  newShareId,\n} from \"../model/sharing_model\";\n\n/** Field name carrying a project snapshot inside a {@link SharedEnvelopeResourceType}. */\nexport const EnvelopeProjectFieldPrefix = \"project/\";\nexport const envelopeProjectField = (uuid: ProjectFieldUuid) =>\n  `${EnvelopeProjectFieldPrefix}${uuid}`;\n\n/** True for an envelope field that carries a project snapshot. */\nexport function isEnvelopeProjectField(name: string): boolean {\n  return name.startsWith(EnvelopeProjectFieldPrefix);\n}\n\n/** Extracts the project field uuid from a `project/{uuid}` field name. */\nexport function envelopeProjectFieldUuid(name: string): ProjectFieldUuid {\n  return name.slice(EnvelopeProjectFieldPrefix.length) as ProjectFieldUuid;\n}\n\n//\n// Donor side\n//\n\n/**\n * One project going into an envelope: `fresh` snapshots a live source (normal path); `carry`\n * re-attaches an existing snapshot (change's \"keep\", or an \"update\" whose source is gone).\n */\nexport type EnvelopeProjectSource =\n  | { kind: \"fresh\"; projectId: ProjectId; sourceRid: SignedResourceId }\n  | {\n      kind: \"carry\";\n      projectId: ProjectId;\n      label: string;\n      snapshotRid: SignedResourceId;\n      /** ms epoch the carried snapshot was last taken; preserved so \"keep\" keeps its timestamp. */\n      updatedAt: number;\n    };\n\n/**\n * Builds one {@link SharedEnvelopeResourceType} on the donor side inside the given write\n * transaction: snapshots each source project by reference, seals the envelope with its\n * immutable {@link EnvelopeData}, and attaches the envelope under `{shareId}` on the donor's\n * outbox. The caller is responsible for issuing the per-recipient grants and committing the\n * transaction — keeping create + grant atomic.\n *\n * @returns the new envelope resource and the generated `EnvelopeData`.\n */\nexport async function buildShareEnvelope(\n  tx: PlTransaction,\n  outboxRid: SignedResourceId,\n  sources: EnvelopeProjectSource[],\n  params: {\n    mode: EnvelopeMode;\n    sender: string;\n    title: string;\n    /** ms epoch; sharedAt + ttl for a targeted share, null for share-with-everybody. */\n    expiresAt: number | null;\n    /** Existing shareId for a change; a fresh one is minted when omitted. */\n    shareId?: ShareId;\n    sharedAt?: number;\n  },\n): Promise<{ envelope: ResourceRef; data: EnvelopeData }> {\n  const shareId = params.shareId ?? newShareId();\n  const sharedAt = params.sharedAt ?? Date.now();\n\n  // Snapshot (fresh) or re-attach (carry) each project, collecting its metadata for the pack.\n  const projects: Record<ProjectFieldUuid, EnvelopeProject> = {};\n  const snapshots: { uuid: ProjectFieldUuid; ref: ResourceRef | SignedResourceId }[] = [];\n  for (const src of sources) {\n    const uuid = randomUUID() as ProjectFieldUuid;\n    if (src.kind === \"fresh\") {\n      const meta = await tx.getKValueJson<ProjectMeta>(src.sourceRid, ProjectMetaKey);\n      const ref = await duplicateProject(tx, src.sourceRid, { label: meta.label });\n      projects[uuid] = { label: meta.label, source: src.projectId, updatedAt: sharedAt }; // (re)snapshotted now\n      snapshots.push({ uuid, ref });\n    } else {\n      // Re-attach the prior snapshot; the new envelope references it before the old one is\n      // detached in the same tx, so it stays alive. Label and timestamp carry unchanged.\n      projects[uuid] = { label: src.label, source: src.projectId, updatedAt: src.updatedAt };\n      snapshots.push({ uuid, ref: src.snapshotRid });\n    }\n  }\n\n  const data: EnvelopeData = {\n    schemaVersion: EnvelopeSchemaVersionCurrent,\n    shareId,\n    sharedAt,\n    expiresAt: params.expiresAt,\n    mode: params.mode,\n    sender: params.sender,\n    title: params.title,\n    payload: { kind: \"projects\", projects },\n  };\n\n  // Immutable data set once at creation, never altered.\n  const envelope = tx.createEphemeral(SharedEnvelopeResourceType, JSON.stringify(data));\n\n  // Attach the project snapshots as Input fields, then seal the input set one-way.\n  for (const { uuid, ref } of snapshots) {\n    tx.createField(field(envelope, envelopeProjectField(uuid)), \"Input\", ref);\n  }\n  tx.lockInputs(envelope);\n\n  // Attach to the outbox under {shareId} in the same transaction so the held-resource rule\n  // keeps the ephemeral envelope alive.\n  tx.createField(field(outboxRid, shareId), \"Dynamic\", envelope);\n\n  return { envelope, data };\n}\n\n/**\n * Builds one {@link SharedEnvelopeResourceType} carrying a template document on the donor side,\n * and attaches it under `{shareId}` on the donor's outbox. The caller issues the grant — always\n * read-only — and commits, keeping create + grant atomic.\n *\n * There is nothing to snapshot and no input field to seal: the document is the whole payload and\n * rides in the envelope's immutable `data`, which is also why the recipient needs no write access\n * (it copies no resource out of the envelope).\n *\n * @returns the new envelope resource and the generated `EnvelopeData`.\n */\nexport function buildTemplateShareEnvelope(\n  tx: PlTransaction,\n  outboxRid: SignedResourceId,\n  template: { document: ProjectTemplateV1; label: string },\n  params: {\n    sender: string;\n    title: string;\n    /** ms epoch; sharedAt + ttl for a targeted share, null for share-with-everybody. */\n    expiresAt: number | null;\n    /** Existing shareId for a change; a fresh one is minted when omitted. */\n    shareId?: ShareId;\n    sharedAt?: number;\n  },\n): { envelope: ResourceRef; data: EnvelopeData } {\n  const data: EnvelopeData = {\n    schemaVersion: EnvelopeSchemaVersionCurrent,\n    shareId: params.shareId ?? newShareId(),\n    sharedAt: params.sharedAt ?? Date.now(),\n    expiresAt: params.expiresAt,\n    mode: \"read-only\",\n    sender: params.sender,\n    title: params.title,\n    payload: {\n      kind: \"template\",\n      document: template.document,\n      label: template.label,\n      from: params.sender,\n    },\n  };\n\n  // Immutable data set once at creation, never altered.\n  const envelope = tx.createEphemeral(SharedEnvelopeResourceType, JSON.stringify(data));\n\n  // Attach to the outbox under {shareId} in the same transaction so the held-resource rule\n  // keeps the ephemeral envelope alive.\n  tx.createField(field(outboxRid, data.shareId), \"Dynamic\", envelope);\n\n  return { envelope, data };\n}\n\n/**\n * Records a response onto the envelope as a dynamic `acceptance/{login}` field: the acceptor\n * writing their own decision (their writable grant permits it), or the donor transferring an\n * existing record onto a changed envelope. Accepts the envelope by ref or id.\n */\nexport function writeEnvelopeAcceptance(\n  tx: PlTransaction,\n  envelopeRid: ResourceRef | SignedResourceId,\n  login: string,\n  action: EnvelopeAcceptance[\"action\"],\n  timestamp: number,\n): void {\n  const acceptance: EnvelopeAcceptance = { action, timestamp };\n  const value = tx.createJsonValue(acceptance);\n  tx.createField(field(envelopeRid, acceptanceField(login)), \"Dynamic\", value);\n}\n\n//\n// Acceptor side\n//\n\n/**\n * Records the acceptor's decision for a handled share on the acceptor's SharingState as a\n * dynamic `decision/{shareId}` field. Keyed on the logical shareId so discovery dedups on the\n * share, not on the envelope instance.\n */\nexport function writeSharingDecision(\n  tx: PlTransaction,\n  stateRid: SignedResourceId,\n  shareId: ShareId,\n  decision: SharingDecision,\n): void {\n  const value = tx.createJsonValue(decision);\n  tx.createField(field(stateRid, decisionField(shareId)), \"Dynamic\", value);\n}\n\n/**\n * Copies every project snapshot inside an envelope into the acceptor's own project list — a\n * cross-color attach the backend permits. Mirrors {@link duplicateProject}'s `rename` contract,\n * but resolves the source against the envelope tree (not the acceptor's own list), so the\n * wrapper cannot be reused.\n *\n * @returns ids of the projects created in the acceptor's list.\n */\nexport async function copyEnvelopeProjectsIntoList(\n  tx: PlTransaction,\n  envelopeRid: SignedResourceId,\n  projectListRid: SignedResourceId,\n  rename?: (previousLabel: string, existingLabels: string[]) => string,\n): Promise<SignedResourceId[]> {\n  // Read the acceptor's existing project labels once (own color, no relaxation).\n  const projectListData = await tx.getResourceData(projectListRid, true);\n  const existingRids = projectListData.fields.map((f) => f.value).filter(isNotNullSignedResourceId);\n  const existingLabels = (\n    await Promise.all(existingRids.map((rid) => tx.getKValueJson<ProjectMeta>(rid, ProjectMetaKey)))\n  ).map((m) => m.label);\n\n  // Enumerate the envelope's project/{uuid} input field values (signed envelope-colored ids).\n  const envelopeData = await tx.getResourceData(envelopeRid, true);\n  const sourceRids = envelopeData.fields\n    .filter((f) => isEnvelopeProjectField(f.name))\n    .map((f) => f.value)\n    .filter(isNotNullSignedResourceId);\n\n  const created: SignedResourceId[] = [];\n  for (const sourceRid of sourceRids) {\n    const sourceMeta = await tx.getKValueJson<ProjectMeta>(sourceRid, ProjectMetaKey);\n    const newLabel = rename ? rename(sourceMeta.label, existingLabels) : sourceMeta.label;\n    existingLabels.push(newLabel);\n\n    // Cross-color attach: a new UserProject in the acceptor's color whose fields point at\n    // envelope-colored resources. Fails with PermissionDenied: color mismatch on a backend\n    // that lacks crossTreeRefs:v1.\n    const newPrj = await duplicateProject(tx, sourceRid, { label: newLabel });\n    tx.createField(field(projectListRid, randomUUID()), \"Dynamic\", newPrj);\n\n    const signedRid = await newPrj.globalId;\n    created.push(signedRid);\n  }\n\n  return created;\n}\n\n/** String-form ids of the projects created by {@link copyEnvelopeProjectsIntoList}. */\nexport function resourceIdsToStrings(ids: SignedResourceId[]): string[] {\n  return ids.map((id) => resourceIdToString(id));\n}\n"],"mappings":";;;;;;;AAyBA,MAAa,6BAA6B;AAC1C,MAAa,wBAAwB,SACnC,GAAG,6BAA6B;;AAGlC,SAAgB,uBAAuB,MAAuB;CAC5D,OAAO,KAAK,WAAW,0BAA0B;AACnD;;AAGA,SAAgB,yBAAyB,MAAgC;CACvE,OAAO,KAAK,MAAM,CAAiC;AACrD;;;;;;;;;;AA8BA,eAAsB,mBACpB,IACA,WACA,SACA,QAUwD;CACxD,MAAM,UAAU,OAAO,WAAW,WAAW;CAC7C,MAAM,WAAW,OAAO,YAAY,KAAK,IAAI;CAG7C,MAAM,WAAsD,CAAC;CAC7D,MAAM,YAA+E,CAAC;CACtF,KAAK,MAAM,OAAO,SAAS;EACzB,MAAM,OAAO,WAAW;EACxB,IAAI,IAAI,SAAS,SAAS;GACxB,MAAM,OAAO,MAAM,GAAG,cAA2B,IAAI,WAAW,cAAc;GAC9E,MAAM,MAAM,MAAM,iBAAiB,IAAI,IAAI,WAAW,EAAE,OAAO,KAAK,MAAM,CAAC;GAC3E,SAAS,QAAQ;IAAE,OAAO,KAAK;IAAO,QAAQ,IAAI;IAAW,WAAW;GAAS;GACjF,UAAU,KAAK;IAAE;IAAM;GAAI,CAAC;EAC9B,OAAO;GAGL,SAAS,QAAQ;IAAE,OAAO,IAAI;IAAO,QAAQ,IAAI;IAAW,WAAW,IAAI;GAAU;GACrF,UAAU,KAAK;IAAE;IAAM,KAAK,IAAI;GAAY,CAAC;EAC/C;CACF;CAEA,MAAM,OAAqB;EACzB,eAAA;EACA;EACA;EACA,WAAW,OAAO;EAClB,MAAM,OAAO;EACb,QAAQ,OAAO;EACf,OAAO,OAAO;EACd,SAAS;GAAE,MAAM;GAAY;EAAS;CACxC;CAGA,MAAM,WAAW,GAAG,gBAAgB,4BAA4B,KAAK,UAAU,IAAI,CAAC;CAGpF,KAAK,MAAM,EAAE,MAAM,SAAS,WAC1B,GAAG,YAAY,MAAM,UAAU,qBAAqB,IAAI,CAAC,GAAG,SAAS,GAAG;CAE1E,GAAG,WAAW,QAAQ;CAItB,GAAG,YAAY,MAAM,WAAW,OAAO,GAAG,WAAW,QAAQ;CAE7D,OAAO;EAAE;EAAU;CAAK;AAC1B;;;;;;;;;;;;AAaA,SAAgB,2BACd,IACA,WACA,UACA,QAS+C;CAC/C,MAAM,OAAqB;EACzB,eAAA;EACA,SAAS,OAAO,WAAW,WAAW;EACtC,UAAU,OAAO,YAAY,KAAK,IAAI;EACtC,WAAW,OAAO;EAClB,MAAM;EACN,QAAQ,OAAO;EACf,OAAO,OAAO;EACd,SAAS;GACP,MAAM;GACN,UAAU,SAAS;GACnB,OAAO,SAAS;GAChB,MAAM,OAAO;EACf;CACF;CAGA,MAAM,WAAW,GAAG,gBAAgB,4BAA4B,KAAK,UAAU,IAAI,CAAC;CAIpF,GAAG,YAAY,MAAM,WAAW,KAAK,OAAO,GAAG,WAAW,QAAQ;CAElE,OAAO;EAAE;EAAU;CAAK;AAC1B;;;;;;AAOA,SAAgB,wBACd,IACA,aACA,OACA,QACA,WACM;CACN,MAAM,aAAiC;EAAE;EAAQ;CAAU;CAC3D,MAAM,QAAQ,GAAG,gBAAgB,UAAU;CAC3C,GAAG,YAAY,MAAM,aAAa,gBAAgB,KAAK,CAAC,GAAG,WAAW,KAAK;AAC7E;;;;;;AAWA,SAAgB,qBACd,IACA,UACA,SACA,UACM;CACN,MAAM,QAAQ,GAAG,gBAAgB,QAAQ;CACzC,GAAG,YAAY,MAAM,UAAU,cAAc,OAAO,CAAC,GAAG,WAAW,KAAK;AAC1E;;;;;;;;;AAUA,eAAsB,6BACpB,IACA,aACA,gBACA,QAC6B;CAG7B,MAAM,gBAAe,MADS,GAAG,gBAAgB,gBAAgB,IAAI,EAAA,CAChC,OAAO,KAAK,MAAM,EAAE,KAAK,CAAC,CAAC,OAAO,yBAAyB;CAChG,MAAM,kBACJ,MAAM,QAAQ,IAAI,aAAa,KAAK,QAAQ,GAAG,cAA2B,KAAK,cAAc,CAAC,CAAC,EAAA,CAC/F,KAAK,MAAM,EAAE,KAAK;CAIpB,MAAM,cAAa,MADQ,GAAG,gBAAgB,aAAa,IAAI,EAAA,CAC/B,OAC7B,QAAQ,MAAM,uBAAuB,EAAE,IAAI,CAAC,CAAC,CAC7C,KAAK,MAAM,EAAE,KAAK,CAAC,CACnB,OAAO,yBAAyB;CAEnC,MAAM,UAA8B,CAAC;CACrC,KAAK,MAAM,aAAa,YAAY;EAClC,MAAM,aAAa,MAAM,GAAG,cAA2B,WAAW,cAAc;EAChF,MAAM,WAAW,SAAS,OAAO,WAAW,OAAO,cAAc,IAAI,WAAW;EAChF,eAAe,KAAK,QAAQ;EAK5B,MAAM,SAAS,MAAM,iBAAiB,IAAI,WAAW,EAAE,OAAO,SAAS,CAAC;EACxE,GAAG,YAAY,MAAM,gBAAgB,WAAW,CAAC,GAAG,WAAW,MAAM;EAErE,MAAM,YAAY,MAAM,OAAO;EAC/B,QAAQ,KAAK,SAAS;CACxB;CAEA,OAAO;AACT;;AAGA,SAAgB,qBAAqB,KAAmC;CACtE,OAAO,IAAI,KAAK,OAAO,mBAAmB,EAAE,CAAC;AAC/C"}
+{"version":3,"file":"sharing.js","names":[],"sources":["../../src/mutator/sharing.ts"],"sourcesContent":["import type { PlTransaction, ResourceRef, SignedResourceId } from \"@milaboratories/pl-client\";\nimport { field, isNotNullSignedResourceId } from \"@milaboratories/pl-client\";\nimport { randomUUID } from \"node:crypto\";\nimport type { FolderId, ProjectMeta } from \"@milaboratories/pl-model-middle-layer\";\nimport { normalizeDescription } from \"@milaboratories/pl-model-middle-layer\";\nimport type { ProjectId, ProjectTemplateV1, TemplateId } from \"@milaboratories/pl-model-common\";\nimport { ProjectMetaKey } from \"../model/project_model\";\nimport { duplicateProject } from \"./project\";\nimport type {\n  EnvelopeData,\n  EnvelopeFolder,\n  EnvelopeFolderId,\n  EnvelopeFolderProject,\n  EnvelopeFolderTemplate,\n  EnvelopeMode,\n  EnvelopeProject,\n  ProjectFieldUuid,\n  ShareId,\n  ShareHidden,\n} from \"../model/sharing_model\";\nimport {\n  EnvelopeSchemaVersionCurrent,\n  SharedEnvelopeResourceType,\n  hiddenField,\n  newProjectFieldUuid,\n  newShareId,\n} from \"../model/sharing_model\";\n\n/** Field name carrying a project snapshot inside a {@link SharedEnvelopeResourceType}. */\nexport const EnvelopeProjectFieldPrefix = \"project/\";\nexport const envelopeProjectField = (uuid: ProjectFieldUuid) =>\n  `${EnvelopeProjectFieldPrefix}${uuid}`;\n\n/** True for an envelope field that carries a project snapshot. */\nexport function isEnvelopeProjectField(name: string): boolean {\n  return name.startsWith(EnvelopeProjectFieldPrefix);\n}\n\n/** Extracts the project field uuid from a `project/{uuid}` field name. */\nexport function envelopeProjectFieldUuid(name: string): ProjectFieldUuid {\n  return name.slice(EnvelopeProjectFieldPrefix.length) as ProjectFieldUuid;\n}\n\n//\n// Donor side\n//\n\n/** One live project going into an envelope; it is snapshotted as the envelope is built. */\nexport type EnvelopeProjectSource = { projectId: ProjectId; sourceRid: SignedResourceId };\n\n/**\n * Builds one {@link SharedEnvelopeResourceType} on the donor side inside the given write\n * transaction: snapshots each source project by reference, seals the envelope with its\n * immutable {@link EnvelopeData}, and attaches the envelope under `{shareId}` on the donor's\n * outbox. The caller is responsible for issuing the per-recipient grants and committing the\n * transaction — keeping create + grant atomic.\n *\n * @returns the new envelope resource and the generated `EnvelopeData`.\n */\nexport async function buildShareEnvelope(\n  tx: PlTransaction,\n  outboxRid: SignedResourceId,\n  sources: EnvelopeProjectSource[],\n  params: {\n    mode: EnvelopeMode;\n    sender: string;\n    title: string;\n    /** ms epoch; sharedAt + ttl for a targeted share, null for share-with-everybody. */\n    expiresAt: number | null;\n  },\n): Promise<{ envelope: ResourceRef; data: EnvelopeData }> {\n  const sharedAt = Date.now();\n  const snapshots = await snapshotEnvelopeProjects(tx, sources, sharedAt);\n\n  const projects: Record<ProjectFieldUuid, EnvelopeProject> = {};\n  for (const { uuid, project } of snapshots) projects[uuid] = project;\n\n  const data: EnvelopeData = {\n    schemaVersion: EnvelopeSchemaVersionCurrent,\n    shareId: newShareId(),\n    sharedAt,\n    expiresAt: params.expiresAt,\n    mode: params.mode,\n    sender: params.sender,\n    title: params.title,\n    payload: { kind: \"projects\", projects },\n  };\n\n  return { envelope: sealEnvelope(tx, outboxRid, data, snapshots), data };\n}\n\n/**\n * Builds one {@link SharedEnvelopeResourceType} carrying a template document on the donor side,\n * and attaches it under `{shareId}` on the donor's outbox. The caller issues the grant — always\n * read-only — and commits, keeping create + grant atomic.\n *\n * There is nothing to snapshot and no input field to seal: the document is the whole payload and\n * rides in the envelope's immutable `data`, which is also why the recipient needs no write access\n * (it copies no resource out of the envelope).\n *\n * @returns the new envelope resource and the generated `EnvelopeData`.\n */\nexport function buildTemplateShareEnvelope(\n  tx: PlTransaction,\n  outboxRid: SignedResourceId,\n  template: {\n    document: ProjectTemplateV1;\n    label: string;\n    description?: string;\n    source: TemplateId;\n  },\n  params: {\n    sender: string;\n    title: string;\n    /** ms epoch; sharedAt + ttl for a targeted share, null for share-with-everybody. */\n    expiresAt: number | null;\n  },\n): { envelope: ResourceRef; data: EnvelopeData } {\n  const data: EnvelopeData = {\n    schemaVersion: EnvelopeSchemaVersionCurrent,\n    shareId: newShareId(),\n    sharedAt: Date.now(),\n    expiresAt: params.expiresAt,\n    mode: \"read-only\",\n    sender: params.sender,\n    title: params.title,\n    payload: {\n      kind: \"template\",\n      document: template.document,\n      source: template.source,\n      label: template.label,\n      ...(template.description === undefined ? {} : { description: template.description }),\n      from: params.sender,\n    },\n  };\n\n  return { envelope: sealEnvelope(tx, outboxRid, data, []), data };\n}\n\n/**\n * Builds one {@link SharedEnvelopeResourceType} carrying a folder subtree: the folders, every\n * project in them snapshotted as a `project/{uuid}` field, and every template's document inline.\n * Attaches it under `{shareId}` on the donor's outbox. The caller issues the grant — writable,\n * because the recipient copies the project snapshots out — and commits.\n *\n * Folder ids are minted here and mean nothing outside this envelope: the recipient's own document\n * mints its own. What travels is the shape of the subtree.\n *\n * @returns the new envelope resource and the generated `EnvelopeData`.\n */\nexport async function buildFolderShareEnvelope(\n  tx: PlTransaction,\n  outboxRid: SignedResourceId,\n  subtree: EnvelopeFolderSubtree,\n  params: {\n    sender: string;\n    title: string;\n    /** ms epoch; sharedAt + ttl for a targeted share, null for share-with-everybody. */\n    expiresAt: number | null;\n  },\n): Promise<{ envelope: ResourceRef; data: EnvelopeData }> {\n  const sharedAt = Date.now();\n  const snapshots = await snapshotEnvelopeProjects(tx, subtree.projects, sharedAt);\n\n  const projects: Record<ProjectFieldUuid, EnvelopeFolderProject> = {};\n  for (const { uuid, project, source } of snapshots)\n    projects[uuid] = { ...project, folder: source.folder };\n\n  const data: EnvelopeData = {\n    schemaVersion: EnvelopeSchemaVersionCurrent,\n    shareId: newShareId(),\n    sharedAt,\n    expiresAt: params.expiresAt,\n    mode: \"copy\",\n    sender: params.sender,\n    title: params.title,\n    payload: {\n      kind: \"folder\",\n      source: subtree.source,\n      folders: subtree.folders,\n      projects,\n      templates: subtree.templates,\n      from: params.sender,\n    },\n  };\n\n  return { envelope: sealEnvelope(tx, outboxRid, data, snapshots), data };\n}\n\n/** A folder subtree ready to be sealed into an envelope: the folders under their envelope-local\n *  ids, the live projects to snapshot, and the templates to carry whole. */\nexport interface EnvelopeFolderSubtree {\n  /** Donor's own id of the shared folder, carried so a later share of it finds this one. */\n  source: FolderId;\n  folders: Record<EnvelopeFolderId, EnvelopeFolder>;\n  projects: (EnvelopeProjectSource & { folder: EnvelopeFolderId })[];\n  templates: EnvelopeFolderTemplate[];\n}\n\n//\n// Recipient side\n//\n\n/**\n * Puts a share out of this recipient's sight, as a dynamic field on their own SharingState.\n * Keyed on the shareId, so a share that replaces this one — a new shareId — is shown again.\n */\nexport function writeShareHidden(\n  tx: PlTransaction,\n  stateRid: SignedResourceId,\n  shareId: ShareId,\n  timestamp: number,\n): void {\n  const value = tx.createJsonValue({ hidden: true, timestamp } satisfies ShareHidden);\n  tx.createField(field(stateRid, hiddenField(shareId)), \"Dynamic\", value);\n}\n\n/** Brings a hidden share back into this recipient's list. */\nexport function clearShareHidden(\n  tx: PlTransaction,\n  stateRid: SignedResourceId,\n  shareId: ShareId,\n): void {\n  tx.removeField(field(stateRid, hiddenField(shareId)));\n}\n\n/**\n * Copies every project snapshot inside an envelope into the recipient's own project list — a\n * cross-color attach the backend permits. The source is resolved against the envelope tree, not\n * the recipient's own list.\n *\n * `label` names each copy from its snapshot's label. The caller picks the names against the\n * destination the copies land in, because that is where they have to be free; left out, each copy\n * keeps its snapshot's label.\n *\n * Each result carries the envelope field uuid it was copied from, because that uuid is what the\n * payload names a project by — a folder share reads the folder of each copy off it. Pairing by\n * position would happen to work today and quietly stop working the moment the order does.\n *\n * @returns one entry per copied project: the envelope uuid it came from and its new id.\n */\nexport async function copyEnvelopeProjectsIntoList(\n  tx: PlTransaction,\n  envelopeRid: SignedResourceId,\n  projectListRid: SignedResourceId,\n  label?: (sourceLabel: string) => string,\n): Promise<{ uuid: ProjectFieldUuid; rid: SignedResourceId }[]> {\n  // Enumerate the envelope's project/{uuid} input fields (signed envelope-colored ids).\n  const envelopeData = await tx.getResourceData(envelopeRid, true);\n  const sources = envelopeData.fields\n    .filter((f) => isEnvelopeProjectField(f.name))\n    .flatMap((f) =>\n      isNotNullSignedResourceId(f.value)\n        ? [{ uuid: envelopeProjectFieldUuid(f.name), sourceRid: f.value }]\n        : [],\n    );\n\n  const created: { uuid: ProjectFieldUuid; rid: SignedResourceId }[] = [];\n  for (const { uuid, sourceRid } of sources) {\n    const sourceMeta = await tx.getKValueJson<ProjectMeta>(sourceRid, ProjectMetaKey);\n    const newLabel = label === undefined ? sourceMeta.label : label(sourceMeta.label);\n\n    // Cross-color attach: a new UserProject in the recipient's color whose fields point at\n    // envelope-colored resources. Fails with PermissionDenied: color mismatch on a backend\n    // that lacks crossTreeRefs:v1.\n    const newPrj = await duplicateProject(tx, sourceRid, { ...sourceMeta, label: newLabel });\n    tx.createField(field(projectListRid, randomUUID()), \"Dynamic\", newPrj);\n\n    created.push({ uuid, rid: await newPrj.globalId });\n  }\n\n  return created;\n}\n\n//\n// Internals\n//\n\n/** One source project snapshotted for an envelope: the field uuid it rides under, the snapshot\n *  itself, and what the payload says about it. */\ntype EnvelopeSnapshot<Source extends EnvelopeProjectSource> = {\n  uuid: ProjectFieldUuid;\n  ref: ResourceRef;\n  source: Source;\n  project: EnvelopeProject;\n};\n\n/**\n * Snapshots each source project by reference, in the given order, under a freshly minted field\n * uuid. The payload entry carries the project's label and description as they were at `sharedAt`,\n * so a share list renders without traversing into the snapshot.\n */\nasync function snapshotEnvelopeProjects<Source extends EnvelopeProjectSource>(\n  tx: PlTransaction,\n  sources: readonly Source[],\n  sharedAt: number,\n): Promise<EnvelopeSnapshot<Source>[]> {\n  const snapshots: EnvelopeSnapshot<Source>[] = [];\n  for (const source of sources) {\n    const meta = await tx.getKValueJson<ProjectMeta>(source.sourceRid, ProjectMetaKey);\n    const ref = await duplicateProject(tx, source.sourceRid, meta);\n    const description = normalizeDescription(meta.description);\n    snapshots.push({\n      uuid: newProjectFieldUuid(),\n      ref,\n      source,\n      project: {\n        label: meta.label,\n        source: source.projectId,\n        updatedAt: sharedAt,\n        ...(description === undefined ? {} : { description }),\n      },\n    });\n  }\n  return snapshots;\n}\n\n/**\n * Creates the envelope with its immutable `data`, attaches each snapshot as a `project/{uuid}`\n * input field, and hangs the envelope on the donor's outbox under its shareId.\n *\n * A payload that carries project snapshots has its input set sealed one-way, even when the\n * subtree it describes holds none, because such an envelope is granted writable. A template\n * payload has no input set to seal. The outbox attach happens in the same transaction, so the\n * held-resource rule keeps the ephemeral envelope alive.\n */\nfunction sealEnvelope(\n  tx: PlTransaction,\n  outboxRid: SignedResourceId,\n  data: EnvelopeData,\n  snapshots: readonly { uuid: ProjectFieldUuid; ref: ResourceRef }[],\n): ResourceRef {\n  const envelope = tx.createEphemeral(SharedEnvelopeResourceType, JSON.stringify(data));\n\n  for (const { uuid, ref } of snapshots)\n    tx.createField(field(envelope, envelopeProjectField(uuid)), \"Input\", ref);\n  if (data.payload.kind !== \"template\") tx.lockInputs(envelope);\n\n  tx.createField(field(outboxRid, data.shareId), \"Dynamic\", envelope);\n  return envelope;\n}\n"],"mappings":";;;;;;;;AA6BA,MAAa,6BAA6B;AAC1C,MAAa,wBAAwB,SACnC,GAAG,6BAA6B;;AAGlC,SAAgB,uBAAuB,MAAuB;CAC5D,OAAO,KAAK,WAAW,0BAA0B;AACnD;;AAGA,SAAgB,yBAAyB,MAAgC;CACvE,OAAO,KAAK,MAAM,CAAiC;AACrD;;;;;;;;;;AAkBA,eAAsB,mBACpB,IACA,WACA,SACA,QAOwD;CACxD,MAAM,WAAW,KAAK,IAAI;CAC1B,MAAM,YAAY,MAAM,yBAAyB,IAAI,SAAS,QAAQ;CAEtE,MAAM,WAAsD,CAAC;CAC7D,KAAK,MAAM,EAAE,MAAM,aAAa,WAAW,SAAS,QAAQ;CAE5D,MAAM,OAAqB;EACzB,eAAA;EACA,SAAS,WAAW;EACpB;EACA,WAAW,OAAO;EAClB,MAAM,OAAO;EACb,QAAQ,OAAO;EACf,OAAO,OAAO;EACd,SAAS;GAAE,MAAM;GAAY;EAAS;CACxC;CAEA,OAAO;EAAE,UAAU,aAAa,IAAI,WAAW,MAAM,SAAS;EAAG;CAAK;AACxE;;;;;;;;;;;;AAaA,SAAgB,2BACd,IACA,WACA,UAMA,QAM+C;CAC/C,MAAM,OAAqB;EACzB,eAAA;EACA,SAAS,WAAW;EACpB,UAAU,KAAK,IAAI;EACnB,WAAW,OAAO;EAClB,MAAM;EACN,QAAQ,OAAO;EACf,OAAO,OAAO;EACd,SAAS;GACP,MAAM;GACN,UAAU,SAAS;GACnB,QAAQ,SAAS;GACjB,OAAO,SAAS;GAChB,GAAI,SAAS,gBAAgB,KAAA,IAAY,CAAC,IAAI,EAAE,aAAa,SAAS,YAAY;GAClF,MAAM,OAAO;EACf;CACF;CAEA,OAAO;EAAE,UAAU,aAAa,IAAI,WAAW,MAAM,CAAC,CAAC;EAAG;CAAK;AACjE;;;;;;;;;;;;AAaA,eAAsB,yBACpB,IACA,WACA,SACA,QAMwD;CACxD,MAAM,WAAW,KAAK,IAAI;CAC1B,MAAM,YAAY,MAAM,yBAAyB,IAAI,QAAQ,UAAU,QAAQ;CAE/E,MAAM,WAA4D,CAAC;CACnE,KAAK,MAAM,EAAE,MAAM,SAAS,YAAY,WACtC,SAAS,QAAQ;EAAE,GAAG;EAAS,QAAQ,OAAO;CAAO;CAEvD,MAAM,OAAqB;EACzB,eAAA;EACA,SAAS,WAAW;EACpB;EACA,WAAW,OAAO;EAClB,MAAM;EACN,QAAQ,OAAO;EACf,OAAO,OAAO;EACd,SAAS;GACP,MAAM;GACN,QAAQ,QAAQ;GAChB,SAAS,QAAQ;GACjB;GACA,WAAW,QAAQ;GACnB,MAAM,OAAO;EACf;CACF;CAEA,OAAO;EAAE,UAAU,aAAa,IAAI,WAAW,MAAM,SAAS;EAAG;CAAK;AACxE;;;;;AAoBA,SAAgB,iBACd,IACA,UACA,SACA,WACM;CACN,MAAM,QAAQ,GAAG,gBAAgB;EAAE,QAAQ;EAAM;CAAU,CAAuB;CAClF,GAAG,YAAY,MAAM,UAAU,YAAY,OAAO,CAAC,GAAG,WAAW,KAAK;AACxE;;AAGA,SAAgB,iBACd,IACA,UACA,SACM;CACN,GAAG,YAAY,MAAM,UAAU,YAAY,OAAO,CAAC,CAAC;AACtD;;;;;;;;;;;;;;;;AAiBA,eAAsB,6BACpB,IACA,aACA,gBACA,OAC8D;CAG9D,MAAM,WAAU,MADW,GAAG,gBAAgB,aAAa,IAAI,EAAA,CAClC,OAC1B,QAAQ,MAAM,uBAAuB,EAAE,IAAI,CAAC,CAAC,CAC7C,SAAS,MACR,0BAA0B,EAAE,KAAK,IAC7B,CAAC;EAAE,MAAM,yBAAyB,EAAE,IAAI;EAAG,WAAW,EAAE;CAAM,CAAC,IAC/D,CAAC,CACP;CAEF,MAAM,UAA+D,CAAC;CACtE,KAAK,MAAM,EAAE,MAAM,eAAe,SAAS;EACzC,MAAM,aAAa,MAAM,GAAG,cAA2B,WAAW,cAAc;EAChF,MAAM,WAAW,UAAU,KAAA,IAAY,WAAW,QAAQ,MAAM,WAAW,KAAK;EAKhF,MAAM,SAAS,MAAM,iBAAiB,IAAI,WAAW;GAAE,GAAG;GAAY,OAAO;EAAS,CAAC;EACvF,GAAG,YAAY,MAAM,gBAAgB,WAAW,CAAC,GAAG,WAAW,MAAM;EAErE,QAAQ,KAAK;GAAE;GAAM,KAAK,MAAM,OAAO;EAAS,CAAC;CACnD;CAEA,OAAO;AACT;;;;;;AAoBA,eAAe,yBACb,IACA,SACA,UACqC;CACrC,MAAM,YAAwC,CAAC;CAC/C,KAAK,MAAM,UAAU,SAAS;EAC5B,MAAM,OAAO,MAAM,GAAG,cAA2B,OAAO,WAAW,cAAc;EACjF,MAAM,MAAM,MAAM,iBAAiB,IAAI,OAAO,WAAW,IAAI;EAC7D,MAAM,cAAc,qBAAqB,KAAK,WAAW;EACzD,UAAU,KAAK;GACb,MAAM,oBAAoB;GAC1B;GACA;GACA,SAAS;IACP,OAAO,KAAK;IACZ,QAAQ,OAAO;IACf,WAAW;IACX,GAAI,gBAAgB,KAAA,IAAY,CAAC,IAAI,EAAE,YAAY;GACrD;EACF,CAAC;CACH;CACA,OAAO;AACT;;;;;;;;;;AAWA,SAAS,aACP,IACA,WACA,MACA,WACa;CACb,MAAM,WAAW,GAAG,gBAAgB,4BAA4B,KAAK,UAAU,IAAI,CAAC;CAEpF,KAAK,MAAM,EAAE,MAAM,SAAS,WAC1B,GAAG,YAAY,MAAM,UAAU,qBAAqB,IAAI,CAAC,GAAG,SAAS,GAAG;CAC1E,IAAI,KAAK,QAAQ,SAAS,YAAY,GAAG,WAAW,QAAQ;CAE5D,GAAG,YAAY,MAAM,WAAW,KAAK,OAAO,GAAG,WAAW,QAAQ;CAClE,OAAO;AACT"}

package/dist/mutator/template.cjs

@@ -1,4 +1,6 @@
 const require_template_list = require("../middle_layer/template_list.cjs");
+const require_list = require("./list.cjs");
+let _milaboratories_pl_model_middle_layer = require("@milaboratories/pl-model-middle-layer");
 let _milaboratories_pl_client = require("@milaboratories/pl-client");
 let node_crypto = require("node:crypto");
 //#region src/mutator/template.ts
@@ -9,16 +11,20 @@ let node_crypto = require("node:crypto");
 * Create and attach are the same transaction on purpose: an ephemeral resource nothing
 * holds is collectable, so the list field is what keeps the template alive.
 *
-* The document rides in the immutable `data` blob, set once here and never altered; only
-* the label and the creation timestamp go to KV, and only the label is ever written again.
+* The document rides in the immutable `data` blob, set once here and never altered. The label,
+* the creation timestamp and the description live in KV beside it; the label and the description
+* may be written again later, the timestamp never is. A blank description stores nothing, the
+* same as {@link setTemplateDescription} does.
 *
 * @returns the new template resource; the caller reads its `globalId` after the commit.
 */
-function createTemplate(tx, listRid, label, data) {
+function createTemplate(tx, listRid, meta, data) {
 	const tpl = tx.createEphemeral(require_template_list.TemplateResourceType, JSON.stringify(data));
 	tx.lock(tpl);
-	tx.setKValue(tpl, require_template_list.TemplateLabelKey, JSON.stringify(label));
+	tx.setKValue(tpl, require_template_list.TemplateLabelKey, JSON.stringify(meta.label));
 	tx.setKValue(tpl, require_template_list.TemplateCreatedTimestamp, String(Date.now()));
+	const description = (0, _milaboratories_pl_model_middle_layer.normalizeDescription)(meta.description);
+	if (description !== void 0) tx.setKValue(tpl, require_template_list.TemplateDescriptionKey, JSON.stringify(description));
 	tx.createField((0, _milaboratories_pl_client.field)(listRid, (0, node_crypto.randomUUID)()), "Dynamic", tpl);
 	return tpl;
 }
@@ -28,27 +34,28 @@ function renameTemplate(tx, rid, label) {
 	tx.setKValue(rid, require_template_list.TemplateLabelKey, JSON.stringify(label));
 }
 /**
+* Sets what a stored template says about itself. Blank removes the entry rather than storing an
+* empty one, so a template that was never described and one whose description was cleared are
+* stored the same way.
+*/
+function setTemplateDescription(tx, rid, description) {
+	const wanted = (0, _milaboratories_pl_model_middle_layer.normalizeDescription)(description);
+	if (wanted === void 0) tx.deleteKValue(rid, require_template_list.TemplateDescriptionKey);
+	else tx.setKValue(rid, require_template_list.TemplateDescriptionKey, JSON.stringify(wanted));
+}
+/**
 * Detaches a template from the templates list, which is what destroys it — the list field is
 * the only thing holding the ephemeral resource.
-*
-* The field name is a uuid unrelated to the template id, so the field carrying the template
-* is found by value, the same way a project is removed from the project list.
 */
 async function deleteTemplate(tx, listRid, id) {
-	const fieldName = await findTemplateField(tx, listRid, id);
-	if (fieldName === void 0) throw new Error(`Template ${id} not found in template list.`);
-	tx.removeField((0, _milaboratories_pl_client.field)(listRid, fieldName));
-}
-async function findTemplateField(tx, listRid, id) {
-	const data = await tx.getResourceData(listRid, true);
-	for (const f of data.fields) {
-		if ((0, _milaboratories_pl_client.isNullSignedResourceId)(f.value)) continue;
-		if ((0, _milaboratories_pl_client.resourceIdToString)(f.value) === id) return f.name;
-	}
+	const entry = (await require_list.listedById(tx, listRid)).get(id);
+	if (entry === void 0) throw require_list.notListedError("Template", id);
+	tx.removeField((0, _milaboratories_pl_client.field)(listRid, entry.fieldName));
 }
 //#endregion
 exports.createTemplate = createTemplate;
 exports.deleteTemplate = deleteTemplate;
 exports.renameTemplate = renameTemplate;
+exports.setTemplateDescription = setTemplateDescription;
 
 //# sourceMappingURL=template.cjs.map

package/dist/mutator/template.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"template.cjs","names":["TemplateResourceType","TemplateLabelKey","TemplateCreatedTimestamp"],"sources":["../../src/mutator/template.ts"],"sourcesContent":["import type { PlTransaction, ResourceRef, SignedResourceId } from \"@milaboratories/pl-client\";\nimport { field, isNullSignedResourceId, resourceIdToString } from \"@milaboratories/pl-client\";\nimport { randomUUID } from \"node:crypto\";\nimport type { StoredTemplateData, TemplateId } from \"../middle_layer/template_list\";\nimport {\n  TemplateCreatedTimestamp,\n  TemplateLabelKey,\n  TemplateResourceType,\n} from \"../middle_layer/template_list\";\n\n/**\n * Creates one `UserTemplate` inside the given write transaction and attaches it to the\n * templates list under a freshly minted uuid field.\n *\n * Create and attach are the same transaction on purpose: an ephemeral resource nothing\n * holds is collectable, so the list field is what keeps the template alive.\n *\n * The document rides in the immutable `data` blob, set once here and never altered; only\n * the label and the creation timestamp go to KV, and only the label is ever written again.\n *\n * @returns the new template resource; the caller reads its `globalId` after the commit.\n */\nexport function createTemplate(\n  tx: PlTransaction,\n  listRid: SignedResourceId,\n  label: string,\n  data: StoredTemplateData,\n): ResourceRef {\n  const tpl = tx.createEphemeral(TemplateResourceType, JSON.stringify(data));\n  tx.lock(tpl);\n  tx.setKValue(tpl, TemplateLabelKey, JSON.stringify(label));\n  tx.setKValue(tpl, TemplateCreatedTimestamp, String(Date.now()));\n  tx.createField(field(listRid, randomUUID()), \"Dynamic\", tpl);\n  return tpl;\n}\n\n/** Renames a stored template. Touches the label KV entry and nothing else, so the stored\n *  document stays byte-identical. */\nexport function renameTemplate(tx: PlTransaction, rid: SignedResourceId, label: string): void {\n  tx.setKValue(rid, TemplateLabelKey, JSON.stringify(label));\n}\n\n/**\n * Detaches a template from the templates list, which is what destroys it — the list field is\n * the only thing holding the ephemeral resource.\n *\n * The field name is a uuid unrelated to the template id, so the field carrying the template\n * is found by value, the same way a project is removed from the project list.\n */\nexport async function deleteTemplate(\n  tx: PlTransaction,\n  listRid: SignedResourceId,\n  id: TemplateId,\n): Promise<void> {\n  const fieldName = await findTemplateField(tx, listRid, id);\n  if (fieldName === undefined) throw new Error(`Template ${id} not found in template list.`);\n  tx.removeField(field(listRid, fieldName));\n}\n\n//\n// Internals\n//\n\nasync function findTemplateField(\n  tx: PlTransaction,\n  listRid: SignedResourceId,\n  id: TemplateId,\n): Promise<string | undefined> {\n  const data = await tx.getResourceData(listRid, true);\n  for (const f of data.fields) {\n    if (isNullSignedResourceId(f.value)) continue;\n    if (resourceIdToString(f.value) === (id as string)) return f.name;\n  }\n  return undefined;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAsBA,SAAgB,eACd,IACA,SACA,OACA,MACa;CACb,MAAM,MAAM,GAAG,gBAAgBA,sBAAAA,sBAAsB,KAAK,UAAU,IAAI,CAAC;CACzE,GAAG,KAAK,GAAG;CACX,GAAG,UAAU,KAAKC,sBAAAA,kBAAkB,KAAK,UAAU,KAAK,CAAC;CACzD,GAAG,UAAU,KAAKC,sBAAAA,0BAA0B,OAAO,KAAK,IAAI,CAAC,CAAC;CAC9D,GAAG,aAAA,GAAA,0BAAA,MAAA,CAAkB,UAAA,GAAA,YAAA,WAAA,CAAoB,CAAC,GAAG,WAAW,GAAG;CAC3D,OAAO;AACT;;;AAIA,SAAgB,eAAe,IAAmB,KAAuB,OAAqB;CAC5F,GAAG,UAAU,KAAKD,sBAAAA,kBAAkB,KAAK,UAAU,KAAK,CAAC;AAC3D;;;;;;;;AASA,eAAsB,eACpB,IACA,SACA,IACe;CACf,MAAM,YAAY,MAAM,kBAAkB,IAAI,SAAS,EAAE;CACzD,IAAI,cAAc,KAAA,GAAW,MAAM,IAAI,MAAM,YAAY,GAAG,6BAA6B;CACzF,GAAG,aAAA,GAAA,0BAAA,MAAA,CAAkB,SAAS,SAAS,CAAC;AAC1C;AAMA,eAAe,kBACb,IACA,SACA,IAC6B;CAC7B,MAAM,OAAO,MAAM,GAAG,gBAAgB,SAAS,IAAI;CACnD,KAAK,MAAM,KAAK,KAAK,QAAQ;EAC3B,KAAA,GAAA,0BAAA,uBAAA,CAA2B,EAAE,KAAK,GAAG;EACrC,KAAA,GAAA,0BAAA,mBAAA,CAAuB,EAAE,KAAK,MAAO,IAAe,OAAO,EAAE;CAC/D;AAEF"}
+{"version":3,"file":"template.cjs","names":["TemplateResourceType","TemplateLabelKey","TemplateCreatedTimestamp","TemplateDescriptionKey","listedById","notListedError"],"sources":["../../src/mutator/template.ts"],"sourcesContent":["import type {\n  AnyResourceRef,\n  PlTransaction,\n  ResourceRef,\n  SignedResourceId,\n} from \"@milaboratories/pl-client\";\nimport { field } from \"@milaboratories/pl-client\";\nimport { normalizeDescription } from \"@milaboratories/pl-model-middle-layer\";\nimport { randomUUID } from \"node:crypto\";\nimport type { StoredTemplateData, TemplateId } from \"../middle_layer/template_list\";\nimport {\n  TemplateCreatedTimestamp,\n  TemplateDescriptionKey,\n  TemplateLabelKey,\n  TemplateResourceType,\n} from \"../middle_layer/template_list\";\nimport { listedById, notListedError } from \"./list\";\n\n/**\n * Creates one `UserTemplate` inside the given write transaction and attaches it to the\n * templates list under a freshly minted uuid field.\n *\n * Create and attach are the same transaction on purpose: an ephemeral resource nothing\n * holds is collectable, so the list field is what keeps the template alive.\n *\n * The document rides in the immutable `data` blob, set once here and never altered. The label,\n * the creation timestamp and the description live in KV beside it; the label and the description\n * may be written again later, the timestamp never is. A blank description stores nothing, the\n * same as {@link setTemplateDescription} does.\n *\n * @returns the new template resource; the caller reads its `globalId` after the commit.\n */\nexport function createTemplate(\n  tx: PlTransaction,\n  listRid: SignedResourceId,\n  meta: { readonly label: string; readonly description?: string },\n  data: StoredTemplateData,\n): ResourceRef {\n  const tpl = tx.createEphemeral(TemplateResourceType, JSON.stringify(data));\n  tx.lock(tpl);\n  tx.setKValue(tpl, TemplateLabelKey, JSON.stringify(meta.label));\n  tx.setKValue(tpl, TemplateCreatedTimestamp, String(Date.now()));\n  const description = normalizeDescription(meta.description);\n  if (description !== undefined)\n    tx.setKValue(tpl, TemplateDescriptionKey, JSON.stringify(description));\n  tx.createField(field(listRid, randomUUID()), \"Dynamic\", tpl);\n  return tpl;\n}\n\n/** Renames a stored template. Touches the label KV entry and nothing else, so the stored\n *  document stays byte-identical. */\nexport function renameTemplate(tx: PlTransaction, rid: SignedResourceId, label: string): void {\n  tx.setKValue(rid, TemplateLabelKey, JSON.stringify(label));\n}\n\n/**\n * Sets what a stored template says about itself. Blank removes the entry rather than storing an\n * empty one, so a template that was never described and one whose description was cleared are\n * stored the same way.\n */\nexport function setTemplateDescription(\n  tx: PlTransaction,\n  rid: AnyResourceRef,\n  description: string,\n): void {\n  const wanted = normalizeDescription(description);\n  if (wanted === undefined) tx.deleteKValue(rid, TemplateDescriptionKey);\n  else tx.setKValue(rid, TemplateDescriptionKey, JSON.stringify(wanted));\n}\n\n/**\n * Detaches a template from the templates list, which is what destroys it — the list field is\n * the only thing holding the ephemeral resource.\n */\nexport async function deleteTemplate(\n  tx: PlTransaction,\n  listRid: SignedResourceId,\n  id: TemplateId,\n): Promise<void> {\n  const entry = (await listedById(tx, listRid)).get(id);\n  if (entry === undefined) throw notListedError(\"Template\", id);\n  tx.removeField(field(listRid, entry.fieldName));\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAgCA,SAAgB,eACd,IACA,SACA,MACA,MACa;CACb,MAAM,MAAM,GAAG,gBAAgBA,sBAAAA,sBAAsB,KAAK,UAAU,IAAI,CAAC;CACzE,GAAG,KAAK,GAAG;CACX,GAAG,UAAU,KAAKC,sBAAAA,kBAAkB,KAAK,UAAU,KAAK,KAAK,CAAC;CAC9D,GAAG,UAAU,KAAKC,sBAAAA,0BAA0B,OAAO,KAAK,IAAI,CAAC,CAAC;CAC9D,MAAM,eAAA,GAAA,sCAAA,qBAAA,CAAmC,KAAK,WAAW;CACzD,IAAI,gBAAgB,KAAA,GAClB,GAAG,UAAU,KAAKC,sBAAAA,wBAAwB,KAAK,UAAU,WAAW,CAAC;CACvE,GAAG,aAAA,GAAA,0BAAA,MAAA,CAAkB,UAAA,GAAA,YAAA,WAAA,CAAoB,CAAC,GAAG,WAAW,GAAG;CAC3D,OAAO;AACT;;;AAIA,SAAgB,eAAe,IAAmB,KAAuB,OAAqB;CAC5F,GAAG,UAAU,KAAKF,sBAAAA,kBAAkB,KAAK,UAAU,KAAK,CAAC;AAC3D;;;;;;AAOA,SAAgB,uBACd,IACA,KACA,aACM;CACN,MAAM,UAAA,GAAA,sCAAA,qBAAA,CAA8B,WAAW;CAC/C,IAAI,WAAW,KAAA,GAAW,GAAG,aAAa,KAAKE,sBAAAA,sBAAsB;MAChE,GAAG,UAAU,KAAKA,sBAAAA,wBAAwB,KAAK,UAAU,MAAM,CAAC;AACvE;;;;;AAMA,eAAsB,eACpB,IACA,SACA,IACe;CACf,MAAM,SAAS,MAAMC,aAAAA,WAAW,IAAI,OAAO,EAAA,CAAG,IAAI,EAAE;CACpD,IAAI,UAAU,KAAA,GAAW,MAAMC,aAAAA,eAAe,YAAY,EAAE;CAC5D,GAAG,aAAA,GAAA,0BAAA,MAAA,CAAkB,SAAS,MAAM,SAAS,CAAC;AAChD"}

package/dist/mutator/template.js

@@ -1,5 +1,7 @@
-import { TemplateCreatedTimestamp, TemplateLabelKey, TemplateResourceType } from "../middle_layer/template_list.js";
-import { field, isNullSignedResourceId, resourceIdToString } from "@milaboratories/pl-client";
+import { TemplateCreatedTimestamp, TemplateDescriptionKey, TemplateLabelKey, TemplateResourceType } from "../middle_layer/template_list.js";
+import { listedById, notListedError } from "./list.js";
+import { normalizeDescription } from "@milaboratories/pl-model-middle-layer";
+import { field } from "@milaboratories/pl-client";
 import { randomUUID } from "node:crypto";
 //#region src/mutator/template.ts
 /**
@@ -9,16 +11,20 @@ import { randomUUID } from "node:crypto";
 * Create and attach are the same transaction on purpose: an ephemeral resource nothing
 * holds is collectable, so the list field is what keeps the template alive.
 *
-* The document rides in the immutable `data` blob, set once here and never altered; only
-* the label and the creation timestamp go to KV, and only the label is ever written again.
+* The document rides in the immutable `data` blob, set once here and never altered. The label,
+* the creation timestamp and the description live in KV beside it; the label and the description
+* may be written again later, the timestamp never is. A blank description stores nothing, the
+* same as {@link setTemplateDescription} does.
 *
 * @returns the new template resource; the caller reads its `globalId` after the commit.
 */
-function createTemplate(tx, listRid, label, data) {
+function createTemplate(tx, listRid, meta, data) {
 	const tpl = tx.createEphemeral(TemplateResourceType, JSON.stringify(data));
 	tx.lock(tpl);
-	tx.setKValue(tpl, TemplateLabelKey, JSON.stringify(label));
+	tx.setKValue(tpl, TemplateLabelKey, JSON.stringify(meta.label));
 	tx.setKValue(tpl, TemplateCreatedTimestamp, String(Date.now()));
+	const description = normalizeDescription(meta.description);
+	if (description !== void 0) tx.setKValue(tpl, TemplateDescriptionKey, JSON.stringify(description));
 	tx.createField(field(listRid, randomUUID()), "Dynamic", tpl);
 	return tpl;
 }
@@ -28,25 +34,25 @@ function renameTemplate(tx, rid, label) {
 	tx.setKValue(rid, TemplateLabelKey, JSON.stringify(label));
 }
 /**
+* Sets what a stored template says about itself. Blank removes the entry rather than storing an
+* empty one, so a template that was never described and one whose description was cleared are
+* stored the same way.
+*/
+function setTemplateDescription(tx, rid, description) {
+	const wanted = normalizeDescription(description);
+	if (wanted === void 0) tx.deleteKValue(rid, TemplateDescriptionKey);
+	else tx.setKValue(rid, TemplateDescriptionKey, JSON.stringify(wanted));
+}
+/**
 * Detaches a template from the templates list, which is what destroys it — the list field is
 * the only thing holding the ephemeral resource.
-*
-* The field name is a uuid unrelated to the template id, so the field carrying the template
-* is found by value, the same way a project is removed from the project list.
 */
 async function deleteTemplate(tx, listRid, id) {
-	const fieldName = await findTemplateField(tx, listRid, id);
-	if (fieldName === void 0) throw new Error(`Template ${id} not found in template list.`);
-	tx.removeField(field(listRid, fieldName));
-}
-async function findTemplateField(tx, listRid, id) {
-	const data = await tx.getResourceData(listRid, true);
-	for (const f of data.fields) {
-		if (isNullSignedResourceId(f.value)) continue;
-		if (resourceIdToString(f.value) === id) return f.name;
-	}
+	const entry = (await listedById(tx, listRid)).get(id);
+	if (entry === void 0) throw notListedError("Template", id);
+	tx.removeField(field(listRid, entry.fieldName));
 }
 //#endregion
-export { createTemplate, deleteTemplate, renameTemplate };
+export { createTemplate, deleteTemplate, renameTemplate, setTemplateDescription };
 
 //# sourceMappingURL=template.js.map

package/dist/mutator/template.js.map

@@ -1 +1 @@
-{"version":3,"file":"template.js","names":[],"sources":["../../src/mutator/template.ts"],"sourcesContent":["import type { PlTransaction, ResourceRef, SignedResourceId } from \"@milaboratories/pl-client\";\nimport { field, isNullSignedResourceId, resourceIdToString } from \"@milaboratories/pl-client\";\nimport { randomUUID } from \"node:crypto\";\nimport type { StoredTemplateData, TemplateId } from \"../middle_layer/template_list\";\nimport {\n  TemplateCreatedTimestamp,\n  TemplateLabelKey,\n  TemplateResourceType,\n} from \"../middle_layer/template_list\";\n\n/**\n * Creates one `UserTemplate` inside the given write transaction and attaches it to the\n * templates list under a freshly minted uuid field.\n *\n * Create and attach are the same transaction on purpose: an ephemeral resource nothing\n * holds is collectable, so the list field is what keeps the template alive.\n *\n * The document rides in the immutable `data` blob, set once here and never altered; only\n * the label and the creation timestamp go to KV, and only the label is ever written again.\n *\n * @returns the new template resource; the caller reads its `globalId` after the commit.\n */\nexport function createTemplate(\n  tx: PlTransaction,\n  listRid: SignedResourceId,\n  label: string,\n  data: StoredTemplateData,\n): ResourceRef {\n  const tpl = tx.createEphemeral(TemplateResourceType, JSON.stringify(data));\n  tx.lock(tpl);\n  tx.setKValue(tpl, TemplateLabelKey, JSON.stringify(label));\n  tx.setKValue(tpl, TemplateCreatedTimestamp, String(Date.now()));\n  tx.createField(field(listRid, randomUUID()), \"Dynamic\", tpl);\n  return tpl;\n}\n\n/** Renames a stored template. Touches the label KV entry and nothing else, so the stored\n *  document stays byte-identical. */\nexport function renameTemplate(tx: PlTransaction, rid: SignedResourceId, label: string): void {\n  tx.setKValue(rid, TemplateLabelKey, JSON.stringify(label));\n}\n\n/**\n * Detaches a template from the templates list, which is what destroys it — the list field is\n * the only thing holding the ephemeral resource.\n *\n * The field name is a uuid unrelated to the template id, so the field carrying the template\n * is found by value, the same way a project is removed from the project list.\n */\nexport async function deleteTemplate(\n  tx: PlTransaction,\n  listRid: SignedResourceId,\n  id: TemplateId,\n): Promise<void> {\n  const fieldName = await findTemplateField(tx, listRid, id);\n  if (fieldName === undefined) throw new Error(`Template ${id} not found in template list.`);\n  tx.removeField(field(listRid, fieldName));\n}\n\n//\n// Internals\n//\n\nasync function findTemplateField(\n  tx: PlTransaction,\n  listRid: SignedResourceId,\n  id: TemplateId,\n): Promise<string | undefined> {\n  const data = await tx.getResourceData(listRid, true);\n  for (const f of data.fields) {\n    if (isNullSignedResourceId(f.value)) continue;\n    if (resourceIdToString(f.value) === (id as string)) return f.name;\n  }\n  return undefined;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAsBA,SAAgB,eACd,IACA,SACA,OACA,MACa;CACb,MAAM,MAAM,GAAG,gBAAgB,sBAAsB,KAAK,UAAU,IAAI,CAAC;CACzE,GAAG,KAAK,GAAG;CACX,GAAG,UAAU,KAAK,kBAAkB,KAAK,UAAU,KAAK,CAAC;CACzD,GAAG,UAAU,KAAK,0BAA0B,OAAO,KAAK,IAAI,CAAC,CAAC;CAC9D,GAAG,YAAY,MAAM,SAAS,WAAW,CAAC,GAAG,WAAW,GAAG;CAC3D,OAAO;AACT;;;AAIA,SAAgB,eAAe,IAAmB,KAAuB,OAAqB;CAC5F,GAAG,UAAU,KAAK,kBAAkB,KAAK,UAAU,KAAK,CAAC;AAC3D;;;;;;;;AASA,eAAsB,eACpB,IACA,SACA,IACe;CACf,MAAM,YAAY,MAAM,kBAAkB,IAAI,SAAS,EAAE;CACzD,IAAI,cAAc,KAAA,GAAW,MAAM,IAAI,MAAM,YAAY,GAAG,6BAA6B;CACzF,GAAG,YAAY,MAAM,SAAS,SAAS,CAAC;AAC1C;AAMA,eAAe,kBACb,IACA,SACA,IAC6B;CAC7B,MAAM,OAAO,MAAM,GAAG,gBAAgB,SAAS,IAAI;CACnD,KAAK,MAAM,KAAK,KAAK,QAAQ;EAC3B,IAAI,uBAAuB,EAAE,KAAK,GAAG;EACrC,IAAI,mBAAmB,EAAE,KAAK,MAAO,IAAe,OAAO,EAAE;CAC/D;AAEF"}
+{"version":3,"file":"template.js","names":[],"sources":["../../src/mutator/template.ts"],"sourcesContent":["import type {\n  AnyResourceRef,\n  PlTransaction,\n  ResourceRef,\n  SignedResourceId,\n} from \"@milaboratories/pl-client\";\nimport { field } from \"@milaboratories/pl-client\";\nimport { normalizeDescription } from \"@milaboratories/pl-model-middle-layer\";\nimport { randomUUID } from \"node:crypto\";\nimport type { StoredTemplateData, TemplateId } from \"../middle_layer/template_list\";\nimport {\n  TemplateCreatedTimestamp,\n  TemplateDescriptionKey,\n  TemplateLabelKey,\n  TemplateResourceType,\n} from \"../middle_layer/template_list\";\nimport { listedById, notListedError } from \"./list\";\n\n/**\n * Creates one `UserTemplate` inside the given write transaction and attaches it to the\n * templates list under a freshly minted uuid field.\n *\n * Create and attach are the same transaction on purpose: an ephemeral resource nothing\n * holds is collectable, so the list field is what keeps the template alive.\n *\n * The document rides in the immutable `data` blob, set once here and never altered. The label,\n * the creation timestamp and the description live in KV beside it; the label and the description\n * may be written again later, the timestamp never is. A blank description stores nothing, the\n * same as {@link setTemplateDescription} does.\n *\n * @returns the new template resource; the caller reads its `globalId` after the commit.\n */\nexport function createTemplate(\n  tx: PlTransaction,\n  listRid: SignedResourceId,\n  meta: { readonly label: string; readonly description?: string },\n  data: StoredTemplateData,\n): ResourceRef {\n  const tpl = tx.createEphemeral(TemplateResourceType, JSON.stringify(data));\n  tx.lock(tpl);\n  tx.setKValue(tpl, TemplateLabelKey, JSON.stringify(meta.label));\n  tx.setKValue(tpl, TemplateCreatedTimestamp, String(Date.now()));\n  const description = normalizeDescription(meta.description);\n  if (description !== undefined)\n    tx.setKValue(tpl, TemplateDescriptionKey, JSON.stringify(description));\n  tx.createField(field(listRid, randomUUID()), \"Dynamic\", tpl);\n  return tpl;\n}\n\n/** Renames a stored template. Touches the label KV entry and nothing else, so the stored\n *  document stays byte-identical. */\nexport function renameTemplate(tx: PlTransaction, rid: SignedResourceId, label: string): void {\n  tx.setKValue(rid, TemplateLabelKey, JSON.stringify(label));\n}\n\n/**\n * Sets what a stored template says about itself. Blank removes the entry rather than storing an\n * empty one, so a template that was never described and one whose description was cleared are\n * stored the same way.\n */\nexport function setTemplateDescription(\n  tx: PlTransaction,\n  rid: AnyResourceRef,\n  description: string,\n): void {\n  const wanted = normalizeDescription(description);\n  if (wanted === undefined) tx.deleteKValue(rid, TemplateDescriptionKey);\n  else tx.setKValue(rid, TemplateDescriptionKey, JSON.stringify(wanted));\n}\n\n/**\n * Detaches a template from the templates list, which is what destroys it — the list field is\n * the only thing holding the ephemeral resource.\n */\nexport async function deleteTemplate(\n  tx: PlTransaction,\n  listRid: SignedResourceId,\n  id: TemplateId,\n): Promise<void> {\n  const entry = (await listedById(tx, listRid)).get(id);\n  if (entry === undefined) throw notListedError(\"Template\", id);\n  tx.removeField(field(listRid, entry.fieldName));\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAgCA,SAAgB,eACd,IACA,SACA,MACA,MACa;CACb,MAAM,MAAM,GAAG,gBAAgB,sBAAsB,KAAK,UAAU,IAAI,CAAC;CACzE,GAAG,KAAK,GAAG;CACX,GAAG,UAAU,KAAK,kBAAkB,KAAK,UAAU,KAAK,KAAK,CAAC;CAC9D,GAAG,UAAU,KAAK,0BAA0B,OAAO,KAAK,IAAI,CAAC,CAAC;CAC9D,MAAM,cAAc,qBAAqB,KAAK,WAAW;CACzD,IAAI,gBAAgB,KAAA,GAClB,GAAG,UAAU,KAAK,wBAAwB,KAAK,UAAU,WAAW,CAAC;CACvE,GAAG,YAAY,MAAM,SAAS,WAAW,CAAC,GAAG,WAAW,GAAG;CAC3D,OAAO;AACT;;;AAIA,SAAgB,eAAe,IAAmB,KAAuB,OAAqB;CAC5F,GAAG,UAAU,KAAK,kBAAkB,KAAK,UAAU,KAAK,CAAC;AAC3D;;;;;;AAOA,SAAgB,uBACd,IACA,KACA,aACM;CACN,MAAM,SAAS,qBAAqB,WAAW;CAC/C,IAAI,WAAW,KAAA,GAAW,GAAG,aAAa,KAAK,sBAAsB;MAChE,GAAG,UAAU,KAAK,wBAAwB,KAAK,UAAU,MAAM,CAAC;AACvE;;;;;AAMA,eAAsB,eACpB,IACA,SACA,IACe;CACf,MAAM,SAAS,MAAM,WAAW,IAAI,OAAO,EAAA,CAAG,IAAI,EAAE;CACpD,IAAI,UAAU,KAAA,GAAW,MAAM,eAAe,YAAY,EAAE;CAC5D,GAAG,YAAY,MAAM,SAAS,MAAM,SAAS,CAAC;AAChD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@milaboratories/pl-middle-layer",
-  "version": "1.71.15",
+  "version": "1.72.0",
   "description": "Pl Middle Layer",
   "keywords": [],
   "license": "UNLICENSED",
@@ -30,26 +30,26 @@
     "utility-types": "^3.11.0",
     "yaml": "^2.8.0",
     "zod": "~3.25.76",
+    "@milaboratories/pf-driver": "1.9.5",
+    "@milaboratories/columns-collection-driver": "0.2.7",
     "@milaboratories/computable": "2.9.8",
-    "@milaboratories/columns-collection-driver": "0.2.5",
     "@milaboratories/helpers": "1.14.5",
-    "@milaboratories/pf-spec-driver": "1.5.3",
-    "@milaboratories/pl-client": "3.17.1",
-    "@milaboratories/pl-deployments": "3.0.17",
-    "@milaboratories/pl-crash-recorder": "0.3.1",
-    "@milaboratories/pl-drivers": "1.16.24",
-    "@milaboratories/pf-driver": "1.9.3",
+    "@milaboratories/pf-spec-driver": "1.5.5",
+    "@milaboratories/pl-crash-recorder": "0.3.3",
+    "@milaboratories/pl-client": "3.17.3",
+    "@milaboratories/pl-deployments": "3.0.19",
+    "@milaboratories/pl-drivers": "1.16.26",
+    "@milaboratories/pl-errors": "1.4.44",
     "@milaboratories/pl-http": "1.2.4",
-    "@milaboratories/pl-errors": "1.4.42",
-    "@milaboratories/pl-model-common": "1.49.0",
-    "@milaboratories/pl-model-middle-layer": "1.32.1",
-    "@milaboratories/pl-tree": "1.15.2",
+    "@milaboratories/pl-model-backend": "1.4.29",
+    "@milaboratories/pl-model-common": "1.51.0",
+    "@milaboratories/pl-model-middle-layer": "1.33.0",
+    "@milaboratories/pl-tree": "1.15.4",
     "@milaboratories/resolve-helper": "1.1.3",
-    "@milaboratories/pl-model-backend": "1.4.27",
     "@milaboratories/ts-helpers": "1.8.6",
-    "@platforma-sdk/block-tools": "2.16.1",
-    "@platforma-sdk/model": "1.83.17",
-    "@platforma-sdk/workflow-tengo": "6.12.1"
+    "@platforma-sdk/block-tools": "2.16.3",
+    "@platforma-sdk/workflow-tengo": "6.12.1",
+    "@platforma-sdk/model": "1.84.1"
   },
   "devDependencies": {
     "@types/node": "~24.5.2",
@@ -57,9 +57,9 @@
     "@vitest/coverage-istanbul": "^4.1.3",
     "typescript": "7.0.2",
     "vitest": "^4.1.3",
+    "@milaboratories/build-configs": "2.0.2",
     "@milaboratories/ts-builder": "1.7.2",
-    "@milaboratories/ts-configs": "1.4.0",
-    "@milaboratories/build-configs": "2.0.2"
+    "@milaboratories/ts-configs": "1.4.0"
   },
   "engines": {
     "node": ">=22.19.0"