@powerlines/schema 0.11.81 → 0.11.83

package/dist/reflection.cjs

@@ -0,0 +1,426 @@
+const require_runtime = require('./_virtual/_rolldown/runtime.cjs');
+const require_type_checks = require('./type-checks.cjs');
+const require_codegen = require('./codegen.cjs');
+let defu = require("defu");
+defu = require_runtime.__toESM(defu, 1);
+let _stryke_type_checks = require("@stryke/type-checks");
+let _powerlines_deepkit_vendor_type = require("@powerlines/deepkit/vendor/type");
+
+//#region src/reflection.ts
+/**
+* Maps a Deepkit numeric `brand` to JSON Schema `type` and `format`.
+*
+* @remarks
+* This function takes a `TypeNumberBrand` (which represents specific numeric types in Deepkit, such as `integer`, `float`, `int8`, etc.) and returns a corresponding JSON Schema fragment that includes the appropriate `type`, `format`, and any relevant keywords (like `multipleOf` for integers). If the brand is not recognized, it defaults to a generic JSON Schema for numbers.
+*
+* @param brand - The Deepkit numeric brand to convert.
+* @return A JSON Schema fragment representing the numeric type corresponding to the provided brand.
+*/
+function numberBrandToJsonSchema(brand) {
+	switch (brand) {
+		case _powerlines_deepkit_vendor_type.TypeNumberBrand.integer: return {
+			type: "integer",
+			format: "int32",
+			multipleOf: 1
+		};
+		case _powerlines_deepkit_vendor_type.TypeNumberBrand.int8: return {
+			type: "integer",
+			format: "int8",
+			multipleOf: 1
+		};
+		case _powerlines_deepkit_vendor_type.TypeNumberBrand.uint8: return {
+			type: "integer",
+			format: "uint8",
+			multipleOf: 1
+		};
+		case _powerlines_deepkit_vendor_type.TypeNumberBrand.int16: return {
+			type: "integer",
+			format: "int16",
+			multipleOf: 1
+		};
+		case _powerlines_deepkit_vendor_type.TypeNumberBrand.uint16: return {
+			type: "integer",
+			format: "uint16",
+			multipleOf: 1
+		};
+		case _powerlines_deepkit_vendor_type.TypeNumberBrand.int32: return {
+			type: "integer",
+			format: "int32",
+			multipleOf: 1
+		};
+		case _powerlines_deepkit_vendor_type.TypeNumberBrand.uint32: return {
+			type: "integer",
+			format: "uint32",
+			multipleOf: 1
+		};
+		case _powerlines_deepkit_vendor_type.TypeNumberBrand.float:
+		case _powerlines_deepkit_vendor_type.TypeNumberBrand.float32: return {
+			type: "number",
+			format: "float"
+		};
+		case _powerlines_deepkit_vendor_type.TypeNumberBrand.float64: return {
+			type: "number",
+			format: "double"
+		};
+		case void 0:
+		default: return { type: "number" };
+	}
+}
+function withReflectionTags(reflection, schema) {
+	if (!(0, _stryke_type_checks.isSetObject)(schema) || !(0, _stryke_type_checks.isSetObject)(reflection?.tags)) return schema;
+	const updatedSchema = { ...schema };
+	const tags = reflection.tags;
+	if ((0, _stryke_type_checks.isSetString)(tags.title)) updatedSchema.title = tags.title;
+	if ((0, _stryke_type_checks.isSetArray)(tags.alias)) updatedSchema.alias = tags.alias;
+	if (!(0, _stryke_type_checks.isUndefined)(tags.hidden)) updatedSchema.hidden = tags.hidden;
+	if (!(0, _stryke_type_checks.isUndefined)(tags.ignore)) updatedSchema.ignore = tags.ignore;
+	if (!(0, _stryke_type_checks.isUndefined)(tags.internal)) updatedSchema.internal = tags.internal;
+	if (!(0, _stryke_type_checks.isUndefined)(tags.runtime)) updatedSchema.runtime = tags.runtime;
+	if (!(0, _stryke_type_checks.isUndefined)(tags.readonly)) updatedSchema.readOnly = tags.readonly;
+	return updatedSchema;
+}
+function withNullable(schema) {
+	if (!(0, _stryke_type_checks.isSetObject)(schema)) return { anyOf: [schema, {
+		type: "null",
+		default: null
+	}] };
+	const rawType = schema.type;
+	const types = Array.isArray(rawType) ? [...rawType] : rawType ? [rawType] : [];
+	if (!types.includes("null")) types.push("null");
+	return {
+		...schema,
+		type: types.length === 1 ? types[0] : types
+	};
+}
+/**
+* Converts a Deepkit type reflection into a JSON Schema (draft-07) fragment.
+*/
+function reflectionToJsonSchema(reflection) {
+	return reflectionToJsonSchemaInner(reflection);
+}
+function reflectionToJsonSchemaInner(reflection) {
+	switch (reflection.kind) {
+		case _powerlines_deepkit_vendor_type.ReflectionKind.any:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.unknown:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.void:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.object: return withReflectionTags(reflection, { name: reflection.typeName });
+		case _powerlines_deepkit_vendor_type.ReflectionKind.never: return;
+		case _powerlines_deepkit_vendor_type.ReflectionKind.undefined:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.null: return withReflectionTags(reflection, {
+			type: "null",
+			name: reflection.typeName,
+			default: null
+		});
+		case _powerlines_deepkit_vendor_type.ReflectionKind.string: return withReflectionTags(reflection, {
+			type: "string",
+			name: reflection.typeName
+		});
+		case _powerlines_deepkit_vendor_type.ReflectionKind.boolean: return withReflectionTags(reflection, {
+			type: "boolean",
+			name: reflection.typeName
+		});
+		case _powerlines_deepkit_vendor_type.ReflectionKind.number: return withReflectionTags(reflection, numberBrandToJsonSchema(reflection.brand));
+		case _powerlines_deepkit_vendor_type.ReflectionKind.bigint: return withReflectionTags(reflection, {
+			type: "integer",
+			name: reflection.typeName,
+			format: "int64"
+		});
+		case _powerlines_deepkit_vendor_type.ReflectionKind.regexp: return withReflectionTags(reflection, {
+			type: "string",
+			name: reflection.typeName,
+			format: "regex",
+			contentMediaType: "text/regex"
+		});
+		case _powerlines_deepkit_vendor_type.ReflectionKind.literal: {
+			const { literal } = reflection;
+			if ((0, _stryke_type_checks.isBigInt)(literal)) return withReflectionTags(reflection, {
+				type: "integer",
+				name: reflection.typeName,
+				format: "int64",
+				const: literal
+			});
+			if ((0, _stryke_type_checks.isRegExp)(literal)) return withReflectionTags(reflection, {
+				type: "string",
+				name: reflection.typeName,
+				format: "regex",
+				const: literal.source
+			});
+			return withReflectionTags(reflection, {
+				type: require_codegen.getJsonSchemaType(literal),
+				name: reflection.typeName,
+				const: literal
+			});
+		}
+		case _powerlines_deepkit_vendor_type.ReflectionKind.templateLiteral: return withReflectionTags(reflection, { type: "string" });
+		case _powerlines_deepkit_vendor_type.ReflectionKind.enum: {
+			const values = reflection.values.filter((value) => (0, _stryke_type_checks.isString)(value) || (0, _stryke_type_checks.isInteger)(value) || (0, _stryke_type_checks.isBigInt)(value) || (0, _stryke_type_checks.isNumber)(value) || (0, _stryke_type_checks.isBoolean)(value) || (0, _stryke_type_checks.isNull)(value));
+			if (values.length === 0) return withReflectionTags(reflection, {
+				name: reflection.typeName,
+				description: reflection.description,
+				enum: []
+			});
+			return withReflectionTags(reflection, {
+				type: values.every((value) => (0, _stryke_type_checks.isString)(value)) ? "string" : values.every((value) => (0, _stryke_type_checks.isInteger)(value) || (0, _stryke_type_checks.isBigInt)(value)) ? "integer" : values.every((value) => (0, _stryke_type_checks.isNumber)(value)) ? "number" : values.every((value) => (0, _stryke_type_checks.isBoolean)(value)) ? "boolean" : values.every((value) => (0, _stryke_type_checks.isNull)(value)) ? "null" : values.reduce((ret, value) => {
+					const type = require_codegen.getJsonSchemaType(value);
+					if (require_type_checks.isJsonSchemaPrimitiveType(type) && !ret.includes(type)) ret.push(type);
+					return ret;
+				}, []),
+				name: reflection.typeName,
+				description: reflection.description,
+				enum: values,
+				default: values.length === 1 ? values[0] : void 0
+			});
+		}
+		case _powerlines_deepkit_vendor_type.ReflectionKind.array: {
+			const items = reflectionToJsonSchemaInner(reflection.type);
+			return withReflectionTags(reflection, {
+				type: "array",
+				name: reflection.typeName,
+				items: items ?? {}
+			});
+		}
+		case _powerlines_deepkit_vendor_type.ReflectionKind.tuple: {
+			const items = reflection.types.map((member) => reflectionToJsonSchemaInner(member.type)).filter((item) => item !== void 0);
+			if (items.length <= 1) return withReflectionTags(reflection, {
+				type: "array",
+				name: reflection.typeName,
+				items: items.length === 1 ? items[0] : {}
+			});
+			return withReflectionTags(reflection, {
+				type: "array",
+				name: reflection.typeName,
+				prefixItems: items,
+				minItems: items.length,
+				maxItems: items.length
+			});
+		}
+		case _powerlines_deepkit_vendor_type.ReflectionKind.union: {
+			const branches = reflection.types.map((inner) => reflectionToJsonSchemaInner(inner)).filter((branch) => branch !== void 0);
+			if (!reflection.types.some((inner) => inner.kind === _powerlines_deepkit_vendor_type.ReflectionKind.null || inner.kind === _powerlines_deepkit_vendor_type.ReflectionKind.undefined)) return withReflectionTags(reflection, {
+				name: reflection.typeName,
+				anyOf: branches
+			});
+			const nonNull = branches.filter((branch) => !require_type_checks.isNullOnlyJsonSchema(branch));
+			if (nonNull.length === 0) return withReflectionTags(reflection, {
+				type: "null",
+				default: null
+			});
+			if (nonNull.length === 1) {
+				const first = nonNull[0];
+				if (!(0, _stryke_type_checks.isSetObject)(first)) return withNullable(withReflectionTags(reflection, {
+					name: reflection.typeName,
+					anyOf: [first]
+				}));
+				return withNullable(withReflectionTags(reflection, {
+					name: reflection.typeName,
+					...first
+				}));
+			}
+			const enumValues = nonNull.map((branch) => (0, _stryke_type_checks.isSetObject)(branch) ? branch.const : void 0).filter((value) => value === null || typeof value === "string" || typeof value === "number" || typeof value === "bigint" || typeof value === "boolean");
+			if (enumValues.length === nonNull.length) return withNullable(withReflectionTags(reflection, {
+				name: reflection.typeName,
+				enum: enumValues
+			}));
+			const discriminator = tryReflectionDiscriminator(reflection.types);
+			if (discriminator && (0, _stryke_type_checks.isSetObject)(discriminator)) return withNullable(withReflectionTags(reflection, {
+				name: reflection.typeName,
+				...discriminator
+			}));
+			return withNullable(withReflectionTags(reflection, {
+				name: reflection.typeName,
+				anyOf: nonNull
+			}));
+		}
+		case _powerlines_deepkit_vendor_type.ReflectionKind.intersection: {
+			const members = reflection.types.map((inner) => reflectionToJsonSchemaInner(inner)).filter((item) => item !== void 0);
+			if (members.length === 0) return;
+			if (members.length === 1) {
+				if (!(0, _stryke_type_checks.isSetObject)(members[0])) return members[0];
+				return withReflectionTags(reflection, {
+					name: reflection.typeName,
+					...members[0]
+				});
+			}
+			if (members.every(require_type_checks.isJsonSchemaObject)) return withReflectionTags(reflection, {
+				name: reflection.typeName,
+				...mergeObjectSchemas(members)
+			});
+			return withReflectionTags(reflection, {
+				name: reflection.typeName,
+				allOf: members
+			});
+		}
+		case _powerlines_deepkit_vendor_type.ReflectionKind.promise: return reflectionToJsonSchemaInner(reflection.type);
+		case _powerlines_deepkit_vendor_type.ReflectionKind.objectLiteral: return objectReflectionToJsonSchema(reflection);
+		case _powerlines_deepkit_vendor_type.ReflectionKind.class: switch (reflection.classType?.name) {
+			case "Date": return withReflectionTags(reflection, {
+				type: "string",
+				format: "date-time"
+			});
+			case "RegExp": return withReflectionTags(reflection, {
+				type: "string",
+				format: "regex"
+			});
+			case "URL": return withReflectionTags(reflection, {
+				type: "string",
+				format: "uri"
+			});
+			case "Set": {
+				const itemType = reflection.arguments?.[0];
+				return withReflectionTags(reflection, {
+					type: "array",
+					items: (itemType ? reflectionToJsonSchemaInner(itemType) : void 0) ?? {},
+					uniqueItems: true
+				});
+			}
+			case "Map": {
+				const valueType = reflection.arguments?.[1];
+				return withReflectionTags(reflection, {
+					type: "object",
+					additionalProperties: (valueType ? reflectionToJsonSchemaInner(valueType) : void 0) ?? true
+				});
+			}
+			case "Uint8Array":
+			case "Uint8ClampedArray":
+			case "Uint16Array":
+			case "Uint32Array":
+			case "Int8Array":
+			case "Int16Array":
+			case "Int32Array":
+			case "Float32Array":
+			case "Float64Array":
+			case "BigInt64Array":
+			case "BigUint64Array": return withReflectionTags(reflection, {
+				type: "string",
+				format: "byte",
+				contentEncoding: "base64"
+			});
+			case void 0:
+			default: return withReflectionTags(reflection, {
+				name: reflection.typeName,
+				description: reflection.description,
+				...objectReflectionToJsonSchema(reflection)
+			});
+		}
+		case _powerlines_deepkit_vendor_type.ReflectionKind.symbol:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.property:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.method:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.function:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.parameter:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.typeParameter:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.tupleMember:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.enumMember:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.rest:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.indexSignature:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.propertySignature:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.methodSignature:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.infer:
+		case _powerlines_deepkit_vendor_type.ReflectionKind.callSignature:
+		default: return;
+	}
+}
+function mergeObjectSchemas(schemas) {
+	const merged = {
+		type: "object",
+		properties: {},
+		required: []
+	};
+	for (const schema of schemas) {
+		if (schema.properties) merged.properties = (0, defu.default)(merged.properties, schema.properties);
+		if (schema.required) merged.required = Array.from(new Set([...merged.required ?? [], ...schema.required]));
+		if (schema.additionalProperties !== void 0) merged.additionalProperties = schema.additionalProperties;
+	}
+	if ((merged.required?.length ?? 0) === 0) delete merged.required;
+	return merged;
+}
+function tryReflectionDiscriminator(types) {
+	const nonNullTypes = types.filter((t) => t.kind !== _powerlines_deepkit_vendor_type.ReflectionKind.null && t.kind !== _powerlines_deepkit_vendor_type.ReflectionKind.undefined);
+	const objectBranches = nonNullTypes.filter((t) => t.kind === _powerlines_deepkit_vendor_type.ReflectionKind.objectLiteral || t.kind === _powerlines_deepkit_vendor_type.ReflectionKind.class);
+	if (objectBranches.length < 2 || objectBranches.length !== nonNullTypes.length) return;
+	let tagKey;
+	const branches = [];
+	for (const branch of objectBranches) {
+		const literalProps = [];
+		for (const member of branch.types) if ((member.kind === _powerlines_deepkit_vendor_type.ReflectionKind.property || member.kind === _powerlines_deepkit_vendor_type.ReflectionKind.propertySignature) && typeof member.name === "string" && member.type.kind === _powerlines_deepkit_vendor_type.ReflectionKind.literal && typeof member.type.literal === "string") literalProps.push({
+			name: member.name,
+			literal: member.type.literal
+		});
+		if (literalProps.length === 0) return;
+		const first = literalProps[0];
+		if (!tagKey) tagKey = first.name;
+		else if (tagKey !== first.name) return;
+		const body = objectReflectionToJsonSchema({
+			...branch,
+			types: branch.types.filter((member) => !((member.kind === _powerlines_deepkit_vendor_type.ReflectionKind.property || member.kind === _powerlines_deepkit_vendor_type.ReflectionKind.propertySignature) && member.name === tagKey))
+		});
+		if (!body || !require_type_checks.isJsonSchemaObject(body)) return;
+		branches.push({
+			type: "object",
+			properties: {
+				[tagKey]: { const: first.literal },
+				...body.properties ?? {}
+			},
+			required: [tagKey, ...body.required ?? []],
+			additionalProperties: body.additionalProperties ?? false
+		});
+	}
+	if (!tagKey) return;
+	return {
+		oneOf: branches,
+		discriminator: { propertyName: tagKey }
+	};
+}
+function objectReflectionToJsonSchema(type) {
+	const reflection = _powerlines_deepkit_vendor_type.ReflectionClass.from(type);
+	const schema = {
+		type: "object",
+		name: reflection.getName(),
+		description: reflection.getDescription(),
+		properties: {},
+		required: [],
+		readOnly: reflection.isReadonly(),
+		ignore: reflection.isIgnored(),
+		internal: reflection.isInternal(),
+		runtime: reflection.isRuntime(),
+		hidden: reflection.isHidden(),
+		primaryKey: reflection.getPrimaries().map((primary) => primary.getNameAsString()),
+		...(0, _stryke_type_checks.isSetString)(reflection.databaseSchemaName) ? { databaseSchemaName: reflection.databaseSchemaName } : {},
+		...(0, _stryke_type_checks.isSetString)(reflection.getName()) ? { name: reflection.getName() } : {},
+		...(0, _stryke_type_checks.isSetString)(reflection.getDescription()) ? { description: reflection.getDescription() } : {},
+		...(0, _stryke_type_checks.isSetArray)(reflection.getAlias()) ? { alias: reflection.getAlias() } : {},
+		...(0, _stryke_type_checks.isSetString)(reflection.getTitle()) ? { title: reflection.getTitle() } : {}
+	};
+	for (const propertyReflection of reflection.getProperties()) {
+		if (propertyReflection.getKind() === _powerlines_deepkit_vendor_type.ReflectionKind.indexSignature) {
+			schema.additionalProperties = reflectionToJsonSchemaInner(propertyReflection.type) ?? true;
+			continue;
+		}
+		let property = reflectionToJsonSchemaInner(propertyReflection.type);
+		if (!property) continue;
+		property = {
+			...(0, _stryke_type_checks.isSetObject)(property) ? property : {},
+			name: propertyReflection.getNameAsString(),
+			description: propertyReflection.getDescription(),
+			readOnly: propertyReflection.isReadonly(),
+			ignore: propertyReflection.isIgnored(),
+			internal: propertyReflection.isInternal(),
+			runtime: propertyReflection.isRuntime(),
+			hidden: propertyReflection.isHidden(),
+			...propertyReflection.hasDefault() ? { default: propertyReflection.getDefaultValue() } : {},
+			...(0, _stryke_type_checks.isSetArray)(propertyReflection.getGroups()) ? { tags: propertyReflection.getGroups() } : {},
+			...(0, _stryke_type_checks.isSetArray)(propertyReflection.getAlias()) ? { alias: propertyReflection.getAlias() } : {},
+			...(0, _stryke_type_checks.isSetString)(propertyReflection.getTitle()) ? { title: propertyReflection.getTitle() } : {}
+		};
+		if (propertyReflection.isNullable()) property = withNullable(property);
+		schema.properties ??= {};
+		schema.properties[propertyReflection.name] = property;
+		if (!propertyReflection.isOptional()) {
+			schema.required ??= [];
+			schema.required.push(propertyReflection.name);
+		}
+	}
+	return schema;
+}
+
+//#endregion
+exports.reflectionToJsonSchema = reflectionToJsonSchema;

