@protobase/server 0.53.0 → 0.53.1

package/dist/assistant/batch-write-tool.js

@@ -1,7 +1,5 @@
 import { HttpProblem } from "../problem.js";
-import { forcedJson } from "./result-budget.js";
 import { defineTool } from "./tools.js";
-import { cutRecordNote } from "./budgeted-page.js";
 import { writeText } from "./write-messages.js";
 import { describedResource } from "./write-prompts.js";
 import { fieldsParameter } from "./write-echo.js";
@@ -127,7 +125,7 @@ const batchWriteTool = (input = {}) => defineTool({
 		const answer = await context.approve(approval);
 		if (answer !== "approved") return `The user did not approve this batch (${answer}); nothing was written.`;
 		const befores = await recordsBefore(context, operations);
-		return context.records.batch(operations).then(async (results) => forcedJson({ results: await batchEcho(context, operations, results, befores, fields) }, cutRecordNote), refused);
+		return context.records.batch(operations).then(async (results) => JSON.stringify({ results: await batchEcho(context, operations, results, befores, fields) }), refused);
 	}
 });
 //#endregion

package/dist/assistant/query-tools.js

@@ -1,7 +1,7 @@
-import { budgetedQueryResult } from "./query-result-budget.js";
 import { runReadOnlyQuery, runReadWriteQuery } from "./run-query.js";
 import { defineTool } from "./tools.js";
 //#region src/assistant/query-tools.ts
