@microsoft/rayfin-client 1.36.0-alpha.1818 → 1.36.0-alpha.1917

package/README.md

@@ -1,5 +1,8 @@
 # @microsoft/rayfin-client
 
+The main client SDK for interacting with Rayfin services.
+This package provides a unified interface to access all Rayfin platform capabilities.
+
 ## Getting started
 
 ```bash
@@ -8,16 +11,155 @@ npm create @microsoft/rayfin@latest
 
 For more details, [visit our docs](https://aka.ms/rayfin/docs).
 
+## Overview
+
+The `@microsoft/rayfin-client` package serves as the primary entry point for applications using the Rayfin platform.
+It integrates and orchestrates the various Rayfin modules:
+
+- Authentication and user management via `@microsoft/rayfin-auth`
+- Data API Builder (DAB) integration via `@microsoft/rayfin-core`
+- Database access patterns via `@microsoft/rayfin-data`
+
+## Installation
+
+```bash
+npm install @microsoft/rayfin-client
+```
+
+## Basic Usage
+
+```typescript
+import { RayfinClient } from '@microsoft/rayfin-client';
+
+// Initialize the client
+const client = new RayfinClient({
+  baseUrl: 'https://api.rayfin.io',
+  publishableKey: 'pk-your-key',
+  headers: {
+    'X-API-Version': '1.0',
+  },
+  timeout: 30000, // 30 seconds
+});
+
+// Authentication
+try {
+  const result = await client.auth.signUpUser({
+    email: 'user@example.com',
+    password: 'SecurePassword123!',
+  });
+
+  console.log('User registered successfully:', result);
+} catch (error) {
+  if (error instanceof RayfinClient.errors.AuthError) {
+    console.error('Authentication error:', error.message, error.code);
+  } else {
+    console.error('Unexpected error:', error);
+  }
+}
+```
+
+## Architecture
+
+The Rayfin client follows a modular architecture, providing access to specialized service modules:
+
+- **auth**: Authentication and user management
+- **data**: Database and entity operations with REST and GraphQL interfaces
+
+Each module is built to be lightweight and focused on its specific domain.
+
+## Advanced Usage
+
+### Error Handling
+
+The client provides standardized error types for consistent error handling:
+
+```typescript
+import RayfinClient, { AuthError } from '@microsoft/rayfin-client';
+
+try {
+  // Client operations
+} catch (error) {
+  if (error instanceof RayfinClient.errors.AuthError) {
+    // Handle authentication errors
+  } else if (error instanceof RayfinClient.errors.NetworkError) {
+    // Handle network errors
+  } else if (error instanceof RayfinClient.errors.SdkError) {
+    // Handle general SDK errors
+  } else {
+    // Handle other errors
+  }
+}
+```
+
+### Custom Configuration
+
+You can customize the client's behavior with various configuration options:
+
+```typescript
+const client = new RayfinClient({
+  baseUrl: 'https://api.rayfin.io',
+  publishableKey: 'pk-your-key',
+  headers: {
+    'X-Custom-Header': 'value',
+  },
+  timeout: 60000, // 60 seconds
+});
+```
+
+### Service Integration
+
+The client is designed to integrate seamlessly with your application services:
+
+```typescript
+class ProductService {
+  private client: RayfinClient;
+
+  constructor(client: RayfinClient) {
+    this.client = client;
+  }
+
+  async getProducts(category?: string) {
+    // Use client.data for database operations
+    // return await this.client.data.Product.findMany();
+  }
+}
+
+// Create client and service
+const client = new RayfinClient({
+  baseUrl: 'https://api.rayfin.io',
+  publishableKey: 'pk-your-key',
+});
+const productService = new ProductService(client);
+```
+
+## TypeScript Support
+
+The Rayfin client is built with TypeScript and provides comprehensive type definitions for all APIs and models.
+
+## Compatibility
+
+- Node.js 16+
+- Browsers (ES2020+)
+- TypeScript 5.8+
+
+## Related Packages
+
+- [@microsoft/rayfin-auth](../auth): Authentication and user management
+- [@microsoft/rayfin-lib](../lib): Core utilities and HTTP client
+- [@microsoft/rayfin-core](../core): Data API Builder integration
+- [@microsoft/rayfin-data](../data): Data access patterns
+
+## Contributing
+
+Please see the Project Rayfin [contributing guide](https://github.com/microsoft/project-rayfin/blob/main/CONTRIBUTING.md).
+
 ## Security
 
-Microsoft takes the security of our software products and services seriously, which
-includes all source code repositories in our GitHub organizations.
+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).
+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
 
@@ -30,22 +172,11 @@ Any use of third-party trademarks or logos is subject to those third parties' po
 
 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.
+[MIT License](https://github.com/microsoft/project-rayfin/blob/main/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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@microsoft/rayfin-client",
   "sideEffects": false,
-  "version": "1.36.0-alpha.1818",
+  "version": "1.36.0-alpha.1917",
   "description": "Main client SDK for Rayfin services",
   "type": "module",
   "exports": {
@@ -23,11 +23,11 @@
     "assets/docs"
   ],
   "dependencies": {
-    "@microsoft/rayfin-auth": "1.36.0-alpha.1818",
-    "@microsoft/rayfin-connectors": "1.36.0-alpha.1818",
-    "@microsoft/rayfin-functions": "1.36.0-alpha.1818",
-    "@microsoft/rayfin-data": "1.36.0-alpha.1818",
-    "@microsoft/rayfin-lib": "1.36.0-alpha.1818"
+    "@microsoft/rayfin-connectors": "1.36.0-alpha.1917",
+    "@microsoft/rayfin-auth": "1.36.0-alpha.1917",
+    "@microsoft/rayfin-data": "1.36.0-alpha.1917",
+    "@microsoft/rayfin-lib": "1.36.0-alpha.1917",
+    "@microsoft/rayfin-functions": "1.36.0-alpha.1917"
   },
   "devDependencies": {
     "typescript": "^5.8.3",