@simplysm/core-common 13.0.96 → 13.0.98
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +117 -70
- package/dist/env.d.ts +5 -0
- package/dist/env.d.ts.map +1 -1
- package/dist/env.js +6 -3
- package/dist/env.js.map +1 -1
- package/docs/errors.md +119 -0
- package/docs/extensions.md +387 -0
- package/docs/features.md +95 -295
- package/docs/types.md +202 -256
- package/docs/utils.md +708 -0
- package/package.json +2 -2
- package/src/env.ts +13 -3
- package/docs/utilities.md +0 -359
package/src/env.ts
CHANGED
|
@@ -1,11 +1,21 @@
|
|
|
1
1
|
declare const process: { env: { DEV?: string; VER?: string; [key: string]: string | undefined } };
|
|
2
2
|
|
|
3
|
+
declare global {
|
|
4
|
+
interface ImportMeta {
|
|
5
|
+
env?: Record<string, unknown>;
|
|
6
|
+
}
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
const _metaEnv: Record<string, unknown> = import.meta.env ?? {};
|
|
10
|
+
const _processEnv: Record<string, unknown> = typeof process !== "undefined" ? process.env : {};
|
|
11
|
+
const _raw: Record<string, unknown> = { ..._metaEnv, ..._processEnv };
|
|
12
|
+
|
|
3
13
|
export const env: {
|
|
4
14
|
DEV: boolean;
|
|
5
15
|
VER?: string;
|
|
6
16
|
[key: string]: unknown;
|
|
7
17
|
} = {
|
|
8
|
-
...
|
|
9
|
-
DEV: JSON.parse(
|
|
10
|
-
VER:
|
|
18
|
+
..._raw,
|
|
19
|
+
DEV: JSON.parse(String(_raw["DEV"] != null && String(_raw["DEV"]) !== "" ? _raw["DEV"] : false)),
|
|
20
|
+
VER: _raw["VER"] as string | undefined,
|
|
11
21
|
};
|
package/docs/utilities.md
DELETED
|
@@ -1,359 +0,0 @@
|
|
|
1
|
-
# 유틸리티
|
|
2
|
-
|
|
3
|
-
네임스페이스로 그룹화된 유틸리티 함수들.
|
|
4
|
-
|
|
5
|
-
## obj -- 객체 유틸리티
|
|
6
|
-
|
|
7
|
-
### 클론/비교/병합
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
import { obj } from "@simplysm/core-common";
|
|
11
|
-
|
|
12
|
-
// 딥 클론 (순환 참조, 커스텀 타입 지원)
|
|
13
|
-
// 지원: DateTime, DateOnly, Time, Uuid, Uint8Array, Date, RegExp, Error, Map, Set, Array
|
|
14
|
-
// 함수/Symbol은 참조 유지, 프로토타입 체인 유지
|
|
15
|
-
const cloned = obj.clone(source);
|
|
16
|
-
|
|
17
|
-
// 딥 비교
|
|
18
|
-
obj.equal(a, b);
|
|
19
|
-
obj.equal(a, b, { shallow: true }); // 1단계만 비교
|
|
20
|
-
obj.equal(a, b, { ignoreArrayIndex: true }); // 배열 순서 무시 (O(n^2))
|
|
21
|
-
obj.equal(a, b, { topLevelIncludes: ["name", "age"] }); // 특정 키만 비교 (최상위만)
|
|
22
|
-
obj.equal(a, b, { topLevelExcludes: ["updatedAt"] }); // 특정 키 제외 (최상위만)
|
|
23
|
-
|
|
24
|
-
// 딥 병합
|
|
25
|
-
obj.merge(source, target);
|
|
26
|
-
obj.merge(source, target, { arrayProcess: "concat" }); // 배열 연결 (Set 기반 중복 제거)
|
|
27
|
-
obj.merge(source, target, { arrayProcess: "replace" }); // 배열 교체 (기본값)
|
|
28
|
-
obj.merge(source, target, { useDelTargetNull: true }); // target이 null이면 키 삭제
|
|
29
|
-
|
|
30
|
-
// 3-way 병합
|
|
31
|
-
const { conflict, result } = obj.merge3(source, origin, target);
|
|
32
|
-
// source와 origin 같고 target 다름 -> target 값 사용
|
|
33
|
-
// target과 origin 같고 source 다름 -> source 값 사용
|
|
34
|
-
// 세 값 모두 다름 -> conflict = true, origin 값 유지
|
|
35
|
-
|
|
36
|
-
// 키별 비교 옵션
|
|
37
|
-
obj.merge3(source, origin, target, {
|
|
38
|
-
name: { keys: ["first", "last"] },
|
|
39
|
-
tags: { ignoreArrayIndex: true },
|
|
40
|
-
});
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
### 객체 조작
|
|
44
|
-
|
|
45
|
-
```typescript
|
|
46
|
-
// pick/omit
|
|
47
|
-
obj.pick(item, ["name", "age"]); // { name, age }
|
|
48
|
-
obj.omit(item, ["password"]); // password 제외
|
|
49
|
-
obj.omitByFilter(item, (key) => key.startsWith("_")); // 조건부 제외
|
|
50
|
-
|
|
51
|
-
// 체인 접근 (점 표기법)
|
|
52
|
-
obj.getChainValue(data, "user.address[0].city");
|
|
53
|
-
obj.getChainValue(data, "user.name", true); // optional: 중간 경로 없으면 undefined
|
|
54
|
-
obj.setChainValue(data, "user.name", "new"); // 중간 경로 없으면 자동 생성
|
|
55
|
-
obj.deleteChainValue(data, "user.temp"); // 중간 경로 없으면 무시
|
|
56
|
-
|
|
57
|
-
// 깊이 기반 체인 접근
|
|
58
|
-
obj.getChainValueByDepth(data, "parent", 2); // data.parent.parent
|
|
59
|
-
obj.getChainValueByDepth(data, "parent", 2, true); // optional 모드
|
|
60
|
-
|
|
61
|
-
// 기타
|
|
62
|
-
obj.clearUndefined(data); // undefined 키 제거 (mutate)
|
|
63
|
-
obj.clear(data); // 모든 키 제거 (mutate)
|
|
64
|
-
obj.nullToUndefined(data); // null -> undefined (재귀, mutate, 순환 참조 안전)
|
|
65
|
-
obj.unflatten({ "a.b.c": 1 }); // { a: { b: { c: 1 } } }
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
### 타입 유틸리티
|
|
69
|
-
|
|
70
|
-
```typescript
|
|
71
|
-
obj.keys(myObj); // 타입 안전한 Object.keys
|
|
72
|
-
obj.entries(myObj); // 타입 안전한 Object.entries
|
|
73
|
-
obj.fromEntries(pairs); // 타입 안전한 Object.fromEntries
|
|
74
|
-
|
|
75
|
-
// 객체 엔트리 변환
|
|
76
|
-
obj.map(colors, (key, rgb) => [null, `rgb(${rgb})`]);
|
|
77
|
-
// key를 null로 반환하면 원래 key 유지, 새 key를 반환하면 key 변환
|
|
78
|
-
|
|
79
|
-
type A = obj.UndefToOptional<{ a: string | undefined }>; // { a?: string | undefined }
|
|
80
|
-
type B = obj.OptionalToUndef<{ a?: string }>; // { a: string | undefined }
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
---
|
|
84
|
-
|
|
85
|
-
## str -- 문자열 유틸리티
|
|
86
|
-
|
|
87
|
-
```typescript
|
|
88
|
-
import { str } from "@simplysm/core-common";
|
|
89
|
-
|
|
90
|
-
str.toPascalCase("hello-world"); // "HelloWorld"
|
|
91
|
-
str.toCamelCase("hello-world"); // "helloWorld"
|
|
92
|
-
str.toKebabCase("HelloWorld"); // "hello-world"
|
|
93
|
-
str.toSnakeCase("HelloWorld"); // "hello_world"
|
|
94
|
-
|
|
95
|
-
str.isNullOrEmpty(value); // value is "" | undefined (타입 가드)
|
|
96
|
-
str.insert("abcde", 2, "XY"); // "abXYcde"
|
|
97
|
-
str.replaceFullWidth("ABC"); // "ABC" (전각 -> 반각)
|
|
98
|
-
|
|
99
|
-
// 한국어 조사
|
|
100
|
-
str.getKoreanSuffix("사과", "을"); // "를"
|
|
101
|
-
str.getKoreanSuffix("바나나", "을"); // "을"
|
|
102
|
-
str.getKoreanSuffix("칼", "로"); // "로" (ㄹ 종성 특수 처리)
|
|
103
|
-
// 지원 타입: "을"(을/를), "은"(은/는), "이"(이/가), "와"(과/와), "랑"(이랑/랑), "로"(으로/로), "라"(이라/라)
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
---
|
|
107
|
-
|
|
108
|
-
## num -- 숫자 유틸리티
|
|
109
|
-
|
|
110
|
-
```typescript
|
|
111
|
-
import { num } from "@simplysm/core-common";
|
|
112
|
-
|
|
113
|
-
// 파싱 (비숫자 문자 자동 제거)
|
|
114
|
-
num.parseInt("1,234원"); // 1234
|
|
115
|
-
num.parseFloat("$1,234.56"); // 1234.56
|
|
116
|
-
num.parseRoundedInt("1.7"); // 2
|
|
117
|
-
|
|
118
|
-
num.isNullOrEmpty(value); // value is 0 | undefined (타입 가드)
|
|
119
|
-
|
|
120
|
-
// 포맷 (천 단위 구분자)
|
|
121
|
-
num.format(1234567); // "1,234,567"
|
|
122
|
-
num.format(1234.5678, { max: 2 }); // "1,234.57"
|
|
123
|
-
num.format(1234.5, { min: 2 }); // "1,234.50"
|
|
124
|
-
num.format(1234.5, { min: 2, max: 4 }); // "1,234.50"
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
---
|
|
128
|
-
|
|
129
|
-
## bytes -- 바이너리 유틸리티
|
|
130
|
-
|
|
131
|
-
```typescript
|
|
132
|
-
import { bytes } from "@simplysm/core-common";
|
|
133
|
-
|
|
134
|
-
bytes.concat([arr1, arr2, arr3]); // Uint8Array 연결
|
|
135
|
-
bytes.toHex(data); // 소문자 hex 문자열
|
|
136
|
-
bytes.fromHex("48656c6c6f"); // Uint8Array
|
|
137
|
-
bytes.toBase64(data); // base64 인코딩
|
|
138
|
-
bytes.fromBase64(b64str); // base64 디코딩
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
---
|
|
142
|
-
|
|
143
|
-
## json -- JSON 직렬화
|
|
144
|
-
|
|
145
|
-
커스텀 타입(DateTime, DateOnly, Time, Uuid, Set, Map, Error, Uint8Array, Date, RegExp 등)을 지원하는 JSON 직렬화/역직렬화.
|
|
146
|
-
|
|
147
|
-
내부적으로 `__type__`/`data` 형식의 태그 객체를 사용하여 타입 정보를 보존한다.
|
|
148
|
-
|
|
149
|
-
```typescript
|
|
150
|
-
import { json, DateTime } from "@simplysm/core-common";
|
|
151
|
-
|
|
152
|
-
// 직렬화 (커스텀 타입 자동 처리)
|
|
153
|
-
const str = json.stringify({
|
|
154
|
-
date: new DateTime(),
|
|
155
|
-
id: Uuid.generate(),
|
|
156
|
-
items: new Set([1, 2, 3]),
|
|
157
|
-
mapping: new Map([["a", 1]]),
|
|
158
|
-
});
|
|
159
|
-
|
|
160
|
-
// 역직렬화 (타입 자동 복원, null -> undefined 변환)
|
|
161
|
-
const data = json.parse<{ date: DateTime }>(str);
|
|
162
|
-
|
|
163
|
-
// 옵션
|
|
164
|
-
json.stringify(obj, { space: 2 }); // 들여쓰기
|
|
165
|
-
json.stringify(obj, { redactBytes: true }); // Uint8Array를 "__hidden__"로 대체 (로깅용)
|
|
166
|
-
json.stringify(obj, { replacer: (key, value) => value }); // 커스텀 replacer
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
**주의사항:**
|
|
170
|
-
- `parse()`는 모든 JSON null을 undefined로 변환한다 (simplysm 프레임워크의 null-free 규칙)
|
|
171
|
-
- `redactBytes: true`로 직렬화한 결과는 `parse()`로 복원 불가 (SdError 발생)
|
|
172
|
-
- 순환 참조가 있으면 TypeError 발생
|
|
173
|
-
|
|
174
|
-
---
|
|
175
|
-
|
|
176
|
-
## xml -- XML 처리
|
|
177
|
-
|
|
178
|
-
```typescript
|
|
179
|
-
import { xml } from "@simplysm/core-common";
|
|
180
|
-
|
|
181
|
-
// 파싱 (속성은 $ 객체, 텍스트는 _ 키, 자식 요소는 배열)
|
|
182
|
-
const obj = xml.parse('<root attr="1"><child>text</child></root>');
|
|
183
|
-
// { root: { $: { attr: "1" }, child: [{ _: "text" }] } }
|
|
184
|
-
|
|
185
|
-
// 네임스페이스 접두사 제거
|
|
186
|
-
xml.parse(xmlStr, { stripTagPrefix: true });
|
|
187
|
-
|
|
188
|
-
// 직렬화
|
|
189
|
-
const xmlStr = xml.stringify(obj);
|
|
190
|
-
// fast-xml-parser의 XmlBuilderOptions를 두 번째 인자로 전달 가능
|
|
191
|
-
xml.stringify(obj, { format: true });
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
---
|
|
195
|
-
|
|
196
|
-
## path -- 경로 유틸리티
|
|
197
|
-
|
|
198
|
-
POSIX 스타일 전용 경로 유틸리티. 브라우저 환경과 Capacitor 플러그인을 위해 설계되었다. Windows 백슬래시 경로는 지원하지 않는다.
|
|
199
|
-
|
|
200
|
-
```typescript
|
|
201
|
-
import { path } from "@simplysm/core-common";
|
|
202
|
-
|
|
203
|
-
path.join("a", "b", "c.txt"); // "a/b/c.txt"
|
|
204
|
-
path.basename("/a/b/file.ts"); // "file.ts"
|
|
205
|
-
path.basename("/a/b/file.ts", ".ts"); // "file"
|
|
206
|
-
path.extname("/a/b/file.ts"); // ".ts"
|
|
207
|
-
path.extname("/a/b/.gitignore"); // "" (숨김 파일은 빈 문자열)
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
---
|
|
211
|
-
|
|
212
|
-
## wait -- 비동기 대기
|
|
213
|
-
|
|
214
|
-
```typescript
|
|
215
|
-
import { wait } from "@simplysm/core-common";
|
|
216
|
-
|
|
217
|
-
// 조건 충족까지 대기
|
|
218
|
-
await wait.until(() => isReady, 100, 50);
|
|
219
|
-
// 100ms 간격으로 체크, 최대 50회 (초과 시 TimeoutError)
|
|
220
|
-
// 첫 호출에서 true면 즉시 반환
|
|
221
|
-
|
|
222
|
-
// 시간 대기
|
|
223
|
-
await wait.time(1000); // 1초 대기
|
|
224
|
-
```
|
|
225
|
-
|
|
226
|
-
---
|
|
227
|
-
|
|
228
|
-
## err -- 에러 처리
|
|
229
|
-
|
|
230
|
-
```typescript
|
|
231
|
-
import { err } from "@simplysm/core-common";
|
|
232
|
-
|
|
233
|
-
try { /* ... */ } catch (e) {
|
|
234
|
-
const message = err.message(e); // unknown 타입에서 안전하게 메시지 추출
|
|
235
|
-
// Error 인스턴스면 .message, 아니면 String(e)
|
|
236
|
-
}
|
|
237
|
-
```
|
|
238
|
-
|
|
239
|
-
---
|
|
240
|
-
|
|
241
|
-
## dt -- 날짜 포맷
|
|
242
|
-
|
|
243
|
-
```typescript
|
|
244
|
-
import { dt } from "@simplysm/core-common";
|
|
245
|
-
|
|
246
|
-
// 포맷 (DateTime/DateOnly/Time의 toFormatString이 내부적으로 사용)
|
|
247
|
-
dt.format("yyyy-MM-dd", { year: 2024, month: 1, day: 15 });
|
|
248
|
-
dt.format("HH:mm:ss", { hour: 14, minute: 30, second: 0 });
|
|
249
|
-
|
|
250
|
-
// 월 정규화
|
|
251
|
-
dt.normalizeMonth(2024, 13, 1); // { year: 2025, month: 1, day: 1 }
|
|
252
|
-
dt.normalizeMonth(2025, 2, 31); // { year: 2025, month: 2, day: 28 }
|
|
253
|
-
|
|
254
|
-
// 12시간 -> 24시간 변환
|
|
255
|
-
dt.convert12To24(12, false); // 0 (12 AM = 0시)
|
|
256
|
-
dt.convert12To24(12, true); // 12 (12 PM = 12시)
|
|
257
|
-
dt.convert12To24(2, true); // 14 (PM 2시 = 14시)
|
|
258
|
-
```
|
|
259
|
-
|
|
260
|
-
---
|
|
261
|
-
|
|
262
|
-
## primitive -- 프리미티브 타입 판별
|
|
263
|
-
|
|
264
|
-
```typescript
|
|
265
|
-
import { primitive } from "@simplysm/core-common";
|
|
266
|
-
|
|
267
|
-
primitive.typeStr("hello"); // "string"
|
|
268
|
-
primitive.typeStr(123); // "number"
|
|
269
|
-
primitive.typeStr(true); // "boolean"
|
|
270
|
-
primitive.typeStr(new DateTime()); // "DateTime"
|
|
271
|
-
primitive.typeStr(new DateOnly()); // "DateOnly"
|
|
272
|
-
primitive.typeStr(new Time()); // "Time"
|
|
273
|
-
primitive.typeStr(new Uuid("...")); // "Uuid"
|
|
274
|
-
primitive.typeStr(new Uint8Array()); // "Bytes"
|
|
275
|
-
```
|
|
276
|
-
|
|
277
|
-
---
|
|
278
|
-
|
|
279
|
-
## transfer -- Worker 데이터 전송
|
|
280
|
-
|
|
281
|
-
Worker `postMessage`용 직렬화/역직렬화. 순환 참조 감지(경로 포함 TypeError), 커스텀 타입 지원.
|
|
282
|
-
|
|
283
|
-
지원 타입: Date, DateTime, DateOnly, Time, Uuid, RegExp, Error(cause/code/detail 포함), Uint8Array, Array, Map, Set, plain object.
|
|
284
|
-
|
|
285
|
-
```typescript
|
|
286
|
-
import { transfer } from "@simplysm/core-common";
|
|
287
|
-
|
|
288
|
-
// Worker로 전송
|
|
289
|
-
const { result, transferList } = transfer.encode(data);
|
|
290
|
-
worker.postMessage(result, transferList);
|
|
291
|
-
// Uint8Array의 ArrayBuffer가 자동으로 transferList에 추가됨
|
|
292
|
-
// SharedArrayBuffer는 transferList에 포함되지 않음
|
|
293
|
-
|
|
294
|
-
// Worker에서 수신
|
|
295
|
-
const original = transfer.decode(event.data);
|
|
296
|
-
```
|
|
297
|
-
|
|
298
|
-
---
|
|
299
|
-
|
|
300
|
-
## 템플릿 문자열 태그
|
|
301
|
-
|
|
302
|
-
IDE 구문 강조를 위한 태그 함수. 들여쓰기 자동 정규화 (공통 들여쓰기 제거, 앞뒤 빈 줄 제거).
|
|
303
|
-
|
|
304
|
-
```typescript
|
|
305
|
-
import { js, ts, html, tsql, mysql, pgsql } from "@simplysm/core-common";
|
|
306
|
-
|
|
307
|
-
const query = tsql`
|
|
308
|
-
SELECT *
|
|
309
|
-
FROM Users
|
|
310
|
-
WHERE id = ${userId}
|
|
311
|
-
`;
|
|
312
|
-
|
|
313
|
-
const markup = html`
|
|
314
|
-
<div class="container">
|
|
315
|
-
<h1>${title}</h1>
|
|
316
|
-
</div>
|
|
317
|
-
`;
|
|
318
|
-
|
|
319
|
-
// js, ts, mysql, pgsql도 동일하게 동작
|
|
320
|
-
```
|
|
321
|
-
|
|
322
|
-
---
|
|
323
|
-
|
|
324
|
-
## ZipArchive -- ZIP 처리
|
|
325
|
-
|
|
326
|
-
`@zip.js/zip.js` 기반 ZIP 파일 처리. 내부 캐싱으로 동일 파일 중복 해제를 방지한다.
|
|
327
|
-
|
|
328
|
-
```typescript
|
|
329
|
-
import { ZipArchive } from "@simplysm/core-common";
|
|
330
|
-
|
|
331
|
-
// ZIP 읽기 (await using 지원)
|
|
332
|
-
await using zip = new ZipArchive(blobOrBytes);
|
|
333
|
-
const fileData = await zip.get("path/to/file.txt");
|
|
334
|
-
const exists = await zip.exists("file.txt");
|
|
335
|
-
|
|
336
|
-
// 전체 파일 추출 (진행률 콜백)
|
|
337
|
-
const allFiles = await zip.extractAll((progress) => {
|
|
338
|
-
// progress: { fileName, totalSize, extractedSize }
|
|
339
|
-
});
|
|
340
|
-
// 반환: Map<string, Bytes | undefined>
|
|
341
|
-
|
|
342
|
-
// ZIP 생성
|
|
343
|
-
await using newZip = new ZipArchive();
|
|
344
|
-
newZip.write("file1.txt", data1);
|
|
345
|
-
newZip.write("dir/file2.txt", data2);
|
|
346
|
-
const compressed = await newZip.compress();
|
|
347
|
-
|
|
348
|
-
// 수동 정리 (await using을 사용하지 않는 경우)
|
|
349
|
-
await zip.close();
|
|
350
|
-
```
|
|
351
|
-
|
|
352
|
-
| 메서드 | 시그니처 | 설명 |
|
|
353
|
-
|--------|---------|------|
|
|
354
|
-
| `get` | `get(fileName: string): Promise<Bytes \| undefined>` | 파일 추출 (캐시 사용) |
|
|
355
|
-
| `exists` | `exists(fileName: string): Promise<boolean>` | 파일 존재 여부 |
|
|
356
|
-
| `extractAll` | `extractAll(cb?): Promise<Map<string, Bytes \| undefined>>` | 전체 추출 |
|
|
357
|
-
| `write` | `write(fileName: string, bytes: Bytes): void` | 파일 쓰기 (캐시에 저장) |
|
|
358
|
-
| `compress` | `compress(): Promise<Bytes>` | 캐시 내용을 ZIP으로 압축 |
|
|
359
|
-
| `close` | `close(): Promise<void>` | 리더 닫기 및 캐시 정리 |
|