@tanstack/workflow-netlify 0.0.1

package/README.md

@@ -0,0 +1,51 @@
+# @tanstack/workflow-netlify
+
+Experimental Netlify host adapter for TanStack Workflow.
+
+See the main [Deployment guide](../../docs/guide/deployment.md) and
+[Host adapters API](../../docs/api/host-adapters.md).
+
+The adapter wires a `WorkflowRuntimeDefinition` into a single Netlify scheduled
+function. It materializes registered workflow schedules into the runtime store,
+then calls `runtime.sweep()` to run due scheduled workflows and resume due
+timers.
+
+```ts
+// netlify/functions/workflow-sweep-background.ts
+import {
+  createNetlifyWorkflowSweepConfig,
+  createNetlifyWorkflowSweepHandler,
+} from '@tanstack/workflow-netlify'
+import { workflowRuntime } from '../../src/workflows/runtime.server'
+
+export default createNetlifyWorkflowSweepHandler({
+  runtime: workflowRuntime,
+})
+
+export const config = createNetlifyWorkflowSweepConfig({
+  schedule: '*/5 * * * *',
+})
+```
+
+Workflow schedules stay in the runtime registration:
+
+```ts
+import { defineWorkflowRuntime, every } from '@tanstack/workflow-runtime'
+
+export const workflowRuntime = defineWorkflowRuntime({
+  store,
+  workflows: {
+    'intent-process': {
+      load: async () => intentProcessWorkflow,
+      schedules: [
+        {
+          id: 'intent-process-every-15m',
+          schedule: every.minutes(15),
+          overlapPolicy: 'skip',
+          input: { batchSize: 50 },
+        },
+      ],
+    },
+  },
+})
+```

package/dist/index.cjs

@@ -0,0 +1,8 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_sweep_handler = require('./sweep-handler.cjs');
+let _tanstack_workflow_runtime = require("@tanstack/workflow-runtime");
+
+exports.createNetlifyWorkflowSweepConfig = require_sweep_handler.createNetlifyWorkflowSweepConfig;
+exports.createNetlifyWorkflowSweepHandler = require_sweep_handler.createNetlifyWorkflowSweepHandler;
+exports.materializeWorkflowSchedules = _tanstack_workflow_runtime.materializeWorkflowSchedules;
+exports.netlifyWorkflowSweepConfig = require_sweep_handler.netlifyWorkflowSweepConfig;

package/dist/index.d.cts

@@ -0,0 +1,2 @@
+import { MaterializeWorkflowSchedulesOptions, MaterializedWorkflowSchedule, NetlifyWorkflowSweepConfig, NetlifyWorkflowSweepConfigOptions, NetlifyWorkflowSweepHandler, NetlifyWorkflowSweepHandlerOptions, NetlifyWorkflowSweepResponse, createNetlifyWorkflowSweepConfig, createNetlifyWorkflowSweepHandler, materializeWorkflowSchedules, netlifyWorkflowSweepConfig } from "./sweep-handler.cjs";
+export { type MaterializeWorkflowSchedulesOptions, type MaterializedWorkflowSchedule, type NetlifyWorkflowSweepConfig, type NetlifyWorkflowSweepConfigOptions, type NetlifyWorkflowSweepHandler, type NetlifyWorkflowSweepHandlerOptions, type NetlifyWorkflowSweepResponse, createNetlifyWorkflowSweepConfig, createNetlifyWorkflowSweepHandler, materializeWorkflowSchedules, netlifyWorkflowSweepConfig };

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { MaterializeWorkflowSchedulesOptions, MaterializedWorkflowSchedule, NetlifyWorkflowSweepConfig, NetlifyWorkflowSweepConfigOptions, NetlifyWorkflowSweepHandler, NetlifyWorkflowSweepHandlerOptions, NetlifyWorkflowSweepResponse, createNetlifyWorkflowSweepConfig, createNetlifyWorkflowSweepHandler, materializeWorkflowSchedules, netlifyWorkflowSweepConfig } from "./sweep-handler.js";
+export { type MaterializeWorkflowSchedulesOptions, type MaterializedWorkflowSchedule, type NetlifyWorkflowSweepConfig, type NetlifyWorkflowSweepConfigOptions, type NetlifyWorkflowSweepHandler, type NetlifyWorkflowSweepHandlerOptions, type NetlifyWorkflowSweepResponse, createNetlifyWorkflowSweepConfig, createNetlifyWorkflowSweepHandler, materializeWorkflowSchedules, netlifyWorkflowSweepConfig };

package/dist/index.js

@@ -0,0 +1,3 @@
+import { createNetlifyWorkflowSweepConfig, createNetlifyWorkflowSweepHandler, materializeWorkflowSchedules, netlifyWorkflowSweepConfig } from "./sweep-handler.js";
+
+export { createNetlifyWorkflowSweepConfig, createNetlifyWorkflowSweepHandler, materializeWorkflowSchedules, netlifyWorkflowSweepConfig };

package/dist/sweep-handler.cjs

