@microsoft/rayfin-client 1.34.0 → 1.35.0-alpha.1274

package/dist/experimental/ConnectorsRayfinClient.d.ts

@@ -1,7 +1,37 @@
-import { createConnectorsApi, type ConnectorsSchema } from '@microsoft/rayfin-connectors';
+import { createConnectorsApi, type ConnectorConfig, type ConnectorsRuntime, type ConnectorsSchema, type HostEnvironment } from '@microsoft/rayfin-connectors';
 import { type EntitySchema } from '@microsoft/rayfin-data';
 import { type FunctionsSchema } from '@microsoft/rayfin-functions';
 import RayfinClient, { RayfinClientConfig } from '../client.js';
+/**
+ * (Experimental) Config for `ConnectorsRayfinClient`. Extends the
+ * stable {@link RayfinClientConfig} with an optional `connectors` map so
+ * the Builder can declare each connector's runtime routing config
+ * (`{ connector: ConnectorType }`) at client construction.
+ *
+ * The map is consumed by `createConnectorsApi` to pick the right
+ * transport per connector name (Cat A GraphQL vs Cat B invoke).
+ */
+export interface ConnectorsRayfinClientConfig<TConnectorsSchema extends ConnectorsSchema = ConnectorsSchema> extends RayfinClientConfig {
+    /**
+     * (Experimental) Per-connector routing config keyed by the connector
+     * name used in `rayfin.yml`. Mirrors the CLI-generated
+     * `connectorConfig` constants exported from each
+     * `rayfin/connectors/<name>/schema.ts`. Required and exhaustive: every
+     * connector declared in `TConnectorsSchema` must have a runtime config.
+     */
+    connectors: Record<keyof TConnectorsSchema & string, ConnectorConfig>;
+    /**
+     * (Experimental) Hosting environment the connectors runtime runs in. Carried
+     * on every invocation context so a registered invoke middleware can branch
+     * on it (embedded-in-Fabric vs standalone vs cli). When omitted, the host is
+     * auto-detected (`detectHost()`) so callers wire up nothing — `cli` under
+     * Node, `embedded` inside a parent frame, otherwise `standalone`. Pass an
+     * explicit value only to override detection. The connectors layer only
+     * carries this value; confirming a specific Fabric host is the job of the
+     * connector-specific package.
+     */
+    host?: HostEnvironment;
+}
 /**
  * (Experimental) Rayfin client that surfaces the typed connectors runtime as
  * `client.connectors.<name>.<operation>(input, options?)`.
@@ -39,6 +69,22 @@ import RayfinClient, { RayfinClientConfig } from '../client.js';
  * });
  * ```
  *
+ * Connectors whose operations return a binary stream (such as the
+ * `fabric-semanticmodel` Apache Arrow response) need a runtime decoder. Pass a
+ * {@link ConnectorsRuntime} as the second constructor argument, keyed by the
+ * same connector names used in the schema:
+ *
+ * @example
+ * ```ts
+ * import { fabricSemanticModel } from '@microsoft/rayfin-connector-fabric-semanticmodel';
+ *
+ * const client = new ConnectorsRayfinClient<
+ *   DataSchema,
+ *   FunctionsSchema,
+ *   AppConnectorsSchema
+ * >(config, { salesModel: fabricSemanticModel() });
+ * ```
+ *
  * @alpha
  * @internal
  */
@@ -51,11 +97,18 @@ export declare class ConnectorsRayfinClient<TSchema extends EntitySchema = Recor
     readonly connectors: ReturnType<typeof createConnectorsApi<TConnectorsSchema>>;
     /**
      * (Experimental) Creates a Rayfin client with the connectors runtime
-     * attached. Accepts the same configuration as {@link RayfinClient}.
+     * attached. Accepts the same configuration as {@link RayfinClient},
+     * plus an optional `connectors` map (see
+     * {@link ConnectorsRayfinClientConfig}) used to route Cat A vs Cat B
+     * dispatch per connector name.
      *
-     * @param config - Client configuration, including optional auth-token storage.
+     * @param config - Client configuration, including optional auth-token
+     *   storage and per-connector routing configs.
+     * @param connectorsRuntime - Optional per-connector runtime hooks (e.g. binary
+     *   decoders) keyed by connector name. Required only for connectors whose
+     *   operations return a binary stream; JSON-only connectors work without it.
      */
