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

package/lib/generators/add-backend/files/README.md

@@ -0,0 +1,133 @@
+# webpack-apollo-server
+Starter kit for apollo server using webpack and typescript
+
+What does it include:
+----
+    1. exported schema as example for GraphQL Schema
+    2. Working Apollo Server (webpack + tslint + tsloader)
+    3. Typescript 2.0.0 => ES6
+    4. Dockerfile to make the apollo-server a container.
+    5. unit testing (mocha-webpack+chai) + coverage report (mocha-istanbul-spec+istanbul).
+    6. working with graphql-tools
+    7. standard-version for auto SemVer.
+
+Notes
+----
+Please note that you will need to rename the library name in some files:
+
+    1. package.json (ofcourse ;))
+
+Useful commands:
+----
+    yarn build       - build the library files (Required for start:watch)
+    yarn build:watch - build the library files in watchmode (Useful for development)
+    npm test            - run tests once
+    yarn test:watch  - run tests in watchmode (Useful for development)
+    yarn test:growl  - run tests in watchmode with growl notification (even more useful for development)
+
+How to run it:
+----
+```bash
+    npm start
+```
+
+Files explained:
+----
+    1. src                         - directory is used for typescript code that is part of the project
+        1a. main.ts                - Main server file. (Starting Apollo server)
+        1b. main.spec.ts           - Tests file for main
+        1c. schema                 - Module used to build schema
+            - index.ts             - simple logic to merge all modules into a schema using graphql-tools
+            - modules/             - directory for modules to be used with graphql-tools
+        1c. schema.spec.ts         - Basic test for schema.
+        1c. main.test.ts           - Main for tests runner.
+    3. package.json                - file is used to describe the library
+    4. tsconfig.json               - configuration file for the library compilation
+    6. tslint.json                 - configuration file for the linter
+    7. typings.json                - typings needed for the server
+    8. webpack.config.js           - configuration file of the compilation automation process for the library
+    9. webpack.config.test.js      - configuration file of the compilation when testing
+    10. Dockerfile                 - Dockerfile used to describe how to make a container out of apollo server
+    11. mocha-webpack.opts         - Options file for mocha-webpack
+
+Output files explained:
+----
+    1. node_modules - directory npm creates with all the dependencies of the module (result of yarn install)
+    2. dist         - directory contains the compiled server (javascript)
+    3. html-report  - output of npm test, code coverage html report.
+
+
+Database
+----
+Connects to memory database through Knex
+
+Database configuration is set in `db-config.json`
+
+Setup
+----
+Create a database and fill the data
+```
+yarn db:seed         
+```
+What files to be customized? 
+----
+Customizable files for a specific project would be the following
+```
+src/container
+src/middleware/graphql.ts
+```
+
+The Person type - dynamic/parametrized query and drill down:
+----
+The person type was added to demonstrate a database like access, parametrized queries, resolvers and drill down.
+The data is currently hard coded but simulates a storage. Each person has an id, name and sex. It also has a dynamic
+field called matches. For demonstration purposes, this field will retrieve all members of the other sex by using a
+resolver.
+
+Since this is a computed field the query can be infinitely nested, for example, try in the graphiql editor this query:
+
+    {
+       getPerson(id: "1") {
+         id,
+         name
+         sex
+         matches {
+           id
+           name
+           sex
+           matches {
+             id
+             name
+             sex
+             matches {
+               id
+               name
+               sex
+             }
+           }
+         }
+       }
+     }
+
+It will return a nested, alternating male/femal results.
+
+To list all persons, use the `persons` query:
+
+    {
+      persons {
+        id
+        name
+      }
+    }
+
+There is also an example of a mutation - `addPerson(name: String, sex: String)`, to use it:
+
+    mutation {
+        addPerson(name: "kuku", sex: "male"){
+            id
+            name
+        }
+    }
+
+Note that the query generates a random id and that the added persons are transient,
+i.e. not persisted and will be gone once you shut down the server.

package/lib/generators/add-backend/files/__tests__/test.ts.template

