@common-stack/generate-plugin 5.0.4-alpha.9 → 5.0.5-alpha.0

package/lib/generators/add-backend/files/package.json

@@ -0,0 +1,162 @@
+{
+    "name": "adminide-stack-backend-server",
+    "version": "3.1.1-alpha.5",
+    "private": true,
+    "description": "Starter kit for apollo server using webpack and typescript",
+    "keywords": [
+        "apollo",
+        "apollo-server",
+        "backend",
+        "express",
+        "graphiql",
+        "graphql",
+        "typescript",
+        "webpack"
+    ],
+    "homepage": "https://github.com/cdmbase/fullstack-pro#readme",
+    "bugs": {
+        "url": "https://github.com/cdmbase/fullstack-pro/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/cdmbase/fullstack-pro.git"
+    },
+    "license": "MIT",
+    "author": "CDMBase LLC",
+    "main": "dist/index.js",
+    "typings": "dist/main.d.ts",
+    "scripts": {
+        "build": "cross-env NODE_ENV=production webpack --config webpack.config.js",
+        "build:clean": "rimraf dist .awcache",
+        "build:dev": "cross-env NODE_ENV=development ENV_FILE=../../config/development/dev.env webpack --config webpack.config.js",
+        "db:migrate": "knex -- migrate:latest --cwd . --knexfile ./knexfile.js",
+        "db:migrate:rollback": "knex -- migrate:rollback  --cwd . --knexfile ./knexfile.js",
+        "db:seed": "yarn db:migrate && knex -- seed:run  --cwd . --knexfile ./knexfile.js",
+        "docker:build": "yarn build && docker build . -t $npm_package_name:$npm_package_version",
+        "docker:build:debug": "yarn build:debug && docker build . -t $npm_package_name:$npm_package_version",
+        "docker:run": "docker run  --env-file ../../config/staging/docker-staging.env -p 8080:8080 -it $npm_package_name:$npm_package_version",
+        "docker:run:debug": "cross-env NODE_ENV=development docker run  --env-file ../../config/staging/docker-staging.env -p 8080:8080 -it $npm_package_name:$npm_package_version",
+        "proddb:migrate": "NODE_ENV=production yarn db:migrate",
+        "proddb:migrate:rollback": "NODE_ENV=production yarn db:migrate:rollback",
+        "proddb:seed": "NODE_ENV=production yarn db:seed",
+        "prepublish": "yarn build:clean",
+        "stagedb:migrate": "cross-env ENV_FILE=../../config/test/test.env NODE_ENV=test yarn db:migrate",
+        "stagedb:migrate:rollback": "cross-env ENV_FILE=../../config/test/test.env NODE_ENV=test yarn db:migrate:rollback",
+        "stagedb:seed": "cross-env ENV_FILE=../../config/test/test.env NODE_ENV=test yarn db:seed",
+        "start": "cross-env NODE_ENV=production tsx dist/index.js",
+        "start:dev": "cross-env NODE_ENV=development ENV_FILE=../../config/development/dev.env tsx watch dist/index.js",
+        "start:staging": "cross-env NODE_ENV=staging ENV_FILE=../../config/staging/staging.env tsx dist/index.js",
+        "start:test": "cross-env NODE_ENV=test ENV_FILE=../../config/test/test.env tsx dist/index.js",
+        "test": "jest",
+        "test:notify": "yarn test:watch -- --notify",
+        "test:watch": "npm test -- --watch",
+        "preupver": "npm test",
+        "upver": "standard-version",
+        "watch": "cross-env NODE_ENV=development ENV_FILE=../../config/development/dev.env yarn build:dev && yarn start:dev",
+        "watch:staging": "cross-env NODE_ENV=test ENV_FILE=../../config/staging/staging.env yarn build && yarn start:stage",
+        "watch:test": "cross-env NODE_ENV=test ENV_FILE=../../config/test/test.env yarn build:test && yarn start:test",
+        "zen:watch": "zen watch -x"
+    },
+    "resolutions": {
+        "apollo-upload-client": "^16.0.0",
+        "extract-files": "^10.0.0",
+        "html-to-text": "^8.0.0"
+    },
+    "dependencies": {
+        "@adminide-stack/account-api-server": "7.2.6-alpha.13",
+        "@adminide-stack/billing-api-server": "7.2.6-alpha.13",
+        "@adminide-stack/core": "7.2.6-alpha.13",
+        "@adminide-stack/extension-module-server": "7.2.6-alpha.13",
+        "@adminide-stack/git-api-server": "7.2.6-alpha.13",
+        "@adminide-stack/integration-api-server": "7.2.6-alpha.13",
+        "@adminide-stack/marketplace-module-server": "7.2.6-alpha.13",
+        "@adminide-stack/platform-server": "7.2.6-alpha.13",
+        "@adminide-stack/project-mgmt-server": "7.2.6-alpha.13",
+        "@adminide-stack/registry-api-server": "7.2.6-alpha.13",
+        "@adminide-stack/user-auth0-server": "7.2.6-alpha.13",
+        "@apollo/client": "^3.9.0",
+        "@apollo/utils.keyvadapter": "3.1.0",
+        "@babel/runtime": "^7.20.1",
+        "@casl/ability": "^4.1.5",
+        "@cdm-logger/client": "9.0.3",
+        "@cdm-logger/server": "^9.0.3",
+        "@cdmbase/graphql-type-uri": "^3.0.0",
+        "@common-stack/cache-api-server": "0.0.1",
+        "@common-stack/client-core": "0.0.1",
+        "@common-stack/core": "0.0.1",
+        "@common-stack/server-core": "0.0.1",
+        "@common-stack/store-mongo": "0.0.1",
+        "@container-stack/core": "5.1.2",
+        "@container-stack/mailing-api": "5.1.2",
+        "@container-stack/notification-api-core": "5.1.2",
+        "@container-stack/notification-api-server": "5.1.2",
+        "@container-stack/territory": "5.1.2",
+        "@graphql-tools/links": "^8.3.21",
+        "@graphql-tools/schema": "^8.3.14",
+        "@graphql-tools/stitch": "^8.7.29",
+        "@graphql-tools/utils": "^8.0.0",
+        "@graphql-tools/wrap": "^8.4.20",
+        "@keyv/redis": "2.8.4",
+        "@remix-run/node": "^2.8.1",
+        "@sentry/node": "~7.24.2",
+        "apollo-datasource": "^3.3.1",
+        "apollo-datasource-rest": "^3.3.1",
+        "apollo-errors": "^1.9.0",
+        "apollo-server-cache-memcached": "^3.3.1",
+        "apollo-server-cache-redis": "^3.3.1",
+        "apollo-server-caching": "^3.3.0",
+        "apollo-server-core": "^3.11.1",
+        "apollo-server-errors": "^3.3.1",
+        "apollo-server-express": "^3.11.1",
+        "apollo-server-plugin-response-cache": "^3.8.1",
+        "app-root-path": "^3.0.0",
+        "body-parser": "^1.19.0",
+        "cors": "^2.8.5",
+        "dataloader": "^2.0.0",
+        "dotenv": "^8.2.0",
+        "dotenv-esm": "^16.0.3-4",
+        "envalid": "~7.2.2",
+        "esm": "^3.2.25",
+        "express": "^4.17.1",
+        "graphql": "^15.0.0",
+        "graphql-bigint": "^1.0.0",
+        "graphql-iso-date": "^3.6.1",
+        "graphql-middleware": "^6.1.33",
+        "graphql-nats-subscriptions": "^1.5.0",
+        "graphql-playground-middleware-express": "^1.7.3",
+        "graphql-shield": "^7.3.5",
+        "graphql-subscriptions": "^2.0.0",
+        "graphql-tools": "^8.0.0",
+        "graphql-type-json": "^0.3.1",
+        "graphql-ws": "^5.11.2",
+        "inversify": "^6.0.2",
+        "ioredis": "^5.4.1",
+        "isomorphic-fetch": "^2.2.1",
+        "lodash": "^4.17.15",
+        "moleculer": "^0.14.2",
+        "moleculer-zipkin": "0.2.2",
+        "mongoose": "^6.3.3",
+        "mongoose-execution-time": "^1.1.0",
+        "morgan": "^1.9.1",
+        "nats": "^1.3.2",
+        "react": "18.2.0",
+        "reflect-metadata": "^0.1.13",
+        "rxjs": "^6.5.3",
+        "rxjs-compat": "^6.5.3",
+        "subscriptions-transport-ws": "^0.11.0",
+        "universal-cookie-express": "^4.0.1",
+        "ws": "^8.11.0"
+    },
+    "devDependencies": {
+        "cross-env": "^7.0.3",
+        "pm2": "^5.2.2",
+        "rimraf": "^3.0.2",
+        "tsx": "^4.7.0"
+    },
+    "engines": {
+        "vscode": "^1.52.1"
+    },
+    "typescript": {
+        "definition": "dist/main.d.ts"
+    }
+}

