@orion-js/graphql 3.11.15 → 4.0.0-alpha.3

package/lib/startWebsocket.test.js

@@ -1,303 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-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 __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getApolloOptions_1 = __importDefault(require("./getApolloOptions"));
-const startWebsocket_1 = __importDefault(require("./startWebsocket"));
-const resolvers_1 = require("@orion-js/resolvers");
-const _1 = require(".");
-const core_1 = require("@apollo/client/core");
-const graphql_tag_1 = __importDefault(require("graphql-tag"));
-const helpers_1 = require("@orion-js/helpers");
-const lodash_1 = require("lodash");
-const websockerViewer_1 = require("./websockerViewer");
-const typed_model_1 = require("@orion-js/typed-model");
-const subscriptions_1 = require("@apollo/client/link/subscriptions");
-const graphql_ws_1 = require("graphql-ws");
-const ws_1 = __importStar(require("ws"));
-const crypto_1 = __importDefault(require("crypto"));
-const http_1 = require("@orion-js/http");
-const getStartServerOptions = async () => {
-    const resolvers = {
-        helloWorld: (0, resolvers_1.resolver)({
-            params: {
-                name: {
-                    type: 'string'
-                }
-            },
-            returns: 'string',
-            async resolve({ name }) {
-                return `Hello ${name}`;
-            }
-        })
-    };
-    const onNewGreeting = (0, _1.subscription)({
-        params: {
-            name: {
-                type: 'string'
-            }
-        },
-        returns: 'string'
-    });
-    const withPermissionsSub = (0, _1.subscription)({
-        returns: 'string',
-        checkPermission: async () => null
-    });
-    const withoutPermissionsSub = (0, _1.subscription)({
-        returns: 'string',
-        checkPermission: async () => 'notAllowed'
-    });
-    const withGlobalPermissionsSub = (0, _1.subscription)({
-        returns: 'string',
-        permissionsOptions: {
-            role: 'user'
-        }
-    });
-    const withoutGlobalPermissionsSub = (0, _1.subscription)({
-        returns: 'string',
-        permissionsOptions: {
-            role: 'admin'
-        }
-    });
-    let TestParams = class TestParams {
-    };
-    __decorate([
-        (0, typed_model_1.Prop)({ type: 'ID' }),
-        __metadata("design:type", String)
-    ], TestParams.prototype, "userId", void 0);
-    TestParams = __decorate([
-        (0, typed_model_1.TypedSchema)()
-    ], TestParams);
-    let TestModel = class TestModel {
-    };
-    __decorate([
-        (0, typed_model_1.Prop)(),
-        __metadata("design:type", String)
-    ], TestModel.prototype, "name", void 0);
-    __decorate([
-        (0, typed_model_1.Prop)(),
-        __metadata("design:type", Number)
-    ], TestModel.prototype, "age", void 0);
-    TestModel = __decorate([
-        (0, typed_model_1.TypedSchema)()
-    ], TestModel);
-    const modelSub = (0, _1.subscription)({
-        params: (0, typed_model_1.getModelForClass)(TestParams),
-        returns: (0, typed_model_1.getModelForClass)(TestModel)
-    });
-    const subscriptions = {
-        onNewGreeting,
-        withPermissionsSub,
-        withoutPermissionsSub,
-        withGlobalPermissionsSub,
-        withoutGlobalPermissionsSub,
-        modelSub
-    };
-    const apolloOptions = await (0, getApolloOptions_1.default)({
-        resolvers,
-        subscriptions
-    });
-    return { apolloOptions, resolvers, subscriptions };
-};
-const gqClient = async () => {
-    // To make the point clear that we are not opening any ports here we use a randomized string that will not produce a correct port number.
-    // This example of WebSocket client/server uses string matching to know to what server connect a given client.
-    // We are randomizing because we should use different string for every test to not share state.
-    const RANDOM_WS_PORT = (0, lodash_1.random)(10000, 65536);
-    // We pass customServer instead of typical configuration of a default WebSocket server
-    const { apolloOptions, subscriptions } = await getStartServerOptions();
-    const uri = `ws://localhost:${RANDOM_WS_PORT}/subscriptions`;
-    const server = new ws_1.WebSocketServer({
-        server: (0, http_1.getServer)(),
-        path: '/subscriptions',
-        port: RANDOM_WS_PORT
-    });
-    (0, startWebsocket_1.default)({ schema: apolloOptions.schema }, { resolvers: {}, subscriptions: {} }, server);
-    const getConnectionParams = () => {
-        return { jwt: 'hi' };
-    };
-    const client = (0, graphql_ws_1.createClient)({
-        url: uri,
-        webSocketImpl: ws_1.default,
-        connectionParams: getConnectionParams,
-        lazy: false,
-        /**
-         * Generates a v4 UUID to be used as the ID.
-         * Reference: https://gist.github.com/jed/982883
-         */
-        generateID: () => 
-        // @ts-expect-error this is the way to do it segun la doc
-        ([1e7] + -1e3 + -4e3 + -8e3 + -1e11).replace(/[018]/g, c => (c ^ (crypto_1.default.randomBytes(1)[0] & (15 >> (c / 4)))).toString(16))
-    });
-    // The uri of the WebSocketLink has to match the customServer uri.
-    const wsLink = new subscriptions_1.GraphQLWsLink(client);
-    // Nothing new here
-    return {
-        client: new core_1.ApolloClient({
-            link: wsLink,
-            cache: new core_1.InMemoryCache()
-        }),
-        subscriptions
-    };
-};
-describe('Test GraphQL Subscriptions', () => {
-    it('Should connect to the graphql subscription server correctly', async () => {
-        const { client, subscriptions } = await gqClient();
-        client
-            .subscribe({
-            query: (0, graphql_tag_1.default) `
-          subscription ($name: String) {
-            info: onNewGreeting(name: $name)
-          }
-        `,
-            variables: { name: 'Nico' }
-        })
-            .subscribe({
-            next({ data }) {
-                expect(data.info).toEqual('finally');
-            }
-        });
-        await (0, helpers_1.sleep)(50);
-        expect.assertions(2);
-        await subscriptions.onNewGreeting.publish({ name: 'Nico' }, 'finally');
-        await subscriptions.onNewGreeting.publish({ name: 'Nico' }, 'finally');
-        await (0, helpers_1.sleep)(50);
-    });
-    it('Should execute subscriptions permissions correctly', async () => {
-        const { client, subscriptions } = await gqClient();
-        client
-            .subscribe({
-            query: (0, graphql_tag_1.default) `
-          subscription {
-            info: withPermissionsSub
-          }
-        `
-        })
-            .subscribe({
-            next({ data }) {
-                expect(data.info).toEqual('yes');
-            }
-        });
-        client
-            .subscribe({
-            query: (0, graphql_tag_1.default) `
-          subscription {
-            info: withoutPermissionsSub
-          }
-        `
-        })
-            .subscribe({
-            next({ data }) {
-                expect(data.info).toEqual('no');
-            }
-        });
-        await (0, helpers_1.sleep)(50);
-        expect.assertions(1); // only with should be called
-        await subscriptions.withPermissionsSub.publish({}, 'yes');
-        await subscriptions.withoutPermissionsSub.publish({}, 'no');
-        await (0, helpers_1.sleep)(50);
-    });
-    it('Should execute subscriptions with global permissions correctly using custom get viewer and custom global permission checker', async () => {
-        const { client, subscriptions } = await gqClient();
-        (0, websockerViewer_1.setGetWebsockerViewer)((connectionParams) => {
-            return {
-                role: 'user'
-            };
-        });
-        (0, resolvers_1.addPermissionChecker)(async ({ resolver, viewer }) => {
-            if (!resolver.permissionsOptions)
-                return null;
-            if (resolver.permissionsOptions.role === viewer.role)
-                return null;
-            return 'notAllowed';
-        });
-        client
-            .subscribe({
-            query: (0, graphql_tag_1.default) `
-          subscription {
-            info: withGlobalPermissionsSub
-          }
-        `
-        })
-            .subscribe({
-            next({ data }) {
-                expect(data.info).toEqual('yes');
-            }
-        });
-        client
-            .subscribe({
-            query: (0, graphql_tag_1.default) `
-          subscription {
-            info: withoutGlobalPermissionsSub
-          }
-        `
-        })
-            .subscribe({
-            next({ data }) {
-                expect(data.info).toEqual('no');
-            }
-        });
-        await (0, helpers_1.sleep)(50);
-        expect.assertions(1); // only with should be called
-        await subscriptions.withGlobalPermissionsSub.publish({}, 'yes');
-        await subscriptions.withoutGlobalPermissionsSub.publish({}, 'no');
-        await (0, helpers_1.sleep)(50);
-    });
-    it('Should work with typed model subscriptions', async () => {
-        const { client, subscriptions } = await gqClient();
-        client
-            .subscribe({
-            query: (0, graphql_tag_1.default) `
-          subscription ($userId: ID) {
-            info: modelSub(userId: $userId) {
-              name
-            }
-          }
-        `,
-            variables: { userId: '1' }
-        })
-            .subscribe({
-            next({ data }) {
-                expect(data.info).toEqual({ name: 'Nico', __typename: 'TestModel' });
-            }
-        });
-        await (0, helpers_1.sleep)(50);
-        expect.assertions(2);
-        await subscriptions.modelSub.publish({ userId: '1' }, { name: 'Nico', age: 20 });
-        await subscriptions.modelSub.publish({ userId: '1' }, { name: 'Nico', age: 20 });
-        await (0, helpers_1.sleep)(50);
-    });
-});

