@ofload/graphql-mongodb-subscriptions 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Matthew Wheatley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,155 @@
+# graphql-mongodb-subscriptions
+
+This repository was bootstrapped by cloning [graphql-redis-subscriptions](https://github.com/davidyaha/graphql-redis-subscriptions) and also referenced the [graphql-postgres-subscriptions](https://github.com/GraphQLCollege/graphql-postgres-subscriptions).
+
+This package implements the PubSubEngine Interface from the [graphql-subscriptions](https://github.com/apollographql/graphql-subscriptions) package and also the new AsyncIterator interface. 
+It allows you to connect your subscriptions manager to a MongoDB Pub Sub mechanism to support 
+multiple subscription manager instances.
+
+## Installation
+At first, install the `graphql-mongodb-subscriptions` package: 
+```
+npm install graphql-mongodb-subscriptions
+```
+
+As the [graphql-subscriptions](https://github.com/apollographql/graphql-subscriptions) package is declared as a peer dependency, you might receive warning about an unmet peer dependency if it's not installed already by one of your other packages. In that case you also need to install it too:
+```
+npm install graphql-subscriptions
+```
+   
+## Using as AsyncIterator
+
+Define your GraphQL schema with a `Subscription` type:
+
+```graphql
+schema {
+  query: Query
+  mutation: Mutation
+  subscription: Subscription
+}
+
+type Subscription {
+    somethingChanged: Result
+}
+
+type Result {
+    id: String
+}
+```
+
+Now, let's create a simple `MongodbPubSub` instance:
+
+```javascript
+import { MongodbPubSub } from 'graphql-mongodb-subscriptions';
+const pubsub = new MongodbPubSub();
+```
+
+Now, implement your Subscriptions type resolver, using the `pubsub.asyncIterator` to map the event you need:
+
+```javascript
+const SOMETHING_CHANGED_TOPIC = 'something_changed';
+
+export const resolvers = {
+  Subscription: {
+    somethingChanged: {
+      subscribe: () => pubsub.asyncIterator(SOMETHING_CHANGED_TOPIC),
+    },
+  },
+}
+```
+
+> Subscriptions resolvers are not a function, but an object with `subscribe` method, that returns `AsyncIterable`.
+
+Calling the method `asyncIterator` of the `MongodbPubSub` instance will send MongoDB a `SUBSCRIBE` message to the topic provided and will return an `AsyncIterator` binded to the MongodbPubSub instance and listens to any event published on that topic.
+Now, the GraphQL engine knows that `somethingChanged` is a subscription, and every time we will use `pubsub.publish` over this topic, the `MongodbPubSub` will `PUBLISH` the event over MongoDB to all subscribed instances and those in their turn will emit the event to GraphQL using the `next` callback given by the GraphQL engine.
+
+```js
+pubsub.publish(SOMETHING_CHANGED_TOPIC, { somethingChanged: { id: "123" }});
+```
+
+## Dynamically create a topic based on subscription args passed on the query
+
+```javascript
+export const resolvers = {
+  Subscription: {
+    somethingChanged: {
+      subscribe: (_, args) => pubsub.asyncIterator(`${SOMETHING_CHANGED_TOPIC}.${args.relevantId}`),
+    },
+  },
+}
+```
+
+## Using both arguments and payload to filter events
+
+```javascript
+import { withFilter } from 'graphql-subscriptions';
+
+export const resolvers = {
+  Subscription: {
+    somethingChanged: {
+      subscribe: withFilter(
+        (_, args) => pubsub.asyncIterator(`${SOMETHING_CHANGED_TOPIC}.${args.relevantId}`),
+        (payload, variables) => payload.somethingChanged.id === variables.relevantId,
+      ),
+    },
+  },
+}
+```
+
+## Configuring MongodbPubSub
+
+`MongodbPubSub` constructor can be passed a configuration object to enable some advanced features. 
+
+`MongoPubSubChannelOptions` are used to change the default options for the capped collection that will be created. [View MongoDB capped collection docs](https://www.mongodb.com/docs/manual/core/capped-collections/)
+
+```ts
+export type CommonMessageHandler = (message: any) => any;
+
+export interface MongoPubSubChannelOptions {
+  size: number;
+  max: number;
+}
+
+export interface PubSubMongoDbOptions {
+  connectionDb: Db;
+  channelName?: string;
+  channelOptions?: MongoPubSubChannelOptions;
+  connectionListener?: (event: string, data: any) => void;
+  commonMessageHandler?: CommonMessageHandler;
+}
+```
+
+| option               | type       | default         | description                                                                                                       |
+|----------------------|------------|-----------------|-------------------------------------------------------------------------------------------------------------------|
+| `connectionDb`       | `Db`       | `undefined`     | pass in an instance of a Mongo DB                                                                                 |
+| `channelName`        | `string`   | `mubsub`        | The name of the capped collection to create inside the provided DB instance.                                      |
+| `channelOptions`     | `MongoPubSubChannelOptions`   | { size: 100000 } | The options are used to configure the size and constraints of the MongoDB capped collection that will be created. |
+| `connectionListener` | `function` | `undefined`     | pass in connection listener to log errors or make sure connection to the MubSub instance is actively listening.   |
+| `commonMessageHandler` | `function` | `undefined`     | The default handler just passes the message object as is.  Use this to pass in a common message handler .         |
+
+### commonMessageHandler
+
+The common message handler gets called with the received document from MongoDB.
+You can transform the message before it is passed to the individual filter/resolver methods of the subscribers.
+This way it is for example possible to inject one instance of a [DataLoader](https://github.com/facebook/dataloader) which can be used in all filter/resolver methods.
+
+```javascript
+const getDataLoader = () => new DataLoader(...)
+const commonMessageHandler = ({attributes: {id}, data}) => ({id, dataLoader: getDataLoader()})
+const pubsub = new PostgresPubSub({ client, commonMessageHandler });
+```
+
+```javascript
+export const resolvers = {
+  Subscription: {
+    somethingChanged: {
+      resolve: ({ id, dataLoader }) => dataLoader.load(id)
+    }
+  }
+};
+```
+
+### Test
+```shell script
+npm run test
+```

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { MongodbPubSub } from './mongodb-pub-sub';
+export { PubSubAsyncIterator } from './pubsub-async-iterator';
+export { withFilter } from './with-filter';

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withFilter = exports.PubSubAsyncIterator = exports.MongodbPubSub = void 0;
+var mongodb_pub_sub_1 = require("./mongodb-pub-sub");
+Object.defineProperty(exports, "MongodbPubSub", { enumerable: true, get: function () { return mongodb_pub_sub_1.MongodbPubSub; } });
+var pubsub_async_iterator_1 = require("./pubsub-async-iterator");
+Object.defineProperty(exports, "PubSubAsyncIterator", { enumerable: true, get: function () { return pubsub_async_iterator_1.PubSubAsyncIterator; } });
+var with_filter_1 = require("./with-filter");
+Object.defineProperty(exports, "withFilter", { enumerable: true, get: function () { return with_filter_1.withFilter; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qDAAkD;AAAzC,gHAAA,aAAa,OAAA;AACtB,iEAA8D;AAArD,4HAAA,mBAAmB,OAAA;AAC5B,6CAA2C;AAAlC,yGAAA,UAAU,OAAA"}

package/dist/mongodb-pub-sub.d.ts

@@ -0,0 +1,31 @@
+import { PubSubEngine } from 'graphql-subscriptions';
+import { Db } from 'mongodb';
+type OnMessage<T> = (message: T) => void;
+export type CommonMessageHandler = (message: any) => any;
+export interface MongoPubSubChannelOptions {
+    size: number;
+    max: number;
+    capped?: boolean;
+}
+export interface PubSubMongoDbOptions {
+    connectionDb: Db;
+    channelName?: string;
+    channelOptions?: MongoPubSubChannelOptions;
+    connectionListener?: (event: string, data: any) => void;
+    commonMessageHandler?: CommonMessageHandler;
+}
+export declare class MongodbPubSub implements PubSubEngine {
+    private channelName;
+    private channel;
+    private commonMessageHandler;
+    private readonly subscriptionMap;
+    private readonly subsRefsMap;
+    private currentSubscriptionId;
+    constructor(options: PubSubMongoDbOptions);
+    publish<T>(trigger: string, payload: T): Promise<void>;
+    subscribe<T = any>(trigger: string, onMessage: OnMessage<T>, options?: unknown): Promise<number>;
+    unsubscribe(subId: number): void;
+    asyncIterator<T>(triggers: string | string[], options?: unknown): AsyncIterator<T>;
+    close(): void;
+}
+export {};

package/dist/mongodb-pub-sub.js

@@ -0,0 +1,137 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MongodbPubSub = void 0;
+var pubsub_async_iterator_1 = require("./pubsub-async-iterator");
+var mongopubsub_1 = require("@mawhea/mongopubsub");
+var defaultCommonMessageHandler = function (message) {
+    console.log("MongodbPubSub.defaultCommonMessageHandler()", message);
+    return message;
+};
+var MongodbPubSub = (function () {
+    function MongodbPubSub(options) {
+        var connectionDb = options.connectionDb, channelName = options.channelName, channelOptions = options.channelOptions, connectionListener = options.connectionListener, commonMessageHandler = options.commonMessageHandler;
+        this.subscriptionMap = {};
+        this.subsRefsMap = new Map();
+        this.currentSubscriptionId = 0;
+        this.channelName = channelName;
+        this.commonMessageHandler = commonMessageHandler || defaultCommonMessageHandler;
+        this.channel = new mongopubsub_1.MubSub(__assign(__assign({ mongoDb: connectionDb }, channelOptions), { name: channelName }));
+        if (connectionListener) {
+            this.channel.on('error', function (error) {
+                connectionListener("error", error);
+            });
+            this.channel.on("ready", function (data) {
+                connectionListener("channel ready", data);
+            });
+        }
+    }
+    MongodbPubSub.prototype.publish = function (trigger, payload) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        console.log("MongodbPubSub publish()", { trigger: trigger, payload: payload });
+                        return [4, this.channel.publish({ event: trigger, message: payload })];
+                    case 1:
+                        _a.sent();
+                        return [2];
+                }
+            });
+        });
+    };
+    MongodbPubSub.prototype.subscribe = function (trigger, onMessage, options) {
+        var _this = this;
+        if (options === void 0) { options = {}; }
+        console.log("MongodbPubSub subscribe()", { trigger: trigger });
+        var triggerName = trigger;
+        var id = this.currentSubscriptionId++;
+        var callback = function (message) {
+            console.log("MongodbPubSub subscription callback[".concat(id, "]"), message);
+            onMessage(message instanceof Error
+                ? message
+                : _this.commonMessageHandler(message));
+        };
+        var subscription = this.channel.subscribe({ event: triggerName, callback: callback });
+        console.log("subscription[".concat(id, "]"), "trigger[".concat(triggerName, "]"));
+        this.subscriptionMap[id] = [triggerName, subscription];
+        if (!this.subsRefsMap.has(triggerName)) {
+            this.subsRefsMap.set(triggerName, new Set());
+        }
+        var refs = this.subsRefsMap.get(triggerName);
+        refs.add(id);
+        return Promise.resolve(id);
+    };
+    MongodbPubSub.prototype.unsubscribe = function (subId) {
+        console.log("MongodbPubSub.unsubscribe()", "subId[".concat(subId, "]"));
+        console.log("MongodbPubSub subscriptionMap", this.subscriptionMap);
+        var _a = this.subscriptionMap[subId] || [], _b = _a[0], triggerName = _b === void 0 ? null : _b, subscription = _a[1];
+        var refs = this.subsRefsMap.get(triggerName);
+        if (!subscription) {
+            throw new Error("There is no subscription of id \"".concat(subId, "\""));
+        }
+        subscription.unsubscribe(triggerName);
+        if (refs.size === 1) {
+            this.subsRefsMap.delete(triggerName);
+        }
+        else {
+            refs.delete(subId);
+        }
+        delete this.subscriptionMap[subId];
+    };
+    MongodbPubSub.prototype.asyncIterator = function (triggers, options) {
+        return new pubsub_async_iterator_1.PubSubAsyncIterator(this, triggers, options);
+    };
+    MongodbPubSub.prototype.close = function () {
+        this.channel.close();
+    };
+    return MongodbPubSub;
+}());
+exports.MongodbPubSub = MongodbPubSub;
+//# sourceMappingURL=mongodb-pub-sub.js.map

package/dist/mongodb-pub-sub.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongodb-pub-sub.js","sourceRoot":"","sources":["../src/mongodb-pub-sub.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,iEAA8D;AAC9D,mDAA6C;AAqB7C,IAAM,2BAA2B,GAAyB,UAAC,OAAY;IACrE,OAAO,CAAC,GAAG,CAAC,6CAA6C,EAAE,OAAO,CAAC,CAAC;IACpE,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF;IASE,uBAAY,OAA6B;QAErC,IAAA,YAAY,GAKV,OAAO,aALG,EACZ,WAAW,GAIT,OAAO,YAJE,EACX,cAAc,GAGZ,OAAO,eAHK,EACd,kBAAkB,GAEhB,OAAO,mBAFS,EAClB,oBAAoB,GAClB,OAAO,qBADW,CACV;QACZ,IAAI,CAAC,eAAe,GAAG,EAAE,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAuB,CAAC;QAClD,IAAI,CAAC,qBAAqB,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,IAAI,2BAA2B,CAAC;QAIhF,IAAI,CAAC,OAAO,GAAG,IAAI,oBAAM,qBAAG,OAAO,EAAE,YAAY,IAAK,cAAc,KAAE,IAAI,EAAE,WAAW,IAAG,CAAC;QAC3F,IAAI,kBAAkB,EAAE;YACtB,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,UAAC,KAAU;gBAClC,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,UAAC,IAAI;gBAC5B,kBAAkB,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAEY,+BAAO,GAApB,UAAwB,OAAe,EAAE,OAAU;;;;;wBACjD,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,EAAE,OAAO,SAAA,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC;wBAC7D,WAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,EAAA;;wBAAhE,SAAgE,CAAC;;;;;KAClE;IAEM,iCAAS,GAAhB,UACE,OAAe,EACf,SAAuB,EACvB,OAAqB;QAHvB,iBA4BC;QAzBC,wBAAA,EAAA,YAAqB;QAErB,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC;QACtD,IAAM,WAAW,GAAW,OAAO,CAAC;QACpC,IAAM,EAAE,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACxC,IAAM,QAAQ,GAAG,UAAC,OAAO;YACvB,OAAO,CAAC,GAAG,CAAC,8CAAuC,EAAE,MAAG,EAAE,OAAO,CAAC,CAAC;YACnE,SAAS,CACP,OAAO,YAAY,KAAK;gBACtB,CAAC,CAAC,OAAO;gBACT,CAAC,CAAC,KAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CACvC,CAAC;QACJ,CAAC,CAAC;QACF,IAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,UAAA,EAAE,CAAC,CAAC;QAC9E,OAAO,CAAC,GAAG,CAAC,uBAAgB,EAAE,MAAG,EAAE,kBAAW,WAAW,MAAG,CAAC,CAAC;QAE9D,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QAEvD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;YACtC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;SAC9C;QAED,IAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC/C,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACb,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAEM,mCAAW,GAAlB,UAAmB,KAAa;QAC9B,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,gBAAS,KAAK,MAAG,CAAC,CAAC;QAC9D,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7D,IAAA,KAAqC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,EAArE,UAAkB,EAAlB,WAAW,mBAAG,IAAI,KAAA,EAAE,YAAY,QAAqC,CAAC;QAC7E,IAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAE/C,IAAI,CAAC,YAAY,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,2CAAmC,KAAK,OAAG,CAAC,CAAC;SAC9D;QAED,YAAY,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QAEtC,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE;YACnB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;SACtC;aAAM;YACL,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SACpB;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAEM,qCAAa,GAApB,UAAwB,QAA2B,EAAE,OAAiB;QACpE,OAAO,IAAI,2CAAmB,CAAI,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAEM,6BAAK,GAAZ;QACE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;IACH,oBAAC;AAAD,CAAC,AAlGD,IAkGC;AAlGY,sCAAa"}

package/dist/pubsub-async-iterator.d.ts

@@ -0,0 +1,23 @@
+import { PubSubEngine } from 'graphql-subscriptions';
+export declare class PubSubAsyncIterator<T> implements AsyncIterableIterator<T> {
+    constructor(pubsub: PubSubEngine, eventNames: string | string[], options?: unknown);
+    next(): Promise<IteratorResult<any, any>>;
+    return(): Promise<{
+        value: unknown;
+        done: true;
+    }>;
+    throw(error: any): Promise<never>;
+    [Symbol.asyncIterator](): this;
+    private pullQueue;
+    private pushQueue;
+    private eventsArray;
+    private subscriptionIds;
+    private listening;
+    private pubsub;
+    private options;
+    private pushValue;
+    private pullValue;
+    private emptyQueue;
+    private subscribeAll;
+    private unsubscribeAll;
+}

package/dist/pubsub-async-iterator.js

@@ -0,0 +1,157 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PubSubAsyncIterator = void 0;
+var PubSubAsyncIterator = (function () {
+    function PubSubAsyncIterator(pubsub, eventNames, options) {
+        this.pubsub = pubsub;
+        this.options = options;
+        this.pullQueue = [];
+        this.pushQueue = [];
+        this.listening = true;
+        this.eventsArray = typeof eventNames === 'string' ? [eventNames] : eventNames;
+    }
+    PubSubAsyncIterator.prototype.next = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.subscribeAll()];
+                    case 1:
+                        _a.sent();
+                        return [2, this.listening ? this.pullValue() : this.return()];
+                }
+            });
+        });
+    };
+    PubSubAsyncIterator.prototype.return = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.emptyQueue()];
+                    case 1:
+                        _a.sent();
+                        return [2, { value: undefined, done: true }];
+                }
+            });
+        });
+    };
+    PubSubAsyncIterator.prototype.throw = function (error) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.emptyQueue()];
+                    case 1:
+                        _a.sent();
+                        return [2, Promise.reject(error)];
+                }
+            });
+        });
+    };
+    PubSubAsyncIterator.prototype[Symbol.asyncIterator] = function () {
+        return this;
+    };
+    PubSubAsyncIterator.prototype.pushValue = function (event) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.subscribeAll()];
+                    case 1:
+                        _a.sent();
+                        if (this.pullQueue.length !== 0) {
+                            this.pullQueue.shift()({ value: event, done: false });
+                        }
+                        else {
+                            this.pushQueue.push(event);
+                        }
+                        return [2];
+                }
+            });
+        });
+    };
+    PubSubAsyncIterator.prototype.pullValue = function () {
+        var _this = this;
+        return new Promise(function (resolve) {
+            if (_this.pushQueue.length !== 0) {
+                resolve({ value: _this.pushQueue.shift(), done: false });
+            }
+            else {
+                _this.pullQueue.push(resolve);
+            }
+        });
+    };
+    PubSubAsyncIterator.prototype.emptyQueue = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (!this.listening) return [3, 3];
+                        this.listening = false;
+                        if (!this.subscriptionIds) return [3, 2];
+                        _a = this.unsubscribeAll;
+                        return [4, this.subscriptionIds];
+                    case 1:
+                        _a.apply(this, [_b.sent()]);
+                        _b.label = 2;
+                    case 2:
+                        this.pullQueue.forEach(function (resolve) { return resolve({ value: undefined, done: true }); });
+                        this.pullQueue.length = 0;
+                        this.pushQueue.length = 0;
+                        _b.label = 3;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
+    PubSubAsyncIterator.prototype.subscribeAll = function () {
+        var _this = this;
+        if (!this.subscriptionIds) {
+            this.subscriptionIds = Promise.all(this.eventsArray.map(function (eventName) { return _this.pubsub.subscribe(eventName, _this.pushValue.bind(_this), _this.options); }));
+        }
+        return this.subscriptionIds;
+    };
+    PubSubAsyncIterator.prototype.unsubscribeAll = function (subscriptionIds) {
+        for (var _i = 0, subscriptionIds_1 = subscriptionIds; _i < subscriptionIds_1.length; _i++) {
+            var subscriptionId = subscriptionIds_1[_i];
+            this.pubsub.unsubscribe(subscriptionId);
+        }
+    };
+    return PubSubAsyncIterator;
+}());
+exports.PubSubAsyncIterator = PubSubAsyncIterator;
+//# sourceMappingURL=pubsub-async-iterator.js.map

