@atscript/typescript 0.1.2 → 0.1.4

package/dist/index.d.ts

@@ -2,9 +2,15 @@ import { TAtscriptPlugin } from '@atscript/core';
 
 interface TTsPluginOptions {
     /**
-     * Render JSON schemas at build-time
+     * JSON Schema support mode:
+     * - `false` — No support. `toJsonSchema()` throws at runtime. No `buildJsonSchema` import. *(default)*
+     * - `'lazy'` — Import `buildJsonSchema`, compute on demand, cache in type object.
+     * - `'bundle'` — Pre-compute at build time, embed static JSON in output. No import.
+     *
+     * Individual interfaces can override this with `@emit.jsonSchema` annotation
+     * to force build-time embedding regardless of this setting.
      */
-    preRenderJsonSchema?: boolean;
+    jsonSchema?: false | 'lazy' | 'bundle';
 }
 declare const tsPlugin: (opts?: TTsPluginOptions) => TAtscriptPlugin;
 

package/dist/index.mjs

@@ -207,7 +207,7 @@ var TypeRenderer = class TypeRenderer extends BaseRenderer {
 		this.writeln(" * Do not edit this file!");
 		this.writeln(" */");
 		this.writeln();
-		this.writeln("import type { TAtscriptTypeObject, TAtscriptTypeComplex, TAtscriptTypeFinal, TAtscriptTypeArray, TMetadataMap, Validator, TAtscriptAnnotatedTypeConstructor, TValidatorOptions } from \"@atscript/typescript/utils\"");
+		this.writeln("import type { TAtscriptTypeObject, TAtscriptTypeComplex, TAtscriptTypeFinal, TAtscriptTypeArray, TAtscriptAnnotatedType, TMetadataMap, Validator, TValidatorOptions } from \"@atscript/typescript/utils\"");
 	}
 	post() {
 		this.writeln("// prettier-ignore-end");
@@ -271,6 +271,10 @@ var TypeRenderer = class TypeRenderer extends BaseRenderer {
 				patterns.push(prop);
 				continue;
 			}
+			if (this.isPhantomProp(prop.getDefinition())) {
+				this.writeln(`// ${prop.id}: phantom`);
+				continue;
+			}
 			const optional = !!prop.token("optional");
 			this.write(wrapProp(prop.id), optional ? "?" : "", ": ");
 			const renderedDef = this.renderTypeDefString(prop.getDefinition());
@@ -296,9 +300,10 @@ var TypeRenderer = class TypeRenderer extends BaseRenderer {
 		}
 		if (asClass) {
 			this.writeln("static __is_atscript_annotated_type: true");
-			this.writeln(`static type: TAtscriptTypeObject<keyof ${asClass}>`);
+			this.writeln(`static type: TAtscriptTypeObject<keyof ${asClass}, ${asClass}>`);
 			this.writeln(`static metadata: TMetadataMap<AtscriptMetadata>`);
-			this.writeln(`static validator: <TT extends TAtscriptAnnotatedTypeConstructor = typeof ${asClass}>(opts?: Partial<TValidatorOptions>) => Validator<TT>`);
+			this.writeln(`static validator: (opts?: Partial<TValidatorOptions>) => Validator<typeof ${asClass}>`);
+			if (resolveJsonSchemaMode(this.opts) === false) this.writeln("/** @deprecated JSON Schema support is disabled. Calling this method will throw a runtime error. To enable, set `jsonSchema: 'lazy'` or `jsonSchema: 'bundle'` in tsPlugin options, or add `@emit.jsonSchema` annotation to individual interfaces. */");
 			this.writeln("static toJsonSchema: () => any");
 		}
 		this.pop();
@@ -313,6 +318,12 @@ var TypeRenderer = class TypeRenderer extends BaseRenderer {
 		if (struct?.entity === "structure") this.renderStructure(struct, node.id);
 else this.writeln("{}");
 		this.writeln();
+		const nsPrefix = exported ? "export declare" : "declare";
+		this.write(`${nsPrefix} namespace ${node.id} `);
+		this.blockln("{}");
+		this.writeln(`type DataType = ${node.id}`);
+		this.popln();
+		this.writeln();
 	}
 	renderType(node) {
 		this.writeln();
@@ -339,6 +350,11 @@ else this.writeln("{}");
 		} else {
 			this.write(exported ? "export declare " : "declare ");
 			this.writeln(`class ${node.id} extends ${targetName} {}`);
+			const nsPrefix = exported ? "export declare" : "declare";
+			this.write(`${nsPrefix} namespace ${node.id} `);
+			this.blockln("{}");
+			this.writeln(`type DataType = ${node.id}`);
+			this.popln();
 			this.writeln();
 		}
 	}
