@jthong/util 0.1.0-alpha.0 → 0.1.0-alpha.2

package/dist/string/index.d.ts

@@ -1,6 +1,94 @@
-declare const capitalize: (str: string) => string;
-declare const camelToKebab: (str: string) => string;
-declare const kebabToCamel: (str: string) => string;
-declare const truncate: (str: string, max: number, suffix?: string) => string;
-
-export { camelToKebab, capitalize, kebabToCamel, truncate };
+/**
+ * 문자열의 첫 글자를 대문자로 변환합니다.
+ *
+ * @param str - 변환할 문자열
+ * @returns 첫 글자가 대문자가 된 문자열. 빈 문자열은 그대로 반환됩니다.
+ * @example
+ * ```ts
+ * capitalize("hello"); // "Hello"
+ * capitalize("");      // ""
+ * ```
+ */
+export declare const capitalize: (str: string) => string;
+/**
+ * camelCase 문자열을 kebab-case로 변환합니다.
+ *
+ * @param str - camelCase 문자열
+ * @returns kebab-case로 변환된 문자열
+ * @example
+ * ```ts
+ * camelToKebab("backgroundColor"); // "background-color"
+ * camelToKebab("HTMLParser");      // "h-t-m-l-parser"
+ * ```
+ */
+export declare const camelToKebab: (str: string) => string;
+/**
+ * kebab-case 문자열을 camelCase로 변환합니다.
+ *
+ * @param str - kebab-case 문자열
+ * @returns camelCase로 변환된 문자열
+ * @example
+ * ```ts
+ * kebabToCamel("background-color"); // "backgroundColor"
+ * kebabToCamel("data-test-id");     // "dataTestId"
+ * ```
+ */
+export declare const kebabToCamel: (str: string) => string;
+/**
+ * 문자열이 최대 길이를 초과하면 잘라내고 접미사를 붙입니다.
+ *
+ * @param str - 원본 문자열
+ * @param max - 결과의 최대 길이 (접미사 포함)
+ * @param suffix - 잘렸을 때 붙일 접미사 (기본값 `"..."`)
+ * @returns 최대 길이 이하면 원본, 초과하면 잘린 문자열 + 접미사
+ * @example
+ * ```ts
+ * truncate("hello world", 8);          // "hello..."
+ * truncate("hi", 5);                   // "hi"   (변경 없음)
+ * truncate("hello world", 8, "…");     // "hello w…"
+ * ```
+ */
+export declare const truncate: (str: string, max: number, suffix?: string) => string;
+/**
+ * 숫자에 천 단위 구분자를 추가합니다. `Intl.NumberFormat` 기반이라 음수/소수/로케일을 모두 지원합니다.
+ *
+ * @param n - 포맷할 숫자
+ * @param locale - BCP 47 로케일 태그 (기본값 `"en-US"`)
+ * @returns 천 단위 구분자가 들어간 문자열
+ * @example
+ * ```ts
+ * formatNumber(1234567);          // "1,234,567"
+ * formatNumber(-1234.56);         // "-1,234.56"
+ * formatNumber(1234567, "de-DE"); // "1.234.567"  (독일은 점이 구분자)
+ * ```
+ */
+export declare const formatNumber: (n: number, locale?: string) => string;
+/**
+ * {@link mask} 함수의 옵션.
+ */
+export interface MaskOptions {
+    /** 앞에서 보존할 문자 수. 기본값 `1`. */
+    start?: number;
+    /** 뒤에서 보존할 문자 수. 기본값 `0`. */
+    end?: number;
+    /** 가릴 때 사용할 문자. 기본값 `"*"`. */
+    char?: string;
+}
+/**
+ * 문자열의 중간 일부를 마스킹 문자로 가립니다. 이메일/전화번호 등 민감 정보 표시에 유용합니다.
+ *
+ * 문자열이 `start + end`보다 짧으면 원본을 그대로 반환합니다.
+ *
+ * @param str - 원본 문자열
+ * @param opts - 마스킹 옵션 ({@link MaskOptions} 참고)
+ * @returns 마스킹된 문자열
+ * @example
+ * ```ts
+ * mask("01012345678", { start: 3, end: 4 });           // "010****5678"
+ * mask("jthong@gmail.com", { start: 1, end: 10 });     // "j*****@gmail.com"
+ * mask("secret", { start: 0, end: 0, char: "#" });     // "######"
+ * mask("hi", { start: 1, end: 1 });                    // "hi"  (너무 짧아 변경 없음)
+ * ```
+ */
+export declare const mask: (str: string, opts?: MaskOptions) => string;
+//# sourceMappingURL=index.d.ts.map

