@wener/common 1.0.1 → 1.0.3

package/src/cn/DivisionCode.ts

@@ -0,0 +1,253 @@
+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
+
+/**
+ * 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 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,
+    };
+  }
+
+  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[] = [];
+    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;
+    }
+  }
+
+  return { found };
+}
+
+interface CodeValue {
+  value: string;
+  label: string;
+  children?: Array<CodeValue>;
+}

package/src/cn/Mod11Checksum.ts

@@ -0,0 +1,24 @@
+/**
+ * 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];
+
+  validate(s: string) {
+    return s.at(-1) === this.compute(s.slice(0, s.length - 1));
+  }
+
+  compute(s: string) {
+    const { weights } = this;
+    let sum = 0;
+    for (let i = 0; i < s.length; i++) {
+      sum += parseInt(s[i]) * weights[i];
+    }
+    const num = (12 - (sum % 11)) % 11;
+    if (num < 10) {
+      return num.toString();
+    } else {
+      return 'X';
+    }
+  }
+}

package/src/cn/Mod31Checksum.ts

@@ -0,0 +1,36 @@
+/**
+ * GB/T 17710（采ISO 7064）的模31校验码
+ *
+ * Mod31-3
+ */
+export class Mod31Checksum {
+  weights = [1, 3, 9, 27, 19, 26, 16, 17, 20, 29, 25, 13, 8, 24, 10, 30, 28];
+  chars = '0123456789ABCDEFGHJKLMNPQRTUWXY';
+  numbers: Record<string, number> = this.chars.split('').reduce(
+    (acc, cur, i) => {
+      acc[cur] = i;
+      return acc;
+    },
+    {} as Record<string, number>,
+  );
+
+  toChar(n: number) {
+    return this.chars[n];
+  }
+
+  toNumber(c: string) {
+    return this.numbers[c];
+  }
+
+  validate(s: string) {
+    return s.at(-1) === this.compute(s.slice(0, s.length - 1));
+  }
+
+  compute(s: string) {
+    let sum = 0;
+    for (let i = 0; i < s.length; i++) {
+      sum += this.numbers[s[i]] * this.weights[i];
+    }
+    return this.toChar(31 - (sum % 31));
+  }
+}

package/src/cn/ResidentIdentityCardNumber.test.ts

@@ -0,0 +1,21 @@
+import { describe, expect, it } from 'vitest';
+import { ResidentIdentityCardNumber } from './ResidentIdentityCardNumber';
+
+describe('ResidentIdentityCardNumber', () => {
+  it('should parse', () => {
+    for (const a of ['11010519491231002X']) {
+      let out = ResidentIdentityCardNumber.parse(a);
+      expect(ResidentIdentityCardNumber.format(out)).toBe(a);
+      expect(out).toMatchSnapshot();
+    }
+  });
+  it('should format with partial', () => {
+    expect(
+      ResidentIdentityCardNumber.format({
+        division: '110105',
+        birthDate: new Date('1949-12-31'),
+        sequence: 2,
+      }),
+    ).toBe('11010519491231002X');
+  });
+});

package/src/cn/ResidentIdentityCardNumber.ts

