@nathapp/na-cli 1.0.8 → 1.0.9

package/dist/templates/nestjs-api/.gitlab-ci.yml

@@ -0,0 +1,180 @@
+# Project must implement Makefile for commands (test, version-prerelease, version-patch, name, version, image)
+# command:
+#   - test: run project test cases
+#   - version-prerelease: bump prerelease version
+#   - version-patch: bump release version
+#   - name: display project name
+#   - version: display project version
+#   - image: display project name and version (e.g. hello-world:1.0.0)
+#
+stages:
+  # run test cases
+  - test
+  # build container image and push to registry
+  - prepare
+  - build-init
+  - build
+  - build-commit
+  # mark release commit as verified
+  - release
+  - notify
+
+run-test:
+  stage: test
+  image: nathapp/node-bun:24.22.0-1.4.3-alpine-ci
+  script:
+    - make test
+  rules:
+    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT tag was created
+    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_COMMIT_TAG != null'
+      when: never
+    # Merge request
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+    # Commit to protected branch or commit branch is default branch (master)
+    - if: '$CI_COMMIT_REF_PROTECTED == "true" || $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+    # Commit message contains `run-test` keyword
+    - if: '$CI_COMMIT_MESSAGE =~ /run-test/'
+    # Commit message contains `run-prerelease` keyword and commit branch is not default branch (master)
+    - if: '$CI_COMMIT_MESSAGE =~ /run-prerelease/ && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
+
+run-pre-prepare:
+  stage: prepare
+  image: nathapp/node-bun:24.22.0-1.4.3-alpine-ci
+  artifacts:
+    paths:
+      - package.json
+      - image-tag.txt
+      - postman-collection.json
+  script:
+    - make spec
+    - make version-prerelease
+    - make image | awk '{ printf("%s/%s/%s", ENVIRON["CONTAINER_REGISTRY_URL"], ENVIRON["CONTAINER_REGISTRY_NAMESPACE"], $0)}' > image-tag.txt
+  rules:
+    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT merge request and NOT tag was created
+    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_TAG != null'
+      when: never
+    # Commit message contains `run-prerelease` keyword and commit branch is not default branch (master)
+    - if: '$CI_COMMIT_MESSAGE =~ /run-prerelease/ && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
+
+run-prepare:
+  stage: prepare
+  image: nathapp/node-bun:24.22.0-1.4.3-alpine-ci
+  artifacts:
+    paths:
+      - package.json
+      - image-tag.txt
+      - postman-collection.json
+  script:
+    - make spec
+    - make version-patch
+    - make image | awk '{ printf("%s/%s/%s", ENVIRON["CONTAINER_REGISTRY_URL"], ENVIRON["CONTAINER_REGISTRY_NAMESPACE"], $0)}' > image-tag.txt
+  rules:
+    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT merge request and NOT tag was created
+    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_TAG != null'
+      when: never
+    # Commit into default branch (master)
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+
+run-build-warmer:
+  stage: build-init
+  image: 
+    name: registry-intl.cn-hongkong.aliyuncs.com/gkci/kaniko-warmer:debug
+    entrypoint: [""]
+  before_script:
+    - echo "$DOCKER_AUTH_CONFIG" > /kaniko/.docker/config.json
+  script:
+    - warmer `cat $CI_PROJECT_DIR/Dockerfile | grep FROM | awk -F" " '{ printf("--image=%s ", $2) }'`
+  rules:
+    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT merge request and NOT tag was created
+    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_TAG != null'
+      when: never
+    # Commit message contains `run-prerelease` keyword and commit branch is not default branch (master)
+    - if: '$CI_COMMIT_MESSAGE =~ /run-prerelease/ && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
+    # Commit into default branch (master)
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+
+run-build:
+  stage: build
+  image: 
+    name: gcr.io/kaniko-project/executor:v1.23.2-debug
+    entrypoint: [""]
+  artifacts:
+    paths:
+      - image-digest.txt
+  before_script:
+    - echo "$DOCKER_AUTH_CONFIG" > /kaniko/.docker/config.json
+  variables:
+      GIT_SUBMODULE_FORCE_HTTPS: "true"
+      GIT_SUBMODULE_STRATEGY: recursive
+      GIT_DEPTH: 1
+      GIT_STRATEGY: clone 
+  script:
+    - echo "BUILDING... `cat $CI_PROJECT_DIR/image-tag.txt`"
+    - if [ -f $CI_PROJECT_DIR/dependency.txt ] && ! [ -z "`cat $CI_PROJECT_DIR/dependency.txt`" ]; then cat $CI_PROJECT_DIR/dependency.txt | awk '{$1=$1;print;exit}' > $CI_PROJECT_DIR/dep.txt; else echo > $CI_PROJECT_DIR/dep.txt; fi
+    - echo -n 'LABEL DEPENDENCY='; cat $CI_PROJECT_DIR/dep.txt
+    - |
+      if [[ -n "$CONTAINER_CACHE_REPO" ]]; then    
+        executor --context $CI_PROJECT_DIR --dockerfile $CI_PROJECT_DIR/Dockerfile --digest-file $CI_PROJECT_DIR/image-digest.txt --destination "`cat $CI_PROJECT_DIR/image-tag.txt`" --label "dependency=`cat $CI_PROJECT_DIR/dep.txt`" --cache=true --cache-repo=$CONTAINER_CACHE_REPO --cache-ttl=24h
+      else
+        executor --context $CI_PROJECT_DIR --dockerfile $CI_PROJECT_DIR/Dockerfile --digest-file $CI_PROJECT_DIR/image-digest.txt --destination "`cat $CI_PROJECT_DIR/image-tag.txt`" --label "dependency=`cat $CI_PROJECT_DIR/dep.txt`"
+      fi     
+    - echo "PUSHED `cat $CI_PROJECT_DIR/image-tag.txt` (`cat $CI_PROJECT_DIR/image-digest.txt`)"
+  rules:
+    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT merge request and NOT tag was created
+    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_TAG != null'
+      when: never
+    # Commit message contains `run-prerelease` keyword and commit branch is not default branch (master)
+    - if: '$CI_COMMIT_MESSAGE =~ /run-prerelease/ && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
+    # Commit into default branch (master)
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+
+run-build-commit:
+  stage: build-commit
+  image: nathapp/node-bun:24.22.0-1.4.3-alpine-ci
+  before_script:
+    - git config --global user.name "$GITLAB_USER_NAME"
+    - git config --global user.email "$GITLAB_USER_EMAIL"
+  script:
+    - git add -A
+    - git commit -m "$(make version)" -m "== release-by-bot ($CI_COMMIT_SHA) =="
+    - git tag -a "$(make version)" -m "$(cat image-tag.txt) ($(cat image-digest.txt))"
+    - git push "https://${GITLAB_USER_NAME}:${CI_GIT_TOKEN}@${CI_REPOSITORY_URL#*@}" "HEAD:${CI_COMMIT_BRANCH}"
+    - git push "https://${GITLAB_USER_NAME}:${CI_GIT_TOKEN}@${CI_REPOSITORY_URL#*@}" --tags
+  rules:
+    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT merge request and NOT tag was created
+    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_TAG != null'
+      when: never
+    # Commit message contains `run-prerelease` keyword and commit branch is not default branch (master)
+    - if: '$CI_COMMIT_MESSAGE =~ /run-prerelease/ && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
+    # Commit into default branch (master)
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+
+run-release:
+  stage: release
+  image: nathapp/node-bun:24.22.0-1.4.3-alpine-ci
+  script:
+    - echo "Bumped version $(make version)"
+  rules:
+    # NOT commit message contains `run-without-release` keyword and NOT merge request
+    - if: '$CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event"'
+      when: never
+    # Tag was created
+    - if: '$CI_COMMIT_TAG != null'
+
+run-notify:
+  stage: notify
+  image: nathapp/node-bun:24.22.0-1.4.3-alpine-ci
+  before_script:
+    - apk --no-cache add curl
+  script:
+    - 'curl -X POST -H "Content-Type: application/json" -d "{\"chat_id\": \"$TELEGRAM_CHAT_ID\", \"text\": \"CI: $CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME version:$(make version) has been released \"}" https://api.telegram.org/bot$TELEGRAM_BOT_TOKEN/sendMessage'
+  rules:
+    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT merge request and NOT tag was created
+    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_TAG != null'
+      when: never
+    - if: '$TELEGRAM_BOT_TOKEN == null || $TELEGRAM_BOT_TOKEN == "" || $TELEGRAM_CHAT_ID == null || $TELEGRAM_CHAT_ID == ""'
+      when: never
+    # Commit message contains `run-prerelease` keyword and commit branch is not default branch (master)
+    - if: '$CI_COMMIT_MESSAGE =~ /run-prerelease/ && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
+    # Commit into default branch (master)
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'

