@ts-pf/docs 0.1.6 → 0.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +10 -3
- package/dist/catalog.d.ts.map +1 -1
- package/dist/catalog.js +9 -12
- package/dist/catalog.js.map +1 -1
- package/package.json +8 -6
- package/skills/ts-pf-docs/SKILL.md +3 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ts-pf contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -33,7 +33,7 @@ export const contract = router({
|
|
|
33
33
|
|
|
34
34
|
```ts
|
|
35
35
|
import { catalog } from '@ts-pf/docs'
|
|
36
|
-
import { contract } from './contract'
|
|
36
|
+
import { contract } from './contract.js'
|
|
37
37
|
|
|
38
38
|
const spec = catalog(contract, { prefix: '/rpc' })
|
|
39
39
|
// spec.procedures[0].key === 'planet/find'
|
|
@@ -53,6 +53,7 @@ The catalog is the portable spec (like `.proto` / `openapi.yaml`). Downstream pa
|
|
|
53
53
|
OpenAPI 3.1 (polyglot, POST JSON RPC only):
|
|
54
54
|
|
|
55
55
|
```ts
|
|
56
|
+
import { catalog } from '@ts-pf/docs'
|
|
56
57
|
import { openapi } from '@ts-pf/openapi'
|
|
57
58
|
|
|
58
59
|
const spec = openapi(catalog(contract, { prefix: '/rpc' }), {
|
|
@@ -63,6 +64,7 @@ const spec = openapi(catalog(contract, { prefix: '/rpc' }), {
|
|
|
63
64
|
Typed `.d.ts` for a split-repo `createClient<Contract>`:
|
|
64
65
|
|
|
65
66
|
```ts
|
|
67
|
+
import { catalog } from '@ts-pf/docs'
|
|
66
68
|
import { emit } from '@ts-pf/codegen'
|
|
67
69
|
import { writeFileSync } from 'node:fs'
|
|
68
70
|
|
|
@@ -71,9 +73,9 @@ writeFileSync('contract.d.ts', emit(catalog(contract, { prefix: '/rpc' })))
|
|
|
71
73
|
|
|
72
74
|
`emit()` prints JSDoc from `docs()`. Other `.meta()` keys stay on the catalog JSON.
|
|
73
75
|
|
|
74
|
-
Serve the JSON in **userland**, outside the RPC prefix (`GET /rpc/...`
|
|
76
|
+
Serve the JSON in **userland**, outside the RPC prefix (`GET /rpc/...` answers `405 METHOD_NOT_ALLOWED`; the RPC prefix serves procedures, not a spec):
|
|
75
77
|
|
|
76
|
-
```ts
|
|
78
|
+
```ts no-check
|
|
77
79
|
if (url.pathname === '/catalog.json') {
|
|
78
80
|
return Response.json(catalog(contract, { prefix: '/rpc' }))
|
|
79
81
|
}
|
|
@@ -82,6 +84,11 @@ const result = await handler.handle(req, { prefix: '/rpc', context })
|
|
|
82
84
|
|
|
83
85
|
See [`@ts-pf/openapi`](../openapi) and [`@ts-pf/codegen`](../codegen).
|
|
84
86
|
|
|
87
|
+
## API
|
|
88
|
+
|
|
89
|
+
- `docs`, `getDocs`, `catalog`, `walkContract`
|
|
90
|
+
- `registerJsonSchemaConverter`, `toJsonSchema`
|
|
91
|
+
|
|
85
92
|
## Not in this package
|
|
86
93
|
|
|
87
94
|
- OpenAPI / Swagger / Scalar (see [`@ts-pf/openapi`](../openapi))
|
package/dist/catalog.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAKV,gBAAgB,EACjB,MAAM,YAAY,CAAA;AAGnB,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE;QACf,IAAI,EAAE,MAAM,EAAE,CAAA;QACd,SAAS,EAAE;YAAE,QAAQ,CAAC,KAAK,EAAE;gBAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;aAAE,CAAA;SAAE,CAAA;KACjE,KAAK,OAAO,CAAA;CACd,CAAA;AA0CD,wBAAgB,OAAO,CACrB,QAAQ,EAAE,OAAO,EACjB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB,CA+BlB"}
|
package/dist/catalog.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { joinProcedurePath, PROTOCOL_HEADER } from '@ts-pf/http';
|
|
1
|
+
import { joinProcedurePath, PROTOCOL_HEADER, PROTOCOL_HTTP_STATUS, } from '@ts-pf/http';
|
|
2
2
|
import { PROTOCOL_VERSION, ProtocolErrorCode } from '@ts-pf/protocol';
|
|
3
3
|
import { getDocs } from './docs.js';
|
|
4
4
|
import { tryToJsonSchema } from './json-schema.js';
|
|
@@ -26,18 +26,15 @@ const VALIDATION_DATA_SCHEMA = {
|
|
|
26
26
|
},
|
|
27
27
|
},
|
|
28
28
|
};
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
29
|
+
// Codes come from ProtocolErrorCode (key order); statuses from the
|
|
30
|
+
// @ts-pf/http table. Neither is hand-copied here.
|
|
31
|
+
const PROTOCOL_ERRORS = Object.values(ProtocolErrorCode).map((code) => code === ProtocolErrorCode.VALIDATION
|
|
32
|
+
? {
|
|
33
|
+
code,
|
|
34
|
+
status: PROTOCOL_HTTP_STATUS[code],
|
|
34
35
|
data: { kind: 'json', jsonSchema: VALIDATION_DATA_SCHEMA },
|
|
35
|
-
}
|
|
36
|
-
{ code
|
|
37
|
-
{ code: ProtocolErrorCode.INTERNAL, status: 500 },
|
|
38
|
-
{ code: ProtocolErrorCode.METHOD_NOT_ALLOWED, status: 405 },
|
|
39
|
-
{ code: ProtocolErrorCode.PAYLOAD_TOO_LARGE, status: 413 },
|
|
40
|
-
];
|
|
36
|
+
}
|
|
37
|
+
: { code, status: PROTOCOL_HTTP_STATUS[code] });
|
|
41
38
|
export function catalog(contract, options = {}) {
|
|
42
39
|
const schemas = options.schemas ?? true;
|
|
43
40
|
const filter = options.filter ??
|
package/dist/catalog.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"catalog.js","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"catalog.js","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,oBAAoB,GACrB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAQlD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAWxC,qEAAqE;AACrE,MAAM,sBAAsB,GAAe;IACzC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,QAAQ,CAAC;IACpB,UAAU,EAAE;QACV,MAAM,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,KAAK;gBAC3B,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC;gBAC7B,UAAU,EAAE;oBACV,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC3B,IAAI,EAAE;wBACJ,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE;qBACtC;iBACF;aACF;SACF;KACF;CACF,CAAA;AAED,mEAAmE;AACnE,kDAAkD;AAClD,MAAM,eAAe,GAIhB,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACjD,IAAI,KAAK,iBAAiB,CAAC,UAAU;IACnC,CAAC,CAAC;QACE,IAAI;QACJ,MAAM,EAAE,oBAAoB,CAAC,IAAI,CAAC;QAClC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,sBAAsB,EAAE;KAC3D;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,oBAAoB,CAAC,IAAI,CAAC,EAAE,CACjD,CAAA;AAED,MAAM,UAAU,OAAO,CACrB,QAAiB,EACjB,UAA0B,EAAE;IAE5B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,IAAI,CAAA;IACvC,MAAM,MAAM,GACV,OAAO,CAAC,MAAM;QACd,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC,CAAA;IAEpE,MAAM,UAAU,GAAuB,EAAE,CAAA;IACzC,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACnB,SAAQ;QACV,CAAC;QACD,UAAU,CAAC,IAAI,CACb,WAAW,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAClE,CAAA;IACH,CAAC;IAED,MAAM,MAAM,GAAqB;QAC/B,cAAc,EAAE,CAAC;QACjB,QAAQ,EAAE;YACR,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,gBAAgB;YACzB,MAAM,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,gBAAgB,EAAE;YAC1D,MAAM,EAAE,MAAM;SACf;QACD,cAAc,EAAE,eAAe;QAC/B,UAAU;KACX,CAAA;IACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAA;IAChC,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,SAAS,WAAW,CAClB,IAAc,EACd,SAUC,EACD,MAA0B,EAC1B,OAAgB;IAEhB,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAAA;IAC5B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC9B,MAAM,IAAI,GAAqB;QAC7B,IAAI;QACJ,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;QACnB,IAAI,EAAE,EAAE,GAAG,GAAG,CAAC,IAAI,EAAE;QACrB,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE;YACrD,MAAM,IAAI,GAAiB,EAAE,IAAI,EAAE,CAAA;YACnC,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAC7B,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAA;YAC1B,CAAC;YACD,IAAI,GAAG,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC9B,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAA;YAC5B,CAAC;YACD,IAAI,OAAO,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBACtC,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;YACjD,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC,CAAC;KACH,CAAA;IACD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IAC7C,CAAC;IACD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IACD,IAAI,OAAO,EAAE,CAAC;QACZ,IAAI,GAAG,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,CAAC,KAAK,GAAG,eAAe,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QAClD,CAAC;QACD,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;QACrD,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,YAAY,CAAC,MAAe;IACnC,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,MAAM,KAAK,IAAI;QACf,WAAW,IAAI,MAAM;QACpB,MAAgD,CAAC,WAAW,CAAC,EAAE,MAAM;YACpE,OAAO,CACV,CAAA;AACH,CAAC;AAED,SAAS,UAAU,CAAC,MAAe;IACjC,IACE,OAAO,MAAM,KAAK,QAAQ;QAC1B,MAAM,KAAK,IAAI;QACf,CAAC,CAAC,WAAW,IAAI,MAAM,CAAC,EACxB,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,MAAM,KAAK,GAAI,MAA+C,CAAC,WAAW,CAAC,CAAA;IAC3E,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,EAAE,CAAC;QACtE,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAA;AACnB,CAAC;AAED,SAAS,eAAe,CACtB,MAAe,EACf,EAAsB;IAEtB,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;QACzB,MAAM,MAAM,GAAkB,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,CAAA;QACjE,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;QAC/B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,GAAG,eAAe,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QACzC,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IACD,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,CAAA;IACjD,IAAI,SAAS,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,MAAM,GAAkB;YAC5B,IAAI,EAAE,MAAM;YACZ,UAAU,EAAE,SAAS,CAAC,MAAM;SAC7B,CAAA;QACD,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,CAAA;QAClC,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,CAAA;AAC1D,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ts-pf/docs",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.7",
|
|
4
4
|
"description": "Opt-in procedure catalog from a contract (docs, catalog)",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ts-pf",
|
|
@@ -15,6 +15,9 @@
|
|
|
15
15
|
"documentation"
|
|
16
16
|
],
|
|
17
17
|
"license": "MIT",
|
|
18
|
+
"engines": {
|
|
19
|
+
"node": ">=22"
|
|
20
|
+
},
|
|
18
21
|
"repository": {
|
|
19
22
|
"type": "git",
|
|
20
23
|
"url": "git+https://github.com/crobinson42/ts-pf.git",
|
|
@@ -46,10 +49,9 @@
|
|
|
46
49
|
"lint": "biome check src tests"
|
|
47
50
|
},
|
|
48
51
|
"dependencies": {
|
|
49
|
-
"@
|
|
50
|
-
"@ts-pf/
|
|
51
|
-
"@ts-pf/
|
|
52
|
-
"@ts-pf/protocol": "0.1.2"
|
|
52
|
+
"@ts-pf/contract": "0.2.0",
|
|
53
|
+
"@ts-pf/http": "0.2.0",
|
|
54
|
+
"@ts-pf/protocol": "0.2.0"
|
|
53
55
|
},
|
|
54
56
|
"peerDependencies": {
|
|
55
57
|
"typebox": "^1.0.0"
|
|
@@ -60,7 +62,7 @@
|
|
|
60
62
|
}
|
|
61
63
|
},
|
|
62
64
|
"devDependencies": {
|
|
63
|
-
"@ts-pf/stream": "0.
|
|
65
|
+
"@ts-pf/stream": "0.2.0",
|
|
64
66
|
"typebox": "^1.3.24",
|
|
65
67
|
"zod": "^4.0.0"
|
|
66
68
|
}
|
|
@@ -14,6 +14,7 @@ Link for agents: `npx skills experimental_sync -y`
|
|
|
14
14
|
## Do
|
|
15
15
|
|
|
16
16
|
```ts
|
|
17
|
+
import { procedure } from '@ts-pf/contract'
|
|
17
18
|
import { docs, catalog } from '@ts-pf/docs'
|
|
18
19
|
|
|
19
20
|
procedure.meta(docs({ description: 'Find a planet by id' }))
|
|
@@ -22,7 +23,7 @@ const spec = catalog(contract, { prefix: '/rpc' })
|
|
|
22
23
|
|
|
23
24
|
Serve JSON in userland, outside the RPC prefix:
|
|
24
25
|
|
|
25
|
-
```ts
|
|
26
|
+
```ts no-check
|
|
26
27
|
if (url.pathname === '/catalog.json') {
|
|
27
28
|
return Response.json(catalog(contract, { prefix: '/rpc' }))
|
|
28
29
|
}
|
|
@@ -44,6 +45,6 @@ if (url.pathname === '/catalog.json') {
|
|
|
44
45
|
## Don't
|
|
45
46
|
|
|
46
47
|
- `.docs()` on the contract builder.
|
|
47
|
-
- Serve the catalog from `FetchHandler` (`GET /rpc/...`
|
|
48
|
+
- Serve the catalog from `FetchHandler` (`GET /rpc/...` answers `405 METHOD_NOT_ALLOWED`; the RPC prefix serves procedures only).
|
|
48
49
|
- Walk an implemented `app` — pass `contract`.
|
|
49
50
|
- REST `method` / `path` / path params.
|