@microsoft/rayfin-client 1.34.0-alpha.1225 → 1.34.0-beta.1

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.
@@ -1,26 +1,7 @@
1
- import { createConnectorsApi, type ConnectorConfig, type ConnectorsRuntime, type ConnectorsSchema } from '@microsoft/rayfin-connectors';
1
+ import { createConnectorsApi, type ConnectorsSchema } from '@microsoft/rayfin-connectors';
2
2
  import { type EntitySchema } from '@microsoft/rayfin-data';
3
3
  import { type FunctionsSchema } from '@microsoft/rayfin-functions';
4
4
  import RayfinClient, { RayfinClientConfig } from '../client.js';
5
- /**
6
- * (Experimental) Config for `ConnectorsRayfinClient`. Extends the
7
- * stable {@link RayfinClientConfig} with an optional `connectors` map so
8
- * the Builder can declare each connector's runtime routing config
9
- * (`{ connector: ConnectorType }`) at client construction.
10
- *
11
- * The map is consumed by `createConnectorsApi` to pick the right
12
- * transport per connector name (Cat A GraphQL vs Cat B invoke).
13
- */
14
- export interface ConnectorsRayfinClientConfig<TConnectorsSchema extends ConnectorsSchema = ConnectorsSchema> extends RayfinClientConfig {
15
- /**
16
- * (Experimental) Per-connector routing config keyed by the connector
17
- * name used in `rayfin.yml`. Mirrors the CLI-generated
18
- * `connectorConfig` constants exported from each
19
- * `rayfin/connectors/<name>/schema.ts`. Required and exhaustive: every
20
- * connector declared in `TConnectorsSchema` must have a runtime config.
21
- */
22
- connectors: Record<keyof TConnectorsSchema & string, ConnectorConfig>;
23
- }
24
5
  /**
25
6
  * (Experimental) Rayfin client that surfaces the typed connectors runtime as
26
7
  * `client.connectors.<name>.<operation>(input, options?)`.
@@ -58,22 +39,6 @@ export interface ConnectorsRayfinClientConfig<TConnectorsSchema extends Connecto
58
39
  * });
59
40
  * ```
60
41
  *
61
- * Connectors whose operations return a binary stream (such as the
62
- * `fabric-semanticmodel` Apache Arrow response) need a runtime decoder. Pass a
63
- * {@link ConnectorsRuntime} as the second constructor argument, keyed by the
64
- * same connector names used in the schema:
65
- *
66
- * @example
67
- * ```ts
68
- * import { fabricSemanticModel } from '@microsoft/rayfin-connector-fabric-semanticmodel';
69
- *
70
- * const client = new ConnectorsRayfinClient<
71
- * DataSchema,
72
- * FunctionsSchema,
73
- * AppConnectorsSchema
74
- * >(config, { salesModel: fabricSemanticModel() });
75
- * ```
76
- *
77
42
  * @alpha
78
43
  * @internal
79
44
  */
@@ -86,18 +51,11 @@ export declare class ConnectorsRayfinClient<TSchema extends EntitySchema = Recor
86
51
  readonly connectors: ReturnType<typeof createConnectorsApi<TConnectorsSchema>>;
87
52
  /**
88
53
  * (Experimental) Creates a Rayfin client with the connectors runtime
89
- * attached. Accepts the same configuration as {@link RayfinClient},
90
- * plus an optional `connectors` map (see
91
- * {@link ConnectorsRayfinClientConfig}) used to route Cat A vs Cat B
92
- * dispatch per connector name.
54
+ * attached. Accepts the same configuration as {@link RayfinClient}.
93
55
  *
94
- * @param config - Client configuration, including optional auth-token
95
- * storage and per-connector routing configs.
96
- * @param connectorsRuntime - Optional per-connector runtime hooks (e.g. binary
97
- * decoders) keyed by connector name. Required only for connectors whose
98
- * operations return a binary stream; JSON-only connectors work without it.
56
+ * @param config - Client configuration, including optional auth-token storage.
99
57
  */
100
- constructor(config: ConnectorsRayfinClientConfig<TConnectorsSchema>, connectorsRuntime?: ConnectorsRuntime);
58
+ constructor(config: RayfinClientConfig);
101
59
  }
102
60
  export default ConnectorsRayfinClient;
103
61
  //# sourceMappingURL=ConnectorsRayfinClient.d.ts.map
@@ -37,22 +37,6 @@ import RayfinClient from '../client.js';
37
37
  * });
