From 3f49d880c8ea1ce0d2a7d8f7196b17d5de9d09e4 Mon Sep 17 00:00:00 2001 From: Pau Costa Date: Sat, 16 Nov 2024 20:01:08 +0100 Subject: [PATCH 1/2] feat: adds common logic module --- app/package-lock.json | 13 ++++ app/package.json | 1 + app/src/main.ts | 5 +- common_logic/index.ts | 3 + common_logic/package-lock.json | 45 ++++++++++++++ common_logic/package.json | 17 +++++ common_logic/tsconfig.json | 110 +++++++++++++++++++++++++++++++++ web/package-lock.json | 13 ++++ web/package.json | 1 + 9 files changed, 207 insertions(+), 1 deletion(-) create mode 100644 common_logic/index.ts create mode 100644 common_logic/package-lock.json create mode 100644 common_logic/package.json create mode 100644 common_logic/tsconfig.json diff --git a/app/package-lock.json b/app/package-lock.json index ffa3454..060f545 100644 --- a/app/package-lock.json +++ b/app/package-lock.json @@ -14,6 +14,7 @@ "@nestjs/platform-express": "^10.0.0", "@nestjs/platform-socket.io": "^10.4.7", "@nestjs/websockets": "^10.4.7", + "common_logic": "file:../common_logic", "reflect-metadata": "^0.2.0", "rxjs": "^7.8.1" }, @@ -41,6 +42,14 @@ "typescript": "^5.1.3" } }, + "../common_logic": { + "version": "1.0.0", + "license": "ISC", + "devDependencies": { + "@types/node": "^22.9.0", + "typescript": "^5.6.3" + } + }, "node_modules/@ampproject/remapping": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.3.0.tgz", @@ -3540,6 +3549,10 @@ "node": ">= 6" } }, + "node_modules/common_logic": { + "resolved": "../common_logic", + "link": true + }, "node_modules/component-emitter": { "version": "1.3.1", "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.3.1.tgz", diff --git a/app/package.json b/app/package.json index a889c6f..9e197fc 100644 --- a/app/package.json +++ b/app/package.json @@ -24,6 +24,7 @@ "@nestjs/platform-express": "^10.0.0", "@nestjs/platform-socket.io": "^10.4.7", "@nestjs/websockets": "^10.4.7", + "common_logic": "file:../common_logic", "reflect-metadata": "^0.2.0", "rxjs": "^7.8.1" }, diff --git a/app/src/main.ts b/app/src/main.ts index 48b193f..19a5915 100644 --- a/app/src/main.ts +++ b/app/src/main.ts @@ -1,8 +1,11 @@ import { NestFactory } from '@nestjs/core'; import { AppModule } from './app.module'; +import { printMsg } from 'common_logic'; async function bootstrap() { const app = await NestFactory.create(AppModule); - await app.listen(process.env.PORT ?? 3010); + const port = process.env.PORT ?? 3010; + await app.listen(port); + printMsg(`App listening on port ${port}`); } bootstrap(); diff --git a/common_logic/index.ts b/common_logic/index.ts new file mode 100644 index 0000000..863d561 --- /dev/null +++ b/common_logic/index.ts @@ -0,0 +1,3 @@ +export function printMsg(msg: string){ + console.log(msg); +} \ No newline at end of file diff --git a/common_logic/package-lock.json b/common_logic/package-lock.json new file mode 100644 index 0000000..23ae191 --- /dev/null +++ b/common_logic/package-lock.json @@ -0,0 +1,45 @@ +{ + "name": "common_logic", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "common_logic", + "version": "1.0.0", + "license": "ISC", + "devDependencies": { + "@types/node": "^22.9.0", + "typescript": "^5.6.3" + } + }, + "node_modules/@types/node": { + "version": "22.9.0", + "resolved": "https://registry.npmjs.org/@types/node/-/node-22.9.0.tgz", + "integrity": "sha512-vuyHg81vvWA1Z1ELfvLko2c8f34gyA0zaic0+Rllc5lbCnbSyuvb2Oxpm6TAUAC/2xZN3QGqxBNggD1nNR2AfQ==", + "dev": true, + "dependencies": { + "undici-types": "~6.19.8" + } + }, + "node_modules/typescript": { + "version": "5.6.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.3.tgz", + "integrity": "sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/undici-types": { + "version": "6.19.8", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.19.8.tgz", + "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==", + "dev": true + } + } +} diff --git a/common_logic/package.json b/common_logic/package.json new file mode 100644 index 0000000..596ad86 --- /dev/null +++ b/common_logic/package.json @@ -0,0 +1,17 @@ +{ + "name": "common_logic", + "version": "1.0.0", + "description": "A collection of common functions for the trains and roads project.", + "main": "dist/index.js", + "types": "dist/index.d.ts", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1", + "build": "tsc" + }, + "author": "", + "license": "ISC", + "devDependencies": { + "@types/node": "^22.9.0", + "typescript": "^5.6.3" + } +} diff --git a/common_logic/tsconfig.json b/common_logic/tsconfig.json new file mode 100644 index 0000000..3e5b4c6 --- /dev/null +++ b/common_logic/tsconfig.json @@ -0,0 +1,110 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "commonjs", /* Specify what module code is generated. */ + "rootDir": "./", /* Specify the root folder within your source files. */ + // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "noUncheckedSideEffectImports": true, /* Check side effect imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + "outDir": "./dist", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +} diff --git a/web/package-lock.json b/web/package-lock.json index 4d7684b..f6dd53e 100644 --- a/web/package-lock.json +++ b/web/package-lock.json @@ -16,6 +16,7 @@ "@types/node": "^16.18.119", "@types/react": "^18.3.12", "@types/react-dom": "^18.3.1", + "common_logic": "file:../common_logic", "react": "^18.3.1", "react-dom": "^18.3.1", "react-scripts": "5.0.1", @@ -25,6 +26,14 @@ "web-vitals": "^2.1.4" } }, + "../common_logic": { + "version": "1.0.0", + "license": "ISC", + "devDependencies": { + "@types/node": "^22.9.0", + "typescript": "^5.6.3" + } + }, "node_modules/@adobe/css-tools": { "version": "4.4.0", "resolved": "https://registry.npmjs.org/@adobe/css-tools/-/css-tools-4.4.0.tgz", @@ -6133,6 +6142,10 @@ "node": ">= 12" } }, + "node_modules/common_logic": { + "resolved": "../common_logic", + "link": true + }, "node_modules/common-tags": { "version": "1.8.2", "resolved": "https://registry.npmjs.org/common-tags/-/common-tags-1.8.2.tgz", diff --git a/web/package.json b/web/package.json index 8a1e01c..a0d6d26 100644 --- a/web/package.json +++ b/web/package.json @@ -11,6 +11,7 @@ "@types/node": "^16.18.119", "@types/react": "^18.3.12", "@types/react-dom": "^18.3.1", + "common_logic": "file:../common_logic", "react": "^18.3.1", "react-dom": "^18.3.1", "react-scripts": "5.0.1", From f1c284915ebebfd0fd3f65cf96297c82f5d7ddb9 Mon Sep 17 00:00:00 2001 From: MiguelMLorente Date: Sat, 16 Nov 2024 20:57:06 +0100 Subject: [PATCH 2/2] Moved to interface and create real enum type --- app/package-lock.json | 12 ++++++------ app/package.json | 2 +- app/src/main.ts | 2 -- common_logic/index.ts | 3 --- interface/constants/TrackType.ts | 4 ++++ interface/index.ts | 1 + {common_logic => interface}/package-lock.json | 0 {common_logic => interface}/package.json | 2 +- {common_logic => interface}/tsconfig.json | 0 web/package-lock.json | 12 ++++++------ web/package.json | 2 +- 11 files changed, 20 insertions(+), 20 deletions(-) delete mode 100644 common_logic/index.ts create mode 100644 interface/constants/TrackType.ts create mode 100644 interface/index.ts rename {common_logic => interface}/package-lock.json (100%) rename {common_logic => interface}/package.json (93%) rename {common_logic => interface}/tsconfig.json (100%) diff --git a/app/package-lock.json b/app/package-lock.json index 060f545..001b2e9 100644 --- a/app/package-lock.json +++ b/app/package-lock.json @@ -14,7 +14,7 @@ "@nestjs/platform-express": "^10.0.0", "@nestjs/platform-socket.io": "^10.4.7", "@nestjs/websockets": "^10.4.7", - "common_logic": "file:../common_logic", + "interface": "file:../interface", "reflect-metadata": "^0.2.0", "rxjs": "^7.8.1" }, @@ -42,7 +42,7 @@ "typescript": "^5.1.3" } }, - "../common_logic": { + "../interface": { "version": "1.0.0", "license": "ISC", "devDependencies": { @@ -3549,10 +3549,6 @@ "node": ">= 6" } }, - "node_modules/common_logic": { - "resolved": "../common_logic", - "link": true - }, "node_modules/component-emitter": { "version": "1.3.1", "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.3.1.tgz", @@ -5284,6 +5280,10 @@ "node": ">=12.0.0" } }, + "node_modules/interface": { + "resolved": "../interface", + "link": true + }, "node_modules/ipaddr.js": { "version": "1.9.1", "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", diff --git a/app/package.json b/app/package.json index 9e197fc..c4cc9fd 100644 --- a/app/package.json +++ b/app/package.json @@ -24,7 +24,7 @@ "@nestjs/platform-express": "^10.0.0", "@nestjs/platform-socket.io": "^10.4.7", "@nestjs/websockets": "^10.4.7", - "common_logic": "file:../common_logic", + "interface": "file:../interface", "reflect-metadata": "^0.2.0", "rxjs": "^7.8.1" }, diff --git a/app/src/main.ts b/app/src/main.ts index 19a5915..5589d5f 100644 --- a/app/src/main.ts +++ b/app/src/main.ts @@ -1,11 +1,9 @@ import { NestFactory } from '@nestjs/core'; import { AppModule } from './app.module'; -import { printMsg } from 'common_logic'; async function bootstrap() { const app = await NestFactory.create(AppModule); const port = process.env.PORT ?? 3010; await app.listen(port); - printMsg(`App listening on port ${port}`); } bootstrap(); diff --git a/common_logic/index.ts b/common_logic/index.ts deleted file mode 100644 index 863d561..0000000 --- a/common_logic/index.ts +++ /dev/null @@ -1,3 +0,0 @@ -export function printMsg(msg: string){ - console.log(msg); -} \ No newline at end of file diff --git a/interface/constants/TrackType.ts b/interface/constants/TrackType.ts new file mode 100644 index 0000000..4e68f01 --- /dev/null +++ b/interface/constants/TrackType.ts @@ -0,0 +1,4 @@ +export enum TrackType { + RAIL = "RAIL", + ROAD = "ROAD" +}; diff --git a/interface/index.ts b/interface/index.ts new file mode 100644 index 0000000..f4c0cdf --- /dev/null +++ b/interface/index.ts @@ -0,0 +1 @@ +export * from "./constants/TrackType" \ No newline at end of file diff --git a/common_logic/package-lock.json b/interface/package-lock.json similarity index 100% rename from common_logic/package-lock.json rename to interface/package-lock.json diff --git a/common_logic/package.json b/interface/package.json similarity index 93% rename from common_logic/package.json rename to interface/package.json index 596ad86..0233457 100644 --- a/common_logic/package.json +++ b/interface/package.json @@ -1,5 +1,5 @@ { - "name": "common_logic", + "name": "interface", "version": "1.0.0", "description": "A collection of common functions for the trains and roads project.", "main": "dist/index.js", diff --git a/common_logic/tsconfig.json b/interface/tsconfig.json similarity index 100% rename from common_logic/tsconfig.json rename to interface/tsconfig.json diff --git a/web/package-lock.json b/web/package-lock.json index f6dd53e..c572af6 100644 --- a/web/package-lock.json +++ b/web/package-lock.json @@ -16,7 +16,7 @@ "@types/node": "^16.18.119", "@types/react": "^18.3.12", "@types/react-dom": "^18.3.1", - "common_logic": "file:../common_logic", + "interface": "file:../interface", "react": "^18.3.1", "react-dom": "^18.3.1", "react-scripts": "5.0.1", @@ -26,7 +26,7 @@ "web-vitals": "^2.1.4" } }, - "../common_logic": { + "../interface": { "version": "1.0.0", "license": "ISC", "devDependencies": { @@ -6142,10 +6142,6 @@ "node": ">= 12" } }, - "node_modules/common_logic": { - "resolved": "../common_logic", - "link": true - }, "node_modules/common-tags": { "version": "1.8.2", "resolved": "https://registry.npmjs.org/common-tags/-/common-tags-1.8.2.tgz", @@ -9667,6 +9663,10 @@ "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==", "license": "ISC" }, + "node_modules/interface": { + "resolved": "../interface", + "link": true + }, "node_modules/internal-slot": { "version": "1.0.7", "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.7.tgz", diff --git a/web/package.json b/web/package.json index a0d6d26..6a469ba 100644 --- a/web/package.json +++ b/web/package.json @@ -11,7 +11,7 @@ "@types/node": "^16.18.119", "@types/react": "^18.3.12", "@types/react-dom": "^18.3.1", - "common_logic": "file:../common_logic", + "interface": "file:../interface", "react": "^18.3.1", "react-dom": "^18.3.1", "react-scripts": "5.0.1",