@adhd/apigen-plugin-health 0.1.0

package/index.d.ts

@@ -0,0 +1,3 @@
+export type { HealthOptions } from './lib/plugin';
+export { healthPlugin } 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 s(e){return{raw:e,words:[e]}}function n(e,t={}){return[{id:"_meta/health",host:e.host,namespace:s("meta"),path:[s("health")],kind:"query",async:!1,streaming:!1,safe:!0,input:{},output:{type:"object",required:["status","host"],properties:{status:{const:"ok"},host:{type:"string"},meta:{type:"object"}}},envelope:{},typeText:null,transports:["http","grpc"],handler:i=>{const a={status:"ok",host:e.host};return t.meta!==void 0&&Object.keys(t.meta).length>0&&(a.meta=t.meta),a}}]}const o={id:"health",description:"Mount plugin: exposes GET /meta/health for gateway readiness (SPEC §13.1)",optionsSchema:{type:"object",properties:{meta:{type:"object",description:"Extra metadata included in the health response"}},additionalProperties:!1},capabilities:{mount:{operations(e,t){return n(e,t)}}}};exports.default=o;exports.healthPlugin=o;

package/index.mjs

@@ -0,0 +1,66 @@
+function s(t) {
+  return { raw: t, words: [t] };
+}
+function n(t, e = {}) {
+  return [
+    {
+      // Canonical id — `_meta` prefix convention for meta-endpoints.
+      id: "_meta/health",
+      host: t.host,
+      namespace: s("meta"),
+      path: [s("health")],
+      // query + safe → GET /meta/health; gRPC also useful for load-balancer probes.
+      kind: "query",
+      async: !1,
+      streaming: !1,
+      safe: !0,
+      // Input: no domain params.
+      input: {},
+      // Output: the HealthResponse shape (inlined for zero extra dependencies).
+      output: {
+        type: "object",
+        required: ["status", "host"],
+        properties: {
+          status: { const: "ok" },
+          host: { type: "string" },
+          meta: { type: "object" }
+        }
+      },
+      envelope: {},
+      typeText: null,
+      // Expose on HTTP and gRPC — useful for both HTTP health checks and
+      // gRPC-native load-balancer probes (SPEC §7.2c / §13.1).
+      transports: ["http", "grpc"],
+      // Handler: always returns ready when the runtime can answer.
+      handler: (o) => {
+        const a = {
+          status: "ok",
+          host: t.host
+        };
+        return e.meta !== void 0 && Object.keys(e.meta).length > 0 && (a.meta = e.meta), a;
+      }
+    }
+  ];
+}
+const r = {
+  id: "health",
+  description: "Mount plugin: exposes GET /meta/health for gateway readiness (SPEC §13.1)",
+  optionsSchema: {
+    type: "object",
+    properties: {
+      meta: { type: "object", description: "Extra metadata included in the health response" }
+    },
+    additionalProperties: !1
+  },
+  capabilities: {
+    mount: {
+      operations(t, e) {
+        return n(t, e);
+      }
+    }
+  }
+};
+export {
+  r as default,
+  r as healthPlugin
+};

package/lib/plugin.d.ts

@@ -0,0 +1,33 @@
+import { Plugin } from '@adhd/apigen-core';
+
+/** Options accepted by the health mount plugin. */
+export interface HealthOptions {
+    /**
+     * Optional extra metadata to include in the health response payload.
+     * Values must be serialisable (string / number / boolean / null).
+     */
+    meta?: Record<string, string | number | boolean | null>;
+}
+/**
+ * The readiness signal emitted by `_meta/health`.
+ *
+ * - `status: 'ok'` — the runtime is alive and ready to serve.
+ * - `host`         — the owning language runtime tag from the descriptor.
+ * - `meta`         — optional operator-supplied metadata (see {@link HealthOptions}).
+ *
+ * The gateway feeds on this shape when aggregating per-host status (§13.1).
+ */
+export interface HealthResponse {
+    status: 'ok';
+    host: string;
+    meta?: Record<string, string | number | boolean | null>;
+}
+/**
+ * v2 health mount plugin (SPEC §7.1 / §7.2c).
+ *
+ * Contributes `GET /meta/health` (+ gRPC) → `{ status: 'ok', host: '...' }`.
+ * The gateway routes a host's operations only after this endpoint reports
+ * ready (SPEC §13.1 gateway readiness contract).
+ */
+export declare const healthPlugin: Plugin<HealthOptions>;
+export default healthPlugin;

package/package.json

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