@@ -0,0 +1,96 @@
+import { formatDate } from './formatDate';
+import { Mod11Checksum } from './Mod11Checksum';
+
+export namespace ResidentIdentityCardNumber {
+  export const Checksum = new Mod11Checksum();
+
+  /*
+  export const length = 18;
+  export const pattern = /^\d{6}(18|19|20)\d{2}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])\d{3}[0-9Xx]$/;
+   */
+
+  export function parse(s: string): ParsedResidentIdentityCardNumber {
+    const division = s.slice(0, 6);
+    const birthDate = s.slice(6, 14);
+    const sequence = parseInt(s.slice(14, 17), 10);
+    const checksum = s.slice(17, 18);
+    const valid = Checksum.validate(s);
+    const sex = sequence % 2 === 1 ? 'Male' : 'Female';
+    return {
+      division,
+      birthDate,
+      sequence,
+      checksum,
+      valid,
+      sex,
+      male: sex === 'Male',
+      female: sex === 'Female',
+      age: new Date().getFullYear() - parseInt(birthDate.slice(0, 4), 10),
+    };
+  }
+
+  export function format({
+    division,
+    birthDate,
+    sequence,
+    checksum,
+  }: {
+    division: string;
+    birthDate: string | Date;
+    sequence: number | string;
+    checksum?: string;
+  }) {
+    if (typeof birthDate !== 'string') {
+      birthDate = formatDate(birthDate, 'yyyyMMDD');
+    }
+    if (birthDate.includes('-')) {
+      birthDate = birthDate.replace(/-/g, '');
+    }
+    typeof sequence === 'number' && (sequence = sequence.toString());
+    sequence = sequence.padStart(3, '0');
+    const base = [division, birthDate, sequence].join('');
+    if (base.length !== 17) throw new Error('Invalid params');
+    checksum ||= Checksum.compute(base);
+    return base + checksum;
+  }
+}
+export interface ParsedResidentIdentityCardNumber {
+  /**
+   * @title 行政区划代码
+   */
+  division: string;
+  /**
+   * @title 出生日期
+   * 格式 yyyyMMDD
+   */
+  birthDate: string;
+  /**
+   * @title 顺序码
+   */
+  sequence: number;
+  /**
+   * @title 校验位
+   */
+  checksum: string;
+
+  /**
+   * @title 是否有效
+   */
+  valid: boolean;
+  /**
+   * @title 是否男性
+   */
+  male: boolean;
+  /**
+   * @title 是否女性
+   */
+  female: boolean;
+  /**
+   * @title 性别
+   */
+  sex: 'Male' | 'Female';
+  /**
+   * @title 年龄
+   */
+  age: number;
+}

package/src/cn/UnifiedSocialCreditCode.test.ts

@@ -0,0 +1,16 @@
+import { describe, expect, it } from 'vitest';
+import { UnifiedSocialCreditCode } from './UnifiedSocialCreditCode';
+
+describe('UnifiedSocialCreditCode', () => {
+  it('should parse', () => {
+    for (const a of [
+      //
+      '91330106673959654P',
+      '91330106MA2CFLDG4R',
+    ]) {
+      let out = UnifiedSocialCreditCode.parse(a);
+      expect(UnifiedSocialCreditCode.format(out)).toBe(a);
+      expect(out).toMatchSnapshot();
+    }
+  });
+});

package/src/cn/UnifiedSocialCreditCode.ts

