@adhd/apigen-plugin-openapi 0.1.0

package/index.d.ts

@@ -0,0 +1,3 @@
+export type { OpenapiOptions } from './lib/plugin';
+export { openapiPlugin } from './lib/plugin';
+export { default } from './lib/plugin';

package/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});function m(e){return e.words.join("-")}function g(e){return e.words.map(P).join("")}function b(e){return e.words.join("_")}function v(e,t={}){var d,h;const n=[e.namespace,...e.path],s=e.safe?"GET":"POST",r=((h=(d=t.http)==null?void 0:d.verb)==null?void 0:h[e.id])??s,o="/"+n.map(i=>m(i)).join("/"),l=n.map(i=>b(i)).join("_"),p=n.map(i=>b(i)).slice(0,-1).join("."),u=g(n[n.length-2]??n[0]),c=g(n[n.length-1]),a=n.map(i=>m(i));return{http:{verb:r,route:o},mcp:{name:l},grpc:{package:p,service:u,method:c},cli:{path:a}}}function P(e){return e.length===0?e:e[0].toUpperCase()+e.slice(1)}function O(e,t={}){const n=t.title??"API",s=t.version??"0.0.0",r={};for(const o of e){const l=v(o),{verb:f,route:p}=l.http,u=f.toLowerCase(),c={operationId:o.id,summary:o.id,responses:{200:S(o.output)}};if(o.safe)c.parameters=q(o.input);else{const a=o.input;typeof a=="object"&&a!==null&&Object.keys(a).length>0&&(c.requestBody={required:!0,content:{"application/json":{schema:a}}})}r[p]===void 0&&(r[p]={}),r[p][u]=c}return{openapi:"3.1.0",info:{title:n,version:s},paths:r}}function S(e){return typeof e=="object"&&e!==null&&Object.keys(e).length>0?{description:"Success",content:{"application/json":{schema:e}}}:{description:"Success"}}function q(e){if(typeof e!="object"||e===null||typeof e.properties!="object"||e.properties===null)return[];const t=Array.isArray(e.required)?e.required:[],n=e.properties;return Object.entries(n).map(([s,r])=>({name:s,in:"query",required:t.includes(s),schema:r}))}function y(e){return{raw:e,words:e.split(/(?=[A-Z])|[-_]/).map(t=>t.toLowerCase()).filter(Boolean)}}function A(e,t={}){return[{id:"_meta/openapi",host:e.host,namespace:y("meta"),path:[y("openapi")],kind:"query",async:!1,streaming:!1,safe:!0,input:{},output:{type:"object"},envelope:{},typeText:null,transports:["http"],handler:n=>O(e.operations,{title:t.title,version:t.version})}]}const j={id:"openapi",description:"Mount plugin: serves the OpenAPI 3.1 doc at GET /meta/openapi",optionsSchema:{type:"object",properties:{title:{type:"string",description:"OpenAPI info.title"},version:{type:"string",description:"OpenAPI info.version"}},additionalProperties:!1},capabilities:{mount:{operations(e,t){return A(e,t)}}}};exports.default=j;exports.openapiPlugin=j;

package/index.mjs

