@mshima/generator-jhipster-nodejs 0.0.0-stage → 0.0.2

package/generators/node-server/templates/server/src/users/user.service.ts.ejs

@@ -0,0 +1,156 @@
+import { Injectable<% if (generateUserManagement) { %>, Logger<% } %> } from '@nestjs/common';
+<%_ if (generateUserManagement) { _%>
+import { Cron } from '@nestjs/schedule';
+<%_ } _%>
+import { InjectRepository } from '@nestjs/typeorm';
+import { EntityMetadata, FindManyOptions, FindOneOptions, <% if (generateUserManagement && typeormRelationsSupport) { %>IsNull, LessThan, Not, <% } %>Repository } from 'typeorm';
+import { <%= user.persistClass %> } from './user.entity.ts';
+import { PublicUserDTO, <%= user.dtoClass%> } from './dto/user.dto.ts';
+import { UserMapper } from './user.mapper.ts';
+<%_ if (databaseTypeMongodb) { _%>
+import { documentOrder } from '../common/sortable-properties.ts';
+<%_ } _%>
+import { User } from './user.entity.ts';
+<%_ if (generateUserManagement) { _%>
+import { PasswordService } from '../auth/password.service.ts';
+<%_ } _%>
+
+<%_ if (typeormRelationsSupport) { _%>
+const relations = { authorities: true } as const;
+
+<%_ } _%>
+@Injectable()
+export class UserService {
+<%_ if (generateUserManagement) { _%>
+    logger = new Logger('UserService');
+
+<%_ } _%>
+    constructor(
+        @InjectRepository(User) private userRepository: Repository<User>,
+<%_ if (generateUserManagement) { _%>
+        private readonly passwordService: PasswordService,
+<%_ } _%>
+    ) {}
+
+    /** The TypeORM metadata of the user, the sort of the user lists is validated with. */
+    get metadata(): EntityMetadata {
+        return this.userRepository.metadata;
+    }
+
+    async findById(id: <%= user.primaryKey.tsType %>): Promise<<%= user.dtoClass%> | undefined> {
+        const result = await this.userRepository.findOneBy({ id });
+        return UserMapper.fromEntityToDTO(this.flatAuthorities(result))
+    }
+
+    async findByFields(options: FindOneOptions<<%= user.dtoClass%>>): Promise<<%= user.dtoClass%> | undefined> {
+        const result = await this.userRepository.findOne(
+<%_ if (typeormRelationsSupport) { _%>
+          { ...options, relations },
+<%_ } else { _%>
+          options,
+<%_ } _%>
+        );
+        return UserMapper.fromEntityToDTO(this.flatAuthorities(result));
+    }
+
+    async find(options: FindManyOptions<<%= user.dtoClass%>>): Promise<<%= user.dtoClass%> | undefined> {
+        const result = await this.userRepository.findOne(options);
+        return UserMapper.fromEntityToDTO(this.flatAuthorities(result));
+    }
+
+    async findAndCount(options: FindManyOptions<<%= user.dtoClass%>>): Promise<[<%= user.dtoClass%>[], number]> {
+        const resultList = await this.userRepository.findAndCount(
+<%_ if (typeormRelationsSupport) { _%>
+          { ...options, relations },
+<%_ } else { _%>
+          { ...options, order: documentOrder(this.metadata, options.order) },
+<%_ } _%>
+        );
+        const usersDTO: <%= user.dtoClass%>[] = [];
+        if (resultList && resultList[0]) {
+            resultList[0].forEach(user => usersDTO.push(UserMapper.fromEntityToDTO(this.flatAuthorities(user))));
+            resultList[0] = usersDTO;
+        }
+        return resultList;
+    }
+
+    /** The users of the public user list, like JHipster Spring Boot: the activated ones, by their id and login only. */
+    async findPublicUsers(options: FindManyOptions<<%= user.persistClass %>>): Promise<[PublicUserDTO[], number]> {
+        const [users, count] = await this.userRepository.findAndCount({
+          ...options,
+<%_ if (databaseTypeMongodb) { _%>
+          order: documentOrder(this.metadata, options.order),
+<%_ } _%>
+          where: { activated: true },
+        });
+        return [users.map(user => ({ id: user.<%- user.primaryKey.name %>!, login: user.login })), count];
+    }
+
+    async save(userDTO: <%= user.dtoClass%>, creator?: string<% if (generateUserManagement) { %>, updatePassword = false<% } %>): Promise<<%= user.dtoClass%>> {
+        const user = this.convertInAuthorities(UserMapper.fromDTOtoEntity(userDTO));
+<%_ if (generateUserManagement) { _%>
+        if (updatePassword) {
+            await this.passwordService.transform(user);
+        }
+<%_ } _%>
+        if (creator) {
+            if (!user.createdBy ) {
+                user.createdBy = creator;
+            }
+            user.lastModifiedBy = creator;
+        }
+        const result = await this.userRepository.save(user);
+        return UserMapper.fromEntityToDTO(this.flatAuthorities(result));
+    }
+
+    async update(userDTO: <%= user.dtoClass%>, updater?: string): Promise<<%= user.dtoClass%>> {
+        return this.save(userDTO, updater);
+    }
+
+    async delete(userDTO: <%= user.dtoClass%>): Promise<<%= user.dtoClass%> | undefined> {
+        const user = UserMapper.fromDTOtoEntity(userDTO);
+        const result = await this.userRepository.remove(user)
+        return UserMapper.fromEntityToDTO(result);
+    }
+
+<%_ if (generateUserManagement) { _%>
+    /**
+     * Like JHipster Spring Boot, removes every day, at 01:00, the users registered more than 3 days ago and still not
+     * activated: their login and mail are free again.
+     */
+    @Cron('0 0 1 * * *')
+    async removeNotActivatedUsers(): Promise<void> {
+        const registeredBefore = new Date(Date.now() - 3 * 24 * 60 * 60 * 1000);
+        const users = await this.userRepository.find({
+<%_ if (typeormRelationsSupport) { _%>
+            where: { activated: false, activationKey: Not(IsNull()), createdDate: LessThan(registeredBefore) },
+<%_ } else { _%>
+            // The operators of MongoDB: TypeORM does not translate its find operators (LessThan) for it.
+            where: { activated: false, activationKey: { $ne: null }, createdDate: { $lt: registeredBefore } } as any,
+<%_ } _%>
+        });
+        for (const user of users) {
+            this.logger.debug(`Deleting not activated user ${user.login}`);
+            await this.userRepository.remove(user);
+        }
+    }
+
+<%_ } _%>
+    private flatAuthorities<T extends <%= user.persistClass %> | null>(user: T): T {
+        if (user && user.authorities) {
+            const authorities: string[] = [];
+            user.authorities.forEach((authority: { name: string }) => authorities.push(authority.name));
+            user.authorities = authorities as any[];
+        }
+        return user;
+    }
+
+    private convertInAuthorities(user: any): <%= user.persistClass %> {
+        if (user && user.authorities) {
+            const authorities: any[] = [];
+            user.authorities.forEach((authority: string) => authorities.push({ name: authority }));
+            user.authorities = authorities;
+        }
+        return user;
+    }
+}

