@microsoft/rayfin-client 1.33.1 → 1.34.0-alpha.1148

package/dist/client.d.ts

@@ -12,8 +12,16 @@ import { ApiClient, ApiClientConfig } from '@microsoft/rayfin-lib';
  * Auth error specific to the Rayfin SDK.
  */
 export declare class AuthError extends SdkError {
+    /**
+     * @param message - Human-readable error description.
+     * @param code - Optional stable error code (defaults to `'AUTH_ERROR'`).
+     */
     constructor(message: string, code?: string);
 }
+/**
+ * Configuration for the browser-oriented {@link RayfinClient}, extending the
+ * base HTTP client configuration with auth-token storage options.
+ */
 export interface RayfinClientConfig extends ApiClientConfig {
     /**
      * Storage implementation for authentication tokens.
@@ -23,15 +31,22 @@ export interface RayfinClientConfig extends ApiClientConfig {
      */
     authStorage?: AuthStorage | boolean;
 }
+/**
+ * Configuration for the server/worker-oriented {@link RayfinServerClient}.
+ * Omits the browser-only `getAccessToken` hook in favor of a supplied
+ * access token.
+ */
 export interface RayfinServerClientConfig extends Omit<ApiClientConfig, 'getAccessToken'> {
     /** Access token (string or function) for Authorization: Bearer <token>. Use the function form to rotate per request. */
     accessToken?: string | (() => string | null);
 }
 /** Shared base for Rayfin clients: owns the typed data API and the underlying HTTP client. */
 export declare abstract class RayfinClientBase<TSchema extends EntitySchema = Record<string, any>> {
+    /** Typed data API for querying and mutating your entities. */
     readonly data: ReturnType<typeof createDataApi<TSchema>>;
     protected apiClient: ApiClient;
     protected constructor(config: ApiClientConfig);
+    /** SDK error classes, exposed for convenient `instanceof` checks. */
     static readonly errors: {
         SdkError: typeof SdkError;
         AuthError: typeof AuthError;
@@ -65,8 +80,15 @@ export declare abstract class RayfinClientBase<TSchema extends EntitySchema = Re
  * ```
  */
 export declare class RayfinClient<TSchema extends EntitySchema = Record<string, any>, TFunctionsSchema extends FunctionsSchema = FunctionsSchema> extends RayfinClientBase<TSchema> {
+    /** Authentication operations (sign up, sign in, sign out, session state). */
     readonly auth: Auth;
+    /** Typed, schema-aware accessors for invoking your backend functions. */
     readonly functions: ReturnType<typeof createFunctionsApi<TFunctionsSchema>>;
+    /**
+     * Creates a browser Rayfin client and wires up authentication.
+     *
+     * @param config - Client configuration, including optional auth-token storage.
+     */
     constructor(config: RayfinClientConfig);
 }
 /**
@@ -85,6 +107,12 @@ export declare class RayfinClient<TSchema extends EntitySchema = Record<string,
  * ```
  */
 export declare class RayfinServerClient<TSchema extends EntitySchema = Record<string, any>> extends RayfinClientBase<TSchema> {
+    /**
+     * Creates a server/worker Rayfin client using a supplied access token.
+     *
+     * @param config - Client configuration, including the access token (string or
+     * function form for per-request rotation).
+     */
     constructor(config: RayfinServerClientConfig);
 }
 export default RayfinClient;

package/dist/client.js

@@ -12,23 +12,39 @@ import { ApiClient } from '@microsoft/rayfin-lib';
  * Auth error specific to the Rayfin SDK.
  */
 export class AuthError extends SdkError {
+    /**
+     * @param message - Human-readable error description.
+     * @param code - Optional stable error code (defaults to `'AUTH_ERROR'`).
+     */
     constructor(message, code) {
         super(message, code || 'AUTH_ERROR');
     }
 }
 /** Shared base for Rayfin clients: owns the typed data API and the underlying HTTP client. */
 export class RayfinClientBase {
+    /** Typed data API for querying and mutating your entities. */
     data;
     apiClient;
     constructor(config) {
-        if (!config.baseUrl && !config.useProxy) {
-            throw new SdkError('SDK configuration requires a baseUrl.', 'MISSING_BASE_URL');
+        // Legacy compatibility: before `useProxy` was deprecated, passing
+        // `useProxy: true` without a `baseUrl` meant "route same-origin through the
+        // dev-server proxy". Preserve that as `baseUrl: ''` during the deprecation
+        // window so existing consumers are not broken. The ApiClient emits the
+        // one-time `useProxy` deprecation warning.
+        const baseUrl = (config.baseUrl === undefined || config.baseUrl === null) &&
+            config.useProxy
+            ? ''
+            : config.baseUrl;
+        if (baseUrl === undefined || baseUrl === null) {
+            throw new SdkError('SDK configuration requires a baseUrl. Pass an absolute URL to call a ' +
+                "backend directly, or an empty string ('') to keep requests " +
+                'same-origin so a development proxy can forward them.', 'MISSING_BASE_URL');
         }
         if (!config.publishableKey || config.publishableKey.trim() === '') {
             throw new SdkError('SDK configuration requires a publishableKey for service-level authentication.', 'MISSING_PUBLISHABLE_KEY');
         }
         this.apiClient = new ApiClient({
-            baseUrl: config.baseUrl,
+            baseUrl: baseUrl,
             publishableKey: config.publishableKey,
             functionsBaseUrl: config.functionsBaseUrl,
             useProxy: config.useProxy,
@@ -39,6 +55,7 @@ export class RayfinClientBase {
         this.data = createDataApi(this.apiClient);
     }
     // Static access to custom errors for easy import by consumers
+    /** SDK error classes, exposed for convenient `instanceof` checks. */
     static errors = {
         SdkError,
         AuthError,
@@ -72,8 +89,15 @@ export class RayfinClientBase {
  * ```
  */
 export class RayfinClient extends RayfinClientBase {
+    /** Authentication operations (sign up, sign in, sign out, session state). */
     auth;
-    functions; // Functions-specific operations (typed function schema)
+    /** Typed, schema-aware accessors for invoking your backend functions. */
+    functions;
+    /**
+     * Creates a browser Rayfin client and wires up authentication.
+     *
+     * @param config - Client configuration, including optional auth-token storage.
+     */
     constructor(config) {
         super(config);
         this.auth = new Auth(this.apiClient, { storage: config.authStorage });
@@ -97,6 +121,12 @@ export class RayfinClient extends RayfinClientBase {
  * ```
  */
 export class RayfinServerClient extends RayfinClientBase {
+    /**
+     * Creates a server/worker Rayfin client using a supplied access token.
+     *
+     * @param config - Client configuration, including the access token (string or
+     * function form for per-request rotation).
+     */
     constructor(config) {
         super(config);
         if (config.accessToken !== undefined) {

package/dist/experimental/ConnectorsRayfinClient.d.ts

@@ -0,0 +1,61 @@
+import { createConnectorsApi, type ConnectorsSchema } 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) Rayfin client that surfaces the typed connectors runtime as
+ * `client.connectors.<name>.<operation>(input, options?)`.
+ *
+ * The connector layer is being incubated under the experimental subpath while
+ * the API and configuration model stabilize. Public consumers should import
+ * from `@microsoft/rayfin-client/experimental` rather than the stable entry.
+ *
+ * @typeParam TSchema - Data entity schema (same shape as {@link RayfinClient}).
+ * @typeParam TFunctionsSchema - Functions schema (same shape as {@link RayfinClient}).
+ * @typeParam TConnectorsSchema - Connector schema mapping connector names
+ *   (as declared in `rayfin.yml`) to typed connector markers such as
+ *   `FabricSemanticModel<'executeQuery'>`.
+ *
+ * @example
+ * ```ts
+ * import { ConnectorsRayfinClient } from '@microsoft/rayfin-client/experimental';
+ * import type { FabricSemanticModel } from '@microsoft/rayfin-connector-fabric-semanticmodel';
+ *
+ * type AppConnectorsSchema = {
+ *   salesModel: FabricSemanticModel<'executeQuery'>;
+ * };
+ *
+ * const client = new ConnectorsRayfinClient<
+ *   DataSchema,
+ *   FunctionsSchema,
+ *   AppConnectorsSchema
+ * >({
+ *   baseUrl: import.meta.env.VITE_RAYFIN_BASE_URL,
+ *   publishableKey: import.meta.env.VITE_RAYFIN_PUBLISHABLE_KEY,
+ * });
+ *
+ * const result = await client.connectors.salesModel.executeQuery({
+ *   query: 'EVALUATE TOPN(10, Sales)',
+ * });
+ * ```
+ *
+ * @alpha
+ * @internal
+ */
+export declare class ConnectorsRayfinClient<TSchema extends EntitySchema = Record<string, any>, TFunctionsSchema extends FunctionsSchema = FunctionsSchema, TConnectorsSchema extends ConnectorsSchema = ConnectorsSchema> extends RayfinClient<TSchema, TFunctionsSchema> {
+    /**
+     * (Experimental) Typed accessors for connectors declared in `rayfin.yml`.
+     * Each property resolves lazily on first access; the underlying transport
+     * (`POST /connector-invoke`) is shared with the rest of the SDK.
+     */
+    readonly connectors: ReturnType<typeof createConnectorsApi<TConnectorsSchema>>;
+    /**
+     * (Experimental) Creates a Rayfin client with the connectors runtime
+     * attached. Accepts the same configuration as {@link RayfinClient}.
+     *
+     * @param config - Client configuration, including optional auth-token storage.
+     */
+    constructor(config: RayfinClientConfig);
+}
+export default ConnectorsRayfinClient;
+//# sourceMappingURL=ConnectorsRayfinClient.d.ts.map

package/dist/experimental/ConnectorsRayfinClient.js

@@ -0,0 +1,62 @@
+import { createConnectorsApi, } from '@microsoft/rayfin-connectors';
+import RayfinClient from '../client.js';
+/**
+ * (Experimental) Rayfin client that surfaces the typed connectors runtime as
+ * `client.connectors.<name>.<operation>(input, options?)`.
+ *
+ * The connector layer is being incubated under the experimental subpath while
+ * the API and configuration model stabilize. Public consumers should import
+ * from `@microsoft/rayfin-client/experimental` rather than the stable entry.
+ *
+ * @typeParam TSchema - Data entity schema (same shape as {@link RayfinClient}).
+ * @typeParam TFunctionsSchema - Functions schema (same shape as {@link RayfinClient}).
+ * @typeParam TConnectorsSchema - Connector schema mapping connector names
+ *   (as declared in `rayfin.yml`) to typed connector markers such as
+ *   `FabricSemanticModel<'executeQuery'>`.
+ *
+ * @example
+ * ```ts
+ * import { ConnectorsRayfinClient } from '@microsoft/rayfin-client/experimental';
+ * import type { FabricSemanticModel } from '@microsoft/rayfin-connector-fabric-semanticmodel';
+ *
+ * type AppConnectorsSchema = {
+ *   salesModel: FabricSemanticModel<'executeQuery'>;
+ * };
+ *
+ * const client = new ConnectorsRayfinClient<
+ *   DataSchema,
+ *   FunctionsSchema,
+ *   AppConnectorsSchema
+ * >({
+ *   baseUrl: import.meta.env.VITE_RAYFIN_BASE_URL,
+ *   publishableKey: import.meta.env.VITE_RAYFIN_PUBLISHABLE_KEY,
+ * });
+ *
+ * const result = await client.connectors.salesModel.executeQuery({
+ *   query: 'EVALUATE TOPN(10, Sales)',
+ * });
+ * ```
+ *
+ * @alpha
+ * @internal
+ */
+export class ConnectorsRayfinClient extends RayfinClient {
+    /**
+     * (Experimental) Typed accessors for connectors declared in `rayfin.yml`.
+     * Each property resolves lazily on first access; the underlying transport
+     * (`POST /connector-invoke`) is shared with the rest of the SDK.
+     */
+    connectors;
+    /**
+     * (Experimental) Creates a Rayfin client with the connectors runtime
+     * attached. Accepts the same configuration as {@link RayfinClient}.
+     *
+     * @param config - Client configuration, including optional auth-token storage.
+     */
+    constructor(config) {
+        super(config);
+        this.connectors = createConnectorsApi(this.apiClient);
+    }
+}
+export default ConnectorsRayfinClient;
+//# sourceMappingURL=ConnectorsRayfinClient.js.map

package/dist/experimental/index.d.ts

@@ -1,3 +1,5 @@
 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';
 //# sourceMappingURL=index.d.ts.map

package/dist/experimental/index.js

@@ -1,2 +1,3 @@
 export { ExtendableRayfinClient, ServicePlugin, } from './ExtendableRayfinClient.js';
+export { ConnectorsRayfinClient } from './ConnectorsRayfinClient.js';
 //# sourceMappingURL=index.js.map

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 export * from './client.js';
 export { default } from './client.js';
 export type { TypedDataClients, EntitySchema } from '@microsoft/rayfin-data';
+export type { FunctionsSchema } from '@microsoft/rayfin-functions';
 export type { ApiClientConfig } from '@microsoft/rayfin-lib';
+export { setDeprecationsSilenced, isDeprecationSilenced, } from '@microsoft/rayfin-lib';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,4 +1,7 @@
 // Export all from client.ts
 export * from './client.js';
 export { default } from './client.js';
+// Re-export deprecation silencing controls from rayfin-lib so consumers have a
+// stable public import path here; emitter helpers stay internal to the SDK.
+export { setDeprecationsSilenced, isDeprecationSilenced, } from '@microsoft/rayfin-lib';
 //# sourceMappingURL=index.js.map

package/package.json

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