package/dist/reflection.d.cts

@@ -0,0 +1,11 @@
+import { JsonSchema } from "./types.cjs";
+import { Type } from "@powerlines/deepkit/vendor/type";
+
+//#region src/reflection.d.ts
+/**
+ * Converts a Deepkit type reflection into a JSON Schema (draft-07) fragment.
+ */
+declare function reflectionToJsonSchema(reflection: Type): JsonSchema | undefined;
+//#endregion
+export { reflectionToJsonSchema };
+//# sourceMappingURL=reflection.d.cts.map

package/dist/reflection.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reflection.d.cts","names":[],"sources":["../src/reflection.ts"],"mappings":";;;;;;AAgKA;iBAAgB,sBAAA,CACd,UAAA,EAAY,IAAA,GACX,UAAU"}

package/dist/reflection.d.mts

@@ -0,0 +1,11 @@
+import { JsonSchema } from "./types.mjs";
+import { Type } from "@powerlines/deepkit/vendor/type";
+
+//#region src/reflection.d.ts
+/**
+ * Converts a Deepkit type reflection into a JSON Schema (draft-07) fragment.
+ */
+declare function reflectionToJsonSchema(reflection: Type): JsonSchema | undefined;
+//#endregion
+export { reflectionToJsonSchema };
+//# sourceMappingURL=reflection.d.mts.map

package/dist/reflection.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reflection.d.mts","names":[],"sources":["../src/reflection.ts"],"mappings":";;;;;;AAgKA;iBAAgB,sBAAA,CACd,UAAA,EAAY,IAAA,GACX,UAAU"}