@@ -0,0 +1,95 @@
+import { createServer } from "http";
+import express from "express";
+import { ApolloServer, gql } from "apollo-server-express";
+import { ApolloServerPluginDrainHttpServer } from "apollo-server-core";
+import { PubSub } from "graphql-subscriptions";
+import { makeExecutableSchema } from "@graphql-tools/schema";
+import { WebSocketServer } from "ws";
+import { useServer } from "graphql-ws/lib/use/ws";
+
+const PORT = 8080;
+const pubsub = new PubSub();
+
+// Schema definition
+const typeDefs = gql`
+  type Query {
+    currentNumber: Int
+  }
+
+  type Subscription {
+    numberIncremented: Int
+  }
+`;
+
+// Resolver map
+const resolvers = {
+  Query: {
+    currentNumber() {
+      return currentNumber;
+    },
+  },
+  Subscription: {
+    numberIncremented: {
+      subscribe: () => pubsub.asyncIterator(["NUMBER_INCREMENTED"]),
+    },
+  },
+};
+
+// Create schema, which will be used separately by ApolloServer and
+// the WebSocket server.
+const schema = makeExecutableSchema({ typeDefs, resolvers });
+console.log('--schema--', schema)
+// Create an Express app and HTTP server; we will attach the WebSocket
+// server and the ApolloServer to this HTTP server.
+const app = express();
+const httpServer = createServer(app);
+
+// Set up WebSocket server.
+const wsServer = new WebSocketServer({
+  server: httpServer,
+  path: "/graphql",
+});
+const serverCleanup = useServer({ schema }, wsServer);
+
+// Set up ApolloServer.
+const server = new ApolloServer({
+  schema,
+  plugins: [
+    // Proper shutdown for the HTTP server.
+    ApolloServerPluginDrainHttpServer({ httpServer }),
+
+    // Proper shutdown for the WebSocket server.
+    {
+      async serverWillStart() {
+        return {
+          async drainServer() {
+            await serverCleanup.dispose();
+          },
+        };
+      },
+    },
+  ],
+});
+await server.start();
+server.applyMiddleware({ app });
+
+// Now that our HTTP server is fully set up, actually listen.
+httpServer.listen(PORT, () => {
+  console.log(
+    `🚀 Query endpoint ready at http://localhost:${PORT}${server.graphqlPath}`
+  );
+  console.log(
+    `🚀 Subscription endpoint ready at ws://localhost:${PORT}${server.graphqlPath}`
+  );
+});
+
+// In the background, increment a number every second and notify subscribers when
+// it changes.
+let currentNumber = 0;
+function incrementNumber() {
+  currentNumber++;
+  pubsub.publish("NUMBER_INCREMENTED", { numberIncremented: currentNumber });
+  setTimeout(incrementNumber, 10000);
+}
+// Start incrementing
+incrementNumber();

package/lib/generators/add-backend/files/babel.config.js

@@ -0,0 +1,45 @@
+process.env.ENV_FILE !== null && require('dotenv').config({ path: process.env.ENV_FILE });
+
+module.exports = (api) => {
+    const isBabelRegister = api.caller((caller) => caller && caller.name === '@babel/register');
+    const isTest = api.env('test');
+    api.cache(true);
+    if (isTest || isBabelRegister) {
+        return {
+            presets: [
+                '@babel/preset-typescript',
+                '@babel/preset-react',
+                ['@babel/preset-env', { targets: { node: true }, modules: 'commonjs' }],
+            ],
+            plugins: [
+                'babel-plugin-dynamic-import-node',
+                '@babel/plugin-proposal-class-properties',
+                '@babel/plugin-proposal-optional-chaining',
+                'babel-plugin-import-graphql',
+            ],
+        };
+    }
+    return {
+        compact: false,
+        presets: [
+            '@babel/preset-typescript',
+            '@babel/preset-react',
+            ['@babel/preset-env', { targets: { node: true }, modules: false }],
+        ],
+        plugins: [
+            'babel-plugin-dynamic-import-node',
+            '@loadable/babel-plugin',
+            '@babel/plugin-transform-destructuring',
+            '@babel/plugin-transform-runtime',
+            ['@babel/plugin-proposal-decorators', { legacy: true }],
+            '@babel/plugin-proposal-class-properties',
+            '@babel/plugin-proposal-object-rest-spread',
+            '@babel/plugin-proposal-optional-chaining',
+        ],
+        env: {
+            production: {
+                compact: true,
+            },
+        },
+    };
+};

package/lib/generators/add-backend/files/build.config.js

@@ -0,0 +1,14 @@
+process.env.ENV_FILE !== null && require('dotenv').config({ path: process.env.ENV_FILE });
+const config = {
+    ...require('../../build.config'),
+    __CLIENT__: false,
+    __SERVER__: true,
+    __DEV__: process.env.NODE_ENV !== 'production',
+    __TEST__: false,
+    'process.env.NODE_ENV': process.env.NODE_ENV || 'development',
+    __GRAPHQL_URL__: process.env.GRAPHQL_URL || '/graphql',
+    __CDN_URL__: process.env.CDN_URL || '',
+    __FRONTEND_BUILD_DIR__: process.env.FRONTEND_BUILD_DIR || '../frontend-server/dist/web',
+};
+
+module.exports = config;

package/lib/generators/add-backend/files/build.config.mjs

