|
| 1 | +import { describe, it, expect } from 'vitest'; |
| 2 | +import { |
| 3 | + ObjectNameSchema, |
| 4 | + FieldNameSchema, |
| 5 | + ViewNameSchema, |
| 6 | + AppNameSchema, |
| 7 | + FlowNameSchema, |
| 8 | + RoleNameSchema, |
| 9 | + type ObjectName, |
| 10 | + type FieldName, |
| 11 | + type ViewName, |
| 12 | + type AppName, |
| 13 | + type FlowName, |
| 14 | + type RoleName, |
| 15 | +} from './branded-types.zod'; |
| 16 | + |
| 17 | +describe('ObjectNameSchema', () => { |
| 18 | + it('should accept valid snake_case object names', () => { |
| 19 | + const validNames = ['account', 'project_task', 'crm_lead', 'user_profile']; |
| 20 | + validNames.forEach((name) => { |
| 21 | + expect(() => ObjectNameSchema.parse(name)).not.toThrow(); |
| 22 | + }); |
| 23 | + }); |
| 24 | + |
| 25 | + it('should reject dots (not allowed in object names)', () => { |
| 26 | + expect(() => ObjectNameSchema.parse('user.created')).toThrow(); |
| 27 | + }); |
| 28 | + |
| 29 | + it('should reject uppercase', () => { |
| 30 | + expect(() => ObjectNameSchema.parse('Account')).toThrow(); |
| 31 | + expect(() => ObjectNameSchema.parse('projectTask')).toThrow(); |
| 32 | + }); |
| 33 | + |
| 34 | + it('should reject too short names', () => { |
| 35 | + expect(() => ObjectNameSchema.parse('a')).toThrow(); |
| 36 | + }); |
| 37 | + |
| 38 | + it('should produce branded type at runtime', () => { |
| 39 | + const name: ObjectName = ObjectNameSchema.parse('my_object'); |
| 40 | + expect(name).toBe('my_object'); |
| 41 | + }); |
| 42 | +}); |
| 43 | + |
| 44 | +describe('FieldNameSchema', () => { |
| 45 | + it('should accept valid snake_case field names', () => { |
| 46 | + const validNames = ['first_name', 'created_at', 'total_amount', 'is_active']; |
| 47 | + validNames.forEach((name) => { |
| 48 | + expect(() => FieldNameSchema.parse(name)).not.toThrow(); |
| 49 | + }); |
| 50 | + }); |
| 51 | + |
| 52 | + it('should reject dots', () => { |
| 53 | + expect(() => FieldNameSchema.parse('user.name')).toThrow(); |
| 54 | + }); |
| 55 | + |
| 56 | + it('should reject camelCase', () => { |
| 57 | + expect(() => FieldNameSchema.parse('firstName')).toThrow(); |
| 58 | + }); |
| 59 | + |
| 60 | + it('should produce branded type at runtime', () => { |
| 61 | + const name: FieldName = FieldNameSchema.parse('task_name'); |
| 62 | + expect(name).toBe('task_name'); |
| 63 | + }); |
| 64 | +}); |
| 65 | + |
| 66 | +describe('ViewNameSchema', () => { |
| 67 | + it('should accept valid system identifiers', () => { |
| 68 | + const validNames = ['all_tasks', 'my_open_deals', 'contact.recent']; |
| 69 | + validNames.forEach((name) => { |
| 70 | + expect(() => ViewNameSchema.parse(name)).not.toThrow(); |
| 71 | + }); |
| 72 | + }); |
| 73 | + |
| 74 | + it('should allow dots (namespacing)', () => { |
| 75 | + const name: ViewName = ViewNameSchema.parse('contact.recent'); |
| 76 | + expect(name).toBe('contact.recent'); |
| 77 | + }); |
| 78 | + |
| 79 | + it('should reject uppercase', () => { |
| 80 | + expect(() => ViewNameSchema.parse('AllTasks')).toThrow(); |
| 81 | + }); |
| 82 | +}); |
| 83 | + |
| 84 | +describe('AppNameSchema', () => { |
| 85 | + it('should accept valid app names', () => { |
| 86 | + const validNames = ['crm', 'helpdesk', 'project_management']; |
| 87 | + validNames.forEach((name) => { |
| 88 | + expect(() => AppNameSchema.parse(name)).not.toThrow(); |
| 89 | + }); |
| 90 | + }); |
| 91 | + |
| 92 | + it('should produce branded type at runtime', () => { |
| 93 | + const name: AppName = AppNameSchema.parse('crm'); |
| 94 | + expect(name).toBe('crm'); |
| 95 | + }); |
| 96 | +}); |
| 97 | + |
| 98 | +describe('FlowNameSchema', () => { |
| 99 | + it('should accept valid flow names', () => { |
| 100 | + const validNames = ['approval_flow', 'onboarding_wizard', 'lead_qualification']; |
| 101 | + validNames.forEach((name) => { |
| 102 | + expect(() => FlowNameSchema.parse(name)).not.toThrow(); |
| 103 | + }); |
| 104 | + }); |
| 105 | + |
| 106 | + it('should produce branded type at runtime', () => { |
| 107 | + const name: FlowName = FlowNameSchema.parse('approval_flow'); |
| 108 | + expect(name).toBe('approval_flow'); |
| 109 | + }); |
| 110 | +}); |
| 111 | + |
| 112 | +describe('RoleNameSchema', () => { |
| 113 | + it('should accept valid role names', () => { |
| 114 | + const validNames = ['admin', 'sales_manager', 'read_only']; |
| 115 | + validNames.forEach((name) => { |
| 116 | + expect(() => RoleNameSchema.parse(name)).not.toThrow(); |
| 117 | + }); |
| 118 | + }); |
| 119 | + |
| 120 | + it('should produce branded type at runtime', () => { |
| 121 | + const name: RoleName = RoleNameSchema.parse('admin'); |
| 122 | + expect(name).toBe('admin'); |
| 123 | + }); |
| 124 | +}); |
| 125 | + |
| 126 | +describe('Branded type safety', () => { |
| 127 | + it('branded types parse the same underlying strings', () => { |
| 128 | + const objectName = ObjectNameSchema.parse('my_entity'); |
| 129 | + const fieldName = FieldNameSchema.parse('my_entity'); |
| 130 | + // At runtime both are 'my_entity' strings but TS types differ |
| 131 | + expect(objectName).toBe('my_entity'); |
| 132 | + expect(fieldName).toBe('my_entity'); |
| 133 | + }); |
| 134 | +}); |
0 commit comments