uniconst 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 kiccer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+# Uniconst
+
+Uniconst is a lightweight TypeScript utility library designed to manage constant mappings in a type-safe and structured manner. It provides an intuitive class-based API for handling constants with associated labels, values, and additional metadata such as colors.
+
+## 📌 Features
+
+* **Type Safety**: Built with TypeScript generics to ensure compile-time type checking.
+* **Flexible Data Structure**: Supports extensible constant items with customizable fields.
+* **Utility Methods**: Offers convenient methods for retrieving values, extracting options, and mapping labels.
+* **Scalable Design**: Easily integrable into various applications including UI frameworks, backend services, and configuration systems.
+
+## 🛠️ Usage
+
+Create a constant definition object and instantiate the `Uniconst` class:
+
+```ts
+import Uniconst from 'uniconst';
+
+const Status = new Uniconst({
+  PENDING: { label: 'Pending', value: 0 },
+  APPROVED: { label: 'Approved', value: 1 },
+  REJECTED: { label: 'Rejected', value: 2 }
+});
+
+console.log(Status.get('PENDING')); // { label: 'Pending', value: 0 }
+console.log(Status.getOptions());   // Array of all options
+console.log(Status.toLabelMap());   // { '0': 'Pending', '1': 'Approved', '2': 'Rejected' }
+```
+
+## ✅ Benefits
+
+* **Strong Typing**: Ensures that only valid keys and values are accessed.
+* **Extensible**: You can add custom fields to your constant items without breaking existing logic.
+* **Clean Abstraction**: Encapsulates common patterns for working with labeled constants.
+
+## 📦 Installation
+
+If you plan to publish this package to npm, install it via:
+
+```bash
+npm install uniconst
+```
+
+Or if using yarn:
+
+```bash
+yarn add uniconst
+```
+
+## 📄 License
+
+MIT License — See LICENSE for details.

package/README.zh_CN.md

@@ -0,0 +1,52 @@
+# Uniconst
+
+Uniconst 是一个轻量级的 TypeScript 工具库，旨在以类型安全且结构化的方式管理常量映射。它提供了一个基于类的直观 API，用于处理带有相关标签、值以及附加元数据（如颜色）的常量。
+
+## 📌 特性
+
+* **类型安全**：使用 TypeScript 泛型确保编译时类型检查。
+* **灵活的数据结构**：支持带有可扩展字段的常量项。
+* **实用方法**：提供便捷的方法用于获取值、提取选项和映射标签。
+* **可扩展的设计**：易于集成到各种应用中，包括 UI 框架、后端服务和配置系统。
+
+## 🛠️ 使用方法
+
+创建一个常量定义对象并实例化 `Uniconst` 类:
+
+```ts
+import Uniconst from 'uniconst';
+
+const Status = new Uniconst({
+  PENDING: { label: 'Pending', value: 0 },
+  APPROVED: { label: 'Approved', value: 1 },
+  REJECTED: { label: 'Rejected', value: 2 }
+});
+
+console.log(Status.get('PENDING')); // { label: 'Pending', value: 0 }
+console.log(Status.getOptions());   // 所有选项的数组
+console.log(Status.toLabelMap());   // { '0': 'Pending', '1': 'Approved', '2': 'Rejected' }
+```
+
+## ✅ 优势
+
+* **强类型**：确保只能访问有效的键和值。
+* **可扩展性**：可以向常量项中添加自定义字段而不破坏现有逻辑。
+* **清晰的抽象**：封装了处理带标签常量的常见模式。
+
+## 📦 Installation
+
+如果你计划将此包发布到 npm，可以通过以下方式安装:
+
+```bash
+npm install uniconst
+```
+
+或使用 yarn:
+
+```bash
+yarn add uniconst
+```
+
+## 📄 许可证
+
+MIT License — 详情请查看 LICENSE 文件。

package/dist/index.d.mts

