@microsoft/rayfin-client 1.20.0

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+# @microsoft/rayfin-client
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which
+includes all source code repositories in our GitHub organizations.
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+For security reporting information, locations, contact information, and policies,
+please review the latest guidance for Microsoft repositories at
+[https://aka.ms/SECURITY.md](https://aka.ms/SECURITY.md).
+
+## Trademarks
+
+This project may contain trademarks or logos for projects, products, or services.
+Authorized use of Microsoft trademarks or logos must follow the [Microsoft Trademark and Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+Any use of third-party trademarks or logos is subject to those third parties' policies.
+
+## License
+
+Copyright (c) Microsoft Corporation.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/client.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @fileoverview Main entry point for the Rayfin SDK.
+ * This file orchestrates the different modules and provides the public SDK interface.
+ */
+import { Auth, AuthStorage } from '@microsoft/rayfin-auth';
+import { type EntitySchema, createDataApi } from '@microsoft/rayfin-data';
+import { SdkError, NetworkError } from '@microsoft/rayfin-lib';
+import { ApiClient, ApiClientConfig } from '@microsoft/rayfin-lib';
+/**
+ * Auth error specific to the Rayfin SDK.
+ */
+export declare class AuthError extends SdkError {
+    constructor(message: string, code?: string);
+}
+export interface RayfinClientConfig extends ApiClientConfig {
+    /**
+     * Storage implementation for authentication tokens.
+     * If set to true, localStorage will be used.
+     * If set to false, no storage will be used.
+     * You may also provide your own storage or use browser's built-in Session Storage
+     */
+    authStorage?: AuthStorage | boolean;
+}
+/**
+ * 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
+ * ```typescript
+ * const client = new RayfinClient<{
+ *   User: User;
+ *   Organization: Organization;
+ * }>({
+ *   baseUrl: 'http://localhost:5000',
+ *   publishableKey: 'pk-Abc123-def456-GHI78'
+ * });
+ *
+ * // Authentication operations
+ * await client.auth.signUp({ email: 'user@example.com', password: 'password' });
+ *
+ * // GraphQL operations
+ * const activeUsers = await client.User
+ *   .select(['id', 'name', 'email'])
+ *   .where({ isActive: true })
+ *   .execute();
+ * ```
+ */
+export declare class RayfinClient<TSchema extends EntitySchema = Record<string, any>> {
+    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;
+    };
+}
+export default RayfinClient;
+//# sourceMappingURL=client.d.ts.map

package/dist/client.js

@@ -0,0 +1,79 @@
+/**
+ * @fileoverview Main entry point for the Rayfin SDK.
+ * This file orchestrates the different modules and provides the public SDK interface.
+ */
+import { Auth } from '@microsoft/rayfin-auth';
+import { createDataApi } from '@microsoft/rayfin-data';
+import { SdkError, NetworkError } from '@microsoft/rayfin-lib';
+import { ApiClient } from '@microsoft/rayfin-lib';
+/**
+ * Auth error specific to the Rayfin SDK.
+ */
+export class AuthError extends SdkError {
+    constructor(message, code) {
+        super(message, code || 'AUTH_ERROR');
+    }
+}
+/**
+ * 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
+ * ```typescript
+ * const client = new RayfinClient<{
+ *   User: User;
+ *   Organization: Organization;
+ * }>({
+ *   baseUrl: 'http://localhost:5000',
+ *   publishableKey: 'pk-Abc123-def456-GHI78'
+ * });
+ *
+ * // Authentication operations
+ * await client.auth.signUp({ email: 'user@example.com', password: 'password' });
+ *
+ * // GraphQL operations
+ * const activeUsers = await client.User
+ *   .select(['id', 'name', 'email'])
+ *   .where({ isActive: true })
+ *   .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.
+     */
+    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
+        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
+export default RayfinClient;
+//# sourceMappingURL=client.js.map

package/dist/experimental/ExtendableRayfinClient.d.ts

@@ -0,0 +1,29 @@
+import { ServicePlugin, TServiceClasses, ServicePluginFactory } from '@microsoft/rayfin-lib';
+import RayfinClient, { RayfinClientConfig } from '../client';
+export { ServicePlugin, type TServiceClasses, type ServicePluginFactory as ServicePluginClass, };
+/**
+ * (Experimental) Extendable Rayfin Client supports adding custom services. Use `ExtendableRayfinClient.create` to instantiate.
+ * @alpha
+ * @hidden
+ */
+export declare class ExtendableRayfinClient<TSchema extends Record<string, any> = Record<string, any>, TServices extends Record<string, ServicePlugin> = Record<string, ServicePlugin>> extends RayfinClient<TSchema> {
+    private services;
+    protected constructor(config: RayfinClientConfig & {
+        services?: TServiceClasses<TServices>;
+    });
+    private createProxy;
+    /**
+     * (Experimental) Create an instance of ExtendableRayfinClient with custom services.
+     * @alpha
+     * @hidden
+     * @param config - The configuration for the Rayfin client.
+     * @param services - The custom services to extend the client with.
+     * @returns An instance of ExtendableRayfinClient with the specified services.
+     */
+    static create<TSchema extends Record<string, any>, TServices extends Record<string, ServicePlugin>>(config: RayfinClientConfig & {
+        schema?: TSchema;
+    } & {
+        services?: TServiceClasses<TServices>;
+    }): ExtendableRayfinClient<TSchema, TServices> & TServices;
+}
+//# sourceMappingURL=ExtendableRayfinClient.d.ts.map

package/dist/experimental/ExtendableRayfinClient.js

@@ -0,0 +1,67 @@
+import { ServicePlugin, } from '@microsoft/rayfin-lib';
+import RayfinClient from '../client';
+export { ServicePlugin, };
+/**
+ * (Experimental) Extendable Rayfin Client supports adding custom services. Use `ExtendableRayfinClient.create` to instantiate.
+ * @alpha
+ * @hidden
+ */
+export class ExtendableRayfinClient extends RayfinClient {
+    services = {};
+    constructor(config) {
+        super(config);
+        const services = config.services || {};
+        this.services = Object.keys(services).reduce((acc, key) => {
+            acc[key] = services[key](this.apiClient);
+            return acc;
+        }, {});
+        return this.createProxy();
+    }
+    // Prioritize the client and then go to the services proxy
+    createProxy() {
+        return new Proxy(this, {
+            get: (target, prop) => {
+                if (prop in target) {
+                    return target[prop];
+                }
+                if (target.services[prop]) {
+                    return target.services[prop];
+                }
+                return undefined;
+            },
+            has: (target, prop) => {
+                if (prop in target) {
+                    return true;
+                }
+                if (target.services[prop]) {
+                    return true;
+                }
+                return false;
+            },
+            ownKeys: () => {
+                return Object.keys(this.services);
+            },
+            getOwnPropertyDescriptor: (target, prop) => {
+                if (prop in target) {
+                    return Object.getOwnPropertyDescriptor(target, prop);
+                }
+                if (target.services[prop]) {
+                    return Object.getOwnPropertyDescriptor(target.services, prop);
+                }
+                return undefined;
+            },
+        });
+    }
+    /**
+     * (Experimental) Create an instance of ExtendableRayfinClient with custom services.
+     * @alpha
+     * @hidden
+     * @param config - The configuration for the Rayfin client.
+     * @param services - The custom services to extend the client with.
+     * @returns An instance of ExtendableRayfinClient with the specified services.
+     */
+    static create(config) {
+        return new ExtendableRayfinClient(config);
+    }
+}
+//# sourceMappingURL=ExtendableRayfinClient.js.map

package/dist/experimental/index.d.ts

@@ -0,0 +1,3 @@
+export { ExtendableRayfinClient, ServicePlugin, } from './ExtendableRayfinClient';
+export type { TServiceClasses, ServicePluginClass, } from './ExtendableRayfinClient';
+//# sourceMappingURL=index.d.ts.map

package/dist/experimental/index.js

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

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,4 @@
+// Export all from client.ts
+export * from './client';
+export { default } from './client';
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@microsoft/rayfin-client",
+  "version": "1.20.0",
+  "description": "Main client SDK for Rayfin services",
+  "type": "module",
+  "exports": {
+    ".": {
+      "default": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./experimental": {
+      "default": "./dist/experimental/index.js",
+      "types": "./dist/experimental/index.d.ts"
+    }
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "!dist/**/__tests__/**",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@microsoft/rayfin-auth": "1.20.0",
+    "@microsoft/rayfin-lib": "1.20.0",
+    "@microsoft/rayfin-data": "1.20.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.3",
+    "@vitest/coverage-v8": "~3.2.4",
+    "jsdom": "^24.1.0",
+    "rimraf": "~6.0.1"
+  },
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com",
+    "access": "restricted"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/project-rayfin.git",
+    "directory": "packages/typescript-sdk/client"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "clean": "rimraf dist && rimraf .tsbuildinfo"
+  }
+}