package/lib/generators/add-backend/files/src/api/remote-config.ts.template

@@ -0,0 +1,11 @@
+interface ISchemaConfig {
+    uri: string;
+    wsUri: string;
+}
+
+export const remoteSchemaDetails: ISchemaConfig[] = [
+    // {
+    // uri: 'http://localhost:8085/graphql',
+    // wsUri: 'ws://localhost:8085/graphql',
+    // },
+];

package/lib/generators/add-backend/files/src/api/resolver.ts.template

@@ -0,0 +1,15 @@
+import GraphQLJSON, { GraphQLJSONObject } from 'graphql-type-json';
+import { GraphQLDate, GraphQLTime, GraphQLDateTime } from 'graphql-iso-date';
+import { GraphQLAnyObject } from './scalar';
+import GraphQLURI from '@cdmbase/graphql-type-uri';
+
+export const resolvers = {
+    AnyObject: GraphQLAnyObject,
+    Date: GraphQLDate,
+    Time: GraphQLTime,
+    URI: GraphQLURI('URI'),
+    URIInput: GraphQLURI('URIInput'),
+    DateTime: GraphQLDateTime,
+    JSON: GraphQLJSON,
+    JSONObject: GraphQLJSONObject,
+};

package/lib/generators/add-backend/files/src/api/root-schema.graphqls

