@quatrain/cloudwrapper-supabase 1.1.20 → 1.1.21

package/README.md

@@ -1,17 +1,25 @@
 # @quatrain/cloudwrapper-supabase
 
 This package provides a Cloud Wrapper adapter for Supabase Edge Functions. It allows you to invoke serverless functions in a consistent way across different BaaS providers.
+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.
 
 ## Features
 
--  Invokes Supabase Edge Functions.
--  Consistent interface provided by `@quatrain/cloudwrapper`.
--  Works with both SaaS and self-hosted Supabase instances.
+- 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.
 
 ## Installation
 
 ```bash
+# With npm
 npm install @quatrain/cloudwrapper-supabase @supabase/supabase-js
+
+# With yarn
+yarn add @quatrain/cloudwrapper-supabase @supabase/supabase-js
 ```
 
 ## Usage
@@ -19,6 +27,28 @@ npm install @quatrain/cloudwrapper-supabase @supabase/supabase-js
 ```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,
+})
+
+// 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
+   },
+})
 ```

package/lib/SupabaseCloudWrapper.js

@@ -140,6 +140,7 @@ class SupabaseCloudWrapper extends cloudwrapper_1.AbstractCloudWrapper {
                 realtime: {
                     heartbeatIntervalMs: 5000,
                     heartbeatCallback: (status) => {
+                        console.log('status received', status);
                         switch (status) {
                             case 'ok':
                                 if (!this._heartbeatOkReceived) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quatrain/cloudwrapper-supabase",
-  "version": "1.1.20",
+  "version": "1.1.21",
   "license": "MIT",
   "description": "Cloud Wrapper adapter for Supabase",
   "repository": {

package/src/SupabaseCloudWrapper.ts

@@ -192,6 +192,7 @@ export class SupabaseCloudWrapper extends AbstractCloudWrapper {
                realtime: {
                   heartbeatIntervalMs: 5000,
                   heartbeatCallback: (status: HeartbeatStatus) => {
+                     console.log('status received', status)
                      switch (status) {
                         case 'ok':
                            if (!this._heartbeatOkReceived) {