@protobase/server 0.67.12 → 0.68.0

package/dist/workflows/mcp/type-catalog.js

@@ -1,144 +0,0 @@
-//#region src/workflows/mcp/type-catalog.ts
-const needs = (takes) => ({
-	required: true,
-	takes
-});
-const may = (takes) => ({
-	required: false,
-	takes
-});
-const resource = needs("the resource's name, as list_resources gives it");
-const key = needs("the record's key");
-const refused = ["Records.Refused: the API refused it, its status and message in the cause", "Records.InvalidArguments: an argument has the wrong type, named in the cause"];
-/** The step types a Task names as its `Resource`, as the workflows reference describes them. */
-const stepTypeCatalog = [
-	{
-		resource: "app:http",
-		does: "Sends one HTTP request to a public address and reads the answer.",
-		arguments: {
-			url: needs("an http or https URL"),
-			method: may("GET (default), POST, PUT, PATCH or DELETE"),
-			headers: may("an object of text values"),
-			query: may("an object of text values, added to the URL's query"),
-			body: may("text sent as it is, a file value sent as its bytes, any other value sent as JSON; a GET sends none"),
-			response: may("how the answer's body is read: json (default; empty is null), text, or file (kept as a file value of the run)")
-		},
-		result: "{ status, headers, body }",
-		errors: [
-			"Http.Status: a status outside 2xx; the cause names it with the start of the body",
-			"Http.Network: no answer",
-			"Http.InvalidArguments: an argument has the wrong type, named in the cause",
-			"Http.InvalidBody: response json, and the body is not JSON",
-			"Http.AddressRefused: the host is not a public address",
-			"Http.ResponseTooLarge: a body over 10 MiB"
-		]
-	},
-	{
-		resource: "app:records.create",
-		does: "Creates records of the app's resources, as the workflow's last editor.",
-		arguments: {
-			resource,
-			data: needs("an object of field values, or a list of them, created in one batch: all or none")
-		},
-		result: "the created record, or the list of them",
-		errors: refused
-	},
-	{
-		resource: "app:records.update",
-		does: "Updates one record, as the workflow's last editor.",
-		arguments: {
-			resource,
-			key,
-			data: needs("an object of the field values to change")
-		},
-		result: "the updated record",
-		errors: refused
-	},
-	{
-		resource: "app:records.get",
-		does: "Reads one record, as the workflow's last editor.",
-		arguments: {
-			resource,
-			key
-		},
-		result: "the record",
-		errors: refused
-	},
-	{
-		resource: "app:records.list",
-		does: "Lists records, as the workflow's last editor.",
-		arguments: {
-			resource,
-			filter: may("a filter in the API's syntax, such as status = \"open\""),
-			order_by: may("such as \"created_at desc\""),
-			limit: may("how many at most")
-		},
-		result: "{ records }",
-		errors: refused
-	},
-	{
-		resource: "app:mail.send",
-		does: "Sends a mail from the app's own sender.",
-		arguments: {
-			to: needs("one address, or a list of at most 50"),
-			subject: needs("one line of text"),
-			text: needs("the body as text"),
-			html: may("the body as HTML too"),
-			attachments: may("a list of file values the run keeps, at most 10 MiB together")
-		},
-		result: "{ message_id }",
-		errors: ["Mail.InvalidArguments: an argument has the wrong type, named in the cause", "States.TaskFailed: the app sends no mail, or the mailer refused it"]
-	},
-	{
-		resource: "app:piece",
-		does: "Runs an action of a connector. Not implemented yet: a run fails it.",
-		arguments: {
-			piece: needs("the connector's name"),
-			action: needs("one of its actions"),
-			connection: needs("the connection holding its sign-in"),
-			props: may("the action's arguments, by name")
-		},
-		result: "what the action returns",
-		errors: ["Piece.Error: always, until connectors are implemented"]
-	}
-];
-/** The triggers a definition's `trigger` holds exactly one of. */
-const triggerCatalog = [
-	{
-		trigger: "manual",
-		example: { manual: {} },
-		starts: "when someone runs the workflow, such as with run_workflow",
-		input: "the input they give"
-	},
-	{
-		trigger: "webhook",
-		example: { webhook: {} },
-		starts: "on each POST to the workflow's webhook address",
-		input: "{ body, headers, query }"
-	},
-	{
-		trigger: "schedule",
-		example: { schedule: {
-			cron: "0 6 * * 1-5",
-			timezone: "Europe/Amsterdam"
-		} },
-		starts: "on a 5-field cron, in an IANA time zone (default UTC)",
-		input: "{ scheduled_at }, ISO 8601 with the zone's offset"
-	},
-	{
-		trigger: "mail",
-		example: { mail: { mailbox: "support" } },
-		starts: "on each mail arriving in that mailbox",
-		input: "{ from, to, subject, text, html, received_at, attachments }"
-	},
-	{
-		trigger: "record",
-		example: { record: { events: ["orders.created"] } },
-		starts: "on each of those record events, <resource>.<event>",
-		input: "{ event, resource, key, after, before, changed }"
-	}
-];
-/** Only manual runs start for now: a save takes the other triggers, which start nothing yet. */
-const triggerNote = "Runs start only by hand (run_workflow) for now: a workflow saves with any trigger, and the other triggers start no runs yet.";
-//#endregion
-export { stepTypeCatalog, triggerCatalog, triggerNote };

