@lowdefy/api 5.6.0 → 6.0.0

package/dist/routes/endpoints/handleRenderNotification.js

@@ -0,0 +1,189 @@
+/*
+  Copyright 2020-2026 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/ import { validate } from '@lowdefy/ajv';
+import { ConfigError } from '@lowdefy/errors';
+import { type } from '@lowdefy/helpers';
+import addStepResult from './addStepResult.js';
+import derivePreview from '../notifications/derivePreview.js';
+import getNotificationConfig from '../notifications/getNotificationConfig.js';
+import resolveNotificationLinks from '../notifications/resolveNotificationLinks.js';
+import resolveThemeLogo from '../notifications/resolveThemeLogo.js';
+function itemHasPageLinks(item, dataKeys) {
+    const links = Object.values(item.links ?? {});
+    const arrayLinks = dataKeys.flatMap((key)=>(type.isArray(item[key]) ? item[key] : []).map((entry)=>entry?.link));
+    return [
+        ...links,
+        ...arrayLinks
+    ].some((link)=>type.isObject(link) && !type.isNone(link.pageId));
+}
+async function handleRenderNotification(context, routineContext, { step }) {
+    const { logger, evaluateOperators } = context;
+    logger.debug({
+        event: 'debug_start_render_notification',
+        step
+    });
+    const evaluatedProperties = evaluateOperators({
+        input: step.properties,
+        items: routineContext.items,
+        location: step.stepId,
+        payload: routineContext.payload,
+        state: routineContext.state,
+        steps: routineContext.steps
+    });
+    const { notificationId, data, landingPage, recordId } = evaluatedProperties;
+    let { serverUrl } = evaluatedProperties;
+    if (!type.isString(notificationId)) {
+        throw new ConfigError(`RenderNotification step "${step.stepId}" properties.notificationId must evaluate to a string. Received ${JSON.stringify(notificationId)}.`, {
+            configKey: step['~k']
+        });
+    }
+    if (type.isArray(data)) {
+        throw new ConfigError(`RenderNotification step "${step.stepId}" properties.data must evaluate to an object. Received an array — iterate with a ":for" control and render one item per step.`, {
+            configKey: step['~k']
+        });
+    }
+    if (!type.isObject(data)) {
+        throw new ConfigError(`RenderNotification step "${step.stepId}" properties.data must evaluate to an object. Received ${JSON.stringify(data)}.`, {
+            configKey: step['~k']
+        });
+    }
+    if (!type.isNone(serverUrl)) {
+        if (!type.isString(serverUrl) || serverUrl === '') {
+            throw new ConfigError(`RenderNotification step "${step.stepId}" properties.serverUrl must evaluate to a non-empty string. Received ${JSON.stringify(serverUrl)}.`, {
+                configKey: step['~k']
+            });
+        }
+        serverUrl = serverUrl.replace(/\/$/, '');
+    }
+    if (!type.isNone(landingPage) && !type.isString(landingPage)) {
+        throw new ConfigError(`RenderNotification step "${step.stepId}" properties.landingPage must evaluate to a string. Received ${JSON.stringify(landingPage)}.`, {
+            configKey: step['~k']
+        });
+    }
+    if (!type.isNone(recordId) && !type.isString(recordId)) {
+        throw new ConfigError(`RenderNotification step "${step.stepId}" properties.recordId must evaluate to a string. Received ${JSON.stringify(recordId)}.`, {
+            configKey: step['~k']
+        });
+    }
+    const notificationConfig = await getNotificationConfig(context, {
+        notificationId,
+        configKey: step['~k']
+    });
+    const configKey = notificationConfig['~k'];
+    const Template = context.notifications[notificationConfig.type];
+    if (!Template) {
+        throw new ConfigError(`Notification template type "${notificationConfig.type}" can not be found.`, {
+            configKey
+        });
+    }
+    const { renderEmail, interpolateProperties } = context;
+    if (!type.isFunction(renderEmail) || !type.isFunction(interpolateProperties)) {
+        // plugins/notifications.js exports real implementations whenever the app
+        // has notifications built — reaching this means the build artifact and
+        // config are out of sync.
+        throw new ConfigError('Email rendering is not available. Rebuild the app — @lowdefy/email-templates is installed when "notifications:" is configured.', {
+            configKey
+        });
+    }
+    const app = await context.readConfigFile('app.json') ?? {};
+    const basePath = context.config?.basePath ?? '';
+    // Resolve after the merge so a per-notification theme.logo override also
+    // resolves; precedence stays notification theme over app.email.
+    const theme = resolveThemeLogo({
+        theme: {
+            ...app.email ?? {},
+            ...notificationConfig.theme ?? {}
+        },
+        serverUrl,
+        basePath
+    });
+    if (itemHasPageLinks(data, Template.dataKeys ?? [])) {
+        if (type.isNone(serverUrl)) {
+            throw new ConfigError(`Notification "${notificationId}" has links but no server URL is available. Set the serverUrl step property.`, {
+                configKey: step['~k']
+            });
+        }
+        // Landing URLs embed the record id — without it the landing page cannot
+        // resolve the record and every link in the email would be dead.
+        if (!type.isNone(landingPage) && type.isNone(recordId)) {
+            throw new ConfigError(`RenderNotification step "${step.stepId}" properties.landingPage requires properties.recordId to compose landing URLs.`, {
+                configKey: step['~k']
+            });
+        }
+    }
+    const resolvedItem = resolveNotificationLinks({
+        item: data,
+        dataKeys: Template.dataKeys ?? [],
+        serverUrl: serverUrl ?? '',
+        basePath,
+        landingPage,
+        recordId
+    });
+    let interpolated;
+    try {
+        interpolated = interpolateProperties({
+            properties: notificationConfig.properties,
+            data: resolvedItem,
+            markdownProperties: Template.markdownProperties ?? []
+        });
+    } catch (error) {
+        throw new ConfigError(`Notification "${notificationId}" template interpolation failed: ${error.message}`, {
+            configKey,
+            cause: error
+        });
+    }
+    if (Template.schema) {
+        const { valid, errors } = validate({
+            schema: Template.schema,
+            data: interpolated,
+            returnErrors: true
+        });
+        if (!valid) {
+            throw new ConfigError(`Notification "${notificationId}" properties do not match template "${notificationConfig.type}" schema: ${errors?.[0]?.message}.`, {
+                configKey
+            });
+        }
+    }
+    const { html, text } = await renderEmail({
+        Template,
+        properties: interpolated,
+        data: resolvedItem,
+        theme,
+        links: resolvedItem.links ?? {}
+    });
+    const result = {
+        subject: interpolated.subject,
+        title: interpolated.title ?? interpolated.subject,
+        preview: derivePreview({
+            properties: interpolated
+        }),
+        html,
+        text,
+        data: resolvedItem
+    };
+    addStepResult(context, routineContext, {
+        result,
+        stepId: step.stepId
+    });
+    logger.debug({
+        event: 'debug_end_render_notification',
+        stepId: step.stepId,
+        notificationId
+    });
+    return {
+        status: 'continue'
+    };
+}
+export default handleRenderNotification;

package/dist/routes/endpoints/handleValidateSchema.js

@@ -51,10 +51,12 @@ async function handleValidateSchema(context, routineContext, { step }) {
         const error = new Error(buildErrorMessage(result.errors, step.stepId), {
             cause: result.errors
         });
+        // Log under `err` — see controlThrow: only the `err` key runs the pino error
+        // serializer, so `error` would drop the message from the log line.
         logger.error({
             event: 'error_validate_schema',
             stepId: step.stepId,
-            error
+            err: error
         });
         return {
             status: 'error',

package/dist/routes/endpoints/isUnauthenticatedHuman.js

@@ -0,0 +1,31 @@
+/*
+  Copyright 2020-2026 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/ import { type } from '@lowdefy/helpers';
+// True for a session-less caller on an app that has auth configured, outside a
+// system run. This is the one caller who must get the same answer for a missing
+// id as for a protected one - "authenticate" - or a logged-out client can
+// enumerate endpoint ids by response difference (500/does-not-exist for a miss
+// versus 401 for a protected id). "No user" is not enough on its own: it is also
+// "no auth in this app" and "the engine talking to itself" (scheduled, webhook
+// and detached runs), and neither should be told to authenticate against
+// nothing. auth.json is a build artifact the build always writes.
+async function isUnauthenticatedHuman({ readConfigFile, system, user }) {
+    if (!type.isNone(user) || system === true) {
+        return false;
+    }
+    const authConfig = await readConfigFile('auth.json');
+    return authConfig?.configured === true;
+}
+export default isUnauthenticatedHuman;

package/dist/routes/endpoints/resolveCronEnvironment.js

@@ -0,0 +1,37 @@
+/*
+  Copyright 2020-2026 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/ import { type } from '@lowdefy/helpers';
+import { ConfigError } from '@lowdefy/errors';
+// The environment a cron run resolves its schedules for. A forwarded request names it in the
+// x-lowdefy-cron-environment header; a request without one is the deployment running its own crons,
+// which is the environment declared without a url (the one Vercel fires crons on). Without
+// config.cron there are no environments and the endpoint's plain schedules apply.
+function resolveCronEnvironment({ config, environment }) {
+    const environments = config?.cron?.environments;
+    if (type.isNone(environments)) {
+        if (!type.isNone(environment)) {
+            throw new ConfigError(`Cron environment "${environment}" is not configured: lowdefy.config.cron.environments is not defined.`);
+        }
+        return undefined;
+    }
+    if (!type.isNone(environment)) {
+        if (!type.isObject(environments[environment])) {
+            throw new ConfigError(`Cron environment "${environment}" is not declared in lowdefy.config.cron.environments.`);
+        }
+        return environment;
+    }
+    return Object.keys(environments).find((name)=>type.isObject(environments[name]) && type.isUndefined(environments[name].url));
+}
+export default resolveCronEnvironment;

package/dist/routes/endpoints/runDetachedEndpoint.js

@@ -0,0 +1,66 @@
+/*
+  Copyright 2020-2026 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/ import { serializer } from '@lowdefy/helpers';
+import buildEndpointResult from '../../response/buildEndpointResult.js';
+import createAuthorize from '../../context/createAuthorize.js';
+import createEvaluateOperators from '../../context/createEvaluateOperators.js';
+import getEndpointConfig from './getEndpointConfig.js';
+import runRoutine from './runRoutine.js';
+// Runs an endpoint invoked through the detached route (a CallApi step with
+// `detached: true` fire-and-forgets an HTTP call back to the deployment, so the
+// target runs in its OWN function invocation with a fresh duration budget).
+// Like a cron run this is authorized by the transport layer (CRON_SECRET) and
+// executes as a system context: no user session, `_user` resolves to undefined,
+// and InternalApi endpoints are callable. Payload arrives serialized (dates
+// etc. survive the HTTP hop via @lowdefy/helpers serializer).
+async function runDetachedEndpoint(context, { endpointId, payload }) {
+    const { logger } = context;
+    context.endpointId = endpointId;
+    context.evaluateOperators = createEvaluateOperators(context);
+    logger.debug({
+        event: 'debug_detached_endpoint',
+        endpointId
+    });
+    const endpointConfig = await getEndpointConfig(context, {
+        endpointId
+    });
+    // Force a system context regardless of any session cookie sent with the request.
+    // system: true — nested CallApi steps are authorized like function calls (the run
+    // was already authorized at the transport layer), not re-gated on a user session.
+    context.session = undefined;
+    context.user = undefined;
+    context.system = true;
+    context.authorize = createAuthorize({
+        session: undefined,
+        system: true
+    });
+    const routineContext = {
+        steps: {},
+        payload: serializer.deserialize(payload ?? {}),
+        arrayIndices: [],
+        items: {},
+        state: {},
+        endpointDepth: 0
+    };
+    const { error, response, status } = await runRoutine(context, routineContext, {
+        routine: endpointConfig.routine
+    });
+    return buildEndpointResult(context, {
+        error,
+        response,
+        status
+    });
+}
+export default runDetachedEndpoint;

package/dist/routes/endpoints/runRoutine.js

@@ -13,8 +13,10 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 */ import { type } from '@lowdefy/helpers';
+import handleAgentCall from './handleAgentCall.js';
 import handleControl from './control/handleControl.js';
 import handleEndpointCall from './handleEndpointCall.js';
