nicot-simple-user 1.0.0

package/dist/utility/load-config.d.ts

@@ -0,0 +1,7 @@
+declare const defaultConfig: {
+    host: string;
+    port: number;
+};
+export type LoadConfig = typeof defaultConfig;
+export declare function loadConfig(): Promise<LoadConfig>;
+export {};

package/dist/utility/load-config.js

@@ -0,0 +1,61 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadConfig = loadConfig;
+const yaml_1 = __importDefault(require("yaml"));
+const fs = __importStar(require("fs"));
+const defaultConfig = {
+    host: '::',
+    port: 3000,
+};
+async function loadConfig() {
+    let readConfig = {};
+    try {
+        const configText = await fs.promises.readFile('./config.yaml', 'utf-8');
+        readConfig = yaml_1.default.parse(configText);
+    }
+    catch (e) {
+        console.error(`Failed to read config: ${e.toString()}`);
+    }
+    return {
+        ...defaultConfig,
+        ...readConfig,
+        ...process.env,
+    };
+}
+//# sourceMappingURL=load-config.js.map

package/dist/utility/load-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"load-config.js","sourceRoot":"","sources":["../../src/utility/load-config.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAUA,gCAaC;AAvBD,gDAAwB;AACxB,uCAAyB;AAEzB,MAAM,aAAa,GAAG;IACpB,IAAI,EAAE,IAAI;IACV,IAAI,EAAE,IAAI;CACX,CAAC;AAIK,KAAK,UAAU,UAAU;IAC9B,IAAI,UAAU,GAAwB,EAAE,CAAC;IACzC,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;QACxE,UAAU,GAAG,cAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO;QACL,GAAG,aAAa;QAChB,GAAG,UAAU;QACb,GAAG,OAAO,CAAC,GAAG;KACf,CAAC;AACJ,CAAC"}

package/eslint.config.mjs

@@ -0,0 +1,34 @@
+// @ts-check
+import eslint from '@eslint/js';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    ignores: ['eslint.config.mjs'],
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  eslintPluginPrettierRecommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+      sourceType: 'commonjs',
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-floating-promises': 'warn',
+      '@typescript-eslint/no-unsafe-argument': 'warn'
+    },
+  },
+);

package/install-npm-typeorm.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+npm install --save typeorm @nestjs/typeorm pg nicot

package/nest-cli.json

@@ -0,0 +1,7 @@
+{
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "plugins": ["@nestjs/swagger"]
+  }
+}

package/package.json

