@cloudcome/utils-core/dist/dict.mjs.map

cloudcome core utils

{"version":3,"file":"dict.mjs","sources":["../src/dict.ts"],"sourcesContent":["import type { AnyObject, MergeIntersection, UnionToIntersection, UnionToTuple } from './types';\n\nexport type DictKey = string;\nexport type DictValue = number | string;\nexport type DictMetaAppend = {\n  key?: string;\n  value?: string | number;\n  // biome-ignore lint/suspicious/noExplicitAny: <explanation>\n  [key: string]: any;\n};\nexport type DictMeta<A extends DictMetaAppend> = A & {\n  value: DictValue;\n};\nexport type DictDescription<A extends DictMetaAppend> = Record<DictKey, DictMeta<A>>;\n\nconst dictError = Symbol('dictKeyError');\n\ntype _StartWithDollarSign<T extends string> = T extends `$${infer R}` ? R : never;\n\ntype _CheckDefinition<O extends AnyObject> = {\n  // [K in keyof O & string]: K extends Capitalize<K> ? O[K] : `错误：枚举键名 ${K} 必须大写字母开头`;\n  [K in keyof O & string]: K extends Capitalize<K>\n    ? K extends `$${infer R}`\n      ? O[K] & { [dictError]: `错误：枚举键名 ${K} 不能以 $ 符号开头` }\n      : O[K]\n    : O[K] & { [dictError]: `错误：枚举键名 ${K} 必须以大写字母开头` };\n};\n\ntype _ToOriginDefProp<T extends AnyObject> = {\n  [K in keyof T as `$${K & string}`]: MergeIntersection<T[K] & { readonly key: K }>;\n};\n\ntype _KVRecord<T> = T extends Record<string, AnyObject>\n  ? {\n      readonly [K in keyof T]: T[K]['value'];\n    }\n  : never;\n\ntype _VKRecord<T> = T extends Record<string, AnyObject>\n  ? MergeIntersection<\n      UnionToIntersection<\n        {\n          [K in keyof T]: {\n            [P in keyof T[K] as P extends 'value' ? T[K][P] & (string | number) : never]: K;\n          };\n        }[keyof T]\n      >\n    >\n  : never;\n\nexport type DictExpose<A extends DictMetaAppend, E extends DictDescription<A>> = _ToOriginDefProp<E> &\n  _KVRecord<E> & {\n    readonly definition: E;\n    readonly descriptions: MergeIntersection<A & { key: keyof E }>[];\n    readonly keys: UnionToTuple<keyof E>;\n    readonly length: UnionToTuple<keyof E>['length'];\n    readonly values: UnionToTuple<E[keyof E]['value']>;\n    readonly kvRecord: _KVRecord<E>;\n    readonly vkRecord: _VKRecord<E>;\n    toKeyRecord: <P extends keyof A>(prop: P) => Record<keyof E, A[P]>;\n    toValRecord: <P extends keyof A>(prop: P) => Record<E[keyof E]['value'], A[P]>;\n  };\n\n/**\n * 定义一个枚举类型，如果需要类型提示，需要使用 declareDict 函数定义枚举。\n * @template A - 枚举元数据附加类型，扩展自 DictMetaAppend\n * @template E - 枚举描述类型，键为枚举键名，值为枚举元数据\n * @param {_CheckDefinition<E>} definition - 枚举定义对象\n * @returns {DictExpose<A, E>} 返回枚举的完整暴露对象\n * @example\n * ```typescript\n * const Status = defineDict({\n *   Pending: { value: 0, label: '待处理' },\n *   Approved: { value: 1, label: '已批准' }\n * });\n * ```\n *\n * @property {E} definition - 原始枚举定义对象\n * @property {Array<MergeIntersection<A & { key: keyof E }>>} descriptions - 枚举项的完整描述数组\n * @property {UnionToTuple<keyof E>} keys - 枚举键名的元组\n * @property {\"UnionToTuple<keyof E>[\\\"length\\\"]\"} length - 枚举项的数量\n * @property {UnionToTuple<E[keyof E][\"value\"]>} values - 枚举值的元组\n * @property {Record<keyof E, E[keyof E][\"value\"]>} kvRecord - 键到值的映射记录\n * @property {Record<E[keyof E][\"value\"], E[keyof E]>} vkRecord - 值到键的映射记录\n * @property {function} toKeyRecord - 根据属性名创建键到属性值的映射记录\n * @property {function} toValueRecord - 根据属性名创建值到属性值的映射记录\n */\nfunction _defineDict<A extends DictMetaAppend, const E extends DictDescription<A>>(\n  definition: _CheckDefinition<E>,\n): DictExpose<A, E> {\n  const keys = Object.keys(definition);\n\n  return {\n    ...[...Object.entries(definition)].reduce((acc, [key, dfn]) => {\n      if (key[0].toUpperCase() !== key[0]) {\n        throw new Error(`错误：枚举键名 ${key} 必须以大写字母开头`);\n      }\n\n      if (key.startsWith('$')) {\n        throw new Error(`错误：枚举键名 ${key} 不能以 $ 符号开头`);\n      }\n\n      // @ts-ignore\n      acc[key] = dfn.value;\n      // @ts-ignore\n      acc[`$${key}`] = { key, ...dfn };\n      return acc;\n    }, {}),\n    definition,\n    descriptions: keys.map((key) => ({\n      key,\n      ...definition[key],\n    })),\n    keys,\n    length: keys.length,\n    values: keys.map((key) => definition[key as keyof E].value),\n    kvRecord: keys.reduce((acc, key) => {\n      // @ts-ignore\n      acc[key] = definition[key].value;\n      return acc;\n    }, {}),\n    vkRecord: keys.reduce((acc, key) => {\n      // @ts-ignore\n      acc[definition[key].value] = key;\n      return acc;\n    }, {}),\n    toKeyRecord<P extends keyof A>(prop: P) {\n      return keys.reduce((acc, key) => {\n        // @ts-ignore\n        acc[key] = definition[key][prop];\n        return acc;\n      }, {});\n    },\n    toValRecord<P extends keyof A>(prop: P) {\n      return keys.reduce(\n        (acc, key) => {\n          // @ts-ignore\n          acc[definition[key].value] = definition[key][prop];\n          return acc;\n        },\n        {} as Record<E[keyof E]['value'], A[P]>,\n      );\n    },\n  } as unknown as DictExpose<A, E>;\n}\n\n/**\n * 声明一个枚举工厂函数\n * @template A - 枚举元数据附加类型，扩展自 DictMetaAppend\n * @returns {Object} 返回包含 define 方法的对象\n *\n * @property {function} define - 定义枚举的函数\n *   @template E - 枚举描述类型\n *   @param {_CheckDefinition<E>} definition - 枚举定义对象\n *   @returns {DictExpose<A, E>} 返回枚举的完整暴露对象\n *   @example\n *   ```typescript\n *   const createStatusDict = declareDict<{ label: string }>();\n *   const Status = createStatusDict.define({\n *     Pending: { value: 0, label: '待处理' },\n *     Approved: { value: 1, label: '已批准' }\n *   });\n *   ```\n */\nexport function declareDict<A extends DictMetaAppend>() {\n  return {\n    define<const E extends DictDescription<A>>(definition: _CheckDefinition<E>): DictExpose<A, E> {\n      return _defineDict(definition);\n    },\n  };\n}\n"],"names":[],"mappings":"AAuFA,SAAS,YACP,YACkB;AACZ,QAAA,OAAO,OAAO,KAAK,UAAU;AAE5B,SAAA;AAAA,IACL,GAAG,CAAC,GAAG,OAAO,QAAQ,UAAU,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM;AAC7D,UAAI,IAAI,CAAC,EAAE,kBAAkB,IAAI,CAAC,GAAG;AACnC,cAAM,IAAI,MAAM,WAAW,GAAG,YAAY;AAAA,MAAA;AAGxC,UAAA,IAAI,WAAW,GAAG,GAAG;AACvB,cAAM,IAAI,MAAM,WAAW,GAAG,aAAa;AAAA,MAAA;AAIzC,UAAA,GAAG,IAAI,IAAI;AAEf,UAAI,IAAI,GAAG,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI;AACxB,aAAA;AAAA,IACT,GAAG,EAAE;AAAA,IACL;AAAA,IACA,cAAc,KAAK,IAAI,CAAC,SAAS;AAAA,MAC/B;AAAA,MACA,GAAG,WAAW,GAAG;AAAA,IAAA,EACjB;AAAA,IACF;AAAA,IACA,QAAQ,KAAK;AAAA,IACb,QAAQ,KAAK,IAAI,CAAC,QAAQ,WAAW,GAAc,EAAE,KAAK;AAAA,IAC1D,UAAU,KAAK,OAAO,CAAC,KAAK,QAAQ;AAElC,UAAI,GAAG,IAAI,WAAW,GAAG,EAAE;AACpB,aAAA;AAAA,IACT,GAAG,EAAE;AAAA,IACL,UAAU,KAAK,OAAO,CAAC,KAAK,QAAQ;AAElC,UAAI,WAAW,GAAG,EAAE,KAAK,IAAI;AACtB,aAAA;AAAA,IACT,GAAG,EAAE;AAAA,IACL,YAA+B,MAAS;AACtC,aAAO,KAAK,OAAO,CAAC,KAAK,QAAQ;AAE/B,YAAI,GAAG,IAAI,WAAW,GAAG,EAAE,IAAI;AACxB,eAAA;AAAA,MACT,GAAG,EAAE;AAAA,IACP;AAAA,IACA,YAA+B,MAAS;AACtC,aAAO,KAAK;AAAA,QACV,CAAC,KAAK,QAAQ;AAER,cAAA,WAAW,GAAG,EAAE,KAAK,IAAI,WAAW,GAAG,EAAE,IAAI;AAC1C,iBAAA;AAAA,QACT;AAAA,QACA,CAAA;AAAA,MACF;AAAA,IAAA;AAAA,EAEJ;AACF;AAoBO,SAAS,cAAwC;AAC/C,SAAA;AAAA,IACL,OAA2C,YAAmD;AAC5F,aAAO,YAAY,UAAU;AAAA,IAAA;AAAA,EAEjC;AACF;"}