@oneuptime/common 12.0.6 → 12.0.8

package/build/dist/Types/Workflow/TemplateSyntax.js

@@ -0,0 +1,326 @@
+/*
+ * Parsing helpers for the {{...}} template syntax that workflow arguments use.
+ *
+ * The runtime implementation lives in Common/Server/Utils/VM/VMAPI.ts
+ * (replaceValueInPlace, expandEachLoops, deepFind). Everything in this file
+ * mirrors that behaviour so the builder can warn about a broken reference
+ * before a run does — VMAPI deliberately skips a reference it cannot resolve
+ * ("Skip replacement if the variable is not found in the storageMap"), which
+ * means a typo like {{local.componets.api-get-1.returnValues.response-body}}
+ * is sent as literal text in the outgoing request and the run still reports
+ * Success. That silence is the bug this module exists to end.
+ *
+ * This lives in Common/Types (not Common/UI) because both the builder and the
+ * server-side runner need it, and Common/Types has no UI or server deps.
+ */
+import JSON5 from "json5";
+export const getTemplateExpressionRegex = () => {
+    return /{{(.*?)}}/g;
+};
+export var TemplateExpressionKind;
+(function (TemplateExpressionKind) {
+    /** A value reference, e.g. {{local.variables.apiKey}}. */
+    TemplateExpressionKind["Reference"] = "Reference";
+    /** The opening tag of a loop, e.g. {{#each local.components.x.returnValues.items}}. */
+    TemplateExpressionKind["EachOpen"] = "EachOpen";
+    /** The closing tag of a loop: {{/each}}. */
+    TemplateExpressionKind["EachClose"] = "EachClose";
+    /** The loop index helper: {{@index}}. */
+    TemplateExpressionKind["LoopIndex"] = "LoopIndex";
+    /** The current primitive element inside a loop: {{this}}. */
+    TemplateExpressionKind["LoopThis"] = "LoopThis";
+})(TemplateExpressionKind || (TemplateExpressionKind = {}));
+const classifyExpression = (inner) => {
+    if (inner.startsWith("#each")) {
+        return TemplateExpressionKind.EachOpen;
+    }
+    if (inner === "/each") {
+        return TemplateExpressionKind.EachClose;
+    }
+    if (inner === "@index") {
+        return TemplateExpressionKind.LoopIndex;
+    }
+    if (inner === "this") {
+        return TemplateExpressionKind.LoopThis;
+    }
+    return TemplateExpressionKind.Reference;
+};
+/**
+ * Every {{...}} expression in `value`, in source order, each tagged with what
+ * it is and whether it sits inside a loop body.
+ */
+export const parseTemplateExpressions = (value) => {
+    if (!value || typeof value !== "string") {
+        return [];
+    }
+    const expressions = [];
+    const regex = getTemplateExpressionRegex();
+    let match = null;
+    let eachDepth = 0;
+    while ((match = regex.exec(value)) !== null) {
+        const raw = match[0];
+        const innerRaw = match[1] || "";
+        const inner = innerRaw.trim();
+        const kind = classifyExpression(inner);
+        /*
+         * A closing tag is not itself "inside" the block it closes, and an opening
+         * tag is not inside the block it opens — but the array path on an opening
+         * tag IS resolved against the enclosing scope, so nested opens still count
+         * as inside their parent.
+         */
+        if (kind === TemplateExpressionKind.EachClose) {
+            eachDepth = Math.max(0, eachDepth - 1);
+        }
+        expressions.push({
+            raw: raw,
+            inner: inner,
+            innerRaw: innerRaw,
+            kind: kind,
+            startIndex: match.index,
+            endIndex: match.index + raw.length,
+            isInsideEachBlock: eachDepth > 0,
+        });
+        if (kind === TemplateExpressionKind.EachOpen) {
+            eachDepth++;
+        }
+    }
+    return expressions;
+};
+/**
+ * True when the value contains a loop. A loop expands to a variable number of
+ * repetitions of its body, so the shape of the final string is not knowable
+ * statically — callers that check structure (e.g. JSON validity) must bail out.
+ */
+export const hasEachBlock = (value) => {
+    if (!value || typeof value !== "string") {
+        return false;
+    }
+    return value.includes("{{#each") || value.includes("{{/each}}");
+};
+/*
+ * Substituted into a JSON document in place of every {{...}} expression before
+ * the document is parsed. `1` is chosen because it is simultaneously a legal
+ * JSON value (`{"n": {{x}}}` -> `{"n": 1}`), legal inside a string literal
+ * (`{"s": "{{x}}"}` -> `{"s": "1"}`), and legal as an object key
+ * (`{"{{x}}": 2}` -> `{"1": 2}`). Any of those three is a real thing people
+ * write, and all three have to survive masking or the check reports a
+ * syntax error where none exists.
+ */
+const TEMPLATE_MASK_TOKEN = "1";
+/**
+ * Replace every {{...}} expression with a neutral literal, so what remains can
+ * be checked for JSON syntax without the (unknown, run-time) substituted
+ * values.
+ */
+export const maskTemplateExpressions = (value) => {
+    if (!value || typeof value !== "string") {
+        return value;
+    }
+    return value.replace(getTemplateExpressionRegex(), TEMPLATE_MASK_TOKEN);
+};
+/**
+ * Is `value` a JSON document, once its {{...}} placeholders are accounted for?
+ *
+ * Deliberately permissive. It returns invalid only for a string that cannot
+ * become JSON no matter what the placeholders resolve to, because a false
+ * positive here disables the Save button on a workflow that actually works.
+ */
+export const checkJSONSyntax = (value, options) => {
+    const skipped = {
+        isValid: true,
+        errorMessage: null,
+        wasSkipped: true,
+    };
+    /*
+     * Not a string: the field already holds a parsed object (the Dictionary
+     * editor and imported graphs both produce these). Nothing to parse.
+     */
+    if (typeof value !== "string") {
+        return skipped;
+    }
+    // Empty is the job of the required-field check, not this one.
+    if (value.trim() === "") {
+        return skipped;
+    }
+    /*
+     * A loop emits its body once per array element, so the document's structure
+     * depends on data that only exists at run time. Checking the unexpanded text
+     * would flag every correct loop ever written.
+     */
+    if (hasEachBlock(value)) {
+        return skipped;
+    }
+    const masked = maskTemplateExpressions(value);
+    try {
+        if (options === null || options === void 0 ? void 0 : options.allowJSON5) {
+            JSON5.parse(masked);
+        }
+        else {
+            JSON.parse(masked);
+        }
+        return { isValid: true, errorMessage: null, wasSkipped: false };
+    }
+    catch (err) {
+        const parserMessage = err instanceof Error ? err.message : "Invalid JSON.";
+        return {
+            isValid: false,
+            errorMessage: parserMessage,
+            wasSkipped: false,
+        };
+    }
+};
+/* ------------------------------------------------------------------------ */
+/* Reference paths                                                           */
+/* ------------------------------------------------------------------------ */
+export var ReferenceRootType;
+(function (ReferenceRootType) {
+    ReferenceRootType["LocalVariable"] = "LocalVariable";
+    ReferenceRootType["GlobalVariable"] = "GlobalVariable";
+    ReferenceRootType["ComponentReturnValue"] = "ComponentReturnValue";
+    /** Well-formed-looking but not a root the runtime storage map has. */
+    ReferenceRootType["Unknown"] = "Unknown";
+})(ReferenceRootType || (ReferenceRootType = {}));
+/**
+ * `items[0]` -> `items`. VMUtil.deepFind splits a path on "." and then looks
+ * for a `[index]` suffix on each segment, so the name to match against
+ * metadata is whatever precedes the bracket.
+ */
+const stripArrayAccessor = (segment) => {
+    const bracketIndex = segment.indexOf("[");
+    if (bracketIndex === -1) {
+        return segment;
+    }
+    return segment.slice(0, bracketIndex);
+};
+/*
+ * Characters that appear in code but never in a reference path. A workflow's
+ * JavaScript component is templated like every other argument
+ * (RunWorkflow.getComponentArguments runs on all of them), so its source is
+ * scanned by the same regex — and JavaScript really can contain `{{` and `}}`
+ * on one line, e.g. `if (x) {{ return 1; }}`. Anything carrying these is code
+ * that happened to match, not a reference somebody typo'd, and reporting it
+ * would put a red badge on a component that works.
+ */
+const NON_REFERENCE_CHARACTERS = /[{}()[\];=+*/&|!<>"'`,]/;
+/**
+ * Whether a template capture was plausibly *meant* to be a value reference.
+ * Used to decide whether an unrecognized path is worth complaining about.
+ *
+ * Array accessors are stripped first, since `items[0]` is a legitimate path
+ * segment even though it contains brackets.
+ */
+export const looksLikeReferencePath = (capture) => {
+    const trimmed = capture.trim();
+    if (trimmed === "") {
+        return false;
+    }
+    const withoutAccessors = trimmed.replace(/\[(\d+|last)\]/g, "");
+    return !NON_REFERENCE_CHARACTERS.test(withoutAccessors);
+};
+/**
+ * Break a reference path into the parts the builder can check against the
+ * graph. Mirrors the StorageMap shape built in RunWorkflow.getVariables:
+ *
+ *   local.variables.<name>
+ *   local.components.<componentId>.returnValues.<returnValueId>[...deeper]
+ *   global.variables.<name>
+ *
+ * Anything past the return value id is a drill-in to whatever that value
+ * happens to contain at run time, so it is not inspected here.
+ */
+export const parseReferencePath = (path) => {
+    if (path.trim() === "") {
+        return {
+            rootType: ReferenceRootType.Unknown,
+            reason: "the reference is empty",
+        };
+    }
+    const rawSegments = path.split(".").map((segment) => {
+        return segment.trim();
+    });
+    /*
+     * deepFind splits on "." and bails on the first empty key, so a doubled dot
+     * silently resolves to nothing. Catch it here rather than filtering the
+     * empties out, which would make "local..variables.x" look perfectly fine.
+     */
+    if (rawSegments.some((segment) => {
+        return segment.length === 0;
+    })) {
+        return {
+            rootType: ReferenceRootType.Unknown,
+            reason: "it has an empty part between two dots",
+        };
+    }
+    const segments = rawSegments;
+    const root = stripArrayAccessor(segments[0]);
+    if (root === "global") {
+        if (stripArrayAccessor(segments[1] || "") !== "variables") {
+            return {
+                rootType: ReferenceRootType.Unknown,
+                reason: '"global" must be followed by "variables"',
+            };
+        }
+        if (!segments[2]) {
+            return {
+                rootType: ReferenceRootType.Unknown,
+                reason: "no global variable name was given",
+            };
+        }
+        return {
+            rootType: ReferenceRootType.GlobalVariable,
+            variableName: stripArrayAccessor(segments[2]),
+        };
+    }
+    if (root !== "local") {
+        return {
+            rootType: ReferenceRootType.Unknown,
+            reason: `"${root}" is not a thing a reference can start with — use "local" or "global"`,
+        };
+    }
+    const second = stripArrayAccessor(segments[1] || "");
+    if (second === "variables") {
+        if (!segments[2]) {
+            return {
+                rootType: ReferenceRootType.Unknown,
+                reason: "no variable name was given",
+            };
+        }
+        return {
+            rootType: ReferenceRootType.LocalVariable,
+            variableName: stripArrayAccessor(segments[2]),
+        };
+    }
+    if (second !== "components") {
+        return {
+            rootType: ReferenceRootType.Unknown,
+            reason: `"local.${second}" is not valid — use "local.variables" or "local.components"`,
+        };
+    }
+    const componentId = stripArrayAccessor(segments[2] || "");
+    if (!componentId) {
+        return {
+            rootType: ReferenceRootType.Unknown,
+            reason: "no component id was given",
+        };
+    }
+    const third = stripArrayAccessor(segments[3] || "");
+    if (third !== "returnValues") {
+        return {
+            rootType: ReferenceRootType.Unknown,
+            reason: `"local.components.${componentId}" must be followed by "returnValues"`,
+        };
+    }
+    const returnValueId = stripArrayAccessor(segments[4] || "");
+    if (!returnValueId) {
+        return {
+            rootType: ReferenceRootType.Unknown,
+            reason: `no return value was named on "${componentId}"`,
+        };
+    }
+    return {
+        rootType: ReferenceRootType.ComponentReturnValue,
+        componentId: componentId,
+        returnValueId: returnValueId,
+    };
+};
+//# sourceMappingURL=TemplateSyntax.js.map

package/build/dist/Types/Workflow/TemplateSyntax.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TemplateSyntax.js","sourceRoot":"","sources":["../../../../Types/Workflow/TemplateSyntax.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAS1B,MAAM,CAAC,MAAM,0BAA0B,GACrC,GAAW,EAAE;IACX,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAEJ,MAAM,CAAN,IAAY,sBAWX;AAXD,WAAY,sBAAsB;IAChC,0DAA0D;IAC1D,iDAAuB,CAAA;IACvB,uFAAuF;IACvF,+CAAqB,CAAA;IACrB,4CAA4C;IAC5C,iDAAuB,CAAA;IACvB,yCAAyC;IACzC,iDAAuB,CAAA;IACvB,6DAA6D;IAC7D,+CAAqB,CAAA;AACvB,CAAC,EAXW,sBAAsB,KAAtB,sBAAsB,QAWjC;AAiCD,MAAM,kBAAkB,GAA+B,CACrD,KAAa,EACW,EAAE;IAC1B,IAAI,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,OAAO,sBAAsB,CAAC,QAAQ,CAAC;IACzC,CAAC;IAED,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;QACtB,OAAO,sBAAsB,CAAC,SAAS,CAAC;IAC1C,CAAC;IAED,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;QACvB,OAAO,sBAAsB,CAAC,SAAS,CAAC;IAC1C,CAAC;IAED,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;QACrB,OAAO,sBAAsB,CAAC,QAAQ,CAAC;IACzC,CAAC;IAED,OAAO,sBAAsB,CAAC,SAAS,CAAC;AAC1C,CAAC,CAAC;AAMF;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAqC,CACxE,KAAa,EACc,EAAE;IAC7B,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,WAAW,GAA8B,EAAE,CAAC;IAClD,MAAM,KAAK,GAAW,0BAA0B,EAAE,CAAC;IACnD,IAAI,KAAK,GAA2B,IAAI,CAAC;IACzC,IAAI,SAAS,GAAW,CAAC,CAAC;IAE1B,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QAC5C,MAAM,GAAG,GAAW,KAAK,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,QAAQ,GAAW,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACxC,MAAM,KAAK,GAAW,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtC,MAAM,IAAI,GAA2B,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAE/D;;;;;WAKG;QACH,IAAI,IAAI,KAAK,sBAAsB,CAAC,SAAS,EAAE,CAAC;YAC9C,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,CAAC;QACzC,CAAC;QAED,WAAW,CAAC,IAAI,CAAC;YACf,GAAG,EAAE,GAAG;YACR,KAAK,EAAE,KAAK;YACZ,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,IAAI;YACV,UAAU,EAAE,KAAK,CAAC,KAAK;YACvB,QAAQ,EAAE,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,MAAM;YAClC,iBAAiB,EAAE,SAAS,GAAG,CAAC;SACjC,CAAC,CAAC;QAEH,IAAI,IAAI,KAAK,sBAAsB,CAAC,QAAQ,EAAE,CAAC;YAC7C,SAAS,EAAE,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAIF;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAyB,CAAC,KAAa,EAAW,EAAE;IAC3E,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,mBAAmB,GAAW,GAAG,CAAC;AAIxC;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAoC,CACtE,KAAa,EACL,EAAE;IACV,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,KAAK,CAAC,OAAO,CAAC,0BAA0B,EAAE,EAAE,mBAAmB,CAAC,CAAC;AAC1E,CAAC,CAAC;AAqCF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAA4B,CACtD,KAAc,EACd,OAA4C,EACrB,EAAE;IACzB,MAAM,OAAO,GAA0B;QACrC,OAAO,EAAE,IAAI;QACb,YAAY,EAAE,IAAI;QAClB,UAAU,EAAE,IAAI;KACjB,CAAC;IAEF;;;OAGG;IACH,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,8DAA8D;IAC9D,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACxB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,MAAM,GAAW,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAEtD,IAAI,CAAC;QACH,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,EAAE,CAAC;YACxB,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;QACD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;IAClE,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACtB,MAAM,aAAa,GACjB,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;QAEvD,OAAO;YACL,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,aAAa;YAC3B,UAAU,EAAE,KAAK;SAClB,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAEF,8EAA8E;AAC9E,+EAA+E;AAC/E,8EAA8E;AAE9E,MAAM,CAAN,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC3B,oDAA+B,CAAA;IAC/B,sDAAiC,CAAA;IACjC,kEAA6C,CAAA;IAC7C,sEAAsE;IACtE,wCAAmB,CAAA;AACrB,CAAC,EANW,iBAAiB,KAAjB,iBAAiB,QAM5B;AAmBD;;;;GAIG;AACH,MAAM,kBAAkB,GAA+B,CACrD,OAAe,EACP,EAAE;IACV,MAAM,YAAY,GAAW,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAElD,IAAI,YAAY,KAAK,CAAC,CAAC,EAAE,CAAC;QACxB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;AACxC,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,wBAAwB,GAAW,yBAAyB,CAAC;AAInE;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAmC,CACpE,OAAe,EACN,EAAE;IACX,MAAM,OAAO,GAAW,OAAO,CAAC,IAAI,EAAE,CAAC;IAEvC,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;QACnB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,gBAAgB,GAAW,OAAO,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;IAExE,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;AAC1D,CAAC,CAAC;AAIF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAA+B,CAC5D,IAAY,EACS,EAAE;IACvB,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACvB,OAAO;YACL,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM,EAAE,wBAAwB;SACjC,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAkB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,OAAe,EAAE,EAAE;QACzE,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH;;;;OAIG;IACH,IACE,WAAW,CAAC,IAAI,CAAC,CAAC,OAAe,EAAE,EAAE;QACnC,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC;IAC9B,CAAC,CAAC,EACF,CAAC;QACD,OAAO;YACL,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM,EAAE,uCAAuC;SAChD,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAkB,WAAW,CAAC;IAE5C,MAAM,IAAI,GAAW,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAW,CAAC,CAAC;IAE/D,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtB,IAAI,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,WAAW,EAAE,CAAC;YAC1D,OAAO;gBACL,QAAQ,EAAE,iBAAiB,CAAC,OAAO;gBACnC,MAAM,EAAE,0CAA0C;aACnD,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;YACjB,OAAO;gBACL,QAAQ,EAAE,iBAAiB,CAAC,OAAO;gBACnC,MAAM,EAAE,mCAAmC;aAC5C,CAAC;QACJ,CAAC;QAED,OAAO;YACL,QAAQ,EAAE,iBAAiB,CAAC,cAAc;YAC1C,YAAY,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;SAC9C,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,OAAO;YACL,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM,EAAE,IAAI,IAAI,uEAAuE;SACxF,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAW,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAE7D,IAAI,MAAM,KAAK,WAAW,EAAE,CAAC;QAC3B,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;YACjB,OAAO;gBACL,QAAQ,EAAE,iBAAiB,CAAC,OAAO;gBACnC,MAAM,EAAE,4BAA4B;aACrC,CAAC;QACJ,CAAC;QAED,OAAO;YACL,QAAQ,EAAE,iBAAiB,CAAC,aAAa;YACzC,YAAY,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;SAC9C,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,KAAK,YAAY,EAAE,CAAC;QAC5B,OAAO;YACL,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM,EAAE,UAAU,MAAM,8DAA8D;SACvF,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAW,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAElE,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO;YACL,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM,EAAE,2BAA2B;SACpC,CAAC;IACJ,CAAC;IAED,MAAM,KAAK,GAAW,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAE5D,IAAI,KAAK,KAAK,cAAc,EAAE,CAAC;QAC7B,OAAO;YACL,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM,EAAE,qBAAqB,WAAW,sCAAsC;SAC/E,CAAC;IACJ,CAAC;IAED,MAAM,aAAa,GAAW,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAEpE,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAO;YACL,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM,EAAE,iCAAiC,WAAW,GAAG;SACxD,CAAC;IACJ,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,iBAAiB,CAAC,oBAAoB;QAChD,WAAW,EAAE,WAAW;QACxB,aAAa,EAAE,aAAa;KAC7B,CAAC;AACJ,CAAC,CAAC"}

package/build/dist/Types/Workflow/Templates.js

@@ -0,0 +1,218 @@
+/*
+ * Starter workflows.
+ *
+ * An empty canvas is a bad first lesson: the thing a new builder most needs to
+ * learn is how one step reads another's output, and nothing on a blank graph
+ * teaches it. Each template below is a small, working workflow whose whole
+ * point is to show a {{local.components.…}} reference in context.
+ *
+ * Every template here is deliberately runnable with no external configuration
+ * — no Slack token, no API key, no third-party account. Templates that need
+ * credentials belong in the docs, not in a one-click "start from this".
+ *
+ * The graphs are plain data in the same shape the builder saves and the JSON
+ * import reads, so a template is created through the ordinary Workflow create
+ * path (which denormalizes the trigger onto the row in
+ * WorkflowService.onCreateSuccess).
+ */
+import ComponentID from "./ComponentID";
+import { ComponentType, NodeType } from "./Component";
+export const buildTemplateGraph = (spec, generateId) => {
+    const nodeIdByComponentId = {};
+    const nodes = spec.nodes.map((node) => {
+        const nodeId = generateId();
+        nodeIdByComponentId[node.componentId] = nodeId;
+        return {
+            id: nodeId,
+            type: "node",
+            position: node.position,
+            data: {
+                id: node.componentId,
+                nodeType: NodeType.Node,
+                componentType: node.componentType,
+                metadataId: node.metadataId,
+                internalId: generateId(),
+                error: "",
+                arguments: node.args || {},
+                returnValues: {},
+            },
+        };
+    });
+    const edges = spec.edges.map((edge) => {
+        return {
+            id: generateId(),
+            source: nodeIdByComponentId[edge.fromComponentId],
+            target: nodeIdByComponentId[edge.toComponentId],
+            sourceHandle: edge.fromPort,
+            targetHandle: "in",
+        };
+    });
+    return { nodes: nodes, edges: edges };
+};
+const TEMPLATE_DEFINITIONS = [
+    {
+        id: "manual-log",
+        name: "Log a message when run by hand",
+        description: "The smallest working workflow: a manual trigger and a step that writes a line to the run log.",
+        teaches: "How to run a workflow and where its output shows up.",
+        workflowName: "Log a message",
+        workflowDescription: "Runs on demand and writes a line to the run log. A good place to start.",
+        graph: {
+            nodes: [
+                {
+                    componentId: "manual-1",
+                    metadataId: ComponentID.Manual,
+                    componentType: ComponentType.Trigger,
+                    position: { x: 100, y: 100 },
+                },
+                {
+                    componentId: "log-1",
+                    metadataId: ComponentID.Log,
+                    componentType: ComponentType.Component,
+                    position: { x: 100, y: 300 },
+                    args: {
+                        value: "Hello from OneUptime. This workflow ran.",
+                    },
+                },
+            ],
+            edges: [
+                {
+                    fromComponentId: "manual-1",
+                    toComponentId: "log-1",
+                    fromPort: "success",
+                },
+            ],
+        },
+    },
+    {
+        id: "webhook-echo",
+        name: "Echo what a webhook sent",
+        description: "Takes the body posted to this workflow's webhook and writes it back out to the log.",
+        /*
+         * The reason this template exists: the log message is a reference, not
+         * text, and seeing that in place is the fastest way to understand the
+         * whole substitution model.
+         */
+        teaches: "How one step reads another's output, using {{local.components...}}.",
+        workflowName: "Echo webhook body",
+        workflowDescription: "Writes whatever was posted to this workflow's webhook into the run log.",
+        graph: {
+            nodes: [
+                {
+                    componentId: "webhook-1",
+                    metadataId: ComponentID.Webhook,
+                    componentType: ComponentType.Trigger,
+                    position: { x: 100, y: 100 },
+                },
+                {
+                    componentId: "log-1",
+                    metadataId: ComponentID.Log,
+                    componentType: ComponentType.Component,
+                    position: { x: 100, y: 300 },
+                    args: {
+                        value: "Webhook received: {{local.components.webhook-1.returnValues.request-body}}",
+                    },
+                },
+            ],
+            edges: [
+                {
+                    fromComponentId: "webhook-1",
+                    toComponentId: "log-1",
+                    fromPort: "out",
+                },
+            ],
+        },
+    },
+    {
+        id: "scheduled-check",
+        name: "Call an API on a schedule",
+        description: "Runs every hour, calls a URL, and logs whether it came back OK — with separate paths for success and failure.",
+        teaches: "How a schedule works, and how a step's Success and Error ports branch.",
+        workflowName: "Hourly API check",
+        workflowDescription: "Calls a URL every hour and logs the outcome. Point the URL at something of yours.",
+        graph: {
+            nodes: [
+                {
+                    componentId: "schedule-1",
+                    metadataId: ComponentID.Schedule,
+                    componentType: ComponentType.Trigger,
+                    position: { x: 100, y: 100 },
+                    args: {
+                        schedule: "0 * * * *",
+                    },
+                },
+                {
+                    componentId: "api-get-1",
+                    metadataId: ComponentID.ApiGet,
+                    componentType: ComponentType.Component,
+                    position: { x: 100, y: 300 },
+                    args: {
+                        url: "https://api.github.com/zen",
+                    },
+                },
+                {
+                    componentId: "log-ok",
+                    metadataId: ComponentID.Log,
+                    componentType: ComponentType.Component,
+                    position: { x: -100, y: 500 },
+                    args: {
+                        value: "Responded {{local.components.api-get-1.returnValues.response-status}}: {{local.components.api-get-1.returnValues.response-body}}",
+                    },
+                },
+                {
+                    componentId: "log-failed",
+                    metadataId: ComponentID.Log,
+                    componentType: ComponentType.Component,
+                    position: { x: 300, y: 500 },
+                    args: {
+                        value: "Call failed: {{local.components.api-get-1.returnValues.error}}",
+                    },
+                },
+            ],
+            edges: [
+                {
+                    fromComponentId: "schedule-1",
+                    toComponentId: "api-get-1",
+                    fromPort: "execute",
+                },
+                {
+                    fromComponentId: "api-get-1",
+                    toComponentId: "log-ok",
+                    fromPort: "success",
+                },
+                {
+                    fromComponentId: "api-get-1",
+                    toComponentId: "log-failed",
+                    fromPort: "error",
+                },
+            ],
+        },
+    },
+];
+export const getWorkflowTemplates = () => {
+    return TEMPLATE_DEFINITIONS.map((definition) => {
+        return {
+            id: definition.id,
+            name: definition.name,
+            description: definition.description,
+            teaches: definition.teaches,
+            workflowName: definition.workflowName,
+            workflowDescription: definition.workflowDescription,
+        };
+    });
+};
+export const getTemplateGraphSpec = (templateId) => {
+    const definition = TEMPLATE_DEFINITIONS.find((candidate) => {
+        return candidate.id === templateId;
+    });
+    return definition ? definition.graph : null;
+};
+export const buildGraphForTemplate = (templateId, generateId) => {
+    const spec = getTemplateGraphSpec(templateId);
+    if (!spec) {
+        return null;
+    }
+    return buildTemplateGraph(spec, generateId);
+};
+export default getWorkflowTemplates;
+//# sourceMappingURL=Templates.js.map

package/build/dist/Types/Workflow/Templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Templates.js","sourceRoot":"","sources":["../../../../Types/Workflow/Templates.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAGH,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AA6CtD,MAAM,CAAC,MAAM,kBAAkB,GAA+B,CAC5D,IAAuB,EACvB,UAAwB,EACZ,EAAE;IACd,MAAM,mBAAmB,GAA2B,EAAE,CAAC;IAEvD,MAAM,KAAK,GAAsB,IAAI,CAAC,KAAK,CAAC,GAAG,CAC7C,CAAC,IAAsB,EAAc,EAAE;QACrC,MAAM,MAAM,GAAW,UAAU,EAAE,CAAC;QACpC,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC;QAE/C,OAAO;YACL,EAAE,EAAE,MAAM;YACV,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE;gBACJ,EAAE,EAAE,IAAI,CAAC,WAAW;gBACpB,QAAQ,EAAE,QAAQ,CAAC,IAAI;gBACvB,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,UAAU,EAAE,UAAU,EAAE;gBACxB,KAAK,EAAE,EAAE;gBACT,SAAS,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;gBAC1B,YAAY,EAAE,EAAE;aACjB;SACF,CAAC;IACJ,CAAC,CACF,CAAC;IAEF,MAAM,KAAK,GAAsB,IAAI,CAAC,KAAK,CAAC,GAAG,CAC7C,CAAC,IAAsB,EAAc,EAAE;QACrC,OAAO;YACL,EAAE,EAAE,UAAU,EAAE;YAChB,MAAM,EAAE,mBAAmB,CAAC,IAAI,CAAC,eAAe,CAAW;YAC3D,MAAM,EAAE,mBAAmB,CAAC,IAAI,CAAC,aAAa,CAAW;YACzD,YAAY,EAAE,IAAI,CAAC,QAAQ;YAC3B,YAAY,EAAE,IAAI;SACnB,CAAC;IACJ,CAAC,CACF,CAAC;IAEF,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AACxC,CAAC,CAAC;AAIF,MAAM,oBAAoB,GAA8B;IACtD;QACE,EAAE,EAAE,YAAY;QAChB,IAAI,EAAE,gCAAgC;QACtC,WAAW,EACT,+FAA+F;QACjG,OAAO,EAAE,sDAAsD;QAC/D,YAAY,EAAE,eAAe;QAC7B,mBAAmB,EACjB,yEAAyE;QAC3E,KAAK,EAAE;YACL,KAAK,EAAE;gBACL;oBACE,WAAW,EAAE,UAAU;oBACvB,UAAU,EAAE,WAAW,CAAC,MAAM;oBAC9B,aAAa,EAAE,aAAa,CAAC,OAAO;oBACpC,QAAQ,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE;iBAC7B;gBACD;oBACE,WAAW,EAAE,OAAO;oBACpB,UAAU,EAAE,WAAW,CAAC,GAAG;oBAC3B,aAAa,EAAE,aAAa,CAAC,SAAS;oBACtC,QAAQ,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE;oBAC5B,IAAI,EAAE;wBACJ,KAAK,EAAE,0CAA0C;qBAClD;iBACF;aACF;YACD,KAAK,EAAE;gBACL;oBACE,eAAe,EAAE,UAAU;oBAC3B,aAAa,EAAE,OAAO;oBACtB,QAAQ,EAAE,SAAS;iBACpB;aACF;SACF;KACF;IACD;QACE,EAAE,EAAE,cAAc;QAClB,IAAI,EAAE,0BAA0B;QAChC,WAAW,EACT,qFAAqF;QACvF;;;;WAIG;QACH,OAAO,EACL,qEAAqE;QACvE,YAAY,EAAE,mBAAmB;QACjC,mBAAmB,EACjB,yEAAyE;QAC3E,KAAK,EAAE;YACL,KAAK,EAAE;gBACL;oBACE,WAAW,EAAE,WAAW;oBACxB,UAAU,EAAE,WAAW,CAAC,OAAO;oBAC/B,aAAa,EAAE,aAAa,CAAC,OAAO;oBACpC,QAAQ,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE;iBAC7B;gBACD;oBACE,WAAW,EAAE,OAAO;oBACpB,UAAU,EAAE,WAAW,CAAC,GAAG;oBAC3B,aAAa,EAAE,aAAa,CAAC,SAAS;oBACtC,QAAQ,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE;oBAC5B,IAAI,EAAE;wBACJ,KAAK,EACH,4EAA4E;qBAC/E;iBACF;aACF;YACD,KAAK,EAAE;gBACL;oBACE,eAAe,EAAE,WAAW;oBAC5B,aAAa,EAAE,OAAO;oBACtB,QAAQ,EAAE,KAAK;iBAChB;aACF;SACF;KACF;IACD;QACE,EAAE,EAAE,iBAAiB;QACrB,IAAI,EAAE,2BAA2B;QACjC,WAAW,EACT,+GAA+G;QACjH,OAAO,EACL,wEAAwE;QAC1E,YAAY,EAAE,kBAAkB;QAChC,mBAAmB,EACjB,mFAAmF;QACrF,KAAK,EAAE;YACL,KAAK,EAAE;gBACL;oBACE,WAAW,EAAE,YAAY;oBACzB,UAAU,EAAE,WAAW,CAAC,QAAQ;oBAChC,aAAa,EAAE,aAAa,CAAC,OAAO;oBACpC,QAAQ,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE;oBAC5B,IAAI,EAAE;wBACJ,QAAQ,EAAE,WAAW;qBACtB;iBACF;gBACD;oBACE,WAAW,EAAE,WAAW;oBACxB,UAAU,EAAE,WAAW,CAAC,MAAM;oBAC9B,aAAa,EAAE,aAAa,CAAC,SAAS;oBACtC,QAAQ,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE;oBAC5B,IAAI,EAAE;wBACJ,GAAG,EAAE,4BAA4B;qBAClC;iBACF;gBACD;oBACE,WAAW,EAAE,QAAQ;oBACrB,UAAU,EAAE,WAAW,CAAC,GAAG;oBAC3B,aAAa,EAAE,aAAa,CAAC,SAAS;oBACtC,QAAQ,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE;oBAC7B,IAAI,EAAE;wBACJ,KAAK,EACH,kIAAkI;qBACrI;iBACF;gBACD;oBACE,WAAW,EAAE,YAAY;oBACzB,UAAU,EAAE,WAAW,CAAC,GAAG;oBAC3B,aAAa,EAAE,aAAa,CAAC,SAAS;oBACtC,QAAQ,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE;oBAC5B,IAAI,EAAE;wBACJ,KAAK,EACH,gEAAgE;qBACnE;iBACF;aACF;YACD,KAAK,EAAE;gBACL;oBACE,eAAe,EAAE,YAAY;oBAC7B,aAAa,EAAE,WAAW;oBAC1B,QAAQ,EAAE,SAAS;iBACpB;gBACD;oBACE,eAAe,EAAE,WAAW;oBAC5B,aAAa,EAAE,QAAQ;oBACvB,QAAQ,EAAE,SAAS;iBACpB;gBACD;oBACE,eAAe,EAAE,WAAW;oBAC5B,aAAa,EAAE,YAAY;oBAC3B,QAAQ,EAAE,OAAO;iBAClB;aACF;SACF;KACF;CACF,CAAC;AAIF,MAAM,CAAC,MAAM,oBAAoB,GAC/B,GAA4B,EAAE;IAC5B,OAAO,oBAAoB,CAAC,GAAG,CAC7B,CAAC,UAA8B,EAAoB,EAAE;QACnD,OAAO;YACL,EAAE,EAAE,UAAU,CAAC,EAAE;YACjB,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,WAAW,EAAE,UAAU,CAAC,WAAW;YACnC,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,YAAY,EAAE,UAAU,CAAC,YAAY;YACrC,mBAAmB,EAAE,UAAU,CAAC,mBAAmB;SACpD,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAMJ,MAAM,CAAC,MAAM,oBAAoB,GAAiC,CAChE,UAAkB,EACQ,EAAE;IAC5B,MAAM,UAAU,GAAmC,oBAAoB,CAAC,IAAI,CAC1E,CAAC,SAA6B,EAAE,EAAE;QAChC,OAAO,SAAS,CAAC,EAAE,KAAK,UAAU,CAAC;IACrC,CAAC,CACF,CAAC;IAEF,OAAO,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAC9C,CAAC,CAAC;AAOF,MAAM,CAAC,MAAM,qBAAqB,GAAkC,CAClE,UAAkB,EAClB,UAAwB,EACL,EAAE;IACrB,MAAM,IAAI,GAA6B,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAExE,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAC9C,CAAC,CAAC;AAEF,eAAe,oBAAoB,CAAC"}