package/dist/templates/nestjs-api/.nvmrc

@@ -0,0 +1 @@
+v22.22.2

package/dist/templates/nestjs-api/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

package/dist/templates/nestjs-api/Makefile

@@ -0,0 +1,95 @@
+MAKEFILE := $(abspath $(lastword $(MAKEFILE_LIST)))
+ROOT_PATH := $(shell pwd)
+SERVICE_NAME := <%= projectName %>
+
+.PHONY: version name image test spec spec-file
+
+version-major: version-sync
+	@npm -s version major --no-git-tag-version
+
+version-minor: version-sync
+	@npm -s version minor --no-git-tag-version
+
+version-patch: version-sync
+	@npm -s version patch --no-git-tag-version
+
+version-prerelease: version-sync
+	@npm -s version prerelease --preid=rc --no-git-tag-version
+
+version-latest:
+	@(git tag --sort=-creatordate || echo) | awk 'NR==1 { \
+		split($$0, n, "-"); \
+		if (n[1] != "") { \
+			split(n[1], v, "."); \
+			if (v[1] ~ /^[0-9]+$$/ && v[2] ~ /^[0-9]+$$/ && v[3] ~ /^[0-9]+$$/) { \
+				print $$0; \
+				exit 0; \
+			} \
+		} \
+		print "1.0.0-rc.0"; \
+	 } \
+	 END { \
+		 if (NR == 0) { \
+			 print "1.0.0-rc.0"; \
+		 } \
+	 }'
+
+version-sync:
+	@git checkout $(CI_COMMIT_BRANCH)
+	@git pull --tags 2&>/dev/null || true
+	@git tag --sort=-creatordate | head -10
+	@cat package.json | jq -r --arg PKG_VERSION `make --no-print-directory -f$(MAKEFILE) version-latest` '.version=$$PKG_VERSION' > package.json;
+	@echo -n "Current Git tag: "; cat package.json | jq -r '.version'
+
+version:
+	@echo $(shell node -p "require('$(ROOT_PATH)/package.json').version")
+
+name:
+	@echo $(SERVICE_NAME)
+
+image:
+	@echo $(SERVICE_NAME):$(shell node -p "require('$(ROOT_PATH)/package.json').version")
+
+test:
+	@bun install --frozen-lockfile
+	@bun run test
+
+spec:
+	@set -e -o pipefail; \
+		if [ -f "$(ROOT_PATH)/spec.yaml" ]; then \
+			make --no-print-directory -f$(MAKEFILE) spec-file > $(ROOT_PATH)/all-spec.yaml; \
+			openapi2postmanv2 -s $(ROOT_PATH)/all-spec.yaml -o postman-collection.json | \
+				awk ' \
+					BEGIN{ result = 0; error = "" } \
+					{ \
+						if (0 < index($$0, "Conversion successful, collection written to file")) { \
+							result = 1; \
+						} \
+						error = error $$0; \
+					} \
+					END{ \
+						if (result != 1) { \
+							print error; \
+							exit(-1); \
+						} \
+					}'; \
+			rm -f $(ROOT_PATH)/all-spec.yaml; \
+		fi;
+
+spec-file:
+	@cat $(ROOT_PATH)/spec.yaml;
+	@for file in `find $(ROOT_PATH)/src -iname "*-spec.yaml"`; do \
+		echo ""; \
+		cat $$file; \
+	done;
+
+
+gen-keypair:
+	@openssl genrsa -out private.pem 2048
+	@openssl rsa -in private.pem -pubout -out public.pem
+
+view-privatekey:
+	@awk '{printf "%s\\n", $$0}' private.pem
+
+view-publickey:
+	@awk '{printf "%s\\n", $$0}' public.pem