+import handleRenderNotification from './handleRenderNotification.js';
 import handleRequest from './handleRequest.js';
 import handleValidateSchema from './handleValidateSchema.js';
 async function runRoutine(context, routineContext, { routine }) {
@@ -35,6 +37,16 @@ async function runRoutine(context, routineContext, { routine }) {
                     step: routine
                 });
             }
+            if (routine.id?.startsWith?.('agent:')) {
+                return await handleAgentCall(context, routineContext, {
+                    step: routine
+                });
+            }
+            if (routine.id?.startsWith?.('notification:')) {
+                return await handleRenderNotification(context, routineContext, {
+                    step: routine
+                });
+            }
             return await handleControl(context, routineContext, {
                 control: routine
             });

package/dist/routes/endpoints/runScheduledEndpoint.js

@@ -0,0 +1,104 @@
+/*
+  Copyright 2020-2026 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/ import { serializer } from '@lowdefy/helpers';
+import createAuthorize from '../../context/createAuthorize.js';
+import buildEndpointResult from '../../response/buildEndpointResult.js';
+import createEvaluateOperators from '../../context/createEvaluateOperators.js';
+import findSchedule from './findSchedule.js';
+import getEndpointConfig from './getEndpointConfig.js';
+import getEnvironmentSchedules from './getEnvironmentSchedules.js';
+import resolveCronEnvironment from './resolveCronEnvironment.js';
+import runRoutine from './runRoutine.js';
+import scheduleBackground from './scheduleBackground.js';
+// Runs an endpoint routine on a schedule (cron). Unlike callEndpoint this does NOT check the
+// endpoint's `auth` config and does NOT block InternalApi: a cron run is authorized by the transport
+// layer (CRON_SECRET) plus the endpoint declaring the firing schedule, and runs as a system context
+// (no user session, so `_user` resolves to undefined). An InternalApi with schedules is therefore a
+// cron-only endpoint that is never client-callable.
+// `environment` (x-lowdefy-cron-environment, set on requests forwarded from the production
+// deployment) selects which environment's schedules apply; see resolveCronEnvironment.
+async function runScheduledEndpoint(context, { endpointId, cron, environment }) {
+    const { logger } = context;
+    context.endpointId = endpointId;
+    context.evaluateOperators = createEvaluateOperators(context);
+    const cronEnvironment = resolveCronEnvironment({
+        config: context.config,
+        environment
+    });
+    logger.debug({
+        event: 'debug_scheduled_endpoint',
+        endpointId,
+        cron,
+        environment: cronEnvironment
+    });
+    const endpointConfig = await getEndpointConfig(context, {
+        endpointId
+    });
+    const schedules = getEnvironmentSchedules({
+        endpointConfig,
+        environment: cronEnvironment
+    });
+    const schedule = findSchedule({
+        schedules,
+        cron,
+        endpointId,
+        environment: cronEnvironment
+    });
+    // Force a system context regardless of any session cookie sent with the request.
+    // system: true — nested CallApi steps are authorized like function calls (the run
+    // was already authorized at the transport layer), not re-gated on a user session.
+    context.session = undefined;
+    context.user = undefined;
+    context.system = true;
+    context.authorize = createAuthorize({
+        session: undefined,
+        system: true
+    });
+    const routineContext = {
+        steps: {},
+        payload: schedule.payload ?? {},
+        arrayIndices: [],
+        items: {},
+        state: {},
+        endpointDepth: 0
+    };
+    // async: true — acknowledge the cron trigger immediately and run in the
+    // background; transport auth (CRON_SECRET) already passed at the route.
+    if (endpointConfig.async === true) {
+        scheduleBackground(context, {
+            event: 'background_scheduled_endpoint',
+            endpointId
+        }, ()=>runRoutine(context, routineContext, {
+                routine: endpointConfig.routine
+            }));
+        return {
+            error: null,
+            response: serializer.serialize({
+                accepted: true
+            }),
+            status: 'accepted',
+            success: true
+        };
+    }
+    const { error, response, status } = await runRoutine(context, routineContext, {
+        routine: endpointConfig.routine
+    });
+    return buildEndpointResult(context, {
+        error,
+        response,
+        status
+    });
+}
+export default runScheduledEndpoint;

package/dist/routes/endpoints/runWebhookEndpoint.js

@@ -0,0 +1,83 @@
+/*
+  Copyright 2020-2026 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/ import { ConfigError } from '@lowdefy/errors';
+import buildEndpointResult from '../../response/buildEndpointResult.js';
+import createAuthorize from '../../context/createAuthorize.js';
+import createEvaluateOperators from '../../context/createEvaluateOperators.js';
+import getEndpointConfig from './getEndpointConfig.js';
+import runRoutine from './runRoutine.js';
+// Runs an endpoint declared `webhook: true` — a third-party webhook receiver
+// (SNS, Event Grid, Stripe, ...) served on the standard /api/endpoints route,
+// but taking the request RAW: bodies are the caller's own format, not
+// Lowdefy's { payload } envelope, so the routine receives
+// { body, query, headers } as its payload and its return value is sent back
+// verbatim (handshakes require exact response shapes). Only endpoints that
+// opt in are runnable here (a missing flag reads as a missing endpoint — no
+// probing). The transport is public by design: authenticating the caller
+// (shared-secret query param, signature header) is the webhook routine's own
+// first step. Executes as a system context.
+async function runWebhookEndpoint(context, { endpointId, body, query, headers }) {
+    const { logger } = context;
+    context.endpointId = endpointId;
+    context.evaluateOperators = createEvaluateOperators(context);
+    logger.debug({
+        event: 'debug_webhook_endpoint',
+        endpointId
+    });
+    const endpointConfig = await getEndpointConfig(context, {
+        endpointId
+    });
+    if (endpointConfig.webhook !== true) {
+        const err = new ConfigError(`API Endpoint "${endpointId}" does not exist.`);
+        logger.debug({
+            params: {
+                endpointId
+            },
+            err
+        }, err.message);
+        throw err;
+    }
+    // Force a system context regardless of any session cookie sent with the request.
+    // system: true — nested CallApi steps are authorized like function calls (the run
+    // was already authorized at the transport layer), not re-gated on a user session.
+    context.session = undefined;
+    context.user = undefined;
+    context.system = true;
+    context.authorize = createAuthorize({
+        session: undefined,
+        system: true
+    });
+    const routineContext = {
+        steps: {},
+        payload: {
+            body: body ?? null,
+            query: query ?? {},
+            headers: headers ?? {}
+        },
+        arrayIndices: [],
+        items: {},
+        state: {},
+        endpointDepth: 0
+    };
+    const { error, response, status } = await runRoutine(context, routineContext, {
+        routine: endpointConfig.routine
+    });
+    return buildEndpointResult(context, {
+        error,
+        response,
+        status
+    });
+}
+export default runWebhookEndpoint;

package/dist/routes/endpoints/scheduleBackground.js

@@ -0,0 +1,48 @@
+/*
+  Copyright 2020-2026 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/ // Run work after the response is sent. Platforms that reap the invocation once
+// the response is flushed (Vercel fluid compute) inject context.waitUntil in
+// their server's apiContext middleware to keep the invocation alive until the
+// promise settles (bounded by the function's maxDuration); locally /
+// self-hosted there is no waitUntil and the promise simply runs detached on
+// the still-alive Node process.
+//
+// The outcome only exists in logs — completion and failure are logged through
+// the request logger so they reach the platform log stream (and any log
+// drains); a background failure must never surface as an unhandled rejection.
+function scheduleBackground(context, { event, endpointId }, fn) {
+    const { logger } = context;
+    const promise = (async ()=>{
+        try {
+            const result = await fn();
+            logger.info({
+                event: `${event}_done`,
+                endpointId,
+                status: result?.status
+            });
+        } catch (err) {
+            logger.error({
+                event: `${event}_failed`,
+                endpointId,
+                err
+            }, err.message);
+        }
+    })();
+    if (context.waitUntil) {
+        context.waitUntil(promise);
+    }
+    return promise;
+}
+export default scheduleBackground;