graphql-pg-subscriptions 3.0.0 → 3.1.0

package/README.md

@@ -43,8 +43,12 @@ const client = new Client({
     password: 'secretpassword',
     port: 3211,
 });
+
 client.connect();
-const pubsub = new PostgresPubSub({ client });
+
+const pubsub = new PostgresPubSub({ client, maxListeners: 15 });
+
+//You can increase max event listeners if you need, default is 15
 ```
 
 **Important**: Don't pass clients from `pg`'s `Pool` to `PostgresPubSub`. As [node-postgres creator states in this StackOverflow answer](https://stackoverflow.com/questions/8484404/what-is-the-proper-way-to-use-the-node-js-postgresql-module), the client needs to be around and not shared so pg can properly handle `NOTIFY` messages (which this library uses under the hood)

package/dist/cjs/index.d.ts

@@ -0,0 +1,2 @@
+import { PostgresPubSub } from "./pubsub/postgres-pubsub";
+export { PostgresPubSub };

package/dist/cjs/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostgresPubSub = void 0;
+const postgres_pubsub_1 = require("./pubsub/postgres-pubsub");
+Object.defineProperty(exports, "PostgresPubSub", { enumerable: true, get: function () { return postgres_pubsub_1.PostgresPubSub; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,8DAA0D;AAEjD,+FAFA,gCAAc,OAEA"}

package/dist/cjs/pubsub/event-emitter-to-async-iterator.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" />
+import { $$asyncIterator } from "iterall";
+import { EventEmitter } from "events";
+type MessageHandler<T> = (message: T) => any;
+declare function eventEmitterAsyncIterator<T>(eventEmitter: EventEmitter, eventsNames: string | string[], commonMessageHandler?: MessageHandler<T>): {
+    next(): Promise<IteratorResult<any, any>>;
+    return(): Promise<{
+        value: undefined;
+        done: boolean;
+    }>;
+    throw(error: any): Promise<never>;
+    [$$asyncIterator](): any;
+};
+export { eventEmitterAsyncIterator };

package/dist/cjs/pubsub/event-emitter-to-async-iterator.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.eventEmitterAsyncIterator = void 0;
+const iterall_1 = require("iterall");
+function eventEmitterAsyncIterator(eventEmitter, eventsNames, commonMessageHandler = message => message) {
+    const pullQueue = [];
+    const pushQueue = [];
+    const eventsArray = typeof eventsNames === "string" ? [eventsNames] : eventsNames;
+    let listening = true;
+    const pushValue = ({ payload: event }) => {
+        const value = commonMessageHandler(event);
+        if (pullQueue.length !== 0) {
+            pullQueue.shift()({ value, done: false });
+        }
+        else {
+            pushQueue.push(value);
+        }
+    };
+    const pullValue = () => {
+        return new Promise(resolve => {
+            if (pushQueue.length !== 0) {
+                resolve({ value: pushQueue.shift(), done: false });
+            }
+            else {
+                pullQueue.push(resolve);
+            }
+        });
+    };
+    const emptyQueue = () => {
+        if (listening) {
+            listening = false;
+            removeEventListeners();
+            pullQueue.forEach(resolve => resolve({ value: undefined, done: true }));
+            pullQueue.length = 0;
+            pushQueue.length = 0;
+        }
+    };
+    const addEventListeners = () => {
+        for (const eventName of eventsArray) {
+            eventEmitter.addListener(eventName, pushValue);
+        }
+    };
+    const removeEventListeners = () => {
+        for (const eventName of eventsArray) {
+            eventEmitter.removeListener(eventName, pushValue);
+        }
+    };
+    addEventListeners();
+    return {
+        next() {
+            return listening ? pullValue() : this.return();
+        },
+        return() {
+            emptyQueue();
+            return Promise.resolve({ value: undefined, done: true });
+        },
+        throw(error) {
+            emptyQueue();
+            return Promise.reject(error);
+        },
+        [iterall_1.$$asyncIterator]() {
+            return this;
+        }
+    };
+}
+exports.eventEmitterAsyncIterator = eventEmitterAsyncIterator;
+//# sourceMappingURL=event-emitter-to-async-iterator.js.map

package/dist/cjs/pubsub/event-emitter-to-async-iterator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-emitter-to-async-iterator.js","sourceRoot":"","sources":["../../../src/pubsub/event-emitter-to-async-iterator.ts"],"names":[],"mappings":";;;AAAA,qCAA0C;AAK1C,SAAS,yBAAyB,CAC9B,YAA0B,EAC1B,WAA8B,EAC9B,uBAA0C,OAAO,CAAC,EAAE,CAAC,OAAO;IAE5D,MAAM,SAAS,GAAgD,EAAE,CAAC;IAClE,MAAM,SAAS,GAAU,EAAE,CAAC;IAC5B,MAAM,WAAW,GAAG,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;IAClF,IAAI,SAAS,GAAG,IAAI,CAAC;IAErB,MAAM,SAAS,GAAG,CAAC,EAAE,OAAO,EAAE,KAAK,EAAkB,EAAE,EAAE;QACrD,MAAM,KAAK,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,SAAS,CAAC,KAAK,EAAG,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/C,CAAC;aAAM,CAAC;YACJ,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1B,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,GAAG,EAAE;QACnB,OAAO,IAAI,OAAO,CAAsB,OAAO,CAAC,EAAE;YAC9C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;YACvD,CAAC;iBAAM,CAAC;gBACJ,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5B,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,GAAG,EAAE;QACpB,IAAI,SAAS,EAAE,CAAC;YACZ,SAAS,GAAG,KAAK,CAAC;YAClB,oBAAoB,EAAE,CAAC;YACvB,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACxE,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;YACrB,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;QACzB,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,iBAAiB,GAAG,GAAG,EAAE;QAC3B,KAAK,MAAM,SAAS,IAAI,WAAW,EAAE,CAAC;YAClC,YAAY,CAAC,WAAW,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnD,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,oBAAoB,GAAG,GAAG,EAAE;QAC9B,KAAK,MAAM,SAAS,IAAI,WAAW,EAAE,CAAC;YAClC,YAAY,CAAC,cAAc,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACtD,CAAC;IACL,CAAC,CAAC;IAEF,iBAAiB,EAAE,CAAC;IAEpB,OAAO;QACH,IAAI;YACA,OAAO,SAAS,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACnD,CAAC;QACD,MAAM;YACF,UAAU,EAAE,CAAC;YACb,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7D,CAAC;QACD,KAAK,CAAC,KAAU;YACZ,UAAU,EAAE,CAAC;YACb,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;QACD,CAAC,yBAAe,CAAC;YACb,OAAO,IAAI,CAAC;QAChB,CAAC;KACJ,CAAC;AACN,CAAC;AAGG,8DAAyB"}

package/dist/cjs/pubsub/postgres-pubsub.d.ts

@@ -0,0 +1,20 @@
+import { PubSubEngine } from "graphql-subscriptions";
+import { Client, ClientConfig } from "pg";
+interface PostgresPubSubOptions extends ClientConfig {
+    commonMessageHandler?: (message: any) => any;
+    client?: Client;
+    maxListeners?: number;
+}
+declare class PostgresPubSub extends PubSubEngine {
+    private client;
+    private ee;
+    private subscriptions;
+    private subIdCounter;
+    private commonMessageHandler;
+    constructor(options?: PostgresPubSubOptions);
+    publish(triggerName: string, payload: any): Promise<void>;
+    subscribe(triggerName: string, onMessage: (message: any) => void): Promise<number>;
+    unsubscribe(subId: number): void;
+    asyncIterator<T>(triggers: string | string[]): AsyncIterator<T>;
+}
+export { PostgresPubSub, PostgresPubSubOptions };

package/dist/cjs/pubsub/postgres-pubsub.js

@@ -0,0 +1,62 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostgresPubSub = void 0;
+const graphql_subscriptions_1 = require("graphql-subscriptions");
+//@ts-ignore
+const pg_ipc_1 = __importDefault(require("pg-ipc"));
+const pg_1 = require("pg");
+const event_emitter_to_async_iterator_1 = require("./event-emitter-to-async-iterator");
+const defaultCommonMessageHandler = (message) => message;
+class PostgresPubSub extends graphql_subscriptions_1.PubSubEngine {
+    constructor(options = {}) {
+        const { commonMessageHandler, client, maxListeners = 15 } = options, pgOptions = __rest(options, ["commonMessageHandler", "client", "maxListeners"]);
+        super();
+        this.client = client || new pg_1.Client(pgOptions);
+        if (!client) {
+            this.client.connect();
+        }
+        this.ee = new pg_ipc_1.default(this.client);
+        this.ee.setMaxListeners(maxListeners);
+        this.subscriptions = {};
+        this.subIdCounter = 0;
+        this.commonMessageHandler = commonMessageHandler || defaultCommonMessageHandler;
+    }
+    publish(triggerName, payload) {
+        return this.ee.notify(triggerName, payload);
+    }
+    subscribe(triggerName, onMessage) {
+        const callback = (message) => {
+            onMessage(message instanceof Error
+                ? message
+                : this.commonMessageHandler(message.payload));
+        };
+        this.ee.on(triggerName, callback);
+        this.subIdCounter += 1;
+        this.subscriptions[this.subIdCounter] = [triggerName, callback];
+        return Promise.resolve(this.subIdCounter);
+    }
+    unsubscribe(subId) {
+        const [triggerName, onMessage] = this.subscriptions[subId];
+        delete this.subscriptions[subId];
+        this.ee.removeListener(triggerName, onMessage);
+    }
+    asyncIterator(triggers) {
+        return (0, event_emitter_to_async_iterator_1.eventEmitterAsyncIterator)(this.ee, triggers, this.commonMessageHandler);
+    }
+}
+exports.PostgresPubSub = PostgresPubSub;
+//# sourceMappingURL=postgres-pubsub.js.map

package/dist/cjs/pubsub/postgres-pubsub.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgres-pubsub.js","sourceRoot":"","sources":["../../../src/pubsub/postgres-pubsub.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iEAAqD;AACrD,YAAY;AACZ,oDAA2B;AAC3B,2BAA0C;AAC1C,uFAA8E;AAE9E,MAAM,2BAA2B,GAAG,CAAC,OAAY,EAAE,EAAE,CAAC,OAAO,CAAC;AAQ9D,MAAM,cAAe,SAAQ,oCAAY;IAOrC,YAAY,UAAiC,EAAE;QAC3C,MAAM,EAAE,oBAAoB,EAAE,MAAM,EAAE,YAAY,GAAG,EAAE,KAAmB,OAAO,EAArB,SAAS,UAAK,OAAO,EAA3E,kDAAiE,CAAU,CAAC;QAClF,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,IAAI,WAAM,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC;QACD,IAAI,CAAC,EAAE,GAAG,IAAI,gBAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,IAAI,2BAA2B,CAAC;IACpF,CAAC;IAED,OAAO,CAAC,WAAmB,EAAE,OAAY;QACrC,OAAO,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED,SAAS,CAAC,WAAmB,EAAE,SAAiC;QAC5D,MAAM,QAAQ,GAAG,CAAC,OAAY,EAAE,EAAE;YAC9B,SAAS,CACL,OAAO,YAAY,KAAK;gBACpB,CAAC,CAAC,OAAO;gBACT,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,CACnD,CAAC;QACN,CAAC,CAAC;QACF,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAClC,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC;QACvB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAChE,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED,WAAW,CAAC,KAAa;QACrB,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC3D,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IACnD,CAAC;IAED,aAAa,CAAI,QAA2B;QACxC,OAAO,IAAA,2DAAyB,EAC5B,IAAI,CAAC,EAAE,EACP,QAAQ,EACR,IAAI,CAAC,oBAAoB,CACrB,CAAC;IACb,CAAC;CACJ;AAEQ,wCAAc"}

package/dist/esm/index.d.ts

@@ -0,0 +1,2 @@
+import { PostgresPubSub } from "./pubsub/postgres-pubsub";
+export { PostgresPubSub };

package/dist/esm/index.js

@@ -0,0 +1,3 @@
+import { PostgresPubSub } from "./pubsub/postgres-pubsub";
+export { PostgresPubSub };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/dist/esm/pubsub/event-emitter-to-async-iterator.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" />
+import { $$asyncIterator } from "iterall";
+import { EventEmitter } from "events";
+type MessageHandler<T> = (message: T) => any;
+declare function eventEmitterAsyncIterator<T>(eventEmitter: EventEmitter, eventsNames: string | string[], commonMessageHandler?: MessageHandler<T>): {
+    next(): Promise<IteratorResult<any, any>>;
+    return(): Promise<{
+        value: undefined;
+        done: boolean;
+    }>;
+    throw(error: any): Promise<never>;
+    [$$asyncIterator](): any;
+};
+export { eventEmitterAsyncIterator };

package/{event-emitter-to-async-iterator.js → dist/esm/pubsub/event-emitter-to-async-iterator.js}

@@ -1,77 +1,64 @@
-// Based on https://github.com/apollographql/graphql-subscriptions/blob/master/src/event-emitter-to-async-iterator.ts
-const { $$asyncIterator } = require("iterall");
-const { EventEmitter } = require("events");
-
-function eventEmitterAsyncIterator(eventEmitter, eventsNames, commonMessageHandler = message => message) {
-    const pullQueue = [];
-    const pushQueue = [];
-    const eventsArray =
-        typeof eventsNames === "string" ? [eventsNames] : eventsNames;
-    let listening = true;
-
-    const pushValue = ({ payload: event }) => {
-        const value = commonMessageHandler(event);
-        if (pullQueue.length !== 0) {
-            pullQueue.shift()({ value, done: false });
-        } else {
-            pushQueue.push(value);
-        }
-    };
-
-    const pullValue = () => {
-        return new Promise(resolve => {
-            if (pushQueue.length !== 0) {
-                resolve({ value: pushQueue.shift(), done: false });
-            } else {
-                pullQueue.push(resolve);
-            }
-        });
-    };
-
-    const emptyQueue = () => {
-        if (listening) {
-            listening = false;
-            removeEventListeners();
-            pullQueue.forEach(resolve => resolve({ value: undefined, done: true }));
-            pullQueue.length = 0;
-            pushQueue.length = 0;
-        }
-    };
-
-    const addEventListeners = () => {
-        for (const eventName of eventsArray) {
-            eventEmitter.addListener(eventName, pushValue);
-        }
-    };
-
-    const removeEventListeners = () => {
-        for (const eventName of eventsArray) {
-            eventEmitter.removeListener(eventName, pushValue);
-        }
-    };
-
-    addEventListeners();
-
-    return {
-        next() {
-            return listening ? pullValue() : this.return();
-        },
-        return() {
-            emptyQueue();
-
-            return Promise.resolve({ value: undefined, done: true });
-        },
-        throw(error) {
-            emptyQueue();
-
-            return Promise.reject(error);
-        },
-        [$$asyncIterator]() {
-            return this;
-        }
-    };
-}
-
-module.exports = {
-    eventEmitterAsyncIterator
-};
+import { $$asyncIterator } from "iterall";
+function eventEmitterAsyncIterator(eventEmitter, eventsNames, commonMessageHandler = message => message) {
+    const pullQueue = [];
+    const pushQueue = [];
+    const eventsArray = typeof eventsNames === "string" ? [eventsNames] : eventsNames;
+    let listening = true;
+    const pushValue = ({ payload: event }) => {
+        const value = commonMessageHandler(event);
+        if (pullQueue.length !== 0) {
+            pullQueue.shift()({ value, done: false });
+        }
+        else {
+            pushQueue.push(value);
+        }
+    };
+    const pullValue = () => {
+        return new Promise(resolve => {
+            if (pushQueue.length !== 0) {
+                resolve({ value: pushQueue.shift(), done: false });
+            }
+            else {
+                pullQueue.push(resolve);
+            }
+        });
+    };
+    const emptyQueue = () => {
+        if (listening) {
+            listening = false;
+            removeEventListeners();
+            pullQueue.forEach(resolve => resolve({ value: undefined, done: true }));
+            pullQueue.length = 0;
+            pushQueue.length = 0;
+        }
+    };
+    const addEventListeners = () => {
+        for (const eventName of eventsArray) {
+            eventEmitter.addListener(eventName, pushValue);
+        }
+    };
+    const removeEventListeners = () => {
+        for (const eventName of eventsArray) {
+            eventEmitter.removeListener(eventName, pushValue);
+        }
+    };
+    addEventListeners();
+    return {
+        next() {
+            return listening ? pullValue() : this.return();
+        },
+        return() {
+            emptyQueue();
+            return Promise.resolve({ value: undefined, done: true });
+        },
+        throw(error) {
+            emptyQueue();
+            return Promise.reject(error);
+        },
+        [$$asyncIterator]() {
+            return this;
+        }
+    };
+}
+export { eventEmitterAsyncIterator };
+//# sourceMappingURL=event-emitter-to-async-iterator.js.map

package/dist/esm/pubsub/event-emitter-to-async-iterator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-emitter-to-async-iterator.js","sourceRoot":"","sources":["../../../src/pubsub/event-emitter-to-async-iterator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAK1C,SAAS,yBAAyB,CAC9B,YAA0B,EAC1B,WAA8B,EAC9B,uBAA0C,OAAO,CAAC,EAAE,CAAC,OAAO;IAE5D,MAAM,SAAS,GAAgD,EAAE,CAAC;IAClE,MAAM,SAAS,GAAU,EAAE,CAAC;IAC5B,MAAM,WAAW,GAAG,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;IAClF,IAAI,SAAS,GAAG,IAAI,CAAC;IAErB,MAAM,SAAS,GAAG,CAAC,EAAE,OAAO,EAAE,KAAK,EAAkB,EAAE,EAAE;QACrD,MAAM,KAAK,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,SAAS,CAAC,KAAK,EAAG,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/C,CAAC;aAAM,CAAC;YACJ,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1B,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,GAAG,EAAE;QACnB,OAAO,IAAI,OAAO,CAAsB,OAAO,CAAC,EAAE;YAC9C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;YACvD,CAAC;iBAAM,CAAC;gBACJ,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5B,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,GAAG,EAAE;QACpB,IAAI,SAAS,EAAE,CAAC;YACZ,SAAS,GAAG,KAAK,CAAC;YAClB,oBAAoB,EAAE,CAAC;YACvB,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACxE,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;YACrB,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;QACzB,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,iBAAiB,GAAG,GAAG,EAAE;QAC3B,KAAK,MAAM,SAAS,IAAI,WAAW,EAAE,CAAC;YAClC,YAAY,CAAC,WAAW,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnD,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,oBAAoB,GAAG,GAAG,EAAE;QAC9B,KAAK,MAAM,SAAS,IAAI,WAAW,EAAE,CAAC;YAClC,YAAY,CAAC,cAAc,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACtD,CAAC;IACL,CAAC,CAAC;IAEF,iBAAiB,EAAE,CAAC;IAEpB,OAAO;QACH,IAAI;YACA,OAAO,SAAS,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACnD,CAAC;QACD,MAAM;YACF,UAAU,EAAE,CAAC;YACb,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7D,CAAC;QACD,KAAK,CAAC,KAAU;YACZ,UAAU,EAAE,CAAC;YACb,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;QACD,CAAC,eAAe,CAAC;YACb,OAAO,IAAI,CAAC;QAChB,CAAC;KACJ,CAAC;AACN,CAAC;AAED,OAAO,EACH,yBAAyB,EAC5B,CAAC"}

package/dist/esm/pubsub/postgres-pubsub.d.ts

@@ -0,0 +1,20 @@
+import { PubSubEngine } from "graphql-subscriptions";
+import { Client, ClientConfig } from "pg";
+interface PostgresPubSubOptions extends ClientConfig {
+    commonMessageHandler?: (message: any) => any;
+    client?: Client;
+    maxListeners?: number;
+}
+declare class PostgresPubSub extends PubSubEngine {
+    private client;
+    private ee;
+    private subscriptions;
+    private subIdCounter;
+    private commonMessageHandler;
+    constructor(options?: PostgresPubSubOptions);
+    publish(triggerName: string, payload: any): Promise<void>;
+    subscribe(triggerName: string, onMessage: (message: any) => void): Promise<number>;
+    unsubscribe(subId: number): void;
+    asyncIterator<T>(triggers: string | string[]): AsyncIterator<T>;
+}
+export { PostgresPubSub, PostgresPubSubOptions };

package/dist/esm/pubsub/postgres-pubsub.js

@@ -0,0 +1,56 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { PubSubEngine } from "graphql-subscriptions";
+//@ts-ignore
+import pgIPC from "pg-ipc";
+import { Client } from "pg";
+import { eventEmitterAsyncIterator } from "./event-emitter-to-async-iterator";
+const defaultCommonMessageHandler = (message) => message;
+class PostgresPubSub extends PubSubEngine {
+    constructor(options = {}) {
+        const { commonMessageHandler, client, maxListeners = 15 } = options, pgOptions = __rest(options, ["commonMessageHandler", "client", "maxListeners"]);
+        super();
+        this.client = client || new Client(pgOptions);
+        if (!client) {
+            this.client.connect();
+        }
+        this.ee = new pgIPC(this.client);
+        this.ee.setMaxListeners(maxListeners);
+        this.subscriptions = {};
+        this.subIdCounter = 0;
+        this.commonMessageHandler = commonMessageHandler || defaultCommonMessageHandler;
+    }
+    publish(triggerName, payload) {
+        return this.ee.notify(triggerName, payload);
+    }
+    subscribe(triggerName, onMessage) {
+        const callback = (message) => {
+            onMessage(message instanceof Error
+                ? message
+                : this.commonMessageHandler(message.payload));
+        };
+        this.ee.on(triggerName, callback);
+        this.subIdCounter += 1;
+        this.subscriptions[this.subIdCounter] = [triggerName, callback];
+        return Promise.resolve(this.subIdCounter);
+    }
+    unsubscribe(subId) {
+        const [triggerName, onMessage] = this.subscriptions[subId];
+        delete this.subscriptions[subId];
+        this.ee.removeListener(triggerName, onMessage);
+    }
+    asyncIterator(triggers) {
+        return eventEmitterAsyncIterator(this.ee, triggers, this.commonMessageHandler);
+    }
+}
+export { PostgresPubSub };
+//# sourceMappingURL=postgres-pubsub.js.map

package/dist/esm/pubsub/postgres-pubsub.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgres-pubsub.js","sourceRoot":"","sources":["../../../src/pubsub/postgres-pubsub.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,YAAY;AACZ,OAAO,KAAK,MAAM,QAAQ,CAAC;AAC3B,OAAO,EAAE,MAAM,EAAgB,MAAM,IAAI,CAAC;AAC1C,OAAO,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAC;AAE9E,MAAM,2BAA2B,GAAG,CAAC,OAAY,EAAE,EAAE,CAAC,OAAO,CAAC;AAQ9D,MAAM,cAAe,SAAQ,YAAY;IAOrC,YAAY,UAAiC,EAAE;QAC3C,MAAM,EAAE,oBAAoB,EAAE,MAAM,EAAE,YAAY,GAAG,EAAE,KAAmB,OAAO,EAArB,SAAS,UAAK,OAAO,EAA3E,kDAAiE,CAAU,CAAC;QAClF,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC;QACD,IAAI,CAAC,EAAE,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,IAAI,2BAA2B,CAAC;IACpF,CAAC;IAED,OAAO,CAAC,WAAmB,EAAE,OAAY;QACrC,OAAO,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED,SAAS,CAAC,WAAmB,EAAE,SAAiC;QAC5D,MAAM,QAAQ,GAAG,CAAC,OAAY,EAAE,EAAE;YAC9B,SAAS,CACL,OAAO,YAAY,KAAK;gBACpB,CAAC,CAAC,OAAO;gBACT,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,CACnD,CAAC;QACN,CAAC,CAAC;QACF,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAClC,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC;QACvB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAChE,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED,WAAW,CAAC,KAAa;QACrB,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC3D,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IACnD,CAAC;IAED,aAAa,CAAI,QAA2B;QACxC,OAAO,yBAAyB,CAC5B,IAAI,CAAC,EAAE,EACP,QAAQ,EACR,IAAI,CAAC,oBAAoB,CACrB,CAAC;IACb,CAAC;CACJ;AAED,OAAO,EAAE,cAAc,EAAyB,CAAC"}

package/package.json

@@ -1,8 +1,18 @@
 {
   "name": "graphql-pg-subscriptions",
-  "version": "3.0.0",
-  "description": "",
-  "main": "index.js",
+  "version": "3.1.0",
+  "description": "A graphql subscriptions implementation using postgres and apollo's graphql-subscriptions.",
+  "homepage": "https://github.com/siamahnaf/graphql-pg-subscriptions",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rimraf dist && npm run build:esm && npm run build.cjs",
+    "build:esm": "tsc",
+    "build.cjs": "tsc --module CommonJS --outDir dist/cjs"
+  },
   "author": {
     "name": "Siam Ahnaf",
     "email": "mail@siamahnaf.com",
@@ -13,9 +23,10 @@
     "pub/sub for pg",
     "pub/sub for postgreesql",
     "graphql",
-    "graphql-subscriptions"
+    "graphql-subscriptions",
+    "graphql-pg-subscriptions"
   ],
-  "license": "MIT",
+  "license": "ISC",
   "repository": {
     "type": "git",
     "directory": "https://github.com/siamahnaf/graphql-pg-subscriptions",
@@ -30,7 +41,10 @@
     "pg-ipc": "^1.0.5"
   },
   "devDependencies": {
+    "@types/node": "^20.12.12",
+    "@types/pg": "^8.11.6",
     "graphql": "^16.8.1",
-    "pg": "^8.11.5"
+    "pg": "^8.11.5",
+    "typescript": "^5.4.5"
   }
 }

package/index.d.ts

@@ -1,22 +0,0 @@
-import { Client, ClientConfig } from "pg";
-import { PubSub } from "graphql-subscriptions";
-
-interface PostgresPubSubOptions extends ClientConfig {
-    commonMessageHandler?: (...args: any) => any,
-    client?: Client,
-    maxListeners?: number;
-}
-
-export class PostgresPubSub extends PubSub {
-    constructor(config?: PostgresPubSubOptions);
-    asyncIterator(triggers: string | string[]): PubSubAsyncIterator;
-    subscribe(triggerName: string, onMessage: (...args: any) => void | Promise<void>): Promise<number>;
-    unsubscribe(subId: number): void;
-}
-
-export interface PubSubAsyncIterator {
-    next(): any | Promise<any>;
-    return(): any;
-    throw(error?: any): any;
-    [Symbol.asyncIterator](): any;
-}

package/index.js

@@ -1 +0,0 @@
-module.exports = { PostgresPubSub: require("./postgres-pubsub").PostgresPubSub };

package/postgres-pubsub.js

@@ -1,56 +0,0 @@
-const { PubSub } = require("graphql-subscriptions");
-const pgIPC = require("pg-ipc");
-const { Client } = require("pg");
-const {
-    eventEmitterAsyncIterator
-} = require("./event-emitter-to-async-iterator");
-
-const defaultCommonMessageHandler = message => message;
-
-class PostgresPubSub extends PubSub {
-    constructor(options = {}) {
-        const { commonMessageHandler, client, maxListeners = 15, ...pgOptions } = options;
-        super();
-        this.client = client || new Client(pgOptions);
-        if (!client) {
-            this.client.connect();
-        }
-        this.ee = new pgIPC(this.client);
-        this.ee.setMaxListeners(maxListeners);
-        this.subscriptions = {};
-        this.subIdCounter = 0;
-        this.commonMessageHandler =
-            commonMessageHandler || defaultCommonMessageHandler;
-    }
-    publish(triggerName, payload) {
-        this.ee.notify(triggerName, payload);
-        return true;
-    }
-    subscribe(triggerName, onMessage) {
-        const callback = message => {
-            onMessage(
-                message instanceof Error
-                    ? message
-                    : this.commonMessageHandler(message.payload)
-            );
-        };
-        this.ee.on(triggerName, callback);
-        this.subIdCounter = this.subIdCounter + 1;
-        this.subscriptions[this.subIdCounter] = [triggerName, callback];
-        return Promise.resolve(this.subIdCounter);
-    }
-    unsubscribe(subId) {
-        const [triggerName, onMessage] = this.subscriptions[subId];
-        delete this.subscriptions[subId];
-        this.ee.removeListener(triggerName, onMessage);
-    }
-    asyncIterator(triggers) {
-        return eventEmitterAsyncIterator(
-            this.ee,
-            triggers,
-            this.commonMessageHandler
-        );
-    }
-}
-
-module.exports = { PostgresPubSub };

package/postgres-pubsub.test.js

@@ -1,201 +0,0 @@
-// Adapted from https://github.com/apollographql/graphql-subscriptions/blob/master/src/test/tests.ts
-const { isAsyncIterable } = require("iterall");
-const { Client } = require("pg");
-
-const { PostgresPubSub } = require("./postgres-pubsub");
-let client;
-
-describe("PostgresPubSub", () => {
-    beforeEach(async () => {
-        client = new Client();
-        await client.connect();
-    });
-
-    test("PostgresPubSub can subscribe when instantiated without a client", function (done) {
-        const ps = new PostgresPubSub();
-        ps.subscribe("a", payload => {
-            expect(payload).toEqual("test");
-            done();
-        }).then(() => {
-            const succeed = ps.publish("a", "test");
-            expect(succeed).toBe(true);
-        });
-    });
-
-    test("PostgresPubSub can subscribe and is called when events happen", function (done) {
-        const ps = new PostgresPubSub({ client });
-        ps.subscribe("a", payload => {
-            expect(payload).toEqual("test");
-            done();
-        }).then(() => {
-            const succeed = ps.publish("a", "test");
-            expect(succeed).toBe(true);
-        });
-    });
-
-    test("PostgresPubSub can subscribe when instantiated with connection options but without a client", function (done) {
-        const ps = new PostgresPubSub({
-            connectionString: process.env.DATABASE_URL
-        });
-        ps.subscribe("a", payload => {
-            expect(payload).toEqual("test");
-            done();
-        }).then(() => {
-            const succeed = ps.publish("a", "test");
-            expect(succeed).toBe(true);
-        });
-    });
-
-    test("should send notification event after calling publish", done => {
-        const ps = new PostgresPubSub({ client });
-        client.on("notification", ({ payload }) => {
-            expect(payload).toEqual("test");
-            done();
-        });
-        ps.subscribe("a", payload => {
-            expect(payload).toEqual("test");
-        }).then(() => {
-            const succeed = ps.publish("a", "test");
-            expect(succeed).toBe(true);
-        });
-    });
-
-    test("PostgresPubSub can unsubscribe", function (done) {
-        const ps = new PostgresPubSub({ client });
-        ps.subscribe("a", payload => {
-            expect(false).toBe(true); // Should not reach this point
-        }).then(subId => {
-            ps.unsubscribe(subId);
-            const succeed = ps.publish("a", "test");
-            expect(succeed).toBe(true); // True because publish success is not
-            // indicated by trigger having subscriptions
-            done(); // works because pubsub is synchronous
-        });
-    });
-
-    test("Should emit error when payload exceeds Postgres 8000 character limit", done => {
-        const ps = new PostgresPubSub({ client });
-        ps.subscribe("a", () => {
-            expect(false).toBe(true); // Should not reach this point
-            done();
-        });
-        ps.subscribe("error", err => {
-            expect(err.message).toEqual("payload string too long");
-            done();
-        }).then(() => {
-            const succeed = ps.publish("a", "a".repeat(9000));
-            expect(succeed).toBe(true);
-        });
-    });
-
-    test("AsyncIterator should expose valid asyncIterator for a specific event", () => {
-        const eventName = "test";
-        const ps = new PostgresPubSub({ client });
-        const iterator = ps.asyncIterator(eventName);
-        expect(iterator).not.toBeUndefined();
-        expect(isAsyncIterable(iterator)).toBe(true);
-    });
-
-    test("AsyncIterator should trigger event on asyncIterator when published", done => {
-        const eventName = "test";
-        const ps = new PostgresPubSub({ client });
-        const iterator = ps.asyncIterator(eventName);
-
-        iterator.next().then(result => {
-            expect(result).not.toBeUndefined();
-            expect(result.value).not.toBeUndefined();
-            expect(result.done).not.toBeUndefined();
-            done();
-        });
-
-        ps.publish(eventName, { test: true });
-    });
-
-    test("AsyncIterator should not trigger event on asyncIterator when publishing other event", done => {
-        const eventName = "test2";
-        const ps = new PostgresPubSub({ client });
-        const iterator = ps.asyncIterator("test");
-        const spy = jest.fn();
-
-        iterator.next().then(spy);
-        ps.publish(eventName, { test: true });
-        expect(spy).not.toHaveBeenCalled();
-        done();
-    });
-
-    test("AsyncIterator should register to multiple events", done => {
-        const eventName = "test2";
-        const ps = new PostgresPubSub({ client });
-        const iterator = ps.asyncIterator(["test", "test2"]);
-        const spy = jest.fn();
-
-        iterator.next().then(() => {
-            spy();
-            expect(spy).toHaveBeenCalled();
-            done();
-        });
-        ps.publish(eventName, { test: true });
-    });
-
-    test("AsyncIterator transforms messages using commonMessageHandler", done => {
-        const eventName = "test";
-        const commonMessageHandler = message => ({ transformed: message });
-        const ps = new PostgresPubSub({ client, commonMessageHandler });
-        const iterator = ps.asyncIterator(eventName);
-
-        iterator.next().then(result => {
-            expect(result).not.toBeUndefined();
-            expect(result.value).toEqual({ transformed: { test: true } });
-            expect(result.done).toBe(false);
-            done();
-        });
-
-        ps.publish(eventName, { test: true });
-    });
-
-    test("PostgresPubSub transforms messages using commonMessageHandler", function (done) {
-        const commonMessageHandler = message => ({ transformed: message });
-        const ps = new PostgresPubSub({ client, commonMessageHandler });
-        ps.subscribe("transform", payload => {
-            expect(payload).toEqual({ transformed: { test: true } });
-            done();
-        }).then(() => {
-            const succeed = ps.publish("transform", { test: true });
-            expect(succeed).toBe(true);
-        });
-    });
-
-    // This test does not clean up after it ends. It breaks the test that follows after it.
-    // It won't break any tests if it's the last. https://imgflip.com/i/2lmlgm
-    // TODO: Fix it properly
-    test("AsyncIterator should not trigger event on asyncIterator already returned", async done => {
-        const eventName = "test";
-        const ps = new PostgresPubSub({ client });
-        const iterator = ps.asyncIterator(eventName);
-
-        const delay = ms => new Promise(resolve => setTimeout(resolve, ms));
-
-        iterator.next().then(result => {
-            expect(result).not.toBeUndefined();
-            expect(result.value).not.toBeUndefined();
-            expect(result.done).toBe(false);
-        });
-
-        ps.publish(eventName, { test: true });
-
-        await delay(0);
-
-        iterator.next().then(result => {
-            expect(result).not.toBeUndefined();
-            expect(result.value).toBeUndefined();
-            expect(result.done).toBe(true);
-            done();
-        });
-
-        await delay(0);
-
-        iterator.return();
-
-        ps.publish(eventName, { test: true });
-    });
-});