@aburi/effects-prisma 0.4.0 → 0.4.1

package/dist/index.d.mts

@@ -4,112 +4,44 @@ import { CallCandidate, ClassifyContext, Confidence, EffectClassification, Effec
 /**
  * Classify a CallCandidate against Prisma Client conventions.
  *
- * Recognition strategy:
- *   1. The owning file must import a Prisma Client module (see `hasPrismaImport`). No
- *      import → `null`, so callers can chain other effect plugins after this one.
- *   2. The target is split on `.`; the plugin looks at the trailing segments to match
- *      Prisma's fixed client surface. Two shapes are accepted:
- *        - `<...>.<model>.<verb>` (3+ segments) — a model delegate call. The client
- *          segment stops two-segment method collisions (Express `router.create(...)`)
- *          from false-classifying.
- *        - `<...>.$transaction` (2+ segments) — the top-level transaction API on the
- *          client itself.
- *   3. A literal first argument rules the call out — no Prisma method takes one — and the
- *      receiver and the argument count decide the tier (`classificationConfidence`).
- *   3a. A model segment that names nothing — `prisma[model].create(…)`, which arrives as
- *      `prisma.<computed>.create` — supplies the third segment without supplying a model, so
- *      the receiver has to carry the claim on its own: it must name a client binding, or the
- *      call is not classified at all.
- *   4. Malformed targets (empty string, adjacent / leading / trailing dots) throw — the
- *      language plugin's contract is a normalized non-empty callee, so a violation
- *      here is an upstream bug we surface loudly instead of silently miscategorizing.
- *
- * **The import gate is not a receiver check.** It answers "does this file use Prisma",
- * which a file is free to answer yes to while most of its calls belong to something else:
- * `this.cache.items.delete(key)` is a `Map`, `session.user.update(fields)` is an object,
- * and both have three segments and a delegate verb. Step 3 is what keeps those from being
- * recorded as `db.write` at the tier a hand-annotated effect gets — a claim that
- * would then propagate through the call graph and into the diff. Where the receiver names
- * the client, the classification still lands at `high`; where it does not, the effect is
- * still emitted but at `medium`, because a syntactic classifier cannot tell a client under
- * a house naming convention apart from an unrelated object of the same shape, and silently
- * dropping the first is as wrong as confidently claiming the second.
- *
- * The function is a pure lookup — no I/O, no state, no async — matching the per-call
- * timeout budget the core enforces (effect-plugin.md §5.1.1).
+ * Two shapes are accepted once the file imports a Prisma Client module (`hasPrismaImport`):
+ *   - `<...>.<model>.<verb>` (3+ segments) — a model delegate call. The client segment is
+ *     what separates it from two-segment collisions such as Express `router.create(...)`.
+ *   - `<...>.$transaction` (2+ segments) — the transaction API on the client itself.
+ *
+ * The import gate is not a receiver check: `this.cache.items.delete(key)` is a `Map` and
+ * `session.user.update(fields)` an object, both three segments with a delegate verb in a
+ * file that also uses Prisma. A literal first argument rules a call out — no Prisma method
+ * takes one — and the receiver plus argument count decide the tier, downgrading rather
+ * than dropping (`receiverConfidence`). A model addressed through brackets arrives as
+ * `<computed>` and supplies the third segment without a model, so there the receiver must
+ * name a client outright.
+ *
+ * Throws on a malformed target (`assertNonEmptySegments`): an upstream contract violation,
+ * not a classification decision. Pure with respect to plugin state (effect-plugin.md).
  */
 declare function classifyPrismaCall(call: CallCandidate, ctx: ClassifyContext): EffectClassification | null;
 //#endregion
 //#region src/constants.d.ts
-/**
- * Package-relative plugin name. Doubles as the prefix of every thrown message, so a caught
- * exception names the plugin that rejected the input. `manifest.ts` declares the same
- * string as `name`.
- */
+/** Plugin name: the manifest's `name` and the prefix of every thrown message. */
 declare const EFFECTS_PRISMA_PLUGIN_NAME: "effects-prisma";
-/**
- * Shared derivedBy namespace. `manifest.ts` imports this same const for its
- * `derivedByPrefixes` entry, so the classifier's tag builder and the registry
- * declaration cannot drift.
- */
+/** derivedBy namespace shared by the classifier's tag builder and the manifest. */
 declare const EFFECTS_PRISMA_DERIVED_BY_PREFIX: "effects-plugin:prisma";
 //#endregion
 //#region src/imports.d.ts
-/**
- * True when the file's import list contains any recognized Prisma Client module. An
- * empty source string on an ImportEdge is rejected by the shared guard: the language
- * plugin's contract is to emit normalized non-empty specifiers, and treating `""` as
- * unmatched would silently hide upstream bugs.
- *
- * `filePath` is required and threaded into any thrown error message so a caught
- * exception in production tooling (CI logs, error reporters) points directly at the
- * offending source file rather than a bare "empty source" string.
- */
+/** True when the file imports a Prisma Client module; see `hasMatchingImport`. */
 declare function hasPrismaImport(imports: readonly ImportEdge[], filePath: string): boolean;
 //#endregion
 //#region src/manifest.d.ts
-/**
- * Manifest for `@aburi/effects-prisma`. `as const satisfies EffectsManifest` keeps
- * every literal narrow so downstream registry checks see the exact shape.
- *
- * The plugin returns core-owned effect ids (`db.read` / `db.write` / `db.transaction`)
- * from `classify()`; per extension-vocab.md §5.1 core vocab lives in the reserved
- * namespace and MUST NOT appear in a plugin's `provides.effects`. The plugin's own
- * `x-prisma:*` namespace currently has no bindings — model-specific effects would sit there
- * once introduced. `derivedByPrefixes` shares its literal with the classifier's tag
- * builder so both stay in lockstep across edits.
- */
-declare const effectsPrismaManifest: {
-  readonly $schema: "https://aburi.kage1020.com/schema/aburi.plugin.v1.json";
-  readonly name: "effects-prisma";
-  readonly version: "0.0.0";
-  readonly type: "effects";
-  readonly engines: {
-    readonly aburi: "*";
-  };
-  readonly provides: {
-    readonly effects: [];
-    readonly effectPrefixes: [];
-    readonly extKinds: [];
-    readonly extKindPrefixes: [];
-    readonly derivedByPrefixes: ["effects-plugin:prisma"];
-    readonly frameworks: [];
-  };
-};
+/** See `defineEffectsManifest` for why `provides` claims no vocabulary of its own. */
+declare const effectsPrismaManifest: import("@aburi/plugin-registry/plugin-input").EffectsPluginManifest<"effects-prisma", "effects-plugin:prisma">;
 //#endregion
 //#region src/methods.d.ts
 /**
- * Prisma model delegate method vocabulary.
- *
- * Each `_LIST` is the single source of truth — the union type and the runtime `Set` are
- * both derived from it, so extending the vocabulary is a table edit in exactly one
- * place. Extending as Prisma ships new delegate methods keeps the classifier honest
- * without a code rewrite.
- *
- * Only methods that map cleanly onto core `db.read` / `db.write` vocabulary are listed.
- * Delegate helpers whose semantics do not match (metadata accessors, raw SQL escapes,
- * connection lifecycle) stay out — the plugin returns `null` for them so downstream
- * effect plugins get a chance.
+ * Prisma model delegate method vocabulary. Each `_LIST` is the single source of truth for
+ * its union type and runtime `Set`. Only methods that map onto core `db.read` / `db.write`
+ * are listed; metadata accessors, raw SQL escapes and connection lifecycle stay out, so the
+ * plugin returns `null` for them and downstream effect plugins get a chance.
  */
 declare const PRISMA_READ_METHODS_LIST: readonly ["findUnique", "findUniqueOrThrow", "findFirst", "findFirstOrThrow", "findMany", "count", "aggregate", "groupBy"];
 declare const PRISMA_WRITE_METHODS_LIST: readonly ["create", "createMany", "createManyAndReturn", "update", "updateMany", "updateManyAndReturn", "upsert", "delete", "deleteMany"];
@@ -126,84 +58,31 @@ declare function isPrismaTransactionMethod(name: string): name is PrismaTransact
 //#endregion
 //#region src/plugin.d.ts
 /**
- * Prisma effect plugin. Sits behind the language plugin's `walkBody` output, mapping
- * `prisma.<model>.<verb>` and `prisma.$transaction` call expressions into the core
- * `db.read` / `db.write` / `db.transaction` effect vocabulary.
- *
- * `init` and `classify` are both pure with respect to plugin state — no lazy resources,
- * no per-run caches — so repeated invocations against the same CallCandidate produce
- * identical results. This matches the per-call timeout contract in
- * effect-plugin.md §5.1.1 and the "pure classifier" recommendation in §11.1.
+ * Prisma effect plugin: maps `prisma.<model>.<verb>` and `prisma.$transaction` call
+ * expressions onto the core `db.read` / `db.write` / `db.transaction` vocabulary. `classify`
+ * is pure (effect-plugin.md) and throws on a malformed CallCandidate — an
+ * upstream contract violation, surfaced rather than swallowed.
  */
 declare class PrismaEffectsPlugin implements EffectPlugin {
-  readonly manifest: {
-    readonly $schema: "https://aburi.kage1020.com/schema/aburi.plugin.v1.json";
-    readonly name: "effects-prisma";
-    readonly version: "0.0.0";
-    readonly type: "effects";
-    readonly engines: {
-      readonly aburi: "*";
-    };
-    readonly provides: {
-      readonly effects: [];
-      readonly effectPrefixes: [];
-      readonly extKinds: [];
-      readonly extKindPrefixes: [];
-      readonly derivedByPrefixes: ["effects-plugin:prisma"];
-      readonly frameworks: [];
-    };
-  };
+  readonly manifest: import("@aburi/plugin-registry/plugin-input").EffectsPluginManifest<"effects-prisma", "effects-plugin:prisma">;
   init(_ctx: PluginContext): Promise<void>;
   classify(call: CallCandidate, ctx: ClassifyContext): EffectClassification | null;
 }
-/**
- * Ready-to-register instance. Callers pass this to `@aburi/plugin-registry` or a scan
- * pipeline. The type annotation is omitted deliberately: `class implements EffectPlugin`
- * already enforces the structural contract, and inferring the narrow class type keeps
- * the manifest literals (`readonly ["effects-plugin:prisma"]`, `"effects-prisma"`)
- * visible to consumers that want to compare against them without a separate manifest
- * import.
- */
+/** Ready-to-register instance; left unannotated so the manifest literals stay visible. */
 declare const prismaEffectsPlugin: PrismaEffectsPlugin;
 //#endregion
 //#region src/receivers.d.ts
 /**
- * The words a Prisma Client binding is spelled with.
- *
- * A classifier only ever sees the callee string, so "which local binding holds the client"
- * is not a question it can answer outright — the assignment that created the binding
- * (`const prisma = new PrismaClient()`, `constructor(private prisma: PrismaClient)`) is in
- * the AST, which effect plugins deliberately never see (effect-plugin.md §11.1). What the
- * callee does carry is the name the author gave that binding, and Prisma's own docs, the
- * generated client, and every published starter spell it from this handful of words.
- *
- * Matching is per word (`identifierWords`), so `prismaClient`, `readReplicaDb`, `_prisma`,
- * `dbClient` and `prismaRo` all count, while `cache`, `router`, `items` and `store` do not.
- * That is the whole point: `delete`, `create` and `update` are shared vocabulary across
- * `Map`, `Set`, the DOM and every HTTP router, and `this.<x>.<y>.delete(...)` is everyday
- * TypeScript, so the method name plus a file-level import gate is not evidence that the
- * receiver is a database client.
- *
- * `tx` / `trx` are here because the interactive-transaction callback rebinds the client
- * under its own parameter name — `prisma.$transaction(async (tx) => tx.user.create(...))` —
- * and that call is as much a write as the one outside it.
- *
- * **What is deliberately not here.** A word only earns a place if it separates a database
- * client from everything else that shares Prisma's verbs:
- *
- * - `client` matches `apiClient`, `httpClient`, `redisClient`, `sdkClient`. A resource
- *   SDK's `<client>.<resource>.<verb>` is spelled exactly like a Prisma delegate, so
- *   `apiClient.users.update(payload)` would land at the tier a hand-annotated effect gets
- *   — the bug class this module exists to close. `prismaClient`, `dbClient` and `_prisma`
- *   match on `prisma` or `db` regardless; a bare `client.user.create()` is all the entry
- *   would have bought.
- * - `transaction` matches the domain nouns `paymentTransaction` / `transactionLog` more
- *   often than it names a client, and `tx` / `trx` already cover the callback parameter.
- * - `datasource` was unreachable as anyone spells it: `identifierWords("dataSource")` is
- *   `["data", "source"]`, so only the all-lowercase form ever matched.
- *
- * A literal source of truth, like every other vocabulary in this package: extending it for
- * a house naming convention is a table edit in exactly one place.
+ * The words a Prisma Client binding is spelled with. The callee string is all a classifier
+ * sees (effect-plugin.md), and matching is per word (`identifierWords`): `prisma`,
+ * `prismaClient`, `readReplicaDb` and `_prisma` count; `cache`, `router`, `items` and
+ * `feedback` do not. `tx` / `trx` cover the interactive-transaction callback parameter.
+ *
+ * Deliberately absent: `client`, which would hand an SDK's `apiClient.users.update(payload)`
+ * — spelled exactly like a delegate call — a high-confidence `db.write`; `transaction`,
+ * which names a domain noun (`paymentTransaction`) far more often than a client; and
+ * `datasource`, which `identifierWords("dataSource")` splits so only the all-lowercase form
+ * ever matched. See docs/design/effect-plugin.md.
  */
 declare const PRISMA_CLIENT_WORDS_LIST: readonly ["prisma", "db", "database", "orm", "tx", "trx"];
 type PrismaClientWord = (typeof PRISMA_CLIENT_WORDS_LIST)[number];
@@ -211,44 +90,13 @@ declare const PRISMA_CLIENT_WORDS: ReadonlySet<PrismaClientWord>;
 /** True when `segment` spells a word this package recognizes as a Prisma client binding. */
 declare function namesPrismaClient(segment: string): boolean;
 /**
- * The most arguments a Prisma call takes before it stops looking like Prisma's own API.
- *
- * A model delegate method takes a single options object (`{ where }`, `{ data }`) or
- * nothing at all. `$transaction` takes two: the callback form carries an options object
- * (`$transaction(fn, { timeout })`), while the array form takes one.
+ * The most arguments a Prisma call takes before it stops looking like Prisma's own API: a
+ * delegate method takes one options object or nothing; `$transaction(fn, { timeout })`
+ * takes two.
  */
 declare const PRISMA_DELEGATE_MAX_ARGUMENTS = 1;
 declare const PRISMA_TRANSACTION_MAX_ARGUMENTS = 2;
-/**
- * How much the call backs the classification its method name suggests.
- *
- * `high` needs every signal to agree: the receiver segment names a client binding, the
- * receiver is a binding at all rather than a collapsed expression, and the call takes no
- * more arguments than the API allows. Anything else is `medium` — the effect is still
- * recorded, with the uncertainty stated:
- *
- * - **An unrecognized receiver** is either a binding this plugin cannot place by name (a
- *   house convention, a client reached through a wrapper) or an unrelated object that
- *   happens to share the verb. A syntactic classifier cannot separate those two without
- *   the binding table it has no access to, so it says so in `confidence` rather than
- *   picking one and being confidently wrong half the time. `medium` is the same tier
- *   `@aburi/framework-express` uses for a route that matches the shape without an import
- *   anchor.
- * - **A dynamic receiver** (`getClient().user.create()`, `clients[0].user.create()`) is
- *   capped at `medium` whatever it is spelled: normalization collapsed an expression down
- *   to a name, so the name in `target` is not a binding and reading it as one would
- *   manufacture evidence out of a call the language plugin already flagged as unresolvable
- *   (`CallCandidate.dynamicReceiver`).
- * - **An argument list longer than the API takes** is evidence against, not proof:
- *   `argumentCount` comes from a syntactic walk, and this classifier is the first thing to
- *   read it as a signature. Treating an overflow as "not a Prisma call" would let one
- *   miscount erase a real write and log nothing — the failure mode with no trace. So it
- *   costs the tier instead, which is this module's own rule applied to its own inputs.
- *
- * A literal first argument is the one shape that is *not* a tier question, and it is not
- * decided here: `prisma.user.delete("u1")` is a type error rather than a Prisma call, so
- * `classifyPrismaCall` rejects it outright.
- */
+/** `receiverConfidence` under this package's client vocabulary. */
 declare function classificationConfidence(clientSegment: string | undefined, call: CallCandidate, maxArguments: number): Confidence;
 //#endregion
 export { EFFECTS_PRISMA_DERIVED_BY_PREFIX, EFFECTS_PRISMA_PLUGIN_NAME, PRISMA_CLIENT_WORDS, PRISMA_DELEGATE_MAX_ARGUMENTS, PRISMA_READ_METHODS, PRISMA_TRANSACTION_MAX_ARGUMENTS, PRISMA_TRANSACTION_METHOD, PRISMA_WRITE_METHODS, type PrismaClientWord, PrismaEffectsPlugin, type PrismaReadMethod, type PrismaTransactionMethod, type PrismaWriteMethod, classificationConfidence, classifyPrismaCall, effectsPrismaManifest, hasPrismaImport, isPrismaReadMethod, isPrismaTransactionMethod, isPrismaWriteMethod, namesPrismaClient, prismaEffectsPlugin };

package/dist/index.mjs

@@ -1 +1 @@
-import{assertNonEmptySegments as e,hasLiteralFirstArgument as t,hasMatchingImport as n,identifierMentions as r}from"@aburi/plugin-registry/plugin-input";import{COMPUTED_TARGET_SEGMENT as i}from"@aburi/types";const a=`effects-prisma`,o=`effects-plugin:prisma`,s=new Set([`@prisma/client`,`@prisma/client/edge`]);function c(e){return s.has(e)}function l(e,t){return n(e,{plugin:a,filePath:t},c)}const u=[`findUnique`,`findUniqueOrThrow`,`findFirst`,`findFirstOrThrow`,`findMany`,`count`,`aggregate`,`groupBy`],d=[`create`,`createMany`,`createManyAndReturn`,`update`,`updateMany`,`updateManyAndReturn`,`upsert`,`delete`,`deleteMany`],f=new Set(u),p=new Set(d),m=`$transaction`;function h(e){return f.has(e)}function g(e){return p.has(e)}function _(e){return e===m}const v=new Set([`prisma`,`db`,`database`,`orm`,`tx`,`trx`]);function y(e){return r(e,v)}const b=1,x=2;function S(e,t,n){return t.dynamicReceiver===!0||t.argumentCount>n?`medium`:e!==void 0&&y(e)?`high`:`medium`}function C(n,r){let s={plugin:a,filePath:r.file.path},{segments:c,last:u}=e(n.target,s);if(!l(r.file.imports,r.file.path))return null;if(_(u))return c.length<2||t(n)?null:{effectId:`db.transaction`,confidence:S(c.at(-2),n,2),derivedBy:`${o}:tx`};if(c.length<3||t(n))return null;let d=c.at(-3);if(d!==void 0&&c.at(-2)===i&&!y(d))return null;let f=S(d,n,1);return h(u)?{effectId:`db.read`,confidence:f,derivedBy:`${o}:read`}:g(u)?{effectId:`db.write`,confidence:f,derivedBy:`${o}:write`}:null}const w={$schema:`https://aburi.kage1020.com/schema/aburi.plugin.v1.json`,name:a,version:`0.0.0`,type:`effects`,engines:{aburi:`*`},provides:{effects:[],effectPrefixes:[],extKinds:[],extKindPrefixes:[],derivedByPrefixes:[o],frameworks:[]}};var T=class{manifest=w;async init(e){}classify(e,t){return C(e,t)}};const E=new T;export{o as EFFECTS_PRISMA_DERIVED_BY_PREFIX,a as EFFECTS_PRISMA_PLUGIN_NAME,v as PRISMA_CLIENT_WORDS,b as PRISMA_DELEGATE_MAX_ARGUMENTS,f as PRISMA_READ_METHODS,x as PRISMA_TRANSACTION_MAX_ARGUMENTS,m as PRISMA_TRANSACTION_METHOD,p as PRISMA_WRITE_METHODS,T as PrismaEffectsPlugin,S as classificationConfidence,C as classifyPrismaCall,w as effectsPrismaManifest,l as hasPrismaImport,h as isPrismaReadMethod,_ as isPrismaTransactionMethod,g as isPrismaWriteMethod,y as namesPrismaClient,E as prismaEffectsPlugin};
+import{assertNonEmptySegments as e,defineEffectsManifest as t,hasLiteralFirstArgument as n,hasMatchingImport as r,identifierMentions as i,receiverConfidence as a}from"@aburi/plugin-registry/plugin-input";import{COMPUTED_TARGET_SEGMENT as o}from"@aburi/types";const s=`effects-prisma`,c=`effects-plugin:prisma`,l=new Set([`@prisma/client`,`@prisma/client/edge`]);function u(e){return l.has(e)}function d(e,t){return r(e,{plugin:s,filePath:t},u)}const f=[`findUnique`,`findUniqueOrThrow`,`findFirst`,`findFirstOrThrow`,`findMany`,`count`,`aggregate`,`groupBy`],p=[`create`,`createMany`,`createManyAndReturn`,`update`,`updateMany`,`updateManyAndReturn`,`upsert`,`delete`,`deleteMany`],m=new Set(f),h=new Set(p),g=`$transaction`;function _(e){return m.has(e)}function v(e){return h.has(e)}function y(e){return e===g}const b=new Set([`prisma`,`db`,`database`,`orm`,`tx`,`trx`]);function x(e){return i(e,b)}const S=1,C=2;function w(e,t,n){return a(e,t,n,x)}function T(t,r){let i={plugin:s,filePath:r.file.path},{segments:a,last:l}=e(t.target,i);if(!d(r.file.imports,r.file.path))return null;if(y(l))return a.length<2||n(t)?null:{effectId:`db.transaction`,confidence:w(a.at(-2),t,2),derivedBy:`${c}:tx`};if(a.length<3||n(t))return null;let u=a.at(-3);if(u!==void 0&&a.at(-2)===o&&!x(u))return null;let f=w(u,t,1);return _(l)?{effectId:`db.read`,confidence:f,derivedBy:`${c}:read`}:v(l)?{effectId:`db.write`,confidence:f,derivedBy:`${c}:write`}:null}const E=t(s,c);var D=class{manifest=E;async init(e){}classify(e,t){return T(e,t)}};const O=new D;export{c as EFFECTS_PRISMA_DERIVED_BY_PREFIX,s as EFFECTS_PRISMA_PLUGIN_NAME,b as PRISMA_CLIENT_WORDS,S as PRISMA_DELEGATE_MAX_ARGUMENTS,m as PRISMA_READ_METHODS,C as PRISMA_TRANSACTION_MAX_ARGUMENTS,g as PRISMA_TRANSACTION_METHOD,h as PRISMA_WRITE_METHODS,D as PrismaEffectsPlugin,w as classificationConfidence,T as classifyPrismaCall,E as effectsPrismaManifest,d as hasPrismaImport,_ as isPrismaReadMethod,y as isPrismaTransactionMethod,v as isPrismaWriteMethod,x as namesPrismaClient,O as prismaEffectsPlugin};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aburi/effects-prisma",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Aburi Prisma effects plugin: classifies prisma.<model>.<verb> and prisma.$transaction call expressions into core db.read / db.write / db.transaction effects",
   "license": "Apache-2.0",
   "author": "kage1020",
@@ -32,15 +32,16 @@
     "access": "public"
   },
   "dependencies": {
-    "@aburi/plugin-registry": "0.4.0",
-    "@aburi/types": "0.4.0"
+    "@aburi/plugin-registry": "0.5.0",
+    "@aburi/types": "0.5.0"
   },
   "devDependencies": {
     "@types/node": "^26.0.1",
     "tsdown": "^0.22.3",
     "typescript": "^6.0.3",
     "vitest": "^4.1.11",
-    "@aburi/lang-typescript": "0.4.0"
+    "@aburi/lang-typescript": "0.5.0",
+    "@aburi/test-support": "0.0.1"
   },
   "scripts": {
     "build": "tsdown",