@simplysm/service-common 13.0.12 → 13.0.14

package/README.md

@@ -1,6 +1,6 @@
 # @simplysm/service-common
 
-A package that provides shared communication protocols, message types, and service interface definitions between the service client (`service-client`) and server (`service-server`). It includes binary protocol-based message encoding/decoding, automatic message chunking for large payloads, event system types, and service interfaces for ORM/encryption/SMTP/auto-update.
+A package that provides shared communication protocols, message types, and service interface definitions between the service client (`service-client`) and server (`service-server`). It includes binary protocol-based message encoding/decoding, automatic message chunking for large payloads, event system types, and service interfaces for ORM/encryption/auto-update.
 
 ## Installation
 
@@ -27,7 +27,6 @@ pnpm add @simplysm/service-common
 | `protocol/service-protocol` | Message encoding/decoding class |
 | `service-types/orm-service.types` | ORM service interface and DB connection options |
 | `service-types/crypto-service.types` | Crypto service interface and config |
-| `service-types/smtp-service.types` | SMTP service interface and email options |
 | `service-types/auto-update-service.types` | Auto-update service interface |
 | `types` | `ServiceUploadResult` |
 | `define-event` | `defineEvent`, `ServiceEventDef` |
@@ -36,7 +35,7 @@ pnpm add @simplysm/service-common
 
 ## ServiceProtocol
 
-The core class for encoding/decoding messages into binary format. Messages exceeding 3MB are automatically split into 300KB chunks, and the receiving side automatically assembles the chunks to restore the original message.
+The core interface for encoding/decoding messages into binary format. Created via the `createServiceProtocol()` factory function. Messages exceeding 3MB are automatically split into 300KB chunks, and the receiving side automatically assembles the chunks to restore the original message.
 
 ### Binary Header Structure
 
