@softr/sdk 0.0.12 → 0.0.14

package/dist/vite.js

@@ -1,411 +1,8 @@
-import { randomUUID } from "node:crypto";
-import * as nodeFs from "node:fs/promises";
-import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { ManifestError, generateRoutesManifest } from "./routes/manifest.js";
+import { mkdir, writeFile } from "node:fs/promises";
 import path from "node:path";
 import { pathToFileURL } from "node:url";
-import { Generator, getConfig, inferFullPath } from "@tanstack/router-generator";
-import os from "node:os";
-import { parse } from "@babel/parser";
-import babelTraverse from "@babel/traverse";
 
-//#region src/routes/mem-fs.ts
-/**
-* Reads through to disk and swallows every write. Driving the generator without this rewrites the
-* app's route sources and strips Start's `Register` block from its routeTree.gen.ts.
-*/
-function createReadOnlyFs() {
-	const writes = /* @__PURE__ */ new Map();
-	return {
-		async stat(filePath) {
-			const stat = await statOrNull(path.resolve(filePath));
-			if (stat === null) return {
-				mtimeMs: SYNTHETIC_MTIME,
-				mode: 420,
-				uid: 0,
-				gid: 0
-			};
-			return {
-				mtimeMs: stat.mtimeMs,
-				mode: Number(stat.mode),
-				uid: Number(stat.uid),
-				gid: Number(stat.gid)
-			};
-		},
-		async rename(oldPath, newPath) {
-			const from = path.resolve(oldPath);
-			const content = writes.get(from);
-			if (content !== void 0) {
-				writes.delete(from);
-				writes.set(path.resolve(newPath), content);
-			}
-		},
-		async writeFile(filePath, content) {
-			writes.set(path.resolve(filePath), content);
-		},
-		async readFile(filePath) {
-			const resolved = path.resolve(filePath);
-			const pending = writes.get(resolved);
-			const stat = await statOrNull(resolved);
-			if (pending !== void 0) return {
-				stat: { mtimeMs: stat?.mtimeMs ?? SYNTHETIC_MTIME },
-				fileContent: pending
-			};
-			if (stat === null) return "file-not-existing";
-			try {
-				const fileContent = await nodeFs.readFile(resolved, "utf8");
-				return {
-					stat: { mtimeMs: stat.mtimeMs },
-					fileContent
-				};
-			} catch {
-				return "file-not-existing";
-			}
-		},
-		async chmod() {},
-		async chown() {}
-	};
-}
-const SYNTHETIC_MTIME = 1n;
-async function statOrNull(filePath) {
-	try {
-		return await nodeFs.stat(filePath, { bigint: true });
-	} catch {
-		return null;
-	}
-}
-
-//#endregion
-//#region src/routes/discover.ts
-async function crawlRoutes(opts) {
-	const config = getConfig({
-		disableLogging: true,
-		tmpDir: TMP_DIR,
-		generatedRouteTree: generatedRouteTreePath()
-	}, opts.root);
-	const generator = new Generator({
-		config,
-		root: opts.root,
-		fs: createReadOnlyFs()
-	});
-	await generator.run();
-	const crawlingResult = await generator.getCrawlingResult();
-	if (!crawlingResult) throw new Error(`the route crawl produced no result for ${opts.root}`);
-	return {
-		rootRouteNode: crawlingResult.rootRouteNode,
-		routeNodes: crawlingResult.acc.routeNodes,
-		routePiecesByPath: crawlingResult.acc.routePiecesByPath,
-		routeTree: crawlingResult.acc.routeTree,
-		routesDirectory: path.relative(opts.root, path.resolve(opts.root, config.routesDirectory)).split(path.sep).join("/")
-	};
-}
-/** Reads the rule out of the source text. The route file is never executed. */
-function extractVisibility(source, filePath) {
-	let program;
-	try {
-		program = parse(source, {
-			sourceType: "module",
-			plugins: ["typescript", "jsx"]
-		});
-	} catch (error) {
-		const position = error.loc;
-		return fail("unparsable", `could not parse ${filePath}: ${error.message}`, filePath, position?.line ?? 1, position?.column ?? 0);
-	}
-	const calls = findVisibilityCalls(program);
-	if (calls.length > 1) {
-		const second = calls[1].call;
-		return fail("duplicate-declaration", `${filePath} declares visibility more than once; a route has exactly one rule`, filePath, second.loc?.start.line ?? 1, second.loc?.start.column ?? 0);
-	}
-	const declaration = calls[0];
-	if (declaration === void 0) return {
-		ok: true,
-		visibility: null
-	};
-	const { call, statement } = declaration;
-	const argument = call.arguments[0];
-	if (argument === void 0) return fail("not-literal", `${filePath} calls ${VISIBILITY_FUNCTION} with no argument`, filePath, call.loc?.start.line ?? 1, call.loc?.start.column ?? 0);
-	const read = readLiteral(argument);
-	if (!read.ok) return fail("not-literal", `${filePath}: the visibility rule must be a literal — ${read.reason}`, filePath, read.line, read.column);
-	return {
-		ok: true,
-		visibility: {
-			value: read.value,
-			line: statement.loc?.start.line ?? 1,
-			column: statement.loc?.start.column ?? 0
-		}
-	};
-}
-/**
-* The generator `mkdirSync`s `tmpDir` and the directory of `generatedRouteTree` outside the `fs`
-* shim, so defaulted they create directories in the crawled project. Aimed at `os.tmpdir()` both
-* calls are no-ops, and nothing is ever written through either path. The uuid keeps the generated
-* tree file a miss rather than whatever a shared temp directory happens to hold.
-*/
-const TMP_DIR = os.tmpdir();
-const generatedRouteTreePath = () => path.join(TMP_DIR, `softr-sdk-route-tree-${randomUUID()}.gen.ts`);
-const SDK_PACKAGE_NAME = "@softr/sdk";
-const VISIBILITY_FUNCTION = "defineVisibility";
-function fail(code, message, filePath, line, column) {
-	return {
-		ok: false,
-		error: {
-			code,
-			message,
-			filePath,
-			line,
-			column
-		}
-	};
-}
-const traverse = babelTraverse.default ?? babelTraverse;
-/** Only a call initialising a top-level variable counts; one inside a function or block does not. */
-function findVisibilityCalls(ast) {
-	const found = [];
-	traverse(ast, { VariableDeclarator(path$1) {
-		const list = path$1.parentPath;
-		if (!list.isVariableDeclaration()) return;
-		const statement = list.parentPath.isExportNamedDeclaration() ? list.parentPath : list;
-		if (!statement.parentPath?.isProgram()) return;
-		if (path$1.node.init === null || path$1.node.init === void 0) return;
-		const call = unwrap(path$1.node.init);
-		if (call.type !== "CallExpression" && call.type !== "OptionalCallExpression") return;
-		if (call.callee.type !== "Identifier") return;
-		if (!isVisibilityImport(path$1, call.callee.name)) return;
-		found.push({
-			call,
-			statement: statement.node
-		});
-	} });
-	return found;
-}
-function isVisibilityImport(path$1, name) {
-	const binding = path$1.scope.getBinding(name);
-	if (binding === void 0 || binding.kind !== "module") return false;
-	const specifier = binding.path.node;
-	const declaration = binding.path.parent;
-	if (specifier.type !== "ImportSpecifier" || declaration.type !== "ImportDeclaration") return false;
-	if (specifier.importKind === "type" || declaration.importKind === "type") return false;
-	if (declaration.source.value !== SDK_PACKAGE_NAME) return false;
-	return (specifier.imported.type === "Identifier" ? specifier.imported.name : specifier.imported.value) === VISIBILITY_FUNCTION;
-}
-/** Strips the wrappers that leave the runtime value unchanged: `as const`, `satisfies`, `!`, `()`. */
-function unwrap(node) {
-	switch (node.type) {
-		case "TSAsExpression":
-		case "TSSatisfiesExpression":
-		case "TSNonNullExpression":
-		case "TSTypeAssertion":
-		case "TSInstantiationExpression":
-		case "ParenthesizedExpression": return unwrap(node.expression);
-		default: return node;
-	}
-}
-function reject(node, reason) {
-	return {
-		ok: false,
-		reason,
-		line: node.loc?.start.line ?? 1,
-		column: node.loc?.start.column ?? 0
-	};
-}
-function readLiteral(input) {
-	const node = unwrap(input);
-	switch (node.type) {
-		case "StringLiteral": return {
-			ok: true,
-			value: node.value
-		};
-		case "TemplateLiteral":
-			if (node.expressions.length > 0) return reject(node, "a template literal with an expression is not a static value");
-			return {
-				ok: true,
-				value: node.quasis[0]?.value.cooked ?? ""
-			};
-		case "ArrayExpression": {
-			const values = [];
-			for (const element of node.elements) {
-				if (element === null) return reject(node, "an array hole is not a static value");
-				if (element.type === "SpreadElement") return reject(element, "a spread is not a static value");
-				const read = readLiteral(element);
-				if (!read.ok) return read;
-				values.push(read.value);
-			}
-			return {
-				ok: true,
-				value: values
-			};
-		}
-		case "ObjectExpression": {
-			const value = {};
-			for (const property of node.properties) {
-				if (property.type === "SpreadElement") return reject(property, "a spread is not a static value");
-				if (property.type === "ObjectMethod") return reject(property, "a method is not a static value");
-				if (property.computed) return reject(property, "a computed key is not a static value");
-				if (property.shorthand) return reject(property, "a shorthand property is not a static value");
-				const key = property.key.type === "Identifier" ? property.key.name : property.key.type === "StringLiteral" ? property.key.value : null;
-				if (key === null) return reject(property.key, "this key is not a static value");
-				if (key === "__proto__") return reject(property.key, "a __proto__ key is not a static value");
-				const read = readLiteral(property.value);
-				if (!read.ok) return read;
-				value[key] = read.value;
-			}
-			return {
-				ok: true,
-				value
-			};
-		}
-		case "NumericLiteral":
-		case "BooleanLiteral":
-		case "NullLiteral": return reject(node, "a visibility rule is built from strings, arrays and objects");
-		case "Identifier": return reject(node, `an identifier (${node.name}) is not a static value`);
-		case "CallExpression":
-		case "NewExpression": return reject(node, "a call is not a static value");
-		default: return reject(node, `${node.type} is not a static value`);
-	}
-}
-
-//#endregion
-//#region src/routes/manifest.ts
-var ManifestError = class extends Error {
-	detail;
-	constructor(detail) {
-		super(detail.message);
-		this.name = "ManifestError";
-		this.detail = detail;
-	}
-};
-/** Returns the manifest as the exact text to write. Throws on a declaration it cannot read. */
-async function generateRoutesManifest(root) {
-	const crawl = await crawlRoutes({ root });
-	const routeFiles = new Set([crawl.rootRouteNode.filePath]);
-	for (const node of crawl.routeNodes) routeFiles.add(node.filePath);
-	for (const pieces of Object.values(crawl.routePiecesByPath)) if (pieces.lazy) routeFiles.add(pieces.lazy.filePath);
-	const sources = /* @__PURE__ */ new Map();
-	for (const relative of routeFiles) {
-		const absolute = path.resolve(root, crawl.routesDirectory, relative);
-		const source = await readIfPresent(absolute);
-		if (source !== null) sources.set(absolute, source);
-	}
-	const manifest = buildManifest({
-		crawl,
-		root,
-		sources
-	});
-	return `${JSON.stringify(manifest, null, 2)}\n`;
-}
-function buildManifest(opts) {
-	const routesDirectory = opts.crawl.routesDirectory;
-	const toNode = (node) => {
-		const projectRelative = toProjectRelative(opts.root, routesDirectory, node.filePath);
-		const routePath = node.routePath;
-		if (routePath === void 0) throw new Error(`the route crawl produced a node with no route path: ${projectRelative}`);
-		let declared = visibilityOf(opts, node.filePath);
-		const lazyPiece = opts.crawl.routePiecesByPath[routePath]?.lazy;
-		if (lazyPiece && lazyPiece.filePath !== node.filePath) {
-			const lazyDeclared = visibilityOf(opts, lazyPiece.filePath);
-			if (lazyDeclared !== null && declared !== null) throw new ManifestError({
-				code: "duplicate-declaration",
-				message: `${routePath} declares visibility in both ${projectRelative} and ${lazyDeclared.filePath}; a route has exactly one rule`,
-				filePath: lazyDeclared.filePath,
-				line: lazyDeclared.line,
-				column: lazyDeclared.column
-			});
-			if (lazyDeclared !== null) declared = lazyDeclared;
-		}
-		return {
-			routePath,
-			filePath: projectRelative,
-			...node._fsRouteType ? { _fsRouteType: node._fsRouteType } : {},
-			inferFullPath: inferFullPath(node) ?? null,
-			createFileRouteProps: [...node.createFileRouteProps ?? []].sort(),
-			visibility: declared?.value ?? null,
-			children: (node.children ?? []).map(toNode)
-		};
-	};
-	const rootNode = opts.crawl.rootRouteNode;
-	const rootRelative = toProjectRelative(opts.root, routesDirectory, rootNode.filePath);
-	const rootDeclared = visibilityOf(opts, rootNode.filePath);
-	if (rootDeclared !== null) throw new ManifestError({
-		code: "root-declaration",
-		message: "the root route cannot carry a visibility rule: it would gate sign-in with no way back in. Move this declaration to the routes you want gated.",
-		filePath: rootRelative,
-		line: rootDeclared.line,
-		column: rootDeclared.column
-	});
-	return { root: {
-		routePath: ROOT_ROUTE_ID,
-		filePath: rootRelative,
-		inferFullPath: inferFullPath(rootNode) ?? null,
-		createFileRouteProps: [...rootNode.createFileRouteProps ?? []].sort(),
-		visibility: null,
-		children: opts.crawl.routeTree.map(toNode)
-	} };
-}
-/**
-* `rootRouteId` from `@tanstack/router-core`, which is what a consumer matches against — not the
-* generator's `rootPathId`, which is the base name of `__root.tsx` and names a file, not a route.
-*/
-const ROOT_ROUTE_ID = "__root__";
-/** The crawl's paths are relative to the routes directory; the manifest's are project-relative. */
-function toProjectRelative(root, routesDirectory, filePath) {
-	const absolute = path.resolve(root, routesDirectory, filePath);
-	return path.relative(root, absolute).split(path.sep).join("/");
-}
-const USER_GROUPS = [
-	"ALL_USERS",
-	"NON_LOGGED_IN_USERS",
-	"LOGGED_IN_USERS"
-];
-function checkVisibilityShape(declared) {
-	const reject$1 = (message) => {
-		throw new ManifestError({
-			code: "invalid-visibility",
-			message: `${declared.filePath}: ${message}`,
-			filePath: declared.filePath,
-			line: declared.line,
-			column: declared.column
-		});
-	};
-	const visibility = declared.value;
-	if (typeof visibility !== "object" || Array.isArray(visibility)) reject$1(`the visibility rule must be an object literal like { userGroup: 'ALL_USERS' }, not ${JSON.stringify(visibility)}`);
-	for (const key of Object.keys(visibility)) {
-		if (key === "userGroup" || key === "userGroupIds") continue;
-		reject$1(`"${key}" is not part of a visibility rule; a rule has userGroup and, under LOGGED_IN_USERS, userGroupIds. Check the spelling.`);
-	}
-	const userGroup = visibility["userGroup"];
-	if (typeof userGroup !== "string" || !USER_GROUPS.includes(userGroup)) reject$1(`userGroup must be one of ${USER_GROUPS.join(", ")}, not ${JSON.stringify(userGroup)}. A rule the build cannot read is a route with no rule at all.`);
-	if (!("userGroupIds" in visibility)) return;
-	if (userGroup !== "LOGGED_IN_USERS") reject$1(`userGroupIds only means anything under LOGGED_IN_USERS, not under ${userGroup}`);
-	const ids = visibility["userGroupIds"];
-	if (!Array.isArray(ids) || ids.some((id) => typeof id !== "string")) reject$1(`userGroupIds must be an array of group id strings, not ${JSON.stringify(ids)}. Drop the key entirely to mean "any logged-in user".`);
-}
-function visibilityOf(opts, filePath) {
-	const projectRelative = toProjectRelative(opts.root, opts.crawl.routesDirectory, filePath);
-	const source = opts.sources.get(path.resolve(opts.root, opts.crawl.routesDirectory, filePath));
-	if (source === void 0) return null;
-	const result = extractVisibility(source, projectRelative);
-	if (!result.ok) throw new ManifestError(result.error);
-	if (result.visibility === null) return null;
-	const declared = {
-		...result.visibility,
-		filePath: projectRelative
-	};
-	checkVisibilityShape(declared);
-	return declared;
-}
-/**
-* Only ENOENT becomes `null`. The caller reads `null` as "nothing declared here", so swallowing any
-* other read error would turn an unreadable declaration into an ungated route.
-*/
-async function readIfPresent(filePath) {
-	try {
-		return await readFile(filePath, "utf8");
-	} catch (error) {
-		if (error.code === "ENOENT") return null;
-		throw error;
-	}
-}
-
-//#endregion
 //#region src/vite.ts
 const MANIFEST_RELATIVE_PATH = path.join("dist", "routes.json");
 async function renderManifest(root) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softr/sdk",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "type": "module",
   "exports": {
     ".": { "types": "./dist/index.d.ts", "import": "./dist/index.js" },
@@ -12,14 +12,14 @@
   "publishConfig": { "access": "public" },
   "scripts": {
     "build": "tsdown",
-    "test": "node --test",
+    "test": "node --import ./src/test-utils/setup.ts --test",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
     "@babel/parser": "^7.28.0",
     "@babel/traverse": "^7.28.0",
     "@babel/types": "^7.28.0",
-    "@tanstack/router-generator": "1.167.23",
+    "@tanstack/router-generator": "^1.167.0",
     "zod": "^4.4.3"
   },
   "devDependencies": {
@@ -32,7 +32,7 @@
     "vite": "^8.0.0"
   },
   "peerDependencies": {
-    "react": ">=18",
+    "react": "^18.0.0 || ^19.0.0",
     "vite": "^8.0.0",
     "@tanstack/react-router": "^1.168.0",
     "@tanstack/react-start": "^1.168.0"