package/dist/string/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/string/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,GAAI,KAAK,MAAM,KAAG,MACsB,CAAC;AAEhE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,GAAI,KAAK,MAAM,KAAG,MAC4B,CAAC;AAExE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,GAAI,KAAK,MAAM,KAAG,MACkB,CAAC;AAE9D;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,QAAQ,GAAI,KAAK,MAAM,EAAE,KAAK,MAAM,EAAE,eAAc,KAAG,MACe,CAAC;AAEpF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,GAAI,GAAG,MAAM,EAAE,eAAgB,KAAG,MAClB,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,6BAA6B;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6BAA6B;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,IAAI,GAAI,KAAK,MAAM,EAAE,OAAM,WAAgB,KAAG,MAO1D,CAAC"}

package/dist/string/index.js

@@ -3,7 +3,16 @@ var capitalize = (str) => str.length === 0 ? str : str[0].toUpperCase() + str.sl
 var camelToKebab = (str) => str.replace(/[A-Z]/g, (m) => `-${m.toLowerCase()}`).replace(/^-/, "");
 var kebabToCamel = (str) => str.replace(/-([a-z])/g, (_, c) => c.toUpperCase());
 var truncate = (str, max, suffix = "...") => str.length <= max ? str : str.slice(0, Math.max(0, max - suffix.length)) + suffix;
+var formatNumber = (n, locale = "en-US") => new Intl.NumberFormat(locale).format(n);
+var mask = (str, opts = {}) => {
+  const start = Math.max(0, opts.start ?? 1);
+  const end = Math.max(0, opts.end ?? 0);
+  const char = opts.char ?? "*";
+  if (str.length <= start + end) return str;
+  const masked = char.repeat(str.length - start - end);
+  return str.slice(0, start) + masked + str.slice(str.length - end);
+};
 
