@wener/common 1.0.5 → 2.0.2

package/src/foundation/schema/SexType.ts

@@ -0,0 +1,21 @@
+import { z } from 'zod/v4';
+import type { EnumValues } from '../../resource/schema';
+
+// Sex 指的是生理性别/生物性别，通常由出生时的生物特征决定
+export const SexType = Object.freeze({
+	__proto__: null,
+	Male: 'Male',
+	Female: 'Female',
+});
+export type SexType = EnumValues<typeof SexType>;
+
+export const SexTypeSchema = z
+	.union([
+		//
+		z.literal(SexType.Male).describe('男'),
+		z.literal(SexType.Female).describe('女'),
+	])
+	.describe('性别')
+	.meta({
+		title: 'SexType',
+	});

package/src/foundation/schema/index.ts

@@ -0,0 +1 @@
+export { SexType, SexTypeSchema } from './SexType';

package/src/foundation/schema/parseSexType.ts

@@ -0,0 +1,19 @@
+import { SexType } from './SexType';
+
+export function parseSexType(s: string | null | undefined): undefined | SexType {
+	if (!s) return undefined;
+
+	switch (s.toLowerCase()) {
+		case '♂':
+		case '男':
+		case 'male':
+		case 'man':
+			return SexType.Male;
+		case '♀':
+		case '女':
+		case 'female':
+		case 'woman':
+			return SexType.Female;
+	}
+	return undefined;
+}

package/src/foundation/schema/types.ts

@@ -0,0 +1,8 @@
+import z from 'zod/v4';
+
+export const CoordinatesSchema = z
+	.object({
+		latitude: z.number().min(-90).max(90).describe('纬度'),
+		longitude: z.number().min(-180).max(180).describe('经度'),
+	})
+	.describe('坐标信息');

package/src/jsonschema/JsonSchema.test.ts

@@ -1,5 +1,8 @@
+import type { TObject } from '@sinclair/typebox';
+import type { AnySchemaObject, JSONSchemaType } from 'ajv';
 import { describe, expect, it } from 'vitest';
 import { JsonSchema } from './JsonSchema';