@@ -0,0 +1,64 @@
+let _tanstack_workflow_runtime = require("@tanstack/workflow-runtime");
+
+//#region src/sweep-handler.ts
+const DEFAULT_SWEEP_INTERVAL_MINUTES = 5;
+const netlifyWorkflowSweepConfig = createNetlifyWorkflowSweepConfig();
+function createNetlifyWorkflowSweepConfig(options = {}) {
+	if (options.schedule) return { schedule: options.schedule };
+	const everyMinutes = options.everyMinutes ?? DEFAULT_SWEEP_INTERVAL_MINUTES;
+	if (!Number.isInteger(everyMinutes) || everyMinutes <= 0) throw new Error("Netlify workflow sweep interval must be a positive integer.");
+	return { schedule: everyMinutes === 1 ? "* * * * *" : `*/${everyMinutes} * * * *` };
+}
+function createNetlifyWorkflowSweepHandler(options) {
+	return async (request) => {
+		const now = options.now?.() ?? Date.now();
+		const materialized = options.materializeSchedules === false ? [] : await (0, _tanstack_workflow_runtime.materializeWorkflowSchedules)(options.runtime, {
+			now,
+			cronLookbackMs: options.cronLookbackMs
+		});
+		const leaseOwner = resolveLeaseOwner(options.leaseOwner, request, now);
+		const sweepArgs = {
+			now,
+			leaseOwner,
+			limit: options.limit,
+			maxScheduledRuns: options.maxScheduledRuns,
+			maxTimers: options.maxTimers,
+			maxDurationMs: options.maxDurationMs,
+			leaseMs: options.leaseMs,
+			includeEvents: options.includeEvents ?? false,
+			maxEvents: options.maxEvents
+		};
+		const sweep = await options.runtime.sweep(sweepArgs);
+		const response = {
+			ok: true,
+			now,
+			leaseOwner,
+			materialized,
+			summary: {
+				materialized: materialized.length,
+				...sweep.summary
+			},
+			deadlineReached: sweep.deadlineReached,
+			remainingMayExist: sweep.remainingMayExist,
+			...options.includeSweepResult ? { sweep } : void 0
+		};
+		return Response.json(response);
+	};
+}
+function resolveLeaseOwner(leaseOwner, request, now) {
+	if (typeof leaseOwner === "string") return leaseOwner;
+	if (typeof leaseOwner === "function") return leaseOwner({
+		request,
+		now
+	}) ?? defaultLeaseOwner(request, now);
+	return defaultLeaseOwner(request, now);
+}
+function defaultLeaseOwner(request, now) {
+	return `netlify:${request.headers.get("x-nf-request-id") ?? now}`;
+}
+
+//#endregion
+exports.createNetlifyWorkflowSweepConfig = createNetlifyWorkflowSweepConfig;
+exports.createNetlifyWorkflowSweepHandler = createNetlifyWorkflowSweepHandler;
+exports.netlifyWorkflowSweepConfig = netlifyWorkflowSweepConfig;
+//# sourceMappingURL=sweep-handler.cjs.map