@@ -0,0 +1,96 @@
+scalar AnyObject
+scalar Date
+scalar Time
+scalar DateTime
+scalar URI
+scalar URIInput
+scalar Observable
+
+scalar JSON
+scalar JSONObject
+
+directive @cacheControl(maxAge: Int, scope: CacheControlScope) on FIELD_DEFINITION | OBJECT | INTERFACE
+enum CacheControlScope {
+  PUBLIC
+  PRIVATE
+}
+
+"""
+ An object with an ID.
+"""
+interface Node {
+    """
+    The ID of the node.
+    """
+    id: ID!
+}
+
+# Pagination information. See https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo.
+type PageInfo {
+    # Whether there is a next page of nodes in the connection.
+    hasNextPage: Boolean!
+}
+
+"""
+ Represents a null return value.
+"""
+type EmptyResponse {
+    # A dummy null value.
+    alwaysNil: String
+}
+
+type FieldError {
+  field: String!
+  message: String!
+}
+
+input Sort{
+    key: String!,
+    value: SortEnum!,
+}
+
+enum SortEnum{
+    ASC,
+    DESC
+}
+
+type Query {
+    """
+     Looks up a node by ID.
+    """
+    node(id: ID!): Node
+}
+
+type Mutation {
+    dummy: Int
+}
+
+type Subscription {
+    dummy: Int
+}
+
+type AdminIdeSettings {
+    dummy: Int
+}
+
+""" All Moleculer Topic names are extended from this."""
+enum MoleculerServiceName {
+    dummy
+}
+
+interface IResourceUtilizationSettings {
+    subTopic: String
+    adminApiNamespace: String
+}
+
+
+type GeoLocation {
+    coordinates: [Float]
+}
+
+schema {
+    query: Query
+    mutation: Mutation
+    subscription: Subscription
+}
+

package/lib/generators/add-backend/files/src/api/scalar.ts.template