@@ -0,0 +1,43 @@
+interface UniconstItem {
+    label: string;
+    value: string | number;
+    color: string;
+    [key: string]: any;
+}
+interface UniconstOptions {
+    [key: string]: UniconstItem;
+}
+interface UniconstMaps {
+    [key: UniconstItem['value']]: UniconstItem['label'];
+}
+declare class Uniconst<T extends UniconstOptions> {
+    private readonly __source;
+    constructor(__source: T);
+    /**
+     * 根据键获取对应的值
+     *
+     * 此方法通过泛型K来限制可以访问的属性类型，确保类型安全
+     * 它利用了TypeScript的索引访问特性，以键值的形式获取对象的属性
+     *
+     * @param key - 要获取的属性的键，必须是对象T的有效键
+     * @returns 返回对象T中与键K对应的值
+     */
+    get<K extends keyof T>(key: K): T[K];
+    /**
+     * 获取选项数组
+     *
+     * 此方法用于获取当前源数据中的所有选项这些选项是源数据对象的值的集合
+     * 如果源数据为空或者不存在，将返回一个空数组
+     *
+     * @returns {UniconstItem[]} 一个包含所有选项的数组如果源数据为空，则返回空数组
+     */
+    getOptions(): UniconstItem[];
+    /**
+     * 将当前对象的选项转换为标签映射
+     * 此方法主要用于生成一个映射对象，其中键是选项的值，值是选项的标签
+     * @returns {UniconstMaps} 返回一个对象，其中每个选项的值映射到其对应的标签
+     */
+    toLabelMap(): UniconstMaps;
+}
+
+export { Uniconst as default };

package/dist/index.d.ts

@@ -0,0 +1,43 @@
+interface UniconstItem {
+    label: string;
+    value: string | number;
+    color: string;
+    [key: string]: any;
+}
+interface UniconstOptions {
+    [key: string]: UniconstItem;
+}
+interface UniconstMaps {
+    [key: UniconstItem['value']]: UniconstItem['label'];
+}
+declare class Uniconst<T extends UniconstOptions> {
+    private readonly __source;
+    constructor(__source: T);
+    /**
+     * 根据键获取对应的值
+     *
+     * 此方法通过泛型K来限制可以访问的属性类型，确保类型安全
+     * 它利用了TypeScript的索引访问特性，以键值的形式获取对象的属性
+     *
+     * @param key - 要获取的属性的键，必须是对象T的有效键
+     * @returns 返回对象T中与键K对应的值
+     */
+    get<K extends keyof T>(key: K): T[K];
+    /**
+     * 获取选项数组
+     *
+     * 此方法用于获取当前源数据中的所有选项这些选项是源数据对象的值的集合
+     * 如果源数据为空或者不存在，将返回一个空数组
+     *
+     * @returns {UniconstItem[]} 一个包含所有选项的数组如果源数据为空，则返回空数组
+     */
+    getOptions(): UniconstItem[];
+    /**
+     * 将当前对象的选项转换为标签映射
+     * 此方法主要用于生成一个映射对象，其中键是选项的值，值是选项的标签
+     * @returns {UniconstMaps} 返回一个对象，其中每个选项的值映射到其对应的标签
+     */
+    toLabelMap(): UniconstMaps;
+}
+
+export { Uniconst as default };

package/dist/index.js

