@quatrain/cloudwrapper 1.1.23 → 1.1.25

package/README.md

@@ -1,171 +1,31 @@
 # @quatrain/cloudwrapper
 
-Foundation package for cloud function wrappers. This package provides abstract base classes and type definitions for building cloud function triggers across different platforms (Firebase, Supabase, etc.).
+A comprehensive wrapper for cloud provider SDKs within the Quatrain framework.
 
-## Features
+## Introduction
 
--  Abstract base class for cloud wrapper implementations
--  Type definitions for database and storage triggers
--  Event payload types for cloud functions
--  Static logger with "Cloud" namespace
--  Platform-agnostic trigger definitions
+Instead of initializing multiple adapters (Auth, Backend, Storage) individually, `@quatrain/cloudwrapper` provides a unified entry point to initialize an entire ecosystem at once. For instance, if you are building exclusively on Firebase, the wrapper initializes Firestore, Firebase Auth, and Firebase Storage simultaneously using a single configuration object.
+
+## Key Concepts
+
+- **`CloudWrapper`**: The static registry where you define your wrapper.
+- **`AbstractCloudWrapper`**: The base class that orchestrates the initialization of backend, auth, and storage adapters.
 
 ## Installation
 
 ```bash
 npm install @quatrain/cloudwrapper
+# You will also need an adapter, e.g.:
+npm install @quatrain/cloudwrapper-firebase
 ```
 
-## Usage
-
-### Extending AbstractCloudWrapper
-
-```typescript
-import { AbstractCloudWrapper } from '@quatrain/cloudwrapper'
-
-class MyCloudWrapper extends AbstractCloudWrapper {
-   constructor(params: any) {
-      super(params)
-      // Your initialization logic
-   }
-
-   // Implement your cloud-specific methods
-}
-
-const wrapper = new MyCloudWrapper({
-   projectId: 'my-project',
-   region: 'us-central1',
-})
-```
-
-### Using CloudWrapper Logger
-
-```typescript
-import { CloudWrapper } from '@quatrain/cloudwrapper'
-
-CloudWrapper.logger.info('Cloud function initialized')
-CloudWrapper.logger.debug('Processing event...')
-CloudWrapper.logger.error('Error occurred:', error)
-```
-
-### Database Trigger Definition
-
-```typescript
-import { DatabaseTriggerType } from '@quatrain/cloudwrapper'
-import { BackendAction } from '@quatrain/backend'
-
-const userTrigger: DatabaseTriggerType = {
-   name: 'onUserCreate',
-   event: BackendAction.CREATE,
-   script: async (payload) => {
-      // Handle user creation
-      console.log('New user:', payload.after)
-   },
-   model: 'User',
-   path: '/users/{userId}',
-   schema: 'public', // Optional
-}
-```
-
-### Storage Trigger Definition
-
-```typescript
-import {
-   StorageTriggerType,
-   StorageEventPayloadType,
-} from '@quatrain/cloudwrapper'
-import { BackendAction } from '@quatrain/backend'
-
-const fileTrigger: StorageTriggerType = {
-   name: 'onFileUpload',
-   event: BackendAction.CREATE,
-   script: async (payload: StorageEventPayloadType) => {
-      const file = payload.after
-      console.log('File uploaded:', file?.fullPath)
-      console.log('Size:', file?.size, 'bytes')
-   },
-}
-```
-
-### Multiple Events
-
-```typescript
-import { DatabaseTriggerType } from '@quatrain/cloudwrapper'
-import { BackendAction } from '@quatrain/backend'
-
-const multiEventTrigger: DatabaseTriggerType = {
-   name: 'onPostChange',
-   event: [BackendAction.CREATE, BackendAction.UPDATE],
-   script: async (payload) => {
-      const before = payload.before
-      const after = payload.after
-
-      if (!before) {
-         console.log('Post created')
-      } else {
-         console.log('Post updated')
-      }
-   },
-   model: 'Post',
-   path: '/posts/{postId}',
-}
-```
-
-## Type Definitions
-
-### DatabaseTriggerType
-
-Defines triggers for database operations (create, update, delete).
-
-```typescript
-interface DatabaseTriggerType {
-   name: string
-   event: BackendAction | BackendAction[]
-   script: Function
-   model: string // Database model/table name
-   path: string // Path pattern for the trigger
-   schema?: string // Optional database schema
-}
-```
-
-### StorageTriggerType
-
-Defines triggers for storage operations (file upload, update, delete).
-
-```typescript
-interface StorageTriggerType {
-   name: string
-   event: BackendAction | BackendAction[]
-   script: Function
-}
-```
-
-### StorageEventPayloadType
-
-Payload structure for storage events.
-
-```typescript
-interface StorageEventPayloadType {
-   before: FileType | undefined // File state before event
-   after: FileType | undefined // File state after event
-   context: any // Additional context
-}
-```
-
-## Platform Adapters
-
-This package serves as the foundation. Specific implementations are available:
-
--  **[@quatrain/cloudwrapper-firebase](../cloudwrapper-firebase)** - Firebase Functions adapter
--  **[@quatrain/cloudwrapper-supabase](../cloudwrapper-supabase)** - Supabase Edge Functions adapter
+## Architecture
 
-## BackendAction Enum
+The wrapper acts as a macro. When you configure and register it, it automatically creates and registers the underlying `@quatrain/backend`, `@quatrain/storage`, and `@quatrain/auth` adapters with the respective registries.
 
-Triggers use the `BackendAction` enum from `@quatrain/backend`:
+## Documentation
 
--  `BackendAction.CREATE` - Resource creation
--  `BackendAction.UPDATE` - Resource modification
--  `BackendAction.DELETE` - Resource deletion
+For concrete examples and usage guides, please refer to the [How-To Guide](HOWTO.md).
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quatrain/cloudwrapper",
-  "version": "1.1.23",
+  "version": "1.1.25",
   "license": "AGPL-3.0-only",
   "description": "Cloud wrappers commons",
   "main": "dist/index.js",
@@ -14,8 +14,8 @@
   ],
   "author": "Quatrain Développement SAS <developers@quatrain.com>",
   "peerDependencies": {
-    "@quatrain/backend": "^1.1.34",
-    "@quatrain/core": "^1.1.48"
+    "@quatrain/backend": "^1.1.35",
+    "@quatrain/core": "^1.1.49"
   },
   "devDependencies": {
     "@tsconfig/recommended": "^1.0.1",
@@ -36,8 +36,8 @@
     "bump-to": "yarn version"
   },
   "dependencies": {
-    "@quatrain/backend": "^1.1.34",
-    "@quatrain/core": "^1.1.48",
+    "@quatrain/backend": "^1.1.35",
+    "@quatrain/core": "^1.1.49",
     "@quatrain/storage": "^1.1"
   }
 }