@captiveorigins/payload-plugin-onephylogeny 0.1.0-alpha.0 → 0.1.0-alpha.1

package/dist/index.d.ts

@@ -14,7 +14,7 @@ type OnePhylogenyPluginOptions = {
         files?: string;
         importRuns?: string;
     };
-    /** Who may create panels and results, and activate panels. Default: nobody but trusted local scripts. */
+    /** Who may create panels and results, and activate panels. Default: nobody but trusted local scripts. Activating also needs a signed-in user, who is recorded. */
     manageAccess?: Access;
     /** Who may approve or reject results. Default: same as manageAccess. */
     reviewAccess?: Access;
@@ -22,6 +22,11 @@ type OnePhylogenyPluginOptions = {
     readReleasedAccess?: Access;
     /** Field added to assignments for multi-tenant hosts' isolation plugins to find. */
     group?: string;
+    /**
+     * Which panels results may be made against. `activeOrShown` also allows a `candidate` a maintainer ticked "shown as
+     * exploratory", and lets readers see such candidates. Default: `active`.
+     */
+    resultsAgainst?: 'active' | 'activeOrShown';
 };
 /**
  * OnePhylogeny for Payload. Adds immutable panels and reviewed results, relating to whatever collections a site already

package/dist/index.js

@@ -19,16 +19,31 @@ var stripIds = (rows) => Array.isArray(rows) ? rows.map((r) => {
   const { id: _id, ...rest } = r;
   return rest;
 }) : rows;
-var panelBeforeChange = ({ data, originalDoc, operation }) => {
+var stamp = (v) => v == null || v === "" ? "" : v instanceof Date ? v.toISOString() : String(v);
+var ACTIVATION_FIELDS = ["activatedBy", "activatedAt"];
+var panelBeforeChange = ({ data, originalDoc, operation, req }) => {
+  const leaving = operation === "update" && String(data.status ?? originalDoc.status) !== "candidate";
+  if (leaving) {
+    if (data.shownAsExploratory === true && String(originalDoc.status) !== "candidate") fail("Only a candidate panel can be shown as exploratory.");
+    data.shownAsExploratory = false;
+  }
   if (hasCoordinates(data.groups)) fail("Panels use generalized regions and never hold coordinates.");
   if (operation === "create") {
     if ((data.status ?? "candidate") !== "candidate") fail("A new panel starts as a candidate.");
+    if (ACTIVATION_FIELDS.some((f) => stamp(data[f]))) fail("Who activated a panel, and when, are set by activating.");
     return data;
   }
   const from = String(originalDoc.status);
   const to = String(data.status ?? from);
   if (to !== from && !PANEL_TRANSITIONS[from]?.includes(to)) fail(`A panel can't go from ${from} to ${to}.`);
-  if (from === "candidate" && to === "active" && !(data.validatedScope ?? originalDoc.validatedScope)?.length) fail("A panel with no validated claims can't become active.");
+  if (from === "candidate" && to === "active") {
+    if (!(data.validatedScope ?? originalDoc.validatedScope)?.length) fail("A panel with no validated claims can't become active.");
+    if (!req.user) fail("Activating a panel needs a signed-in person, who is recorded.");
+    data.activatedBy = String(req.user.id);
+    data.activatedAt = (/* @__PURE__ */ new Date()).toISOString();
+  } else if (ACTIVATION_FIELDS.some((f) => f in data && stamp(data[f]) !== stamp(originalDoc[f]))) {
+    fail("Who activated a panel, and when, are set by activating.");
+  }
   if (from !== "candidate") {
     for (const f of LOCKED_PANEL_FIELDS) {
       if (!(f in data)) continue;
@@ -44,11 +59,14 @@ 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) => async ({ data, originalDoc, operation, req }) => {
+var assignmentBeforeChange = (panels, againstShown) => async ({ data, originalDoc, operation, req }) => {
   if (operation === "create") {
     if ((data.reviewStatus ?? "pending") !== "pending") fail("A new result starts as pending review.");
     const panel = await req.payload.findByID({ collection: panels, id: idOf(data.panel), depth: 0, req, overrideAccess: true });
-    if (panel.status !== "active") fail("Results can only be made against an active panel.");
+    const shown = panel.status === "candidate" && panel.shownAsExploratory === true;
+    if (panel.status !== "active" && !(againstShown && shown)) fail(againstShown ? "Results can only be made against an active panel, or a candidate shown as exploratory." : "Results can only be made against an active panel.");
+    data.panelStatus = panel.status;
+    data.panelShownAsExploratory = shown;
     const result = data.result;
     const problems = validateResult(result).filter((d) => d.severity === "error");
     if (problems.length) fail(problems.map((p) => p.message).join("; "));
@@ -64,6 +82,9 @@ var assignmentBeforeChange = (panels) => async ({ data, originalDoc, operation,
   for (const f of ["result", "panel", "sequence", "subject", "summary", "importRun"]) {
     if (f in data && (f === "result" || f === "summary" ? !same(data[f], originalDoc[f]) : idOf(data[f]) !== idOf(originalDoc[f]))) fail("A result can't be edited. Make a new one instead.");
   }
+  for (const f of ["panelStatus", "panelShownAsExploratory"]) {
+    if (f in data && !same(data[f], originalDoc[f])) fail("The panel status a result was made against is set when it is made.");
+  }
   if (to !== from) {
     if (!REVIEW_TRANSITIONS[from]?.includes(to)) fail(`A result can't go from ${from} to ${to}.`);
     if (to === "approved") {
@@ -86,6 +107,7 @@ var onePhylogeny = (options = {}) => (config) => {
   const manage = options.manageAccess ?? (() => false);
   const review = options.reviewAccess ?? manage;
   const readReleased = options.readReleasedAccess ?? (({ req }) => Boolean(req.user));
+  const againstShown = options.resultsAgainst === "activeOrShown";
   const panelCollection = {
     slug: panels,
     labels: { singular: "Reference panel", plural: "Reference panels" },
@@ -93,7 +115,8 @@ var onePhylogeny = (options = {}) => (config) => {
     access: {
       read: async (args) => {
         if (await manage(args)) return true;
-        return { status: { in: ["active", "superseded"] } };
+        const published = { status: { in: ["active", "superseded"] } };
+        return againstShown ? { or: [published, { and: [{ status: { equals: "candidate" } }, { shownAsExploratory: { equals: true } }] }] } : published;
       },
       create: manage,
       update: manage,
@@ -103,6 +126,7 @@ var onePhylogeny = (options = {}) => (config) => {
       { name: "key", type: "text", required: true, index: true, admin: { description: "Stays the same across versions of one panel." } },
       { name: "version", type: "text", required: true },
       { name: "status", type: "select", required: true, defaultValue: "candidate", index: true, options: ["candidate", "active", "superseded", "withdrawn"] },
+      { name: "shownAsExploratory", type: "checkbox", defaultValue: false, index: true, admin: { description: "Show this candidate as exploratory, before review. Only candidates; cleared when it moves on." } },
       { name: "marker", type: "text", required: true },
       { name: "checksum", type: "text", required: true, index: true },
       ...relation("taxa", r.taxa, { hasMany: true }),
@@ -110,7 +134,9 @@ var onePhylogeny = (options = {}) => (config) => {
       ...relation("importRun", r.importRuns),
       { name: "validatedScope", type: "text", hasMany: true, admin: { description: "The claims this panel is validated for. Pages show only these." } },
       { name: "notCovered", type: "text", hasMany: true },
-      { name: "groups", type: "array", fields: [{ name: "groupId", type: "text", required: true }, { name: "label", type: "text", required: true }, { name: "regionName", type: "text", admin: { description: "A general region, never coordinates." } }] }
+      { name: "groups", type: "array", fields: [{ name: "groupId", type: "text", required: true }, { name: "label", type: "text", required: true }, { name: "regionName", type: "text", admin: { description: "A general region, never coordinates." } }] },
+      { name: "activatedBy", type: "text", admin: { readOnly: true, description: "The signed-in user who activated this panel. Set by activating." } },
+      { name: "activatedAt", type: "date", admin: { readOnly: true } }
     ],
     hooks: { beforeChange: [panelBeforeChange], afterChange: [supersedeOthers(panels)] }
   };
@@ -139,9 +165,11 @@ var onePhylogeny = (options = {}) => (config) => {
       ...relation("importRun", r.importRuns),
       { name: "reviewStatus", type: "select", required: true, defaultValue: "pending", index: true, options: ["pending", "approved", "rejected", "withdrawn"] },
       { name: "reviewer", type: "text", admin: { readOnly: true } },
-      { name: "releasedAt", type: "date", admin: { readOnly: true } }
+      { name: "releasedAt", type: "date", admin: { readOnly: true } },
+      { 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)] }
+    hooks: { beforeChange: [assignmentBeforeChange(panels, againstShown)] }
   };
   const released = {
     path: "/onephylogeny/released",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@captiveorigins/payload-plugin-onephylogeny",
-  "version": "0.1.0-alpha.0",
+  "version": "0.1.0-alpha.1",
   "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.0"
+    "@captiveorigins/onephylogeny-core": "^0.1.0-alpha.1"
   },
   "peerDependencies": {
     "payload": "^3.80.0"