@microsoft/rayfin-data 1.29.0 → 1.30.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/assets/docs/index.md +26 -0
- package/package.json +11 -4
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
---
|
|
2
|
+
symbols: []
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# @microsoft/rayfin-data
|
|
6
|
+
|
|
7
|
+
DAB-compliant data client for GraphQL access patterns.
|
|
8
|
+
|
|
9
|
+
This package ships its own docs via the `rayfinDocs` field convention
|
|
10
|
+
(see [docs-package-architecture](https://github.com/microsoft/project-rayfin/tree/main/openspec/changes/docs-package-architecture)).
|
|
11
|
+
For the full TypeDoc reference, see the bundled docs at
|
|
12
|
+
`ts-sdk/@microsoft/rayfin-data/` accessible via `rayfin docs list --module ts-sdk`.
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install @microsoft/rayfin-data
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Quickstart
|
|
21
|
+
|
|
22
|
+
This stub will expand in follow-up PRs as per-package docs are authored.
|
|
23
|
+
The Phase 2 + Phase 3 milestone for this package is the package-level
|
|
24
|
+
convention contract: declare `rayfinDocs` in `package.json`, ship a
|
|
25
|
+
`assets/docs/` directory, let `@microsoft/rayfin-docs` discover it
|
|
26
|
+
automatically.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@microsoft/rayfin-data",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.30.0",
|
|
4
4
|
"description": "Type-safe client library for Data API Builder endpoints",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -9,11 +9,12 @@
|
|
|
9
9
|
"dist/**/*.js",
|
|
10
10
|
"dist/**/*.d.ts",
|
|
11
11
|
"!dist/**/__tests__/**",
|
|
12
|
-
"LICENSE"
|
|
12
|
+
"LICENSE",
|
|
13
|
+
"assets/docs"
|
|
13
14
|
],
|
|
14
15
|
"dependencies": {
|
|
15
|
-
"@microsoft/rayfin-
|
|
16
|
-
"@microsoft/rayfin-
|
|
16
|
+
"@microsoft/rayfin-lib": "1.30.0",
|
|
17
|
+
"@microsoft/rayfin-core": "1.30.0"
|
|
17
18
|
},
|
|
18
19
|
"devDependencies": {
|
|
19
20
|
"@types/node": "^20.0.0",
|
|
@@ -43,6 +44,12 @@
|
|
|
43
44
|
"url": "https://github.com/microsoft/project-rayfin.git",
|
|
44
45
|
"directory": "packages/typescript-sdk/data"
|
|
45
46
|
},
|
|
47
|
+
"rayfinDocs": {
|
|
48
|
+
"version": 1,
|
|
49
|
+
"dir": "assets/docs",
|
|
50
|
+
"module": "rayfin-data",
|
|
51
|
+
"kind": "api-reference"
|
|
52
|
+
},
|
|
46
53
|
"scripts": {
|
|
47
54
|
"build": "tsc",
|
|
48
55
|
"build:watch": "tsc --watch",
|