@aleleba/create-node-ts-graphql-server 1.2.10 → 1.3.0

package/README.md

@@ -4,7 +4,7 @@ This project aims to have a starter kit for creating a new Node with typescript,
 
 Tech(Library or Framework) | Version |
 --- | --- |
-Jest (Testing) | 29.4.3
+Jest (Testing) | 29.5.0
 Typescript | 4.9.5
 GraphQL | 16.6.0
 

package/jest.config.js

@@ -1,6 +1,15 @@
+const { pathsToModuleNameMapper } = require('ts-jest');
+const { compilerOptions } = require('./tsconfig');
+
+const aliases = pathsToModuleNameMapper(compilerOptions.paths, {
+	prefix: '<rootDir>'
+});
+
 module.exports = {
     testEnvironment: 'node',
     transform: {
       "^.+\\.ts$": "ts-jest"
+    },moduleNameMapper: {
+      ...aliases,
     },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aleleba/create-node-ts-graphql-server",
-  "version": "1.2.10",
+  "version": "1.3.0",
   "description": "Node with Typescript and GraphQL Server",
   "bin": "./bin/cli.js",
   "main": "index.js",
@@ -44,7 +44,7 @@
     "graphql-playground-middleware-express": "^1.7.23",
     "graphql-subscriptions": "^2.0.0",
     "graphql-tools": "^8.3.18",
-    "graphql-ws": "^5.11.3",
+    "graphql-ws": "^5.12.0",
     "web-push": "^3.5.0",
     "ws": "^8.12.1"
   },
@@ -53,10 +53,16 @@
     "@babel/preset-env": "^7.20.2",
     "@babel/preset-typescript": "^7.21.0",
     "@babel/register": "^7.21.0",
+    "@types/body-parser": "^1.19.2",
+    "@types/cookie-parser": "^1.4.3",
+    "@types/cors": "^2.8.13",
+    "@types/express": "^4.17.17",
     "@types/jest": "^29.4.0",
-    "@types/node": "^18.14.4",
+    "@types/node": "^18.14.6",
+    "@types/supertest": "^2.0.12",
     "@types/webpack": "^5.28.0",
     "@types/webpack-node-externals": "^3.0.0",
+    "@types/ws": "^8.5.4",
     "@typescript-eslint/eslint-plugin": "^5.54.0",
     "@typescript-eslint/parser": "^5.54.0",
     "babel-loader": "^9.1.2",
@@ -64,8 +70,9 @@
     "compression-webpack-plugin": "^10.0.0",
     "eslint": "^8.35.0",
     "eslint-webpack-plugin": "^4.0.0",
-    "jest": "^29.4.3",
-    "nodemon": "^2.0.20",
+    "jest": "^29.5.0",
+    "nodemon": "^2.0.21",
+    "resolve-ts-aliases": "^1.0.1",
     "supertest": "^6.3.3",
     "ts-jest": "^29.0.5",
     "ts-loader": "^9.4.2",

package/src/GraphQL/resolvers/index.ts

@@ -1,22 +1,22 @@
 'use strict';
 
-import { getTest, addText } from '../../controllers/controllerGraphQL';
+import { getTest, addText } from '@controllerGraphQL';
 
 // A map of functions which return data for the schema.
 const resolvers = {
 	Query: {
 		// eslint-disable-next-line
-		test: (rootValue, args, context) => ({}),
+		test: (rootValue: any, args: any, context: any) => ({}),
 	},
 	Mutation: {
 		// eslint-disable-next-line
-		testMutation: (rootValue, args, context) => ({}),
+		testMutation: (rootValue: any, args: any, context: any) => ({}),
 	},
 	Test: {
-		test: (rootValue, args, context) => getTest({rootValue, args, context})
+		test: (rootValue: any, args: any, context: any) => getTest({rootValue, args, context})
 	},
 	TestMutation: {
-		testMutation: (rootValue, args, context) => addText({rootValue, args, context})
+		testMutation: (rootValue: any, args: any, context: any) => addText({rootValue, args, context})
 	}
 };
 

package/src/GraphQL/schema/index.ts

@@ -1,6 +1,6 @@
 import { makeExecutableSchema } from '@graphql-tools/schema';
