@wener/common 1.0.4 → 2.0.1

package/src/consola/formatLogObject.ts

@@ -0,0 +1,171 @@
+import colors from 'chalk';
+import type { ConsolaOptions, FormatOptions, LogObject, LogType } from 'consola/core';
+import dayjs from 'dayjs';
+import { isDevelopment } from 'std-env';
+
+const levelColors: Record<LogType, (str: string) => string> = {
+	trace: colors.gray,
+	debug: colors.cyan,
+	info: colors.blueBright,
+	warn: colors.yellow,
+	error: colors.red,
+	fatal: colors.bgRed.white,
+	silent: colors.white,
+	log: colors.white,
+	success: colors.green,
+	fail: colors.red,
+	ready: colors.green,
+	start: colors.cyan,
+	box: colors.white,
+	verbose: colors.green,
+};
+
+const levelShort: Record<LogType, string> = {
+	trace: 'TRAC',
+	debug: 'DEBG',
+	info: 'INFO',
+	warn: 'WARN',
+	error: 'ERRO',
+	fatal: 'FATL',
+	silent: 'SLNT',
+	log: 'LOG ', // Added space to make it 4 characters
+	success: 'SUCC',
+	fail: 'FAIL',
+	ready: 'READ',
+	start: 'STRT',
+	box: 'BOX ', // Added space to make it 4 characters
+	verbose: 'VERB',
+};
+const start = Date.now();
+
+export function formatLogObject(
+	o: LogObject,
+	ctx: {
+		options: ConsolaOptions;
+	},
+) {
+	let { date, type, tag } = o;
+	type = type === 'log' ? 'info' : type;
+
+	const color = levelColors[type] || colors.white;
+	const levelText = levelShort[type] || type.toUpperCase().slice(0, 4); // Get first 4 chars, consistent uppercase
+
+	let line = '';
+	let out: string[] = [];
+
+	// Timestamp
+	if (isDevelopment) {
+		// process.hrtime.bigint()
+		let diff = (date.getTime() - start) / 1000;
+
+		out.push(colors.gray(diff.toFixed(3).padStart(7, ' ')));
+	} else {
+		out.push(colors.gray(dayjs(date).format('YYYY-MM-DD HH:mm:ss.SSS')));
+	}
+
+	// Log Level (colored)
+	// Pad to 4 characters
+	out.push(color(levelText.padEnd(4, ' ')));
+
+	if (tag) {
+		out.push(colors.yellow(`[${tag}]`)); // Added color for tag
+	}
+
+	{
+		const [message, ...additional] = formatArgs(o.args, ctx).split('\n');
+
+		out.push(characterFormat(message));
+
+		line = out.join(' ');
+		if (additional.length > 0) {
+			line += characterFormat(additional.join('\n'));
+		}
+
+		if (type === 'trace') {
+			const _err = new Error('Trace: ' + o.message);
+			line += formatStack(_err.stack || '', _err.message);
+		}
+	}
+
+	// if (!message && typeof args[0] === 'string') {
+	//   message = args.shift();
+	// }
+	// if (message) {
+	//   out.push(message);
+	// }
+	// if (args.length) {
+	//   out.push(...args.map((a) => (typeof a === 'string' ? a : JSON.stringify(a)))); // Handle non-string args
+	// }
+
+	// todo format error
+	// https://github.com/unjs/consola/blob/main/src/reporters/fancy.ts
+
+	// return out.join('  '); // Increased spacing for better readability
+	return line;
+}
+
+function characterFormat(str: string) {
+	return (
+		str
+			// highlight backticks
+			.replace(/`([^`]+)`/gm, (_, m) => colors.cyan(m))
+			// underline underscores
+			.replace(/\s+_([^_]+)_\s+/gm, (_, m) => ` ${colors.underline(m)} `)
+	);
+}
+
+function parseStack(stack: string, message: string) {
+	// const cwd = process.cwd() + sep;
+
+	const lines = stack
+		.split('\n')
+		.splice(message.split('\n').length)
+		.map(
+			(l) => l.trim().replace('file://', ''),
+			// .replace(cwd, '')
+		);
+
+	return lines;
+}
+
+function formatStack(stack: string, message: string, opts?: FormatOptions) {
+	const indent = '  '.repeat((opts?.errorLevel || 0) + 1);
+	return (
+		`\n${indent}`
+		+ parseStack(stack, message)
+			.map(
+				(line) =>
+					'  ' + line.replace(/^at +/, (m) => colors.gray(m)).replace(/\((.+)\)/, (_, m) => `(${colors.cyan(m)})`),
+			)
+			.join(`\n${indent}`)
+	);
+}
+
+function formatArgs(args: any[], opts: FormatOptions) {
+	const _args = args.map((arg) => {
+		if (arg && typeof arg.stack === 'string') {
+			return formatError(arg, opts);
+		}
+		return arg;
+	});
+
+	// Only supported with Node >= 10
+	// https://nodejs.org/api/util.html#util_util_inspect_object_options
+	return formatWithOptions(opts, ..._args);
+}
+
+function formatWithOptions(o: any, ...params: any[]) {
+	// import { formatWithOptions } from 'node:util';
+	return params.join(' ');
+}
+
+function formatError(err: any, opts: FormatOptions): string {
+	const message = err.message ?? formatWithOptions(opts, err);
+	const stack = err.stack ? formatStack(err.stack, message, opts) : '';
+
+	const level = opts?.errorLevel || 0;
+	const causedPrefix = level > 0 ? `${'  '.repeat(level)}[cause]: ` : '';
+	const causedError = err.cause ? '\n\n' + formatError(err.cause, { ...opts, errorLevel: level + 1 }) : '';
+
+	return causedPrefix + message + '\n' + stack + causedError;
+}

package/src/consola/index.ts

@@ -0,0 +1,2 @@
+export { formatLogObject } from './formatLogObject';
+export { createStandardConsolaReporter } from './createStandardConsolaReporter';

package/src/data/maybeNumber.ts

@@ -9,9 +9,13 @@ export function maybeNumber(v: MaybeNumber) {
 		case 'number':
 			return v;
 		case 'bigint':
+			if (v > BigInt(Number.MAX_SAFE_INTEGER) || v < BigInt(Number.MIN_SAFE_INTEGER)) {
+				throw new Error(`bigint out of range`);
+			}
 			return Number(v);
 		case 'string':
-			if (v === '') {
+			v = v.trim();
+			if (!v) {
 				return undefined;
 			}
 	}

package/src/data/resolvePagination.test.ts

@@ -53,6 +53,6 @@ test(resolvePagination.name, () => {
 });
 
 test(`${resolvePagination.name} with options`, () => {
-	expect(resolvePagination({ pageSize: '200' }, { maxPageSize: 50 })).toMatchObject({ pageSize: 50, limit: 50 });
+	expect(resolvePagination({ pageSize: '200' }, { maxLimit: 50 })).toMatchObject({ pageSize: 50, limit: 50 });
 	expect(resolvePagination({}, { pageSize: 30 })).toMatchObject({ pageSize: 30, limit: 30 });
 });

package/src/data/resolvePagination.ts

@@ -1,5 +1,5 @@
 import { maybeFunction, type MaybeFunction } from '@wener/utils';
-import { clamp, mapValues, omitBy, pick } from 'es-toolkit';
+import { mapValues, omitBy, pick } from 'es-toolkit';
 import { maybeNumber, type MaybeNumber } from './maybeNumber';
 
 export type PaginationInput = {
@@ -22,7 +22,8 @@ export function resolvePagination(
 	page: PaginationInput,
 	options: {
 		pageSize?: MaybeFunction<number, [number | undefined]>;
-		maxPageSize?: number;
+		maxLimit?: number;
+		maxOffset?: number;
 	} = {},
 ): ResolvedPagination {
 	let out = omitBy(
@@ -38,15 +39,23 @@ export function resolvePagination(
 	if (options.pageSize) {
 		pageSize = maybeFunction(options.pageSize, pageSize);
 	}
-	pageSize ??= 20;
-	pageSize = clamp(pageSize, 1, options.maxPageSize ?? 100);
+	pageSize ??= resolvePagination.pageSize;
 
-	let { pageNumber = 1, pageIndex, limit, offset } = out;
+	let { pageNumber = 1, pageIndex } = out;
 	// page index over page number
 	pageNumber = Math.max(pageNumber, 1);
 	pageIndex = Math.max(pageIndex ?? pageNumber - 1, 0);
-	limit = Math.max(1, limit ?? pageSize);
-	offset = Math.max(0, offset ?? pageSize * pageIndex);
+
+	let { limit = pageSize, offset = pageSize * pageIndex } = out;
+	limit = Math.max(1, limit);
+	offset = Math.max(0, offset);
+
+	if (options.maxLimit) {
+		limit = Math.min(limit, options.maxLimit);
+	}
+	if (options.maxOffset) {
+		offset = Math.min(offset, options.maxOffset);
+	}
 
 	pageSize = limit;
 	pageIndex = Math.floor(offset / pageSize);
@@ -58,3 +67,5 @@ export function resolvePagination(
 		pageIndex,
 	};
 }
+
+resolvePagination.pageSize = 20;

package/src/data/types.d.ts

@@ -31,3 +31,15 @@ type ListResult<T = any> = {
 	/** Total number of items */
 	total: number;
 };
+
+type PageInfo = {
+	/** Whether there are more items */
+	hasNextPage: boolean;
+	/** Whether there are previous items */
+	hasPreviousPage: boolean;
+
+	// /** Start cursor */
+	// startCursor?: string;
+	// /** End cursor */
+	// endCursor?: string;
+};

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

@@ -1,7 +1,7 @@
 import type { Static, TSchema } from '@sinclair/typebox';
 import Ajv, { type ErrorObject, type Options } from 'ajv';
 import addFormats from 'ajv-formats';
-import localize from 'ajv-i18n/localize/zh';
+// import localize from 'ajv-i18n/localize/zh';
 import addKeywords from 'ajv-keywords';
 import { isNil } from 'es-toolkit';
 import { match, P } from 'ts-pattern';
@@ -45,7 +45,7 @@ function validate({ schema, data, mutate, clone, ajv }: ValidateOptions & { sche
 
 	const valid = validate(data);
 	const errors = validate.errors;
-	localize(errors);
+	// localize(errors);
 
 	return { data, success: valid, message: ajv.errorsText(errors), errors: errors };
 }
@@ -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/resource/Identifiable.ts

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

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,3 @@
+export { type AnyResource } from './schema/AnyResourceSchema';
+export { type Identifiable } from './Identifiable';
+export { getTitleOfResource } from './getTitleOfResource';

package/src/resource/schema/AnyResourceSchema.ts

@@ -0,0 +1,113 @@
+import { z } from 'zod/v4';
+import { SexTypeSchema } from './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,
+});