@captiveorigins/payload-plugin-onephylogeny 0.1.0-alpha.3 → 0.1.0-alpha.4

package/README.md

@@ -23,3 +23,5 @@ It refuses, in plain words, a file whose text doesn't match its SHA-256, a file
 
 `assignWaiting(payload, { evaluate })` is the sweep. It tests each waiting sequence against the panel for its marker and species, using the `evaluate` function you pass (OnePhylogeny's `testSample` in a Node job), and records a result pending review. A sequence with no panel stays waiting, and one the panel's checks refuse is marked `not-assessable`, with the reason. Results reach readers only after a reviewer approves them.
 
+On a multi-site host, set `tenantField` if the site field isn't called `tenant`. A result, sample or sequence keeps the site it was made for, so nobody can move it to another site's readers.
+

package/dist/index.d.ts

@@ -127,6 +127,11 @@ type OnePhylogenyPluginOptions = {
      * sequences. Left out, neither collection is added. Results then relate to these sequences.
      */
     records?: RecordsOptions;
+    /**
+     * The host's tenant (site) field on results, if it has one, such as a multi-tenant plugin adds. A result's site is set
+     * when it is made and can't change, so a reviewer can't move it to a site whose people would then see it. Default `tenant`.
+     */
+    tenantField?: string;
 };
 
 /**

package/dist/index.js

@@ -33,6 +33,7 @@ function recordCollections(o, base) {
   const manage = base.manage;
   const read = anyOf(manage, o.readAccess);
   const access = { read, create: manage, update: manage, delete: () => false };
+  const tenantField = o.tenantField ?? "tenant";
   const sampleCollection = {
     slug: samples,
     labels: { singular: "Sample", plural: "Samples" },
@@ -47,7 +48,7 @@ function recordCollections(o, base) {
       { name: "collectedAt", type: "date" },
       { name: "consent", type: "text", admin: { description: "The keeper's consent, as recorded with the kit or upload." } }
     ],
-    hooks: { beforeChange: [locked(["subject", "kit", "source"], "A sample's animal, kit and source can't change. Record a new sample instead.")] }
+    hooks: { beforeChange: [locked(["subject", "kit", "source", tenantField], "A sample's animal, kit, source and site can't change. Record a new sample instead.")] }
   };
   const sequenceCollection = {
     slug: sequences,
@@ -66,14 +67,14 @@ function recordCollections(o, base) {
       { name: "status", type: "select", required: true, defaultValue: "received", index: true, options: ["received", "assigned", "not-assessable"] },
       { name: "statusReason", type: "text", admin: { description: "Why it couldn't be assessed, in plain words." } }
     ],
-    hooks: { beforeChange: [locked(["sample", "marker", "file", "sha256", "residues", "recordId", "length"], "A sequence can't be edited. Register the corrected file instead.")] }
+    hooks: { beforeChange: [locked(["sample", "marker", "file", "sha256", "residues", "recordId", "length", tenantField], "A sequence can't be edited. Register the corrected file instead.")] }
   };
   const config = {
     samples,
     sequences,
     panels: base.panels,
     assignments: base.assignments,
-    tenantField: o.tenantField ?? "tenant",
+    tenantField,
     markers: o.markers,
     subject: base.subject,
     hasTaxa: Boolean(base.taxa),
@@ -269,7 +270,7 @@ var supersedeOthers = (panels) => async ({ doc, previousDoc, req }) => {
   for (const other of others.docs) await req.payload.update({ collection: panels, id: other.id, data: { status: "superseded" }, req, overrideAccess: true });
   return doc;
 };
-var assignmentBeforeChange = (panels, againstShown) => async ({ data, originalDoc, operation, req }) => {
+var assignmentBeforeChange = (panels, againstShown, tenantField) => async ({ data, originalDoc, operation, req }) => {
   if (operation === "create") {
     if ((data.reviewStatus ?? "pending") !== "pending") fail2("A new result starts as pending review.");
     const panel = await req.payload.findByID({ collection: panels, id: idOf2(data.panel), depth: 0, req, overrideAccess: true });
@@ -292,6 +293,7 @@ var assignmentBeforeChange = (panels, againstShown) => async ({ data, originalDo
   for (const f of ["result", "panel", "sequence", "subject", "summary", "importRun"]) {
     if (f in data && (f === "result" || f === "summary" ? !same(data[f], originalDoc[f]) : idOf2(data[f]) !== idOf2(originalDoc[f]))) fail2("A result can't be edited. Make a new one instead.");
   }
+  if (tenantField in data && idOf2(data[tenantField]) !== idOf2(originalDoc[tenantField])) fail2("A result stays on the site it was made for.");
   for (const f of ["panelStatus", "panelShownAsExploratory"]) {
     if (f in data && !same(data[f], originalDoc[f])) fail2("The panel status a result was made against is set when it is made.");
   }
@@ -313,7 +315,8 @@ var checkedWhenMade = { validate: (value, options) => options.operation === "upd
 var onePhylogeny = (options = {}) => (config) => {
   const panels = options.slugs?.panels ?? "panels";
   const assignments = options.slugs?.assignments ?? "assignments";
-  const records = options.records ? recordCollections(options.records, { panels, assignments, subject: options.relations?.subject, taxa: options.relations?.taxa, files: options.relations?.files, manage: options.manageAccess ?? (() => false), againstShown: options.resultsAgainst === "activeOrShown" }) : void 0;
+  const tenantField = options.tenantField ?? options.records?.tenantField ?? "tenant";
+  const records = options.records ? recordCollections({ tenantField, ...options.records }, { panels, assignments, subject: options.relations?.subject, taxa: options.relations?.taxa, files: options.relations?.files, manage: options.manageAccess ?? (() => false), againstShown: options.resultsAgainst === "activeOrShown" }) : void 0;
   const r = { ...options.relations, ...records && !options.relations?.sequence ? { sequence: records.config.sequences } : {} };
   const group = options.group ?? "Genetics";
   const manage = options.manageAccess ?? (() => false);
@@ -380,7 +383,7 @@ var onePhylogeny = (options = {}) => (config) => {
       { name: "panelStatus", type: "text", admin: { readOnly: true, description: "The panel's status when this result was made." } },
       { name: "panelShownAsExploratory", type: "checkbox", admin: { readOnly: true } }
     ],
-    hooks: { beforeChange: [assignmentBeforeChange(panels, againstShown)] }
+    hooks: { beforeChange: [assignmentBeforeChange(panels, againstShown, tenantField)] }
   };
   const released = {
     path: "/onephylogeny/released",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@captiveorigins/payload-plugin-onephylogeny",
-  "version": "0.1.0-alpha.3",
+  "version": "0.1.0-alpha.4",
   "description": "OnePhylogeny for Payload: immutable reference panels and released results on your own collections, with server-enforced review, safe endpoints and no coordinates.",
   "keywords": [
     "phylogenetics",
@@ -35,7 +35,7 @@
     "node": ">=22"
   },
   "dependencies": {
-    "@captiveorigins/onephylogeny-core": "^0.1.0-alpha.3"
+    "@captiveorigins/onephylogeny-core": "^0.1.0-alpha.4"
   },
   "peerDependencies": {
     "payload": "^3.80.0"