package/dist/templates/nestjs-api/nest-cli.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true,
+    "plugins": ["@nestjs/swagger"],
+    "assets": ["i18n/**/*"]
+  }
+}

package/dist/templates/nestjs-api/ormconfig.ts

@@ -0,0 +1,18 @@
+import { DataSource, DataSourceOptions } from 'typeorm';
+
+const config = {
+  name: 'default',
+  type: 'mysql',
+  host: 'localhost',
+  port: 3306,
+  username: 'typeorm',
+  password: 'password',
+  database: 'database-test',
+  entities: ['./src/auth-module/**/*.entity{.ts,.js}'],
+  synchronize: false,
+  migrations: ['./src/migrations/*{.ts,.js}'],
+  // migrationsTableName: 'migrations_typeorm',
+  migrationsRun: true,
+};
+
+export const connectionSource = new DataSource(config as DataSourceOptions);

package/dist/templates/nestjs-api/src/app.controller.spec.ts

@@ -0,0 +1,24 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { AppController } from './app.controller';
+import { AppService } from '@/app.service';
+
+describe('AppController', () => {
+  let appController: AppController;
+  let appService: AppService;
+
+  beforeEach(async () => {
+    const app: TestingModule = await Test.createTestingModule({
+      controllers: [AppController],
+      providers: [AppService],
+    }).compile();
+
+    appController = app.get<AppController>(AppController);
+    appService = app.get(AppService);
+  });
+
+  describe('root', () => {
+    it('should return "App Version"', () => {
+      expect(appController.get()).toEqual(appService.displayVersion());
+    });
+  });
+});