@@ -0,0 +1,65 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var Uniconst = class {
+  constructor(__source) {
+    this.__source = __source;
+  }
+  /**
+   * 根据键获取对应的值
+   *
+   * 此方法通过泛型K来限制可以访问的属性类型，确保类型安全
+   * 它利用了TypeScript的索引访问特性，以键值的形式获取对象的属性
+   *
+   * @param key - 要获取的属性的键，必须是对象T的有效键
+   * @returns 返回对象T中与键K对应的值
+   */
+  get(key) {
+    return this.__source[key];
+  }
+  /**
+   * 获取选项数组
+   *
+   * 此方法用于获取当前源数据中的所有选项这些选项是源数据对象的值的集合
+   * 如果源数据为空或者不存在，将返回一个空数组
+   *
+   * @returns {UniconstItem[]} 一个包含所有选项的数组如果源数据为空，则返回空数组
+   */
+  getOptions() {
+    return Object.values(this.__source) ?? [];
+  }
+  /**
+   * 将当前对象的选项转换为标签映射
+   * 此方法主要用于生成一个映射对象，其中键是选项的值，值是选项的标签
+   * @returns {UniconstMaps} 返回一个对象，其中每个选项的值映射到其对应的标签
+   */
+  toLabelMap() {
+    return this.getOptions().reduce((obj, item) => {
+      return { ...obj, [item.value]: item.label };
+    }, {});
+  }
+};
+var index_default = Uniconst;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["interface UniconstItem {\r\n    label: string\r\n    value: string | number\r\n    color: string\r\n    [key: string]: any\r\n}\r\n\r\ninterface UniconstOptions {\r\n    [key: string]: UniconstItem\r\n}\r\n\r\ninterface UniconstMaps {\r\n    [key: UniconstItem['value']]: UniconstItem['label']\r\n}\r\n\r\nclass Uniconst<T extends UniconstOptions> {\r\n    constructor (\r\n        private readonly __source: T\r\n    ) {}\r\n\r\n    /**\r\n     * 根据键获取对应的值\r\n     *\r\n     * 此方法通过泛型K来限制可以访问的属性类型，确保类型安全\r\n     * 它利用了TypeScript的索引访问特性，以键值的形式获取对象的属性\r\n     *\r\n     * @param key - 要获取的属性的键，必须是对象T的有效键\r\n     * @returns 返回对象T中与键K对应的值\r\n     */\r\n    get<K extends keyof T> (key: K): T[K] {\r\n        return this.__source[key]\r\n    }\r\n\r\n    /**\r\n     * 获取选项数组\r\n     *\r\n     * 此方法用于获取当前源数据中的所有选项这些选项是源数据对象的值的集合\r\n     * 如果源数据为空或者不存在，将返回一个空数组\r\n     *\r\n     * @returns {UniconstItem[]} 一个包含所有选项的数组如果源数据为空，则返回空数组\r\n     */\r\n    getOptions (): UniconstItem[] {\r\n        return Object.values(this.__source) ?? []\r\n    }\r\n\r\n    /**\r\n     * 将当前对象的选项转换为标签映射\r\n     * 此方法主要用于生成一个映射对象，其中键是选项的值，值是选项的标签\r\n     * @returns {UniconstMaps} 返回一个对象，其中每个选项的值映射到其对应的标签\r\n     */\r\n    toLabelMap (): UniconstMaps {\r\n        return this.getOptions().reduce((obj, item) => {\r\n            return { ...obj, [item.value]: item.label }\r\n        }, {}) as UniconstMaps\r\n    }\r\n}\r\n\r\nexport default Uniconst\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAeA,IAAM,WAAN,MAA0C;AAAA,EACtC,YACqB,UACnB;AADmB;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWH,IAAwB,KAAc;AAClC,WAAO,KAAK,SAAS,GAAG;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,aAA8B;AAC1B,WAAO,OAAO,OAAO,KAAK,QAAQ,KAAK,CAAC;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAA4B;AACxB,WAAO,KAAK,WAAW,EAAE,OAAO,CAAC,KAAK,SAAS;AAC3C,aAAO,EAAE,GAAG,KAAK,CAAC,KAAK,KAAK,GAAG,KAAK,MAAM;AAAA,IAC9C,GAAG,CAAC,CAAC;AAAA,EACT;AACJ;AAEA,IAAO,gBAAQ;","names":[]}

package/dist/index.mjs

