@milaboratories/pl-middle-layer 1.64.41 → 1.65.0

package/dist/mutator/sharing.js

@@ -0,0 +1,130 @@
+import { ProjectMetaKey } from "../model/project_model.js";
+import { SharedEnvelopeResourceType, acceptanceField, decisionField, newShareId } from "../model/sharing_model.js";
+import { duplicateProject } from "./project.js";
+import { field, isNotNullSignedResourceId, resourceIdToString } from "@milaboratories/pl-client";
+import { randomUUID } from "node:crypto";
+//#region src/mutator/sharing.ts
+/** Field name carrying a project snapshot inside a {@link SharedEnvelopeResourceType}. */
+const EnvelopeProjectFieldPrefix = "project/";
+const envelopeProjectField = (uuid) => `${EnvelopeProjectFieldPrefix}${uuid}`;
+/** True for an envelope field that carries a project snapshot. */
+function isEnvelopeProjectField(name) {
+	return name.startsWith(EnvelopeProjectFieldPrefix);
+}
+/** Extracts the project field uuid from a `project/{uuid}` field name. */
+function envelopeProjectFieldUuid(name) {
+	return name.slice(8);
+}
+/**
+* Builds one {@link SharedEnvelopeResourceType} on the donor side inside the given write
+* transaction: snapshots each source project by reference, seals the envelope with its
+* immutable {@link EnvelopeData}, and attaches the envelope under `{shareId}` on the donor's
+* outbox. The caller is responsible for issuing the per-recipient grants and committing the
+* transaction — keeping create + grant atomic.
+*
+* @returns the new envelope resource and the generated `EnvelopeData`.
+*/
+async function buildShareEnvelope(tx, outboxRid, sources, params) {
+	const shareId = params.shareId ?? newShareId();
+	const sharedAt = params.sharedAt ?? Date.now();
+	const projects = {};
+	const snapshots = [];
+	for (const src of sources) {
+		const uuid = randomUUID();
+		if (src.kind === "fresh") {
+			const meta = await tx.getKValueJson(src.sourceRid, ProjectMetaKey);
+			const ref = await duplicateProject(tx, src.sourceRid, { label: meta.label });
+			projects[uuid] = {
+				label: meta.label,
+				source: src.projectId,
+				updatedAt: sharedAt
+			};
+			snapshots.push({
+				uuid,
+				ref
+			});
+		} else {
+			projects[uuid] = {
+				label: src.label,
+				source: src.projectId,
+				updatedAt: src.updatedAt
+			};
+			snapshots.push({
+				uuid,
+				ref: src.snapshotRid
+			});
+		}
+	}
+	const data = {
+		schemaVersion: 1,
+		shareId,
+		sharedAt,
+		expiresAt: params.expiresAt,
+		mode: params.mode,
+		sender: params.sender,
+		title: params.title,
+		projects
+	};
+	const envelope = tx.createEphemeral(SharedEnvelopeResourceType, JSON.stringify(data));
+	for (const { uuid, ref } of snapshots) tx.createField(field(envelope, envelopeProjectField(uuid)), "Input", ref);
+	tx.lockInputs(envelope);
+	tx.createField(field(outboxRid, shareId), "Dynamic", envelope);
+	return {
+		envelope,
+		data
+	};
+}
+/**
+* Records a response onto the envelope as a dynamic `acceptance/{login}` field: the acceptor
+* writing their own decision (their writable grant permits it), or the donor transferring an
+* existing record onto a changed envelope. Accepts the envelope by ref or id.
+*/
+function writeEnvelopeAcceptance(tx, envelopeRid, login, action, timestamp) {
+	const acceptance = {
+		action,
+		timestamp
+	};
+	const value = tx.createJsonValue(acceptance);
+	tx.createField(field(envelopeRid, acceptanceField(login)), "Dynamic", value);
+}
+/**
+* Records the acceptor's decision for a handled share on the acceptor's SharingState as a
+* dynamic `decision/{shareId}` field. Keyed on the logical shareId so discovery dedups on the
+* share, not on the envelope instance.
+*/
+function writeSharingDecision(tx, stateRid, shareId, decision) {
+	const value = tx.createJsonValue(decision);
+	tx.createField(field(stateRid, decisionField(shareId)), "Dynamic", value);
+}
+/**
+* Copies every project snapshot inside an envelope into the acceptor's own project list — a
+* cross-color attach the backend permits. Mirrors {@link duplicateProject}'s `rename` contract,
+* but resolves the source against the envelope tree (not the acceptor's own list), so the
+* wrapper cannot be reused.
+*
+* @returns ids of the projects created in the acceptor's list.
+*/
+async function copyEnvelopeProjectsIntoList(tx, envelopeRid, projectListRid, rename) {
+	const existingRids = (await tx.getResourceData(projectListRid, true)).fields.map((f) => f.value).filter(isNotNullSignedResourceId);
+	const existingLabels = (await Promise.all(existingRids.map((rid) => tx.getKValueJson(rid, ProjectMetaKey)))).map((m) => m.label);
+	const sourceRids = (await tx.getResourceData(envelopeRid, true)).fields.filter((f) => isEnvelopeProjectField(f.name)).map((f) => f.value).filter(isNotNullSignedResourceId);
+	const created = [];
+	for (const sourceRid of sourceRids) {
+		const sourceMeta = await tx.getKValueJson(sourceRid, ProjectMetaKey);
+		const newLabel = rename ? rename(sourceMeta.label, existingLabels) : sourceMeta.label;
+		existingLabels.push(newLabel);
+		const newPrj = await duplicateProject(tx, sourceRid, { label: newLabel });
+		tx.createField(field(projectListRid, randomUUID()), "Dynamic", newPrj);
+		const signedRid = await newPrj.globalId;
+		created.push(signedRid);
+	}
+	return created;
+}
+/** String-form ids of the projects created by {@link copyEnvelopeProjectsIntoList}. */
+function resourceIdsToStrings(ids) {
+	return ids.map((id) => resourceIdToString(id));
+}
+//#endregion
+export { EnvelopeProjectFieldPrefix, buildShareEnvelope, copyEnvelopeProjectsIntoList, envelopeProjectField, envelopeProjectFieldUuid, isEnvelopeProjectField, resourceIdsToStrings, writeEnvelopeAcceptance, writeSharingDecision };
+
+//# sourceMappingURL=sharing.js.map

