@protobase/workflow-plugins 0.68.4 → 0.68.6

package/dist/app.d.ts

@@ -7,7 +7,7 @@ export declare const appPlugin: {
     readonly [x: string]: import("@protobase/workflows/plugin").StepType;
   };
   readonly triggers: {
-    readonly [x: string]: import("@protobase/workflows/plugin").ReadyTrigger;
+    readonly [x: string]: import("@protobase/workflows/plugin").ReadyTrigger | import("@protobase/workflows/plugin").PollingTrigger | import("@protobase/workflows/plugin").WebhookTrigger;
   };
 };
 //#endregion

package/dist/app.js

@@ -3,6 +3,8 @@ import { mailSteps } from "./mail.js";
 import { pieceSteps } from "./piece.js";
 import { recordTriggers } from "./record-trigger.js";
 import { recordsSteps } from "./records.js";
+import { scheduleTriggers } from "./schedule.js";
+import { webhookTriggers } from "./webhook.js";
 import { definePlugin } from "@protobase/workflows/plugin";
 //#region src/app.ts
 /** The built-in types, `app:<key>`: one plugin like any other, on the public interface alone. */
@@ -15,7 +17,11 @@ const appPlugin = definePlugin({
 		...mailSteps,
 		...pieceSteps
 	},
-	triggers: { ...recordTriggers }
+	triggers: {
+		...recordTriggers,
+		...scheduleTriggers,
+		...webhookTriggers
+	}
 });
 //#endregion
 export { appPlugin };

package/dist/schedule.js

@@ -0,0 +1,85 @@
+//#region src/schedule.ts
+const fieldBounds = [
+	[0, 59],
+	[0, 23],
+	[1, 31],
+	[1, 12],
+	[0, 7]
+];
+const cronItem = /^(?:\*|(\d+)(?:-(\d+))?)(?:\/(\d+))?$/;
+const cronField = (field, [min, max]) => field.split(",").every((item) => {
+	const match = cronItem.exec(item);
+	if (!match) return false;
+	const [, from, to, step] = match;
+	if (step !== void 0 && Number(step) === 0) return false;
+	if (from === void 0) return true;
+	const last = to === void 0 ? Number(from) : Number(to);
+	return Number(from) >= min && last <= max && Number(from) <= last;
+});
+const knownZone = (zone) => {
+	try {
+		new Intl.DateTimeFormat("en", { timeZone: zone });
+		return true;
+	} catch (error) {
+		if (!(error instanceof RangeError)) throw error;
+		return false;
+	}
+};
+/** What the schema cannot check of a schedule: its five cron fields and its IANA time zone. */
+const scheduleProblems = (input) => {
+	const problems = [];
+	const fields = String(input.cron).trim().split(/\s+/);
+	if (fields.length !== 5 || !fields.every((field, index) => cronField(field, fieldBounds[index]))) problems.push({
+		field: "cron",
+		message: "must be a cron of 5 fields, each within its range, such as 0 6 * * *"
+	});
+	const zone = input.timezone;
+	if (typeof zone === "string" && !knownZone(zone)) problems.push({
+		field: "timezone",
+		message: `"${zone}" is not an IANA time zone, such as Europe/Amsterdam`
+	});
+	return problems;
+};
+/** `app:schedule`: one run at each time of a cron, in a time zone, with the time as the run's input. */
+const scheduleTriggers = { schedule: {
+	kind: "polling",
+	label: "Schedule",
+	description: "Starts one run at each time of a cron schedule, such as 0 6 * * 1-5 in Europe/Amsterdam.",
+	input: {
+		type: "object",
+		additionalProperties: false,
+		required: ["cron"],
+		properties: {
+			cron: {
+				type: "string",
+				minLength: 1,
+				description: "five cron fields: minute, hour, day of month, month, day of week"
+			},
+			timezone: {
+				type: "string",
+				minLength: 1,
+				description: "an IANA time zone, such as Europe/Amsterdam; default UTC"
+			}
+		}
+	},
+	output: {
+		type: "object",
+		description: "{ scheduled_at }: the time this run was scheduled for"
+	},
+	check: scheduleProblems,
+	every: (input) => ({
+		cron: input.cron,
+		...typeof input.timezone === "string" && { timezone: input.timezone }
+	}),
+	limit: 1,
+	start: async () => null,
+	poll: async ({ due }) => ({
+		items: [{
+			key: `schedule:${due.toISOString()}`,
+			data: { scheduled_at: due.toISOString() }
+		}],
+		cursor: due.toISOString()
+	})
+} };
+//#endregion
+export { scheduleTriggers };

package/dist/webhook.js

@@ -0,0 +1,27 @@
+import { webhookInputCheck, webhookInputProperties } from "@protobase/workflows/plugin";
+//#region src/webhook.ts
+/**
+* `app:webhook`: one run per call of the workflow's webhook URL that proves it comes from the sender, with the call as
+* the run's input. A sender's `webhook-id`, or the configured idempotency header, starts one run per value.
+*/
+const webhookTriggers = { webhook: {
+	kind: "webhook",
+	label: "Webhook",
+	description: "Starts one run for each call of the workflow's webhook URL that carries its secret; new_webhook_url issues the URL.",
+	input: {
+		type: "object",
+		additionalProperties: false,
+		properties: webhookInputProperties
+	},
+	output: {
+		type: "object",
+		description: "{ method, query, headers, body, received_at }: the call without its credentials; a body that makes it over 1 MiB as JSON is a file of the run"
+	},
+	check: webhookInputCheck,
+	receive: async ({ event, idempotencyKey }) => ({ items: [{
+		...idempotencyKey !== void 0 && { key: idempotencyKey },
+		data: event
+	}] })
+} };
+//#endregion
+export { webhookTriggers };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/workflow-plugins",
-  "version": "0.68.4",
+  "version": "0.68.6",
   "description": "The built-in workflow trigger and step types, written on the public plugin interface like any other plugin.",
   "license": "Apache-2.0",
   "repository": {
@@ -29,6 +29,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@protobase/workflows": "0.68.4"
+    "@protobase/workflows": "0.68.6"
   }
 }