@@ -0,0 +1,148 @@
+import { Mod31Checksum } from './Mod31Checksum';
+
+/**
+ * 统一社会信用代码
+ *
+ * - GB 11714-1997 全国组织机构代码编制规则
+ */
+export namespace UnifiedSocialCreditCode {
+  interface CodeValue {
+    label: string;
+    children?: Record<string, CodeValue>;
+  }
+
+  const CodeLabels: Record<string, CodeValue> = {
+    1: {
+      label: '机构编制',
+      children: {
+        1: { label: '机关' },
+        2: { label: '事业单位' },
+        3: { label: '中央编办直接管理机构编制的群众团体' },
+        9: { label: '其他' },
+      },
+    },
+    5: {
+      label: '民政',
+      children: {
+        1: { label: '社会团体' },
+        2: { label: '民办非企业单位' },
+        3: { label: '基金会' },
+        9: { label: '其他' },
+      },
+    },
+    9: {
+      label: '工商',
+      children: {
+        1: { label: '企业' },
+        2: { label: '个体工商户' },
+        3: { label: '农民专业合作社' },
+        9: { label: '其他' },
+      },
+    },
+    Y: {
+      label: '其他',
+      children: {
+        1: { label: '其他' },
+      },
+    },
+  };
+
+  export const pattern = /^([159][1239]|Y1)[0-9]{6}[0-9A-HJ-NP-RTUWXY]{10}$/; // 无 I O Z S V
+
+  export const Checksum = new Mod31Checksum();
+
+  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位，校验码
+
+    const labels: string[] = [];
+    let l1 = CodeLabels[bureau];
+    l1 && labels.push(l1?.label);
+    let l2 = l1?.children?.[subjectType];
+    l2 && labels.push(l2?.label);
+
+    return {
+      bureau,
+      subjectType,
+      division,
+      subject,
+      checksum,
+      codes: [bureau, subjectType, division, subject],
+      labels,
+    };
+  }
+
+  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}`;
+  }
+
+  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;
+      }
+    }
+    return sp.map((v) => Checksum.chars[v]).join('');
+  }
+}
+
+/**
+ * 解析后的统一社会信用代码信息
+ */
+interface ParsedUnifiedSocialCreditCode {
+  /**
+   * @title 登记管理部门代码
+   * 对应统一社会信用代码的第1位字符，用于标识发证机构类别（登记管理部门）。
+   */
+  bureau: string;
+
+  /**
+   * @title 机构类别代码
+   * 对应统一社会信用代码的第2位字符，用于标识被赋码主体的类型（如企业、事业单位、社会组织等）。
+   */
+  subjectType: string;
+
+  /**
+   * @title 登记管理机关行政区划代码
+   * 对应统一社会信用代码的第3至第8位字符，用于标识该主体登记机关所在的行政区划。
+   */
+  division: string;
+
+  /**
+   * @title 主体标识码
+   * 对应统一社会信用代码的第9至第17位字符，用于标识特定的市场主体或法人单位。
+   */
+  subject: string;
+
+  /**
+   * @title 校验码
+   * 对应统一社会信用代码的最后一位字符，用特定算法计算，用于校验代码有效性。
+   */
+  checksum: string;
+
+  codes: string[];
+  labels: string[];
+}

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

@@ -0,0 +1,15 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`ResidentIdentityCardNumber > should parse 1`] = `
+{
+  "age": 75,
+  "birthDate": "19491231",
+  "checksum": "X",
+  "division": "110105",
+  "female": true,
+  "male": false,
+  "sequence": 2,
+  "sex": "Female",
+  "valid": true,
+}
+`;

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

@@ -0,0 +1,41 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`UnifiedSocialCreditCode > should parse 1`] = `
+{
+  "bureau": "9",
+  "checksum": "P",
+  "codes": [
+    "9",
+    "1",
+    "330106",
+    "673959654",
+  ],
+  "division": "330106",
+  "labels": [
+    "工商",
+    "企业",
+  ],
+  "subject": "673959654",
+  "subjectType": "1",
+}
+`;
+
+exports[`UnifiedSocialCreditCode > should parse 2`] = `
+{
+  "bureau": "9",
+  "checksum": "R",
+  "codes": [
+    "9",
+    "1",
+    "330106",
+    "MA2CFLDG4",
+  ],
+  "division": "330106",
+  "labels": [
+    "工商",
+    "企业",
+  ],
+  "subject": "MA2CFLDG4",
+  "subjectType": "1",
+}
+`;

package/src/cn/formatDate.ts

@@ -0,0 +1,12 @@
+export function formatDate(date: Date, format: 'yyyyMMDD') {
+  switch (format) {
+    case 'yyyyMMDD': {
+      const year = date.getFullYear();
+      const month = (date.getMonth() + 1).toString().padStart(2, '0');
+      const day = date.getDate().toString().padStart(2, '0');
+      return `${year}${month}${day}`;
+    }
+    default:
+      throw new Error(`Invalid format`);
+  }
+}

package/src/cn/index.ts

@@ -0,0 +1,3 @@
+export { ResidentIdentityCardNumber } from './ResidentIdentityCardNumber';
+export { DivisionCode } from './DivisionCode';
+export { UnifiedSocialCreditCode } from './UnifiedSocialCreditCode';

package/src/cn/parseSex.ts

@@ -0,0 +1,27 @@
+export function parseSex(s: string):
+  | undefined
+  | {
+      sex: 'Male' | 'Female';
+      male: boolean;
+      female: boolean;
+    } {
+  if (!s) return undefined;
+
+  switch (s.toLowerCase()) {
+    case '男':
+    case 'male':
+      return {
+        sex: 'Male',
+        male: true,
+        female: false,
+      };
+    case '女':
+    case 'female':
+      return {
+        sex: 'Female',
+        male: false,
+        female: true,
+      };
+  }
+  return undefined;
+}