package/lib/subscription/getChannelName.d.ts

@@ -1 +0,0 @@
-export default function (name: string, params: any): string;

package/lib/subscription/getChannelName.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const helpers_1 = require("@orion-js/helpers");
-function default_1(name, params) {
-    const hash = (0, helpers_1.hashObject)(params);
-    const channelName = `${name}_${hash}`;
-    return channelName;
-}
-exports.default = default_1;

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

@@ -1 +0,0 @@
-export {};

package/lib/subscription/getChannelName.test.js

@@ -1,26 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getChannelName_1 = __importDefault(require("./getChannelName"));
-describe('Test channel name generation', () => {
-    it('Should return different channel names with different params', () => {
-        const channelName1 = (0, getChannelName_1.default)('test', {
-            hello: 'world'
-        });
-        const channelName2 = (0, getChannelName_1.default)('test', {
-            hello: 'country'
-        });
-        expect(channelName1).not.toEqual(channelName2);
-    });
-    it('Should return same channel names with same params', () => {
-        const channelName1 = (0, getChannelName_1.default)('test', {
-            hello: 'world'
-        });
-        const channelName2 = (0, getChannelName_1.default)('test', {
-            hello: 'world'
-        });
-        expect(channelName1).toEqual(channelName2);
-    });
-});