@@ -0,0 +1,27 @@
+if (process.env.ENV_FILE !== null) {
+    import('dotenv').then(({ config }) => 
+        config({ path: process.env.ENV_FILE })
+    );
+}
+
+const __API_SERVER_PORT__ = process.env.GRAPHQL_URL ? new URL(process.env.GRAPHQL_URL).port : 8080;
+const __SERVER_PROTOCOL__ = 'http';
+const __LOCAL_SERVER_HOST__ = 'localhost';
+const __GRAPHQL_ENDPOINT__ = process.env.GRAPHQL_URL ? new URL(process.env.GRAPHQL_URL).pathname : '/graphql';
+
+const config = {
+    __CLIENT__: false,
+    __SERVER__: true,
+    __DEV__: process.env.NODE_ENV !== 'production',
+    __TEST__: false,
+    'process.env.NODE_ENV': process.env.NODE_ENV || 'development',
+    __GRAPHQL_URL__: process.env.GRAPHQL_URL || '/graphql',
+    __CDN_URL__: process.env.CDN_URL || '',
+    __FRONTEND_BUILD_DIR__: process.env.FRONTEND_BUILD_DIR || '../frontend-server/dist/web',
+    __API_SERVER_PORT__,
+    __GRAPHQL_ENDPOINT__,
+    __LOCAL_SERVER_HOST__,
+    __API_URL__: process.env.API_URL || `${__SERVER_PROTOCOL__}://${__LOCAL_SERVER_HOST__}:${__API_SERVER_PORT__}${__GRAPHQL_ENDPOINT__}`,
+};
+
+export default config;

package/lib/generators/add-backend/files/generated-schema.graphql

@@ -0,0 +1,235 @@
+"""
+Address City Interface
+"""
+interface ICity {
+    id: ID!
+    name: String!
+    state: ITerritorialState!
+    location: GeoLocation
+    createdAt: DateTime!
+    updatedAt: DateTime!
+}
+
+"""
+Address City Create Input
+"""
+input CityInput {
+    """
+    Name of the state to display
+    """
+    name: String!
+    """
+    ID of State to associate
+    """
+    state: TerritorialStateInput!
+}
+
+"""
+Address City Update Input
+"""
+input CityUpdateInput {
+    name: String
+    state: TerritorialStateUpdateInput!
+}
+
+"""
+Pub N Go Property Address City
+"""
+type City implements ICity {
+    id: ID!
+    name: String!
+    state: State!
+    location: GeoLocation
+    createdAt: DateTime!
+    updatedAt: DateTime!
+}
+
+type Cities {
+    totalCount: Int!
+    data: [City]
+}
+
+input CitiesOptions {
+    criteria: AnyObject
+    limit: Int
+    skip: Int
+    sort: Sort
+}
+
+input CitiesInput {
+    countryOptions: CitiesOptions
+    stateOptions: CitiesOptions
+    cityOptions: CitiesOptions
+}
+
+extend type Query {
+    cities(input: CitiesInput): Cities!
+    city(id: ID!): City!
+}
+
+extend type Mutation {
+    createCity(propertyCity: CityInput!): City!
+    updateCity(id: ID!, propertyCity: CityUpdateInput!): City!
+    deleteCity(id: ID!): Boolean!
+}
+
+interface ICountry {
+    id: ID!
+    name: String!
+    phone_code: String!
+    currency: String
+    currency_symbol: String
+    emoji: String
+    location: GeoLocation
+    createdAt: DateTime!
+    updatedAt: DateTime!
+}
+
+type Country implements ICountry {
+    id: ID!
+    name: String!
+    phone_code: String!
+    currency: String
+    currency_symbol: String
+    emoji: String
+    location: GeoLocation
+    states(criteria: AnyObject, limit: Int, skip: Int, sort: Sort): States
+    createdAt: DateTime!
+    updatedAt: DateTime!
+}
+
+input CountryInput {
+    name: String!
+}
+
+type Countries {
+    totalCount: Int!
+    data: [Country]
+}
+
+extend type Query {
+    countries(criteria: AnyObject, limit: Int, skip: Int, sort: Sort): Countries!
+    country(id: ID!): Country!
+    countryByName(name: String!): Country!
+}
+
+extend type Mutation {
+    createCountry(country: CountryInput!): Country!
+    updateCountry(id: ID!, country: CountryInput!): Country!
+    deleteCountry(id: ID!): Boolean!
+}
+
+type Country implements ICountry{
+    id: ID!
+    name: String!
+    phone_code: String!
+    currency: String
+    currency_symbol: String
+    emoji: String
+    location: GeoLocation
+    states(criteria: AnyObject, limit: Int, skip: Int, sort: Sort): States
+    createdAt: DateTime!
+    updatedAt: DateTime!
+}
+
+type Countries {
+    totalCount: Int!
+    data: [Country]
+}
+
+extend type Query {
+    countries(criteria: AnyObject, limit: Int, skip: Int, sort: Sort): Countries!
+    country(id: ID!): Country!
+    countryByName(name: String!): Country!
+}
+
+extend type Mutation {
+    createCountry(country: CountryInput!): Country!
+    updateCountry(id: ID!, country: CountryInput!): Country!
+    deleteCountry(id: ID!): Boolean!
+}
+"""
+Territorial State
+"""
+interface ITerritorialState {
+    id: ID!
+    name: String!
+    country: ICountry!
+    location: GeoLocation
+    createdAt: DateTime!
+    updatedAt: DateTime!
+}
+
+"""
+Address State Create Input
+"""
+input TerritorialStateInput {
+    """
+    Name of the country to display
+    """
+    name: String!
+    """
+    ID of Country to associate
+    """
+    country: String!
+}
+
+"""
+Address State Update Input
+"""
+input TerritorialStateUpdateInput {
+    name: String
+    country: Int!
+}
+
+
+"""
+Address State
+"""
+type State implements ITerritorialState{
+    id: ID!
+    name: String!
+    country: Country!
+    cities(criteria: AnyObject, limit: Int, skip: Int, sort: Sort): Cities!
+    location: GeoLocation
+    createdAt: DateTime!
+    updatedAt: DateTime!
+}
+
+"""
+Address State Create Input
+"""
+input StateInput {
+    """
+    Name of the country to display
+    """
+    name: String!
+    """
+    ID of Country to associate
+    """
+    country: String!
+}
+
+"""
+Address State Update Input
+"""
+input StateUpdateInput {
+    name: String
+    country: String!
+}
+
+type States {
+    totalCount: Int!
+    data: [State]
+}
+
+extend type Query {
+    states(criteria: AnyObject, limit: Int, skip: Int, sort: Sort): States!
+    state(id: ID!): State!
+}
+
+extend type Mutation {
+    createState(state: StateInput!): State!
+    updateState(id: ID!, state: StateUpdateInput!): State!
+    deleteState(id: ID!): Boolean!
+}