38
38
  * ```
39
39
  *
40
- * Connectors whose operations return a binary stream (such as the
41
- * `fabric-semanticmodel` Apache Arrow response) need a runtime decoder. Pass a
42
- * {@link ConnectorsRuntime} as the second constructor argument, keyed by the
43
- * same connector names used in the schema:
44
- *
45
- * @example
46
- * ```ts
47
- * import { fabricSemanticModel } from '@microsoft/rayfin-connector-fabric-semanticmodel';
48
- *
49
- * const client = new ConnectorsRayfinClient<
50
- * DataSchema,
51
- * FunctionsSchema,
52
- * AppConnectorsSchema
53
- * >(config, { salesModel: fabricSemanticModel() });
54
- * ```
55
- *
56
40
  * @alpha
57
41
  * @internal
58
42
  */
@@ -65,20 +49,13 @@ export class ConnectorsRayfinClient extends RayfinClient {
65
49
  connectors;
66
50
  /**
67
51
  * (Experimental) Creates a Rayfin client with the connectors runtime
68
- * attached. Accepts the same configuration as {@link RayfinClient},
69
- * plus an optional `connectors` map (see
70
- * {@link ConnectorsRayfinClientConfig}) used to route Cat A vs Cat B
71
- * dispatch per connector name.
52
+ * attached. Accepts the same configuration as {@link RayfinClient}.
72
53
  *
73
- * @param config - Client configuration, including optional auth-token
74
- * storage and per-connector routing configs.
75
- * @param connectorsRuntime - Optional per-connector runtime hooks (e.g. binary
76
- * decoders) keyed by connector name. Required only for connectors whose
77
- * operations return a binary stream; JSON-only connectors work without it.
54
+ * @param config - Client configuration, including optional auth-token storage.
78
55
  */
79
- constructor(config, connectorsRuntime) {
56
+ constructor(config) {
80
57
  super(config);
81
- this.connectors = createConnectorsApi(this.apiClient, config.connectors, connectorsRuntime);
58
+ this.connectors = createConnectorsApi(this.apiClient);
82
59
  }
83
60
  }
84
61
  export default ConnectorsRayfinClient;
@@ -1,6 +1,5 @@
1
1
  export { ExtendableRayfinClient, ServicePlugin, } from './ExtendableRayfinClient.js';
2
2
  export type { TServiceClasses, ServicePluginClass, } from './ExtendableRayfinClient.js';
3
3
  export { ConnectorsRayfinClient } from './ConnectorsRayfinClient.js';
4
- export type { ConnectorsRayfinClientConfig } from './ConnectorsRayfinClient.js';
5
- export type { ConnectorConfig, ConnectorMarker, ConnectorsSchema, OperationCatalog, OperationDef, TypedConnectorsApi, TypedConnectorClient, } from '@microsoft/rayfin-connectors';
4
+ export type { ConnectorsSchema, ConnectorMarker, OperationCatalog, OperationDef, TypedConnectorsApi, TypedConnectorClient, } from '@microsoft/rayfin-connectors';
6
5
  //# sourceMappingURL=index.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@microsoft/rayfin-client",
3
- "version": "1.34.0-alpha.1225",
3
+ "version": "1.34.0-beta.1",
4
4
  "description": "Main client SDK for Rayfin services",
5
5
  "type": "module",
6
6
  "exports": {
@@ -21,11 +21,11 @@
21
21
  "assets/docs"
22
22
  ],
23
23
  "dependencies": {
24
- "@microsoft/rayfin-auth": "1.34.0-alpha.1225",
25
- "@microsoft/rayfin-connectors": "1.34.0-alpha.1225",
26
- "@microsoft/rayfin-lib": "1.34.0-alpha.1225",
27
- "@microsoft/rayfin-data": "1.34.0-alpha.1225",
28
- "@microsoft/rayfin-functions": "1.34.0-alpha.1225"
24
+ "@microsoft/rayfin-auth": "1.34.0-beta.1",
25
+ "@microsoft/rayfin-connectors": "1.34.0-beta.1",
26
+ "@microsoft/rayfin-lib": "1.34.0-beta.1",
27
+ "@microsoft/rayfin-data": "1.34.0-beta.1",
28
+ "@microsoft/rayfin-functions": "1.34.0-beta.1"
29
29
  },
30
30
  "devDependencies": {
31
31
  "typescript": "^5.8.3",