package/dist/workflows/piece-step.js

@@ -1,11 +0,0 @@
-import { StepError } from "@protobase/workflows";
-//#region src/workflows/piece-step.ts
-/**
-* The `app:piece` step, which a definition may name but which runs no piece yet: it fails with `Piece.Error` until the
-* app's plugins give it a handler that sends through the plugin context's guarded fetch.
-*/
-const pieceStep = async () => {
-	throw new StepError("Piece.Error", "No piece runs in this app yet");
-};
-//#endregion
-export { pieceStep };

package/dist/workflows/records-step.js

@@ -1,114 +0,0 @@
-import { HttpProblem } from "../problem.js";
-import { tenantScope } from "../tenant.js";
-import { issueTicket } from "../files/ticket.js";
-import { assistantRecords, toolEntry } from "../assistant/records.js";
-import { runFileRef } from "./run-files.js";
-import { sql } from "kysely";
-import { StepError } from "@protobase/workflows";
-//#region src/workflows/records-step.ts
-const ticketSeconds = 60;
-/**
-* The session a run's records steps act in: the user who saved the version the run pinned, with the roles they hold
-* now in the run's tenant, so a workflow never does more than its last editor may do today.
-*/
-const saverSession = async ({ deps, schema, roles }, runId) => {
-	const { rows } = await sql`select v.saved_by, r.tenant_id from ${sql.id(schema, "runs")} r
-    join ${sql.id(schema, "versions")} v on v.workflow_id = r.workflow_id and v.version = r.version where r.id = ${runId}`.execute(deps().db);
-	const row = rows[0];
-	if (!row?.saved_by) throw new StepError("Records.Refused", "The run's version was not saved by a user, so its steps act on no records");
-	const tenant = row.tenant_id ?? void 0;
-	const held = await roles({
-		id: row.saved_by,
-		...tenant !== void 0 && { tenant }
-	});
-	if (held.length === 0) throw new StepError("Records.Refused", "The workflow's last editor holds no role here any more, so its steps act on no records");
-	return {
-		user: {
-			id: row.saved_by,
-			roles: held
-		},
-		...tenant !== void 0 && {
-			tenant,
-			organization: { id: tenant }
-		}
-	};
-};
-const withTickets = async (deps, session, resource, data, runId) => {
-	const entry = toolEntry(deps, resource);
-	const result = { ...data };
-	for (const [name, value] of Object.entries(data)) {
-		const field = entry.model.fields[name];
-		if (field?.type === "decimal" && typeof value === "number") result[name] = String(value);
-		if (!field?.file || value === null || typeof value !== "object") continue;
-		if (!deps.files) throw new StepError("States.TaskFailed", "The app keeps no files");
-		const ref = runFileRef(runId, value, `data.${name}`);
-		const scope = {
-			tenant: String(tenantScope(entry, session)?.tenantValue ?? ""),
-			resource: entry.name,
-			field: name,
-			user: String(session.user.id)
-		};
-		result[name] = await issueTicket(deps.files.signer, {
-			provider: ref.provider,
-			path: ref.path,
-			name: ref.name,
-			...ref.size !== void 0 && { size: ref.size }
-		}, {}, scope, Math.floor(Date.now() / 1e3) + ticketSeconds);
-	}
-	return result;
-};
-const text = (value, name) => {
-	if (typeof value !== "string" || value === "") throw new StepError("Records.InvalidArguments", `${name} must be text`);
-	return value;
-};
-const keyOf = (value) => {
-	if (typeof value === "string" || typeof value === "number") return value;
-	if (Array.isArray(value) && value.every((part) => typeof part === "string" || typeof part === "number")) return value;
-	throw new StepError("Records.InvalidArguments", "key must be text, a number or a list of them");
-};
-const rowOf = (value, name) => {
-	if (typeof value !== "object" || value === null || Array.isArray(value)) throw new StepError("Records.InvalidArguments", `${name} must be an object of field values`);
-	return value;
-};
-const refusedAs = (error) => {
-	if (error instanceof HttpProblem) throw new StepError("Records.Refused", `${error.status} ${error.title}: ${error.detail}`);
-	throw error;
-};
-const run = async (input, operation, args, { runId }) => {
-	const resource = text(args.resource, "resource");
-	const deps = input.deps();
-	const session = await saverSession(input, runId);
-	const records = assistantRecords(deps, session);
-	if (operation === "get") return (await records.get(resource, keyOf(args.key))).record;
-	if (operation === "update") return (await records.update(resource, keyOf(args.key), await withTickets(deps, session, resource, rowOf(args.data, "data"), runId))).record;
-	if (operation === "list") return { records: (await records.list(resource, {
-		...args.filter !== void 0 && { filter: text(args.filter, "filter") },
-		...args.order_by !== void 0 && { order_by: text(args.order_by, "order_by") },
-		...args.limit !== void 0 && { page_size: Number(args.limit) }
-	})).items.map(({ etag: _, permissions: __, ...record }) => record) };
-	if (Array.isArray(args.data)) {
-		const operations = [];
-		for (const [index, item] of args.data.entries()) operations.push({
-			op: "create",
-			resource,
-			data: await withTickets(deps, session, resource, rowOf(item, `data[${index}]`), runId)
-		});
-		return (await records.batch(operations)).flatMap((result) => result.op === "create" ? [result.record] : []);
-	}
-	return (await records.create(resource, await withTickets(deps, session, resource, rowOf(args.data, "data"), runId))).record;
-};
-/**
-* The `app:records.*` steps: `create`, `update`, `get` and `list` through the app's API as the workflow's last editor,
-* so its access rules, tenant scope, validation and write hooks apply as they do to that user's own requests.
-*/
-const recordsSteps = (input) => {
-	const step = (operation) => (args, context) => run(input, operation, rowOf(args ?? {}, "Arguments"), context).catch(refusedAs);
-	return {
-		"app:records.create": step("create"),
-		"app:records.update": step("update"),
-		"app:records.get": step("get"),
-		"app:records.list": step("list")
-	};
-};
-//#endregion
-export { recordsSteps };

package/dist/workflows/step-types.js

@@ -1,27 +0,0 @@
-import { httpStep } from "./http-step.js";
-import { mailStep } from "./mail-step.js";
-import { pieceStep } from "./piece-step.js";
-import { recordsSteps } from "./records-step.js";
-import { workflowStepTypes } from "@protobase/schema/internal";
-//#region src/workflows/step-types.ts
-/** The step types a Task names as its `Resource`, as the editor offers them. */
-const stepTypeNames = Object.keys(workflowStepTypes);
-/** The step types of one segment, which sends mail with the mailer of the job that runs it. */
-const stepTypes = ({ deps, schema, roles, allowPrivateAddresses }, mail) => {
-	const files = () => deps().files;
-	return {
-		"app:http": httpStep({
-			allowPrivateAddresses,
-			files
-		}),
-		...recordsSteps({
-			deps,
-			schema,
-			roles
-		}),
-		"app:mail.send": mailStep(() => mail, files),
-		"app:piece": pieceStep
-	};
-};
-//#endregion
-export { stepTypeNames, stepTypes };