package/dist/sweep-handler.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sweep-handler.cjs","names":[],"sources":["../src/sweep-handler.ts"],"sourcesContent":["import { materializeWorkflowSchedules } from '@tanstack/workflow-runtime'\nimport type {\n  MaterializedWorkflowSchedule,\n  WorkflowRegistrationMap,\n  WorkflowRuntimeDefinition,\n  WorkflowRuntimeSweepArgs,\n  WorkflowRuntimeSweepResult,\n} from '@tanstack/workflow-runtime'\n\nconst DEFAULT_SWEEP_INTERVAL_MINUTES = 5\n\nexport { materializeWorkflowSchedules }\nexport type {\n  MaterializedWorkflowSchedule,\n  MaterializeWorkflowSchedulesOptions,\n} from '@tanstack/workflow-runtime'\n\nexport interface NetlifyWorkflowSweepConfig {\n  schedule: string\n}\n\nexport interface NetlifyWorkflowSweepConfigOptions {\n  schedule?: string\n  everyMinutes?: number\n}\n\nexport interface NetlifyWorkflowSweepResponse {\n  ok: true\n  now: number\n  leaseOwner: string\n  materialized: ReadonlyArray<MaterializedWorkflowSchedule>\n  summary: NetlifyWorkflowSweepSummary\n  deadlineReached: boolean\n  remainingMayExist: boolean\n  sweep?: WorkflowRuntimeSweepResult\n}\n\nexport type NetlifyWorkflowSweepSummary =\n  WorkflowRuntimeSweepResult['summary'] & {\n    materialized: number\n  }\n\nexport type NetlifyWorkflowSweepHandler = (\n  request: Request,\n) => Promise<Response>\n\nexport interface NetlifyWorkflowSweepHandlerOptions<\n  TWorkflows extends WorkflowRegistrationMap = WorkflowRegistrationMap,\n> {\n  runtime: WorkflowRuntimeDefinition<TWorkflows>\n  now?: () => number\n  leaseOwner?:\n    | string\n    | ((args: { request: Request; now: number }) => string | undefined)\n  limit?: number\n  maxScheduledRuns?: number\n  maxTimers?: number\n  maxDurationMs?: number\n  leaseMs?: number\n  includeEvents?: boolean\n  maxEvents?: number\n  includeSweepResult?: boolean\n  materializeSchedules?: boolean\n  cronLookbackMs?: number\n}\n\nexport const netlifyWorkflowSweepConfig = createNetlifyWorkflowSweepConfig()\n\nexport function createNetlifyWorkflowSweepConfig(\n  options: NetlifyWorkflowSweepConfigOptions = {},\n): NetlifyWorkflowSweepConfig {\n  if (options.schedule) return { schedule: options.schedule }\n\n  const everyMinutes = options.everyMinutes ?? DEFAULT_SWEEP_INTERVAL_MINUTES\n  if (!Number.isInteger(everyMinutes) || everyMinutes <= 0) {\n    throw new Error(\n      'Netlify workflow sweep interval must be a positive integer.',\n    )\n  }\n\n  return {\n    schedule: everyMinutes === 1 ? '* * * * *' : `*/${everyMinutes} * * * *`,\n  }\n}\n\nexport function createNetlifyWorkflowSweepHandler<\n  TWorkflows extends WorkflowRegistrationMap,\n>(\n  options: NetlifyWorkflowSweepHandlerOptions<TWorkflows>,\n): NetlifyWorkflowSweepHandler {\n  return async (request) => {\n    const now = options.now?.() ?? Date.now()\n    const materialized =\n      options.materializeSchedules === false\n        ? []\n        : await materializeWorkflowSchedules(options.runtime, {\n            now,\n            cronLookbackMs: options.cronLookbackMs,\n          })\n    const leaseOwner = resolveLeaseOwner(options.leaseOwner, request, now)\n    const sweepArgs: WorkflowRuntimeSweepArgs = {\n      now,\n      leaseOwner,\n      limit: options.limit,\n      maxScheduledRuns: options.maxScheduledRuns,\n      maxTimers: options.maxTimers,\n      maxDurationMs: options.maxDurationMs,\n      leaseMs: options.leaseMs,\n      includeEvents: options.includeEvents ?? false,\n      maxEvents: options.maxEvents,\n    }\n    const sweep = await options.runtime.sweep(sweepArgs)\n    const response: NetlifyWorkflowSweepResponse = {\n      ok: true,\n      now,\n      leaseOwner,\n      materialized,\n      summary: {\n        materialized: materialized.length,\n        ...sweep.summary,\n      },\n      deadlineReached: sweep.deadlineReached,\n      remainingMayExist: sweep.remainingMayExist,\n      ...(options.includeSweepResult ? { sweep } : undefined),\n    }\n\n    return Response.json(response)\n  }\n}\n\nfunction resolveLeaseOwner(\n  leaseOwner: NetlifyWorkflowSweepHandlerOptions['leaseOwner'],\n  request: Request,\n  now: number,\n) {\n  if (typeof leaseOwner === 'string') return leaseOwner\n  if (typeof leaseOwner === 'function') {\n    return leaseOwner({ request, now }) ?? defaultLeaseOwner(request, now)\n  }\n  return defaultLeaseOwner(request, now)\n}\n\nfunction defaultLeaseOwner(request: Request, now: number) {\n  return `netlify:${request.headers.get('x-nf-request-id') ?? now}`\n}\n"],"mappings":";;;AASA,MAAM,iCAAiC;AAyDvC,MAAa,6BAA6B,kCAAkC;AAE5E,SAAgB,iCACd,UAA6C,EAAE,EACnB;AAC5B,KAAI,QAAQ,SAAU,QAAO,EAAE,UAAU,QAAQ,UAAU;CAE3D,MAAM,eAAe,QAAQ,gBAAgB;AAC7C,KAAI,CAAC,OAAO,UAAU,aAAa,IAAI,gBAAgB,EACrD,OAAM,IAAI,MACR,8DACD;AAGH,QAAO,EACL,UAAU,iBAAiB,IAAI,cAAc,KAAK,aAAa,WAChE;;AAGH,SAAgB,kCAGd,SAC6B;AAC7B,QAAO,OAAO,YAAY;EACxB,MAAM,MAAM,QAAQ,OAAO,IAAI,KAAK,KAAK;EACzC,MAAM,eACJ,QAAQ,yBAAyB,QAC7B,EAAE,GACF,mEAAmC,QAAQ,SAAS;GAClD;GACA,gBAAgB,QAAQ;GACzB,CAAC;EACR,MAAM,aAAa,kBAAkB,QAAQ,YAAY,SAAS,IAAI;EACtE,MAAM,YAAsC;GAC1C;GACA;GACA,OAAO,QAAQ;GACf,kBAAkB,QAAQ;GAC1B,WAAW,QAAQ;GACnB,eAAe,QAAQ;GACvB,SAAS,QAAQ;GACjB,eAAe,QAAQ,iBAAiB;GACxC,WAAW,QAAQ;GACpB;EACD,MAAM,QAAQ,MAAM,QAAQ,QAAQ,MAAM,UAAU;EACpD,MAAM,WAAyC;GAC7C,IAAI;GACJ;GACA;GACA;GACA,SAAS;IACP,cAAc,aAAa;IAC3B,GAAG,MAAM;IACV;GACD,iBAAiB,MAAM;GACvB,mBAAmB,MAAM;GACzB,GAAI,QAAQ,qBAAqB,EAAE,OAAO,GAAG;GAC9C;AAED,SAAO,SAAS,KAAK,SAAS;;;AAIlC,SAAS,kBACP,YACA,SACA,KACA;AACA,KAAI,OAAO,eAAe,SAAU,QAAO;AAC3C,KAAI,OAAO,eAAe,WACxB,QAAO,WAAW;EAAE;EAAS;EAAK,CAAC,IAAI,kBAAkB,SAAS,IAAI;AAExE,QAAO,kBAAkB,SAAS,IAAI;;AAGxC,SAAS,kBAAkB,SAAkB,KAAa;AACxD,QAAO,WAAW,QAAQ,QAAQ,IAAI,kBAAkB,IAAI"}

