@microsoft/rayfin-client 1.28.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.
@@ -0,0 +1,26 @@
1
+ ---
2
+ symbols: []
3
+ ---
4
+
5
+ # @microsoft/rayfin-client
6
+
7
+ High-level Rayfin client entrypoint for auth and data APIs.
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-client/` accessible via `rayfin docs list --module ts-sdk`.
13
+
14
+ ## Installation
15
+
16
+ ```bash
17
+ npm install @microsoft/rayfin-client
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/dist/client.d.ts CHANGED
@@ -5,6 +5,7 @@
5
5
  */
6
6
  import { Auth, AuthStorage } from '@microsoft/rayfin-auth';
7
7
  import { type EntitySchema, createDataApi } from '@microsoft/rayfin-data';
8
+ import { createFunctionsApi, type FunctionsSchema } from '@microsoft/rayfin-functions';
8
9
  import { SdkError, NetworkError } from '@microsoft/rayfin-lib';
9
10
  import { ApiClient, ApiClientConfig } from '@microsoft/rayfin-lib';
10
11
  /**
@@ -63,8 +64,9 @@ export declare abstract class RayfinClientBase<TSchema extends EntitySchema = Re
63
64
  * .execute();
64
65
  * ```
65
66
  */
66
- export declare class RayfinClient<TSchema extends EntitySchema = Record<string, any>> extends RayfinClientBase<TSchema> {
67
+ export declare class RayfinClient<TSchema extends EntitySchema = Record<string, any>, TFunctionsSchema extends FunctionsSchema = FunctionsSchema> extends RayfinClientBase<TSchema> {
67
68
  readonly auth: Auth;
69
+ readonly functions: ReturnType<typeof createFunctionsApi<TFunctionsSchema>>;
68
70
  constructor(config: RayfinClientConfig);
69
71
  }
70
72
  /**
package/dist/client.js CHANGED
@@ -5,6 +5,7 @@
5
5
  */
6
6
  import { Auth } from '@microsoft/rayfin-auth';
7
7
  import { createDataApi } from '@microsoft/rayfin-data';
8
+ import { createFunctionsApi, } from '@microsoft/rayfin-functions';
8
9
  import { SdkError, NetworkError } from '@microsoft/rayfin-lib';
9
10
  import { ApiClient } from '@microsoft/rayfin-lib';
10
11
  /**
@@ -71,10 +72,12 @@ export class RayfinClientBase {
71
72
  */
72
73
  export class RayfinClient extends RayfinClientBase {
73
74
  auth;
75
+ functions; // Functions-specific operations (typed function schema)
74
76
  constructor(config) {
75
77
  super(config);
76
78
  this.auth = new Auth(this.apiClient, { storage: config.authStorage });
77
79
  this.auth.attachToClient(this.apiClient);
80
+ this.functions = createFunctionsApi(this.apiClient);
78
81
  }
79
82
  }
80
83
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@microsoft/rayfin-client",
3
- "version": "1.28.0",
3
+ "version": "1.30.0",
4
4
  "description": "Main client SDK for Rayfin services",
5
5
  "type": "module",
6
6
  "exports": {
@@ -17,12 +17,14 @@
17
17
  "dist/**/*.js",
18
18
  "dist/**/*.d.ts",
19
19
  "!dist/**/__tests__/**",
20
- "LICENSE"
20
+ "LICENSE",
21
+ "assets/docs"
21
22
  ],
22
23
  "dependencies": {
23
- "@microsoft/rayfin-auth": "1.28.0",
24
- "@microsoft/rayfin-data": "1.28.0",
25
- "@microsoft/rayfin-lib": "1.28.0"
24
+ "@microsoft/rayfin-auth": "1.30.0",
25
+ "@microsoft/rayfin-data": "1.30.0",
26
+ "@microsoft/rayfin-lib": "1.30.0",
27
+ "@microsoft/rayfin-functions": "1.30.0"
26
28
  },
27
29
  "devDependencies": {
28
30
  "typescript": "^5.8.3",
@@ -41,6 +43,12 @@
41
43
  "directory": "packages/typescript-sdk/client"
42
44
  },
43
45
  "license": "MIT",
46
+ "rayfinDocs": {
47
+ "version": 1,
48
+ "dir": "assets/docs",
49
+ "module": "rayfin-client",
50
+ "kind": "api-reference"
51
+ },
44
52
  "scripts": {
45
53
  "build": "tsc",
46
54
  "test": "vitest run",