@microsoft/rayfin-client 1.33.0 → 1.33.2

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,12 +12,17 @@ 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) {
@@ -39,6 +44,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 +78,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 +110,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/package.json

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