@@ -0,0 +1,16 @@
+// add any scalar types
+import { GraphQLError, GraphQLScalarType, Kind } from 'graphql';
+
+// https://stackoverflow.com/questions/41557536/custom-map-keys-in-graphql-response
+export const GraphQLAnyObject = new GraphQLScalarType({
+    name: 'AnyObject',
+    description: 'Any JSON object. This type bypasses type checking.',
+    serialize: (value) => value,
+    parseValue: (value) => value,
+    parseLiteral: (ast) => {
+        if (ast.kind !== Kind.OBJECT) {
+            throw new GraphQLError(`Query error: Can only parse object but got a: ${ast.kind}`, [ast]);
+        }
+        return ast.fields;
+    },
+});

package/lib/generators/add-backend/files/src/api/schema-builder.ts.template

@@ -0,0 +1,189 @@
+/* eslint-disable class-methods-use-this */
+/* eslint-disable no-useless-constructor */
+/* eslint-disable import/no-extraneous-dependencies */
+import * as fs from 'fs';
+import { GraphQLSchema, OperationDefinitionNode } from 'graphql';
+import { stitchSchemas } from '@graphql-tools/stitch';
+import { makeExecutableSchema } from '@graphql-tools/schema';
+import { linkToExecutor } from '@graphql-tools/links';
+import { introspectSchema, wrapSchema } from '@graphql-tools/wrap';
+// import { transformSchema } from '@graphql-tools/delegate';
+import * as ws from 'ws';
+import { getMainDefinition } from '@apollo/client/utilities';
+import { WebSocketLink } from '@apollo/client/link/ws';
+import { split } from '@apollo/client/index.js';
+import { IGraphqlShieldRules, logger } from '@common-stack/server-core';
+import { HttpLink } from '@apollo/client/link/http';
+import * as fetch from 'isomorphic-fetch';
+import { CdmLogger } from '@cdm-logger/core';
+import { shield } from 'graphql-shield';
+import { applyMiddleware } from 'graphql-middleware';
+import { remoteSchemaDetails } from './remote-config';
+import rootSchemaDef from './root-schema.graphqls';
+import { resolvers as rootResolver } from './resolver';
+import { attachDirectiveResolvers } from './utils';
+
+interface IGraphqlOptions {
+    schema: string | string[];
+    resolvers: any;
+    directives: any[];
+    directiveResolvers: { [key: string]: any };
+    middlewares: any[];
+    rules?: IGraphqlShieldRules;
+    logger: CdmLogger.ILogger;
+}
+export class GatewaySchemaBuilder {
+    constructor(private options: IGraphqlOptions) {}
+
+    public async build(): Promise<GraphQLSchema> {
+        let gatewaySchema;
+        let ownSchema;
+        try {
+            ownSchema = this.createOwnSchema();
+            const remoteSchema = await this.load();
+            // techSchema = this.patchSchema(techSchema, 'TechService');
+
+            gatewaySchema = stitchSchemas({
+                subschemas: [ownSchema],
+            });
+
+            // Apply middleware to the schema
+            if (this.options.middlewares && this.options.middlewares.length > 0) {
+                gatewaySchema = applyMiddleware(
+                    gatewaySchema,
+                    ...this.options.middlewares,
+                    shield(this.options.rules || {}, {
+                        allowExternalErrors: true,
+                    }),
+                );
+            }
+            // TODO after updating graphql-tools to v8
+            // addErrorLoggingToSchema(schema, { log: (e) => logger.error(e as Error) });
+        } catch (err) {
+            logger.error('[Graphql Schema Errors] when building schema:', err.message);
+            gatewaySchema = ownSchema;
+        }
+
+        return gatewaySchema;
+    }
+
+    private async load() {
+        const schemas = [];
+        // eslint-disable-next-line no-plusplus
+        for (let i = 0; i < remoteSchemaDetails.length; i++) {
+            // eslint-disable-next-line no-await-in-loop
+            const schema = await this.loadRemoteSchema(remoteSchemaDetails[i]);
+            schemas.push(schema);
+        }
+        return schemas;
+    }
+
+    private async createRemoteSchema(service: string, iteration?: number): Promise<GraphQLSchema> {
+        logger.info('Fetch service [%s] iteration [%s]', service, iteration);
+        const services = remoteSchemaDetails;
+        if (!services.length) {
+            console.warn(`Service ${services} is undefined`);
+            if (iteration && iteration > 2) {
+                return Promise.reject(`tried upto ${iteration} attempts, now failing...`);
+            }
+            return new Promise<GraphQLSchema>((resolve, reject) => {
+                const timeout = iteration ? 1000 * iteration : 1000;
+                logger.info('Wait for service startup %s', timeout);
+                setTimeout(() => {
+                    this.createRemoteSchema(service, iteration ? iteration + 1 : 1)
+                        .then(resolve)
+                        .catch(reject);
+                }, timeout);
+            });
+        }
+        // instead need to loop it
+        // https://github.com/j-colter/graphql-gateway/blob/9c64d90a74727d2002d10b06f47e1f4a316070fc/src/schema.js#L50
+        const url = services[0].uri;
+        logger.info('fetch service [%s]', url);
+        // 1. Create apollo Link that's connected to the underlying GraphQL API
+        const link = new HttpLink({ uri: url, fetch });
+        const executor: any = linkToExecutor(link);
+        // 2. Retrieve schema definition of the underlying GraphQL API
+        const remoteSchema = await introspectSchema(link as any);
+
+        // 3. Create the executable schema based on schema definition and Apollo Link
+        return wrapSchema({
+            schema: remoteSchema,
+            executor,
+        });
+    }
+
+    private async loadRemoteSchema({ uri, wsUri }) {
+        try {
+            const httpLink = new HttpLink({ uri, fetch });
+            let link = null;
+
+            if (wsUri) {
+                const wsLink = new WebSocketLink({
+                    uri: wsUri,
+                    options: {
+                        reconnect: true,
+                    },
+                    webSocketImpl: ws,
+                });
+                link = split(
+                    // split based on operatino type
+                    ({ query }) => {
+                        const { kind, operation } = getMainDefinition(query) as OperationDefinitionNode;
+                        return kind === 'OperationDefinition' && operation === 'subscription';
+                    },
+                    wsLink,
+                    httpLink,
+                );
+            } else {
+                link = httpLink;
+            }
+            const executor: any = linkToExecutor(link);
+            const remoteSchema = await introspectSchema(link);
+            const executableSchema = wrapSchema({
+                schema: remoteSchema,
+                executor,
+            });
+            return executableSchema;
+        } catch (err) {
+            this.options.logger.error('fetching schema error: ', err);
+            return {};
+        }
+    }
+
+    // disabled after updating to apollo-client to v3 and graphql-tools to v8
+    // private patchSchema(schema: GraphQLSchema, systemName: string) {
+    //     return transformSchema(schema, [
+    //         new RenameTypes((name: string) => (name === 'StatusInfo' ? `${systemName}StatusInfo` : undefined)),
+    //         new RenameRootFields((_operation: string, name: string) =>
+    //             name === 'status'
+    //                 ? `${systemName.substring(0, 1).toLowerCase()}${systemName.substring(1)}Status`
+    //                 : name,
+    //         ),
+    //     ]);
+    // }
+
+    private createOwnSchema(): GraphQLSchema {
+        const typeDefs = [rootSchemaDef, this.options.schema].join('\n');
+        if (__DEV__) {
+            import('../modules/module').then(({ ExternalModules }) => {
+                const externalSchema = ExternalModules?.schemas || ``;
+                const writeData = `${externalSchema}`;
+                fs.writeFileSync('./generated-schema.graphql', writeData);
+            });
+        }
+        let mergedSchema = makeExecutableSchema({
+            resolvers: [rootResolver, this.options.resolvers],
+            typeDefs,
+            resolverValidationOptions: {
+                requireResolversForResolveType: 'warn',
+            },
+        });
+        // mergedSchema = this.options.directives.reduce((curSchema,transform) => transform(curSchema), mergedSchema);
+        if (this.options.directiveResolvers && Object.keys(this.options.directiveResolvers).length !== 0) {
+            this.options.logger.warn('directiveResolvers deprecated replaced with directives');
+            mergedSchema = attachDirectiveResolvers(mergedSchema, this.options.directiveResolvers);
+        }
+        return mergedSchema;
+    }
+}