@@ -0,0 +1,44 @@
+// src/index.ts
+var Uniconst = class {
+  constructor(__source) {
+    this.__source = __source;
+  }
+  /**
+   * 根据键获取对应的值
+   *
+   * 此方法通过泛型K来限制可以访问的属性类型，确保类型安全
+   * 它利用了TypeScript的索引访问特性，以键值的形式获取对象的属性
+   *
+   * @param key - 要获取的属性的键，必须是对象T的有效键
+   * @returns 返回对象T中与键K对应的值
+   */
+  get(key) {
+    return this.__source[key];
+  }
+  /**
+   * 获取选项数组
+   *
+   * 此方法用于获取当前源数据中的所有选项这些选项是源数据对象的值的集合
+   * 如果源数据为空或者不存在，将返回一个空数组
+   *
+   * @returns {UniconstItem[]} 一个包含所有选项的数组如果源数据为空，则返回空数组
+   */
+  getOptions() {
+    return Object.values(this.__source) ?? [];
+  }
+  /**
+   * 将当前对象的选项转换为标签映射
+   * 此方法主要用于生成一个映射对象，其中键是选项的值，值是选项的标签
+   * @returns {UniconstMaps} 返回一个对象，其中每个选项的值映射到其对应的标签
+   */
+  toLabelMap() {
+    return this.getOptions().reduce((obj, item) => {
+      return { ...obj, [item.value]: item.label };
+    }, {});
+  }
+};
+var index_default = Uniconst;
+export {
+  index_default as default
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["interface UniconstItem {\r\n    label: string\r\n    value: string | number\r\n    color: string\r\n    [key: string]: any\r\n}\r\n\r\ninterface UniconstOptions {\r\n    [key: string]: UniconstItem\r\n}\r\n\r\ninterface UniconstMaps {\r\n    [key: UniconstItem['value']]: UniconstItem['label']\r\n}\r\n\r\nclass Uniconst<T extends UniconstOptions> {\r\n    constructor (\r\n        private readonly __source: T\r\n    ) {}\r\n\r\n    /**\r\n     * 根据键获取对应的值\r\n     *\r\n     * 此方法通过泛型K来限制可以访问的属性类型，确保类型安全\r\n     * 它利用了TypeScript的索引访问特性，以键值的形式获取对象的属性\r\n     *\r\n     * @param key - 要获取的属性的键，必须是对象T的有效键\r\n     * @returns 返回对象T中与键K对应的值\r\n     */\r\n    get<K extends keyof T> (key: K): T[K] {\r\n        return this.__source[key]\r\n    }\r\n\r\n    /**\r\n     * 获取选项数组\r\n     *\r\n     * 此方法用于获取当前源数据中的所有选项这些选项是源数据对象的值的集合\r\n     * 如果源数据为空或者不存在，将返回一个空数组\r\n     *\r\n     * @returns {UniconstItem[]} 一个包含所有选项的数组如果源数据为空，则返回空数组\r\n     */\r\n    getOptions (): UniconstItem[] {\r\n        return Object.values(this.__source) ?? []\r\n    }\r\n\r\n    /**\r\n     * 将当前对象的选项转换为标签映射\r\n     * 此方法主要用于生成一个映射对象，其中键是选项的值，值是选项的标签\r\n     * @returns {UniconstMaps} 返回一个对象，其中每个选项的值映射到其对应的标签\r\n     */\r\n    toLabelMap (): UniconstMaps {\r\n        return this.getOptions().reduce((obj, item) => {\r\n            return { ...obj, [item.value]: item.label }\r\n        }, {}) as UniconstMaps\r\n    }\r\n}\r\n\r\nexport default Uniconst\r\n"],"mappings":";AAeA,IAAM,WAAN,MAA0C;AAAA,EACtC,YACqB,UACnB;AADmB;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWH,IAAwB,KAAc;AAClC,WAAO,KAAK,SAAS,GAAG;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,aAA8B;AAC1B,WAAO,OAAO,OAAO,KAAK,QAAQ,KAAK,CAAC;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAA4B;AACxB,WAAO,KAAK,WAAW,EAAE,OAAO,CAAC,KAAK,SAAS;AAC3C,aAAO,EAAE,GAAG,KAAK,CAAC,KAAK,KAAK,GAAG,KAAK,MAAM;AAAA,IAC9C,GAAG,CAAC,CAAC;AAAA,EACT;AACJ;AAEA,IAAO,gBAAQ;","names":[]}

package/package.json

@@ -0,0 +1,47 @@
+{
+    "name": "uniconst",
+    "version": "1.0.0",
+    "description": "A lightweight TypeScript utility for unified constant management with value-label mapping and type-safe access",
+    "keywords": [
+        "constant",
+        "uniconst",
+        "typescript",
+        "enum",
+        "utility",
+        "mapping",
+        "label-map"
+    ],
+    "homepage": "https://github.com/kiccer/uniconst#readme",
+    "bugs": {
+        "url": "https://github.com/kiccer/uniconst/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/kiccer/uniconst.git"
+    },
+    "license": "MIT",
+    "author": "kiccer <1072907338@qq.com>",
+    "exports": {
+        ".": {
+            "import": "./dist/index.mjs",
+            "require": "./dist/index.cjs"
+        }
+    },
+    "main": "dist/index.cjs",
+    "module": "dist/index.mjs",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist",
+        "README.md",
+        "README.zh_CN.md"
+    ],
+    "scripts": {
+        "build": "tsup",
+        "prepublishOnly": "npm run build",
+        "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "devDependencies": {
+        "tsup": "^8.5.0",
+        "typescript": "^5.8.3"
+    }
+}