-export { camelToKebab, capitalize, kebabToCamel, truncate };
+export { camelToKebab, capitalize, formatNumber, kebabToCamel, mask, truncate };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/string/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/string/index.ts"],"names":[],"mappings":";AAAO,IAAM,UAAA,GAAa,CAAC,GAAA,KACzB,GAAA,CAAI,WAAW,CAAA,GAAI,GAAA,GAAM,GAAA,CAAI,CAAC,CAAA,CAAG,WAAA,EAAY,GAAI,GAAA,CAAI,MAAM,CAAC;AAEvD,IAAM,eAAe,CAAC,GAAA,KAC3B,GAAA,CAAI,OAAA,CAAQ,UAAU,CAAC,CAAA,KAAM,CAAA,CAAA,EAAI,CAAA,CAAE,aAAa,CAAA,CAAE,CAAA,CAAE,OAAA,CAAQ,MAAM,EAAE;AAE/D,IAAM,YAAA,GAAe,CAAC,GAAA,KAC3B,GAAA,CAAI,OAAA,CAAQ,WAAA,EAAa,CAAC,CAAA,EAAG,CAAA,KAAc,CAAA,CAAE,WAAA,EAAa;AAErD,IAAM,QAAA,GAAW,CAAC,GAAA,EAAa,GAAA,EAAa,SAAS,KAAA,KAC1D,GAAA,CAAI,UAAU,GAAA,GAAM,GAAA,GAAM,IAAI,KAAA,CAAM,CAAA,EAAG,KAAK,GAAA,CAAI,CAAA,EAAG,MAAM,MAAA,CAAO,MAAM,CAAC,CAAA,GAAI","file":"index.js","sourcesContent":["export const capitalize = (str: string): string =>\n  str.length === 0 ? str : str[0]!.toUpperCase() + str.slice(1);\n\nexport const camelToKebab = (str: string): string =>\n  str.replace(/[A-Z]/g, (m) => `-${m.toLowerCase()}`).replace(/^-/, \"\");\n\nexport const kebabToCamel = (str: string): string =>\n  str.replace(/-([a-z])/g, (_, c: string) => c.toUpperCase());\n\nexport const truncate = (str: string, max: number, suffix = \"...\"): string =>\n  str.length <= max ? str : str.slice(0, Math.max(0, max - suffix.length)) + suffix;\n"]}
+{"version":3,"sources":["../../src/string/index.ts"],"names":[],"mappings":";AAWO,IAAM,UAAA,GAAa,CAAC,GAAA,KACzB,GAAA,CAAI,WAAW,CAAA,GAAI,GAAA,GAAM,GAAA,CAAI,CAAC,CAAA,CAAG,WAAA,EAAY,GAAI,GAAA,CAAI,MAAM,CAAC;AAavD,IAAM,eAAe,CAAC,GAAA,KAC3B,GAAA,CAAI,OAAA,CAAQ,UAAU,CAAC,CAAA,KAAM,CAAA,CAAA,EAAI,CAAA,CAAE,aAAa,CAAA,CAAE,CAAA,CAAE,OAAA,CAAQ,MAAM,EAAE;AAa/D,IAAM,YAAA,GAAe,CAAC,GAAA,KAC3B,GAAA,CAAI,OAAA,CAAQ,WAAA,EAAa,CAAC,CAAA,EAAG,CAAA,KAAc,CAAA,CAAE,WAAA,EAAa;AAgBrD,IAAM,QAAA,GAAW,CAAC,GAAA,EAAa,GAAA,EAAa,SAAS,KAAA,KAC1D,GAAA,CAAI,UAAU,GAAA,GAAM,GAAA,GAAM,IAAI,KAAA,CAAM,CAAA,EAAG,KAAK,GAAA,CAAI,CAAA,EAAG,MAAM,MAAA,CAAO,MAAM,CAAC,CAAA,GAAI;AAetE,IAAM,YAAA,GAAe,CAAC,CAAA,EAAW,MAAA,GAAS,OAAA,KAC/C,IAAI,IAAA,CAAK,YAAA,CAAa,MAAM,CAAA,CAAE,MAAA,CAAO,CAAC;AA8BjC,IAAM,IAAA,GAAO,CAAC,GAAA,EAAa,IAAA,GAAoB,EAAC,KAAc;AACnE,EAAA,MAAM,QAAQ,IAAA,CAAK,GAAA,CAAI,CAAA,EAAG,IAAA,CAAK,SAAS,CAAC,CAAA;AACzC,EAAA,MAAM,MAAM,IAAA,CAAK,GAAA,CAAI,CAAA,EAAG,IAAA,CAAK,OAAO,CAAC,CAAA;AACrC,EAAA,MAAM,IAAA,GAAO,KAAK,IAAA,IAAQ,GAAA;AAC1B,EAAA,IAAI,GAAA,CAAI,MAAA,IAAU,KAAA,GAAQ,GAAA,EAAK,OAAO,GAAA;AACtC,EAAA,MAAM,SAAS,IAAA,CAAK,MAAA,CAAO,GAAA,CAAI,MAAA,GAAS,QAAQ,GAAG,CAAA;AACnD,EAAA,OAAO,GAAA,CAAI,KAAA,CAAM,CAAA,EAAG,KAAK,CAAA,GAAI,SAAS,GAAA,CAAI,KAAA,CAAM,GAAA,CAAI,MAAA,GAAS,GAAG,CAAA;AAClE","file":"index.js","sourcesContent":["/**\n * 문자열의 첫 글자를 대문자로 변환합니다.\n *\n * @param str - 변환할 문자열\n * @returns 첫 글자가 대문자가 된 문자열. 빈 문자열은 그대로 반환됩니다.\n * @example\n * ```ts\n * capitalize(\"hello\"); // \"Hello\"\n * capitalize(\"\");      // \"\"\n * ```\n */\nexport const capitalize = (str: string): string =>\n  str.length === 0 ? str : str[0]!.toUpperCase() + str.slice(1);\n\n/**\n * camelCase 문자열을 kebab-case로 변환합니다.\n *\n * @param str - camelCase 문자열\n * @returns kebab-case로 변환된 문자열\n * @example\n * ```ts\n * camelToKebab(\"backgroundColor\"); // \"background-color\"\n * camelToKebab(\"HTMLParser\");      // \"h-t-m-l-parser\"\n * ```\n */\nexport const camelToKebab = (str: string): string =>\n  str.replace(/[A-Z]/g, (m) => `-${m.toLowerCase()}`).replace(/^-/, \"\");\n\n/**\n * kebab-case 문자열을 camelCase로 변환합니다.\n *\n * @param str - kebab-case 문자열\n * @returns camelCase로 변환된 문자열\n * @example\n * ```ts\n * kebabToCamel(\"background-color\"); // \"backgroundColor\"\n * kebabToCamel(\"data-test-id\");     // \"dataTestId\"\n * ```\n */\nexport const kebabToCamel = (str: string): string =>\n  str.replace(/-([a-z])/g, (_, c: string) => c.toUpperCase());\n\n/**\n * 문자열이 최대 길이를 초과하면 잘라내고 접미사를 붙입니다.\n *\n * @param str - 원본 문자열\n * @param max - 결과의 최대 길이 (접미사 포함)\n * @param suffix - 잘렸을 때 붙일 접미사 (기본값 `\"...\"`)\n * @returns 최대 길이 이하면 원본, 초과하면 잘린 문자열 + 접미사\n * @example\n * ```ts\n * truncate(\"hello world\", 8);          // \"hello...\"\n * truncate(\"hi\", 5);                   // \"hi\"   (변경 없음)\n * truncate(\"hello world\", 8, \"…\");     // \"hello w…\"\n * ```\n */\nexport const truncate = (str: string, max: number, suffix = \"...\"): string =>\n  str.length <= max ? str : str.slice(0, Math.max(0, max - suffix.length)) + suffix;\n\n/**\n * 숫자에 천 단위 구분자를 추가합니다. `Intl.NumberFormat` 기반이라 음수/소수/로케일을 모두 지원합니다.\n *\n * @param n - 포맷할 숫자\n * @param locale - BCP 47 로케일 태그 (기본값 `\"en-US\"`)\n * @returns 천 단위 구분자가 들어간 문자열\n * @example\n * ```ts\n * formatNumber(1234567);          // \"1,234,567\"\n * formatNumber(-1234.56);         // \"-1,234.56\"\n * formatNumber(1234567, \"de-DE\"); // \"1.234.567\"  (독일은 점이 구분자)\n * ```\n */\nexport const formatNumber = (n: number, locale = \"en-US\"): string =>\n  new Intl.NumberFormat(locale).format(n);\n\n/**\n * {@link mask} 함수의 옵션.\n */\nexport interface MaskOptions {\n  /** 앞에서 보존할 문자 수. 기본값 `1`. */\n  start?: number;\n  /** 뒤에서 보존할 문자 수. 기본값 `0`. */\n  end?: number;\n  /** 가릴 때 사용할 문자. 기본값 `\"*\"`. */\n  char?: string;\n}\n\n/**\n * 문자열의 중간 일부를 마스킹 문자로 가립니다. 이메일/전화번호 등 민감 정보 표시에 유용합니다.\n *\n * 문자열이 `start + end`보다 짧으면 원본을 그대로 반환합니다.\n *\n * @param str - 원본 문자열\n * @param opts - 마스킹 옵션 ({@link MaskOptions} 참고)\n * @returns 마스킹된 문자열\n * @example\n * ```ts\n * mask(\"01012345678\", { start: 3, end: 4 });           // \"010****5678\"\n * mask(\"jthong@gmail.com\", { start: 1, end: 10 });     // \"j*****@gmail.com\"\n * mask(\"secret\", { start: 0, end: 0, char: \"#\" });     // \"######\"\n * mask(\"hi\", { start: 1, end: 1 });                    // \"hi\"  (너무 짧아 변경 없음)\n * ```\n */\nexport const mask = (str: string, opts: MaskOptions = {}): string => {\n  const start = Math.max(0, opts.start ?? 1);\n  const end = Math.max(0, opts.end ?? 0);\n  const char = opts.char ?? \"*\";\n  if (str.length <= start + end) return str;\n  const masked = char.repeat(str.length - start - end);\n  return str.slice(0, start) + masked + str.slice(str.length - end);\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jthong/util",
-  "version": "0.1.0-alpha.0",
+  "version": "0.1.0-alpha.2",
   "description": "Framework-agnostic TypeScript utility functions",
   "license": "MIT",
   "type": "module",
@@ -48,7 +48,7 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsup",
+    "build": "tsup && tsc --emitDeclarationOnly --declaration --declarationMap --outDir dist",
     "dev": "tsup --watch",
     "test": "vitest run",
     "test:watch": "vitest",

package/dist/array/index.d.cts

@@ -1,6 +0,0 @@
-declare const chunk: <T>(arr: readonly T[], size: number) => T[][];
-declare const unique: <T>(arr: readonly T[]) => T[];
-declare const groupBy: <T, K extends PropertyKey>(arr: readonly T[], keyFn: (item: T) => K) => Record<K, T[]>;
-declare const range: (start: number, end?: number, step?: number) => number[];
-
-export { chunk, groupBy, range, unique };

package/dist/fn/index.d.cts

@@ -1,5 +0,0 @@
-declare const debounce: <Args extends unknown[]>(fn: (...args: Args) => void, ms: number) => ((...args: Args) => void);
-declare const throttle: <Args extends unknown[]>(fn: (...args: Args) => void, ms: number) => ((...args: Args) => void);
-declare const sleep: (ms: number) => Promise<void>;
-
-export { debounce, sleep, throttle };

package/dist/index.d.cts

@@ -1,4 +0,0 @@
-export { camelToKebab, capitalize, kebabToCamel, truncate } from './string/index.cjs';
-export { chunk, groupBy, range, unique } from './array/index.cjs';
-export { isPlainObject, omit, pick } from './object/index.cjs';
-export { debounce, sleep, throttle } from './fn/index.cjs';

package/dist/object/index.d.cts

@@ -1,5 +0,0 @@
-declare const pick: <T extends object, K extends keyof T>(obj: T, keys: readonly K[]) => Pick<T, K>;
-declare const omit: <T extends object, K extends keyof T>(obj: T, keys: readonly K[]) => Omit<T, K>;
-declare const isPlainObject: (value: unknown) => value is Record<string, unknown>;
-
-export { isPlainObject, omit, pick };

package/dist/string/index.d.cts

@@ -1,6 +0,0 @@
-declare const capitalize: (str: string) => string;
-declare const camelToKebab: (str: string) => string;
-declare const kebabToCamel: (str: string) => string;
-declare const truncate: (str: string, max: number, suffix?: string) => string;
-
-export { camelToKebab, capitalize, kebabToCamel, truncate };