@ts-pf/docs 0.1.1 → 0.1.3

package/README.md

@@ -69,6 +69,8 @@ import { writeFileSync } from 'node:fs'
 writeFileSync('contract.d.ts', emit(catalog(contract, { prefix: '/rpc' })))
 ```
 
+`emit()` prints JSDoc from `docs()`. Other `.meta()` keys stay on the catalog JSON.
+
 Serve the JSON in **userland**, outside the RPC prefix (`GET /rpc/...` is a procedure miss, not a spec):
 
 ```ts

package/dist/converters/typebox.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typebox.d.ts","sourceRoot":"","sources":["../../src/converters/typebox.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AAE5D,eAAO,MAAM,0BAA0B,EAAE,mBAaxC,CAAA"}
+{"version":3,"file":"typebox.d.ts","sourceRoot":"","sources":["../../src/converters/typebox.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AAgB5D,eAAO,MAAM,0BAA0B,EAAE,mBAgBxC,CAAA"}

package/dist/converters/typebox.js

@@ -1,3 +1,15 @@
+const JSON_SCHEMA_TYPES = new Set([
+    'string',
+    'number',
+    'integer',
+    'boolean',
+    'null',
+    'object',
+    'array',
+]);
+function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
 export const typeboxJsonSchemaConverter = {
     vendor: 'typebox',
     accept(schema) {
@@ -7,7 +19,68 @@ export const typeboxJsonSchemaConverter = {
             typeof schema['~kind'] === 'string');
     },
     convert(schema) {
-        return JSON.parse(JSON.stringify(schema));
+        const cloned = JSON.parse(JSON.stringify(schema));
+        rewriteNamedRefs(cloned);
+        assertJsonSchemaTypes(cloned);
+        return cloned;
     },
 };
+function rewriteNamedRefs(root) {
+    const defsKey = isRecord(root.$defs)
+        ? '$defs'
+        : isRecord(root.definitions)
+            ? 'definitions'
+            : undefined;
+    if (defsKey === undefined) {
+        return;
+    }
+    const names = new Set(Object.keys(root[defsKey]));
+    rewrite(root, names, defsKey);
+}
+function rewrite(value, names, defsKey) {
+    if (Array.isArray(value)) {
+        for (const item of value) {
+            rewrite(item, names, defsKey);
+        }
+        return;
+    }
+    if (!isRecord(value)) {
+        return;
+    }
+    if (typeof value.$ref === 'string' && names.has(value.$ref)) {
+        value.$ref = `#/${defsKey}/${escapePointer(value.$ref)}`;
+    }
+    for (const child of Object.values(value)) {
+        rewrite(child, names, defsKey);
+    }
+}
+function assertJsonSchemaTypes(value) {
+    if (Array.isArray(value)) {
+        for (const item of value) {
+            assertJsonSchemaTypes(item);
+        }
+        return;
+    }
+    if (!isRecord(value)) {
+        return;
+    }
+    if (typeof value.type === 'string') {
+        if (!JSON_SCHEMA_TYPES.has(value.type)) {
+            throw new Error(`TypeBox type "${value.type}" is not JSON Schema`);
+        }
+    }
+    else if (Array.isArray(value.type)) {
+        for (const item of value.type) {
+            if (typeof item === 'string' && !JSON_SCHEMA_TYPES.has(item)) {
+                throw new Error(`TypeBox type "${item}" is not JSON Schema`);
+            }
+        }
+    }
+    for (const child of Object.values(value)) {
+        assertJsonSchemaTypes(child);
+    }
+}
+function escapePointer(value) {
+    return value.replace(/~/g, '~0').replace(/\//g, '~1');
+}
 //# sourceMappingURL=typebox.js.map

package/dist/converters/typebox.js.map

@@ -1 +1 @@
-{"version":3,"file":"typebox.js","sourceRoot":"","sources":["../../src/converters/typebox.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,0BAA0B,GAAwB;IAC7D,MAAM,EAAE,SAAS;IACjB,MAAM,CAAC,MAAM;QACX,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;YAC1B,MAAM,KAAK,IAAI;YACf,OAAO,IAAI,MAAM;YACjB,OAAQ,MAA+B,CAAC,OAAO,CAAC,KAAK,QAAQ,CAC9D,CAAA;IACH,CAAC;IACD,OAAO,CAAC,MAAM;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAA4B,CAAA;IACtE,CAAC;CACF,CAAA"}
+{"version":3,"file":"typebox.js","sourceRoot":"","sources":["../../src/converters/typebox.ts"],"names":[],"mappings":"AAEA,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC;IAChC,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,SAAS;IACT,MAAM;IACN,QAAQ;IACR,OAAO;CACR,CAAC,CAAA;AAEF,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAC7E,CAAC;AAED,MAAM,CAAC,MAAM,0BAA0B,GAAwB;IAC7D,MAAM,EAAE,SAAS;IACjB,MAAM,CAAC,MAAM;QACX,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;YAC1B,MAAM,KAAK,IAAI;YACf,OAAO,IAAI,MAAM;YACjB,OAAQ,MAA+B,CAAC,OAAO,CAAC,KAAK,QAAQ,CAC9D,CAAA;IACH,CAAC;IACD,OAAO,CAAC,MAAM;QACZ,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAA4B,CAAA;QAC5E,gBAAgB,CAAC,MAAM,CAAC,CAAA;QACxB,qBAAqB,CAAC,MAAM,CAAC,CAAA;QAC7B,OAAO,MAAM,CAAA;IACf,CAAC;CACF,CAAA;AAED,SAAS,gBAAgB,CAAC,IAA6B;IACrD,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;QAClC,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC;YAC1B,CAAC,CAAC,aAAa;YACf,CAAC,CAAC,SAAS,CAAA;IACf,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAM;IACR,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAA4B,CAAC,CAAC,CAAA;IAC5E,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;AAC/B,CAAC;AAED,SAAS,OAAO,CAAC,KAAc,EAAE,KAAkB,EAAE,OAAe;IAClE,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;QAC/B,CAAC;QACD,OAAM;IACR,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAM;IACR,CAAC;IACD,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5D,KAAK,CAAC,IAAI,GAAG,KAAK,OAAO,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAA;IAC1D,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QACzC,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IAChC,CAAC;AACH,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAc;IAC3C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,qBAAqB,CAAC,IAAI,CAAC,CAAA;QAC7B,CAAC;QACD,OAAM;IACR,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAM;IACR,CAAC;IACD,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACnC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,iBAAiB,KAAK,CAAC,IAAI,sBAAsB,CAAC,CAAA;QACpE,CAAC;IACH,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YAC9B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7D,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,sBAAsB,CAAC,CAAA;YAC9D,CAAC;QACH,CAAC;IACH,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QACzC,qBAAqB,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,KAAa;IAClC,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;AACvD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ts-pf/docs",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Opt-in procedure catalog from a contract (docs, catalog)",
   "keywords": [
     "ts-pf",
@@ -28,18 +28,12 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./src/index.ts",
-      "import": "./src/index.ts"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
     }
   },
   "publishConfig": {
-    "access": "public",
-    "exports": {
-      ".": {
-        "types": "./dist/index.d.ts",
-        "import": "./dist/index.js"
-      }
-    }
+    "access": "public"
   },
   "files": [
     "dist",
@@ -53,9 +47,9 @@
   },
   "dependencies": {
     "@standard-schema/spec": "^1.0.0",
-    "@ts-pf/contract": "0.1.1",
-    "@ts-pf/http": "0.1.0",
-    "@ts-pf/protocol": "0.1.0"
+    "@ts-pf/contract": "0.1.2",
+    "@ts-pf/http": "0.1.1",
+    "@ts-pf/protocol": "0.1.1"
   },
   "peerDependencies": {
     "typebox": "^1.0.0"
@@ -66,7 +60,7 @@
     }
   },
   "devDependencies": {
-    "@ts-pf/stream": "0.1.1",
+    "@ts-pf/stream": "0.1.2",
     "typebox": "^1.3.24",
     "zod": "^4.0.0"
   }

package/skills/ts-pf-docs/SKILL.md

@@ -38,7 +38,7 @@ if (url.pathname === '/catalog.json') {
 ## Pair with
 
 - OpenAPI: `ts-pf-openapi`
-- Split-repo `.d.ts`: `ts-pf-codegen`
+- Split-repo `.d.ts`: `ts-pf-codegen` (`emit()` prints JSDoc from `docs()`)
 - Descriptions live on existing `.meta()` — not `.docs()` on the builder
 
 ## Don't