package/lib/generators/add-backend/files/src/api/utils.ts.template

@@ -0,0 +1,44 @@
+import { defaultFieldResolver, GraphQLSchema } from 'graphql';
+import { mapSchema, MapperKind, getDirectives } from '@graphql-tools/utils';
+
+export function attachDirectiveResolvers(
+    schema: GraphQLSchema,
+    directiveResolvers: {[key: string]: Function},
+): GraphQLSchema {
+    // ... argument validation ...
+
+    return mapSchema(schema, {
+        [MapperKind.OBJECT_FIELD]: (fieldConfig) => {
+            const newFieldConfig = { ...fieldConfig };
+
+            const directives = getDirectives(schema, fieldConfig);
+            for (const directive of directives) {
+                const directiveName = directive.name;
+                if (directiveResolvers[directiveName]) {
+                    const resolver = directiveResolvers[directiveName];
+                    const originalResolver =
+                        newFieldConfig.resolve != null ? newFieldConfig.resolve : defaultFieldResolver;
+                    const directiveArgs = directive.args;
+                    newFieldConfig.resolve = (source, originalArgs, context, info) => {
+                        return resolver(
+                            () =>
+                                new Promise((resolve, reject) => {
+                                    const result = originalResolver(source, originalArgs, context, info);
+                                    if (result instanceof Error) {
+                                        reject(result);
+                                    }
+                                    resolve(result);
+                                }),
+                            source,
+                            directiveArgs,
+                            context,
+                            info,
+                        );
+                    };
+                }
+            }
+
+            return newFieldConfig;
+        },
+    });
+}