package/dist/pubsub-async-iterator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pubsub-async-iterator.js","sourceRoot":"","sources":["../src/pubsub-async-iterator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA;IAEE,6BAAY,MAAoB,EAAE,UAA6B,EAAE,OAAiB;QAChF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;IAChF,CAAC;IAEY,kCAAI,GAAjB;;;;4BACE,WAAM,IAAI,CAAC,YAAY,EAAE,EAAA;;wBAAzB,SAAyB,CAAC;wBAC1B,WAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,EAAC;;;;KAC1D;IAEY,oCAAM,GAAnB;;;;4BACE,WAAM,IAAI,CAAC,UAAU,EAAE,EAAA;;wBAAvB,SAAuB,CAAC;wBACxB,WAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,EAAC;;;;KACzC;IAEY,mCAAK,GAAlB,UAAmB,KAAK;;;;4BACtB,WAAM,IAAI,CAAC,UAAU,EAAE,EAAA;;wBAAvB,SAAuB,CAAC;wBACxB,WAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAC;;;;KAC9B;IAEM,8BAAC,MAAM,CAAC,aAAa,CAAC,GAA7B;QACE,OAAO,IAAI,CAAC;IACd,CAAC;IAUa,uCAAS,GAAvB,UAAwB,KAAK;;;;4BAC3B,WAAM,IAAI,CAAC,YAAY,EAAE,EAAA;;wBAAzB,SAAyB,CAAC;wBAC1B,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;4BAC/B,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;yBACvD;6BAAM;4BACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;yBAC5B;;;;;KACF;IAEO,uCAAS,GAAjB;QAAA,iBAQC;QAPC,OAAO,IAAI,OAAO,CAAC,UAAA,OAAO;YACxB,IAAI,KAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC/B,OAAO,CAAC,EAAE,KAAK,EAAE,KAAI,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;aACzD;iBAAM;gBACL,KAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aAC9B;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEa,wCAAU,GAAxB;;;;;;6BACM,IAAI,CAAC,SAAS,EAAd,cAAc;wBAChB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;6BACnB,IAAI,CAAC,eAAe,EAApB,cAAoB;wBAAE,KAAA,IAAI,CAAC,cAAc,CAAA;wBAAC,WAAM,IAAI,CAAC,eAAe,EAAA;;wBAA9C,SAAA,IAAI,GAAgB,SAA0B,EAAC,CAAC;;;wBAC1E,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAA,OAAO,IAAI,OAAA,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAzC,CAAyC,CAAC,CAAC;wBAC7E,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;wBAC1B,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;;;;;;KAE7B;IAEO,0CAAY,GAApB;QAAA,iBAOC;QANC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YACzB,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CACrD,UAAA,SAAS,IAAI,OAAA,KAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,KAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAI,CAAC,EAAE,KAAI,CAAC,OAAO,CAAC,EAAzE,CAAyE,CACvF,CAAC,CAAC;SACJ;QACD,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAEO,4CAAc,GAAtB,UAAuB,eAAyB;QAC9C,KAA6B,UAAe,EAAf,mCAAe,EAAf,6BAAe,EAAf,IAAe,EAAE;YAAzC,IAAM,cAAc,wBAAA;YACvB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;SACzC;IACH,CAAC;IAEH,0BAAC;AAAD,CAAC,AAlFD,IAkFC;AAlFY,kDAAmB"}

