@microsoft/rayfin-client 1.32.0 → 1.33.0-beta.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/dist/client.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @fileoverview Main entry point for the Rayfin SDK.
2
+ * @packageDocumentation Main entry point for the Rayfin SDK.
3
3
  * Exposes a browser-oriented RayfinClient (with full Auth support) and a
4
4
  * server/worker-oriented RayfinServerClient (no Auth, token-based auth).
5
5
  */
@@ -43,7 +43,7 @@ export declare abstract class RayfinClientBase<TSchema extends EntitySchema = Re
43
43
  * This class acts as the primary interface for interacting with Rayfin services,
44
44
  * providing authentication, and GraphQL capabilities through a single entry point.
45
45
  *
46
- * @template TSchema - Object type mapping entity names to their types
46
+ * @typeParam TSchema - Object type mapping entity names to their types
47
47
  * @example Frontend usage
48
48
  * ```typescript
49
49
  * const client = new RayfinClient<{
package/dist/client.js CHANGED
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @fileoverview Main entry point for the Rayfin SDK.
2
+ * @packageDocumentation Main entry point for the Rayfin SDK.
3
3
  * Exposes a browser-oriented RayfinClient (with full Auth support) and a
4
4
  * server/worker-oriented RayfinServerClient (no Auth, token-based auth).
5
5
  */
@@ -50,7 +50,7 @@ export class RayfinClientBase {
50
50
  * This class acts as the primary interface for interacting with Rayfin services,
51
51
  * providing authentication, and GraphQL capabilities through a single entry point.
52
52
  *
53
- * @template TSchema - Object type mapping entity names to their types
53
+ * @typeParam TSchema - Object type mapping entity names to their types
54
54
  * @example Frontend usage
55
55
  * ```typescript
56
56
  * const client = new RayfinClient<{
@@ -4,7 +4,7 @@ export { ServicePlugin, type TServiceClasses, type ServicePluginFactory as Servi
4
4
  /**
5
5
  * (Experimental) Extendable Rayfin Client supports adding custom services. Use `ExtendableRayfinClient.create` to instantiate.
6
6
  * @alpha
7
- * @hidden
7
+ * @internal
8
8
  */
9
9
  export declare class ExtendableRayfinClient<TSchema extends Record<string, any> = Record<string, any>, TServices extends Record<string, ServicePlugin> = Record<string, ServicePlugin>> extends RayfinClient<TSchema> {
10
10
  private services;
@@ -15,7 +15,7 @@ export declare class ExtendableRayfinClient<TSchema extends Record<string, any>
15
15
  /**
16
16
  * (Experimental) Create an instance of ExtendableRayfinClient with custom services.
17
17
  * @alpha
18
- * @hidden
18
+ * @internal
19
19
  * @param config - The configuration for the Rayfin client.
20
20
  * @param services - The custom services to extend the client with.
21
21
  * @returns An instance of ExtendableRayfinClient with the specified services.
@@ -4,7 +4,7 @@ export { ServicePlugin, };
4
4
  /**
5
5
  * (Experimental) Extendable Rayfin Client supports adding custom services. Use `ExtendableRayfinClient.create` to instantiate.
6
6
  * @alpha
7
- * @hidden
7
+ * @internal
8
8
  */
9
9
  export class ExtendableRayfinClient extends RayfinClient {
10
10
  services = {};
@@ -55,7 +55,7 @@ export class ExtendableRayfinClient extends RayfinClient {
55
55
  /**
56
56
  * (Experimental) Create an instance of ExtendableRayfinClient with custom services.
57
57
  * @alpha
58
- * @hidden
58
+ * @internal
59
59
  * @param config - The configuration for the Rayfin client.
60
60
  * @param services - The custom services to extend the client with.
61
61
  * @returns An instance of ExtendableRayfinClient with the specified services.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@microsoft/rayfin-client",
3
- "version": "1.32.0",
3
+ "version": "1.33.0-beta.0",
4
4
  "description": "Main client SDK for Rayfin services",
5
5
  "type": "module",
6
6
  "exports": {
@@ -21,10 +21,10 @@
21
21
  "assets/docs"
22
22
  ],
23
23
  "dependencies": {
24
- "@microsoft/rayfin-auth": "1.32.0",
25
- "@microsoft/rayfin-data": "1.32.0",
26
- "@microsoft/rayfin-lib": "1.32.0",
27
- "@microsoft/rayfin-functions": "1.32.0"
24
+ "@microsoft/rayfin-auth": "1.33.0-beta.0",
25
+ "@microsoft/rayfin-data": "1.33.0-beta.0",
26
+ "@microsoft/rayfin-lib": "1.33.0-beta.0",
27
+ "@microsoft/rayfin-functions": "1.33.0-beta.0"
28
28
  },
29
29
  "devDependencies": {
30
30
  "typescript": "^5.8.3",