@quatrain/cloudwrapper-supabase 1.1.36 → 1.2.2

package/dist/SupabaseCloudWrapper.d.ts

@@ -12,17 +12,33 @@ export declare const eventMap: {
     update: string;
     delete: string;
 };
+/**
+ * Concrete implementation adapting Supabase realtime channels and functions.
+ */
 export declare class SupabaseCloudWrapper extends AbstractCloudWrapper {
     protected _supabaseClient: SupabaseClient | undefined;
     protected _isInitialized: boolean;
     protected _heartbeatOkReceived: boolean;
     protected _connectionTimeout: NodeJS.Timeout | undefined;
     constructor(params: SupabaseParams);
+    /**
+     * Binds a PostgreSQL Realtime subscription to track CRUD events on tables.
+     *
+     * @param trigger - Configuration defining the targeted table, event, and callback script.
+     * @returns Event subscription payload params.
+     * @throws {TypeError} If script or client is improperly configured.
+     */
     databaseTrigger(trigger: DatabaseTriggerType): void | {
         event: any;
         schema: string;
         table: string;
     };
+    /**
+     * Binds a Storage object modification realtime subscription.
+     *
+     * @param trigger - Configuration specifying file bucket logic constraints.
+     * @returns Event subscription payload params.
+     */
     storageTrigger(trigger: StorageTriggerType): void | {
         event: any;
         schema: string;

package/dist/SupabaseCloudWrapper.js

@@ -33,6 +33,9 @@ exports.eventMap = {
     [backend_1.BackendAction.UPDATE]: 'UPDATE',
     [backend_1.BackendAction.DELETE]: 'DELETE',
 };
+/**
+ * Concrete implementation adapting Supabase realtime channels and functions.
+ */
 class SupabaseCloudWrapper extends cloudwrapper_1.AbstractCloudWrapper {
     constructor(params) {
         super(params);
@@ -40,6 +43,13 @@ class SupabaseCloudWrapper extends cloudwrapper_1.AbstractCloudWrapper {
         this._heartbeatOkReceived = false;
         this._initialize();
     }
+    /**
+     * Binds a PostgreSQL Realtime subscription to track CRUD events on tables.
+     *
+     * @param trigger - Configuration defining the targeted table, event, and callback script.
+     * @returns Event subscription payload params.
+     * @throws {TypeError} If script or client is improperly configured.
+     */
     databaseTrigger(trigger) {
         var _a;
         this._initialize();
@@ -81,6 +91,12 @@ class SupabaseCloudWrapper extends cloudwrapper_1.AbstractCloudWrapper {
             throw new Error(`Realtime channel subscription failed`);
         }
     }
+    /**
+     * Binds a Storage object modification realtime subscription.
+     *
+     * @param trigger - Configuration specifying file bucket logic constraints.
+     * @returns Event subscription payload params.
+     */
     storageTrigger(trigger) {
         var _a;
         this._initialize();

package/dist/SupabaseCloudWrapper.test.js

@@ -113,8 +113,7 @@ describe('SupabaseCloudWrapper', () => {
             expect(wrapper._connectionTimeout).toBe(initialTimeout);
         });
         it('should handle "timeout" status', () => {
-            // Should not throw or exit
-            expect(() => heartbeatCallback('timeout')).not.toThrow();
+            expect(() => heartbeatCallback('timeout')).toThrow('process.exit called');
         });
         it('should reconnect on "disconnected" when exitOnDisconnect is false', () => {
             wrapper = new SupabaseCloudWrapper_1.SupabaseCloudWrapper({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quatrain/cloudwrapper-supabase",
-  "version": "1.1.36",
+  "version": "1.2.2",
   "license": "AGPL-3.0-only",
   "description": "Cloud Wrapper adapter for Supabase",
   "repository": {
@@ -20,13 +20,13 @@
   ],
   "author": "Quatrain Développement SAS <developers@quatrain.com>",
   "peerDependencies": {
-    "@quatrain/core": "^1.1.51"
+    "@quatrain/core": "^1.2.8"
   },
   "dependencies": {
-    "@quatrain/backend": "^1.1.37",
-    "@quatrain/cloudwrapper": "^1.1.27",
-    "@quatrain/core": "^1.1.51",
-    "@quatrain/storage": "^1.1.33",
+    "@quatrain/backend": "^1.2.7",
+    "@quatrain/cloudwrapper": "^1.2.1",
+    "@quatrain/core": "^1.2.8",
+    "@quatrain/storage": "^1.2.8",
     "@supabase/supabase-js": "^2.87.3",
     "ws": "^8.18.3"
   },
@@ -48,5 +48,8 @@
     "build": "tsc",
     "wbuild": "tsc --watch",
     "bump-to": "yarn version"
+  },
+  "typedoc": {
+    "entryPoint": "src/index.ts"
   }
 }

package/src/SupabaseCloudWrapper.test.ts

@@ -132,8 +132,7 @@ describe('SupabaseCloudWrapper', () => {
       })
 
       it('should handle "timeout" status', () => {
-         // Should not throw or exit
-         expect(() => heartbeatCallback('timeout')).not.toThrow()
+         expect(() => heartbeatCallback('timeout')).toThrow('process.exit called')
       })
 
       it('should reconnect on "disconnected" when exitOnDisconnect is false', () => {

package/src/SupabaseCloudWrapper.ts

@@ -25,6 +25,9 @@ export const eventMap = {
    [BackendAction.DELETE]: 'DELETE',
 }
 
+/**
+ * Concrete implementation adapting Supabase realtime channels and functions.
+ */
 export class SupabaseCloudWrapper extends AbstractCloudWrapper {
    protected _supabaseClient: SupabaseClient | undefined
    protected _isInitialized = false
@@ -36,6 +39,13 @@ export class SupabaseCloudWrapper extends AbstractCloudWrapper {
       this._initialize()
    }
 
+   /**
+    * Binds a PostgreSQL Realtime subscription to track CRUD events on tables.
+    * 
+    * @param trigger - Configuration defining the targeted table, event, and callback script.
+    * @returns Event subscription payload params.
+    * @throws {TypeError} If script or client is improperly configured.
+    */
    databaseTrigger(trigger: DatabaseTriggerType) {
       this._initialize()
 
@@ -95,6 +105,12 @@ export class SupabaseCloudWrapper extends AbstractCloudWrapper {
       }
    }
 
+   /**
+    * Binds a Storage object modification realtime subscription.
+    * 
+    * @param trigger - Configuration specifying file bucket logic constraints.
+    * @returns Event subscription payload params.
+    */
    storageTrigger(trigger: StorageTriggerType) {
       this._initialize()