package/dist/with-filter.d.ts

@@ -0,0 +1,2 @@
+export type FilterFn = (rootValue?: any, args?: any, context?: any, info?: any) => boolean;
+export declare const withFilter: (asyncIteratorFn: () => AsyncIterableIterator<any>, filterFn: FilterFn) => (rootValue: any, args: any, context: any, info: any) => AsyncIterator<any>;

package/dist/with-filter.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withFilter = void 0;
+var withFilter = function (asyncIteratorFn, filterFn) {
+    return function (rootValue, args, context, info) {
+        var _a;
+        var asyncIterator = asyncIteratorFn();
+        var getNextPromise = function () {
+            return asyncIterator
+                .next()
+                .then(function (payload) { return Promise.all([
+                payload,
+                Promise.resolve(filterFn(payload.value, args, context, info)).catch(function () { return false; }),
+            ]); })
+                .then(function (_a) {
+                var payload = _a[0], filterResult = _a[1];
+                if (filterResult === true) {
+                    return payload;
+                }
+                return getNextPromise();
+            });
+        };
+        return _a = {
+                next: function () {
+                    return getNextPromise();
+                },
+                return: function () {
+                    return asyncIterator.return();
+                },
+                throw: function (error) {
+                    return asyncIterator.throw(error);
+                }
+            },
+            _a[Symbol.asyncIterator] = function () {
+                return this;
+            },
+            _a;
+    };
+};
+exports.withFilter = withFilter;
+//# sourceMappingURL=with-filter.js.map

