@aburi/framework-trpc 0.0.0 → 0.1.0

package/README.md

@@ -1,7 +1,112 @@
 # @aburi/framework-trpc
 
-This version holds no code. It reserves the package name so that releases can be published from
-GitHub Actions through npm Trusted Publishing.
+tRPC framework plugin for `@aburi/core`. Classifies the **server** side of
+tRPC — the instance, routers, procedures, base procedures and middleware —
+into `framework:trpc:*` extKinds, so they are Boundaries in the IR. The client
+side, the calls that reach a procedure over the network, is
+[`@aburi/effects-trpc`](../effects-trpc/README.md)'s.
 
-Install `@aburi/framework-trpc@^0.1.0` or later. See
-<https://github.com/kage1020/Aburi/tree/main/packages/framework-trpc> for the plugin itself.
+Every shape is a `const` whose own declarator holds it:
+
+| Source shape | `extKind` | `derivedBy` |
+|---|---|---|
+| `const t = initTRPC.create()`, `initTRPC.context<Context>().meta<Meta>().create({ … })` | `framework:trpc:instance` | `framework:trpc:instance:initTRPC.create` |
+| `const appRouter = t.router({ … })`, `router({ … })`, `createTRPCRouter({ … })` | `framework:trpc:router` | `framework:trpc:router:t.router` |
+| `const merged = t.mergeRouters(a, b)`, `mergeRouters(a, b)` | `framework:trpc:router` | `framework:trpc:router:t.mergeRouters` |
+| `const byId = publicProcedure.input(schema).query(({ input }) => …)` | `framework:trpc:procedure` | `framework:trpc:procedure:publicProcedure.query` |
+| `const create = protectedProcedure.mutation(…)`, `t.procedure.subscription(…)` | `framework:trpc:procedure` | `framework:trpc:procedure:protectedProcedure.mutation` |
+| `const publicProcedure = t.procedure` | `framework:trpc:base-procedure` | `framework:trpc:base-procedure:t.procedure` |
+| `const protectedProcedure = t.procedure.use(isAuthed)`, `protectedProcedure.use(isAdmin)` | `framework:trpc:base-procedure` | `framework:trpc:base-procedure:t.use` |
+| `const isAuthed = t.middleware(({ ctx, next }) => …)`, `middleware(fn)` | `framework:trpc:middleware` | `framework:trpc:middleware:t.middleware` |
+
+A procedure is a `query`, `mutation` or `subscription` handed its resolver — a
+function, an async generator (tRPC v11's subscriptions), a name for one, or a
+call that returns one (`withCache(listUsers)`) — on a chain built from a
+procedure: one that reads `.procedure` straight off a plain name
+(`t.procedure.query(…)`) or starts from a name that is `procedure` or ends in
+`Procedure` (`publicProcedure`, `protectedProcedure`), which is how tRPC's
+documentation and create-t3-app name their base procedures. The chain is what
+tells `publicProcedure.query(resolve)` from `db.query(fn)` and from the client
+call `client.user.byId.query({ id })`. A base procedure is the same chain ending
+in `use`, `input`, `output`, `meta` or `concat` instead, or the bare
+`t.procedure`. That bare read is taken only off a plain name and only in a file
+that imports `@trpc/server`, the file that creates the instance: `procedure` is
+a domain word as well, and `form.procedure` reads the same. The three procedure
+kinds share one extKind, as an Express route's methods do, and `derivedBy` names
+which one it is.
+
+A router is `router` or `createTRPCRouter` handed one object literal, or
+`mergeRouters` handed the routers it merges; another library's
+`createRouter({ routes })` is not one. An alias of a factory
+(`export const createTRPCRouter = t.router`) is not classified: it builds
+nothing until it is called.
+
+`derivedBy` names the call `<receiver>.<method>`, read off the syntax tree as
+every framework plugin reads it: the method called and the name the receiver
+chain starts from, through `as`, `satisfies`, `!`, parentheses and every call
+on the way. So a chain wrapped over several lines, or with a comment in it,
+gives the same entry, and `t.procedure.use(timing).query(fn)` is
+`t.query`. The bare `t.procedure` is named the same way, `t.procedure`.
+
+Confidence is `high` when the file imports `@trpc/server` or one of its
+subpaths, type-only imports included, and `medium` otherwise. Most of the
+names this plugin reads are tRPC's conventions rather than its exports
+(`initTRPC` is the exception), and the usual layout keeps the import in one
+file: create-t3-app's routers import
+`createTRPCRouter` and `publicProcedure` from `~/server/api/trpc`, so their
+routers and procedures are `medium`.
+
+A procedure's resolver is its Symbol's body, so the calls, rules and effects
+written in it are the procedure's: with
+[`@aburi/effects-prisma`](../effects-prisma/README.md), a mutation whose
+resolver calls `prisma.user.create(…)` carries `db.write`.
+
+Not classified today:
+
+- A procedure written inside a router's object literal
+  (`router({ byId: publicProcedure.query(…) })`). `@aburi/lang-typescript`
+  gives an object handed to a call no member Symbols, so there is no Symbol to
+  classify, and the resolver is in no Symbol either. The router itself is
+  classified. Declare the procedure as a `const` and name it in the router to
+  give it a Symbol.
+- What is built on a base procedure whose name is neither `procedure` nor ends
+  in `Procedure` (`const base = t.procedure`, then `base.query(fn)` or
+  `base.use(x)`). `base` itself is classified, but the plugin reads one
+  declaration at a time, so it cannot see where `base` came from.
+- The bare `t.procedure` in a file that does not import `@trpc/server`.
+- A router or middleware factory under a name other than tRPC's
+  (`const makeRouter = t.router`, then `makeRouter({ … })`), for the same reason.
+- `experimental_standaloneMiddleware`, `createCallerFactory(appRouter)` and
+  `appRouter.createCaller(ctx)`.
+- A file that reaches `@trpc/server` only through CommonJS
+  (`const { initTRPC } = require("@trpc/server")`): the import list carries no
+  edge for a `require` call, so its shapes are `medium`.
+
+Classified though not tRPC's: the receiver's name is all a declaration shows,
+so another library's shapes under tRPC's names are read as tRPC's, at `medium`
+in a file that does not import `@trpc/server`. A ts-rest contract
+(`c.router({ getPost: … })`) and an oRPC router (`os.router({ ping })`) are
+routers, `app.middleware(handler)` is a middleware, and a `query` on a name
+ending in `Procedure` (`storedProcedure.query(sql)`) is a procedure.
+
+## Install
+
+```bash
+pnpm add @aburi/framework-trpc
+```
+
+## Usage
+
+```ts
+import { trpcFrameworkPlugin } from "@aburi/framework-trpc"
+```
+
+The plugin's `provides.frameworks: ["trpc"]` matches `@aburi/core`'s Component
+autodetect against a workspace `@trpc/server` npm dependency, and `aburi init`
+writes `"framework-trpc"` into `aburi.json`'s `frameworks` array for one.
+
+## See also
+
+- [`docs/design/lang-plugin.md`](../../docs/design/lang-plugin.md) — the framework `classifySymbol` contract this plugin implements.
+- [`docs/design/extension-vocab.md`](../../docs/design/extension-vocab.md) — how framework `extKind` namespaces (`framework:trpc:*`) plug into the shared vocab.
+- [`@aburi/effects-trpc`](../effects-trpc/README.md) — the client side of tRPC.

package/dist/index.d.mts

@@ -0,0 +1,26 @@
+import { FrameworkClassifyContext, FrameworkManifest, FrameworkPlugin, ImportEdge, OpaqueAstNode, PluginContext, SymbolCandidate, SymbolClassification } from "@aburi/types";
+
+//#region src/classify.d.ts
+declare function classifyTrpcSymbol(symbol: SymbolCandidate<OpaqueAstNode>, ctx: FrameworkClassifyContext): SymbolClassification | null;
+//#endregion
+//#region src/ext-kinds.d.ts
+declare const TRPC_EXT_KINDS: readonly ["framework:trpc:instance", "framework:trpc:router", "framework:trpc:procedure", "framework:trpc:base-procedure", "framework:trpc:middleware"];
+type TrpcExtKind = (typeof TRPC_EXT_KINDS)[number];
+declare const TRPC_DERIVED_BY_PREFIX = "framework:trpc";
+//#endregion
+//#region src/imports.d.ts
+declare function hasTrpcServerImport(imports: readonly ImportEdge[]): boolean;
+//#endregion
+//#region src/manifest.d.ts
+declare const frameworkTrpcManifest: FrameworkManifest;
+//#endregion
+//#region src/plugin.d.ts
+declare class TrpcFrameworkPlugin implements FrameworkPlugin<OpaqueAstNode> {
+  readonly manifest: import("@aburi/types").FrameworkManifest;
+  init(_ctx: PluginContext): Promise<void>;
+  classifySymbol(symbol: SymbolCandidate<OpaqueAstNode>, ctx: FrameworkClassifyContext): SymbolClassification | null;
+}
+/** Singleton so `manifest` identity is stable for consumers comparing against the constant. */
+declare const trpcFrameworkPlugin: TrpcFrameworkPlugin;
+//#endregion
+export { TRPC_DERIVED_BY_PREFIX, TRPC_EXT_KINDS, type TrpcExtKind, TrpcFrameworkPlugin, classifyTrpcSymbol, frameworkTrpcManifest, hasTrpcServerImport, trpcFrameworkPlugin };

package/dist/index.mjs

@@ -0,0 +1 @@
+import{asSyntaxNode as e,calleeName as t,declaratorValue as n,lastQnameSegment as r,receiverChain as i,unwrapValue as a,writtenChildren as o}from"@aburi/core";import{COMPUTED_TARGET_SEGMENT as s}from"@aburi/types";function c(e){if(e.type===`call_expression`){let n=t(e),r=e.childForFieldName(`function`);if(n===null||r===null)return null;let a=r.type===`member_expression`?r.childForFieldName(`object`):null,o=a===null?{path:[],root:n.name}:i(a);return{call:e,name:n.name,leaf:n.leaf,...o}}if(e.type===`member_expression`){let t=e.childForFieldName(`object`),n=e.childForFieldName(`property`)?.text??``;if(t===null||n.length===0)return null;let r=i(t);return{call:null,name:`${r.root}.${n}`,leaf:n,...r}}return null}const l=[`framework:trpc:instance`,`framework:trpc:router`,`framework:trpc:procedure`,`framework:trpc:base-procedure`,`framework:trpc:middleware`],u=`framework:trpc`,d=`@trpc/server`;function f(e){return e.some(({source:e})=>e===d||e.startsWith(`${d}/`))}const p=new Set([`router`,`createTRPCRouter`]),m=new Set([`query`,`mutation`,`subscription`]),h=new Set([`use`,`input`,`output`,`meta`,`concat`]),g=new Set([`arrow_function`,`function_expression`,`generator_function`,`identifier`,`member_expression`,`call_expression`]),_=/(^p|P)rocedure$/;function v(t,i){if(t.kind!==`const`)return null;let a=e(t.fullNode);if(a===null)return null;let o=n(a,r(t.name)),s=o===null?null:c(o),l=f(i.imports),d=s===null?null:y(s,l);return s===null||d===null?null:{extKind:`${u}:${d}`,derivedBy:`${u}:${d}:${s.name}`,confidence:l?`high`:`medium`}}function y(e,t){let{call:n,leaf:r}=e;if(n===null)return r===`procedure`&&e.path.length===0&&x(e.root)&&t?`base-procedure`:null;let i=S(n);if(r===`create`)return e.root===`initTRPC`?`instance`:null;if(p.has(r)){let[e,...t]=i;return e!==void 0&&t.length===0&&a(e).type===`object`?`router`:null}return r===`mergeRouters`?i.length>0?`router`:null:r===`middleware`?C(i)?`middleware`:null:b(e)?m.has(r)?C(i)?`procedure`:null:h.has(r)?`base-procedure`:null:null}function b(e){return e.path.at(-1)===`procedure`&&x(e.root)||_.test(e.root)}function x(e){return e!==`this`&&e!==s}function S(e){let t=e.childForFieldName(`arguments`);return t?.type===`arguments`?o(t):[]}function C(e){let[t,...n]=e;return t!==void 0&&n.length===0&&g.has(a(t).type)}const w={$schema:`https://aburi.kage1020.com/schema/aburi.plugin.v1.json`,name:`framework-trpc`,version:`0.0.0`,type:`framework`,engines:{aburi:`*`},provides:{effects:[],effectPrefixes:[],extKinds:[{id:`framework:trpc:instance`,baseKind:`const`,description:"The tRPC instance — a const initialised by `initTRPC.create(...)`, configured on the way or not (`initTRPC.context<C>().create()`)."},{id:`framework:trpc:router`,baseKind:`const`,description:"A tRPC router — a const initialised by `router({...})` or `createTRPCRouter({...})`, on the instance or not, or by `mergeRouters(...)`."},{id:`framework:trpc:procedure`,baseKind:`const`,description:"A tRPC procedure — a const initialised by a `query`, `mutation` or `subscription` handed its resolver, on a chain built from a procedure (`t.procedure`, or a name that is `procedure` or ends in `Procedure`)."},{id:`framework:trpc:base-procedure`,baseKind:`const`,description:"A reusable base procedure — a const initialised by `t.procedure`, or by `use`, `input`, `output`, `meta` or `concat` on a chain built from a procedure."},{id:`framework:trpc:middleware`,baseKind:`const`,description:"A tRPC middleware — a const initialised by `middleware(fn)`, on the instance or not."}],extKindPrefixes:[u],derivedByPrefixes:[u],frameworks:[`trpc`]}};var T=class{manifest=w;async init(e){}classifySymbol(e,t){return v(e,t)}};const E=new T;export{u as TRPC_DERIVED_BY_PREFIX,l as TRPC_EXT_KINDS,T as TrpcFrameworkPlugin,v as classifyTrpcSymbol,w as frameworkTrpcManifest,f as hasTrpcServerImport,E as trpcFrameworkPlugin};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aburi/framework-trpc",
-  "version": "0.0.0",
-  "description": "Name reservation for the Aburi tRPC framework plugin. Install 0.1.0 or later.",
+  "version": "0.1.0",
+  "description": "Aburi tRPC framework plugin: recognizes the server side of tRPC — the initTRPC instance, routers and merged routers, query / mutation / subscription procedures, base procedures and middleware — emitting framework:trpc:* extKinds",
   "license": "Apache-2.0",
   "author": "kage1020",
   "homepage": "https://github.com/kage1020/Aburi/tree/main/packages/framework-trpc#readme",
@@ -13,10 +13,40 @@
     "url": "git+https://github.com/kage1020/Aburi.git",
     "directory": "packages/framework-trpc"
   },
+  "type": "module",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
+    "dist",
     "README.md"
   ],
+  "sideEffects": false,
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@aburi/core": "0.6.0",
+    "@aburi/types": "0.6.0"
+  },
+  "devDependencies": {
+    "@types/node": "^26.0.1",
+    "tsdown": "^0.22.3",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.11",
+    "@aburi/lang-typescript": "0.6.0",
+    "@aburi/test-harness": "0.0.1",
+    "@aburi/test-support": "0.0.2"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run"
   }
-}
+}