@quatrain/cloudwrapper-supabase 1.1.32 → 1.1.34

package/README.md

@@ -1,70 +1,47 @@
-# Supabase Cloud Wrapper Package
+# @quatrain/cloudwrapper-supabase
 
-## Introduction
+The Supabase ecosystem wrapper for `@quatrain/cloudwrapper`.
 
-This package provides a Cloud Wrapper for Supabase, enabling real-time database
-and storage triggers. It handles the WebSocket connection to Supabase's Realtime
-service, providing robust connection monitoring and configurable automatic reconnection logic.
+## Introduction
 
-## Features
+This package aggregates the initialization of:
+- `@quatrain/backend-postgres` (Supabase uses standard Postgres)
+- `@quatrain/storage-supabase`
+- `@quatrain/auth-supabase`
 
--  Listens to database changes (`INSERT`, `UPDATE`, `DELETE`) on your Supabase Postgres database.
--  Listens to storage changes in Supabase Storage.
--  Monitors connection health with a heartbeat mechanism.
--  Provides a configurable strategy for handling disconnections (exit process or attempt to reconnect).
--  Consistent interface provided by `@quatrain/cloudwrapper`.
--  Works with both SaaS and self-hosted Supabase instances.
+It provides a single configuration entry point to connect your entire Quatrain application to your Supabase project.
 
 ## Installation
 
 ```bash
-# With npm
-npm install @quatrain/cloudwrapper-supabase
-
-# With yarn
-yarn add @quatrain/cloudwrapper-supabase
+npm install @quatrain/cloudwrapper-supabase @supabase/supabase-js pg
+# or
+yarn add @quatrain/cloudwrapper-supabase @supabase/supabase-js pg
 ```
 
-## Usage
+## Configuration
+
+Initialize the wrapper using your Supabase project URL, service role key, and database connection string.
 
 ```typescript
 import { CloudWrapper } from '@quatrain/cloudwrapper'
-import { SupabaseCloudWrapperAdapter } from '@quatrain/cloudwrapper-supabase'
-import { SupabaseCloudWrapper } from '@quatrain/cloudwrapper-supabase'
-import { BackendAction } from '@quatrain/backend'
-
-// Setup and use the adapter with the CloudWrapper singleton.
-const wrapper = new SupabaseCloudWrapper({
-   url: process.env.SUPABASE_URL,
-   key: process.env.SUPABASE_KEY,
-   // Optional: Determines behavior on disconnection.
-   // - `true` (default): Exits the process. Ideal for containerized
-   //   environments (e.g., Kubernetes) that will automatically restart the service.
-   // - `false`: Attempts to reconnect internally.
-   exitOnDisconnect: true,
+import { SupabaseWrapper } from '@quatrain/cloudwrapper-supabase'
+
+const supabaseEnv = new SupabaseWrapper({
+    config: {
+        url: process.env.SUPABASE_URL,
+        key: process.env.SUPABASE_SERVICE_ROLE_KEY,
+        connectionString: process.env.SUPABASE_DB_URL
+    }
 })
 
-// Example: Set up a trigger for new rows in a 'profiles' table
-wrapper.databaseTrigger({
-   name: 'new-profile-trigger',
-   model: 'profiles',
-   event: BackendAction.CREATE,
-   script: async ({ after }) => {
-      console.log(`A new profile was created:`, after)
-      // Add your business logic here
-   },
-})
+CloudWrapper.addAdapter('supabase', supabaseEnv, true)
 ```
 
-### Callback Payload
+## Documentation
 
-The `script` callback for both `databaseTrigger` and `storageTrigger` receives
-an object with the following properties:
+For concrete examples and usage guides, please refer to the [How-To Guide](HOWTO.md).
 
--  `after`: The new state of the record after the event. For `DELETE` events, this will be an empty object.
--  `before`: The state of the record before the event. For `INSERT` events, this will be an empty object.
--  `context`: An object containing additional metadata about the event, such as
-   the schema, table, and commit timestamp provided by Supabase's Realtime service.
+## License
 
-For `storageTrigger`, the `before` and `after` properties are transformed into a
-`FileType` object, providing a standardized format for file metadata.
+AGPL-3.0-only

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quatrain/cloudwrapper-supabase",
-  "version": "1.1.32",
+  "version": "1.1.34",
   "license": "AGPL-3.0-only",
   "description": "Cloud Wrapper adapter for Supabase",
   "repository": {
@@ -19,13 +19,13 @@
   ],
   "author": "Quatrain Développement SAS <developers@quatrain.com>",
   "peerDependencies": {
-    "@quatrain/core": "^1.1.48"
+    "@quatrain/core": "^1.1.49"
   },
   "dependencies": {
-    "@quatrain/backend": "^1.1.34",
-    "@quatrain/cloudwrapper": "^1.1.23",
-    "@quatrain/core": "^1.1.48",
-    "@quatrain/storage": "^1.1.29",
+    "@quatrain/backend": "^1.1.35",
+    "@quatrain/cloudwrapper": "^1.1.25",
+    "@quatrain/core": "^1.1.49",
+    "@quatrain/storage": "^1.1.31",
     "@supabase/supabase-js": "^2.87.3",
     "ws": "^8.18.3"
   },