@@ -353,18 +369,29 @@ else this.writeln("{}");
 			let realDef = inputDef;
 			if (isRef(inputDef)) realDef = this.doc.unwindType(inputDef.id, inputDef.chain)?.def || realDef;
 			realDef = this.doc.mergeIntersection(realDef);
-			if (isStructure(realDef) || isInterface(realDef)) typeDef = `TAtscriptTypeObject<keyof ${name}>`;
-else if (isGroup(realDef)) typeDef = "TAtscriptTypeComplex";
-else if (isArray(realDef)) typeDef = "TAtscriptTypeArray";
-else if (isPrimitive(realDef)) typeDef = "TAtscriptTypeFinal";
+			if (isStructure(realDef) || isInterface(realDef)) typeDef = `TAtscriptTypeObject<keyof ${name}, ${name}>`;
+else if (isGroup(realDef)) typeDef = `TAtscriptTypeComplex<${name}>`;
+else if (isArray(realDef)) typeDef = `TAtscriptTypeArray<${name}>`;
+else if (isPrimitive(realDef)) typeDef = `TAtscriptTypeFinal<${name}>`;
 		}
+		this.writeln(`type DataType = ${name}`);
 		this.writeln(`const __is_atscript_annotated_type: true`);
 		this.writeln(`const type: ${typeDef}`);
 		this.writeln(`const metadata: TMetadataMap<AtscriptMetadata>`);
-		this.writeln(`const validator: (opts?: Partial<TValidatorOptions>) => Validator<TAtscriptAnnotatedTypeConstructor, ${name}>`);
+		this.writeln(`const validator: (opts?: Partial<TValidatorOptions>) => Validator<typeof ${name}, ${name}>`);
+		if (resolveJsonSchemaMode(this.opts) === false) this.writeln("/** @deprecated JSON Schema support is disabled. Calling this method will throw a runtime error. To enable, set `jsonSchema: 'lazy'` or `jsonSchema: 'bundle'` in tsPlugin options, or add `@emit.jsonSchema` annotation to individual interfaces. */");
 		this.writeln("const toJsonSchema: () => any");
 		this.popln();
 	}
+	isPhantomProp(def) {
+		if (!def) return false;
+		if (isPrimitive(def) && def.id === "phantom") return true;
+		if (isRef(def)) {
+			const unwound = this.doc.unwindType(def.id, def.chain)?.def;
+			return isPrimitive(unwound) && unwound.id === "phantom";
+		}
+		return false;
+	}
 	isTypeTarget(name, doc) {
 		const d = doc || this.doc;
 		const decl = d.getDeclarationOwnerNode(name);
@@ -403,6 +430,24 @@ function renderPrimitiveTypeDef(def) {
 	}
 }
 