package/lib/generators/add-backend/files/jest.config.js

@@ -0,0 +1,27 @@
+module.exports = {
+    testMatch: [
+        '<rootDir>/modules/**/server-ts/**/*.test.[jt]s?(x)',
+        '<rootDir>/modules/**/common-react/**/*.test.[jt]s?(x)',
+    ],
+    globalSetup: '<rootDir>/packages/server/src/__tests__/jestSetup.js',
+    rootDir: '../..',
+    resolver: './packages/server/jest.resolver',
+    transform: {
+        '\\.(gql|graphql)$': 'jest-transform-graphql',
+        'locales[\\/]index.[jt]s': '<rootDir>/jest-transform-i18next',
+        '.*': 'babel-jest',
+    },
+    moduleNameMapper: {
+        '^.+\\.(css|less|scss)$': 'babel-jest',
+    },
+    globals: {
+        __CLIENT__: false,
+        __SERVER__: true,
+        __DEV__: true,
+        __TEST__: true,
+        __SSR__: false,
+        __FRONTEND_BUILD_DIR__: `${__dirname}/../client/build`,
+        __API_URL__: '/graphql',
+    },
+    testEnvironment: 'node',
+};

package/lib/generators/add-backend/files/knexfile.js

@@ -0,0 +1,63 @@
+// Update with your config settings.
+var path = require('path');
+require('dotenv').config({ path: process.env.ENV_FILE });
+
+var connection = {
+  host: process.env.DB_HOST,
+  user: process.env.DB_USER,
+  socketPath: process.env.DB_SOCKET_PATH,
+  password: process.env.DB_PASSWORD,
+  database: process.env.DB_DATABASE,
+  multipleStatements: true,
+  charset: 'utf8',
+};
+var DB_CLIENT = process.env.DB_TYPE || 'sqlite3';
+
+var migrations_path = path.dirname(require.resolve('@adminide-stack/store/lib/store/migrations/index'));
+var seeds_path = path.dirname(require.resolve('@adminide-stack/store/lib/store/seeds/index'));
+module.exports = {
+
+  development: {
+    client: 'sqlite3',
+    connection: {
+      filename: './dev-db.sqlite3'
+    },
+    seeds: {
+      directory: seeds_path,
+    },
+    migrations: {
+      directory: migrations_path,
+    },
+    useNullAsDefault: true,
+  },
+
+  test: {
+    client: DB_CLIENT,
+    connection: connection,
+    pool: {
+      min: 2,
+      max: 10
+    },
+    seeds: {
+      directory: seeds_path,
+    },
+    migrations: {
+      directory: migrations_path,
+    },
+    useNullAsDefault: true,
+  },
+
+  production: {
+    client: DB_CLIENT,
+    connection: connection,
+    pool: {
+      min: 2,
+      max: 200
+    },
+    migrations: {
+      directory: migrations_path,
+    },
+    useNullAsDefault: true,
+  }
+
+};