package/dist/mutator/sharing.js.map

@@ -0,0 +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 } 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  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: 1,\n    shareId,\n    sharedAt,\n    expiresAt: params.expiresAt,\n    mode: params.mode,\n    sender: params.sender,\n    title: params.title,\n    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 * 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":";;;;;;;AAwBA,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,eAAe;EACf;EACA;EACA,WAAW,OAAO;EAClB,MAAM,OAAO;EACb,QAAQ,OAAO;EACf,OAAO,OAAO;EACd;CACF;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;;;;;;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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@milaboratories/pl-middle-layer",
-  "version": "1.64.41",
+  "version": "1.65.0",
   "description": "Pl Middle Layer",
   "keywords": [],
   "license": "UNLICENSED",
@@ -31,23 +31,23 @@
     "utility-types": "^3.11.0",
     "yaml": "^2.8.0",
     "zod": "~3.25.76",
-    "@milaboratories/computable": "2.9.5",
     "@milaboratories/helpers": "1.14.2",
-    "@milaboratories/pf-driver": "1.7.14",
-    "@milaboratories/pf-spec-driver": "1.4.16",
-    "@milaboratories/pl-deployments": "3.0.8",
-    "@milaboratories/pl-client": "3.12.0",
-    "@milaboratories/pl-errors": "1.4.24",
+    "@milaboratories/computable": "2.9.5",
+    "@milaboratories/pf-spec-driver": "1.4.17",
+    "@milaboratories/pl-deployments": "3.0.9",
+    "@milaboratories/pl-client": "3.13.0",
+    "@milaboratories/pl-drivers": "1.16.5",
+    "@milaboratories/pl-errors": "1.4.26",
+    "@milaboratories/pl-model-common": "1.46.3",
+    "@milaboratories/pl-model-middle-layer": "1.30.10",
+    "@milaboratories/pl-tree": "1.12.16",
+    "@milaboratories/pl-model-backend": "1.4.11",
+    "@milaboratories/pf-driver": "1.7.15",
+    "@platforma-sdk/block-tools": "2.11.8",
     "@milaboratories/pl-http": "1.2.4",
-    "@milaboratories/pl-drivers": "1.16.3",
-    "@milaboratories/pl-model-common": "1.46.2",
-    "@milaboratories/pl-model-middle-layer": "1.30.9",
-    "@milaboratories/pl-model-backend": "1.4.9",
-    "@milaboratories/pl-tree": "1.12.14",
     "@milaboratories/ts-helpers": "1.8.3",
-    "@platforma-sdk/model": "1.79.20",
-    "@platforma-sdk/block-tools": "2.11.6",
     "@milaboratories/resolve-helper": "1.1.3",
+    "@platforma-sdk/model": "1.79.24",
     "@platforma-sdk/workflow-tengo": "6.6.5"
   },
   "devDependencies": {
@@ -56,8 +56,8 @@
     "@vitest/coverage-istanbul": "^4.1.3",
     "typescript": "~5.9.3",
     "vitest": "^4.1.3",
-    "@milaboratories/build-configs": "2.0.0",
     "@milaboratories/ts-builder": "1.6.0",
+    "@milaboratories/build-configs": "2.0.0",
     "@milaboratories/ts-configs": "1.3.0"
   },
   "engines": {

package/src/middle_layer/index.ts

@@ -3,3 +3,4 @@ export { Project } from "./project";
 export * from "./driver_kit";
 export * from "./ops";
 export { ProjectsField } from "./project_list";
+export type { OutgoingShare, PendingShare } from "./sharing_list";