@atscript/db 0.1.38

package/dist/validation-utils-DEoCMmEb.cjs

@@ -0,0 +1,304 @@
+"use strict";
+const require_chunk = require('./chunk-CrpGerW8.cjs');
+const __atscript_core = require_chunk.__toESM(require("@atscript/core"));
+
+//#region packages/db/src/shared/annotation-utils.ts
+function getDbTableOwner(token) {
+	const field = token.parentNode;
+	const struct = field.ownerNode;
+	if (!struct || !(0, __atscript_core.isStructure)(struct)) return undefined;
+	const iface = struct.ownerNode;
+	return iface && (0, __atscript_core.isInterface)(iface) ? iface : struct;
+}
+function getParentStruct(token) {
+	const field = token.parentNode;
+	const struct = field.ownerNode;
+	return struct && (0, __atscript_core.isStructure)(struct) ? struct : undefined;
+}
+function getParentTypeName(token) {
+	const struct = getParentStruct(token);
+	if (!struct) return undefined;
+	const iface = struct.ownerNode;
+	return iface && (0, __atscript_core.isInterface)(iface) ? iface.id : struct.id;
+}
+function validateFieldBaseType(token, doc, annotationName, expectedType) {
+	const errors = [];
+	const field = token.parentNode;
+	const definition = field.getDefinition();
+	if (!definition || !(0, __atscript_core.isRef)(definition)) return errors;
+	const unwound = doc.unwindType(definition.id, definition.chain);
+	if (!unwound || !(0, __atscript_core.isPrimitive)(unwound.def)) return errors;
+	const ct = unwound.def.config.type;
+	const baseType = typeof ct === "object" ? ct.kind === "final" ? ct.value : ct.kind : ct;
+	const allowed = Array.isArray(expectedType) ? expectedType : [expectedType];
+	if (!allowed.includes(baseType)) errors.push({
+		message: `${annotationName} is not compatible with type "${baseType}" — requires ${allowed.join(" or ")}`,
+		severity: 1,
+		range: token.range
+	});
+	return errors;
+}
+function getNavTargetTypeName(field) {
+	let def = field.getDefinition();
+	if ((0, __atscript_core.isArray)(def)) def = def?.getDefinition();
+	if ((0, __atscript_core.isRef)(def)) return def.id;
+	return undefined;
+}
+function getAnnotationAlias(prop, annotationName) {
+	const annotations = prop.annotations?.filter((a) => a.name === annotationName);
+	if (!annotations || annotations.length === 0) return undefined;
+	return annotations[0].args.length > 0 ? annotations[0].args[0].text : undefined;
+}
+function refActionAnnotation(name) {
+	return new __atscript_core.AnnotationSpec({
+		description: `Referential action when the target ${name === "onDelete" ? "row is deleted" : "key is updated"}. Only valid on @db.rel.FK fields.\n\n` + "**Example:**\n" + "```atscript\n" + "@db.rel.FK\n" + `@db.rel.${name} "cascade"\n` + "authorId: User.id\n" + "```\n",
+		nodeType: ["prop"],
+		argument: {
+			name: "action",
+			type: "string",
+			values: [
+				"cascade",
+				"restrict",
+				"noAction",
+				"setNull",
+				"setDefault"
+			],
+			description: "Referential action: \"cascade\", \"restrict\", \"noAction\", \"setNull\", or \"setDefault\"."
+		},
+		validate(token, args, doc) {
+			const errors = [];
+			const field = token.parentNode;
+			if (field.countAnnotations("db.rel.FK") === 0) errors.push({
+				message: `@db.rel.${name} is only valid on @db.rel.FK fields`,
+				severity: 1,
+				range: token.range
+			});
+			if (args[0]) {
+				const action = args[0].text;
+				if (action === "setNull" && !field.has("optional")) errors.push({
+					message: `@db.rel.${name} "setNull" requires the FK field to be optional (?)`,
+					severity: 1,
+					range: token.range
+				});
+				if (action === "setDefault" && field.countAnnotations("db.default") === 0 && field.countAnnotations("db.default.increment") === 0 && field.countAnnotations("db.default.uuid") === 0 && field.countAnnotations("db.default.now") === 0) errors.push({
+					message: `@db.rel.${name} "setDefault" but no @db.default.* annotation — field will have no fallback value`,
+					severity: 2,
+					range: token.range
+				});
+			}
+			const fkAlias = getAnnotationAlias(field, "db.rel.FK");
+			if (fkAlias) {
+				const struct = getParentStruct(token);
+				if (struct) {
+					const annotationName = `db.rel.${name}`;
+					let count = 0;
+					for (const [, prop] of struct.props) {
+						if (prop.countAnnotations("db.rel.FK") === 0) continue;
+						if (prop.countAnnotations(annotationName) === 0) continue;
+						const propFkAlias = getAnnotationAlias(prop, "db.rel.FK");
+						if (propFkAlias === fkAlias) count++;
+					}
+					if (count > 1) errors.push({
+						message: `Composite FK '${fkAlias}' has @db.rel.${name} on multiple fields — declare it on exactly one`,
+						severity: 1,
+						range: token.range
+					});
+				}
+			}
+			return errors;
+		}
+	});
+}
+
+//#endregion
+//#region packages/db/src/shared/validation-utils.ts
+function validateRefArgument(token, doc, options) {
+	const messages = [];
+	const text = token.text;
+	const [typeName, ...chain] = text.split(".");
+	const decl = doc.getDeclarationOwnerNode(typeName);
+	if (!decl) {
+		const regDef = doc.registry.definitions.get(typeName);
+		if (regDef?.imported) return messages;
+		messages.push({
+			severity: 1,
+			message: `Unknown type '${typeName}'.`,
+			range: token.range
+		});
+		return messages;
+	}
+	if (chain.length > 0) {
+		const unwound = doc.unwindType(typeName, chain);
+		if (!unwound) {
+			messages.push({
+				severity: 1,
+				message: `Field '${chain.join(".")}' does not exist on type '${typeName}'.`,
+				range: token.range
+			});
+			return messages;
+		}
+	}
+	if (options?.requireDbTable && decl.node) {
+		const hasDbTable = decl.node.countAnnotations("db.table") > 0;
+		if (!hasDbTable) messages.push({
+			severity: 1,
+			message: `Type '${typeName}' must have @db.table annotation.`,
+			range: token.range
+		});
+	}
+	return messages;
+}
+function findFKFieldsPointingTo(doc, iface, targetTypeName, alias) {
+	const results = [];
+	let struct;
+	if ((0, __atscript_core.isInterface)(iface) && iface.hasExtends) {
+		const resolved = doc.resolveInterfaceExtends(iface);
+		if (resolved && (0, __atscript_core.isStructure)(resolved)) struct = resolved;
+	}
+	if (!struct) struct = (0, __atscript_core.isStructure)(iface) ? iface : (0, __atscript_core.isInterface)(iface) && (0, __atscript_core.isStructure)(iface.getDefinition()) ? iface.getDefinition() : undefined;
+	if (!struct) return results;
+	for (const [name, prop] of struct.props) {
+		if (prop.countAnnotations("db.rel.FK") === 0) continue;
+		const def = prop.getDefinition();
+		if (!def || !(0, __atscript_core.isRef)(def)) continue;
+		const ref = def;
+		if (!ref.hasChain) continue;
+		const refTypeName = ref.id;
+		const refField = ref.chain.map((c) => c.text).join(".");
+		if (refTypeName !== targetTypeName) continue;
+		if (alias !== undefined) {
+			const fkAnnotations = prop.annotations?.filter((a) => a.name === "db.rel.FK");
+			const hasMatchingAlias = fkAnnotations?.some((a) => a.args.length > 0 && a.args[0].text === alias);
+			if (!hasMatchingAlias) continue;
+		}
+		results.push({
+			name,
+			prop,
+			chainRef: {
+				type: refTypeName,
+				field: refField
+			}
+		});
+	}
+	return results;
+}
+const viewAnnotationNames = [
+	"db.view",
+	"db.view.for",
+	"db.view.joins",
+	"db.view.filter",
+	"db.view.materialized"
+];
+function hasAnyViewAnnotation(node) {
+	return viewAnnotationNames.some((name) => node.countAnnotations(name) > 0);
+}
+function validateQueryScope(queryToken, allowedTypes, unqualifiedTarget, doc) {
+	const errors = [];
+	const queryNode = queryToken.queryNode;
+	if (!queryNode) return errors;
+	function walkFieldRef(ref) {
+		if (ref.typeRef) {
+			const typeName = ref.typeRef.text;
+			if (!allowedTypes.includes(typeName)) errors.push({
+				message: `Query references '${typeName}' which is not in scope — expected ${allowedTypes.map((t) => `'${t}'`).join(" or ")}`,
+				severity: 1,
+				range: ref.typeRef.range
+			});
+		} else if (unqualifiedTarget === null) errors.push({
+			message: `Unqualified field reference '${ref.fieldRef.text}' — use qualified form (e.g., Type.${ref.fieldRef.text})`,
+			severity: 1,
+			range: ref.fieldRef.range
+		});
+else {
+			const unwound = doc.unwindType(unqualifiedTarget);
+			if (unwound) {
+				const targetDef = unwound.def;
+				if ((0, __atscript_core.isInterface)(targetDef) || (0, __atscript_core.isStructure)(targetDef)) {
+					const struct = (0, __atscript_core.isInterface)(targetDef) ? targetDef.getDefinition() : targetDef;
+					if (struct && (0, __atscript_core.isStructure)(struct) && !struct.props.has(ref.fieldRef.text)) errors.push({
+						message: `Field '${ref.fieldRef.text}' does not exist on '${unqualifiedTarget}'`,
+						severity: 1,
+						range: ref.fieldRef.range
+					});
+				}
+			}
+		}
+	}
+	function walkExpr(expr) {
+		if ((0, __atscript_core.isQueryLogical)(expr)) for (const operand of expr.operands) walkExpr(operand);
+else if ((0, __atscript_core.isQueryComparison)(expr)) {
+			walkFieldRef(expr.left);
+			if (expr.right && "fieldRef" in expr.right) walkFieldRef(expr.right);
+		}
+	}
+	walkExpr(queryNode.expression);
+	return errors;
+}
+
+//#endregion
+Object.defineProperty(exports, 'findFKFieldsPointingTo', {
+  enumerable: true,
+  get: function () {
+    return findFKFieldsPointingTo;
+  }
+});
+Object.defineProperty(exports, 'getAnnotationAlias', {
+  enumerable: true,
+  get: function () {
+    return getAnnotationAlias;
+  }
+});
+Object.defineProperty(exports, 'getDbTableOwner', {
+  enumerable: true,
+  get: function () {
+    return getDbTableOwner;
+  }
+});
+Object.defineProperty(exports, 'getNavTargetTypeName', {
+  enumerable: true,
+  get: function () {
+    return getNavTargetTypeName;
+  }
+});
+Object.defineProperty(exports, 'getParentStruct', {
+  enumerable: true,
+  get: function () {
+    return getParentStruct;
+  }
+});
+Object.defineProperty(exports, 'getParentTypeName', {
+  enumerable: true,
+  get: function () {
+    return getParentTypeName;
+  }
+});
+Object.defineProperty(exports, 'hasAnyViewAnnotation', {
+  enumerable: true,
+  get: function () {
+    return hasAnyViewAnnotation;
+  }
+});
+Object.defineProperty(exports, 'refActionAnnotation', {
+  enumerable: true,
+  get: function () {
+    return refActionAnnotation;
+  }
+});
+Object.defineProperty(exports, 'validateFieldBaseType', {
+  enumerable: true,
+  get: function () {
+    return validateFieldBaseType;
+  }
+});
+Object.defineProperty(exports, 'validateQueryScope', {
+  enumerable: true,
+  get: function () {
+    return validateQueryScope;
+  }
+});
+Object.defineProperty(exports, 'validateRefArgument', {
+  enumerable: true,
+  get: function () {
+    return validateRefArgument;
+  }
+});