package/generators/node-server/templates/server/tsconfig.build.json.ejs

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    // Emits dist/main.js; TypeScript 6 no longer infers it from the included files.
+    "rootDir": "src"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["**/*spec.ts"]
+}

package/generators/node-server/templates/server/tsconfig.json.ejs

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2022"],
+    // ES modules ("type": "module"), resolved like Node.js does.
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true,
+    // Relative imports name the TypeScript file (./app.module.ts), emitted as the JavaScript one (./app.module.js), like
+    // the TypeScript files Node.js runs directly.
+    "rewriteRelativeImportExtensions": true,
+    // The ambient types (TypeScript 6 includes none by default); the specs import the test API from vitest.
+    "types": ["node"],
+    "outDir": "dist",
+    "sourceMap": true,
+    "skipLibCheck": true,
+    "strict": true,
+    // Required by the NestJS decorators and dependency injection.
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true
+  },
+  "include": ["src/**/*", "**/*spec.ts", "e2e/setup.test.js", "ormconfig.ts", <% if (databaseTypeSql) { %>"typeorm-migration.ts", <% } %>"vitest.config*.ts"]
+}

package/generators/node-server/templates/server/typeorm-migration.ts.ejs

@@ -0,0 +1,18 @@
+// Runs a command of the typeorm CLI creating a migration (migration:create, migration:generate) with the timestamp of the
+// migrations of the developers: its time plus <%= nodejsMigrationTimestampOffset %>, after the constraints migrations
+// JHipster generates for the entities (their changelogDate plus a smaller offset), like the changelogs added at the end of
+// the master.xml of Liquibase. TypeORM runs the migrations in the order of their timestamp.
+import { spawnSync } from 'node:child_process';
+import process from 'node:process';
+import { fileURLToPath } from 'node:url';
+
+const MIGRATION_TIMESTAMP_OFFSET = <%= nodejsMigrationTimestampOffset %>;
+
+// The CLI run by Node.js without a shell, which would split the arguments again (a path with a space).
+const typeormCli = fileURLToPath(import.meta.resolve('typeorm/cli.js'));
+const { status } = spawnSync(
+  process.execPath,
+  [typeormCli, ...process.argv.slice(2), '--timestamp', `${Date.now() + MIGRATION_TIMESTAMP_OFFSET}`],
+  { stdio: 'inherit' },
+);
+process.exit(status ?? 1);