package/dist/sweep-handler.d.cts

@@ -0,0 +1,48 @@
+import { MaterializeWorkflowSchedulesOptions, MaterializedWorkflowSchedule, MaterializedWorkflowSchedule as MaterializedWorkflowSchedule$1, WorkflowRegistrationMap, WorkflowRuntimeDefinition, WorkflowRuntimeSweepResult, materializeWorkflowSchedules } from "@tanstack/workflow-runtime";
+
+//#region src/sweep-handler.d.ts
+interface NetlifyWorkflowSweepConfig {
+  schedule: string;
+}
+interface NetlifyWorkflowSweepConfigOptions {
+  schedule?: string;
+  everyMinutes?: number;
+}
+interface NetlifyWorkflowSweepResponse {
+  ok: true;
+  now: number;
+  leaseOwner: string;
+  materialized: ReadonlyArray<MaterializedWorkflowSchedule>;
+  summary: NetlifyWorkflowSweepSummary;
+  deadlineReached: boolean;
+  remainingMayExist: boolean;
+  sweep?: WorkflowRuntimeSweepResult;
+}
+type NetlifyWorkflowSweepSummary = WorkflowRuntimeSweepResult['summary'] & {
+  materialized: number;
+};
+type NetlifyWorkflowSweepHandler = (request: Request) => Promise<Response>;
+interface NetlifyWorkflowSweepHandlerOptions<TWorkflows extends WorkflowRegistrationMap = WorkflowRegistrationMap> {
+  runtime: WorkflowRuntimeDefinition<TWorkflows>;
+  now?: () => number;
+  leaseOwner?: string | ((args: {
+    request: Request;
+    now: number;
+  }) => string | undefined);
+  limit?: number;
+  maxScheduledRuns?: number;
+  maxTimers?: number;
+  maxDurationMs?: number;
+  leaseMs?: number;
+  includeEvents?: boolean;
+  maxEvents?: number;
+  includeSweepResult?: boolean;
+  materializeSchedules?: boolean;
+  cronLookbackMs?: number;
+}
+declare const netlifyWorkflowSweepConfig: NetlifyWorkflowSweepConfig;
+declare function createNetlifyWorkflowSweepConfig(options?: NetlifyWorkflowSweepConfigOptions): NetlifyWorkflowSweepConfig;
+declare function createNetlifyWorkflowSweepHandler<TWorkflows extends WorkflowRegistrationMap>(options: NetlifyWorkflowSweepHandlerOptions<TWorkflows>): NetlifyWorkflowSweepHandler;
+//#endregion
+export { type MaterializeWorkflowSchedulesOptions, type MaterializedWorkflowSchedule$1 as MaterializedWorkflowSchedule, NetlifyWorkflowSweepConfig, NetlifyWorkflowSweepConfigOptions, NetlifyWorkflowSweepHandler, NetlifyWorkflowSweepHandlerOptions, NetlifyWorkflowSweepResponse, createNetlifyWorkflowSweepConfig, createNetlifyWorkflowSweepHandler, materializeWorkflowSchedules, netlifyWorkflowSweepConfig };
+//# sourceMappingURL=sweep-handler.d.cts.map

package/dist/sweep-handler.d.ts

