@orion-js/graphql 3.3.21 → 3.3.25

package/lib/buildSchema/getSubscriptions/index.js

@@ -10,10 +10,10 @@ async function default_1(options) {
     const fields = {};
     for (const key of Object.keys(subscriptions)) {
         const subscription = subscriptions[key];
-        subscription.key = key;
+        subscription.name = subscription.name || key;
         const type = await (0, getType_1.default)(subscription.returns, options);
         const args = await (0, getArgs_1.default)(subscription.params);
-        fields[key] = {
+        fields[subscription.name] = {
             type,
             args,
             async subscribe(root, params, viewer) {

package/lib/index.d.ts

@@ -9,3 +9,4 @@ import * as GraphQL from 'graphql';
 export { GraphQL, startGraphQL, startGraphiQL, resolversSchemas, ResolverParams, serializeSchema, subscription, getBasicResultQuery };
 export * from './types';
 export * from './service';
+export * from './websockerViewer';

package/lib/index.js

@@ -44,3 +44,4 @@ const GraphQL = __importStar(require("graphql"));
 exports.GraphQL = GraphQL;
 __exportStar(require("./types"), exports);
 __exportStar(require("./service"), exports);
+__exportStar(require("./websockerViewer"), exports);

package/lib/pubsub.d.ts

@@ -1,3 +1,3 @@
-import { PubSub } from 'graphql-subscriptions';
-export declare const setPubsub: (newPubsub: PubSub) => void;
-export declare const getPubsub: () => PubSub;
+import { PubSubEngine } from 'graphql-subscriptions';
+export declare const setPubsub: (newPubsub: PubSubEngine) => void;
+export declare const getPubsub: () => PubSubEngine;

package/lib/service/index.d.ts

@@ -1,2 +1,3 @@
 export * from './global';
 export * from './model';
+export * from './subscription';

package/lib/service/index.js

@@ -12,3 +12,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./global"), exports);
 __exportStar(require("./model"), exports);
+__exportStar(require("./subscription"), exports);

package/lib/service/subscription.d.ts

@@ -0,0 +1,6 @@
+import { OrionSubscription, OrionSubscriptionOptions } from '../types/subscription';
+export declare function Subscriptions(): ClassDecorator;
+export declare function Subscription<T = any, ReturnType = any>(options: OrionSubscriptionOptions): (object: any, propertyName: string, index?: number) => void;
+export declare function getServiceSubscriptions(target: any): {
+    [key: string]: OrionSubscription;
+};

package/lib/service/subscription.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getServiceSubscriptions = exports.Subscription = exports.Subscriptions = void 0;
+const services_1 = require("@orion-js/services");
+const helpers_1 = require("@orion-js/helpers");
+const __1 = require("..");
+function Subscriptions() {
+    return function (target) {
+        (0, services_1.Service)()(target);
+        target.prototype.service = target;
+        target.prototype.serviceType = 'subscriptions';
+    };
+}
+exports.Subscriptions = Subscriptions;
+function Subscription(options) {
+    return function (object, propertyName, index) {
+        const sub = (0, __1.subscription)({
+            name: propertyName,
+            ...options
+        });
+        object.subscriptions = object.subscriptions || {};
+        object.subscriptions[propertyName] = sub;
+        services_1.Container.registerHandler({
+            object,
+            propertyName,
+            index,
+            value: containerInstance => {
+                if (!object.serviceType || object.serviceType !== 'subscriptions') {
+                    throw new Error('You must pass a class decorated with @Subscriptions if you want to use @Subscription');
+                }
+                return sub;
+            }
+        });
+    };
+}
+exports.Subscription = Subscription;
+function getServiceSubscriptions(target) {
+    if (!target.prototype) {
+        throw new helpers_1.UserError('You must pass a class to getSubscriptions');
+    }
+    return target.prototype.subscriptions || {};
+}
+exports.getServiceSubscriptions = getServiceSubscriptions;

package/lib/service/subscription.test.d.ts

@@ -0,0 +1 @@
+import 'reflect-metadata';

package/lib/service/subscription.test.js

@@ -0,0 +1,55 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const index_1 = require("./index");
+const services_1 = require("@orion-js/services");
+const typed_model_1 = require("@orion-js/typed-model");
+describe('Subscriptions classes', () => {
+    it('should get the subscriptions using services', async () => {
+        let Params = class Params {
+        };
+        __decorate([
+            (0, typed_model_1.Prop)(),
+            __metadata("design:type", String)
+        ], Params.prototype, "name", void 0);
+        Params = __decorate([
+            (0, typed_model_1.TypedSchema)()
+        ], Params);
+        let User = class User {
+        };
+        __decorate([
+            (0, typed_model_1.Prop)(),
+            __metadata("design:type", String)
+        ], User.prototype, "name", void 0);
+        User = __decorate([
+            (0, typed_model_1.TypedSchema)()
+        ], User);
+        let ExampleSubscriptionsService = class ExampleSubscriptionsService {
+        };
+        __decorate([
+            (0, index_1.Subscription)({
+                params: Params,
+                returns: User
+            }),
+            __metadata("design:type", Object)
+        ], ExampleSubscriptionsService.prototype, "onUserCreated", void 0);
+        ExampleSubscriptionsService = __decorate([
+            (0, index_1.Subscriptions)()
+        ], ExampleSubscriptionsService);
+        const subscriptions = (0, index_1.getServiceSubscriptions)(ExampleSubscriptionsService);
+        expect(subscriptions.onUserCreated).toBeDefined();
+        const instance = (0, services_1.getInstance)(ExampleSubscriptionsService);
+        expect(instance.onUserCreated.publish).toBeDefined();
+        expect(instance.onUserCreated.name).toBe('onUserCreated');
+        // await instance.onUserCreated.publish({name: 'test'}, {name: 'test'})
+    });
+});

package/lib/startWebsocket.d.ts

@@ -1,3 +1,4 @@
+import { StartGraphQLOptions } from './types/startGraphQL';
 export default function ({ schema }: {
     schema: any;
-}, options: any): void;
+}, options: StartGraphQLOptions): void;

package/lib/startWebsocket.js

@@ -7,8 +7,9 @@ const pubsub_1 = require("./pubsub");
 const http_1 = require("@orion-js/http");
 const websockerViewer_1 = require("./websockerViewer");
 function default_1({ schema }, options) {
-    (0, pubsub_1.setPubsub)(options.pubsub || new graphql_subscriptions_1.PubSub());
-    const server = options.server || (0, http_1.getApp)();
+    const pubsub = options.pubsub || new graphql_subscriptions_1.PubSub();
+    (0, pubsub_1.setPubsub)(pubsub);
+    const server = options.app || (0, http_1.getApp)();
     if (!server) {
         throw new Error('Error starting GraphQL WebSocket. You must start http server before starting GraphQL WebSocket');
     }

package/lib/startWebsocket.test.js

@@ -114,8 +114,8 @@ const gqClient = async () => {
     // We pass customServer instead of typical configuration of a default WebSocket server
     const { apolloOptions, subscriptions } = await getStartServerOptions();
     const uri = `ws://localhost:${RANDOM_WS_PORT}`;
-    const server = new mock_socket_with_protocol_1.Server(uri);
-    (0, startWebsocket_1.default)({ schema: apolloOptions.schema }, { server });
+    const app = new mock_socket_with_protocol_1.Server(uri);
+    (0, startWebsocket_1.default)({ schema: apolloOptions.schema }, { app, resolvers: {} });
     const getConnectionParams = () => {
         return { jwt: 'hi' };
     };

package/lib/subscription/index.d.ts

@@ -1,3 +1,3 @@
-import { CreateSubscriptionFunction } from '../types/subscription';
-declare const createSubscription: CreateSubscriptionFunction;
+import { CreateOrionSubscriptionFunction } from '../types/subscription';
+declare const createSubscription: CreateOrionSubscriptionFunction;
 export default createSubscription;

package/lib/subscription/index.js

@@ -8,19 +8,19 @@ const getChannelName_1 = __importDefault(require("./getChannelName"));
 const resolvers_1 = require("@orion-js/resolvers");
 const createSubscription = function (options) {
     const subscription = {
-        key: 'notInitialized'
+        name: options.name
     };
     // the publish function
     subscription.publish = async (params, data) => {
         const pubsub = (0, pubsub_1.getPubsub)();
-        const channelName = (0, getChannelName_1.default)(subscription.key, params);
-        await pubsub.publish(channelName, { [subscription.key]: data });
+        const channelName = (0, getChannelName_1.default)(subscription.name, params);
+        await pubsub.publish(channelName, { [subscription.name]: data });
     };
     subscription.subscribe = async (params, viewer) => {
         const pubsub = (0, pubsub_1.getPubsub)();
         try {
             await (0, resolvers_1.checkPermissions)({ params, viewer }, options);
-            const channelName = (0, getChannelName_1.default)(subscription.key, params);
+            const channelName = (0, getChannelName_1.default)(subscription.name, params);
             return pubsub.asyncIterator(channelName);
         }
         catch (error) {

package/lib/types/startGraphQL.d.ts

@@ -1,7 +1,8 @@
 import { GlobalResolversMap, ModelResolversMap } from '@orion-js/models';
 import { express } from '@orion-js/http';
-import { SubscriptionMap } from './subscription';
+import { OrionSubscriptionsMap } from './subscription';
 import { GraphQLOptions } from 'apollo-server-core';
+import { PubSubEngine } from 'graphql-subscriptions';
 export declare type ExecuteGraphQLCache = (req: express.Request, res: express.Response, viewer: object, executeQuery: () => Promise<string>) => Promise<string>;
 export interface ModelsResolversMap {
     [key: string]: ModelResolversMap;
@@ -19,7 +20,7 @@ export interface StartGraphQLOptions extends Omit<GraphQLOptions, SchemaOmits> {
     /**
      * A Map with all global subscriptions
      */
-    subscriptions?: SubscriptionMap;
+    subscriptions?: OrionSubscriptionsMap;
     /**
      * A function that executes the http level cache of graphql queries
      */
@@ -32,5 +33,10 @@ export interface StartGraphQLOptions extends Omit<GraphQLOptions, SchemaOmits> {
      * Pass another express app
      */
     app?: express.Application;
+    /**
+     * The pubsub provider to use. Default to the single server pubsub.
+     * If you are using multiple servers you must pass a pubsub provider like RedisPubSub
+     */
+    pubsub?: PubSubEngine;
 }
 export {};

package/lib/types/subscription.d.ts

@@ -1,14 +1,15 @@
 import { ResolverOptions } from '@orion-js/resolvers';
-export interface Subscription<T = any, ReturnType = any> {
-    key: string;
+export interface OrionSubscription<TParams = any, ReturnType = any> {
+    name: string;
     params: object;
     subscribe: (callParams: object, viewer: object) => {};
     returns: ReturnType;
-    publish: (params: T, data: ReturnType) => Promise<void>;
+    publish: (params: TParams, data: ReturnType) => Promise<void>;
 }
-export declare type CreateSubscriptionFunction = <T = any, ReturnType = any>(options: SubscriptionOptions) => Subscription<T, ReturnType>;
-export interface SubscriptionMap {
-    [key: string]: Subscription;
+export declare type CreateOrionSubscriptionFunction = <T = any, ReturnType = any>(options: OrionSubscriptionOptions) => OrionSubscription<T, ReturnType>;
+export interface OrionSubscriptionsMap {
+    [key: string]: OrionSubscription;
 }
-export interface SubscriptionOptions extends Omit<ResolverOptions, 'resolve'> {
+export interface OrionSubscriptionOptions extends Omit<ResolverOptions, 'resolve'> {
+    name?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orion-js/graphql",
-  "version": "3.3.21",
+  "version": "3.3.25",
   "main": "lib/index.js",
   "author": "nicolaslopezj",
   "license": "MIT",
@@ -14,12 +14,12 @@
   },
   "dependencies": {
     "@orion-js/helpers": "^3.3.20",
-    "@orion-js/http": "^3.3.20",
-    "@orion-js/models": "^3.3.20",
-    "@orion-js/resolvers": "^3.3.20",
+    "@orion-js/http": "^3.3.25",
+    "@orion-js/models": "^3.3.25",
+    "@orion-js/resolvers": "^3.3.25",
     "@orion-js/schema": "^3.3.20",
     "@orion-js/services": "^3.3.20",
-    "@orion-js/typed-model": "^3.3.21",
+    "@orion-js/typed-model": "^3.3.25",
     "apollo-server-core": "3.5.0",
     "graphql-iso-date": "^3.6.1",
     "graphql-subscriptions": "^2.0.0",
@@ -45,5 +45,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c24dc7ba82493710c5d2a1a593ff4ed9eddd3090"
+  "gitHead": "ed68403cef114f593dd16535db8993560f4f1849"
 }