@wener/common 2.0.1 → 2.0.3

package/src/cn/DivisionCode.ts

@@ -1,209 +1,154 @@
-const DivisionCodeLevels: Array<{ level: number; code: string; length: number; size: number; label: string }> = [
-	{ level: 1, code: 'Province', length: 2, size: 2, label: '省' },
-	{ level: 2, code: 'City', length: 4, size: 2, label: '市' },
-	{ level: 3, code: 'County', length: 6, size: 2, label: '区县' },
-	{ level: 4, code: 'Town', length: 9, size: 3, label: '乡镇' },
-	{ level: 5, code: 'Village', length: 12, size: 3, label: '村' },
-] as const;
-
-// String(Number.MAX_SAFE_INTEGER).length=16
-// 12 is safe int
+import z from 'zod/v4';
+import type { EnumValues } from '../resource/schema';
+
+export const DivisionLevel = Object.freeze({
+	__proto__: null,
+	Province: 'Province',
+	City: 'City',
+	County: 'County',
+	Town: 'Town',
+	Village: 'Village',
+});
+const DivisionLevels = [
+	DivisionLevel.Province,
+	DivisionLevel.City,
+	DivisionLevel.County,
+	DivisionLevel.Town, // 3
+	DivisionLevel.Village, // 3
+];
+export type DivisionLevel = EnumValues<typeof DivisionLevel>;
+export const DivisionLevelSchema = z
+	.union([
+		z.literal(DivisionLevel.Province).describe('省级').meta({ ordinal: 1 }),
+		z.literal(DivisionLevel.City).describe('地级').meta({ ordinal: 2 }),
+		z.literal(DivisionLevel.County).describe('县级').meta({ ordinal: 3 }),
+		z.literal(DivisionLevel.Town).describe('乡镇级').meta({ ordinal: 4 }),
+		z.literal(DivisionLevel.Village).describe('村级').meta({ ordinal: 5 }),
+	])
+	.describe('行政区划级别');
+
+export type ParsedDivisionCode = z.infer<typeof ParsedDivisionCodeSchema>;
+export const ParsedDivisionCodeSchema = z.object({
+	code: z.string().describe('行政区划代码'),
+	name: z.string().describe('行政区划名称'),
+	level: DivisionLevelSchema,
+	codes: z.string().array(),
+	names: z.string().array(),
+	latitude: z.number().optional().describe('纬度'),
+	longitude: z.number().optional().describe('经度'),
+});
+
+interface CodeName {
+	value: string;
+	name: string;
+	children?: Array<CodeName>;
+}
 