-import resolvers from'../resolvers';
-import Test from './Test.gql';
+import resolvers from'@GraphQL/resolvers';
+import Test from '@GraphQL/schema/Test.gql';
 
 // The GraphQL schema
 const rootTypes = `

package/src/GraphQL/server.ts

@@ -1,8 +1,8 @@
 'use strict';
 import express from 'express'; //express
 import { graphqlHTTP } from 'express-graphql';
-import { config } from '../../config';
-import schema from './schema';
+import { config } from '@config';
+import schema from '@GraphQL/schema';
 
 const server = express.Router();//Router de Express
 
@@ -21,8 +21,9 @@ server.use(
 
 // DO NOT DO app.listen() unless we're testing this directly
 if (require.main === module) {
-	server.listen((process.env.PORT || 4000), () => {
-		console.log(`Iniciando Express en el puerto 4000${server.graphqlPath}`); /*${app.get('port')}*/
+	const app = express();
+	app.listen((process.env.PORT || 4000), () => {
+		console.log(`Iniciando Express en el puerto 4000`); /*${app.get('port')}*/
 	});
 }
 

package/src/controllers/controllerGraphQL/index.ts

@@ -1,14 +1,18 @@
 'use strict';
 
-import { getTestModel, addTextModel } from '../../models';
+import { getTestModel, addTextModel } from '@models';
 
 // eslint-disable-next-line
-export const getTest = async ({rootValue, args, context}) => {
+export const getTest = async ({}) => {
 	return getTestModel();
 };
 
 // eslint-disable-next-line
-export const addText = async ({rootValue, args, context}) => {
+export const addText = async ({args}: {
+	rootValue: any
+	args: { text: string }
+	context: any
+}) => {
 	const text = args.text;
 	return addTextModel({ text });
 };

package/src/index.ts

@@ -6,17 +6,17 @@ import cors from 'cors';
 import cookieParser from 'cookie-parser';
 import { useServer } from 'graphql-ws/lib/use/ws';
 import { execute, subscribe } from 'graphql';
-import GraphQLserver from './GraphQL/server';// Server of GraphQL,
+import GraphQLserver from '@GraphQL/server';// Server of GraphQL,
 import expressPlayground from 'graphql-playground-middleware-express';
-import schema from './GraphQL/schema';
-import { config } from '../config';
-import apiRouter from './routes';
+import schema from '@GraphQL/schema';
+import { config } from '@config';
+import apiRouter from '@routes';
 
 const app = express(), //creating app
 	whitelist = config.WHITELIST_URLS,
 	corsOptions = {
-		origin: function (origin, callback) {
-			if (whitelist.indexOf(origin) !== -1 || !origin) {
+		origin: function (origin: string | undefined, callback: (arg0: Error | null, arg1?: boolean) => void) {
+			if (whitelist.indexOf(origin as string) !== -1 || !origin) {
 				callback(null, true);
 			} else {
 				callback(new Error('Not allowed by CORS'));
@@ -29,7 +29,7 @@ const app = express(), //creating app
 app
 	.use(cookieParser())
 	.use(express.urlencoded({limit: '500mb', extended: true}))
-	.use(express.json({limit: '500mb', extended: true}))
+	.use(express.json({limit: '500mb'}))
 	.use(cors(corsOptions))
 	.use(apiRouter)//Routes de App
 	.use('/graphql', GraphQLserver);//Server of Graphql

package/src/models/index.ts

@@ -4,6 +4,6 @@ export const getTestModel = async () => {
 	return 'This is the text response for Test Query from a model';
 };
 
-export const addTextModel = async ({ text }) => {
+export const addTextModel = async ({ text }: {text: string}) => {
 	return `Simulate to insert some text: ${text} from a model`;
 };

package/src/tests/server/index.test.ts

@@ -1,11 +1,11 @@
-import server from '../../index';
+import server from '@src';
 import supertest from 'supertest';
 describe('global server tests', () => {
-    let request;
+    let request: supertest.SuperTest<supertest.Test>;
     beforeEach(() => {
         request = supertest(server);
       });
-    test('should return Test data from test Query', async () => {
+    it('should return Test data from test Query', async () => {
         const bodyResponse = {
             data: {
               test: { test: 'This is the text response for Test Query from a model' }
@@ -18,7 +18,7 @@ describe('global server tests', () => {
         expect(response.body).toEqual(bodyResponse);
     });
 
-    test('should return Test data from test Mutation', async () => {
+    it('should return Test data from test Mutation', async () => {
         const bodyResponse = {
             data: {
                 testMutation: {

package/tsconfig.json

@@ -6,6 +6,25 @@
       "moduleResolution": "node",
       "sourceMap": true,
       "typeRoots" : ["./src/@types", "./node_modules/@types"],
+      "strict": true,
+      "forceConsistentCasingInFileNames": true,
+      "baseUrl": ".",
+      "paths": {
+        "@src/*": ["src/*"],
+        "@src": ["src"],
+        "@routes*": ["src/routes/*"],
+        "@routes": ["src/routes"],
+        "@controllers/*": ["src/controllers/*"],
+        "@controllers": ["src/controllers"],
+        "@models/*": ["src/models/*"],
+        "@models": ["src/models"],
+        "@controllerGraphQL/*": ["src/controllers/controllerGraphQL/*"],
+        "@controllerGraphQL": ["src/controllers/controllerGraphQL"],
+        "@GraphQL/*": ["src/GraphQL/*"],
+        "@GraphQL": ["src/GraphQL"],
+        "@config/*": ["config/*"],
+        "@config": ["config"]
+      }
     },
     "lib": ["es2015"]
 }

package/webpack.config.dev.ts

@@ -4,11 +4,13 @@ import { CleanWebpackPlugin } from 'clean-webpack-plugin';
 import ESLintPlugin from 'eslint-webpack-plugin';
 import nodeExternals from 'webpack-node-externals';
 import WebpackShellPluginNext from 'webpack-shell-plugin-next';
+import { resolveTsAliases } from 'resolve-ts-aliases';
 import { deFaultValues } from './config';
 
 const ROOT_DIR = path.resolve(__dirname);
-const resolvePath = (...args) => path.resolve(ROOT_DIR, ...args);
+const resolvePath = (...args: string[]) => path.resolve(ROOT_DIR, ...args);
 const BUILD_DIR = resolvePath('build');
+const alias = resolveTsAliases(path.resolve('tsconfig.json'));
 
 const config = {
 	entry: './src/index.ts',
@@ -21,13 +23,7 @@ const config = {
 	},
 	resolve: {
 		extensions: ['.js', '.ts', '.json', '.gql'],
-		alias: {
-			'@controllers': path.resolve(__dirname, 'controllers/'),
-            '@models': path.resolve(__dirname, 'models/'),
-            '@controllerGraphQL': path.resolve(__dirname, 'controllers/controllerGraphQL/'),
-            '@GraphQL': path.resolve(__dirname, 'GraphQL/'),
-            '@config': path.resolve(__dirname, 'config/'),
-		}
+		alias,
 	},
 	mode: 'development',
 	module: {

package/webpack.config.ts

@@ -4,11 +4,13 @@ import TerserPlugin from 'terser-webpack-plugin';
 import { CleanWebpackPlugin } from 'clean-webpack-plugin';
 import ESLintPlugin from 'eslint-webpack-plugin';
 import nodeExternals from 'webpack-node-externals';
+import { resolveTsAliases } from 'resolve-ts-aliases';
 import { deFaultValues } from './config';
 
 const ROOT_DIR = path.resolve(__dirname);
-const resolvePath = (...args) => path.resolve(ROOT_DIR, ...args);
+const resolvePath = (...args: string[]) => path.resolve(ROOT_DIR, ...args);
 const BUILD_DIR = resolvePath('build');
+const alias = resolveTsAliases(path.resolve('tsconfig.json'));
 
 const config = {
 	entry: './src/index.ts',
@@ -20,13 +22,7 @@ const config = {
 	},
 	resolve: {
 		extensions: ['.js', '.ts', '.json', '.gql'],
-		alias: {
-			'@controllers': path.resolve(__dirname, 'controllers/'),
-            '@models': path.resolve(__dirname, 'models/'),
-            '@controllerGraphQL': path.resolve(__dirname, 'controllers/controllerGraphQL/'),
-            '@GraphQL': path.resolve(__dirname, 'GraphQL/'),
-            '@config': path.resolve(__dirname, 'config/'),
-		}
+		alias,
 	},
 	mode: 'production',
 	module: {