@@ -0,0 +1,128 @@
+function m(e) {
+  return e.words.join("-");
+}
+function y(e) {
+  return e.words.map(v).join("");
+}
+function b(e) {
+  return e.words.join("_");
+}
+function j(e, t = {}) {
+  var f, h;
+  const n = [e.namespace, ...e.path], s = e.safe ? "GET" : "POST", r = ((h = (f = t.http) == null ? void 0 : f.verb) == null ? void 0 : h[e.id]) ?? s, o = "/" + n.map((i) => m(i)).join("/"), l = n.map((i) => b(i)).join("_"), a = n.map((i) => b(i)).slice(0, -1).join("."), u = y(n[n.length - 2] ?? n[0]), c = y(n[n.length - 1]), p = n.map((i) => m(i));
+  return {
+    http: { verb: r, route: o },
+    mcp: { name: l },
+    grpc: { package: a, service: u, method: c },
+    cli: { path: p }
+  };
+}
+function v(e) {
+  return e.length === 0 ? e : e[0].toUpperCase() + e.slice(1);
+}
+function P(e, t = {}) {
+  const n = t.title ?? "API", s = t.version ?? "0.0.0", r = {};
+  for (const o of e) {
+    const l = j(o), { verb: d, route: a } = l.http, u = d.toLowerCase(), c = {
+      operationId: o.id,
+      summary: o.id,
+      responses: {
+        200: O(o.output)
+      }
+    };
+    if (o.safe)
+      c.parameters = q(o.input);
+    else {
+      const p = o.input;
+      typeof p == "object" && p !== null && Object.keys(p).length > 0 && (c.requestBody = {
+        required: !0,
+        content: {
+          "application/json": {
+            schema: p
+          }
+        }
+      });
+    }
+    r[a] === void 0 && (r[a] = {}), r[a][u] = c;
+  }
+  return {
+    openapi: "3.1.0",
+    info: { title: n, version: s },
+    paths: r
+  };
+}
+function O(e) {
+  return typeof e == "object" && e !== null && Object.keys(e).length > 0 ? {
+    description: "Success",
+    content: {
+      "application/json": { schema: e }
+    }
+  } : { description: "Success" };
+}
+function q(e) {
+  if (typeof e != "object" || e === null || typeof e.properties != "object" || e.properties === null)
+    return [];
+  const t = Array.isArray(e.required) ? e.required : [], n = e.properties;
+  return Object.entries(n).map(([s, r]) => ({
+    name: s,
+    in: "query",
+    required: t.includes(s),
+    schema: r
+  }));
+}
+function g(e) {
+  return { raw: e, words: e.split(/(?=[A-Z])|[-_]/).map((t) => t.toLowerCase()).filter(Boolean) };
+}
+function A(e, t = {}) {
+  return [
+    {
+      // Canonical id — the `_meta` prefix is a convention for meta-endpoints.
+      id: "_meta/openapi",
+      host: e.host,
+      namespace: g("meta"),
+      path: [g("openapi")],
+      // query + safe → GET /meta/openapi (SPEC §5)
+      kind: "query",
+      async: !1,
+      streaming: !1,
+      safe: !0,
+      // Input: no domain params — this is a zero-arg metadata endpoint.
+      input: {},
+      // Output: an object (the full OpenAPI doc shape; not narrowed further
+      // here because the exact schema varies with the descriptor content).
+      output: { type: "object" },
+      envelope: {},
+      typeText: null,
+      // Expose only on HTTP — the doc is a tooling artefact (SPEC §7.2b).
+      transports: ["http"],
+      // Handler: derive the doc from the descriptor at request time.
+      handler: (n) => P(e.operations, {
+        title: t.title,
+        version: t.version
+      })
+    }
+  ];
+}
+const S = {
+  id: "openapi",
+  description: "Mount plugin: serves the OpenAPI 3.1 doc at GET /meta/openapi",
+  optionsSchema: {
+    type: "object",
+    properties: {
+      title: { type: "string", description: "OpenAPI info.title" },
+      version: { type: "string", description: "OpenAPI info.version" }
+    },
+    additionalProperties: !1
+  },
+  capabilities: {
+    mount: {
+      operations(e, t) {
+        return A(e, t);
+      }
+    }
+  }
+};
+export {
+  S as default,
+  S as openapiPlugin
+};

package/lib/plugin.d.ts

@@ -0,0 +1,23 @@
+import { Plugin } from '@adhd/apigen-core';
+
+/** Options accepted by the openapi mount plugin. */
+export interface OpenapiOptions {
+    /**
+     * The API title placed in the generated OpenAPI doc's `info.title`.
+     * @default 'API'
+     */
+    title?: string;
+    /**
+     * The API version placed in the generated OpenAPI doc's `info.version`.
+     * @default '0.0.0'
+     */
+    version?: string;
+}
+/**
+ * v2 openapi mount plugin (SPEC §7.1 / §7.2b).
+ *
+ * Contributes `GET /meta/openapi` → the OpenAPI 3.1 document derived from
+ * the canonical descriptor at request time.
+ */
+export declare const openapiPlugin: Plugin<OpenapiOptions>;
+export default openapiPlugin;

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@adhd/apigen-plugin-openapi",
+  "version": "0.1.0",
+  "main": "./index.js",
+  "dependencies": {
+    "@adhd/apigen-core": "^0.1.0",
+    "@adhd/apigen-codegen-openapi": "^0.1.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "module": "./index.mjs",
+  "types": "./index.d.ts"
+}