@torrow/sdk-docs 0.1.0
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/README.md +35 -0
- package/dist/index.d.ts +4428 -0
- package/dist/index.js +4937 -0
- package/dist/index.js.map +1 -0
- package/package.json +45 -0
package/README.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# @torrow/sdk-docs
|
|
2
|
+
|
|
3
|
+
Machine-readable SDK documentation artifacts for MCP/AI integrations.
|
|
4
|
+
|
|
5
|
+
This package is not a markdown docs bundle. It ships typed, importable catalogs used by
|
|
6
|
+
agents, generators, and tooling that need semantic metadata about SDK DTOs and methods.
|
|
7
|
+
|
|
8
|
+
- `ItemFieldDoc` primitives
|
|
9
|
+
- `*FieldDocEntries` and `*FieldDocs` collections
|
|
10
|
+
- `mcpItemFieldCatalog`
|
|
11
|
+
- `mcpRelationFieldCatalog`
|
|
12
|
+
- `mcpBookingFieldCatalog`
|
|
13
|
+
- `mcpViewsFieldCatalog`
|
|
14
|
+
- `mcpUserProfilesFieldCatalog`
|
|
15
|
+
- `mcpAuthFieldCatalog`
|
|
16
|
+
- `mcpSearchFieldCatalog`
|
|
17
|
+
- `mcpOperationsFieldCatalog`
|
|
18
|
+
- `mcpFullFieldCatalog`
|
|
19
|
+
|
|
20
|
+
## Install
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install @torrow/sdk-docs
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
import { mcpFullFieldCatalog } from "@torrow/sdk-docs";
|
|
30
|
+
import { authSdkMethodFieldDocEntries } from "@torrow/sdk-docs";
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Runtime client package
|
|
34
|
+
|
|
35
|
+
HTTP client and domain facades live in `@torrow/sdk-client`.
|