@microsoft/rayfin-client 1.24.0 → 1.27.0

package/dist/client.d.ts

@@ -1,6 +1,7 @@
 /**
  * @fileoverview Main entry point for the Rayfin SDK.
- * This file orchestrates the different modules and provides the public SDK interface.
+ * Exposes a browser-oriented RayfinClient (with full Auth support) and a
+ * server/worker-oriented RayfinServerClient (no Auth, token-based auth).
  */
 import { Auth, AuthStorage } from '@microsoft/rayfin-auth';
 import { type EntitySchema, createDataApi } from '@microsoft/rayfin-data';
@@ -21,13 +22,28 @@ export interface RayfinClientConfig extends ApiClientConfig {
      */
     authStorage?: AuthStorage | boolean;
 }
+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>> {
+    readonly data: ReturnType<typeof createDataApi<TSchema>>;
+    protected apiClient: ApiClient;
+    protected constructor(config: ApiClientConfig);
+    static readonly errors: {
+        SdkError: typeof SdkError;
+        AuthError: typeof AuthError;
+        NetworkError: typeof NetworkError;
+    };
+}
 /**
  * Main SDK class for Rayfin.
  * This class acts as the primary interface for interacting with Rayfin services,
  * providing authentication, and GraphQL capabilities through a single entry point.
  *
  * @template TSchema - Object type mapping entity names to their types
- * @example
+ * @example Frontend usage
  * ```typescript
  * const client = new RayfinClient<{
  *   User: User;
@@ -47,19 +63,27 @@ export interface RayfinClientConfig extends ApiClientConfig {
  *   .execute();
  * ```
  */
-export declare class RayfinClient<TSchema extends EntitySchema = Record<string, any>> {
+export declare class RayfinClient<TSchema extends EntitySchema = Record<string, any>> extends RayfinClientBase<TSchema> {
     readonly auth: Auth;
-    readonly data: ReturnType<typeof createDataApi<TSchema>>;
-    protected apiClient: ApiClient;
-    /**
-     * @param config Configuration for the SDK, including API base URL and publishable key.
-     */
     constructor(config: RayfinClientConfig);
-    static readonly errors: {
-        SdkError: typeof SdkError;
-        AuthError: typeof AuthError;
-        NetworkError: typeof NetworkError;
-    };
+}
+/**
+ * Server / worker (Node.js) Rayfin client. Skips the browser-coupled Auth
+ * module entirely — authentication is supplied via the accessToken config.
+ *
+ * @example
+ * ```typescript
+ * const client = new RayfinServerClient<{ Todo: Todo }>({
+ *   baseUrl: process.env.RAYFIN_BASE_URL!,
+ *   publishableKey: process.env.RAYFIN_PUBLISHABLE_KEY!,
+ *   accessToken: () => incomingRequest.headers.authorization,
+ * });
+ *
+ * const todos = await client.data.Todo.select(['id', 'title']).execute();
+ * ```
+ */
+export declare class RayfinServerClient<TSchema extends EntitySchema = Record<string, any>> extends RayfinClientBase<TSchema> {
+    constructor(config: RayfinServerClientConfig);
 }
 export default RayfinClient;
 //# sourceMappingURL=client.d.ts.map

package/dist/client.js

@@ -1,6 +1,7 @@
 /**
  * @fileoverview Main entry point for the Rayfin SDK.
- * This file orchestrates the different modules and provides the public SDK interface.
+ * Exposes a browser-oriented RayfinClient (with full Auth support) and a
+ * server/worker-oriented RayfinServerClient (no Auth, token-based auth).
  */
 import { Auth } from '@microsoft/rayfin-auth';
 import { createDataApi } from '@microsoft/rayfin-data';
@@ -14,13 +15,41 @@ export class AuthError extends SdkError {
         super(message, code || 'AUTH_ERROR');
     }
 }
