@quatrain/cloudwrapper-supabase 1.1.20 → 1.1.22

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.
+-  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
-npm install @quatrain/cloudwrapper-supabase @supabase/supabase-js
+# With npm
+npm install @quatrain/cloudwrapper-supabase @supabase/supabase-js ws
+
+# With yarn
+yarn add @quatrain/cloudwrapper-supabase @supabase/supabase-js ws
 ```
 
 ## 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

@@ -19,11 +19,15 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SupabaseCloudWrapper = exports.eventMap = void 0;
 const cloudwrapper_1 = require("@quatrain/cloudwrapper");
 const backend_1 = require("@quatrain/backend");
 const supabase_js_1 = require("@supabase/supabase-js");
+const ws_1 = __importDefault(require("ws"));
 exports.eventMap = {
     [backend_1.BackendAction.CREATE]: 'INSERT',
     [backend_1.BackendAction.UPDATE]: 'UPDATE',
@@ -138,6 +142,7 @@ class SupabaseCloudWrapper extends cloudwrapper_1.AbstractCloudWrapper {
             }
             this._supabaseClient = (0, supabase_js_1.createClient)(this._params.url, this._params.key, {
                 realtime: {
+                    transport: ws_1.default,
                     heartbeatIntervalMs: 5000,
                     heartbeatCallback: (status) => {
                         switch (status) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quatrain/cloudwrapper-supabase",
-  "version": "1.1.20",
+  "version": "1.1.22",
   "license": "MIT",
   "description": "Cloud Wrapper adapter for Supabase",
   "repository": {
@@ -22,12 +22,14 @@
   "dependencies": {
     "@quatrain/backend": "^1.1.22",
     "@quatrain/cloudwrapper": "^1.1.14",
-    "@supabase/supabase-js": "^2.82.0"
+    "@supabase/supabase-js": "^2.82.0",
+    "ws": "^8.18.3"
   },
   "devDependencies": {
     "@tsconfig/recommended": "^1.0.1",
     "@types/jest": "^27.0.3",
     "@types/node": "^22.10.1",
+    "@types/ws": "^8.18.1",
     "jest": "^30.1.2",
     "jest-node-exports-resolver": "^1.1.6",
     "jest-serial-runner": "^1.2.2",

package/src/SupabaseCloudWrapper.ts

@@ -12,6 +12,7 @@ import {
    RealtimeChannel,
 } from '@supabase/supabase-js'
 import { HeartbeatStatus } from '@supabase/realtime-js/dist/module/RealtimeClient'
+import ws from 'ws'
 import { FileType } from '@quatrain/storage'
 
 export type SupabaseParams = {
@@ -190,6 +191,7 @@ export class SupabaseCloudWrapper extends AbstractCloudWrapper {
             this._params.key,
             {
                realtime: {
+                  transport: ws as any,
                   heartbeatIntervalMs: 5000,
                   heartbeatCallback: (status: HeartbeatStatus) => {
                      switch (status) {