@@ -68,10 +67,10 @@ Each chunk consists of a 28-byte header and body (Big Endian).
 ### Usage Example
 
 ```typescript
-import { ServiceProtocol } from "@simplysm/service-common";
+import { createServiceProtocol } from "@simplysm/service-common";
 import { Uuid } from "@simplysm/core-common";
 
-const protocol = new ServiceProtocol();
+const protocol = createServiceProtocol();
 
 // Encoding: Convert message to binary chunks
 const uuid = Uuid.new().toString();
@@ -265,61 +264,6 @@ Defines SHA256 hash generation and AES symmetric key encryption/decryption capab
 |------|------|------|
 | `key` | `string` | AES encryption key |
 
-### SmtpService
-
-Defines email sending capabilities. Can send by directly passing SMTP settings or by referencing server config.
-
-| Method | Parameters | Return Type | Description |
-|--------|---------|-----------|------|
-| `send` | `options: SmtpSendOption` | `Promise<string>` | Send email with direct SMTP settings |
-| `sendByConfig` | `configName, options: SmtpSendByConfigOption` | `Promise<string>` | Send email by referencing server config |
-
-#### SmtpSendOption
-
-A type combining `SmtpConnectionOptions` and `SmtpEmailContentOptions`, with an additional `from` field.
-
-| Field | Type | Required | Description |
-|------|------|------|------|
-| `host` | `string` | Y | SMTP host |
-| `port` | `number` | N | SMTP port |
-| `secure` | `boolean` | N | TLS usage |
-| `user` | `string` | N | SMTP auth user |
-| `pass` | `string` | N | SMTP auth password |
-| `from` | `string` | Y | Sender address |
-| `to` | `string` | Y | Recipient address |
-| `cc` | `string` | N | CC |
-| `bcc` | `string` | N | BCC |
-| `subject` | `string` | Y | Subject |
-| `html` | `string` | Y | Body (HTML) |
-| `attachments` | `SmtpSendAttachment[]` | N | Attachment list |
-
-#### SmtpSendByConfigOption
-
-Same as `SmtpEmailContentOptions`. SMTP connection info is referenced from server config (`configName`).
-
-#### SmtpSendAttachment
-
-| Field | Type | Required | Description |
-|------|------|------|------|
-| `filename` | `string` | Y | Attachment filename |
-| `content` | `Bytes` | N | File content (binary). Specify one of `path` or `content` |
-| `path` | `string` | N | File path on server. Specify one of `path` or `content` |
-| `contentType` | `string` | N | MIME type (e.g., `"application/pdf"`) |
-
-#### SmtpConfig
-
-Server-side SMTP configuration type.
-
-| Field | Type | Required | Description |
-|------|------|------|------|
-| `host` | `string` | Y | SMTP host |
-| `port` | `number` | N | SMTP port |
-| `secure` | `boolean` | N | TLS usage |
-| `user` | `string` | N | SMTP auth user |
-| `pass` | `string` | N | SMTP auth password |
-| `senderName` | `string` | Y | Sender display name |
-| `senderEmail` | `string` | N | Sender email address |
-
 ### AutoUpdateService
 
 Defines a service for querying the latest version information of a client application.
@@ -334,7 +278,7 @@ Pass values like `"win32"`, `"darwin"`, `"linux"` to `platform`.
 
 ## Caveats
 
-- `ServiceProtocol` instances internally use `LazyGcMap` to manage incomplete split messages. After use, you must call `dispose()` to release the GC timer.
+- `ServiceProtocol` instances are created via `createServiceProtocol()` factory function and internally use `LazyGcMap` to manage incomplete split messages. After use, you must call `dispose()` to release the GC timer.
 - Encoding or decoding messages exceeding `PROTOCOL_CONFIG.MAX_TOTAL_SIZE` (100MB) will throw an `ArgumentError`.
 - Passing binary data less than 28 bytes during decoding will throw an `ArgumentError`.
 - Service interfaces (`OrmService`, `CryptoService`, etc.) only provide type definitions. Actual implementations are handled by the `@simplysm/service-server` package.

package/dist/index.d.ts

@@ -1,9 +1,7 @@
 export * from "./protocol/protocol.types";
 export * from "./protocol/service-protocol";
 export * from "./service-types/orm-service.types";
-export * from "./service-types/crypto-service.types";
 export * from "./service-types/auto-update-service.types";
-export * from "./service-types/smtp-service.types";
 export * from "./types";
 export * from "./define-event";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAG5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,sCAAsC,CAAC;AACrD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,oCAAoC,CAAC;AAGnD,cAAc,SAAS,CAAC;AAGxB,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAG5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,2CAA2C,CAAC;AAG1D,cAAc,SAAS,CAAC;AAGxB,cAAc,gBAAgB,CAAC"}

package/dist/index.js

@@ -1,9 +1,7 @@
 export * from "./protocol/protocol.types.js";
 export * from "./protocol/service-protocol.js";
 export * from "./service-types/orm-service.types.js";
-export * from "./service-types/crypto-service.types.js";
 export * from "./service-types/auto-update-service.types.js";
-export * from "./service-types/smtp-service.types.js";
 export * from "./types.js";
 export * from "./define-event.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../src/index.ts"],
-  "mappings": "AACA,cAAc;AACd,cAAc;AAGd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AAGd,cAAc;AAGd,cAAc;",
+  "mappings": "AACA,cAAc;AACd,cAAc;AAGd,cAAc;AACd,cAAc;AAGd,cAAc;AAGd,cAAc;",
   "names": []
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@simplysm/service-common",
   "sideEffects": false,
-  "version": "13.0.12",
+  "version": "13.0.14",
   "description": "심플리즘 패키지 - 서비스 모듈 (common)",
   "author": "김석래",
   "repository": {
@@ -18,7 +18,7 @@
     "src"
   ],
   "dependencies": {
-    "@simplysm/core-common": "13.0.12",
-    "@simplysm/orm-common": "13.0.12"
+    "@simplysm/core-common": "13.0.14",
+    "@simplysm/orm-common": "13.0.14"
   }
 }

package/src/index.ts

@@ -4,9 +4,7 @@ export * from "./protocol/service-protocol";
 
 // Service Types
 export * from "./service-types/orm-service.types";
-export * from "./service-types/crypto-service.types";
 export * from "./service-types/auto-update-service.types";
-export * from "./service-types/smtp-service.types";
 
 // Types
 export * from "./types";

package/dist/service-types/crypto-service.types.d.ts

@@ -1,22 +0,0 @@
-import type { Bytes } from "@simplysm/core-common";
-/**
- * 암호화 서비스 인터페이스
- *
- * SHA256 해시 및 AES 대칭키 암호화/복호화 기능을 제공한다.
- */
-export interface CryptoService {
-    /** SHA256 해시 생성 */
-    encrypt(data: string | Bytes): Promise<string>;
-    /** AES 암호화 */
-    encryptAes(data: Bytes): Promise<string>;
-    /** AES 복호화 */
-    decryptAes(encText: string): Promise<Bytes>;
-}
-/**
- * 암호화 서비스 설정
- */
-export interface CryptoConfig {
-    /** AES 암호화 키 */
-    key: string;
-}
-//# sourceMappingURL=crypto-service.types.d.ts.map

package/dist/service-types/crypto-service.types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"crypto-service.types.d.ts","sourceRoot":"","sources":["../../src/service-types/crypto-service.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,mBAAmB;IACnB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,cAAc;IACd,UAAU,CAAC,IAAI,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACzC,cAAc;IACd,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,gBAAgB;IAChB,GAAG,EAAE,MAAM,CAAC;CACb"}

package/dist/service-types/crypto-service.types.js

@@ -1 +0,0 @@
-//# sourceMappingURL=crypto-service.types.js.map

package/dist/service-types/crypto-service.types.js.map

@@ -1,6 +0,0 @@
-{
-  "version": 3,
-  "sources": [],
-  "mappings": "",
-  "names": []
-}

package/dist/service-types/smtp-service.types.d.ts

@@ -1,55 +0,0 @@
-import type { Bytes } from "@simplysm/core-common";
-/**
- * SMTP 서비스 인터페이스
- *
- * 이메일 전송 기능을 제공한다.
- * 직접 SMTP 설정을 전달하거나 서버 설정을 참조하여 전송할 수 있다.
- */
-export interface SmtpService {
-    /** 직접 SMTP 설정으로 이메일 전송 */
-    send(options: SmtpSendOption): Promise<string>;
-    /** 서버 설정 참조로 이메일 전송 */
-    sendByConfig(configName: string, options: SmtpSendByConfigOption): Promise<string>;
-}
-/**
- * 이메일 첨부 파일 정보
- *
- * content 또는 path 중 하나를 지정해야 한다.
- */
-export interface SmtpSendAttachment {
-    /** 첨부 파일명 */
-    filename: string;
-    /** 파일 내용 (바이너리) */
-    content?: Bytes;
-    /** 서버 내 파일 경로 */
-    path?: string;
-    /** MIME 타입 (예: "application/pdf") */
-    contentType?: string;
-}
-/** SMTP 연결 옵션 (공통) */
-export interface SmtpConnectionOptions {
-    host: string;
-    port?: number;
-    secure?: boolean;
-    user?: string;
-    pass?: string;
-}
-/** 이메일 내용 옵션 (공통) */
-export interface SmtpEmailContentOptions {
-    to: string;
-    cc?: string;
-    bcc?: string;
-    subject: string;
-    html: string;
-    attachments?: SmtpSendAttachment[];
-}
-export interface SmtpSendByConfigOption extends SmtpEmailContentOptions {
-}
-export interface SmtpSendOption extends SmtpConnectionOptions, SmtpEmailContentOptions {
-    from: string;
-}
-export interface SmtpConfig extends SmtpConnectionOptions {
-    senderName: string;
-    senderEmail?: string;
-}
-//# sourceMappingURL=smtp-service.types.d.ts.map

package/dist/service-types/smtp-service.types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"smtp-service.types.d.ts","sourceRoot":"","sources":["../../src/service-types/smtp-service.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAEnD;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,0BAA0B;IAC1B,IAAI,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,uBAAuB;IACvB,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACpF;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,aAAa;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,mBAAmB;IACnB,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,iBAAiB;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,sBAAsB;AACtB,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,qBAAqB;AACrB,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,sBAAuB,SAAQ,uBAAuB;CAAG;AAE1E,MAAM,WAAW,cAAe,SAAQ,qBAAqB,EAAE,uBAAuB;IACpF,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,UAAW,SAAQ,qBAAqB;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/dist/service-types/smtp-service.types.js

@@ -1 +0,0 @@
-//# sourceMappingURL=smtp-service.types.js.map

package/dist/service-types/smtp-service.types.js.map

@@ -1,6 +0,0 @@
-{
-  "version": 3,
-  "sources": [],
-  "mappings": "",
-  "names": []
-}

package/src/service-types/crypto-service.types.ts

@@ -1,23 +0,0 @@
-import type { Bytes } from "@simplysm/core-common";
-
-/**
- * 암호화 서비스 인터페이스
- *
- * SHA256 해시 및 AES 대칭키 암호화/복호화 기능을 제공한다.
- */
-export interface CryptoService {
-  /** SHA256 해시 생성 */
-  encrypt(data: string | Bytes): Promise<string>;
-  /** AES 암호화 */
-  encryptAes(data: Bytes): Promise<string>;
-  /** AES 복호화 */
-  decryptAes(encText: string): Promise<Bytes>;
-}
-
-/**
- * 암호화 서비스 설정
- */
-export interface CryptoConfig {
-  /** AES 암호화 키 */
-  key: string;
-}

package/src/service-types/smtp-service.types.ts

@@ -1,60 +0,0 @@
-import type { Bytes } from "@simplysm/core-common";
-
-/**
- * SMTP 서비스 인터페이스
- *
- * 이메일 전송 기능을 제공한다.
- * 직접 SMTP 설정을 전달하거나 서버 설정을 참조하여 전송할 수 있다.
- */
-export interface SmtpService {
-  /** 직접 SMTP 설정으로 이메일 전송 */
-  send(options: SmtpSendOption): Promise<string>;
-  /** 서버 설정 참조로 이메일 전송 */
-  sendByConfig(configName: string, options: SmtpSendByConfigOption): Promise<string>;
-}
-
-/**
- * 이메일 첨부 파일 정보
- *
- * content 또는 path 중 하나를 지정해야 한다.
- */
-export interface SmtpSendAttachment {
-  /** 첨부 파일명 */
-  filename: string;
-  /** 파일 내용 (바이너리) */
-  content?: Bytes;
-  /** 서버 내 파일 경로 */
-  path?: string;
-  /** MIME 타입 (예: "application/pdf") */
-  contentType?: string;
-}
-
-/** SMTP 연결 옵션 (공통) */
-export interface SmtpConnectionOptions {
-  host: string;
-  port?: number;
-  secure?: boolean;
-  user?: string;
-  pass?: string;
-}
-
-/** 이메일 내용 옵션 (공통) */
-export interface SmtpEmailContentOptions {
-  to: string;
-  cc?: string;
-  bcc?: string;
-  subject: string;
-  html: string;
-  attachments?: SmtpSendAttachment[];
-}
-
-export interface SmtpSendByConfigOption extends SmtpEmailContentOptions {}
-
-export interface SmtpSendOption extends SmtpConnectionOptions, SmtpEmailContentOptions {
-  from: string;
-}
-
-export interface SmtpConfig extends SmtpConnectionOptions {
-  senderName: string;
-  senderEmail?: string;
-}