package/dist/with-filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"with-filter.js","sourceRoot":"","sources":["../src/with-filter.ts"],"names":[],"mappings":";;;AAEO,IAAM,UAAU,GAAG,UAAC,eAAiD,EAAE,QAAkB;IAC9F,OAAO,UAAC,SAAc,EAAE,IAAS,EAAE,OAAY,EAAE,IAAS;;QACxD,IAAM,aAAa,GAAG,eAAe,EAAE,CAAC;QAExC,IAAM,cAAc,GAAG;YACrB,OAAO,aAAa;iBACjB,IAAI,EAAE;iBACN,IAAI,CAAC,UAAA,OAAO,IAAI,OAAA,OAAO,CAAC,GAAG,CAAC;gBAC3B,OAAO;gBACP,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,cAAM,OAAA,KAAK,EAAL,CAAK,CAAC;aACjF,CAAC,EAHe,CAGf,CAAC;iBACF,IAAI,CAAC,UAAC,EAAuB;oBAAtB,OAAO,QAAA,EAAE,YAAY,QAAA;gBAC3B,IAAI,YAAY,KAAK,IAAI,EAAE;oBACzB,OAAO,OAAO,CAAC;iBAChB;gBAGD,OAAO,cAAc,EAAE,CAAC;YAC1B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,OAAO;gBACL,IAAI;oBACF,OAAO,cAAc,EAAE,CAAC;gBAC1B,CAAC;gBACD,MAAM;oBACJ,OAAO,aAAa,CAAC,MAAM,EAAE,CAAC;gBAChC,CAAC;gBACD,KAAK,YAAC,KAAK;oBACT,OAAO,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACpC,CAAC;;YACD,GAAC,MAAM,CAAC,aAAa,IAArB;gBACE,OAAO,IAAI,CAAC;YACd,CAAC;cACK,CAAC;IACX,CAAC,CAAC;AACJ,CAAC,CAAC;AApCW,QAAA,UAAU,cAoCrB"}

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@ofload/graphql-mongodb-subscriptions",
+  "version": "1.0.0",
+  "description": "A graphql-subscriptions PubSub Engine using MongoDB",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jingp-ofload/graphql-mongodb-subscriptions"
+  },
+  "keywords": [
+    "graphql",
+    "mongodb",
+    "apollo",
+    "subscriptions"
+  ],
+  "author": "Matthew Wheatley",
+  "contributors": [
+    {
+      "name": "Matthew Wheatley",
+      "url": "https://github.com/mjwheatley"
+    },
+    {
+      "name": "David Yahalomi",
+      "url": "https://github.com/davidyaha"
+    },
+    {
+      "name": "Michał Lytek",
+      "url": "https://github.com/19majkel94"
+    }
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mjwheatley/graphql-mongodb-subscriptions.git/issues"
+  },
+  "homepage": "https://github.com/mjwheatley/graphql-mongodb-subscriptions.git",
+  "scripts": {
+    "build": "tsc -p .",
+    "test": "npm run coverage",
+    "lint": "eslint src --ext ts",
+    "watch": "tsc-watch --noClear -p ./tsconfig.json",
+    "test:tests": "jest test/mongodb-pub-sub.test.ts",
+    "test:integration": "jest test/integration-tests.test.ts",
+    "coverage": "jest --coverage test/",
+    "prepare": "npm run build",
+    "prepublish": "npm run build",
+    "prepublishOnly": "npm run test"
+  },
+  "dependencies": {
+    "@mawhea/mongopubsub": "1.0.0"
+  },
+  "peerDependencies": {
+    "graphql-subscriptions": "^1.0.0 || ^2.0.0",
+    "mongodb": "^5.3.0"
+  },
+  "devDependencies": {
+    "@types/graphql": "^14.5.0",
+    "@types/jest": "^29.5.1",
+    "@types/node": "16.11.7",
+    "@typescript-eslint/eslint-plugin": "^5.36.0",
+    "@typescript-eslint/parser": "^5.36.0",
+    "eslint": "8.22.0",
+    "graphql": "^15.7.2",
+    "graphql-subscriptions": "^2.0.0",
+    "mongoose": "^7.1.0",
+    "mongopubsub": "^1.0.0",
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.1",
+    "tsc-watch": "^4.4.0",
+    "typescript": "^4.8.2"
+  },
+  "typings": "dist/index.d.ts",
+  "typescript": {
+    "definition": "dist/index.d.ts"
+  },
+  "files": [
+    "dist/"
+  ]
+}