+const maxResultLength = 2e4;
 const sqlParameter = (description) => ({
 	type: "string",
 	description
@@ -11,7 +11,7 @@ const refused = (error) => {
 	if (isDatabaseError(error)) return `Postgres refused the statement: ${error.message}`;
 	throw error;
 };
-const shown = (result, statement, context, more) => {
+const shown = (result, statement, context) => {
 	context.show({
 		type: "table",
 		id: crypto.randomUUID(),
@@ -20,9 +20,9 @@ const shown = (result, statement, context, more) => {
 		caption: statement,
 		...result.truncated && { truncated: true }
 	});
-	return budgetedQueryResult(result, more);
+	const json = JSON.stringify(result);
+	return json.length > maxResultLength ? `${json.slice(0, maxResultLength)}... (cut off)` : json;
 };
-const readOn = (count) => `; add OFFSET ${count} to the statement to read on`;
 const statementOf = (args) => typeof args.sql === "string" && args.sql.trim() ? args.sql : void 0;
 /**
 * Lets the model read the app's database: one SELECT per call, in a read-only transaction (see `runReadOnlyQuery`).
@@ -31,7 +31,7 @@ const statementOf = (args) => typeof args.sql === "string" && args.sql.trim() ?
 */
 const readOnlyQueryTool = (db, options = {}) => defineTool({
 	name: "run_read_only_query",
-	description: `Runs one PostgreSQL SELECT on the app's database in a read-only transaction and returns up to ${options.rowLimit ?? 200} rows as JSON ({ columns, rows, truncated }); a result too large for one answer holds fewer rows, with long values cut and named in cut_fields, and a note on reading the rest. The user sees the rows as a table. Use it to answer questions about the data. It reads the app's resource tables only. It cannot change anything.`,
+	description: `Runs one PostgreSQL SELECT on the app's database in a read-only transaction and returns up to ${options.rowLimit ?? 200} rows as JSON ({ columns, rows, truncated }). The user sees the rows as a table. Use it to answer questions about the data. It reads the app's resource tables only. It cannot change anything.`,
 	parameters: {
 		type: "object",
 		properties: { sql: sqlParameter("One SELECT statement, without a trailing semicolon.") },
@@ -44,7 +44,7 @@ const readOnlyQueryTool = (db, options = {}) => defineTool({
 	run: async (args, context) => {
 		const statement = statementOf(args);
 		if (!statement) return "Pass the statement as { \"sql\": \"select ...\" }.";
-		return runReadOnlyQuery(db, statement, options).then((result) => shown(result, statement, context, readOn), refused);
+		return runReadOnlyQuery(db, statement, options).then((result) => shown(result, statement, context), refused);
 	}
 });
 /**
@@ -79,7 +79,7 @@ const readWriteQueryTool = (db, options = {}) => defineTool({
 			code: statement
 		});
 		if (answer !== "approved") return `The user did not approve the statement (${answer}); nothing ran.`;
-		return runReadWriteQuery(db, statement, options).then((result) => shown(result, statement, context, () => ""), refused);
+		return runReadWriteQuery(db, statement, options).then((result) => shown(result, statement, context), refused);
 	}
 });
 //#endregion

package/dist/assistant/record-tools.js

@@ -1,9 +1,6 @@
 import { notFound } from "../problem.js";
-import { forcedJson } from "./result-budget.js";
 import { defineTool } from "./tools.js";
 import { invalidShowDeleted, keyOf, keyParameter, refused, resourceOf, resourceParameter, showDeletedOf, showDeletedParameter } from "./record-tool-args.js";
-import { budgetedPage, cutRecordNote } from "./budgeted-page.js";
-import { fieldPiece, pieceParameters, readsPiece } from "./record-field-piece.js";
 import { countRecordsTool } from "./count-records-tool.js";
 //#region src/assistant/record-tools.ts
 const readOnly = {
@@ -78,7 +75,7 @@ const describeResourceTool = () => defineTool({
 /** Finds records of a resource with the REST API's filters, sorting and pages, under the caller's access rules. */
 const listRecordsTool = () => defineTool({
 	name: "list_records",
-	description: `Finds records of a resource and returns a page of them as JSON ({ items, next_page_token, total_size_estimate }). filter uses AIP-160 syntax, such as status = "open" AND amount > 10, and order_by a comma-separated list of fields, each optionally followed by desc. Pass next_page_token back as page_token for the next page; it is empty on the last. A page too large for one result holds fewer records, with long values cut and named in cut_fields, and a note on reading the rest. show_deleted: true also returns soft-deleted records.`,
+	description: `Finds records of a resource and returns a page of them as JSON ({ items, next_page_token, total_size_estimate }). filter uses AIP-160 syntax, such as status = "open" AND amount > 10, and order_by a comma-separated list of fields, each optionally followed by desc. Pass next_page_token back as page_token for the next page; it is empty on the last. show_deleted: true also returns soft-deleted records.`,
 	parameters: {
 		type: "object",
 		properties: {
@@ -118,21 +115,19 @@ const listRecordsTool = () => defineTool({
 			page_size: typeof args.page_size === "number" ? Math.min(args.page_size, maxPageSize) : defaultPageSize,
 			...showDeleted && { show_deleted: true }
 		};
-		const list = (paged) => context.records.list(resource, paged);
-		return list(params).then((page) => budgetedPage(page, params, list)).catch(refused);
+		return context.records.list(resource, params).then((page) => JSON.stringify(page), refused);
 	}
 });
 /** Reads one record by its key, under the caller's access rules. */
 const getRecordTool = () => defineTool({
 	name: "get_record",
-	description: "Reads one record of a resource by its key and returns it as JSON ({ record, etag }), with long values cut and named in cut_fields when it is too large for one result. field reads one field alone, in pieces from offset. show_deleted: true also finds a soft-deleted record.",
+	description: "Reads one record of a resource by its key and returns it as JSON ({ record, etag }). show_deleted: true also finds a soft-deleted record.",
 	parameters: {
 		type: "object",
 		properties: {
 			resource: resourceParameter,
 			key: keyParameter,
-			show_deleted: showDeletedParameter,
-			...pieceParameters
+			show_deleted: showDeletedParameter
 		},
 		required: ["resource", "key"]
 	},
@@ -143,8 +138,7 @@ const getRecordTool = () => defineTool({
 		if (!resource || key === void 0) return "Pass the resource and key as { \"resource\": \"<name>\", \"key\": \"<key>\" }.";
 		const showDeleted = showDeletedOf(args);
 		if (showDeleted === void 0) return invalidShowDeleted;
-		const shown = (found) => readsPiece(args) ? fieldPiece(found, args) : forcedJson(found, cutRecordNote);
-		return context.records.get(resource, key, { show_deleted: showDeleted }).then(shown, refused);
+		return context.records.get(resource, key, { show_deleted: showDeleted }).then((record) => JSON.stringify(record), refused);
 	}
 });
 /**

package/dist/assistant/write-record-tools.js

@@ -1,7 +1,5 @@
-import { forcedJson } from "./result-budget.js";
 import { defineTool } from "./tools.js";
 import { keyOf, keyParameter, refused, resourceOf } from "./record-tool-args.js";
-import { cutRecordNote } from "./budgeted-page.js";
 import { createApproval, updateApproval } from "./write-prompts.js";
 import { approvalTexts, recordBefore } from "./record-before.js";
 import { forbiddenText, notApproved, onlyNote, outside, resourceParameterFor } from "./write-tool-limits.js";
@@ -43,7 +41,7 @@ const createRecordTool = (input = {}) => defineTool({
 		const { text, described } = await approvalTexts(context, resource);
 		const answer = await context.approve(createApproval(text, described, data));
 		if (answer !== "approved") return notApproved(answer);
-		return context.records.create(resource, data).then((written) => forcedJson(writeEcho(described.model, written, data, void 0, fields), cutRecordNote), refused);
+		return context.records.create(resource, data).then((written) => JSON.stringify(writeEcho(described.model, written, data, void 0, fields)), refused);
 	}
 });
 /** Updates one record by its key once the user approves it, under the caller's access rules. */
@@ -90,7 +88,7 @@ const updateRecordTool = (input = {}) => defineTool({
 		const { text, described } = await approvalTexts(context, resource);
 		const answer = await context.approve(updateApproval(text, described, key, before?.record ?? {}, data));
 		if (answer !== "approved") return notApproved(answer);
-		return context.records.update(resource, key, data, { etag }).then((written) => forcedJson(writeEcho(described.model, written, data, before?.record, fields), cutRecordNote), refused);
+		return context.records.update(resource, key, data, { etag }).then((written) => JSON.stringify(writeEcho(described.model, written, data, before?.record, fields)), refused);
 	}
 });
 /** `create_record`, `update_record` and `delete_record`, on the resources `input` allows. */

package/dist/package.js

@@ -1,4 +1,4 @@
 //#region package.json
-var version = "0.53.0";
+var version = "0.53.1";
 //#endregion
 export { version };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/server",
-  "version": "0.53.0",
+  "version": "0.53.1",
   "description": "The Protobase REST API as a Hono app, with Better Auth sign-in.",
   "license": "Apache-2.0",
   "repository": {
@@ -40,9 +40,9 @@
     "@better-auth/passkey": "^1.7.12",
     "@better-auth/sso": "^1.7.12",
     "@modelcontextprotocol/server": "^2.3.1",
-    "@protobase/layout": "0.53.0",
-    "@protobase/query": "0.53.0",
-    "@protobase/schema": "0.53.0",
+    "@protobase/layout": "0.53.1",
+    "@protobase/query": "0.53.1",
+    "@protobase/schema": "0.53.1",
     "@react-email/render": "^2.1.0",
     "@scalar/hono-api-reference": "^0.12.10",
     "@sentry/core": "^11.7.0",

package/dist/assistant/budgeted-page.js

@@ -1,30 +0,0 @@
-import { budgetedJson, forcedJson, leadingFit } from "./result-budget.js";
-//#region src/assistant/budgeted-page.ts
-/** How a record tool's result says to read a field it cut. */
-const cutRecordNote = "The fields in cut_fields were cut to fit the size limit, each with its full length; read the rest of one with get_record and its field, offset and max_chars arguments.";
-const fewerNote = (count) => `Only ${count} records fit the size limit; pass next_page_token as page_token for the next ones. ${cutRecordNote}`;
-/**
-* A page of records as JSON within the size budget: its strings trimmed, then, when that does not fit, the page
-* listed again with as many records as fit, so its next_page_token goes on from the last one returned.
-*/
-const budgetedPage = async (page, params, list) => {
-	const json = budgetedJson(page, cutRecordNote);
-	if (json) return json;
-	if (page.items.length <= 1) return forcedJson(page, cutRecordNote);
-	const fits = (count) => budgetedJson({
-		...page,
-		items: page.items.slice(0, count),
-		note: fewerNote(count)
-	}, fewerNote(count)) !== void 0;
-	const count = leadingFit(page.items.length - 1, fits);
-	const fewer = await list({
-		...params,
-		page_size: count
-	});
-	return forcedJson({
-		...fewer,
-		note: fewerNote(fewer.items.length)
-	}, fewerNote(fewer.items.length));
-};
-//#endregion
-export { budgetedPage, cutRecordNote };

package/dist/assistant/query-result-budget.js

@@ -1,32 +0,0 @@
-import { budgetedJson, forcedJson, leadingFit } from "./result-budget.js";
-//#region src/assistant/query-result-budget.ts
-const cutCellNote = "The values in cut_fields were cut to fit the size limit, each with its full length (rows[r][c] is row r, column c); read the rest of one with substring(<column> from <start>), counting characters from 1.";
-const fewerRowsNote = (count, more) => `Only the first ${count} rows fit the size limit${more}. ${cutCellNote}`;
-/**
-* A query's result as JSON within the size budget: its strings trimmed, then, when that does not fit, only as many
-* leading rows as fit, marked truncated. `more` ends the note on the rows left out, such as how to read on.
-*/
-const budgetedQueryResult = (result, more) => {
-	const json = budgetedJson(result, cutCellNote);
-	if (json) return json;
-	if (result.rows.length <= 1) return forcedJson(result, cutCellNote);
-	const leading = (count) => {
-		const note = fewerRowsNote(count, more(count));
-		return {
-			result: {
-				...result,
-				rows: result.rows.slice(0, count),
-				truncated: true,
-				note
-			},
-			note
-		};
-	};
-	const { result: fewer, note } = leading(leadingFit(result.rows.length - 1, (count) => {
-		const { result, note } = leading(count);
-		return budgetedJson(result, note) !== void 0;
-	}));
-	return forcedJson(fewer, note);
-};
-//#endregion
-export { budgetedQueryResult };

package/dist/assistant/record-field-piece.js

@@ -1,54 +0,0 @@
-import { forcedJson } from "./result-budget.js";
-//#region src/assistant/record-field-piece.ts
-/** get_record's arguments that read one field in pieces, such as a field a result cut to fit its size limit. */
-const pieceParameters = {
-	field: {
-		type: "string",
-		description: "One field to read alone, in pieces: max_chars characters of its value from offset. A value that is not text reads as its JSON."
-	},
-	offset: {
-		type: "integer",
-		minimum: 0,
-		description: "With field: the character to start at, 0 by default."
-	},
-	max_chars: {
-		type: "integer",
-		minimum: 1,
-		maximum: 3e4,
-		description: "With field: the characters to read, 20000 by default."
-	}
-};
-const defaultChars = 2e4;
-const maxChars = 3e4;
-const invalid = (message) => JSON.stringify({
-	error: "invalid-parameter",
-	message
-});
-const countOf = (value, fallback) => value === void 0 ? fallback : typeof value === "number" && Number.isInteger(value) && value >= 0 ? value : void 0;
-/** Whether the call reads one field in pieces rather than the whole record. */
-const readsPiece = (args) => args.field !== void 0;
-/**
-* The piece of `args.field` of `found` the call asks for, as JSON ({ field, offset, length, value, next_offset }), where
-* length is the whole value's and next_offset is absent once the piece reaches its end.
-*/
-const fieldPiece = (found, args) => {
-	const field = args.field;
-	if (typeof field !== "string" || !Object.hasOwn(found.record, field)) return invalid(`Invalid parameter field: pass one of ${Object.keys(found.record).join(", ")}`);
-	const offset = countOf(args.offset, 0);
-	if (offset === void 0) return invalid("Invalid parameter offset: pass a whole number from 0");
-	const chars = countOf(args.max_chars, defaultChars);
-	if (!chars) return invalid(`Invalid parameter max_chars: pass a whole number from 1 to ${maxChars}`);
-	const raw = found.record[field];
-	const text = typeof raw === "string" ? raw : JSON.stringify(raw) ?? "null";
-	const end = offset + Math.min(chars, maxChars);
-	const piece = {
-		field,
-		offset,
-		length: text.length,
-		value: text.slice(offset, end),
-		...end < text.length && { next_offset: end }
-	};
-	return forcedJson(piece, "The value was cut to fit the size limit; pass a smaller max_chars.");
-};
-//#endregion
-export { fieldPiece, pieceParameters, readsPiece };

package/dist/assistant/result-budget.js

@@ -1,72 +0,0 @@
-//#region src/assistant/result-budget.ts
-/**
-* Keeps a tool result within what a model's client takes: over the budget, its longest string values are trimmed, each
-* named in `cut_fields` with its full length, and a `note` says how to read the rest. A tool with a list returns fewer
-* items when trimming alone does not fit (see `leadingFit`).
-*/
-/** The characters of JSON one tool result may hold. */
-const resultBudget = 4e4;
-const stringFloor = 500;
-const neverCut = /* @__PURE__ */ new Set(["next_page_token", "etag"]);
-const pathOf = (path, key) => path ? `${path}.${key}` : key;
-const trimmed = (value, cap, path, cuts) => {
-	if (typeof value === "string") {
-		if (value.length <= cap) return value;
-		cuts.push({
-			field: path,
-			length: value.length
-		});
-		return `${value.slice(0, cap)}…`;
-	}
-	if (Array.isArray(value)) return value.map((item, index) => trimmed(item, cap, `${path}[${index}]`, cuts));
-	if (value !== null && typeof value === "object") return Object.fromEntries(Object.entries(value).map(([key, item]) => [key, !path && neverCut.has(key) ? item : trimmed(item, cap, pathOf(path, key), cuts)]));
-	return value;
-};
-const longestString = (value) => {
-	if (typeof value === "string") return value.length;
-	if (value !== null && typeof value === "object") return Math.max(0, ...Object.values(value).map(longestString));
-	return 0;
-};
-const cutAt = (result, cap, note) => {
-	const cuts = [];
-	const value = trimmed(result, cap, "", cuts);
-	return JSON.stringify(cuts.length ? {
-		...value,
-		cut_fields: cuts,
-		note
-	} : value);
-};
-/**
-* `result` as JSON within `budget`, its strings trimmed as little as fits but to no fewer than `floor` characters;
-* undefined when even that does not fit. `note` says how to read a cut field's rest.
-*/
-const budgetedJson = (result, note, budget = resultBudget, floor = stringFloor) => {
-	const json = JSON.stringify(result);
-	if (json.length <= budget) return json;
-	const plain = JSON.parse(json);
-	let low = floor;
-	let high = longestString(plain);
-	if (low >= high) return void 0;
-	if (cutAt(plain, low, note).length > budget) return void 0;
-	while (high - low > 1) {
-		const cap = Math.floor((low + high) / 2);
-		if (cutAt(plain, cap, note).length <= budget) low = cap;
-		else high = cap;
-	}
-	return cutAt(plain, low, note);
-};
-/** `result` as JSON within `budget` if it can be, its strings trimmed down to nothing when they must; never undefined. */
-const forcedJson = (result, note, budget = resultBudget) => budgetedJson(result, note, budget) ?? budgetedJson(result, note, budget, 0) ?? cutAt(JSON.parse(JSON.stringify(result)), 0, note);
-/** The most leading items of `count`, at least 1, for which `fits` holds, `fits` holding for fewer when it does for more. */
-const leadingFit = (count, fits) => {
-	let low = 1;
-	let high = count;
-	while (low < high) {
-		const middle = Math.ceil((low + high) / 2);
-		if (fits(middle)) low = middle;
-		else high = middle - 1;
-	}
-	return low;
-};
-//#endregion
-export { budgetedJson, forcedJson, leadingFit, resultBudget };