package/lib/generators/add-backend/files/src/config/env-config.ts.template

@@ -0,0 +1,34 @@
+/// <reference path='../../../../typings/index.d.ts' />
+import { str, bool, num, json, cleanEnv } from 'envalid';
+
+export const config = cleanEnv(process.env, {
+    NODE_ENV: str({ default: 'production', choices: ['production', 'staging', 'development', 'test'] }),
+    NATS_URL: str({ devDefault: 'nats://localhost:4222/' }),
+    NATS_USER: str({ devDefault: 'test' }),
+    NATS_PW: str({ devDefault: 'test' }),
+    MONGO_URL: str({ devDefault: 'mongodb://localhost:27017/sample-stack' }),
+    MONGO_OPTIONS: str({ default: '{}' }),
+    LOG_LEVEL: str({ default: 'info', devDefault: 'trace', choices: ['info', 'debug', 'trace'] }),
+    REDIS_CLUSTER_URL: json({
+        devDefault: '[{"port":6379,"host":"localhost"}]',
+        example: '[{"port":6379,"host":"localhost"}]',
+    }),
+    REDIS_URL: str({ devDefault: 'localhost' }),
+    REDIS_CLUSTER_ENABLED: bool({ devDefault: false }),
+    REDIS_SENTINEL_ENABLED: bool({ devDefault: true }),
+    HEMERA_LOG_LEVEL: str({
+        default: 'info',
+        devDefault: 'info',
+        choices: ['fatal', 'error', 'warn', 'info', 'debug', 'trace'],
+    }),
+    BACKEND_URL: str({ devDefault: __BACKEND_URL__ }),
+    GRAPHQL_URL: str({ devDefault: __GRAPHQL_URL__ }),
+    CLIENT_URL: str({ devDefault: __BACKEND_URL__ }),
+    CONNECTION_ID: str({ devDefault: 'CONNECTION_ID' }),
+    MAILGUN_KEY: str(),
+    MAILGUN_DOMAIN: str(),
+    NAMESPACE: str({ default: 'default' }),
+    ACTIVITY_NAMESPACE: str({ devDefault: 'default' }),
+    API_NAMESPACE: str({ devDefault: 'default' }),
+    ADMIN_API_NAMESPACE: str({ devDefault: 'default' }),
+});

package/lib/generators/add-backend/files/src/config/index.ts.template

@@ -0,0 +1 @@
+export * from './env-config';