package/dist/validation-utils-DhR_mtKa.mjs

@@ -0,0 +1,237 @@
+import { AnnotationSpec, isArray, isInterface, isPrimitive, isQueryComparison, isQueryLogical, isRef, isStructure } from "@atscript/core";
+
+//#region packages/db/src/shared/annotation-utils.ts
+function getDbTableOwner(token) {
+	const field = token.parentNode;
+	const struct = field.ownerNode;
+	if (!struct || !isStructure(struct)) return undefined;
+	const iface = struct.ownerNode;
+	return iface && isInterface(iface) ? iface : struct;
+}
+function getParentStruct(token) {
+	const field = token.parentNode;
+	const struct = field.ownerNode;
+	return struct && isStructure(struct) ? struct : undefined;
+}
+function getParentTypeName(token) {
+	const struct = getParentStruct(token);
+	if (!struct) return undefined;
+	const iface = struct.ownerNode;
+	return iface && isInterface(iface) ? iface.id : struct.id;
+}
+function validateFieldBaseType(token, doc, annotationName, expectedType) {
+	const errors = [];
+	const field = token.parentNode;
+	const definition = field.getDefinition();
+	if (!definition || !isRef(definition)) return errors;
+	const unwound = doc.unwindType(definition.id, definition.chain);
+	if (!unwound || !isPrimitive(unwound.def)) return errors;
+	const ct = unwound.def.config.type;
+	const baseType = typeof ct === "object" ? ct.kind === "final" ? ct.value : ct.kind : ct;
+	const allowed = Array.isArray(expectedType) ? expectedType : [expectedType];
+	if (!allowed.includes(baseType)) errors.push({
+		message: `${annotationName} is not compatible with type "${baseType}" — requires ${allowed.join(" or ")}`,
+		severity: 1,
+		range: token.range
+	});
+	return errors;
+}
+function getNavTargetTypeName(field) {
+	let def = field.getDefinition();
+	if (isArray(def)) def = def?.getDefinition();
+	if (isRef(def)) return def.id;
+	return undefined;
+}
+function getAnnotationAlias(prop, annotationName) {
+	const annotations = prop.annotations?.filter((a) => a.name === annotationName);
+	if (!annotations || annotations.length === 0) return undefined;
+	return annotations[0].args.length > 0 ? annotations[0].args[0].text : undefined;
+}
+function refActionAnnotation(name) {
+	return new AnnotationSpec({
+		description: `Referential action when the target ${name === "onDelete" ? "row is deleted" : "key is updated"}. Only valid on @db.rel.FK fields.\n\n` + "**Example:**\n" + "```atscript\n" + "@db.rel.FK\n" + `@db.rel.${name} "cascade"\n` + "authorId: User.id\n" + "```\n",
+		nodeType: ["prop"],
+		argument: {
+			name: "action",
+			type: "string",
+			values: [
+				"cascade",
+				"restrict",
+				"noAction",
+				"setNull",
+				"setDefault"
+			],
+			description: "Referential action: \"cascade\", \"restrict\", \"noAction\", \"setNull\", or \"setDefault\"."
+		},
+		validate(token, args, doc) {
+			const errors = [];
+			const field = token.parentNode;
+			if (field.countAnnotations("db.rel.FK") === 0) errors.push({
+				message: `@db.rel.${name} is only valid on @db.rel.FK fields`,
+				severity: 1,
+				range: token.range
+			});
+			if (args[0]) {
+				const action = args[0].text;
+				if (action === "setNull" && !field.has("optional")) errors.push({
+					message: `@db.rel.${name} "setNull" requires the FK field to be optional (?)`,
+					severity: 1,
+					range: token.range
+				});
+				if (action === "setDefault" && field.countAnnotations("db.default") === 0 && field.countAnnotations("db.default.increment") === 0 && field.countAnnotations("db.default.uuid") === 0 && field.countAnnotations("db.default.now") === 0) errors.push({
+					message: `@db.rel.${name} "setDefault" but no @db.default.* annotation — field will have no fallback value`,
+					severity: 2,
+					range: token.range
+				});
+			}
+			const fkAlias = getAnnotationAlias(field, "db.rel.FK");
+			if (fkAlias) {
+				const struct = getParentStruct(token);
+				if (struct) {
+					const annotationName = `db.rel.${name}`;
+					let count = 0;
+					for (const [, prop] of struct.props) {
+						if (prop.countAnnotations("db.rel.FK") === 0) continue;
+						if (prop.countAnnotations(annotationName) === 0) continue;
+						const propFkAlias = getAnnotationAlias(prop, "db.rel.FK");
+						if (propFkAlias === fkAlias) count++;
+					}
+					if (count > 1) errors.push({
+						message: `Composite FK '${fkAlias}' has @db.rel.${name} on multiple fields — declare it on exactly one`,
+						severity: 1,
+						range: token.range
+					});
+				}
+			}
+			return errors;
+		}
+	});
+}
+
+//#endregion
+//#region packages/db/src/shared/validation-utils.ts
+function validateRefArgument(token, doc, options) {
+	const messages = [];
+	const text = token.text;
+	const [typeName, ...chain] = text.split(".");
+	const decl = doc.getDeclarationOwnerNode(typeName);
+	if (!decl) {
+		const regDef = doc.registry.definitions.get(typeName);
+		if (regDef?.imported) return messages;
+		messages.push({
+			severity: 1,
+			message: `Unknown type '${typeName}'.`,
+			range: token.range
+		});
+		return messages;
+	}
+	if (chain.length > 0) {
+		const unwound = doc.unwindType(typeName, chain);
+		if (!unwound) {
+			messages.push({
+				severity: 1,
+				message: `Field '${chain.join(".")}' does not exist on type '${typeName}'.`,
+				range: token.range
+			});
+			return messages;
+		}
+	}
+	if (options?.requireDbTable && decl.node) {
+		const hasDbTable = decl.node.countAnnotations("db.table") > 0;
+		if (!hasDbTable) messages.push({
+			severity: 1,
+			message: `Type '${typeName}' must have @db.table annotation.`,
+			range: token.range
+		});
+	}
+	return messages;
+}
+function findFKFieldsPointingTo(doc, iface, targetTypeName, alias) {
+	const results = [];
+	let struct;
+	if (isInterface(iface) && iface.hasExtends) {
+		const resolved = doc.resolveInterfaceExtends(iface);
+		if (resolved && isStructure(resolved)) struct = resolved;
+	}
+	if (!struct) struct = isStructure(iface) ? iface : isInterface(iface) && isStructure(iface.getDefinition()) ? iface.getDefinition() : undefined;
+	if (!struct) return results;
+	for (const [name, prop] of struct.props) {
+		if (prop.countAnnotations("db.rel.FK") === 0) continue;
+		const def = prop.getDefinition();
+		if (!def || !isRef(def)) continue;
+		const ref = def;
+		if (!ref.hasChain) continue;
+		const refTypeName = ref.id;
+		const refField = ref.chain.map((c) => c.text).join(".");
+		if (refTypeName !== targetTypeName) continue;
+		if (alias !== undefined) {
+			const fkAnnotations = prop.annotations?.filter((a) => a.name === "db.rel.FK");
+			const hasMatchingAlias = fkAnnotations?.some((a) => a.args.length > 0 && a.args[0].text === alias);
+			if (!hasMatchingAlias) continue;
+		}
+		results.push({
+			name,
+			prop,
+			chainRef: {
+				type: refTypeName,
+				field: refField
+			}
+		});
+	}
+	return results;
+}
+const viewAnnotationNames = [
+	"db.view",
+	"db.view.for",
+	"db.view.joins",
+	"db.view.filter",
+	"db.view.materialized"
+];
+function hasAnyViewAnnotation(node) {
+	return viewAnnotationNames.some((name) => node.countAnnotations(name) > 0);
+}
+function validateQueryScope(queryToken, allowedTypes, unqualifiedTarget, doc) {
+	const errors = [];
+	const queryNode = queryToken.queryNode;
+	if (!queryNode) return errors;
+	function walkFieldRef(ref) {
+		if (ref.typeRef) {
+			const typeName = ref.typeRef.text;
+			if (!allowedTypes.includes(typeName)) errors.push({
+				message: `Query references '${typeName}' which is not in scope — expected ${allowedTypes.map((t) => `'${t}'`).join(" or ")}`,
+				severity: 1,
+				range: ref.typeRef.range
+			});
+		} else if (unqualifiedTarget === null) errors.push({
+			message: `Unqualified field reference '${ref.fieldRef.text}' — use qualified form (e.g., Type.${ref.fieldRef.text})`,
+			severity: 1,
+			range: ref.fieldRef.range
+		});
+else {
+			const unwound = doc.unwindType(unqualifiedTarget);
+			if (unwound) {
+				const targetDef = unwound.def;
+				if (isInterface(targetDef) || isStructure(targetDef)) {
+					const struct = isInterface(targetDef) ? targetDef.getDefinition() : targetDef;
+					if (struct && isStructure(struct) && !struct.props.has(ref.fieldRef.text)) errors.push({
+						message: `Field '${ref.fieldRef.text}' does not exist on '${unqualifiedTarget}'`,
+						severity: 1,
+						range: ref.fieldRef.range
+					});
+				}
+			}
+		}
+	}
+	function walkExpr(expr) {
+		if (isQueryLogical(expr)) for (const operand of expr.operands) walkExpr(operand);
+else if (isQueryComparison(expr)) {
+			walkFieldRef(expr.left);
+			if (expr.right && "fieldRef" in expr.right) walkFieldRef(expr.right);
+		}
+	}
+	walkExpr(queryNode.expression);
+	return errors;
+}
+
+//#endregion
+export { findFKFieldsPointingTo, getAnnotationAlias, getDbTableOwner, getNavTargetTypeName, getParentStruct, getParentTypeName, hasAnyViewAnnotation, refActionAnnotation, validateFieldBaseType, validateQueryScope, validateRefArgument };

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@atscript/db",
+  "version": "0.1.38",
+  "description": "Database adapter utilities for atscript.",
+  "keywords": [
+    "atscript",
+    "database",
+    "utils"
+  ],
+  "homepage": "https://github.com/moostjs/atscript/tree/main/packages/db#readme",
+  "bugs": {
+    "url": "https://github.com/moostjs/atscript/issues"
+  },
+  "license": "MIT",
+  "author": "Artem Maltsev",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/moostjs/atscript.git",
+    "directory": "packages/db"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./sync": {
+      "types": "./dist/sync.d.ts",
+      "import": "./dist/sync.mjs",
+      "require": "./dist/sync.cjs"
+    },
+    "./plugin": {
+      "types": "./dist/plugin.d.ts",
+      "import": "./dist/plugin.mjs"
+    },
+    "./rel": {
+      "types": "./dist/rel.d.ts",
+      "import": "./dist/rel.mjs"
+    },
+    "./agg": {
+      "types": "./dist/agg.d.ts",
+      "import": "./dist/agg.mjs"
+    },
+    "./shared": {
+      "types": "./dist/shared.d.ts",
+      "import": "./dist/shared.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "build": [
+    {
+      "entries": [
+        "src/index.ts",
+        "src/sync.ts",
+        "src/plugin.ts",
+        "src/rel.ts",
+        "src/agg.ts",
+        "src/shared.ts"
+      ]
+    }
+  ],
+  "devDependencies": {
+    "vitest": "3.2.4"
+  },
+  "peerDependencies": {
+    "@uniqu/core": "^0.1.2",
+    "@atscript/core": "^0.1.38",
+    "@atscript/typescript": "^0.1.38"
+  },
+  "scripts": {
+    "before-build": "node ../typescript/cli.cjs -f js",
+    "pub": "pnpm publish --access public",
+    "test": "vitest"
+  }
+}