+/** Shared base for Rayfin clients: owns the typed data API and the underlying HTTP client. */
+export class RayfinClientBase {
+    data;
+    apiClient;
+    constructor(config) {
+        if (!config.baseUrl && !config.useProxy) {
+            throw new SdkError('SDK configuration requires a baseUrl.', '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,
+            publishableKey: config.publishableKey,
+            useProxy: config.useProxy,
+            headers: config.headers,
+            timeout: config.timeout,
+            getAccessToken: config.getAccessToken,
+        });
+        this.data = createDataApi(this.apiClient);
+    }
+    // Static access to custom errors for easy import by consumers
+    static errors = {
+        SdkError,
+        AuthError,
+        NetworkError,
+    };
+}
 /**
  * Main SDK class for Rayfin.
  * This class acts as the primary interface for interacting with Rayfin services,
  * providing authentication, and GraphQL capabilities through a single entry point.
  *
  * @template TSchema - Object type mapping entity names to their types
- * @example
+ * @example Frontend usage
  * ```typescript
  * const client = new RayfinClient<{
  *   User: User;
@@ -40,40 +69,40 @@ export class AuthError extends SdkError {
  *   .execute();
  * ```
  */
-export class RayfinClient {
-    auth; // The authentication module using the full Auth class
-    data; // Data-specific operations
-    apiClient;
-    /**
-     * @param config Configuration for the SDK, including API base URL and publishable key.
-     */
+export class RayfinClient extends RayfinClientBase {
+    auth;
     constructor(config) {
-        if (!config.baseUrl && !config.useProxy) {
-            throw new SdkError('SDK configuration requires a baseUrl.', '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,
-            publishableKey: config.publishableKey,
-            useProxy: config.useProxy,
-            headers: config.headers,
-            timeout: config.timeout,
-        });
-        // Initialize modules
+        super(config);
         this.auth = new Auth(this.apiClient, { storage: config.authStorage });
-        this.data = createDataApi(this.apiClient);
-        // Wire up the token callback to automatically include tokens in API requests
         this.auth.attachToClient(this.apiClient);
     }
-    // Static access to custom errors for easy import by consumers
-    static errors = {
-        SdkError,
-        AuthError,
-        NetworkError,
-    };
 }
-// Export default client and types
+/**
+ * Server / worker (Node.js) Rayfin client. Skips the browser-coupled Auth
+ * module entirely — authentication is supplied via the accessToken config.
+ *
+ * @example
+ * ```typescript
+ * const client = new RayfinServerClient<{ Todo: Todo }>({
+ *   baseUrl: process.env.RAYFIN_BASE_URL!,
+ *   publishableKey: process.env.RAYFIN_PUBLISHABLE_KEY!,
+ *   accessToken: () => incomingRequest.headers.authorization,
+ * });
+ *
+ * const todos = await client.data.Todo.select(['id', 'title']).execute();
+ * ```
+ */
+export class RayfinServerClient extends RayfinClientBase {
+    constructor(config) {
+        super(config);
+        if (config.accessToken !== undefined) {
+            const tokenFn = typeof config.accessToken === 'function'
+                ? config.accessToken
+                : () => config.accessToken;
+            this.apiClient.setAccessTokenCallback(tokenFn);
+        }
+    }
+}
+// Default export remains the browser client for backward compatibility.
 export default RayfinClient;
 //# sourceMappingURL=client.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/rayfin-client",
-  "version": "1.24.0",
+  "version": "1.27.0",
   "description": "Main client SDK for Rayfin services",
   "type": "module",
   "exports": {
@@ -20,9 +20,9 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@microsoft/rayfin-auth": "1.24.0",
-    "@microsoft/rayfin-data": "1.24.0",
-    "@microsoft/rayfin-lib": "1.24.0"
+    "@microsoft/rayfin-auth": "1.27.0",
+    "@microsoft/rayfin-data": "1.27.0",
+    "@microsoft/rayfin-lib": "1.27.0"
   },
   "devDependencies": {
     "typescript": "^5.8.3",