@deplois/api 0.0.1 → 0.0.3

package/README.md

@@ -175,3 +175,47 @@ npm run publish -- 1.2.3 "릴리스 내용" --deploy
 `fetch`는 세 번째 버전을 1 올립니다. minor/major를 올리면 하위 버전은 0으로 초기화합니다. 테스트·빌드 후 버전을 변경하고 변경 파일 전체를 commit → push → npmjs 공개 배포합니다. `--deploy`를 빼면 commit·push까지만 진행합니다. `npm run deploy`는 현재 버전을 테스트·빌드해서 npm에만 배포합니다.
 
 각 패키지 폴더에 별도 Git 저장소와 origin이 설정되어 있어야 합니다. 상위 저장소를 대신 commit하지 않습니다. npm 배포 시에는 npmjs 로그인 및 배포 권한이 필요합니다. 스크립트 자체는 template과 동일하게 Git 및 npm 패키지에서 제외하는 로컬 파일입니다.
+
+### 서비스별 사용자 필드
+
+`profile`은 기본 항목 외에도 서비스별 키, 배열, 중첩 객체를 받습니다. 기본 항목은 선택 사항이며 `null`도 저장할 수 있습니다. 추가 키는 `userPlugin.create`, `get`, `update`와 JSONB 저장에서 유지됩니다. 수정할 때 생략한 키는 유지하고 `undefined`로 전달한 키만 삭제합니다.
+
+```ts
+await userPlugin.create({
+    profile: {
+        fullName: '민재', nickname: 'minjae',
+        preferences: { language: 'ko' }
+    }
+})
+```
+
+프로젝트 전체에서 추가 필드의 타입을 정하려면 공개 `UserProfile` 인터페이스를 확장합니다.
+
+```ts
+import '@deplois/api'
+
+declare module '@deplois/api' {
+    interface UserProfile {
+        nickname?: string
+        preferences?: { language?: string }
+    }
+}
+```
+
+프로필 타입을 지정하거나 별도 DB 컬럼/관계가 필요하면 공통 Entity를 상속합니다.
+
+```ts
+import { Column, Entity } from 'typeorm'
+import { UserEntity } from '@deplois/api/database'
+import type { UserProfile } from '@deplois/api'
+
+@Entity('user')
+export class User extends UserEntity<UserProfile & { nickname?: string }> {
+    @Column({ name: 'customer_number', type: 'varchar', nullable: true })
+    customerNumber: string | null
+}
+```
+
+DataSource에는 앱의 `User`를 등록하고 해당 Repository로 추가 컬럼을 저장합니다. 기본 `TypeORMIdentityStore`와 `SessionEntity`는 기본 `UserEntity`를 대상으로 하므로, 커스텀 테이블에는 앱의 관계 Entity와 `IdentityStore`도 같은 대상을 사용해야 합니다. 공통 `userPlugin.create/update`는 `profile`, `metadata`만 입력받으며 임의 입력으로 ID나 활성 상태를 덮어쓰지 않습니다.
+
+기본 `/session/users`는 공개용 기본 프로필 항목만 응답합니다. 추가 필드 공개 여부는 앱 컨트롤러에서 정합니다. 새로운 DB 컬럼은 앱의 migration으로 추가하세요.

package/dist/database/user.entity.d.ts

@@ -1,7 +1,7 @@
-import type { User } from '../identity/interface';
-export declare class UserEntity {
+import type { UserProfile } from '../identity/interface';
+export declare class UserEntity<Profile extends UserProfile = UserProfile> {
     readonly id: string;
-    profile: User['profile'];
+    profile: Profile;
     metadata: Record<string, unknown>;
     isActive: boolean;
     readonly createdDate: Date;

package/dist/identity/interface.d.ts

@@ -1,11 +1,13 @@
+export interface UserProfile {
+    fullName?: string | null;
+    emailAddress?: string | null;
+    phoneNumber?: string | null;
+    imageUrl?: string | null;
+    [key: string]: unknown;
+}
 export interface User {
     id: string;
-    profile: {
-        fullName?: string;
-        emailAddress?: string;
-        phoneNumber?: string;
-        imageUrl?: string;
-    };
+    profile: UserProfile;
     metadata: Record<string, unknown>;
     isActive: boolean;
     createdDate: Date;

package/package.json

@@ -1,15 +1,24 @@
 {
   "name": "@deplois/api",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Shared NestJS API infrastructure for deplois",
   "type": "commonjs",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
-    ".": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
-    "./database": { "types": "./dist/database/index.d.ts", "default": "./dist/database/index.js" }
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./database": {
+      "types": "./dist/database/index.d.ts",
+      "default": "./dist/database/index.js"
+    }
   },
-  "files": ["dist", "README.md"],
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "check": "tsc -p tsconfig.json --noEmit",
@@ -18,17 +27,23 @@
     "publish": "node scripts/publish.mjs",
     "deploy": "node scripts/publish.mjs"
   },
-  "engines": { "node": ">=22" },
+  "engines": {
+    "node": ">=22"
+  },
   "peerDependencies": {
-    "@nestjs/common": "^11.0.0",
-    "@nestjs/core": "^11.0.0",
+    "@nestjs/common": "^11.0.0 || ^12.0.0",
+    "@nestjs/core": "^11.0.0 || ^12.0.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.15.0",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.1",
     "typeorm": "^1.1.0"
   },
-  "peerDependenciesMeta": { "typeorm": { "optional": true } },
+  "peerDependenciesMeta": {
+    "typeorm": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@nestjs/common": "^11.0.1",
     "@nestjs/core": "^11.0.1",
@@ -42,6 +57,9 @@
     "typeorm": "^1.1.0",
     "typescript": "^5.7.3"
   },
-  "publishConfig": { "access": "public", "registry": "https://registry.npmjs.org/" },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
   "license": "UNLICENSED"
 }