@geonosis/oxlint-plugin-biological-architecture 2.3.0 → 2.3.1

package/RULES.md

@@ -869,7 +869,7 @@ option not named here is one no rule reads.
 | `dialect-through-the-seam` | — |
 | `document-sagas-are-generic` | `factories`, `perKindPrefixes`, `within` |
 | `documents-share-one-table` | `perKindTables` |
-| `durable-body-reads-through-steps` | `durableKey`, `durableValue`, `ports`, `stepFactories`, `workflowFactories` |
+| `durable-body-reads-through-steps` | `durableKey`, `durableValue`, `ports`, `stepFactories`, `stepProxies`, `workflowFactories` |
 | `effect-hook-naming` | — |
 | `emit-declares-attempts` | `budgetHelpers`, `emitters` |
 | `font-roles-only` | `allow`, `exemptModules`, `prefix`, `roles` |
@@ -917,7 +917,7 @@ option not named here is one no rule reads.
 | `route-no-inline-mutation` | `inlineMutationOk`, `mutationPrefixes`, `paths` |
 | `router-schema-parity` | `ignore`, `mounts`, `routers`, `schemas`, `suffix` |
 | `service-name-not-reserved` | `moduleFactories`, `reserved` |
-| `ssot-no-inline-facts` | — |
+| `ssot-no-inline-facts` | `declarationCallees` |
 | `ssot-no-process-env` | — |
 | `step-declares-compensation-or-none` | `stepFactories` |
 | `step-opens-its-own-cell` | `engine`, `hosts`, `scopeKey`, `within`, `wrapper` |

package/corpus/.oxlintrc.json

@@ -60,7 +60,11 @@
       {
         "ports": [
           "store",
-          "billing"
+          "billing",
+          "q"
+        ],
+        "stepProxies": [
+          "q"
         ]
       }
     ],

package/corpus/engine/good-durable-read-through-step-proxy.ts

@@ -0,0 +1,13 @@
+import { createWorkflow } from '@corpus/workflows'
+
+// ACCEPTED: `q` is the engine's step proxy, so every call through it is a step — journalled under
+// its own name and answered from the record on a replay.
+export const settle = createWorkflow(
+  'invoice.settle',
+  async (id: string, ctx: { q: { getInvoice: (id: string) => Promise<{ status: string }> } }) => {
+    const doc = await ctx.q.getInvoice(id)
+
+    return doc.status
+  },
+  { durable: true },
+)

package/dist/index.js