package/generators/node-server/templates/server/vitest.config.e2e.ts.ejs

@@ -0,0 +1,16 @@
+import { defineConfig } from 'vitest/config';
+
+// The end-to-end tests of the REST API (supertest), on the test profile. The lcov report is read by SonarQube.
+export default defineConfig({
+  test: {
+    include: ['e2e/**/*.e2e-spec.ts'],
+    setupFiles: ['./e2e/setup.test.js'],
+    testTimeout: 10000,
+    coverage: {
+      include: ['src/**/*.ts'],
+      // The specs next to the code are tests, not code to cover.
+      exclude: ['src/**/*.spec.ts'],
+      reporter: ['text', 'lcov'],
+    },
+  },
+});

package/generators/node-server/templates/server/vitest.config.ts.ejs

@@ -0,0 +1,16 @@
+import { defineConfig } from 'vitest/config';
+
+// The unit tests: the specs next to the code. Vite transforms the decorators with their metadata from
+// tsconfig.json (experimentalDecorators, emitDecoratorMetadata), which the dependency injection of NestJS needs.
+export default defineConfig({
+  test: {
+    include: ['src/**/*.spec.ts'],
+    setupFiles: ['./e2e/setup.test.js'],
+    coverage: {
+      include: ['src/**/*.ts'],
+      // The specs next to the code are tests, not code to cover.
+      exclude: ['src/**/*.spec.ts'],
+      reporter: ['text', 'lcov'],
+    },
+  },
+});

package/generators/server/command.js

@@ -0,0 +1,7 @@
+import { asCommand } from 'generator-jhipster';
+
+export default asCommand({
+  configs: {},
+  override: true,
+  import: ['jhipster-nodejs:node-server'],
+});

package/generators/server/generator.js

@@ -0,0 +1,20 @@
+import ServerGenerator from 'generator-jhipster/generators/server';
+
+export default class extends ServerGenerator {
+  constructor(args, opts, features) {
+    super(args, opts, { ...features, checkBlueprint: true });
+  }
+
+  async beforeQueue() {
+    await this.dependsOnBootstrap('server');
+    await this.dependsOnJHipster('common');
+  }
+
+  get [ServerGenerator.COMPOSING]() {
+    return this.asComposingTaskGroup({
+      async composingTemplateTask() {
+        await this.composeWithJHipster('jhipster-nodejs:node-server');
+      },
+    });
+  }
+}

package/generators/server/generators/bootstrap/command.js