-    constructor(config: RayfinClientConfig);
+    constructor(config: ConnectorsRayfinClientConfig<TConnectorsSchema>, connectorsRuntime?: ConnectorsRuntime);
 }
 export default ConnectorsRayfinClient;
 //# sourceMappingURL=ConnectorsRayfinClient.d.ts.map

package/dist/experimental/ConnectorsRayfinClient.js

@@ -37,6 +37,22 @@ import RayfinClient from '../client.js';
  * });
  * ```
  *
+ * Connectors whose operations return a binary stream (such as the
+ * `fabric-semanticmodel` Apache Arrow response) need a runtime decoder. Pass a
+ * {@link ConnectorsRuntime} as the second constructor argument, keyed by the
+ * same connector names used in the schema:
+ *
+ * @example
+ * ```ts
+ * import { fabricSemanticModel } from '@microsoft/rayfin-connector-fabric-semanticmodel';
+ *
+ * const client = new ConnectorsRayfinClient<
+ *   DataSchema,
+ *   FunctionsSchema,
+ *   AppConnectorsSchema
+ * >(config, { salesModel: fabricSemanticModel() });
+ * ```
+ *
  * @alpha
  * @internal
  */
@@ -49,13 +65,20 @@ export class ConnectorsRayfinClient extends RayfinClient {
     connectors;
     /**
      * (Experimental) Creates a Rayfin client with the connectors runtime
-     * attached. Accepts the same configuration as {@link RayfinClient}.
+     * attached. Accepts the same configuration as {@link RayfinClient},
+     * plus an optional `connectors` map (see
+     * {@link ConnectorsRayfinClientConfig}) used to route Cat A vs Cat B
+     * dispatch per connector name.
      *
-     * @param config - Client configuration, including optional auth-token storage.
+     * @param config - Client configuration, including optional auth-token
+     *   storage and per-connector routing configs.
+     * @param connectorsRuntime - Optional per-connector runtime hooks (e.g. binary
+     *   decoders) keyed by connector name. Required only for connectors whose
+     *   operations return a binary stream; JSON-only connectors work without it.
      */
-    constructor(config) {
+    constructor(config, connectorsRuntime) {
         super(config);
-        this.connectors = createConnectorsApi(this.apiClient);
+        this.connectors = createConnectorsApi(this.apiClient, config.connectors, connectorsRuntime, config.host);
     }
 }
 export default ConnectorsRayfinClient;

package/dist/experimental/index.d.ts

@@ -1,5 +1,6 @@
 export { ExtendableRayfinClient, ServicePlugin, } from './ExtendableRayfinClient.js';
 export type { TServiceClasses, ServicePluginClass, } from './ExtendableRayfinClient.js';
 export { ConnectorsRayfinClient } from './ConnectorsRayfinClient.js';
-export type { ConnectorsSchema, ConnectorMarker, OperationCatalog, OperationDef, TypedConnectorsApi, TypedConnectorClient, } from '@microsoft/rayfin-connectors';
+export type { ConnectorsRayfinClientConfig } from './ConnectorsRayfinClient.js';
+export type { ConnectorConfig, ConnectorMarker, ConnectorsSchema, OperationCatalog, OperationDef, TypedConnectorsApi, TypedConnectorClient, } from '@microsoft/rayfin-connectors';
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/rayfin-client",
-  "version": "1.34.0",
+  "version": "1.35.0-alpha.1274",
   "description": "Main client SDK for Rayfin services",
   "type": "module",
   "exports": {
@@ -21,11 +21,11 @@
     "assets/docs"
   ],
   "dependencies": {
-    "@microsoft/rayfin-connectors": "1.34.0",
-    "@microsoft/rayfin-auth": "1.34.0",
-    "@microsoft/rayfin-data": "1.34.0",
-    "@microsoft/rayfin-lib": "1.34.0",
-    "@microsoft/rayfin-functions": "1.34.0"
+    "@microsoft/rayfin-connectors": "1.35.0-alpha.1274",
+    "@microsoft/rayfin-auth": "1.35.0-alpha.1274",
+    "@microsoft/rayfin-data": "1.35.0-alpha.1274",
+    "@microsoft/rayfin-lib": "1.35.0-alpha.1274",
+    "@microsoft/rayfin-functions": "1.35.0-alpha.1274"
   },
   "devDependencies": {
     "typescript": "^5.8.3",