-/**
- * Codes for the administrative divisions of the People's Republic of China
- *
- * @see https://zh.wikipedia.org/wiki/GB/T_2260 中华人民共和国行政区划代码
- */
-export namespace DivisionCode {
-	enum DivisionCodeLevel {
-		Province = 1,
-		City = 2,
-		County = 3,
-		Town = 4,
-		Village = 5,
+export const DivisionCodeRegex =
+	/^(?<province>\d{2})(?<city>\d{2})?(?<county>\d{2})?(?<town>\d{3})?(?<village>\d{3})?$/;
+
+const CodeNames: CodeName[] = [
+	{ value: '11', name: '北京市' },
+	{ value: '12', name: '天津市' },
+	{ value: '13', name: '河北省' },
+	{ value: '14', name: '山西省' },
+	{ value: '15', name: '内蒙古自治区' },
+	{ value: '21', name: '辽宁省' },
+	{ value: '22', name: '吉林省' },
+	{ value: '23', name: '黑龙江省' },
+	{ value: '31', name: '上海市' },
+	{ value: '32', name: '江苏省' },
+	{ value: '33', name: '浙江省' },
+	{ value: '34', name: '安徽省' },
+	{ value: '35', name: '福建省' },
+	{ value: '36', name: '江西省' },
+	{ value: '37', name: '山东省' },
+	{ value: '41', name: '河南省' },
+	{ value: '42', name: '湖北省' },
+	{ value: '43', name: '湖南省' },
+	{ value: '44', name: '广东省' },
+	{ value: '45', name: '广西壮族自治区' },
+	{ value: '46', name: '海南省' },
+	{ value: '50', name: '重庆市' },
+	{ value: '51', name: '四川省' },
+	{ value: '52', name: '贵州省' },
+	{ value: '53', name: '云南省' },
+	{ value: '54', name: '西藏自治区' },
+	{ value: '61', name: '陕西省' },
+	{ value: '62', name: '甘肃省' },
+	{ value: '63', name: '青海省' },
+	{ value: '64', name: '宁夏回族自治区' },
+	{ value: '65', name: '新疆维吾尔自治区' },
+	{ value: '71', name: '台湾省' },
+	{ value: '81', name: '香港特别行政区' },
+	{ value: '82', name: '澳门特别行政区' },
+	// 9 国外
+];
+
+export function parseDivisionCode(code: string): ParsedDivisionCode | undefined {
+	const match = DivisionCodeRegex.exec(code);
+	if (!match) {
+		return undefined;
+	}
+	const { province, city, county, town, village } = match.groups ?? {};
+	if (!province) {
+		return undefined;
 	}
 
-	export const levels = DivisionCodeLevels;
-
-	export const regex = /^(?<province>\d{2})(?<city>\d{2})?(?<county>\d{2})?(?<town>\d{3})?(?<village>\d{3})?$/;
-
-	const root: CodeValue[] = [
-		{ value: '11', label: '北京市' },
-		{ value: '12', label: '天津市' },
-		{ value: '13', label: '河北省' },
-		{ value: '14', label: '山西省' },
-		{ value: '15', label: '内蒙古自治区' },
-		{ value: '21', label: '辽宁省' },
-		{ value: '22', label: '吉林省' },
-		{ value: '23', label: '黑龙江省' },
-		{ value: '31', label: '上海市' },
-		{ value: '32', label: '江苏省' },
-		{ value: '33', label: '浙江省' },
-		{ value: '34', label: '安徽省' },
-		{ value: '35', label: '福建省' },
-		{ value: '36', label: '江西省' },
-		{ value: '37', label: '山东省' },
-		{ value: '41', label: '河南省' },
-		{ value: '42', label: '湖北省' },
-		{ value: '43', label: '湖南省' },
-		{ value: '44', label: '广东省' },
-		{ value: '45', label: '广西壮族自治区' },
-		{ value: '46', label: '海南省' },
-		{ value: '50', label: '重庆市' },
-		{ value: '51', label: '四川省' },
-		{ value: '52', label: '贵州省' },
-		{ value: '53', label: '云南省' },
-		{ value: '54', label: '西藏自治区' },
-		{ value: '61', label: '陕西省' },
-		{ value: '62', label: '甘肃省' },
-		{ value: '63', label: '青海省' },
-		{ value: '64', label: '宁夏回族自治区' },
-		{ value: '65', label: '新疆维吾尔自治区' },
-		{ value: '71', label: '台湾省' },
-		{ value: '81', label: '香港特别行政区' },
-		{ value: '82', label: '澳门特别行政区' },
-		// 9 国外
-	];
-
-	export type ParsedCode = {
-		province: string;
-		city?: string;
-		county?: string;
-		town?: string;
-		village?: string;
-		codes: string[];
-		level: DivisionCodeLevel;
-		labels: string[];
-	};
-
-	export function parse(code: string | undefined | null | number): ParsedCode | undefined {
-		if (!code) return;
-		code = String(code);
-		const match = regex.exec(code);
-		if (!match) return;
-		const { province, city, county, town, village } = match.groups ?? {};
-		if (!province) return;
-
-		let codes = [province, city, county, town, village].filter(Boolean);
-		return { province, city, county, town, village, codes: codes, level: codes.length as DivisionCodeLevel };
+	const codes = [province, city, county, town, village].filter(Boolean);
+	const names: string[] = [];
+	{
+		let name = CodeNames.find((cn) => cn.value === province);
+		if (name) {
+			names.push(name.name);
+		}
 	}
+	let level: DivisionLevel = DivisionLevels[codes.length - 1];
+	return {
+		code,
+		name: names.join(''),
+		level,
+		codes,
+		names,
+	};
+}
 
-	export function format({
-		province,
-		city,
-		county,
-		town,
-		village,
-	}: {
-		province: string | number;
-		city?: string | number;
-		county?: string | number;
-		town?: string | number;
-		village?: string | number;
-	}): string {
-		const codes: string[] = [];
+export function formatDivisionCode({
+	province,
+	city,
+	county,
+	town,
+	village,
+	codes = [],
+}: {
+	province?: string | number;
+	city?: string | number;
+	county?: string | number;
+	town?: string | number;
+	village?: string | number;
+	codes?: string[];
+}): string {
+	if (!codes.length) {
 		for (let i = 0; i < [province, city, county, town, village].length; i++) {
 			let x = [province, city, county, town, village][i];
 			if (x === undefined || x === null || x === '') {
 				break;
 			}
-			let len = levels[i].size;
-			codes.push(String(x).padStart(len, '0').slice(0, len));
-		}
-		return codes.join('');
-	}
-
-	// export function random(level: DivisionCodeLevel = 'County'): string {
-	//   const l = DivisionCodeLevels.find((v) => v.code === level) || DivisionCodeLevels[2];
-	//   const l1 = randomPick(provinces);
-	//   if (l.level === 1) {
-	//     return String(l1[0]);
-	//   }
-	//   return l1 + String(Math.floor(Math.random() * parseFloat(`1e${l.length - 2}`) - 1));
-	// }
-}
-
-interface DivisionTreeNode {
-	sub: string; // sub code
-	children?: Record<string, DivisionTreeNode>;
-
-	code: string; // full code
-	name?: string; // name of division
-}
-
-// export type DivisionCodeLevel = 'Village' | 'Town' | 'County' | 'City' | 'Province';
-
-// export interface ParsedDivisionCode {
-//   level: DivisionCodeLevel;
-//   code: string;
-//   name?: string;
-//   fullName?: string;
-//   names: string[];
-//   // 村级（村委会、居委会）
-//   // 12 位
-//   village?: CodeName;
-//   // 乡级（乡镇、街道）
-//   // 9 位
-//   town?: CodeName;
-//   // 县级（区县）
-//   // 6 位 - 常用 - 2985 个
-//   county?: CodeName;
-//   // 地级（城市）
-//   // 4 位 - 343 个
-//   city?: CodeName;
-//   // 省级（省份、直辖市、自治区）
-//   // 2 位 - 32 个
-//   province: CodeName;
-//
-//   children?: Array<{ code: string; name?: string }>;
-// }
-
-// export interface CodeName {
-//   code: string;
-//   name: string;
-// }
-
-// export function getSimpleProvinceLabel(value: string) {
-//   if (!value) {
-//     return;
-//   }
-//   let label = value;
-//   if (/[0-9]/.test(label)) {
-//     label = label.slice(0, 2);
-//     label = options.find((v) => v.value === label)?.label || label;
-//   }
-//   return label.replace(/省|市|(回族|维吾尔|壮族)?自治区|特别行政区$/, '');
-// }
-
-export function randomPick<T>(s: T[]) {
-	return s[Math.floor(Math.random() * s.length)];
-}
-
-function lookup(opts: { values: string[]; root: CodeValue[] }): { found: CodeValue[] } {
-	const { values, root } = opts;
-	const found: CodeValue[] = [];
-	let currentLevel = root;
-
-	for (const v of values) {
-		const node = currentLevel.find((n) => n.value === v);
-		if (!node) {
-			break;
-		}
-
-		found.push(node);
-
-		if (node.children) {
-			currentLevel = node.children;
-		} else {
-			break;
+			let size = 2;
+			if (i > 2) {
+				size = 3;
+			}
+			codes.push(String(x).padStart(size, '0').slice(0, size));
 		}
 	}
 
-	return { found };
+	return codes.join('');
 }
 
-interface CodeValue {
-	value: string;
-	label: string;
-	children?: Array<CodeValue>;
+export namespace DivisionCode {
+	export const regex = DivisionCodeRegex;
+	export const parse = parseDivisionCode;
+	export const format = formatDivisionCode;
+	export type Result = ParsedDivisionCode;
+	export const ResultSchema = ParsedDivisionCodeSchema;
 }

package/src/cn/{Mod11Checksum.ts → Mod11.ts}

@@ -2,7 +2,7 @@
  * ISO 7064:1983, MOD 11-2.
  */
 export class Mod11Checksum {
-	weights = [7, 9, 10, 5, 8, 4, 2, 1, 6, 3, 7, 9, 10, 5, 8, 4, 2, 1];
+	protected weights = [7, 9, 10, 5, 8, 4, 2, 1, 6, 3, 7, 9, 10, 5, 8, 4, 2, 1];
 
 	validate(s: string) {
 		return s.at(-1) === this.compute(s.slice(0, s.length - 1));
@@ -22,3 +22,5 @@ export class Mod11Checksum {
 		}
 	}
 }
+
+export const Mod11 = new Mod11Checksum();

package/src/cn/{Mod31Checksum.ts → Mod31.ts}

@@ -34,3 +34,5 @@ export class Mod31Checksum {
 		return this.toChar(31 - (sum % 31));
 	}
 }
+
+export const Mod31 = new Mod31Checksum();

package/src/cn/UnifiedSocialCreditCode.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { UnifiedSocialCreditCode } from './UnifiedSocialCreditCode';
+import { UnifiedSocialCreditCode } from './index';
 
 describe('UnifiedSocialCreditCode', () => {
 	it('should parse', () => {
@@ -9,7 +9,7 @@ describe('UnifiedSocialCreditCode', () => {
 			'91330106MA2CFLDG4R',
 		]) {
 			let out = UnifiedSocialCreditCode.parse(a);
-			expect(UnifiedSocialCreditCode.format(out)).toBe(a);
+			expect(UnifiedSocialCreditCode.format(out!)).toBe(a);
 			expect(out).toMatchSnapshot();
 		}
 	});

package/src/cn/UnifiedSocialCreditCode.ts

@@ -1,143 +1,138 @@
-import { Mod31Checksum } from './Mod31Checksum';
+import { z } from 'zod/v4';
+import { Mod31 } from './Mod31';
 
-/**
- * 统一社会信用代码
- *
- * - GB 11714-1997 全国组织机构代码编制规则
- */
-export namespace UnifiedSocialCreditCode {
-	interface CodeValue {
-		label: string;
-		children?: Record<string, CodeValue>;
-	}
+interface CodeValue {
+	name: string;
+	children?: Record<string, CodeValue>;
+}
 
-	const CodeLabels: Record<string, CodeValue> = {
-		1: {
-			label: '机构编制',
-			children: {
-				1: { label: '机关' },
-				2: { label: '事业单位' },
-				3: { label: '中央编办直接管理机构编制的群众团体' },
-				9: { label: '其他' },
-			},
+const CodeNames: Record<string, CodeValue> = {
+	1: {
+		name: '机构编制',
+		children: {
+			1: { name: '机关' },
+			2: { name: '事业单位' },
+			3: { name: '中央编办直接管理机构编制的群众团体' },
+			9: { name: '其他' },
 		},
-		5: {
-			label: '民政',
-			children: {
-				1: { label: '社会团体' },
-				2: { label: '民办非企业单位' },
-				3: { label: '基金会' },
-				9: { label: '其他' },
-			},
+	},
+	5: {
+		name: '民政',
+		children: {
+			1: { name: '社会团体' },
+			2: { name: '民办非企业单位' },
+			3: { name: '基金会' },
+			9: { name: '其他' },
 		},
-		9: {
-			label: '工商',
-			children: {
-				1: { label: '企业' },
-				2: { label: '个体工商户' },
-				3: { label: '农民专业合作社' },
-				9: { label: '其他' },
-			},
+	},
+	9: {
+		name: '工商',
+		children: {
+			1: { name: '企业' },
+			2: { name: '个体工商户' },
+			3: { name: '农民专业合作社' },
+			9: { name: '其他' },
 		},
-		Y: { label: '其他', children: { 1: { label: '其他' } } },
-	};
+	},
+	Y: { name: '其他', children: { 1: { name: '其他' } } },
+};
 
-	export const pattern = /^([159][1239]|Y1)[0-9]{6}[0-9A-HJ-NP-RTUWXY]{10}$/; // 无 I O Z S V
+export type ParsedUnifiedSocialCreditCode = z.infer<typeof ParsedUnifiedSocialCreditCodeSchema>;
+export const ParsedUnifiedSocialCreditCodeSchema = z
+	.object({
+		raw: z.string().length(18).describe('统一社会信用代码'),
+		registrationAuthorityCode: z.string().length(1).describe('登记管理部门代码'),
+		entityCategoryCode: z.string().length(1).describe('机构类别代码'),
+		adminDivisionCode: z.string().length(6).describe('登记管理机关行政区划码 '),
+		organizationCode: z.string().length(9).describe('主体标识码/组织机构代码'),
+		checkDigit: z.string().length(1).describe('校验码'),
 
-	export const Checksum = new Mod31Checksum();
+		codes: z.string().array().describe('代码数组'),
+		names: z.string().array().describe('代码名称'),
+		valid: z.boolean().optional().describe('是否有效'),
+	})
+	.describe('统一社会信用代码');
 
-	export function parse(s: string): ParsedUnifiedSocialCreditCode {
-		let bureau = s[0];
-		let subjectType = s[1];
-		let division = s.slice(2, 8); // 第3~8位，共6位，正确
-		let subject = s.slice(8, 17); // 第9~17位，共9位
-		let checksum = s.slice(17, 18); // 第18位，校验码
+export const UnifiedSocialCreditCodeRegex = /^([159][1239]|Y1)[0-9]{6}[0-9A-HJ-NP-RTUWXY]{10}$/;
 
-		const labels: string[] = [];
-		let l1 = CodeLabels[bureau];
-		l1 && labels.push(l1?.label);
-		let l2 = l1?.children?.[subjectType];
-		l2 && labels.push(l2?.label);
+export function parseUnifiedSocialCreditCode(s: string): ParsedUnifiedSocialCreditCode | undefined {
+	if (!s || s.length !== 18) return undefined;
 
-		return {
-			bureau,
-			subjectType,
-			division,
-			subject,
-			checksum,
-			codes: [bureau, subjectType, division, subject],
-			labels,
-		};
-	}
+	const registrationAuthorityCode = s[0];
+	const entityCategoryCode = s[1];
+	const adminDivisionCode = s.slice(2, 8);
+	const organizationCode = s.slice(8, 17);
+	const checkDigit = s[17];
 
-	export function format({
-		bureau,
-		subjectType,
-		division,
-		subject,
-		checksum,
-	}: {
-		bureau: string;
-		subjectType: string;
-		division: string;
-		subject: string;
-		checksum?: string;
-	}): string {
-		const base = `${bureau}${subjectType}${division}${subject}`;
-		checksum ||= Checksum.compute(base);
-		return `${base}${checksum}`;
-	}
+	const codes = [registrationAuthorityCode, entityCategoryCode, adminDivisionCode, organizationCode, checkDigit];
+	const names: string[] = [];
 
-	export function next(s: string, delta: number = 1) {
-		const sp = s.split('').map((v) => Checksum.numbers[v]);
-		for (let i = sp.length - 1; i >= 0; i--) {
-			if ((delta > 0 && sp[i] < 30) || (delta < 0 && sp[i] > 0)) {
-				sp[i] += delta;
-				break;
-			} else if (delta > 0 && sp[i] === 30) {
-				sp[i] = 0;
-			} else if (delta < 0 && sp[i] === 0) {
-				sp[i] = 30;
-			}
+	const bureau = CodeNames[registrationAuthorityCode];
+	if (bureau) {
+		names.push(bureau.name);
+		const subject = bureau.children?.[entityCategoryCode];
+		if (subject) {
+			names.push(subject.name);
 		}
-		return sp.map((v) => Checksum.chars[v]).join('');
 	}
-}
-
-/**
- * 解析后的统一社会信用代码信息
- */
-interface ParsedUnifiedSocialCreditCode {
-	/**
-	 * @title 登记管理部门代码
-	 * 对应统一社会信用代码的第1位字符，用于标识发证机构类别（登记管理部门）。
-	 */
-	bureau: string;
-
-	/**
-	 * @title 机构类别代码
-	 * 对应统一社会信用代码的第2位字符，用于标识被赋码主体的类型（如企业、事业单位、社会组织等）。
-	 */
-	subjectType: string;
 
-	/**
-	 * @title 登记管理机关行政区划代码
-	 * 对应统一社会信用代码的第3至第8位字符，用于标识该主体登记机关所在的行政区划。
-	 */
-	division: string;
+	return {
+		raw: s,
+		registrationAuthorityCode,
+		entityCategoryCode,
+		adminDivisionCode,
+		organizationCode,
+		checkDigit,
+		codes,
+		names,
+		valid: UnifiedSocialCreditCodeRegex.test(s) && Mod31.validate(s),
+	};
+}
 
-	/**
-	 * @title 主体标识码
-	 * 对应统一社会信用代码的第9至第17位字符，用于标识特定的市场主体或法人单位。
-	 */
-	subject: string;
+export function formatUnifiedSocialCreditCode({
+	registrationAuthorityCode,
+	entityCategoryCode,
+	adminDivisionCode,
+	organizationCode,
+	checkDigit,
+}: {
+	registrationAuthorityCode: string;
+	entityCategoryCode: string;
+	adminDivisionCode: string;
+	organizationCode: string;
+	checkDigit?: string;
+}): string {
+	const base = `${registrationAuthorityCode}${entityCategoryCode}${adminDivisionCode}${organizationCode}`;
+	checkDigit ||= Mod31.compute(base);
+	return `${base}${checkDigit}`;
+}
 
-	/**
-	 * @title 校验码
-	 * 对应统一社会信用代码的最后一位字符，用特定算法计算，用于校验代码有效性。
-	 */
-	checksum: string;
+export function next(s: string, delta: number = 1) {
+	const sp = s.split('').map((v) => Mod31.numbers[v]);
+	for (let i = sp.length - 1; i >= 0; i--) {
+		if ((delta > 0 && sp[i] < 30) || (delta < 0 && sp[i] > 0)) {
+			sp[i] += delta;
+			break;
+		} else if (delta > 0 && sp[i] === 30) {
+			sp[i] = 0;
+		} else if (delta < 0 && sp[i] === 0) {
+			sp[i] = 30;
+		}
+	}
+	return sp.map((v) => Mod31.chars[v]).join('');
+}
 
-	codes: string[];
-	labels: string[];
+export namespace UnifiedSocialCreditCode {
+	export const regex = UnifiedSocialCreditCodeRegex;
+	export const parse = parseUnifiedSocialCreditCode;
+	export const format = formatUnifiedSocialCreditCode;
+	export type Result = ParsedUnifiedSocialCreditCode;
+	export const ResultSchema = ParsedUnifiedSocialCreditCodeSchema;
+	export function test(s: string | undefined | null) {
+		if (!s) {
+			return false;
+		}
+		// fast check
+		return regex.test(s) && Mod31.validate(s);
+	}
 }

package/src/cn/__snapshots__/ChineseResidentIdNo.test.ts.snap

@@ -0,0 +1,14 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`ChineseResidentIdNo > should parse 1`] = `
+{
+  "addressCode": "110105",
+  "age": 76,
+  "birthDate": "1949-12-31",
+  "checkDigit": 10,
+  "raw": "11010519491231002X",
+  "sequence": 2,
+  "sex": "Male",
+  "valid": true,
+}
+`;