@@ -0,0 +1,5 @@
+import { asCommand } from 'generator-jhipster';
+
+export default asCommand({
+  configs: {},
+});

package/generators/server/generators/bootstrap/generator.js

@@ -0,0 +1,15 @@
+import BaseApplicationGenerator from 'generator-jhipster/generators/base-application';
+
+export default class extends BaseApplicationGenerator {
+  constructor(args, opts, features) {
+    super(args, opts, { ...features, sbsBlueprint: true });
+  }
+
+  get [BaseApplicationGenerator.COMPOSING]() {
+    return this.asComposingTaskGroup({
+      async composingTemplateTask() {
+        await this.composeWithJHipster('jhipster-nodejs:node-server:bootstrap');
+      },
+    });
+  }
+}

package/generators/server/generators/bootstrap/index.js

@@ -0,0 +1,2 @@
+export { default } from './generator.js';
+export { default as command } from './command.js';

package/generators/server/index.js

@@ -0,0 +1,2 @@
+export { default } from './generator.js';
+export { default as command } from './command.js';

package/package.json

@@ -1,6 +1,77 @@
 {
   "name": "@mshima/generator-jhipster-nodejs",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.2",
+  "description": "A NodeJS blueprint that creates the backend using NodeJS with NestJS framework",
+  "keywords": [
+    "yeoman-generator",
+    "jhipster-blueprint",
+    "jhipster-8",
+    "nodejs"
+  ],
+  "homepage": "https://github.com/jhipster/generator-jhipster-nodejs",
+  "bugs": {
+    "url": "https://github.com/jhipster/generator-jhipster-nodejs/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jhipster/generator-jhipster-nodejs.git"
+  },
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Angelo Manganiello",
+    "email": "angelo.mang@libero.it",
+    "url": "https://github.com/amanganiello90"
+  },
+  "contributors": [
+    "Deepu KS <d4udts@gmail.com> (https://deepu105.github.io)",
+    "Hadi Rasouli (https://github.com/hadirsa)",
+    "Iván García Sainz-Aja (https://github.com/ivangsa)",
+    "Daniel Franco <dandrfranco@gmail.com> (https://github.com/DanielFran)"
+  ],
+  "type": "module",
+  "main": "generators/app/index.js",
+  "bin": {
+    "nhipster": "cli/cli.cjs"
+  },
+  "files": [
+    "build-info.json",
+    "cli",
+    "generators",
+    "!**/__*",
+    "!**/*.snap",
+    "!**/*.spec.?(c|m)?(j|t)s"
+  ],
+  "scripts": {
+    "ejslint": "ejslint generators/**/*.ejs",
+    "lint": "eslint",
+    "lint-fix": "npm run ejslint && npm run lint -- --fix",
+    "prettier-check": "prettier --check \"{,**/}*.{md,json,yml,html,cjs,mjs,js,cts,mts,ts,tsx,css,scss,vue,java}\"",
+    "prettier-format": "prettier --write \"{,**/}*.{md,json,yml,html,cjs,mjs,js,cts,mts,ts,tsx,css,scss,vue,java}\"",
+    "sonar:scanner": "sonar-scanner",
+    "pretest": "npm run prettier-check && npm run lint",
+    "test": "vitest run",
+    "update-snapshot": "vitest run --update",
+    "vitest": "vitest"
+  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "generator-jhipster": "npm:@mshima/generator-jhipster@0.0.10"
+  },
+  "devDependencies": {
+    "ejs-lint": "2.0.1",
+    "eslint": "10.10.0",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-plugin-prettier": "5.5.6",
+    "globals": "17.12.0",
+    "jiti": "2.7.0",
+    "prettier": "3.9.6",
+    "prettier-plugin-packagejson": "3.0.2",
+    "sonarqube-scanner": "5.0.1",
+    "vitest": "5.0.5",
+    "yeoman-test": ">=10"
+  },
+  "engines": {
+    "generator-jhipster": "^9.4.0",
+    "node": "^22.18.0 || >=24.11.0"
+  }
+}