package/dist/templates/nestjs-api/src/app.controller.ts

@@ -0,0 +1,27 @@
+import { JsonResponse } from '@nathapp/common';
+import { Public } from '@nathapp/nestjs-auth';
+import { Controller, Get } from '@nestjs/common';
+import { AppService } from './app.service';
+
+@Controller()
+export class AppController {
+  constructor(private readonly appService: AppService) { }
+
+  @Get('/')
+  @Public()
+  get() {
+    return this.appService.displayVersion();
+  }
+
+  @Get('/liveness')
+  @Public()
+  liveness() {
+    return JsonResponse.Ok({});
+  }
+
+  @Get('/readiness')
+  @Public()
+  readiness() {
+    return JsonResponse.Ok({});
+  }
+}

package/dist/templates/nestjs-api/src/app.module.ts

@@ -0,0 +1,31 @@
+import {
+  DefaultJwtModuleOptionsFactory,
+  JwtModule,
+  JwtStrategy,
+} from '@nathapp/nestjs-auth';
+import { I18nCoreModule, ServerSecurityConfig } from '@nathapp/nestjs-common';
+import { LoggingModule } from '@nathapp/nestjs-logging';
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+      load: [ServerSecurityConfig],
+    }),
+    JwtModule.forRootAsync({
+      imports: [ConfigModule],
+      useClass: DefaultJwtModuleOptionsFactory,
+    }),
+    I18nCoreModule.forRoot(),
+    // Request context + auto request logging; `/`, `/liveness`, `/readiness`
+    // and `/favicon.ico` are excluded by default.
+    LoggingModule.register({ type: 'default' }),
+  ],
+  controllers: [AppController],
+  providers: [AppService, JwtStrategy],
+})
+export class AppModule {}