@@ -0,0 +1,48 @@
+import { MaterializeWorkflowSchedulesOptions, MaterializedWorkflowSchedule, MaterializedWorkflowSchedule as MaterializedWorkflowSchedule$1, WorkflowRegistrationMap, WorkflowRuntimeDefinition, WorkflowRuntimeSweepResult, materializeWorkflowSchedules } from "@tanstack/workflow-runtime";
+
+//#region src/sweep-handler.d.ts
+interface NetlifyWorkflowSweepConfig {
+  schedule: string;
+}
+interface NetlifyWorkflowSweepConfigOptions {
+  schedule?: string;
+  everyMinutes?: number;
+}
+interface NetlifyWorkflowSweepResponse {
+  ok: true;
+  now: number;
+  leaseOwner: string;
+  materialized: ReadonlyArray<MaterializedWorkflowSchedule>;
+  summary: NetlifyWorkflowSweepSummary;
+  deadlineReached: boolean;
+  remainingMayExist: boolean;
+  sweep?: WorkflowRuntimeSweepResult;
+}
+type NetlifyWorkflowSweepSummary = WorkflowRuntimeSweepResult['summary'] & {
+  materialized: number;
+};
+type NetlifyWorkflowSweepHandler = (request: Request) => Promise<Response>;
+interface NetlifyWorkflowSweepHandlerOptions<TWorkflows extends WorkflowRegistrationMap = WorkflowRegistrationMap> {
+  runtime: WorkflowRuntimeDefinition<TWorkflows>;
+  now?: () => number;
+  leaseOwner?: string | ((args: {
+    request: Request;
+    now: number;
+  }) => string | undefined);
+  limit?: number;
+  maxScheduledRuns?: number;
+  maxTimers?: number;
+  maxDurationMs?: number;
+  leaseMs?: number;
+  includeEvents?: boolean;
+  maxEvents?: number;
+  includeSweepResult?: boolean;
+  materializeSchedules?: boolean;
+  cronLookbackMs?: number;
+}
+declare const netlifyWorkflowSweepConfig: NetlifyWorkflowSweepConfig;
+declare function createNetlifyWorkflowSweepConfig(options?: NetlifyWorkflowSweepConfigOptions): NetlifyWorkflowSweepConfig;
+declare function createNetlifyWorkflowSweepHandler<TWorkflows extends WorkflowRegistrationMap>(options: NetlifyWorkflowSweepHandlerOptions<TWorkflows>): NetlifyWorkflowSweepHandler;
+//#endregion
+export { type MaterializeWorkflowSchedulesOptions, type MaterializedWorkflowSchedule$1 as MaterializedWorkflowSchedule, NetlifyWorkflowSweepConfig, NetlifyWorkflowSweepConfigOptions, NetlifyWorkflowSweepHandler, NetlifyWorkflowSweepHandlerOptions, NetlifyWorkflowSweepResponse, createNetlifyWorkflowSweepConfig, createNetlifyWorkflowSweepHandler, materializeWorkflowSchedules, netlifyWorkflowSweepConfig };
+//# sourceMappingURL=sweep-handler.d.ts.map

package/dist/sweep-handler.js

@@ -0,0 +1,62 @@
+import { materializeWorkflowSchedules } from "@tanstack/workflow-runtime";
+
+//#region src/sweep-handler.ts
+const DEFAULT_SWEEP_INTERVAL_MINUTES = 5;
+const netlifyWorkflowSweepConfig = createNetlifyWorkflowSweepConfig();
+function createNetlifyWorkflowSweepConfig(options = {}) {
+	if (options.schedule) return { schedule: options.schedule };
+	const everyMinutes = options.everyMinutes ?? DEFAULT_SWEEP_INTERVAL_MINUTES;
+	if (!Number.isInteger(everyMinutes) || everyMinutes <= 0) throw new Error("Netlify workflow sweep interval must be a positive integer.");
+	return { schedule: everyMinutes === 1 ? "* * * * *" : `*/${everyMinutes} * * * *` };
+}
+function createNetlifyWorkflowSweepHandler(options) {
+	return async (request) => {
+		const now = options.now?.() ?? Date.now();
+		const materialized = options.materializeSchedules === false ? [] : await materializeWorkflowSchedules(options.runtime, {
+			now,
+			cronLookbackMs: options.cronLookbackMs
+		});
+		const leaseOwner = resolveLeaseOwner(options.leaseOwner, request, now);
+		const sweepArgs = {
+			now,
+			leaseOwner,
+			limit: options.limit,
+			maxScheduledRuns: options.maxScheduledRuns,
+			maxTimers: options.maxTimers,
+			maxDurationMs: options.maxDurationMs,
+			leaseMs: options.leaseMs,
+			includeEvents: options.includeEvents ?? false,
+			maxEvents: options.maxEvents
+		};
+		const sweep = await options.runtime.sweep(sweepArgs);
+		const response = {
+			ok: true,
+			now,
+			leaseOwner,
+			materialized,
+			summary: {
+				materialized: materialized.length,
+				...sweep.summary
+			},
+			deadlineReached: sweep.deadlineReached,
+			remainingMayExist: sweep.remainingMayExist,
+			...options.includeSweepResult ? { sweep } : void 0
+		};
+		return Response.json(response);
+	};
+}
+function resolveLeaseOwner(leaseOwner, request, now) {
+	if (typeof leaseOwner === "string") return leaseOwner;
+	if (typeof leaseOwner === "function") return leaseOwner({
+		request,
+		now
+	}) ?? defaultLeaseOwner(request, now);
+	return defaultLeaseOwner(request, now);
+}
+function defaultLeaseOwner(request, now) {
+	return `netlify:${request.headers.get("x-nf-request-id") ?? now}`;
+}
+
+//#endregion
+export { createNetlifyWorkflowSweepConfig, createNetlifyWorkflowSweepHandler, materializeWorkflowSchedules, netlifyWorkflowSweepConfig };
+//# sourceMappingURL=sweep-handler.js.map