@@ -1053,7 +1053,7 @@ var stepNameOf = (node, config) => {
 
 // src/rules/durable-body-reads-through-steps.ts
 var RULE3 = "durable-body-reads-through-steps";
-var ACCEPTS2 = "{ ports: string[] (required), durableKey: string, durableValue: boolean | string, workflowFactories: string[], stepFactories: string[] }";
+var ACCEPTS2 = "{ ports: string[] (required), durableKey: string, durableValue: boolean | string, workflowFactories: string[], stepFactories: string[], stepProxies: string[] }";
 var DEFAULT_WORKFLOW_FACTORIES = ["createWorkflow"];
 var DEFAULT_DURABLE_KEY = "execution";
 var DEFAULT_DURABLE_VALUE = "durable";
@@ -1085,6 +1085,7 @@ var durableBodyReadsThroughSteps = {
   create(context) {
     const bag = context.options?.[0] ?? {};
     const ports = new Set(requireOption(RULE3, bag.ports, "ports", ACCEPTS2));
+    const proxies = new Set(bag.stepProxies ?? []);
     const steps = stepFactoriesOf(RULE3, bag.stepFactories);
     const workflows = new Set(
       requireOption(RULE3, bag.workflowFactories ?? DEFAULT_WORKFLOW_FACTORIES, "workflowFactories")
@@ -1102,7 +1103,7 @@ var durableBodyReadsThroughSteps = {
         walkNode(node, (inner) => {
           if (inner.type !== "CallExpression" || memoised.has(inner)) return;
           const port = portReachedBy(inner, ports);
-          if (port === null) return;
+          if (port === null || portReachedBy(inner, proxies) !== null) return;
           context.report({ data: { port, workflow }, messageId: "freeRead", node: inner });
         });
       }
@@ -1113,7 +1114,9 @@ input or from a step result. A port read written straight into the body \u2014 \
 inline-only: the platform memoises steps by name and does not journal reads, so on a replay the read
 sees what the first invocation wrote, the branch flips, and the run unwinds work it had completed.
 Move the decision into a step (\`const doc = await ensureDraft(id)\`) and it is memoised with the run.
-Name this repo's ports in \`ports\`; enabled without them the rule refuses the run. What it can SEE is a
+Name this repo's ports in \`ports\`; enabled without them the rule refuses the run. A receiver the
+engine already made steps of \u2014 \`stepsOf\`' proxy over bound queries \u2014 goes in \`stepProxies\`: a call
+through it is journalled under its own name and is what this rule asks for. What it can SEE is a
 call on a name \`ports\` lists: a read moved one function out \u2014 \`readStatus(id)\`, with the port inside
 it \u2014 is invisible here, and no lint rule that reads one file can follow it. Name the helper in
 \`ports\` too when a body reaches the outside world through one; a helper that is really a step is
@@ -1135,6 +1138,7 @@ better made one. \`durableKey\` /
           durableValue: { type: ["boolean", "string"] },
           ports: { items: { type: "string" }, type: "array" },
           stepFactories: { items: { type: "string" }, type: "array" },
+          stepProxies: { items: { type: "string" }, type: "array" },
           workflowFactories: { items: { type: "string" }, type: "array" }
         },
         type: "object"
@@ -5136,13 +5140,14 @@ var styleAttributes = /* @__PURE__ */ new Set([
   "autoComplete"
 ]);
 var styleCallees = /* @__PURE__ */ new Set(["cn", "clsx", "twMerge", "cva", "tv"]);
-var declarationCallees = /* @__PURE__ */ new Set([
+var DECLARATION_CALLEES = [
   "declare",
   "saga",
   "step",
   "action",
   "defineEvent",
   "defineWorkflow",
+  "createWorkflow",
   "createStep",
   "sqliteTable",
   "text",
@@ -5156,7 +5161,7 @@ var declarationCallees = /* @__PURE__ */ new Set([
   "check",
   "literal",
   "enum"
-]);
+];
 var formFieldCallees = /* @__PURE__ */ new Set([
   "register",
   "watch",
@@ -5189,7 +5194,7 @@ var nameOf4 = (node) => {
   if (node.type === "Literal") return String(node.value);
   return void 0;
 };
-var isSpelledAsStyleOrModule = (node) => {
+var isSpelledAsStyleOrModule = (node, declarationCallees) => {
   let current = node.parent;
   let child = node;
   while (current && typeof current.type === "string" && current.type !== "Program") {
@@ -5216,9 +5221,13 @@ var ssotNoInlineFacts = {
   create(context) {
     const normalized = normalise(context.filename);
     if (factOwners.some((owner) => owner.test(normalized))) return {};
+    const declarationCallees = /* @__PURE__ */ new Set([
+      ...DECLARATION_CALLEES,
+      ...context.options?.[0]?.declarationCallees ?? []
+    ]);
     const check = (literal, node) => {
       if (!isFactShaped(literal)) return;
-      if (isSpelledAsStyleOrModule(node)) return;
+      if (isSpelledAsStyleOrModule(node, declarationCallees)) return;
       context.report({ data: { literal }, messageId: "inlineFact", node });
     };
     return {
@@ -5233,7 +5242,9 @@ var ssotNoInlineFacts = {
   },
   fixShape: `A route, a URL, a code, a dotted key: a fact is declared once, in the module that owns it, and
 imported. An inline literal used as configuration is a second copy waiting to drift \u2014 name it and put
-it where its owner lives.`,
+it where its owner lives. A literal that DECLARES rather than repeats \u2014 the first argument to
+\`createWorkflow\`, \`createStep\`, \`defineEvent\` \u2014 is the declaration itself and is left alone; name
+this repo's own factories in \`declarationCallees\` and they are added to those.`,
   meta: {
     docs: {
       description: "A fact \u2014 a route, a URL, a CODE, a dotted.name, a long key \u2014 is declared once, in its owner module (the owning module, lib/routes.ts, lib/env.ts, @during/client), and imported everywhere else. Spelling it inline makes a second source."
@@ -5241,7 +5252,15 @@ it where its owner lives.`,
     messages: {
       inlineFact: '"{{literal}}" is a fact spelled inline. Declare it once in its owner module and import it.'
     },
-    schema: [],
+    schema: [
+      {
+        additionalProperties: false,
+        properties: {
+          declarationCallees: { items: { type: "string" }, type: "array" }
+        },
+        type: "object"
+      }
+    ],
     type: "problem"
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geonosis/oxlint-plugin-biological-architecture",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "types": "./dist/index.d.ts",
   "description": "Biological tier architecture as lint — the union of the dielime and during.day rule sets, shipped as presets.",
   "keywords": [
@@ -44,7 +44,7 @@
     "oxlint": ">=1.77"
   },
   "devDependencies": {
-    "@geonosis/lint-parity": "2.3.0"
+    "@geonosis/lint-parity": "2.3.1"
   },
   "engines": {
     "node": ">=22"