package/dist/templates/nestjs-api/src/app.service.ts

@@ -0,0 +1,27 @@
+import { JsonResponse } from '@nathapp/common';
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class AppService {
+  displayVersion(): any {
+    return JsonResponse.Ok({
+      version: `${process.env.npm_package_name} ${process.env.npm_package_version}`,
+    });
+  }
+
+  appVersion(): string {
+    return process.env.npm_package_version || '1.0.0-rc.0';
+  }
+
+  appName(): string {
+    return process.env.npm_package_name || 'noname-app';
+  }
+
+  getAppInfo(): any {
+    return {
+      name: this.appName(),
+      version: this.appVersion(),
+      description: '',
+    };
+  }
+}

package/dist/templates/nestjs-api/src/main.ts

@@ -0,0 +1,31 @@
+import { AppFactory } from '@nathapp/nestjs-app';
+import { Logger } from '@nathapp/nestjs-logging';
+import { AppModule } from './app.module';
+import { AppService } from './app.service';
+
+async function bootstrap() {
+<% if (isFastify) { -%>
+  const app = await AppFactory.createFastifyApp(AppModule, {
+    bufferLogs: true,
+  });
+<% } else { -%>
+  const app = await AppFactory.create(AppModule, {
+    bufferLogs: true,
+  });
+<% } -%>
+  app.useLogger(app.get(Logger));
+
+  const appService = app.get(AppService);
+
+  await app.useServerSecurityConfig();
+
+  app
+    .useAppGlobalPrefix()
+    .useAppGlobalPipes()
+    .useAppGlobalFilters()
+    .useAppGlobalGuards()
+    .useSwaggerUIOnDevOnly(appService.getAppInfo());
+
+  await app.start();
+}
+bootstrap();

package/dist/templates/nestjs-api/test/app.e2e-spec.ts

@@ -0,0 +1,47 @@
+import { INestApplication } from '@nestjs/common';
+import { Test, TestingModule } from '@nestjs/testing';
+<% if (isFastify) { -%>
+import {
+  FastifyAdapter,
+  NestFastifyApplication,
+} from '@nestjs/platform-fastify';
+<% } -%>
+import request from 'supertest';
+import { AppModule } from '../src/app.module';
+import { AppService } from '../src/app.service';
+
+describe('AppController (e2e)', () => {
+  let app: INestApplication;
+  let appService: AppService;
+
+  beforeEach(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AppModule],
+    }).compile();
+
+<% if (isFastify) { -%>
+    app = moduleFixture.createNestApplication<NestFastifyApplication>(
+      new FastifyAdapter(),
+    );
+<% } else { -%>
+    app = moduleFixture.createNestApplication();
+<% } -%>
+    appService = app.get(AppService);
+    await app.init();
+<% if (isFastify) { -%>
+    await app.getHttpAdapter().getInstance().ready();
+<% } -%>
+  });
+
+  afterEach(async () => {
+    await app.close();
+  });
+
+  it('/ (GET)', () => {
+    const response = appService.displayVersion();
+    return request(app.getHttpServer())
+      .get('/')
+      .expect(200)
+      .expect({ ret: response.ret, data: response.data });
+  });
+});

package/dist/templates/nestjs-api/tsconfig.build.json

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src/**/*"],
+  "exclude": ["generated", "node_modules", "test", "dist", "**/*spec.ts", "ormconfig.ts"]
+}

package/dist/templates/nestjs-api/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "target": "ES2022",
+    "lib": ["ES2022"],
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": false,
+    "noImplicitAny": false,
+    "strictBindCallApply": false,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": false,
+    "paths": {
+      "@/*": ["src/*"]
+    }
+  }
+}

package/dist/templates/nestjs-api/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "types": ["vitest/globals", "node"]
+  },
+  "include": ["src/**/*", "test/**/*"],
+  "exclude": ["node_modules", "dist"]
+}