+//#endregion
+//#region packages/typescript/src/traverse.ts
+function forAnnotatedType(def, handlers) {
+	switch (def.type.kind) {
+		case "": {
+			const typed = def;
+			if (handlers.phantom && typed.type.designType === "phantom") return handlers.phantom(typed);
+			return handlers.final(typed);
+		}
+		case "object": return handlers.object(def);
+		case "array": return handlers.array(def);
+		case "union": return handlers.union(def);
+		case "intersection": return handlers.intersection(def);
+		case "tuple": return handlers.tuple(def);
+		default: throw new Error(`Unknown type kind "${def.type.kind}"`);
+	}
+}
+
 //#endregion
 //#region packages/typescript/src/validator.ts
 function _define_property$1(obj, key, value) {
@@ -448,7 +493,17 @@ var Validator = class {
 	throw() {
 		throw new ValidatorError(this.errors);
 	}
-	validate(value, safe) {
+	/**
+	* Validates a value against the type definition.
+	*
+	* Acts as a TypeScript type guard — when it returns `true`, the value
+	* is narrowed to `DataType`.
+	*
+	* @param value - The value to validate.
+	* @param safe - If `true`, returns `false` on failure instead of throwing.
+	* @returns `true` if the value matches the type definition.
+	* @throws {ValidatorError} When validation fails and `safe` is not `true`.
+	*/ validate(value, safe) {
 		this.push("");
 		this.errors = [];
 		this.stackErrors = [];
@@ -475,15 +530,15 @@ var Validator = class {
 		return this.stackPath.slice(1).join(".");
 	}
 	validateAnnotatedType(def, value) {
-		switch (def.type.kind) {
-			case "object": return this.validateObject(def, value);
-			case "union": return this.validateUnion(def, value);
-			case "intersection": return this.validateIntersection(def, value);
-			case "tuple": return this.validateTuple(def, value);
-			case "array": return this.validateArray(def, value);
-			case "": return this.validatePrimitive(def, value);
-			default: throw new Error(`Unknown type "${def.type.kind}"`);
-		}
+		return forAnnotatedType(def, {
+			final: (d) => this.validatePrimitive(d, value),
+			phantom: () => true,
+			object: (d) => this.validateObject(d, value),
+			array: (d) => this.validateArray(d, value),
+			union: (d) => this.validateUnion(d, value),
+			intersection: (d) => this.validateIntersection(d, value),
+			tuple: (d) => this.validateTuple(d, value)
+		});
 	}
 	validateUnion(def, value) {
 		let i = 0;
@@ -574,7 +629,7 @@ var Validator = class {
 		let partialFunctionMatched = false;
 		if (typeof this.opts.partial === "function") partialFunctionMatched = this.opts.partial(def, this.path);
 		for (const [key, item] of def.type.props.entries()) {
-			if (skipList.has(key)) continue;
+			if (skipList.has(key) || isPhantomType(item)) continue;
 			typeKeys.add(key);
 			if (value[key] === undefined) {
 				if (partialFunctionMatched || this.opts.partial === "deep" || this.opts.partial === true && this.stackPath.length <= 1) continue;
@@ -715,7 +770,7 @@ else {
 	constructor(def, opts) {
 		_define_property$1(this, "def", void 0);
 		_define_property$1(this, "opts", void 0);
-		_define_property$1(this, "errors", void 0);
+		/** Validation errors collected during the last {@link validate} call. */ _define_property$1(this, "errors", void 0);
 		_define_property$1(this, "stackErrors", void 0);
 		_define_property$1(this, "stackPath", void 0);
 		this.def = def;
@@ -856,19 +911,24 @@ else if (!newBase) throw new Error(`"${typeName}" is not annotated type`);
 	};
 	return handle;
 }
+function isPhantomType(def) {
+	return def.type.kind === "" && def.type.designType === "phantom";
+}
 
 //#endregion
 //#region packages/typescript/src/json-schema.ts
 function buildJsonSchema(type) {
 	const build = (def) => {
-		const t = def.type;
 		const meta = def.metadata;
-		switch (t.kind) {
-			case "object": {
-				const obj = t;
+		return forAnnotatedType(def, {
+			phantom() {
+				return {};
+			},
+			object(d) {
 				const properties = {};
 				const required = [];
-				for (const [key, val] of obj.props.entries()) {
+				for (const [key, val] of d.type.props.entries()) {
+					if (isPhantomType(val)) continue;
 					properties[key] = build(val);
 					if (!val.optional) required.push(key);
 				}
@@ -878,41 +938,36 @@ function buildJsonSchema(type) {
 				};
 				if (required.length) schema.required = required;
 				return schema;
-			}
-			case "array": {
-				const arr = t;
+			},
+			array(d) {
 				const schema = {
 					type: "array",
-					items: build(arr.of)
+					items: build(d.type.of)
 				};
 				const minLength = meta.get("expect.minLength");
 				if (typeof minLength === "number") schema.minItems = minLength;
 				const maxLength = meta.get("expect.maxLength");
 				if (typeof maxLength === "number") schema.maxItems = maxLength;
 				return schema;
-			}
-			case "union": {
-				const grp = t;
-				return { anyOf: grp.items.map(build) };
-			}
-			case "intersection": {
-				const grp = t;
-				return { allOf: grp.items.map(build) };
-			}
-			case "tuple": {
-				const grp = t;
+			},
+			union(d) {
+				return { anyOf: d.type.items.map(build) };
+			},
+			intersection(d) {
+				return { allOf: d.type.items.map(build) };
+			},
+			tuple(d) {
 				return {
 					type: "array",
-					items: grp.items.map(build),
+					items: d.type.items.map(build),
 					additionalItems: false
 				};
-			}
-			case "": {
-				const fin = t;
+			},
+			final(d) {
 				const schema = {};
-				if (fin.value !== undefined) schema.const = fin.value;
-				if (fin.designType && fin.designType !== "any") {
-					schema.type = fin.designType === "undefined" ? "null" : fin.designType;
+				if (d.type.value !== undefined) schema.const = d.type.value;
+				if (d.type.designType && d.type.designType !== "any") {
+					schema.type = d.type.designType === "undefined" ? "null" : d.type.designType;
 					if (schema.type === "number" && meta.get("expect.int")) schema.type = "integer";
 				}
 				if (schema.type === "string") {
@@ -932,8 +987,7 @@ else schema.allOf = (schema.allOf || []).concat(patterns.map((p) => ({ pattern:
 				}
 				return schema;
 			}
-			default: return {};
-		}
+		});
 	};
 	return build(type);
 }
@@ -955,7 +1009,7 @@ var JsRenderer = class extends BaseRenderer {
 		this.writeln("// prettier-ignore-start");
 		this.writeln("/* eslint-disable */");
 		const imports = ["defineAnnotatedType as $", "annotate as $a"];
-		if (!this.opts?.preRenderJsonSchema) imports.push("buildJsonSchema as $$");
+		if (resolveJsonSchemaMode(this.opts) === "lazy") imports.push("buildJsonSchema as $$");
 		this.writeln(`import { ${imports.join(", ")} } from "@atscript/typescript/utils"`);
 	}
 	buildAdHocMap(annotateNodes) {
@@ -1043,15 +1097,21 @@ else {
 		this.writeln();
 	}
 	renderJsonSchemaMethod(node) {
-		if (this.opts?.preRenderJsonSchema) {
+		const mode = resolveJsonSchemaMode(this.opts);
+		const hasAnnotation = node.countAnnotations("emit.jsonSchema") > 0;
+		if (hasAnnotation || mode === "bundle") {
 			const schema = JSON.stringify(buildJsonSchema(this.toAnnotatedType(node)));
 			this.writeln("static toJsonSchema() {");
 			this.indent().writeln(`return ${schema}`).unindent();
 			this.writeln("}");
-		} else {
+		} else if (mode === "lazy") {
 			this.writeln("static toJsonSchema() {");
 			this.indent().writeln("return this._jsonSchema ?? (this._jsonSchema = $$(this))").unindent();
 			this.writeln("}");
+		} else {
+			this.writeln("static toJsonSchema() {");
+			this.indent().writeln("throw new Error(\"JSON Schema support is disabled. To enable, set `jsonSchema: 'lazy'` or `jsonSchema: 'bundle'` in tsPlugin options, or add @emit.jsonSchema annotation to individual interfaces.\")").unindent();
+			this.writeln("}");
 		}
 	}
 	toAnnotatedType(node) {
@@ -1085,7 +1145,7 @@ else {
 			case "primitive": {
 				const prim = node;
 				const handle = defineAnnotatedType();
-				handle.designType(prim.id === "never" ? "never" : prim.config.type);
+				handle.designType(prim.id === "never" ? "never" : prim.id === "phantom" ? "phantom" : prim.config.type);
 				if (!skipAnnotations) this.applyExpectAnnotations(handle, this.doc.evalAnnotationsForNode(node));
 				return handle;
 			}
@@ -1212,7 +1272,7 @@ else handle.prop(prop.id, propHandle.$type);
 		return this;
 	}
 	definePrimitive(node, name) {
-		this.renderPrimitiveDef(node.id === "never" ? "never" : node.config.type, name);
+		this.renderPrimitiveDef(node.id === "never" ? "never" : node.id === "phantom" ? "phantom" : node.config.type, name);
 		this.writeln(`  .tags(${Array.from(node.tags).map((f) => `"${escapeQuotes(f)}"`).join(", ")})`);
 		return this;
 	}
@@ -1494,6 +1554,10 @@ else {
 
 //#endregion
 //#region packages/typescript/src/plugin.ts
+function resolveJsonSchemaMode(opts) {
+	if (opts?.jsonSchema !== undefined) return opts.jsonSchema;
+	return false;
+}
 const tsPlugin = (opts) => {
 	return {
 		name: "typesccript",