node-resource-utils 0.0.0-stage → 1.1.8

package/resources/src/lib/validation.test.ts

@@ -0,0 +1,297 @@
+import { describe, expect, it } from 'vitest';
+import {
+  fieldTypeLabel,
+  inferValidationType,
+  registerFieldType,
+  suggestedMaxLength,
+  validateField,
+} from './validation';
+import { zField, zNullableField, zOptionalField } from './zodField';
+
+/** 小工具：只取提示语，断言时更直观 */
+function message(type: string, value: unknown, options: Parameters<typeof validateField>[2] = {}) {
+  const result = validateField(type, value, options);
+  return result.ok ? null : result.message;
+}
+
+describe('身份证号', () => {
+  it('接受校验位正确的 18 位身份证号', () => {
+    const result = validateField('idCard', '11010519491231002x', { label: '身份证号' });
+    expect(result.ok).toBe(true);
+    expect(result.value).toBe('11010519491231002X'); // X 自动大写
+  });
+
+  it('接受 15 位老身份证号', () => {
+    expect(validateField('idCard', '110105491231002').ok).toBe(true);
+  });
+
+  it('校验位错误时给出明确提示', () => {
+    expect(message('idCard', '110105194912310021')).toContain('校验位不正确');
+  });
+
+  it('出生日期不存在时提示核对', () => {
+    expect(message('idCard', '11010519490231002X')).toContain('出生日期不存在');
+  });
+
+  it('出生日期晚于今天时拒绝', () => {
+    expect(message('idCard', '11010520991231002X')).toContain('不能晚于今天');
+  });
+
+  it('地区码明显错误时拒绝', () => {
+    expect(message('idCard', '99010519491231002X')).toContain('地区码不正确');
+  });
+
+  it('位数不对时说明应填多少位', () => {
+    expect(message('idCard', '110105')).toContain('15 位或 18 位');
+  });
+
+  it('自动去掉空格', () => {
+    const result = validateField('idCard', '110105 19491231 002X');
+    expect(result.ok).toBe(true);
+    expect(result.value).toBe('11010519491231002X');
+  });
+});
+
+describe('姓名', () => {
+  it('接受常见中文名和少数民族姓名', () => {
+    expect(validateField('name', '张三').ok).toBe(true);
+    expect(validateField('name', '欧阳·娜娜').ok).toBe(true);
+  });
+
+  it('接受英文姓名', () => {
+    expect(validateField('name', 'John Smith').ok).toBe(true);
+  });
+
+  it('拒绝数字与特殊符号', () => {
+    expect(message('name', '张三1')).toContain('不能包含数字');
+    expect(message('name', '张三!')).toContain('特殊符号');
+  });
+
+  it('拒绝单字姓名', () => {
+    expect(message('name', '张')).toContain('至少需要 2 个字符');
+  });
+
+  it('拒绝间隔号位置不对的姓名', () => {
+    expect(message('name', '·张三')).toContain('间隔号');
+  });
+});
+
+describe('密码', () => {
+  it('接受 6-64 位普通密码', () => {
+    expect(validateField('password', '123456').ok).toBe(true);
+  });
+
+  it('拒绝过短、过长和含空格的密码', () => {
+    expect(message('password', '12345')).toContain('至少需要 6 位');
+    expect(message('password', '1'.repeat(65))).toContain('不能超过 64 位');
+    expect(message('password', '123 456')).toContain('不能包含空格');
+  });
+
+  it('强密码模式要求字母 + 数字', () => {
+    expect(message('password', 'abcdefgh', { strength: 'strong' })).toContain('字母和数字');
+    expect(validateField('password', 'abc12345', { strength: 'strong' }).ok).toBe(true);
+  });
+});
+
+describe('手机号 / 邮箱 / 联系方式', () => {
+  it('接受 11 位手机号并剥离 +86 前缀', () => {
+    const result = validateField('phone', '+86 138-0013-8000');
+    expect(result.ok).toBe(true);
+    expect(result.value).toBe('13800138000');
+  });
+
+  it('拒绝号段和位数不合法的手机号', () => {
+    expect(message('phone', '12800138000')).toContain('第二位为 3-9');
+    expect(message('phone', '1380013800')).toContain('11 位');
+  });
+
+  it('全角数字会自动转成半角', () => {
+    expect(validateField('phone', '１３８００１３８０００').value).toBe('13800138000');
+    expect(validateField('idCard', '１１０１０５１９４９１２３１００２Ｘ').ok).toBe(true);
+  });
+
+  it('接受常见邮箱', () => {
+    expect(validateField('email', 'name@example.com').ok).toBe(true);
+    expect(validateField('email', 'admin@sub.example.co').ok).toBe(true);
+  });
+
+  it('拒绝错误邮箱并给出示例', () => {
+    expect(message('email', 'name@example')).toContain('例如 name@example.com');
+    expect(message('email', 'name @example.com')).not.toBeNull();
+  });
+
+  it('联系方式同时接受手机号和邮箱', () => {
+    expect(validateField('contact', '13800138000').ok).toBe(true);
+    expect(validateField('contact', 'name@example.com').ok).toBe(true);
+    expect(message('contact', 'abc')).toContain('手机号或邮箱');
+  });
+});
+
+describe('用户名 / 工号', () => {
+  it('用户名需字母开头、3-32 位', () => {
+    expect(validateField('username', 'admin').ok).toBe(true);
+    expect(validateField('username', 'user_01').ok).toBe(true);
+    expect(message('username', '1user')).toContain('以字母开头');
+    expect(message('username', 'ab')).toContain('至少需要 3 个字符');
+  });
+
+  it('工号只允许字母、数字、下划线、短横线', () => {
+    expect(validateField('code', 'E1001').ok).toBe(true);
+    expect(validateField('code', 'dept-tech').ok).toBe(true);
+    expect(message('code', '技术部')).toContain('只能包含字母');
+  });
+});
+
+describe('银行卡 / 统一社会信用代码 / 邮编 / 网址', () => {
+  it('银行卡按 Luhn 校验', () => {
+    expect(validateField('bankCard', '4111 1111 1111 1111').ok).toBe(true);
+    expect(message('bankCard', '4111111111111112')).toContain('校验失败');
+    expect(message('bankCard', '411111111111')).toContain('16-19 位');
+  });
+
+  it('统一社会信用代码校验长度和校验位', () => {
+    expect(validateField('creditCode', '91330100716105852F').ok).toBe(true);
+    expect(validateField('creditCode', '91350100M000100Y43').ok).toBe(true);
+    expect(message('creditCode', '91330100716105852A')).toContain('校验位不正确');
+    expect(message('creditCode', '91330100')).toContain('18 位');
+  });
+
+  it('邮编必须是 6 位且不以 0 开头', () => {
+    expect(validateField('postalCode', '100000').ok).toBe(true);
+    expect(message('postalCode', '012345')).toContain('不能以 0 开头');
+  });
+
+  it('网址必须是 http/https', () => {
+    expect(validateField('url', 'https://example.com').ok).toBe(true);
+    expect(validateField('url', 'http://localhost:3000').ok).toBe(true);
+    expect(message('url', 'www.example.com')).toContain('例如 https://example.com');
+    expect(message('url', 'ftp://example.com')).toContain('http://');
+  });
+});
+
+describe('日期与数字', () => {
+  it('日期支持多种分隔符并校验真实存在', () => {
+    const result = validateField('date', '2024/1/5');
+    expect(result.ok).toBe(true);
+    expect(result.value).toBe('2024-01-05');
+    expect(validateField('date', '2024-02-29').ok).toBe(true);
+    expect(message('date', '2023-02-29')).toContain('不存在');
+    expect(message('date', '2024-13-01')).toContain('不存在');
+  });
+
+  it('接受 Excel 导出的日期时间并只保留日期', () => {
+    expect(validateField('date', '2024-01-31 00:00:00').value).toBe('2024-01-31');
+  });
+
+  it('整数与数字支持千分位和范围', () => {
+    expect(validateField('integer', '1,000').value).toBe('1000');
+    expect(message('integer', '1.5')).toContain('整数');
+    expect(message('integer', '5', { min: 10, max: 20 })).toContain('不能小于 10');
+    expect(validateField('number', '1,234.56').value).toBe('1234.56');
+    expect(message('number', '1.2.3')).toContain('必须是数字');
+  });
+
+  it('金额不允许负数或超过两位小数', () => {
+    expect(validateField('amount', '12.50').ok).toBe(true);
+    expect(message('amount', '-1')).toContain('不小于 0');
+    expect(message('amount', '12.345')).toContain('2 位小数');
+  });
+});
+
+describe('必填与自定义扩展', () => {
+  it('必填为空时提示请输入，选填为空时直接通过', () => {
+    expect(message('name', '  ', { label: '姓名', required: true })).toBe('请输入姓名');
+    expect(validateField('name', '', { required: false }).ok).toBe(true);
+  });
+
+  it('可以注册新字段类型供前后端复用', () => {
+    registerFieldType('evenNumber', {
+      label: '数值',
+      normalize: (v) => v.trim(),
+      check: (v, ctx) => (Number(v) % 2 === 0 ? null : `${ctx.label}必须是偶数`),
+    });
+    expect(validateField('evenNumber', '4').ok).toBe(true);
+    expect(message('evenNumber', '3')).toBe('数值必须是偶数');
+    expect(fieldTypeLabel('evenNumber')).toBe('数值');
+  });
+
+  it('文本支持自定义正则与长度', () => {
+    expect(
+      validateField('text', 'hello', {
+        label: '口令',
+        pattern: /^h/,
+        patternMessage: '必须以 h 开头',
+      }).ok
+    ).toBe(true);
+    expect(message('text', 'x', { label: '昵称', min: 2 })).toContain('至少需要 2 个字符');
+    expect(message('text', 'abc', { label: '昵称', max: 2 })).toContain('不能超过 2 个字符');
+  });
+});
+
+describe('字段类型自动推断', () => {
+  it('按字段名识别常见类型', () => {
+    expect(inferValidationType('idCard')).toBe('idCard');
+    expect(inferValidationType('mobile')).toBe('phone');
+    expect(inferValidationType('email')).toBe('email');
+    expect(inferValidationType('newPassword')).toBe('password');
+    expect(inferValidationType('realName')).toBe('name');
+    expect(inferValidationType('contact')).toBe('contact');
+    expect(inferValidationType('jobNo')).toBe('code');
+    expect(inferValidationType('hireDate')).toBe('date');
+    expect(inferValidationType('salary')).toBe('amount');
+  });
+
+  it('按中文标签识别常见类型', () => {
+    expect(inferValidationType('field1', '身份证号')).toBe('idCard');
+    expect(inferValidationType('field2', '联系方式')).toBe('contact');
+    expect(inferValidationType('field2b', '手机或邮箱')).toBe('contact');
+    expect(inferValidationType('field3', '真实姓名')).toBe('name');
+    expect(inferValidationType('field4', '月薪')).toBe('amount');
+  });
+
+  it('人员模型的 name 才按姓名校验，避免误伤部门/菜单名称', () => {
+    expect(inferValidationType('name', '名称', undefined, 'Employee')).toBe('name');
+    expect(inferValidationType('name', '名称', undefined, 'User')).toBe('name');
+    expect(inferValidationType('name', '名称', undefined, 'Department')).toBeUndefined();
+  });
+
+  it('形近英文单词不误判', () => {
+    expect(inferValidationType('feedback')).toBeUndefined();
+    expect(inferValidationType('candidate')).toBeUndefined();
+    expect(inferValidationType('message')).toBeUndefined();
+    // 权限标识带冒号，不能误判成工号/编码
+    expect(inferValidationType('permCode')).toBeUndefined();
+  });
+
+  it('建议输入长度可直接给输入框使用', () => {
+    expect(suggestedMaxLength('idCard')).toBe(18);
+    expect(suggestedMaxLength('phone')).toBe(20);
+  });
+});
+
+describe('zod 适配器', () => {
+  it('必填字段校验失败时返回友好提示', () => {
+    const schema = zField('idCard', { label: '身份证号' });
+    const bad = schema.safeParse('110105194912310021');
+    expect(bad.success).toBe(false);
+    if (!bad.success) expect(bad.error.issues[0]?.message).toContain('校验位不正确');
+    const good = schema.safeParse('110105 19491231 002x');
+    expect(good.success).toBe(true);
+    if (good.success) expect(good.data).toBe('11010519491231002X');
+  });
+
+  it('选填字段允许空串和缺省，可空字段允许 null', () => {
+    expect(zOptionalField('password').safeParse(undefined).success).toBe(true);
+    expect(zNullableField('email').safeParse('').success).toBe(true);
+    expect(zNullableField('email').safeParse(null).success).toBe(true);
+    expect(zNullableField('email', { label: '邮箱' }).safeParse('bad').success).toBe(false);
+  });
+
+  it('必填字段不接受空串、缺省和 null，并给出中文提示', () => {
+    for (const value of ['   ', undefined, null]) {
+      const bad = zField('name', { label: '姓名' }).safeParse(value);
+      expect(bad.success).toBe(false);
+      if (!bad.success) expect(bad.error.issues[0]?.message).toBe('请输入姓名');
+    }
+  });
+});