@typion/rest 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Simone Ergotino
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,29 @@
-# Temporary Holding Version
+# @typion/rest
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The REST transport for [Typion](../../typion/docs/README.md): every collection a resource, with its access rules applied to each
+call and the read config in the query string. Install it and list it in the handler's `transports`.
+
+```ts
+import { rest } from '@typion/rest'
+import { routeHandlers } from 'typion/next'
+import { config } from '@/typion.config.ts'
+
+export const { GET, POST, PATCH, PUT, DELETE, OPTIONS } = await routeHandlers(config, {
+  transports: [rest()],
+})
+```
+
+```http
+GET    /api/posts?columns=slug,title&where[status][eq]=published&sort=-createdAt&limit=10
+GET    /api/posts/:id?with=author&locale=en
+POST   /api/posts/find                the whole read config as JSON (also /find-one, /page, /count)
+POST   /api/posts                     { "data": { … } }
+PATCH  /api/posts/:id                 { "data": { … } }
+DELETE /api/posts/:id
+POST   /api/posts/:id/publish         the routes the features' operations declare
+POST   /api/posts/:id/link/tags       { "ids": [ … ] }, the links of a many-to-many (also /unlink)
+```
+
+Each route becomes a descriptor that the core checks before it runs, as the other transports' do: an unknown key,
+column, relation or operator is `400`, and bulk writes (`/update-many`, `/delete-many`) run only with the handler's
+`exposeBulk: true`. The routes in full are in the guide, [Pages, routes and the browser](../../typion/docs/http.md).

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { Transport } from "typion/http";
+//#region src/index.d.ts
+export declare function rest(): Transport;
+//#endregion
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,354 @@
+import { BadRequestError } from "typion";
+//#region src/query.ts
+function isPlainObject(value) {
+	if (typeof value !== "object" || value === null || Array.isArray(value)) return false;
+	const proto = Object.getPrototypeOf(value);
+	return proto === Object.prototype || proto === null;
+}
+const LIST_PARAMS = /* @__PURE__ */ new Set([
+	"q",
+	"columns",
+	"with",
+	"sort",
+	"limit",
+	"offset",
+	"page",
+	"where"
+]);
+const ONE_PARAMS = /* @__PURE__ */ new Set([
+	"q",
+	"columns",
+	"with"
+]);
+const LOGICAL = {
+	and: "AND",
+	AND: "AND",
+	or: "OR",
+	OR: "OR",
+	not: "NOT",
+	NOT: "NOT"
+};
+const LIST_OPERATORS = /* @__PURE__ */ new Set([
+	"in",
+	"notIn",
+	"arrayContains",
+	"arrayContained",
+	"arrayOverlaps"
+]);
+const FLAG_OPERATORS = /* @__PURE__ */ new Set(["isNull", "isNotNull"]);
+function bad(message) {
+	throw new BadRequestError(message);
+}
+function bool(name, raw) {
+	if (raw === "true" || raw === "") return true;
+	if (raw === "false") return false;
+	return bad(`${name} must be true or false`);
+}
+function int(name, raw) {
+	if (!/^\d+$/.test(raw)) bad(`${name} must be a non-negative integer`);
+	return Number(raw);
+}
+function json(name, raw) {
+	try {
+		return JSON.parse(raw);
+	} catch {
+		return bad(`${name} must be JSON`);
+	}
+}
+function selection(raw, name) {
+	const out = {};
+	for (const entry of raw.split(",")) {
+		const path = entry.trim();
+		if (path === "") continue;
+		const [head, ...rest] = path.split(".");
+		if (head === void 0 || head === "") bad(`${name} has an empty entry`);
+		if (rest.length === 0) {
+			out[head] ??= true;
+			continue;
+		}
+		const nested = isPlainObject(out[head]) ? out[head] : {};
+		const inner = isPlainObject(nested.with) ? nested.with : {};
+		Object.assign(inner, selection(rest.join("."), name));
+		nested.with = inner;
+		out[head] = nested;
+	}
+	return out;
+}
+function sort(raw) {
+	const out = {};
+	for (const entry of raw.split(",")) {
+		const field = entry.trim();
+		if (field === "") continue;
+		out[field.startsWith("-") ? field.slice(1) : field] = field.startsWith("-") ? "desc" : "asc";
+	}
+	return out;
+}
+function pathOf(key) {
+	const segments = [];
+	const brackets = key.slice(5);
+	const re = /\[([^\]]*)\]/g;
+	let consumed = 0;
+	let match = re.exec(brackets);
+	while (match !== null) {
+		if (match.index !== consumed) bad(`Malformed filter parameter '${key}'`);
+		segments.push(match[1] ?? "");
+		consumed = re.lastIndex;
+		match = re.exec(brackets);
+	}
+	if (consumed !== brackets.length || segments.length === 0) bad(`Malformed filter parameter '${key}'`);
+	return segments;
+}
+function filterValue(operator, raw) {
+	if (operator !== void 0 && LIST_OPERATORS.has(operator)) return raw.split(",").map((item) => item.trim());
+	if (operator !== void 0 && FLAG_OPERATORS.has(operator)) return bool(operator, raw);
+	return raw;
+}
+function assign(where, key, raw) {
+	const segments = pathOf(key);
+	let node = where;
+	for (const [index, segment] of segments.entries()) {
+		const name = LOGICAL[segment] ?? segment;
+		const last = index === segments.length - 1;
+		if (Array.isArray(node)) {
+			if (!/^\d+$/.test(segment)) bad(`'${key}': ${name} is not an index of the list before it`);
+			const at = Number(segment);
+			if (last) {
+				node[at] = filterValue(void 0, raw);
+				return;
+			}
+			node[at] = normalize(node[at], segments[index + 1]);
+			node = node[at];
+			continue;
+		}
+		if (last) {
+			node[name] = filterValue(name, raw);
+			return;
+		}
+		node[name] = normalize(node[name], segments[index + 1]);
+		node = node[name];
+	}
+}
+function normalize(current, next) {
+	if (next !== void 0 && /^\d+$/.test(next)) return Array.isArray(current) ? current : [];
+	return isPlainObject(current) ? current : {};
+}
+function optionValue(key, type, raw) {
+	if (type === "boolean") return bool(key, raw);
+	if (type === "number") {
+		const value = Number(raw);
+		if (raw.trim() === "" || !Number.isFinite(value)) bad(`${key} must be a number`);
+		return value;
+	}
+	return raw;
+}
+function readOptions(params, config, plugins) {
+	for (const [key, type] of plugins) {
+		const raw = params.get(key);
+		if (raw !== null) config[key] = optionValue(key, type, raw);
+	}
+}
+function optionParams(url, options) {
+	const config = {};
+	for (const [key, type] of options) {
+		const raw = url.searchParams.get(key);
+		if (raw !== null) config[key] = optionValue(key, type, raw);
+	}
+	return Object.keys(config).length === 0 ? void 0 : config;
+}
+function selections(params, config) {
+	const columns = params.get("columns");
+	if (columns !== null) config.columns = selection(columns, "columns");
+	const withParam = params.get("with");
+	if (withParam !== null) config.with = selection(withParam, "with");
+}
+function base(params, allowed, what) {
+	for (const key of params.keys()) {
+		const name = key.startsWith("where[") ? "where" : key;
+		if (!allowed.has(name)) bad(`Unknown query parameter '${key}' (${what}: ${[...allowed].join(", ")})`);
+	}
+	const q = params.get("q");
+	if (q === null) return {};
+	const parsed = json("q", q);
+	if (!isPlainObject(parsed)) bad("q must be a JSON object");
+	return { ...parsed };
+}
+function parseReadQuery(url, maxLimit, plugins) {
+	const params = url.searchParams;
+	const config = base(params, /* @__PURE__ */ new Set([...LIST_PARAMS, ...plugins.keys()]), "a list read takes");
+	selections(params, config);
+	readOptions(params, config, plugins);
+	const sortParam = params.get("sort");
+	if (sortParam !== null) config.orderBy = sort(sortParam);
+	const limit = params.get("limit");
+	if (limit !== null) config.limit = int("limit", limit);
+	const offset = params.get("offset");
+	if (offset !== null) config.offset = int("offset", offset);
+	const page = params.get("page");
+	if (page !== null) {
+		const number = int("page", page);
+		if (number < 1) bad("page starts at 1");
+		config.offset = (number - 1) * (typeof config.limit === "number" ? config.limit : maxLimit);
+	}
+	const whereParam = params.get("where");
+	const where = isPlainObject(config.where) ? { ...config.where } : {};
+	if (whereParam !== null) {
+		const parsed = json("where", whereParam);
+		if (!isPlainObject(parsed)) bad("where must be a JSON object");
+		Object.assign(where, parsed);
+	}
+	for (const [key, value] of params.entries()) if (key.startsWith("where[")) assign(where, key, value);
+	if (Object.keys(where).length > 0) config.where = where;
+	return config;
+}
+function parseOneQuery(url, plugins) {
+	const params = url.searchParams;
+	const config = base(params, /* @__PURE__ */ new Set([...ONE_PARAMS, ...plugins.keys()]), "reading one row takes");
+	selections(params, config);
+	readOptions(params, config, plugins);
+	return config;
+}
+//#endregion
+//#region src/index.ts
+async function objectBody(call) {
+	const value = await call.body();
+	if (value === void 0) return {};
+	if (!isPlainObject(value)) throw new BadRequestError("The request body must be a JSON object");
+	return value;
+}
+function matchPath(path, segments) {
+	const pattern = path.split("/").filter(Boolean);
+	if (pattern.length !== segments.length) return null;
+	const params = {};
+	return pattern.every((part, i) => {
+		const segment = segments[i];
+		if (part.startsWith(":")) {
+			params[part.slice(1)] = segment;
+			return true;
+		}
+		return part === segment;
+	}) ? params : null;
+}
+function operationQuery(url, op) {
+	const out = {};
+	for (const [key, raw] of url.searchParams) {
+		const type = op.options[key];
+		if (type !== void 0) out[key] = optionValue(key, type, raw);
+		else if (op.args.includes(key)) out[key] = raw;
+		else throw new BadRequestError(`Unknown query parameter '${key}'`);
+	}
+	return out;
+}
+const POSTS = {
+	find: "find",
+	"find-one": "findOne",
+	page: "page",
+	count: "count",
+	"update-many": "updateMany",
+	"delete-many": "deleteMany"
+};
+function collectionRoute(call, entity) {
+	const { method, segments, url, schema } = call;
+	const [, id, action, relation] = segments;
+	switch (segments.length) {
+		case 1:
+			if (method === "GET") return {
+				entity,
+				op: "find",
+				input: async () => parseReadQuery(url, schema.maxLimit, schema.readOptions)
+			};
+			if (method === "POST") return {
+				entity,
+				op: "create",
+				input: call.body,
+				status: 201
+			};
+			return null;
+		case 2: {
+			const name = id;
+			if (method === "POST") {
+				const op = POSTS[name];
+				return op === void 0 ? null : {
+					entity,
+					op,
+					input: call.body
+				};
+			}
+			if (method === "GET") return {
+				entity,
+				op: "findById",
+				input: async () => ({
+					id: name,
+					config: parseOneQuery(url, schema.readOptions)
+				})
+			};
+			if (method === "PATCH") return {
+				entity,
+				op: "update",
+				input: async () => ({
+					...await objectBody(call),
+					id: name
+				})
+			};
+			if (method === "DELETE") return {
+				entity,
+				op: "delete",
+				input: async () => ({
+					id: name,
+					options: optionParams(url, schema.deleteOptions)
+				})
+			};
+			return null;
+		}
+		case 4:
+			if (method === "POST" && (action === "link" || action === "unlink")) return {
+				entity,
+				op: action,
+				input: async () => ({
+					...await objectBody(call),
+					id,
+					relation
+				})
+			};
+			return null;
+		default: return null;
+	}
+}
+function operationRoute(call, entity) {
+	for (const op of entity.operations) {
+		if (op.route === void 0 || op.route.method !== call.method) continue;
+		const params = matchPath(op.route.path, call.segments.slice(1));
+		if (params === null) continue;
+		return {
+			entity: entity.name,
+			op: op.name,
+			input: async () => ({
+				...call.method === "GET" ? operationQuery(call.url, op) : await objectBody(call),
+				...params
+			})
+		};
+	}
+	return null;
+}
+function rest() {
+	return {
+		name: "rest",
+		async handle(call) {
+			const name = call.segments[0];
+			const entity = name === void 0 ? null : call.schema.entity(name);
+			if (entity === null) return void 0;
+			const route = collectionRoute(call, entity.name) ?? operationRoute(call, entity);
+			if (route === null) return void 0;
+			const input = await route.input();
+			const data = await call.run(call.descriptor({
+				entity: route.entity,
+				op: route.op,
+				input
+			}));
+			return call.respond(route.status ?? 200, { data });
+		}
+	};
+}
+//#endregion
+export { rest };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/query.ts","../src/index.ts"],"sourcesContent":["import { BadRequestError, type OptionType } from 'typion'\n\ntype AnyRow = Record<string, unknown>\n\nexport function isPlainObject(value: unknown): value is AnyRow {\n  if (typeof value !== 'object' || value === null || Array.isArray(value)) return false\n  const proto = Object.getPrototypeOf(value)\n  return proto === Object.prototype || proto === null\n}\n\n// The query string of a REST read. `q` carries the whole wire config as JSON for anything this cannot say;\n// everything else is the readable form: `?columns=slug,title&where[title][ilike]=%ciao%&sort=-createdAt`.\n\nconst LIST_PARAMS = new Set(['q', 'columns', 'with', 'sort', 'limit', 'offset', 'page', 'where'])\n\nconst ONE_PARAMS = new Set(['q', 'columns', 'with'])\n\nconst LOGICAL: Record<string, string> = {\n  and: 'AND',\n  AND: 'AND',\n  or: 'OR',\n  OR: 'OR',\n  not: 'NOT',\n  NOT: 'NOT',\n}\n\nconst LIST_OPERATORS = new Set(['in', 'notIn', 'arrayContains', 'arrayContained', 'arrayOverlaps'])\nconst FLAG_OPERATORS = new Set(['isNull', 'isNotNull'])\n\nfunction bad(message: string): never {\n  throw new BadRequestError(message)\n}\n\nfunction bool(name: string, raw: string): boolean {\n  if (raw === 'true' || raw === '') return true\n  if (raw === 'false') return false\n  return bad(`${name} must be true or false`)\n}\n\nfunction int(name: string, raw: string): number {\n  if (!/^\\d+$/.test(raw)) bad(`${name} must be a non-negative integer`)\n  return Number(raw)\n}\n\nfunction json(name: string, raw: string): unknown {\n  try {\n    return JSON.parse(raw)\n  } catch {\n    return bad(`${name} must be JSON`)\n  }\n}\n\n// `columns=slug,title` and `with=author,comments.author`; a relation is included whole, and a narrower\n// selection inside it is what `q` (or POST /:collection/find) is for.\nfunction selection(raw: string, name: string): AnyRow {\n  const out: AnyRow = {}\n  for (const entry of raw.split(',')) {\n    const path = entry.trim()\n    if (path === '') continue\n    const [head, ...rest] = path.split('.')\n    if (head === undefined || head === '') bad(`${name} has an empty entry`)\n    if (rest.length === 0) {\n      out[head] ??= true\n      continue\n    }\n    const nested = isPlainObject(out[head]) ? (out[head] as AnyRow) : {}\n    const inner = isPlainObject(nested.with) ? (nested.with as AnyRow) : {}\n    Object.assign(inner, selection(rest.join('.'), name))\n    nested.with = inner\n    out[head] = nested\n  }\n  return out\n}\n\nfunction sort(raw: string): AnyRow {\n  const out: AnyRow = {}\n  for (const entry of raw.split(',')) {\n    const field = entry.trim()\n    if (field === '') continue\n    out[field.startsWith('-') ? field.slice(1) : field] = field.startsWith('-') ? 'desc' : 'asc'\n  }\n  return out\n}\n\nfunction pathOf(key: string): string[] {\n  const segments: string[] = []\n  const brackets = key.slice('where'.length)\n  const re = /\\[([^\\]]*)\\]/g\n  let consumed = 0\n  let match = re.exec(brackets)\n  while (match !== null) {\n    if (match.index !== consumed) bad(`Malformed filter parameter '${key}'`)\n    segments.push(match[1] ?? '')\n    consumed = re.lastIndex\n    match = re.exec(brackets)\n  }\n  if (consumed !== brackets.length || segments.length === 0) {\n    bad(`Malformed filter parameter '${key}'`)\n  }\n  return segments\n}\n\nfunction filterValue(operator: string | undefined, raw: string): unknown {\n  if (operator !== undefined && LIST_OPERATORS.has(operator)) {\n    return raw.split(',').map((item) => item.trim())\n  }\n  if (operator !== undefined && FLAG_OPERATORS.has(operator)) return bool(operator, raw)\n  return raw\n}\n\n// `where[title][ilike]=%x%`, `where[or][0][status][eq]=published`, `where[author][role][eq]=admin`.\nfunction assign(where: AnyRow, key: string, raw: string): void {\n  const segments = pathOf(key)\n  let node: AnyRow | unknown[] = where\n  for (const [index, segment] of segments.entries()) {\n    const name = LOGICAL[segment] ?? segment\n    const last = index === segments.length - 1\n    if (Array.isArray(node)) {\n      if (!/^\\d+$/.test(segment)) bad(`'${key}': ${name} is not an index of the list before it`)\n      const at = Number(segment)\n      if (last) {\n        node[at] = filterValue(undefined, raw)\n        return\n      }\n      node[at] = normalize(node[at], segments[index + 1])\n      node = node[at] as AnyRow | unknown[]\n      continue\n    }\n    if (last) {\n      node[name] = filterValue(name, raw)\n      return\n    }\n    node[name] = normalize(node[name], segments[index + 1])\n    node = node[name] as AnyRow | unknown[]\n  }\n}\n\nfunction normalize(current: unknown, next: string | undefined): AnyRow | unknown[] {\n  const wantsList = next !== undefined && /^\\d+$/.test(next)\n  if (wantsList) return Array.isArray(current) ? current : []\n  return isPlainObject(current) ? (current as AnyRow) : {}\n}\n\n// The installed plugins' read options (`locale`, `fallback`, `withDeleted`, `draft`), typed so the strings\n// can be coerced.\nexport type QueryOptions = ReadonlyMap<string, OptionType>\n\nexport function optionValue(key: string, type: OptionType, raw: string): unknown {\n  if (type === 'boolean') return bool(key, raw)\n  if (type === 'number') {\n    const value = Number(raw)\n    if (raw.trim() === '' || !Number.isFinite(value)) bad(`${key} must be a number`)\n    return value\n  }\n  return raw\n}\n\nfunction readOptions(params: URLSearchParams, config: AnyRow, plugins: QueryOptions): void {\n  for (const [key, type] of plugins) {\n    const raw = params.get(key)\n    if (raw !== null) config[key] = optionValue(key, type, raw)\n  }\n}\n\n// The plugins' options of a request whose other parameters are fixed (`DELETE …?hard=true`).\nexport function optionParams(url: URL, options: QueryOptions): AnyRow | undefined {\n  const config: AnyRow = {}\n  for (const [key, type] of options) {\n    const raw = url.searchParams.get(key)\n    if (raw !== null) config[key] = optionValue(key, type, raw)\n  }\n  return Object.keys(config).length === 0 ? undefined : config\n}\n\nfunction selections(params: URLSearchParams, config: AnyRow): void {\n  const columns = params.get('columns')\n  if (columns !== null) config.columns = selection(columns, 'columns')\n  const withParam = params.get('with')\n  if (withParam !== null) config.with = selection(withParam, 'with')\n}\n\nfunction base(params: URLSearchParams, allowed: Set<string>, what: string): AnyRow {\n  for (const key of params.keys()) {\n    const name = key.startsWith('where[') ? 'where' : key\n    if (!allowed.has(name)) {\n      bad(`Unknown query parameter '${key}' (${what}: ${[...allowed].join(', ')})`)\n    }\n  }\n  const q = params.get('q')\n  if (q === null) return {}\n  const parsed = json('q', q)\n  if (!isPlainObject(parsed)) bad('q must be a JSON object')\n  return { ...parsed }\n}\n\nexport function parseReadQuery(url: URL, maxLimit: number, plugins: QueryOptions): unknown {\n  const params = url.searchParams\n  const config = base(params, new Set([...LIST_PARAMS, ...plugins.keys()]), 'a list read takes')\n  selections(params, config)\n  readOptions(params, config, plugins)\n\n  const sortParam = params.get('sort')\n  if (sortParam !== null) config.orderBy = sort(sortParam)\n  const limit = params.get('limit')\n  if (limit !== null) config.limit = int('limit', limit)\n  const offset = params.get('offset')\n  if (offset !== null) config.offset = int('offset', offset)\n  const page = params.get('page')\n  if (page !== null) {\n    const number = int('page', page)\n    if (number < 1) bad('page starts at 1')\n    config.offset = (number - 1) * (typeof config.limit === 'number' ? config.limit : maxLimit)\n  }\n\n  const whereParam = params.get('where')\n  const where: AnyRow = isPlainObject(config.where) ? { ...(config.where as AnyRow) } : {}\n  if (whereParam !== null) {\n    const parsed = json('where', whereParam)\n    if (!isPlainObject(parsed)) bad('where must be a JSON object')\n    Object.assign(where, parsed)\n  }\n  for (const [key, value] of params.entries()) {\n    if (key.startsWith('where[')) assign(where, key, value)\n  }\n  if (Object.keys(where).length > 0) config.where = where\n  return config\n}\n\nexport function parseOneQuery(url: URL, plugins: QueryOptions): unknown {\n  const params = url.searchParams\n  const config = base(params, new Set([...ONE_PARAMS, ...plugins.keys()]), 'reading one row takes')\n  selections(params, config)\n  readOptions(params, config, plugins)\n  return config\n}\n","import { BadRequestError, type Op } from 'typion'\nimport type { Transport, TransportCall, TransportEntity, TransportOperation } from 'typion/http'\nimport { isPlainObject, optionParams, optionValue, parseOneQuery, parseReadQuery } from './query.js'\n\ntype AnyRow = Record<string, unknown>\n\ntype Route = {\n  readonly entity: string\n  readonly op: Op\n  readonly input: () => Promise<unknown>\n  readonly status?: number\n}\n\nasync function objectBody(call: TransportCall): Promise<AnyRow> {\n  const value = await call.body()\n  if (value === undefined) return {}\n  if (!isPlainObject(value)) throw new BadRequestError('The request body must be a JSON object')\n  return value\n}\n\nfunction matchPath(path: string, segments: readonly string[]): Record<string, string> | null {\n  const pattern = path.split('/').filter(Boolean)\n  if (pattern.length !== segments.length) return null\n  const params: Record<string, string> = {}\n  const ok = pattern.every((part, i) => {\n    const segment = segments[i] as string\n    if (part.startsWith(':')) {\n      params[part.slice(1)] = segment\n      return true\n    }\n    return part === segment\n  })\n  return ok ? params : null\n}\n\n// On a GET the query string carries what the path does not: the other arguments as they are, the options in\n// their wire types.\nfunction operationQuery(url: URL, op: TransportOperation): AnyRow {\n  const out: AnyRow = {}\n  for (const [key, raw] of url.searchParams) {\n    const type = op.options[key]\n    if (type !== undefined) out[key] = optionValue(key, type, raw)\n    else if (op.args.includes(key)) out[key] = raw\n    else throw new BadRequestError(`Unknown query parameter '${key}'`)\n  }\n  return out\n}\n\n// The bulk routes are matched like the others; the handler's `exposeBulk` decides whether they run, for every\n// transport at once.\nconst POSTS: Record<string, Op> = {\n  find: 'find',\n  'find-one': 'findOne',\n  page: 'page',\n  count: 'count',\n  'update-many': 'updateMany',\n  'delete-many': 'deleteMany',\n}\n\n// The routes every collection has: its reads, writes, and the links of the many-to-many it owns.\nfunction collectionRoute(call: TransportCall, entity: string): Route | null {\n  const { method, segments, url, schema } = call\n  const [, id, action, relation] = segments\n  switch (segments.length) {\n    case 1:\n      if (method === 'GET') {\n        return {\n          entity,\n          op: 'find',\n          input: async () => parseReadQuery(url, schema.maxLimit, schema.readOptions),\n        }\n      }\n      if (method === 'POST') return { entity, op: 'create', input: call.body, status: 201 }\n      return null\n    case 2: {\n      const name = id as string\n      if (method === 'POST') {\n        const op = POSTS[name]\n        return op === undefined ? null : { entity, op, input: call.body }\n      }\n      if (method === 'GET') {\n        return {\n          entity,\n          op: 'findById',\n          input: async () => ({ id: name, config: parseOneQuery(url, schema.readOptions) }),\n        }\n      }\n      if (method === 'PATCH') {\n        return {\n          entity,\n          op: 'update',\n          input: async () => ({ ...(await objectBody(call)), id: name }),\n        }\n      }\n      if (method === 'DELETE') {\n        return {\n          entity,\n          op: 'delete',\n          input: async () => ({ id: name, options: optionParams(url, schema.deleteOptions) }),\n        }\n      }\n      return null\n    }\n    case 4:\n      if (method === 'POST' && (action === 'link' || action === 'unlink')) {\n        return {\n          entity,\n          op: action,\n          input: async () => ({ ...(await objectBody(call)), id, relation }),\n        }\n      }\n      return null\n    default:\n      return null\n  }\n}\n\n// A route an operation of a feature declares under the collection (`POST /posts/:id/publish`).\nfunction operationRoute(call: TransportCall, entity: TransportEntity): Route | null {\n  for (const op of entity.operations) {\n    if (op.route === undefined || op.route.method !== call.method) continue\n    const params = matchPath(op.route.path, call.segments.slice(1))\n    if (params === null) continue\n    return {\n      entity: entity.name,\n      op: op.name,\n      input: async () => ({\n        ...(call.method === 'GET' ? operationQuery(call.url, op) : await objectBody(call)),\n        ...params,\n      }),\n    }\n  }\n  return null\n}\n\n// A resource per collection, with the rules of each: `GET /posts?columns=slug,title&where[status][eq]=published`,\n// `PATCH /posts/:id`, `POST /posts/:id/publish`. Every route becomes a descriptor that the core checks before it\n// runs, as the other transports' do.\nexport function rest(): Transport {\n  return {\n    name: 'rest',\n    async handle(call) {\n      const name = call.segments[0]\n      const entity = name === undefined ? null : call.schema.entity(name)\n      if (entity === null) return undefined\n      const route = collectionRoute(call, entity.name) ?? operationRoute(call, entity)\n      if (route === null) return undefined\n      const input = await route.input()\n      const data = await call.run(call.descriptor({ entity: route.entity, op: route.op, input }))\n      return call.respond(route.status ?? 200, { data })\n    },\n  }\n}\n"],"mappings":";;AAIA,SAAgB,cAAc,OAAiC;CAC7D,IAAI,OAAO,UAAU,YAAY,UAAU,QAAQ,MAAM,QAAQ,KAAK,GAAG,OAAO;CAChF,MAAM,QAAQ,OAAO,eAAe,KAAK;CACzC,OAAO,UAAU,OAAO,aAAa,UAAU;AACjD;AAKA,MAAM,8BAAc,IAAI,IAAI;CAAC;CAAK;CAAW;CAAQ;CAAQ;CAAS;CAAU;CAAQ;AAAO,CAAC;AAEhG,MAAM,6BAAa,IAAI,IAAI;CAAC;CAAK;CAAW;AAAM,CAAC;AAEnD,MAAM,UAAkC;CACtC,KAAK;CACL,KAAK;CACL,IAAI;CACJ,IAAI;CACJ,KAAK;CACL,KAAK;AACP;AAEA,MAAM,iCAAiB,IAAI,IAAI;CAAC;CAAM;CAAS;CAAiB;CAAkB;AAAe,CAAC;AAClG,MAAM,iCAAiB,IAAI,IAAI,CAAC,UAAU,WAAW,CAAC;AAEtD,SAAS,IAAI,SAAwB;CACnC,MAAM,IAAI,gBAAgB,OAAO;AACnC;AAEA,SAAS,KAAK,MAAc,KAAsB;CAChD,IAAI,QAAQ,UAAU,QAAQ,IAAI,OAAO;CACzC,IAAI,QAAQ,SAAS,OAAO;CAC5B,OAAO,IAAI,GAAG,KAAK,uBAAuB;AAC5C;AAEA,SAAS,IAAI,MAAc,KAAqB;CAC9C,IAAI,CAAC,QAAQ,KAAK,GAAG,GAAG,IAAI,GAAG,KAAK,gCAAgC;CACpE,OAAO,OAAO,GAAG;AACnB;AAEA,SAAS,KAAK,MAAc,KAAsB;CAChD,IAAI;EACF,OAAO,KAAK,MAAM,GAAG;CACvB,QAAQ;EACN,OAAO,IAAI,GAAG,KAAK,cAAc;CACnC;AACF;AAIA,SAAS,UAAU,KAAa,MAAsB;CACpD,MAAM,MAAc,CAAC;CACrB,KAAK,MAAM,SAAS,IAAI,MAAM,GAAG,GAAG;EAClC,MAAM,OAAO,MAAM,KAAK;EACxB,IAAI,SAAS,IAAI;EACjB,MAAM,CAAC,MAAM,GAAG,QAAQ,KAAK,MAAM,GAAG;EACtC,IAAI,SAAS,KAAA,KAAa,SAAS,IAAI,IAAI,GAAG,KAAK,oBAAoB;EACvE,IAAI,KAAK,WAAW,GAAG;GACrB,IAAI,UAAU;GACd;EACF;EACA,MAAM,SAAS,cAAc,IAAI,KAAK,IAAK,IAAI,QAAmB,CAAC;EACnE,MAAM,QAAQ,cAAc,OAAO,IAAI,IAAK,OAAO,OAAkB,CAAC;EACtE,OAAO,OAAO,OAAO,UAAU,KAAK,KAAK,GAAG,GAAG,IAAI,CAAC;EACpD,OAAO,OAAO;EACd,IAAI,QAAQ;CACd;CACA,OAAO;AACT;AAEA,SAAS,KAAK,KAAqB;CACjC,MAAM,MAAc,CAAC;CACrB,KAAK,MAAM,SAAS,IAAI,MAAM,GAAG,GAAG;EAClC,MAAM,QAAQ,MAAM,KAAK;EACzB,IAAI,UAAU,IAAI;EAClB,IAAI,MAAM,WAAW,GAAG,IAAI,MAAM,MAAM,CAAC,IAAI,SAAS,MAAM,WAAW,GAAG,IAAI,SAAS;CACzF;CACA,OAAO;AACT;AAEA,SAAS,OAAO,KAAuB;CACrC,MAAM,WAAqB,CAAC;CAC5B,MAAM,WAAW,IAAI,MAAM,CAAc;CACzC,MAAM,KAAK;CACX,IAAI,WAAW;CACf,IAAI,QAAQ,GAAG,KAAK,QAAQ;CAC5B,OAAO,UAAU,MAAM;EACrB,IAAI,MAAM,UAAU,UAAU,IAAI,+BAA+B,IAAI,EAAE;EACvE,SAAS,KAAK,MAAM,MAAM,EAAE;EAC5B,WAAW,GAAG;EACd,QAAQ,GAAG,KAAK,QAAQ;CAC1B;CACA,IAAI,aAAa,SAAS,UAAU,SAAS,WAAW,GACtD,IAAI,+BAA+B,IAAI,EAAE;CAE3C,OAAO;AACT;AAEA,SAAS,YAAY,UAA8B,KAAsB;CACvE,IAAI,aAAa,KAAA,KAAa,eAAe,IAAI,QAAQ,GACvD,OAAO,IAAI,MAAM,GAAG,CAAC,CAAC,KAAK,SAAS,KAAK,KAAK,CAAC;CAEjD,IAAI,aAAa,KAAA,KAAa,eAAe,IAAI,QAAQ,GAAG,OAAO,KAAK,UAAU,GAAG;CACrF,OAAO;AACT;AAGA,SAAS,OAAO,OAAe,KAAa,KAAmB;CAC7D,MAAM,WAAW,OAAO,GAAG;CAC3B,IAAI,OAA2B;CAC/B,KAAK,MAAM,CAAC,OAAO,YAAY,SAAS,QAAQ,GAAG;EACjD,MAAM,OAAO,QAAQ,YAAY;EACjC,MAAM,OAAO,UAAU,SAAS,SAAS;EACzC,IAAI,MAAM,QAAQ,IAAI,GAAG;GACvB,IAAI,CAAC,QAAQ,KAAK,OAAO,GAAG,IAAI,IAAI,IAAI,KAAK,KAAK,uCAAuC;GACzF,MAAM,KAAK,OAAO,OAAO;GACzB,IAAI,MAAM;IACR,KAAK,MAAM,YAAY,KAAA,GAAW,GAAG;IACrC;GACF;GACA,KAAK,MAAM,UAAU,KAAK,KAAK,SAAS,QAAQ,EAAE;GAClD,OAAO,KAAK;GACZ;EACF;EACA,IAAI,MAAM;GACR,KAAK,QAAQ,YAAY,MAAM,GAAG;GAClC;EACF;EACA,KAAK,QAAQ,UAAU,KAAK,OAAO,SAAS,QAAQ,EAAE;EACtD,OAAO,KAAK;CACd;AACF;AAEA,SAAS,UAAU,SAAkB,MAA8C;CAEjF,IADkB,SAAS,KAAA,KAAa,QAAQ,KAAK,IAAI,GAC1C,OAAO,MAAM,QAAQ,OAAO,IAAI,UAAU,CAAC;CAC1D,OAAO,cAAc,OAAO,IAAK,UAAqB,CAAC;AACzD;AAMA,SAAgB,YAAY,KAAa,MAAkB,KAAsB;CAC/E,IAAI,SAAS,WAAW,OAAO,KAAK,KAAK,GAAG;CAC5C,IAAI,SAAS,UAAU;EACrB,MAAM,QAAQ,OAAO,GAAG;EACxB,IAAI,IAAI,KAAK,MAAM,MAAM,CAAC,OAAO,SAAS,KAAK,GAAG,IAAI,GAAG,IAAI,kBAAkB;EAC/E,OAAO;CACT;CACA,OAAO;AACT;AAEA,SAAS,YAAY,QAAyB,QAAgB,SAA6B;CACzF,KAAK,MAAM,CAAC,KAAK,SAAS,SAAS;EACjC,MAAM,MAAM,OAAO,IAAI,GAAG;EAC1B,IAAI,QAAQ,MAAM,OAAO,OAAO,YAAY,KAAK,MAAM,GAAG;CAC5D;AACF;AAGA,SAAgB,aAAa,KAAU,SAA2C;CAChF,MAAM,SAAiB,CAAC;CACxB,KAAK,MAAM,CAAC,KAAK,SAAS,SAAS;EACjC,MAAM,MAAM,IAAI,aAAa,IAAI,GAAG;EACpC,IAAI,QAAQ,MAAM,OAAO,OAAO,YAAY,KAAK,MAAM,GAAG;CAC5D;CACA,OAAO,OAAO,KAAK,MAAM,CAAC,CAAC,WAAW,IAAI,KAAA,IAAY;AACxD;AAEA,SAAS,WAAW,QAAyB,QAAsB;CACjE,MAAM,UAAU,OAAO,IAAI,SAAS;CACpC,IAAI,YAAY,MAAM,OAAO,UAAU,UAAU,SAAS,SAAS;CACnE,MAAM,YAAY,OAAO,IAAI,MAAM;CACnC,IAAI,cAAc,MAAM,OAAO,OAAO,UAAU,WAAW,MAAM;AACnE;AAEA,SAAS,KAAK,QAAyB,SAAsB,MAAsB;CACjF,KAAK,MAAM,OAAO,OAAO,KAAK,GAAG;EAC/B,MAAM,OAAO,IAAI,WAAW,QAAQ,IAAI,UAAU;EAClD,IAAI,CAAC,QAAQ,IAAI,IAAI,GACnB,IAAI,4BAA4B,IAAI,KAAK,KAAK,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE,EAAE;CAEhF;CACA,MAAM,IAAI,OAAO,IAAI,GAAG;CACxB,IAAI,MAAM,MAAM,OAAO,CAAC;CACxB,MAAM,SAAS,KAAK,KAAK,CAAC;CAC1B,IAAI,CAAC,cAAc,MAAM,GAAG,IAAI,yBAAyB;CACzD,OAAO,EAAE,GAAG,OAAO;AACrB;AAEA,SAAgB,eAAe,KAAU,UAAkB,SAAgC;CACzF,MAAM,SAAS,IAAI;CACnB,MAAM,SAAS,KAAK,wBAAQ,IAAI,IAAI,CAAC,GAAG,aAAa,GAAG,QAAQ,KAAK,CAAC,CAAC,GAAG,mBAAmB;CAC7F,WAAW,QAAQ,MAAM;CACzB,YAAY,QAAQ,QAAQ,OAAO;CAEnC,MAAM,YAAY,OAAO,IAAI,MAAM;CACnC,IAAI,cAAc,MAAM,OAAO,UAAU,KAAK,SAAS;CACvD,MAAM,QAAQ,OAAO,IAAI,OAAO;CAChC,IAAI,UAAU,MAAM,OAAO,QAAQ,IAAI,SAAS,KAAK;CACrD,MAAM,SAAS,OAAO,IAAI,QAAQ;CAClC,IAAI,WAAW,MAAM,OAAO,SAAS,IAAI,UAAU,MAAM;CACzD,MAAM,OAAO,OAAO,IAAI,MAAM;CAC9B,IAAI,SAAS,MAAM;EACjB,MAAM,SAAS,IAAI,QAAQ,IAAI;EAC/B,IAAI,SAAS,GAAG,IAAI,kBAAkB;EACtC,OAAO,UAAU,SAAS,MAAM,OAAO,OAAO,UAAU,WAAW,OAAO,QAAQ;CACpF;CAEA,MAAM,aAAa,OAAO,IAAI,OAAO;CACrC,MAAM,QAAgB,cAAc,OAAO,KAAK,IAAI,EAAE,GAAI,OAAO,MAAiB,IAAI,CAAC;CACvF,IAAI,eAAe,MAAM;EACvB,MAAM,SAAS,KAAK,SAAS,UAAU;EACvC,IAAI,CAAC,cAAc,MAAM,GAAG,IAAI,6BAA6B;EAC7D,OAAO,OAAO,OAAO,MAAM;CAC7B;CACA,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,GACxC,IAAI,IAAI,WAAW,QAAQ,GAAG,OAAO,OAAO,KAAK,KAAK;CAExD,IAAI,OAAO,KAAK,KAAK,CAAC,CAAC,SAAS,GAAG,OAAO,QAAQ;CAClD,OAAO;AACT;AAEA,SAAgB,cAAc,KAAU,SAAgC;CACtE,MAAM,SAAS,IAAI;CACnB,MAAM,SAAS,KAAK,wBAAQ,IAAI,IAAI,CAAC,GAAG,YAAY,GAAG,QAAQ,KAAK,CAAC,CAAC,GAAG,uBAAuB;CAChG,WAAW,QAAQ,MAAM;CACzB,YAAY,QAAQ,QAAQ,OAAO;CACnC,OAAO;AACT;;;AC7NA,eAAe,WAAW,MAAsC;CAC9D,MAAM,QAAQ,MAAM,KAAK,KAAK;CAC9B,IAAI,UAAU,KAAA,GAAW,OAAO,CAAC;CACjC,IAAI,CAAC,cAAc,KAAK,GAAG,MAAM,IAAI,gBAAgB,wCAAwC;CAC7F,OAAO;AACT;AAEA,SAAS,UAAU,MAAc,UAA4D;CAC3F,MAAM,UAAU,KAAK,MAAM,GAAG,CAAC,CAAC,OAAO,OAAO;CAC9C,IAAI,QAAQ,WAAW,SAAS,QAAQ,OAAO;CAC/C,MAAM,SAAiC,CAAC;CASxC,OARW,QAAQ,OAAO,MAAM,MAAM;EACpC,MAAM,UAAU,SAAS;EACzB,IAAI,KAAK,WAAW,GAAG,GAAG;GACxB,OAAO,KAAK,MAAM,CAAC,KAAK;GACxB,OAAO;EACT;EACA,OAAO,SAAS;CAClB,CACQ,IAAI,SAAS;AACvB;AAIA,SAAS,eAAe,KAAU,IAAgC;CAChE,MAAM,MAAc,CAAC;CACrB,KAAK,MAAM,CAAC,KAAK,QAAQ,IAAI,cAAc;EACzC,MAAM,OAAO,GAAG,QAAQ;EACxB,IAAI,SAAS,KAAA,GAAW,IAAI,OAAO,YAAY,KAAK,MAAM,GAAG;OACxD,IAAI,GAAG,KAAK,SAAS,GAAG,GAAG,IAAI,OAAO;OACtC,MAAM,IAAI,gBAAgB,4BAA4B,IAAI,EAAE;CACnE;CACA,OAAO;AACT;AAIA,MAAM,QAA4B;CAChC,MAAM;CACN,YAAY;CACZ,MAAM;CACN,OAAO;CACP,eAAe;CACf,eAAe;AACjB;AAGA,SAAS,gBAAgB,MAAqB,QAA8B;CAC1E,MAAM,EAAE,QAAQ,UAAU,KAAK,WAAW;CAC1C,MAAM,GAAG,IAAI,QAAQ,YAAY;CACjC,QAAQ,SAAS,QAAjB;EACE,KAAK;GACH,IAAI,WAAW,OACb,OAAO;IACL;IACA,IAAI;IACJ,OAAO,YAAY,eAAe,KAAK,OAAO,UAAU,OAAO,WAAW;GAC5E;GAEF,IAAI,WAAW,QAAQ,OAAO;IAAE;IAAQ,IAAI;IAAU,OAAO,KAAK;IAAM,QAAQ;GAAI;GACpF,OAAO;EACT,KAAK,GAAG;GACN,MAAM,OAAO;GACb,IAAI,WAAW,QAAQ;IACrB,MAAM,KAAK,MAAM;IACjB,OAAO,OAAO,KAAA,IAAY,OAAO;KAAE;KAAQ;KAAI,OAAO,KAAK;IAAK;GAClE;GACA,IAAI,WAAW,OACb,OAAO;IACL;IACA,IAAI;IACJ,OAAO,aAAa;KAAE,IAAI;KAAM,QAAQ,cAAc,KAAK,OAAO,WAAW;IAAE;GACjF;GAEF,IAAI,WAAW,SACb,OAAO;IACL;IACA,IAAI;IACJ,OAAO,aAAa;KAAE,GAAI,MAAM,WAAW,IAAI;KAAI,IAAI;IAAK;GAC9D;GAEF,IAAI,WAAW,UACb,OAAO;IACL;IACA,IAAI;IACJ,OAAO,aAAa;KAAE,IAAI;KAAM,SAAS,aAAa,KAAK,OAAO,aAAa;IAAE;GACnF;GAEF,OAAO;EACT;EACA,KAAK;GACH,IAAI,WAAW,WAAW,WAAW,UAAU,WAAW,WACxD,OAAO;IACL;IACA,IAAI;IACJ,OAAO,aAAa;KAAE,GAAI,MAAM,WAAW,IAAI;KAAI;KAAI;IAAS;GAClE;GAEF,OAAO;EACT,SACE,OAAO;CACX;AACF;AAGA,SAAS,eAAe,MAAqB,QAAuC;CAClF,KAAK,MAAM,MAAM,OAAO,YAAY;EAClC,IAAI,GAAG,UAAU,KAAA,KAAa,GAAG,MAAM,WAAW,KAAK,QAAQ;EAC/D,MAAM,SAAS,UAAU,GAAG,MAAM,MAAM,KAAK,SAAS,MAAM,CAAC,CAAC;EAC9D,IAAI,WAAW,MAAM;EACrB,OAAO;GACL,QAAQ,OAAO;GACf,IAAI,GAAG;GACP,OAAO,aAAa;IAClB,GAAI,KAAK,WAAW,QAAQ,eAAe,KAAK,KAAK,EAAE,IAAI,MAAM,WAAW,IAAI;IAChF,GAAG;GACL;EACF;CACF;CACA,OAAO;AACT;AAKA,SAAgB,OAAkB;CAChC,OAAO;EACL,MAAM;EACN,MAAM,OAAO,MAAM;GACjB,MAAM,OAAO,KAAK,SAAS;GAC3B,MAAM,SAAS,SAAS,KAAA,IAAY,OAAO,KAAK,OAAO,OAAO,IAAI;GAClE,IAAI,WAAW,MAAM,OAAO,KAAA;GAC5B,MAAM,QAAQ,gBAAgB,MAAM,OAAO,IAAI,KAAK,eAAe,MAAM,MAAM;GAC/E,IAAI,UAAU,MAAM,OAAO,KAAA;GAC3B,MAAM,QAAQ,MAAM,MAAM,MAAM;GAChC,MAAM,OAAO,MAAM,KAAK,IAAI,KAAK,WAAW;IAAE,QAAQ,MAAM;IAAQ,IAAI,MAAM;IAAI;GAAM,CAAC,CAAC;GAC1F,OAAO,KAAK,QAAQ,MAAM,UAAU,KAAK,EAAE,KAAK,CAAC;EACnD;CACF;AACF"}

package/package.json

@@ -1,6 +1,34 @@
 {
   "name": "@typion/rest",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.1",
+  "description": "REST routes for Typion: a resource per collection, with the rules of each",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/the-escape-studio/typion.git",
+    "directory": "packages/transports/rest"
+  },
+  "homepage": "https://github.com/the-escape-studio/typion/tree/main/packages/transports/rest#readme",
+  "bugs": {
+    "url": "https://github.com/the-escape-studio/typion/issues"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "typion": "^0.1.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
 }