package/dist/sweep-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sweep-handler.js","names":[],"sources":["../src/sweep-handler.ts"],"sourcesContent":["import { materializeWorkflowSchedules } from '@tanstack/workflow-runtime'\nimport type {\n  MaterializedWorkflowSchedule,\n  WorkflowRegistrationMap,\n  WorkflowRuntimeDefinition,\n  WorkflowRuntimeSweepArgs,\n  WorkflowRuntimeSweepResult,\n} from '@tanstack/workflow-runtime'\n\nconst DEFAULT_SWEEP_INTERVAL_MINUTES = 5\n\nexport { materializeWorkflowSchedules }\nexport type {\n  MaterializedWorkflowSchedule,\n  MaterializeWorkflowSchedulesOptions,\n} from '@tanstack/workflow-runtime'\n\nexport interface NetlifyWorkflowSweepConfig {\n  schedule: string\n}\n\nexport interface NetlifyWorkflowSweepConfigOptions {\n  schedule?: string\n  everyMinutes?: number\n}\n\nexport interface NetlifyWorkflowSweepResponse {\n  ok: true\n  now: number\n  leaseOwner: string\n  materialized: ReadonlyArray<MaterializedWorkflowSchedule>\n  summary: NetlifyWorkflowSweepSummary\n  deadlineReached: boolean\n  remainingMayExist: boolean\n  sweep?: WorkflowRuntimeSweepResult\n}\n\nexport type NetlifyWorkflowSweepSummary =\n  WorkflowRuntimeSweepResult['summary'] & {\n    materialized: number\n  }\n\nexport type NetlifyWorkflowSweepHandler = (\n  request: Request,\n) => Promise<Response>\n\nexport interface NetlifyWorkflowSweepHandlerOptions<\n  TWorkflows extends WorkflowRegistrationMap = WorkflowRegistrationMap,\n> {\n  runtime: WorkflowRuntimeDefinition<TWorkflows>\n  now?: () => number\n  leaseOwner?:\n    | string\n    | ((args: { request: Request; now: number }) => string | undefined)\n  limit?: number\n  maxScheduledRuns?: number\n  maxTimers?: number\n  maxDurationMs?: number\n  leaseMs?: number\n  includeEvents?: boolean\n  maxEvents?: number\n  includeSweepResult?: boolean\n  materializeSchedules?: boolean\n  cronLookbackMs?: number\n}\n\nexport const netlifyWorkflowSweepConfig = createNetlifyWorkflowSweepConfig()\n\nexport function createNetlifyWorkflowSweepConfig(\n  options: NetlifyWorkflowSweepConfigOptions = {},\n): NetlifyWorkflowSweepConfig {\n  if (options.schedule) return { schedule: options.schedule }\n\n  const everyMinutes = options.everyMinutes ?? DEFAULT_SWEEP_INTERVAL_MINUTES\n  if (!Number.isInteger(everyMinutes) || everyMinutes <= 0) {\n    throw new Error(\n      'Netlify workflow sweep interval must be a positive integer.',\n    )\n  }\n\n  return {\n    schedule: everyMinutes === 1 ? '* * * * *' : `*/${everyMinutes} * * * *`,\n  }\n}\n\nexport function createNetlifyWorkflowSweepHandler<\n  TWorkflows extends WorkflowRegistrationMap,\n>(\n  options: NetlifyWorkflowSweepHandlerOptions<TWorkflows>,\n): NetlifyWorkflowSweepHandler {\n  return async (request) => {\n    const now = options.now?.() ?? Date.now()\n    const materialized =\n      options.materializeSchedules === false\n        ? []\n        : await materializeWorkflowSchedules(options.runtime, {\n            now,\n            cronLookbackMs: options.cronLookbackMs,\n          })\n    const leaseOwner = resolveLeaseOwner(options.leaseOwner, request, now)\n    const sweepArgs: WorkflowRuntimeSweepArgs = {\n      now,\n      leaseOwner,\n      limit: options.limit,\n      maxScheduledRuns: options.maxScheduledRuns,\n      maxTimers: options.maxTimers,\n      maxDurationMs: options.maxDurationMs,\n      leaseMs: options.leaseMs,\n      includeEvents: options.includeEvents ?? false,\n      maxEvents: options.maxEvents,\n    }\n    const sweep = await options.runtime.sweep(sweepArgs)\n    const response: NetlifyWorkflowSweepResponse = {\n      ok: true,\n      now,\n      leaseOwner,\n      materialized,\n      summary: {\n        materialized: materialized.length,\n        ...sweep.summary,\n      },\n      deadlineReached: sweep.deadlineReached,\n      remainingMayExist: sweep.remainingMayExist,\n      ...(options.includeSweepResult ? { sweep } : undefined),\n    }\n\n    return Response.json(response)\n  }\n}\n\nfunction resolveLeaseOwner(\n  leaseOwner: NetlifyWorkflowSweepHandlerOptions['leaseOwner'],\n  request: Request,\n  now: number,\n) {\n  if (typeof leaseOwner === 'string') return leaseOwner\n  if (typeof leaseOwner === 'function') {\n    return leaseOwner({ request, now }) ?? defaultLeaseOwner(request, now)\n  }\n  return defaultLeaseOwner(request, now)\n}\n\nfunction defaultLeaseOwner(request: Request, now: number) {\n  return `netlify:${request.headers.get('x-nf-request-id') ?? now}`\n}\n"],"mappings":";;;AASA,MAAM,iCAAiC;AAyDvC,MAAa,6BAA6B,kCAAkC;AAE5E,SAAgB,iCACd,UAA6C,EAAE,EACnB;AAC5B,KAAI,QAAQ,SAAU,QAAO,EAAE,UAAU,QAAQ,UAAU;CAE3D,MAAM,eAAe,QAAQ,gBAAgB;AAC7C,KAAI,CAAC,OAAO,UAAU,aAAa,IAAI,gBAAgB,EACrD,OAAM,IAAI,MACR,8DACD;AAGH,QAAO,EACL,UAAU,iBAAiB,IAAI,cAAc,KAAK,aAAa,WAChE;;AAGH,SAAgB,kCAGd,SAC6B;AAC7B,QAAO,OAAO,YAAY;EACxB,MAAM,MAAM,QAAQ,OAAO,IAAI,KAAK,KAAK;EACzC,MAAM,eACJ,QAAQ,yBAAyB,QAC7B,EAAE,GACF,MAAM,6BAA6B,QAAQ,SAAS;GAClD;GACA,gBAAgB,QAAQ;GACzB,CAAC;EACR,MAAM,aAAa,kBAAkB,QAAQ,YAAY,SAAS,IAAI;EACtE,MAAM,YAAsC;GAC1C;GACA;GACA,OAAO,QAAQ;GACf,kBAAkB,QAAQ;GAC1B,WAAW,QAAQ;GACnB,eAAe,QAAQ;GACvB,SAAS,QAAQ;GACjB,eAAe,QAAQ,iBAAiB;GACxC,WAAW,QAAQ;GACpB;EACD,MAAM,QAAQ,MAAM,QAAQ,QAAQ,MAAM,UAAU;EACpD,MAAM,WAAyC;GAC7C,IAAI;GACJ;GACA;GACA;GACA,SAAS;IACP,cAAc,aAAa;IAC3B,GAAG,MAAM;IACV;GACD,iBAAiB,MAAM;GACvB,mBAAmB,MAAM;GACzB,GAAI,QAAQ,qBAAqB,EAAE,OAAO,GAAG;GAC9C;AAED,SAAO,SAAS,KAAK,SAAS;;;AAIlC,SAAS,kBACP,YACA,SACA,KACA;AACA,KAAI,OAAO,eAAe,SAAU,QAAO;AAC3C,KAAI,OAAO,eAAe,WACxB,QAAO,WAAW;EAAE;EAAS;EAAK,CAAC,IAAI,kBAAkB,SAAS,IAAI;AAExE,QAAO,kBAAkB,SAAS,IAAI;;AAGxC,SAAS,kBAAkB,SAAkB,KAAa;AACxD,QAAO,WAAW,QAAQ,QAAQ,IAAI,kBAAkB,IAAI"}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@tanstack/workflow-netlify",
+  "version": "0.0.1",
+  "description": "Netlify host adapter for TanStack Workflow runtimes.",
+  "author": "Tanner Linsley",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TanStack/workflow.git",
+    "directory": "packages/workflow-netlify"
+  },
+  "homepage": "https://tanstack.com/workflow",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/tannerlinsley"
+  },
+  "keywords": [
+    "tanstack",
+    "workflow",
+    "durable-execution",
+    "netlify",
+    "serverless"
+  ],
+  "scripts": {
+    "clean": "premove ./build ./dist",
+    "lint": "eslint ./src",
+    "lint:fix": "eslint ./src --fix",
+    "test:eslint": "eslint ./src",
+    "test:lib": "vitest",
+    "test:lib:dev": "pnpm test:lib --watch",
+    "test:types": "tsc",
+    "build": "tsdown"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist/",
+    "src"
+  ],
+  "dependencies": {
+    "@tanstack/workflow-runtime": "workspace:*"
+  }
+}