@@ -0,0 +1,98 @@
+{
+  "name": "nicot-simple-user",
+  "version": "1.0.0",
+  "description": "Simple user module based on NICOT",
+  "author": "Nanahira <nanahira@momobako.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/purerosefallen/nicot-simple-user.git"
+  },
+  "bugs": {
+    "url": "https://github.com/purerosefallen/nicot-simple-user/issues"
+  },
+  "homepage": "https://github.com/purerosefallen/nicot-simple-user",
+  "main": "dist/simple-user/index.js",
+  "types": "dist/simple-user/index.d.ts",
+  "scripts": {
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "dependencies": {
+    "aragami": "^1.2.9",
+    "argon2": "^0.44.0",
+    "crypto-random-string": "3.3.1",
+    "nestjs-aragami": "^1.2.0"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^11.0.1",
+    "@nestjs/core": "^11.0.1",
+    "@nestjs/swagger": "^11.2.3",
+    "@nestjs/typeorm": "^11.0.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.3",
+    "nicot": "^1.3.1",
+    "typeorm": "^0.3.28"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.2.0",
+    "@eslint/js": "^9.18.0",
+    "@nestjs/cli": "^11.0.0",
+    "@nestjs/schematics": "^11.0.0",
+    "@nestjs/testing": "^11.0.1",
+    "@swc/cli": "^0.6.0",
+    "@swc/core": "^1.10.7",
+    "@types/express": "^5.0.6",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.10.7",
+    "@types/supertest": "^6.0.2",
+    "eslint": "^9.18.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-prettier": "^5.2.2",
+    "globals": "^16.0.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.4.2",
+    "source-map-support": "^0.5.21",
+    "supertest": "^7.0.0",
+    "ts-jest": "^29.2.5",
+    "ts-loader": "^9.5.2",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.20.0",
+    "@nestjs/platform-express": "^11.0.1",
+    "@nestjs/config": "^4.0.2",
+    "nesties": "^1.1.26",
+    "pg": "^8.16.3",
+    "reflect-metadata": "^0.2.2",
+    "rxjs": "^7.8.1",
+    "yaml": "^2.8.2"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "test",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}

package/test/app-e2e.spec.ts

@@ -0,0 +1,242 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { INestApplication } from '@nestjs/common';
+import request from 'supertest';
+import { AppModule } from './../src/app.module';
+
+type BlankReturnMessageDto = {
+  statusCode: number;
+  message: string;
+  success: boolean;
+  timestamp: string;
+};
+
+type ReturnMessage<T> = BlankReturnMessageDto & { data?: T };
+
+type LoginResponseDto = {
+  token: string;
+  tokenExpiresAt: string;
+  userId: number;
+};
+
+type SimpleUserResultDto = {
+  id: number;
+  email?: string;
+  passwordSet: boolean;
+};
+
+describe('SimpleUserModule (e2e)', () => {
+  let app: INestApplication;
+  let httpServer: any;
+
+  // 固定：测试模式下验证码永远是 123456
+  const TEST_CODE = '123456';
+
+  // 每次跑用不同邮箱，避免被数据库里历史数据影响
+  const rand = Math.random().toString(16).slice(2);
+  const email1 = `e2e_${rand}@example.com`;
+  const email2 = `e2e2_${rand}@example.com`;
+
+  // x-client-ssaid 是你体系里“客户端会话标识”
+  const ssaid = `ssaid_e2e_${rand}`;
+
+  // 密码在流程中会变
+  const password1 = `P@ss_${rand}_1`;
+  const password2 = `P@ss_${rand}_2`;
+
+  let token: string | undefined;
+
+  beforeAll(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AppModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.init();
+    httpServer = app.getHttpServer();
+  });
+
+  afterAll(async () => {
+    await app.close();
+  });
+
+  function expectOkEnvelope(resBody: any) {
+    // 你的所有返回都有这些字段（BlankReturnMessageDto）
+    expect(resBody).toHaveProperty('statusCode');
+    expect(resBody).toHaveProperty('message');
+    expect(resBody).toHaveProperty('success');
+    expect(resBody).toHaveProperty('timestamp');
+  }
+
+  it('GET /login/user-exists -> should be false for a brand new email', async () => {
+    const res = await request(httpServer)
+      .get('/login/user-exists')
+      .query({ email: email1 })
+      .expect(200);
+
+    expectOkEnvelope(res.body);
+    expect(res.body.data).toBeDefined();
+    expect(res.body.data.exists).toBe(false);
+  });
+
+  it('POST /send-code/send (login) -> should succeed', async () => {
+    const res = await request(httpServer)
+      .post('/send-code/send')
+      .set('x-client-ssaid', ssaid)
+      .send({ email: email1, codePurpose: 'Login' })
+      .expect(200);
+
+    expectOkEnvelope(res.body);
+  });
+
+  it('GET /send-code/verify (login) -> correct code should pass; wrong code should 403', async () => {
+    // 正确验证码
+    const ok = await request(httpServer)
+      .get('/send-code/verify')
+      .query({ email: email1, codePurpose: 'Login', code: TEST_CODE })
+      .expect(200);
+
+    expectOkEnvelope(ok.body);
+
+    // 错误验证码
+    const bad = await request(httpServer)
+      .get('/send-code/verify')
+      .query({ email: email1, codePurpose: 'Login', code: '000000' })
+      .expect(403);
+
+    expectOkEnvelope(bad.body);
+  });
+
+  it('POST /login (code) -> should auto-create user & return token', async () => {
+    const res = await request(httpServer)
+      .post('/login')
+      .set('x-client-ssaid', ssaid)
+      .send({ email: email1, code: TEST_CODE })
+      .expect(200);
+
+    expectOkEnvelope(res.body);
+    const data = (res.body as ReturnMessage<LoginResponseDto>).data;
+    expect(data).toBeDefined();
+    expect(typeof data.userId).toBe('number');
+    expect(typeof data.token).toBe('string');
+    expect(data.token).toHaveLength(64);
+
+    token = data.token;
+  });
+
+  it('GET /user-center/me -> should return current user info', async () => {
+    const res = await request(httpServer)
+      .get('/user-center/me')
+      .set('x-client-ssaid', ssaid)
+      .set('x-client-token', token)
+      .expect(200);
+
+    expectOkEnvelope(res.body);
+    const data = (res.body as ReturnMessage<SimpleUserResultDto>).data;
+    expect(data).toBeDefined();
+    expect(typeof data.id).toBe('number');
+    // 刚用 email 登录，通常应该有 email
+    expect(data.email).toBe(email1);
+    expect(typeof data.passwordSet).toBe('boolean');
+  });
+
+  it('POST /user-center/change-password -> set password (first time) and then login by password', async () => {
+    // 第一次设置密码：currentPassword 可能不需要（passwordSet=false 时）
+    const setRes = await request(httpServer)
+      .post('/user-center/change-password')
+      .set('x-client-ssaid', ssaid)
+      .set('x-client-token', token)
+      .send({ newPassword: password1 })
+      .expect(200);
+
+    expectOkEnvelope(setRes.body);
+
+    // 用密码登录成功
+    const loginOk = await request(httpServer)
+      .post('/login')
+      .set('x-client-ssaid', ssaid)
+      .send({ email: email1, password: password1 })
+      .expect(200);
+
+    expectOkEnvelope(loginOk.body);
+    const data = (loginOk.body as ReturnMessage<LoginResponseDto>).data;
+    expect(data.token).toHaveLength(64);
+
+    // 用错密码应 403
+    const loginBad = await request(httpServer)
+      .post('/login')
+      .set('x-client-ssaid', ssaid)
+      .send({ email: email1, password: 'WRONG_PASSWORD' })
+      .expect(403);
+
+    expectOkEnvelope(loginBad.body);
+  });
+
+  it('POST /send-code/send (ChangeEmail) -> POST /user-center/change-email -> should change email', async () => {
+    // 发给新邮箱的验证码（purpose 注意大小写：ChangeEmail）
+    const send = await request(httpServer)
+      .post('/send-code/send')
+      .set('x-client-ssaid', ssaid)
+      .send({ email: email2, codePurpose: 'ChangeEmail' })
+      .expect(200);
+
+    expectOkEnvelope(send.body);
+
+    // 提交换绑
+    const change = await request(httpServer)
+      .post('/user-center/change-email')
+      .set('x-client-ssaid', ssaid)
+      .set('x-client-token', token)
+      .send({ email: email2, code: TEST_CODE })
+      .expect(200);
+
+    expectOkEnvelope(change.body);
+
+    // 用“新邮箱 + 旧密码”再次登录验证换绑生效
+    const relogin = await request(httpServer)
+      .post('/login')
+      .set('x-client-ssaid', ssaid)
+      .send({ email: email2, password: password1 })
+      .expect(200);
+
+    expectOkEnvelope(relogin.body);
+    const data = (relogin.body as ReturnMessage<LoginResponseDto>).data;
+    expect(data.token).toHaveLength(64);
+  });
+
+  it('POST /send-code/send (ResetPassword) -> POST /login/reset-password -> login with new password', async () => {
+    // 发 reset code（purpose 注意大小写：ResetPassword）
+    const send = await request(httpServer)
+      .post('/send-code/send')
+      .set('x-client-ssaid', ssaid)
+      .send({ email: email2, codePurpose: 'ResetPassword' })
+      .expect(200);
+
+    expectOkEnvelope(send.body);
+
+    // 重置密码
+    const reset = await request(httpServer)
+      .post('/login/reset-password')
+      .send({ email: email2, code: TEST_CODE, newPassword: password2 })
+      .expect(200);
+
+    expectOkEnvelope(reset.body);
+
+    // 老密码应失败
+    const oldBad = await request(httpServer)
+      .post('/login')
+      .set('x-client-ssaid', ssaid)
+      .send({ email: email2, password: password1 })
+      .expect(403);
+
+    expectOkEnvelope(oldBad.body);
+
+    // 新密码应成功
+    const newOk = await request(httpServer)
+      .post('/login')
+      .set('x-client-ssaid', ssaid)
+      .send({ email: email2, password: password2 })
+      .expect(200);
+
+    expectOkEnvelope(newOk.body);
+  });
+});

package/test/jest-e2e.json

@@ -0,0 +1,9 @@
+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "rootDir": ".",
+  "testEnvironment": "node",
+  "testRegex": ".e2e-spec.ts$",
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  }
+}

package/tsconfig.build.json

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

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "es2021",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "esModuleInterop": true
+  },
+  "compileOnSave": true,
+  "allowJs": true
+}