+import type { JsonSchemaDef } from './types';
 
 describe('jsonschema', () => {
 	it('should create from schema', () => {
@@ -15,4 +18,18 @@ describe('jsonschema', () => {
 			expect(JsonSchema.create(a)).toEqual(b);
 		}
 	});
+
+	it('should match typebox types', () => {
+		let a: JsonSchemaDef | undefined;
+		let b: TObject<{}> | undefined;
+		a = b;
+	});
+
+	it('should match ajv types', () => {
+		let a: JsonSchemaDef | undefined;
+		let b: AnySchemaObject | undefined;
+		let c: JSONSchemaType<{}> | undefined;
+		a = b;
+		// a = c;
+	});
 });

package/src/jsonschema/JsonSchema.ts

@@ -55,7 +55,7 @@ type TypeOfSchema<S> = S extends TSchema ? Static<S> : any;
 export namespace JsonSchema {
 	export let schemas: JsonSchemaDef[] = [];
 
-	export const createAjv = _createAjv;
+	export let createAjv = _createAjv;
 
 	export function addSchema(
 		schema: JsonSchemaDef,
@@ -113,7 +113,7 @@ export namespace JsonSchema {
 		// will not ensure value match the rule
 		return match(schema as JsonSchemaDef)
 			.returnType<any>()
-			.with({ const: P.select() }, (v) => v)
+			.with({ const: P.nonNullable }, (v) => v)
 			.with({ default: P.select() }, (v) => v)
 			.with({ anyOf: P.nonNullable }, (schema) => {
 				return create(schema.anyOf[0]);

package/src/jsonschema/types.d.ts

@@ -5,7 +5,8 @@ type JsonSchemaTypeName =
 	| 'boolean'
 	| 'object'
 	| 'array'
-	| 'null';
+	| 'null'
+	| undefined;
 
 type JsonValue =
 	| string //
@@ -13,15 +14,21 @@ type JsonValue =
 	| boolean
 	| { [key: string]: JsonValue }
 	| JsonValue[]
-	| null;
+	| null
+	| undefined; //
 
 type JsonSchemaVersion =
 	| 'http://json-schema.org/schema' // latest
+	//
 	| 'https://json-schema.org/draft/2020-12/schema'
+	| 'https://json-schema.org/draft/2019-09/schema'
 	// draft-07
-	| 'http://json-schema.org/draft-07/schema#' //
-	| 'http://json-schema.org/draft-07/hyper-schema#';
-
+	| 'https://json-schema.org/draft-07/schema'
+	| 'http://json-schema.org/draft-07/schema'
+	| 'https://json-schema.org/draft-07/hyper-schema'
+	| 'http://json-schema.org/draft-07/hyper-schema'
+	//
+	| 'https://json-schema.org/draft-04/schema';
 type JsonSchemaFormatName =
 	//
 	| 'date-time'
@@ -47,7 +54,12 @@ type JsonSchemaFormatName =
 	| 'json-pointer'
 	| 'relative-json-pointer';
 
-export type JsonSchemaDef = {
+/**
+ * JSON Schema Definition
+ *
+ * @see https://json-schema.org/specification-links.html
+ */
+export type JsonSchemaDef<I = any, O = I> = {
 	$id?: string;
 	$ref?: string;
 	/**
@@ -67,7 +79,7 @@ export type JsonSchemaDef = {
 	$defs?: { [key: string]: JsonSchemaDef };
 
 	type?: JsonSchemaTypeName | JsonSchemaTypeName[];
-	enum?: JsonValue[];
+	enum?: JsonValue;
 	const?: JsonValue;
 
 	//region Numeric Validation
@@ -90,12 +102,23 @@ export type JsonSchemaDef = {
 
 	//region Array Validation
 
+	/**
+	 * schema for array items
+	 * @see https://json-schema.org/understanding-json-schema/reference/array.html#items
+	 */
 	items?: JsonSchemaDef | JsonSchemaDef[];
-	additionalItems?: JsonSchemaDef;
+	additionalItems?: JsonSchemaDef | boolean;
 	maxItems?: number;
 	minItems?: number;
 	uniqueItems?: boolean;
 	contains?: JsonSchemaDef;
+
+	//region Draft 2022-12
+	minContains?: number;
+	maxContains?: number;
+	prefixItems?: JsonSchemaDef[];
+	//endregion
+
 	//endregion
 
 	//region Object Validation
@@ -105,9 +128,25 @@ export type JsonSchemaDef = {
 	required?: string[];
 	properties?: { [key: string]: JsonSchemaDef };
 	patternProperties?: { [key: string]: JsonSchemaDef };
-	additionalProperties?: JsonSchemaDef;
-	dependencies?: { [key: string]: JsonSchemaDef | string[] };
+	/**
+	 * Replaced by {@link unevaluatedProperties} in Draft 2019-09+
+	 */
+	additionalProperties?: JsonSchemaDef | boolean; // true = {}
+	/**
+	 * Superseded by {@link dependentSchemas}, {@link dependentRequired} in Draft 2019-09+
+	 */
+	dependencies?: { [key: string]: undefined | JsonSchemaDef | string[] };
 	propertyNames?: JsonSchemaDef;
+
+	//region Draft 2019-09+
+
+	dependentSchemas?: { [key: string]: JsonSchemaDef };
+	dependentRequired?: { [key: string]: string[] };
+	unevaluatedProperties?: JsonSchemaDef | boolean;
+	unevaluatedItems?: JsonSchemaDef | boolean;
+
+	//endregion
+
 	//endregion
 
 	//region Conditional
@@ -120,9 +159,9 @@ export type JsonSchemaDef = {
 
 	//region Boolean Logic
 
-	allOf?: JsonSchemaDef[];
+	allOf?: JsonSchemaDef[]; // extends, merge
 	anyOf?: JsonSchemaDef[];
-	oneOf?: JsonSchemaDef[];
+	oneOf?: JsonSchemaDef[]; // polymorphism, enum
 	not?: JsonSchemaDef;
 	//endregion
 
@@ -159,5 +198,17 @@ export type JsonSchemaDef = {
 
 	//endregion
 
+	//region OpenAPI Spec
+
 	nullable?: boolean;
+
+	discriminator?: {
+		propertyName: string;
+		mapping?: { [key: string]: string };
+	};
+
+	//endregion
+
+	// [key: `x-${string}`]: JsonValue;
+	[key: string]: JsonValue;
 };

package/src/password/Password.ts

@@ -68,10 +68,10 @@ export namespace Password {
 		return f;
 	}
 
-	export async function check(password: string, hash: string) {
+	export async function validate(password: string, hash: string) {
 		let res = await parse(hash);
 		let f = resolveAlgorithm(res.id);
-		return { result: f.verify(password, hash, res), parsed: res };
+		return { result: await f.verify(password, hash, res), parsed: res };
 	}
 
 	export async function verify(password: string, hash: string) {

package/src/resource/Identifiable.ts

@@ -0,0 +1,3 @@
+export type Identifiable = {
+	id: string;
+};

package/src/resource/ListQuery.ts

@@ -0,0 +1,53 @@
+import { z } from 'zod/v4';
+
+export type ListQueryInput = z.input<typeof ListQuerySchema>;
+export type ListQuery = z.infer<typeof ListQuerySchema>;
+const IntLikeSchema = z.coerce
+	.number()
+	.multipleOf(1)
+	.min(0)
+	.optional()
+	.overwrite((v) => v || undefined);
+export const ListQuerySchema = z.object({
+	id: z.coerce.string().optional(),
+	ids: z.array(z.coerce.string()).optional(),
+	filter: z.string().optional().describe('sql-like filter string'),
+	filters: z.array(z.any()).optional().describe('sql-like filter string'),
+	where: z.record(z.string(), z.any()).optional().describe('document query filter'),
+	search: z.string().optional(),
+	limit: IntLikeSchema,
+	offset: IntLikeSchema,
+	order: z.array(z.string()).optional().describe('order like "a,-b,c desc null last"'),
+	pageIndex: IntLikeSchema.describe('0-based page index'),
+	pageNumber: IntLikeSchema.describe('1-based page number'),
+	pageSize: IntLikeSchema,
+	cursor: z.string().optional(),
+	deleted: z.coerce.boolean().optional(),
+});
+
+type ListQueryOverride = ListQueryInput | undefined | ((input: ListQueryInput) => ListQueryInput | undefined | void);
+
+export function resolveListQuery(target: ListQueryInput | undefined, ...args: ListQueryOverride[]): ListQuery {
+	let out = args.reduce((a: ListQueryInput, source) => {
+		if (typeof source === 'function') {
+			const result = source(a);
+			// do not use the result as merge source
+			return result || a;
+		}
+
+		let b: ListQueryInput | undefined = source;
+		if (!b) return a;
+
+		// do not resolve id to ids
+		let ids = [...(a.ids || []), ...(b.ids || [])];
+		return {
+			...a,
+			...b,
+			ids: ids,
+			filters: [...(a.filters || []), ...(b.filters || [])],
+			search: b.search || a.search,
+			// NOTE maybe should merge where ?
+		};
+	}, target || {});
+	return ListQuerySchema.parse(out);
+}

package/src/resource/getTitleOfResource.tsx

@@ -0,0 +1,6 @@
+export function getTitleOfResource(res?: any): string | undefined {
+	if (res && typeof res === 'object') {
+		return res.displayName || res.title || res.fullName || res.loginName || res.topic || res.code;
+	}
+	return undefined;
+}

package/src/resource/index.ts

@@ -0,0 +1,4 @@
+export { type AnyResource } from './schema/AnyResourceSchema';
+export { type Identifiable } from './Identifiable';
+export { getTitleOfResource } from './getTitleOfResource';
+export { type ListQueryInput, type ListQuery, resolveListQuery, ListQuerySchema } from './ListQuery';

package/src/resource/schema/AnyResourceSchema.ts

@@ -0,0 +1,113 @@
+import { z } from 'zod/v4';
+import { SexTypeSchema } from '../../foundation/schema/SexType';
+import { rz } from './types';
+
+export type AnyResource = z.infer<typeof AnyResourceSchema>;
+export const AnyResourceSchema = z
+	.object({
+		id: rz.resourceId.readonly().describe('ID'),
+		uid: z.guid().nullish().readonly().describe('唯一ID'),
+		tid: rz.resourceId.nullish().readonly().describe('租户ID'),
+		sid: z.coerce.number().nullish().readonly().describe('序号'),
+		eid: z.string().nullish().readonly().describe('外部ID'),
+		cid: z.string().nullish().readonly().describe('服务商ID'),
+		rid: z.string().nullish().readonly().describe('服务商资源ID'),
+
+		code: z.string().nullish().describe('编号'),
+
+		fullName: rz.friendlyName.optional().describe('名称'),
+		displayName: rz.friendlyName.nullish().describe('显示名'),
+		loginName: rz.loginName.nullish().describe('登录名'),
+		email: z.string().nullish().describe('邮箱'),
+		emailVerifiedAt: rz.date.nullish().describe('邮箱验证时间'),
+		phoneNumber: rz.phoneNumber.nullish().describe('电话号码'),
+		phoneNumberVerifiedAt: rz.date.nullish().describe('电话号码验证时间'),
+
+		jobNumber: z.string().nullish().describe('工号'),
+		jobTitle: z.string().nullish().describe('职位'),
+		birthDate: rz.date.nullish().describe('出生日期'),
+
+		password: rz.password.nullish().describe('密码'),
+		sex: SexTypeSchema.nullish().describe('性别'),
+
+		contactName: rz.friendlyName.nullish().describe('联系人'),
+		contactPhone: rz.phoneNumber.nullish().describe('联系电话'),
+		contactEmail: z.string().nullish().describe('联系邮箱'),
+		contactAddress: z.string().nullish().describe('联系地址'),
+		alternativeName: rz.friendlyName.nullish().describe('备用联系人'),
+		alternativeEmail: z.string().nullish().describe('备用联系邮箱'),
+		alternativePhone: rz.phoneNumber.nullish().describe('备用联系电话'),
+		alternativeAddress: z.string().nullish().describe('备用联系地址'),
+
+		title: z.string().trim().nullish().describe('标题'),
+		description: z.string().trim().nullish().describe('描述'),
+		topic: z.string().nullish().describe('主题'),
+		summary: z.string().nullish().describe('摘要'),
+
+		avatarUrl: z.string().nullish().describe('头像'),
+		photoUrl: z.string().nullish().describe('照片'),
+		imageUrl: z.string().nullish().describe('图片'),
+		bannerUrl: z.string().nullish().describe('横幅图片'),
+
+		type: z.string().nullish().describe('类型'),
+		data: z.record(z.string(), z.any()).nullish().describe('数据'),
+
+		licenseNumber: z.string().nullish().describe('证件号码'),
+		licenseStartDate: rz.date.nullish().describe('证件有效期开始日期'),
+		licenseEndDate: rz.date.nullish().describe('证件有效期结束日期'),
+		licenseAddress: z.string().nullish().describe('证件地址'),
+		licenseFrontUrl: z.string().nullish().describe('证件正面照片'),
+		licenseBackUrl: z.string().nullish().describe('证件背面照片'),
+
+		address: z.string().nullish().describe('地址'),
+		divisionCode: z.string().nullish().describe('行政区划代码'),
+		province: z.string().nullish().describe('省'),
+		city: z.string().nullish().describe('市'),
+
+		startDate: rz.date.nullish().describe('开始日期'),
+		endDate: rz.date.nullish().describe('结束日期'),
+		startTime: rz.dateTime.nullish().describe('开始时间'),
+		endTime: rz.dateTime.nullish().describe('结束时间'),
+
+		userId: rz.resourceIdOf('User').nullish(),
+		entityId: rz.resourceId.nullish().describe('关联的实体'),
+		entityType: z.string().nullish().describe('关联的实体类型'),
+		customerId: rz.resourceId.nullish().describe('客户'),
+		customerType: z.string().nullish().describe('客户类型'),
+		contactId: rz.resourceId.nullish().describe('联系人'),
+		accountId: rz.resourceId.nullish().describe('账户'),
+
+		ownerId: rz.resourceId.nullish(),
+		ownerType: z.string().nullish().describe('负责人类型'),
+		owningUserId: rz.resourceId.nullish().describe('负责人'),
+
+		parentId: rz.resourceId.nullish().describe('父级'),
+
+		metadata: z.record(z.string(), z.any()).nullish().describe('元数据'),
+		tags: z.array(z.string()).nullish().describe('标记'),
+		notes: z.string().nullish().describe('备注'),
+
+		state: z.string().nullish().describe('系统状态'),
+		status: z.string().nullish().describe('状态'),
+		statusReason: z.string().nullish().describe('状态原因'),
+		statusUpdatedAt: rz.dateTime.nullish().describe('状态更新时间'),
+		statusUpdatedById: rz.resourceId.nullish().describe('状态更新人'),
+
+		createdAt: rz.dateTime.nullish().readonly().describe('创建时间'),
+		updatedAt: rz.dateTime.nullish().readonly().describe('更新时间'),
+		deletedAt: rz.dateTime.nullish().readonly().describe('删除时间'),
+
+		createdById: z.string().nullish().readonly().describe('创建人'),
+		updatedById: z.string().nullish().readonly().describe('更新人'),
+		deletedById: z.string().nullish().readonly().describe('删除人'),
+
+		attributes: z.record(z.string(), z.any()).nullish().describe('自定义属性'),
+		properties: z.record(z.string(), z.any()).nullish().describe('属性'),
+		extensions: z.record(z.string(), z.any()).nullish().describe('扩展属性'),
+
+		__typename: z.coerce.string().nullish().describe('类型'),
+	})
+	.meta({
+		title: 'AnyResource',
+		description: '任意资源',
+	});

package/src/resource/schema/BaseResourceSchema.ts

@@ -0,0 +1,32 @@
+import { AnyResourceSchema } from './AnyResourceSchema';
+
+export const BaseResourceSchema = AnyResourceSchema.pick({
+	id: true,
+	uid: true,
+	tid: true,
+	eid: true,
+
+	state: true,
+	status: true,
+	statusReason: true,
+	statusUpdatedAt: true,
+	statusUpdatedById: true,
+
+	createdAt: true,
+	updatedAt: true,
+	deletedAt: true,
+	createdById: true,
+	updatedById: true,
+	deletedById: true,
+	attributes: true,
+	properties: true,
+}).required({
+	uid: true,
+	tid: true,
+	state: true,
+	status: true,
+	createdAt: true,
+	updatedAt: true,
+	attributes: true,
+	properties: true,
+});

package/src/resource/schema/ResourceActionType.ts

@@ -0,0 +1,123 @@
+import { z } from 'zod/v4';
+import type { EnumValues } from './types';
+
+export const ResourceActionType = Object.freeze({
+	__proto__: null,
+	Approve: 'Approve',
+	AssignOwner: 'AssignOwner',
+	Bind: 'Bind',
+	BindCustomer: 'BindCustomer',
+	BindEntity: 'BindEntity',
+	BindUser: 'BindUser',
+	Cancel: 'Cancel',
+	ChangePassword: 'ChangePassword',
+	ClaimOwner: 'ClaimOwner',
+	Close: 'Close',
+	Communicate: 'Communicate',
+	Complete: 'Complete',
+	Create: 'Create',
+	Delete: 'Delete',
+	Deny: 'Deny',
+	Disable: 'Disable',
+	Download: 'Download',
+	Edit: 'Edit',
+	Enable: 'Enable',
+	List: 'List',
+	Login: 'Login',
+	Logout: 'Logout',
+	Manage: 'Manage',
+	Publish: 'Publish',
+	Purge: 'Purge',
+	Read: 'Read',
+	Reject: 'Reject',
+	ReleaseOwner: 'ReleaseOwner',
+	ResetPassword: 'ResetPassword',
+	ReturnForRevision: 'ReturnForRevision',
+	Revise: 'Revise',
+	SaveDraft: 'SaveDraft',
+	Signup: 'Signup',
+	Submit: 'Submit',
+	SubmitAgency: 'SubmitAgency',
+	SubmitVendor: 'SubmitVendor',
+	Suspend: 'Suspend',
+	Terminate: 'Terminate',
+	Timeout: 'Timeout',
+	Unbind: 'Unbind',
+	UnbindCustomer: 'UnbindCustomer',
+	UnbindEntity: 'UnbindEntity',
+	UnbindUser: 'UnbindUser',
+	Undelete: 'Undelete',
+	Unpublish: 'Unpublish',
+	Update: 'Update',
+	UpdateNotes: 'UpdateNotes',
+	UpdateTags: 'UpdateTags',
+	Upload: 'Upload',
+	Validate: 'Validate',
+	View: 'View',
+	Write: 'Write',
+} as const);
+export type ResourceActionType = EnumValues<typeof ResourceActionType>;
+export const ResourceActionTypeSchema = z
+	.union([
+		z.literal(ResourceActionType.Approve).describe('批准'),
+		z.literal(ResourceActionType.AssignOwner).describe('分配负责人'),
+		z.literal(ResourceActionType.Bind).describe('绑定'),
+		z.literal(ResourceActionType.BindCustomer).describe('绑定客户'),
+		z.literal(ResourceActionType.BindEntity).describe('绑定实体'),
+		z.literal(ResourceActionType.BindUser).describe('绑定用户'),
+		z.literal(ResourceActionType.Cancel).describe('取消'),
+		z.literal(ResourceActionType.ChangePassword).describe('修改密码'),
+		z.literal(ResourceActionType.ClaimOwner).describe('认领负责人'),
+		z.literal(ResourceActionType.Close).describe('关闭'),
+		z.literal(ResourceActionType.Communicate).describe('沟通'),
+		z.literal(ResourceActionType.Complete).describe('完成'),
+		z.literal(ResourceActionType.Create).describe('创建'),
+		z.literal(ResourceActionType.Delete).describe('删除'),
+		z.literal(ResourceActionType.Deny).describe('拒绝'),
+		z.literal(ResourceActionType.Disable).describe('禁用'),
+		z.literal(ResourceActionType.Download).describe('下载'),
+		z.literal(ResourceActionType.Edit).describe('编辑'),
+		z.literal(ResourceActionType.Enable).describe('启用'),
+		z.literal(ResourceActionType.List).describe('列表'),
+		z.literal(ResourceActionType.Login).describe('登录'),
+		z.literal(ResourceActionType.Logout).describe('登出'),
+		z.literal(ResourceActionType.Manage).describe('管理'),
+		z.literal(ResourceActionType.Publish).describe('发布'),
+		z.literal(ResourceActionType.Purge).describe('彻底删除'),
+		z.literal(ResourceActionType.Read).describe('读取'),
+		z.literal(ResourceActionType.Reject).describe('驳回'),
+		z.literal(ResourceActionType.ReleaseOwner).describe('释放负责人'),
+		z.literal(ResourceActionType.ResetPassword).describe('重置密码'),
+		z.literal(ResourceActionType.ReturnForRevision).describe('退回修订'),
+		z.literal(ResourceActionType.Revise).describe('修订'),
+		z.literal(ResourceActionType.SaveDraft).describe('保存草稿'),
+		z.literal(ResourceActionType.Signup).describe('注册'),
+		z.literal(ResourceActionType.Submit).describe('提交'),
+		z.literal(ResourceActionType.SubmitAgency).describe('提交机构'),
+		z.literal(ResourceActionType.SubmitVendor).describe('提交供应商'),
+		z.literal(ResourceActionType.Suspend).describe('暂停'),
+		z.literal(ResourceActionType.Terminate).describe('终止'),
+		z.literal(ResourceActionType.Timeout).describe('超时'),
+		z.literal(ResourceActionType.Unbind).describe('解绑'),
+		z.literal(ResourceActionType.UnbindCustomer).describe('解绑客户'),
+		z.literal(ResourceActionType.UnbindEntity).describe('解绑实体'),
+		z.literal(ResourceActionType.UnbindUser).describe('解绑用户'),
+		z.literal(ResourceActionType.Undelete).describe('恢复删除'),
+		z.literal(ResourceActionType.Unpublish).describe('取消发布'),
+		z.literal(ResourceActionType.Update).describe('更新'),
+		z.literal(ResourceActionType.UpdateNotes).describe('修改备注'),
+		z.literal(ResourceActionType.UpdateNotes).describe('更新备注'),
+		z.literal(ResourceActionType.UpdateTags).describe('更新标签'),
+		z.literal(ResourceActionType.Upload).describe('上传'),
+		z.literal(ResourceActionType.Validate).describe('校验'),
+		z.literal(ResourceActionType.View).describe('查看'),
+		z.literal(ResourceActionType.Write).describe('写入'),
+	])
+	.meta({
+		title: 'ResourceAction',
+		description: '资源操作',
+		type: 'string',
+	});
+export const ResourceActionDataSchema = z.object({
+	reason: z.string().optional().describe('操作原因'),
+});