package/src/index.ts

@@ -0,0 +1,15 @@
+export {
+  createNetlifyWorkflowSweepConfig,
+  createNetlifyWorkflowSweepHandler,
+  materializeWorkflowSchedules,
+  netlifyWorkflowSweepConfig,
+} from './sweep-handler'
+export type {
+  MaterializedWorkflowSchedule,
+  MaterializeWorkflowSchedulesOptions,
+  NetlifyWorkflowSweepConfig,
+  NetlifyWorkflowSweepConfigOptions,
+  NetlifyWorkflowSweepHandler,
+  NetlifyWorkflowSweepHandlerOptions,
+  NetlifyWorkflowSweepResponse,
+} from './sweep-handler'

package/src/sweep-handler.ts

@@ -0,0 +1,145 @@
+import { materializeWorkflowSchedules } from '@tanstack/workflow-runtime'
+import type {
+  MaterializedWorkflowSchedule,
+  WorkflowRegistrationMap,
+  WorkflowRuntimeDefinition,
+  WorkflowRuntimeSweepArgs,
+  WorkflowRuntimeSweepResult,
+} from '@tanstack/workflow-runtime'
+
+const DEFAULT_SWEEP_INTERVAL_MINUTES = 5
+
+export { materializeWorkflowSchedules }
+export type {
+  MaterializedWorkflowSchedule,
+  MaterializeWorkflowSchedulesOptions,
+} from '@tanstack/workflow-runtime'
+
+export interface NetlifyWorkflowSweepConfig {
+  schedule: string
+}
+
+export interface NetlifyWorkflowSweepConfigOptions {
+  schedule?: string
+  everyMinutes?: number
+}
+
+export interface NetlifyWorkflowSweepResponse {
+  ok: true
+  now: number
+  leaseOwner: string
+  materialized: ReadonlyArray<MaterializedWorkflowSchedule>
+  summary: NetlifyWorkflowSweepSummary
+  deadlineReached: boolean
+  remainingMayExist: boolean
+  sweep?: WorkflowRuntimeSweepResult
+}
+
+export type NetlifyWorkflowSweepSummary =
+  WorkflowRuntimeSweepResult['summary'] & {
+    materialized: number
+  }
+
+export type NetlifyWorkflowSweepHandler = (
+  request: Request,
+) => Promise<Response>
+
+export interface NetlifyWorkflowSweepHandlerOptions<
+  TWorkflows extends WorkflowRegistrationMap = WorkflowRegistrationMap,
+> {
+  runtime: WorkflowRuntimeDefinition<TWorkflows>
+  now?: () => number
+  leaseOwner?:
+    | string
+    | ((args: { request: Request; now: number }) => string | undefined)
+  limit?: number
+  maxScheduledRuns?: number
+  maxTimers?: number
+  maxDurationMs?: number
+  leaseMs?: number
+  includeEvents?: boolean
+  maxEvents?: number
+  includeSweepResult?: boolean
+  materializeSchedules?: boolean
+  cronLookbackMs?: number
+}
+
+export const netlifyWorkflowSweepConfig = createNetlifyWorkflowSweepConfig()
+
+export function createNetlifyWorkflowSweepConfig(
+  options: NetlifyWorkflowSweepConfigOptions = {},
+): NetlifyWorkflowSweepConfig {
+  if (options.schedule) return { schedule: options.schedule }
+
+  const everyMinutes = options.everyMinutes ?? DEFAULT_SWEEP_INTERVAL_MINUTES
+  if (!Number.isInteger(everyMinutes) || everyMinutes <= 0) {
+    throw new Error(
+      'Netlify workflow sweep interval must be a positive integer.',
+    )
+  }
+
+  return {
+    schedule: everyMinutes === 1 ? '* * * * *' : `*/${everyMinutes} * * * *`,
+  }
+}
+
+export function createNetlifyWorkflowSweepHandler<
+  TWorkflows extends WorkflowRegistrationMap,
+>(
+  options: NetlifyWorkflowSweepHandlerOptions<TWorkflows>,
+): NetlifyWorkflowSweepHandler {
+  return async (request) => {
+    const now = options.now?.() ?? Date.now()
+    const materialized =
+      options.materializeSchedules === false
+        ? []
+        : await materializeWorkflowSchedules(options.runtime, {
+            now,
+            cronLookbackMs: options.cronLookbackMs,
+          })
+    const leaseOwner = resolveLeaseOwner(options.leaseOwner, request, now)
+    const sweepArgs: WorkflowRuntimeSweepArgs = {
+      now,
+      leaseOwner,
+      limit: options.limit,
+      maxScheduledRuns: options.maxScheduledRuns,
+      maxTimers: options.maxTimers,
+      maxDurationMs: options.maxDurationMs,
+      leaseMs: options.leaseMs,
+      includeEvents: options.includeEvents ?? false,
+      maxEvents: options.maxEvents,
+    }
+    const sweep = await options.runtime.sweep(sweepArgs)
+    const response: NetlifyWorkflowSweepResponse = {
+      ok: true,
+      now,
+      leaseOwner,
+      materialized,
+      summary: {
+        materialized: materialized.length,
+        ...sweep.summary,
+      },
+      deadlineReached: sweep.deadlineReached,
+      remainingMayExist: sweep.remainingMayExist,
+      ...(options.includeSweepResult ? { sweep } : undefined),
+    }
+
+    return Response.json(response)
+  }
+}
+
+function resolveLeaseOwner(
+  leaseOwner: NetlifyWorkflowSweepHandlerOptions['leaseOwner'],
+  request: Request,
+  now: number,
+) {
+  if (typeof leaseOwner === 'string') return leaseOwner
+  if (typeof leaseOwner === 'function') {
+    return leaseOwner({ request, now }) ?? defaultLeaseOwner(request, now)
+  }
+  return defaultLeaseOwner(request, now)
+}
+
+function defaultLeaseOwner(request: Request, now: number) {
+  return `netlify:${request.headers.get('x-nf-request-id') ?? now}`
+}