package/lib/subscription/index.d.ts

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

package/lib/subscription/index.js

@@ -1,34 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const pubsub_1 = require("../pubsub");
-const getChannelName_1 = __importDefault(require("./getChannelName"));
-const resolvers_1 = require("@orion-js/resolvers");
-const createSubscription = function (options) {
-    const subscription = {
-        name: options.name
-    };
-    // the publish function
-    subscription.publish = async (params, data) => {
-        const pubsub = (0, pubsub_1.getPubsub)();
-        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: null }, options);
-            const channelName = (0, getChannelName_1.default)(subscription.name, params);
-            return pubsub.asyncIterator(channelName);
-        }
-        catch (error) {
-            return pubsub.asyncIterator('unauthorized');
-        }
-    };
-    subscription.params = (0, resolvers_1.cleanParams)(options.params);
-    subscription.returns = (0, resolvers_1.cleanReturns)(options.returns);
-    return subscription;
-};
-exports.default = createSubscription;

package/lib/types/index.d.ts

@@ -1,3 +0,0 @@
-import './subscription';
-export * from './startGraphQL';
-export * from './subscription';

package/lib/types/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-require("./subscription");
-__exportStar(require("./startGraphQL"), exports);
-__exportStar(require("./subscription"), exports);

package/lib/types/startGraphQL.d.ts

@@ -1,41 +0,0 @@
-import { GlobalResolversMap, ModelResolversMap } from '@orion-js/models';
-import { express } from '@orion-js/http';
-import { OrionSubscriptionsMap } from './subscription';
-import { PubSubEngine } from 'graphql-subscriptions';
-import { ApolloServerOptions } from '@apollo/server';
-export type ExecuteGraphQLCache = (req: express.Request, res: express.Response, viewer: object, executeQuery: () => Promise<string>) => Promise<string>;
-export interface ModelsResolversMap {
-    [key: string]: ModelResolversMap;
-}
-type SchemaOmits = 'schema' | 'schemaHash' | 'context' | 'useGraphiql';
-export interface StartGraphQLOptions extends Omit<ApolloServerOptions<any>, SchemaOmits> {
-    /**
-     * A map with all the global resolvers
-     */
-    resolvers: GlobalResolversMap;
-    /**
-     * A map with all the model resolvers. You must only add the models that you want to extend with resolvers.
-     */
-    modelResolvers?: ModelsResolversMap;
-    /**
-     * A Map with all global subscriptions
-     */
-    subscriptions?: OrionSubscriptionsMap;
-    /**
-     * A function that executes the http level cache of graphql queries
-     */
-    /**
-     * Should use GraphiQL. Default to true
-     */
-    useGraphiql?: boolean;
-    /**
-     * 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/startGraphQL.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/subscription.d.ts

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

package/lib/types/subscription.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/websockerViewer.d.ts

@@ -1,2 +0,0 @@
-export declare const getWebsockerViewer: (connectionParams: any) => Promise<any>;
-export declare const setGetWebsockerViewer: (getViewerFunc: (connectionParams: any) => any) => void;

package/lib/websockerViewer.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setGetWebsockerViewer = exports.getWebsockerViewer = void 0;
-global.getWebsocketViewerRef = () => null;
-const getWebsockerViewer = async (connectionParams) => {
-    try {
-        const viewer = await global.getWebsocketViewerRef(connectionParams);
-        if (!viewer)
-            return {};
-        return viewer;
-    }
-    catch {
-        return {};
-    }
-};
-exports.getWebsockerViewer = getWebsockerViewer;
-const setGetWebsockerViewer = (getViewerFunc) => {
-    global.getWebsocketViewerRef = getViewerFunc;
-};
-exports.setGetWebsockerViewer = setGetWebsockerViewer;

package/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "compilerOptions": {
-    "strict": false,
-    "outDir": "./lib",
-    "rootDir": "./src",
-    "module": "commonjs",
-    "target": "es2020",
-    "moduleResolution": "node",
-    "lib": ["es2020"],
-    "declaration": true,
-
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-
-    // required for typed models
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true
-  }
-}