@oneuptime/common 14.0.11 → 14.0.12

package/build/dist/Types/Workflow/Documentation/DatabaseDocumentation.js

@@ -0,0 +1,488 @@
+/*
+ * Help for the eleven steps generated for every model a workflow can use:
+ * Find, Create, Update and Delete (one and many), and the On Create, On Update
+ * and On Delete triggers.
+ *
+ * This used to be five Markdown files shared by all 227 models, which is why
+ * Create One Incident explained "Create Many" and On Delete described a Select
+ * Fields setting it does not have. Each operation now has its own help, named
+ * for the model and built from its real fields: the example on Find One
+ * Incident reads the incident's title, and an Update step's query picks the
+ * very record the workflow's trigger handed on, by that trigger's identifier.
+ */
+import { DatabaseOperation, getDatabaseOperation } from "../DatabaseOperation";
+import { componentReturnValueReference } from "../TemplateSyntax";
+import { ComponentDocumentationNoteType, } from "./ComponentDocumentation";
+import { findRecordStep, ownReference, } from "./DocumentationContext";
+import { WorkflowDocsPaths, docsLink, modelReferenceLink, } from "./DocumentationLinks";
+import { EXAMPLE_ID, ID_COLUMN_ID, getDisplayColumn, getExampleRecord, getExampleUpdate, getRequiredCreateColumns, getWorkflowModel, } from "./ModelExamples";
+/*
+ * Which of the eleven generated steps a component is, read off the end of
+ * its id. It lives in Types/Workflow/DatabaseOperation so the Add Component
+ * picker can use it without loading this help; re-exported here for the
+ * code and tests that have always imported it from this file.
+ */
+export { DatabaseOperation, getDatabaseOperation };
+// One line for a small object, so an example is read at a glance.
+const formatJSON = (value) => {
+    return JSON.stringify(value).replace(/":/g, '": ').replace(/,"/g, ', "');
+};
+/*
+ * What a Query looks like here. Where another step in this workflow hands on
+ * one of these records, the query picks that record by its ID - which is how
+ * these steps are mostly used: "update the incident that was just created".
+ * Otherwise it matches on the field that names a record.
+ */
+const queryExample = (data) => {
+    const recordStep = findRecordStep(data.context, data.words.model.tableName || "");
+    const hasNamingField = data.words.display.id !== ID_COLUMN_ID;
+    if (recordStep && (data.isOneRecord || !hasNamingField)) {
+        return {
+            title: `Query: the ${data.words.one} from ${recordStep.id}`,
+            code: formatJSON({
+                [ID_COLUMN_ID]: componentReturnValueReference(recordStep.id, "model", [
+                    ID_COLUMN_ID,
+                ]),
+            }),
+            description: `Picks the ${data.words.one} that \`${recordStep.id}\` handed on, by its ID.`,
+        };
+    }
+    if (hasNamingField) {
+        return {
+            title: `Query: by ${data.words.display.title.toLowerCase()}`,
+            code: formatJSON({ [data.words.display.id]: data.words.display.example }),
+            description: "Keys are field names. Every key must match.",
+        };
+    }
+    return {
+        title: "Query: by ID",
+        code: formatJSON({ [ID_COLUMN_ID]: EXAMPLE_ID }),
+        description: `Put in the ID of the ${data.words.one}.`,
+    };
+};
+const modelLinks = (words) => {
+    return [
+        modelReferenceLink(words.model),
+        docsLink("Working with records", WorkflowDocsPaths.records),
+    ];
+};
+const triggerLinks = (words) => {
+    return [
+        modelReferenceLink(words.model),
+        docsLink("Record triggers guide", WorkflowDocsPaths.eventTriggers),
+    ];
+};
+const whenItFailsTopic = (words) => {
+    return {
+        title: "When it fails",
+        paragraphs: [
+            `The step takes **Error** and the run's log says why. If a key in **Query** is not one of the ${words.one}'s fields, the log lists the fields it does have.`,
+        ],
+    };
+};
+const thisProjectOnlyTopic = (words) => {
+    return {
+        title: "Only this project",
+        paragraphs: [
+            `A query only ever matches ${words.many} in the project this workflow belongs to, so you never add the project to it yourself.`,
+        ],
+    };
+};
+const idSpellingTopic = (words) => {
+    return {
+        title: "Writing the query as JSON",
+        paragraphs: [
+            `Keys are the ${words.one}'s field names, and its ID is \`_id\` (\`id\` works too). A value can be a reference to another step's value.`,
+        ],
+    };
+};
+const findOne = (context, words) => {
+    return {
+        summary: `Finds one ${words.one} in this project and passes it to the next steps.`,
+        steps: [
+            `Under **Query**, add what the ${words.one} must match.`,
+            "Under **Select Fields**, choose the fields later steps need. Only those come back.",
+            "Connect **Success** to what runs next, and **Error** to handle a failure.",
+        ],
+        examples: [
+            {
+                title: `Read a field of the ${words.one} it found`,
+                code: ownReference(context, "model", [words.display.id]),
+                description: words.display.id === ID_COLUMN_ID
+                    ? undefined
+                    : `\`${words.display.id}\` must be one of the **Select Fields**.`,
+            },
+        ],
+        notes: [
+            {
+                type: ComponentDocumentationNoteType.Tip,
+                text: `Finding nothing is not an error: the step still takes **Success**, with no ${words.one}. Check for that with an **If / Else** step.`,
+            },
+        ],
+        learnMore: [
+            Object.assign(Object.assign({}, idSpellingTopic(words)), { example: queryExample({ context, words, isOneRecord: true }) }),
+            thisProjectOnlyTopic(words),
+            whenItFailsTopic(words),
+        ],
+        links: modelLinks(words),
+    };
+};
+const findMany = (context, words) => {
+    return {
+        summary: `Finds the ${words.many} in this project that match a query, and passes them to the next steps as a list.`,
+        steps: [
+            `Under **Query**, add what the ${words.many} must match.`,
+            "Under **Select Fields**, choose the fields later steps need. Only those come back.",
+            "Connect **Success** to what runs next, and **Error** to handle a failure.",
+        ],
+        examples: [
+            {
+                title: `Read a field of the first ${words.one} found`,
+                code: ownReference(context, "models[0]", [words.display.id]),
+                description: "`[0]` is the first in the list, `[1]` the second.",
+            },
+        ],
+        notes: [
+            {
+                type: ComponentDocumentationNoteType.Tip,
+                text: `It returns at most 10 ${words.many}. Change that with **Limit**, under the advanced settings.`,
+            },
+        ],
+        learnMore: [
+            {
+                title: `Using every ${words.one} in a message`,
+                paragraphs: [
+                    "A message can repeat a line for each item in the list. Inside the loop, a field name on its own reads that item's field.",
+                ],
+                example: {
+                    title: "One line per item",
+                    code: `{{#each local.components.${context.stepId}.returnValues.models}}\n- {{${words.display.id}}}\n{{/each}}`,
+                },
+            },
+            Object.assign(Object.assign({}, idSpellingTopic(words)), { example: queryExample({ context, words, isOneRecord: false }) }),
+            thisProjectOnlyTopic(words),
+            whenItFailsTopic(words),
+        ],
+        links: [
+            ...modelLinks(words),
+            docsLink("Looping over a list", WorkflowDocsPaths.loops),
+        ],
+    };
+};
+const createOne = (context, words) => {
+    const required = getRequiredCreateColumns(words.model);
+    return {
+        summary: `Creates one ${words.one} in this project each time it runs.`,
+        steps: [
+            required.length > 0
+                ? `Under **JSON Object**, fill in the ${words.one}'s fields. The ones it needs come first.`
+                : `Under **JSON Object**, add the ${words.one}'s fields with **Add a field**.`,
+            "Connect **Success** to what runs next, and **Error** to handle a failure.",
+            `Use the new ${words.one} in later steps, starting with its ID.`,
+        ],
+        examples: [
+            {
+                title: `The new ${words.one}'s ID`,
+                code: ownReference(context, "model", [ID_COLUMN_ID]),
+            },
+        ],
+        notes: [
+            {
+                type: ComponentDocumentationNoteType.Tip,
+                text: `The ${words.one} is always created in this workflow's project. There is no project to set.`,
+            },
+            {
+                type: ComponentDocumentationNoteType.Warning,
+                text: `A key that is not one of the ${words.one}'s fields is skipped, and the run's log names it. A missing required field takes **Error**.`,
+            },
+        ],
+        learnMore: [
+            {
+                title: "Writing it as JSON",
+                paragraphs: [
+                    "**Edit as JSON** shows the same fields as one JSON object, keyed by field name. A value can be a reference to another step's value.",
+                ],
+                example: {
+                    title: `One ${words.one}`,
+                    code: formatJSON(getExampleRecord(words.model)),
+                },
+            },
+        ],
+        links: modelLinks(words),
+    };
+};
+const createMany = (context, words) => {
+    const required = getRequiredCreateColumns(words.model);
+    return {
+        summary: `Creates several ${words.many} in this project at once, from a list.`,
+        steps: [
+            `Write the list in **JSON Array**: one object per ${words.one}, keyed by field name.`,
+            "Connect **Success** to what runs next, and **Error** to handle a failure.",
+            `Use the new ${words.many} in later steps, as a list.`,
+        ],
+        examples: [
+            {
+                title: `A list of one ${words.one}`,
+                code: formatJSON([getExampleRecord(words.model)]),
+                description: required.length > 0
+                    ? `Every ${words.one} needs ${required
+                        .map((column) => {
+                        return `\`${column.id}\``;
+                    })
+                        .join(", ")}.`
+                    : `Add another object for each further ${words.one}.`,
+            },
+        ],
+        notes: [
+            {
+                type: ComponentDocumentationNoteType.Tip,
+                text: `The ${words.many} are always created in this workflow's project. There is no project to set.`,
+            },
+            {
+                type: ComponentDocumentationNoteType.Warning,
+                text: `A key that is not one of the ${words.one}'s fields is skipped, and the run's log names it. A missing required field takes **Error**.`,
+            },
+        ],
+        learnMore: [
+            {
+                title: "Reading what it created",
+                paragraphs: [
+                    `\`${ownReference(context, "models[0]", [ID_COLUMN_ID])}\` is the first new ${words.one}'s ID, \`[1]\` the second's, and so on.`,
+                ],
+            },
+        ],
+        links: modelLinks(words),
+    };
+};
+// How to act on the count an update or a delete returns.
+const countTopic = (data) => {
+    const isUpdate = data.returnValueId === "items-updated";
+    return {
+        title: "Checking whether anything matched",
+        paragraphs: [
+            `${isUpdate ? "**Items Updated**" : "**Items Deleted**"} says how many ${data.words.many} were ${isUpdate ? "changed" : "deleted"}. To act on a query that matched nothing, compare it with \`0\` in an **If / Else** step.`,
+        ],
+        example: {
+            title: `How many were ${isUpdate ? "changed" : "deleted"}`,
+            code: ownReference(data.context, data.returnValueId),
+        },
+    };
+};
+const update = (context, words, isMany) => {
+    const example = getExampleUpdate(words.model);
+    return {
+        summary: isMany
+            ? `Changes the ${words.many} in this project that match a query.`
+            : `Changes one ${words.one} in this project that matches a query.`,
+        steps: [
+            isMany
+                ? `Under **Query**, say which ${words.many} to change.`
+                : `Under **Query**, say which ${words.one} to change, usually by its ID.`,
+            "Under **Data (JSON Object)**, set the fields to change and their new values.",
+            "Connect **Success** to what runs next, and **Error** to handle a failure.",
+        ],
+        examples: [queryExample({ context, words, isOneRecord: !isMany })],
+        notes: [
+            isMany
+                ? {
+                    type: ComponentDocumentationNoteType.Warning,
+                    text: `It changes at most 10 ${words.many}, however many match. Raise **Limit**, under the advanced settings, to change more.`,
+                }
+                : {
+                    type: ComponentDocumentationNoteType.Tip,
+                    text: `If more than one ${words.one} matches, only one is changed. Query by ID to be sure which.`,
+                },
+            {
+                type: ComponentDocumentationNoteType.Tip,
+                text: "Matching nothing is not an error: **Items Updated** is `0` and the step takes **Success**.",
+            },
+        ],
+        learnMore: [
+            {
+                title: "Writing the data as JSON",
+                paragraphs: [
+                    "**Edit as JSON** shows the fields to change as one JSON object, keyed by field name. Fields you leave out keep their values.",
+                ],
+                example: Object.keys(example).length
+                    ? { title: "Data (JSON Object)", code: formatJSON(example) }
+                    : undefined,
+            },
+            countTopic({ context, words, returnValueId: "items-updated" }),
+            idSpellingTopic(words),
+            thisProjectOnlyTopic(words),
+            whenItFailsTopic(words),
+        ],
+        links: modelLinks(words),
+    };
+};
+const remove = (context, words, isMany) => {
+    return {
+        summary: isMany
+            ? `Deletes the ${words.many} in this project that match a query.`
+            : `Deletes one ${words.one} in this project that matches a query.`,
+        steps: [
+            isMany
+                ? `Under **Query**, say which ${words.many} to delete.`
+                : `Under **Query**, say which ${words.one} to delete, usually by its ID.`,
+            "Connect **Success** to what runs next, and **Error** to handle a failure.",
+        ],
+        examples: [queryExample({ context, words, isOneRecord: !isMany })],
+        notes: isMany
+            ? [
+                {
+                    type: ComponentDocumentationNoteType.Warning,
+                    text: `Deleting cannot be undone, and an empty query matches every ${words.one} in the project. It deletes at most 10 per run; raise **Limit** to delete more.`,
+                },
+                {
+                    type: ComponentDocumentationNoteType.Tip,
+                    text: "Matching nothing is not an error: **Items Deleted** is `0` and the step takes **Success**.",
+                },
+            ]
+            : [
+                {
+                    type: ComponentDocumentationNoteType.Warning,
+                    text: "Deleting cannot be undone. Query by ID to be sure which one goes.",
+                },
+                {
+                    type: ComponentDocumentationNoteType.Tip,
+                    text: "Matching nothing is not an error: **Items Deleted** is `0` and the step takes **Success**.",
+                },
+            ],
+        learnMore: [
+            countTopic({ context, words, returnValueId: "items-deleted" }),
+            idSpellingTopic(words),
+            thisProjectOnlyTopic(words),
+            whenItFailsTopic(words),
+        ],
+        links: modelLinks(words),
+    };
+};
+const onCreateOrUpdate = (context, words, isUpdate) => {
+    const event = isUpdate ? "changed" : "created";
+    return {
+        summary: isUpdate
+            ? `Starts this workflow each time one of this project's ${words.many} changes.`
+            : `Starts this workflow each time a new ${words.one} is created in this project.`,
+        steps: [
+            ...(isUpdate
+                ? [
+                    "To run only when particular fields change, choose them in **Listen on**. Leave it empty to run on any change.",
+                ]
+                : []),
+            `Under **Select Fields**, choose the fields of the ${words.one} later steps need.`,
+            "Connect **Success** to the steps to run.",
+            `Turn the workflow on. Only ${words.many} ${event} while it is on start a run.`,
+        ],
+        examples: [
+            {
+                title: `Read a field of the ${words.one} in a later step`,
+                code: ownReference(context, "model", [words.display.id]),
+                description: words.display.id === ID_COLUMN_ID
+                    ? undefined
+                    : `\`${words.display.id}\` must be one of the **Select Fields**.`,
+            },
+        ],
+        notes: [
+            {
+                type: ComponentDocumentationNoteType.Warning,
+                text: `A field left out of **Select Fields** is empty in later steps, even though the ${words.one} has it.`,
+            },
+            ...(isUpdate
+                ? [
+                    {
+                        type: ComponentDocumentationNoteType.Tip,
+                        text: "**Listen on** cuts out noise, but it is not a guarantee: when an update does not say which fields changed, the workflow runs anyway.",
+                    },
+                ]
+                : []),
+        ],
+        learnMore: [
+            {
+                title: "Testing it",
+                paragraphs: [
+                    `Click **Run Workflow** in the builder's toolbar and enter the ID of any ${words.one}. The workflow runs as if that ${words.one} had just been ${event}.`,
+                ],
+            },
+        ],
+        links: triggerLinks(words),
+    };
+};
+const onDelete = (context, words) => {
+    return {
+        summary: `Starts this workflow each time one of this project's ${words.many} is deleted.`,
+        steps: [
+            "Connect **Success** to the steps to run.",
+            `Turn the workflow on. Only ${words.many} deleted while it is on start a run.`,
+        ],
+        examples: [
+            {
+                title: `The deleted ${words.one}'s ID`,
+                code: ownReference(context, "model", [ID_COLUMN_ID]),
+            },
+        ],
+        notes: [
+            {
+                type: ComponentDocumentationNoteType.Warning,
+                text: `Only the ID is passed on. The ${words.one} is already gone, so its other fields cannot be read, and a find step will not find it.`,
+            },
+        ],
+        learnMore: [
+            {
+                title: "Testing it",
+                paragraphs: [
+                    `Click **Run Workflow** in the builder's toolbar and enter the ID of any ${words.one}. The workflow runs as if that ${words.one} had just been deleted.`,
+                ],
+            },
+        ],
+        links: triggerLinks(words),
+    };
+};
+/**
+ * The help for a generated database step, or null when the step is not one of
+ * the eleven or its model cannot be found.
+ */
+export const getDatabaseDocumentation = (context) => {
+    const tableName = context.metadata.tableName;
+    if (!tableName) {
+        return null;
+    }
+    const operation = getDatabaseOperation({
+        componentId: context.metadata.id,
+        tableName: tableName,
+    });
+    const model = getWorkflowModel(tableName);
+    if (!operation || !model) {
+        return null;
+    }
+    const words = {
+        model: model,
+        one: model.singularName || tableName,
+        many: model.pluralName || model.singularName || tableName,
+        display: getDisplayColumn(model),
+    };
+    switch (operation) {
+        case DatabaseOperation.FindOne:
+            return findOne(context, words);
+        case DatabaseOperation.FindMany:
+            return findMany(context, words);
+        case DatabaseOperation.CreateOne:
+            return createOne(context, words);
+        case DatabaseOperation.CreateMany:
+            return createMany(context, words);
+        case DatabaseOperation.UpdateOne:
+            return update(context, words, false);
+        case DatabaseOperation.UpdateMany:
+            return update(context, words, true);
+        case DatabaseOperation.DeleteOne:
+            return remove(context, words, false);
+        case DatabaseOperation.DeleteMany:
+            return remove(context, words, true);
+        case DatabaseOperation.OnCreate:
+            return onCreateOrUpdate(context, words, false);
+        case DatabaseOperation.OnUpdate:
+            return onCreateOrUpdate(context, words, true);
+        case DatabaseOperation.OnDelete:
+            return onDelete(context, words);
+    }
+};
+//# sourceMappingURL=DatabaseDocumentation.js.map

package/build/dist/Types/Workflow/Documentation/DatabaseDocumentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DatabaseDocumentation.js","sourceRoot":"","sources":["../../../../../Types/Workflow/Documentation/DatabaseDocumentation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAKH,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,EAAE,6BAA6B,EAAE,MAAM,mBAAmB,CAAC;AAClE,OAA+B,EAG7B,8BAA8B,GAE/B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAEL,cAAc,EACd,YAAY,GACb,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,iBAAiB,EACjB,QAAQ,EACR,kBAAkB,GACnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,UAAU,EAEV,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,wBAAwB,EACxB,gBAAgB,GACjB,MAAM,iBAAiB,CAAC;AAEzB;;;;;GAKG;AACH,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,CAAC;AAsBnD,kEAAkE;AAClE,MAAM,UAAU,GAAuB,CACrC,KAAqC,EAC7B,EAAE;IACV,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC3E,CAAC,CAAC;AAYF;;;;;GAKG;AACH,MAAM,YAAY,GAAyB,CAAC,IAI3C,EAAiC,EAAE;IAClC,MAAM,UAAU,GAAwB,cAAc,CACpD,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,IAAI,EAAE,CACjC,CAAC;IACF,MAAM,cAAc,GAAY,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,YAAY,CAAC;IAEvE,IAAI,UAAU,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;QACxD,OAAO;YACL,KAAK,EAAE,cAAc,IAAI,CAAC,KAAK,CAAC,GAAG,SAAS,UAAU,CAAC,EAAE,EAAE;YAC3D,IAAI,EAAE,UAAU,CAAC;gBACf,CAAC,YAAY,CAAC,EAAE,6BAA6B,CAAC,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE;oBACpE,YAAY;iBACb,CAAC;aACH,CAAC;YACF,WAAW,EAAE,aAAa,IAAI,CAAC,KAAK,CAAC,GAAG,WAAW,UAAU,CAAC,EAAE,0BAA0B;SAC3F,CAAC;IACJ,CAAC;IAED,IAAI,cAAc,EAAE,CAAC;QACnB,OAAO;YACL,KAAK,EAAE,aAAa,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE;YAC5D,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACzE,WAAW,EAAE,6CAA6C;SAC3D,CAAC;IACJ,CAAC;IAED,OAAO;QACL,KAAK,EAAE,cAAc;QACrB,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,UAAU,EAAE,CAAC;QAChD,WAAW,EAAE,wBAAwB,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG;KACvD,CAAC;AACJ,CAAC,CAAC;AAMF,MAAM,UAAU,GAAuB,CACrC,KAAiB,EACkB,EAAE;IACrC,OAAO;QACL,kBAAkB,CAAC,KAAK,CAAC,KAAK,CAAC;QAC/B,QAAQ,CAAC,sBAAsB,EAAE,iBAAiB,CAAC,OAAO,CAAC;KAC5D,CAAC;AACJ,CAAC,CAAC;AAMF,MAAM,YAAY,GAAyB,CACzC,KAAiB,EACkB,EAAE;IACrC,OAAO;QACL,kBAAkB,CAAC,KAAK,CAAC,KAAK,CAAC;QAC/B,QAAQ,CAAC,uBAAuB,EAAE,iBAAiB,CAAC,aAAa,CAAC;KACnE,CAAC;AACJ,CAAC,CAAC;AAIF,MAAM,gBAAgB,GAAkB,CACtC,KAAiB,EACY,EAAE;IAC/B,OAAO;QACL,KAAK,EAAE,eAAe;QACtB,UAAU,EAAE;YACV,gGAAgG,KAAK,CAAC,GAAG,mDAAmD;SAC7J;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAkB,CAC1C,KAAiB,EACY,EAAE;IAC/B,OAAO;QACL,KAAK,EAAE,mBAAmB;QAC1B,UAAU,EAAE;YACV,6BAA6B,KAAK,CAAC,IAAI,wFAAwF;SAChI;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,eAAe,GAAkB,CACrC,KAAiB,EACY,EAAE;IAC/B,OAAO;QACL,KAAK,EAAE,2BAA2B;QAClC,UAAU,EAAE;YACV,gBAAgB,KAAK,CAAC,GAAG,+GAA+G;SACzI;KACF,CAAC;AACJ,CAAC,CAAC;AAOF,MAAM,OAAO,GAAkB,CAC7B,OAAsC,EACtC,KAAiB,EACO,EAAE;IAC1B,OAAO;QACL,OAAO,EAAE,aAAa,KAAK,CAAC,GAAG,mDAAmD;QAClF,KAAK,EAAE;YACL,iCAAiC,KAAK,CAAC,GAAG,cAAc;YACxD,oFAAoF;YACpF,2EAA2E;SAC5E;QACD,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,uBAAuB,KAAK,CAAC,GAAG,WAAW;gBAClD,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBACxD,WAAW,EACT,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,YAAY;oBAC/B,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC,KAAK,KAAK,CAAC,OAAO,CAAC,EAAE,0CAA0C;aACtE;SACF;QACD,KAAK,EAAE;YACL;gBACE,IAAI,EAAE,8BAA8B,CAAC,GAAG;gBACxC,IAAI,EAAE,8EAA8E,KAAK,CAAC,GAAG,8CAA8C;aAC5I;SACF;QACD,SAAS,EAAE;4CAEJ,eAAe,CAAC,KAAK,CAAC,KACzB,OAAO,EAAE,YAAY,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;YAE9D,oBAAoB,CAAC,KAAK,CAAC;YAC3B,gBAAgB,CAAC,KAAK,CAAC;SACxB;QACD,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;KACzB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAkB,CAC9B,OAAsC,EACtC,KAAiB,EACO,EAAE;IAC1B,OAAO;QACL,OAAO,EAAE,aAAa,KAAK,CAAC,IAAI,mFAAmF;QACnH,KAAK,EAAE;YACL,iCAAiC,KAAK,CAAC,IAAI,cAAc;YACzD,oFAAoF;YACpF,2EAA2E;SAC5E;QACD,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,6BAA6B,KAAK,CAAC,GAAG,QAAQ;gBACrD,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,WAAW,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBAC5D,WAAW,EAAE,mDAAmD;aACjE;SACF;QACD,KAAK,EAAE;YACL;gBACE,IAAI,EAAE,8BAA8B,CAAC,GAAG;gBACxC,IAAI,EAAE,yBAAyB,KAAK,CAAC,IAAI,4DAA4D;aACtG;SACF;QACD,SAAS,EAAE;YACT;gBACE,KAAK,EAAE,eAAe,KAAK,CAAC,GAAG,eAAe;gBAC9C,UAAU,EAAE;oBACV,0HAA0H;iBAC3H;gBACD,OAAO,EAAE;oBACP,KAAK,EAAE,mBAAmB;oBAC1B,IAAI,EAAE,4BAA4B,OAAO,CAAC,MAAM,+BAA+B,KAAK,CAAC,OAAO,CAAC,EAAE,eAAe;iBAC/G;aACF;4CAEI,eAAe,CAAC,KAAK,CAAC,KACzB,OAAO,EAAE,YAAY,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;YAE/D,oBAAoB,CAAC,KAAK,CAAC;YAC3B,gBAAgB,CAAC,KAAK,CAAC;SACxB;QACD,KAAK,EAAE;YACL,GAAG,UAAU,CAAC,KAAK,CAAC;YACpB,QAAQ,CAAC,qBAAqB,EAAE,iBAAiB,CAAC,KAAK,CAAC;SACzD;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,SAAS,GAAkB,CAC/B,OAAsC,EACtC,KAAiB,EACO,EAAE;IAC1B,MAAM,QAAQ,GAAyB,wBAAwB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAE7E,OAAO;QACL,OAAO,EAAE,eAAe,KAAK,CAAC,GAAG,qCAAqC;QACtE,KAAK,EAAE;YACL,QAAQ,CAAC,MAAM,GAAG,CAAC;gBACjB,CAAC,CAAC,sCAAsC,KAAK,CAAC,GAAG,0CAA0C;gBAC3F,CAAC,CAAC,kCAAkC,KAAK,CAAC,GAAG,iCAAiC;YAChF,2EAA2E;YAC3E,eAAe,KAAK,CAAC,GAAG,wCAAwC;SACjE;QACD,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,WAAW,KAAK,CAAC,GAAG,OAAO;gBAClC,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,YAAY,CAAC,CAAC;aACrD;SACF;QACD,KAAK,EAAE;YACL;gBACE,IAAI,EAAE,8BAA8B,CAAC,GAAG;gBACxC,IAAI,EAAE,OAAO,KAAK,CAAC,GAAG,4EAA4E;aACnG;YACD;gBACE,IAAI,EAAE,8BAA8B,CAAC,OAAO;gBAC5C,IAAI,EAAE,gCAAgC,KAAK,CAAC,GAAG,6FAA6F;aAC7I;SACF;QACD,SAAS,EAAE;YACT;gBACE,KAAK,EAAE,oBAAoB;gBAC3B,UAAU,EAAE;oBACV,qIAAqI;iBACtI;gBACD,OAAO,EAAE;oBACP,KAAK,EAAE,OAAO,KAAK,CAAC,GAAG,EAAE;oBACzB,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;iBAChD;aACF;SACF;QACD,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;KACzB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,UAAU,GAAkB,CAChC,OAAsC,EACtC,KAAiB,EACO,EAAE;IAC1B,MAAM,QAAQ,GAAyB,wBAAwB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAE7E,OAAO;QACL,OAAO,EAAE,mBAAmB,KAAK,CAAC,IAAI,wCAAwC;QAC9E,KAAK,EAAE;YACL,oDAAoD,KAAK,CAAC,GAAG,wBAAwB;YACrF,2EAA2E;YAC3E,eAAe,KAAK,CAAC,IAAI,6BAA6B;SACvD;QACD,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,iBAAiB,KAAK,CAAC,GAAG,EAAE;gBACnC,IAAI,EAAE,UAAU,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;gBACjD,WAAW,EACT,QAAQ,CAAC,MAAM,GAAG,CAAC;oBACjB,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,UAAU,QAAQ;yBACjC,GAAG,CAAC,CAAC,MAAqB,EAAU,EAAE;wBACrC,OAAO,KAAK,MAAM,CAAC,EAAE,IAAI,CAAC;oBAC5B,CAAC,CAAC;yBACD,IAAI,CAAC,IAAI,CAAC,GAAG;oBAClB,CAAC,CAAC,uCAAuC,KAAK,CAAC,GAAG,GAAG;aAC1D;SACF;QACD,KAAK,EAAE;YACL;gBACE,IAAI,EAAE,8BAA8B,CAAC,GAAG;gBACxC,IAAI,EAAE,OAAO,KAAK,CAAC,IAAI,6EAA6E;aACrG;YACD;gBACE,IAAI,EAAE,8BAA8B,CAAC,OAAO;gBAC5C,IAAI,EAAE,gCAAgC,KAAK,CAAC,GAAG,6FAA6F;aAC7I;SACF;QACD,SAAS,EAAE;YACT;gBACE,KAAK,EAAE,yBAAyB;gBAChC,UAAU,EAAE;oBACV,KAAK,YAAY,CAAC,OAAO,EAAE,WAAW,EAAE,CAAC,YAAY,CAAC,CAAC,uBAAuB,KAAK,CAAC,GAAG,yCAAyC;iBACjI;aACF;SACF;QACD,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;KACzB,CAAC;AACJ,CAAC,CAAC;AAcF,yDAAyD;AACzD,MAAM,UAAU,GAAuB,CAAC,IAIvC,EAA+B,EAAE;IAChC,MAAM,QAAQ,GAAY,IAAI,CAAC,aAAa,KAAK,eAAe,CAAC;IAEjE,OAAO;QACL,KAAK,EAAE,mCAAmC;QAC1C,UAAU,EAAE;YACV,GAAG,QAAQ,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,mBAAmB,kBAAkB,IAAI,CAAC,KAAK,CAAC,IAAI,SAAS,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,2FAA2F;SAC7N;QACD,OAAO,EAAE;YACP,KAAK,EAAE,iBAAiB,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,EAAE;YAC1D,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC;SACrD;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,MAAM,GAA2B,CACrC,OAAsC,EACtC,KAAiB,EACjB,MAAe,EACS,EAAE;IAC1B,MAAM,OAAO,GAAe,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAE1D,OAAO;QACL,OAAO,EAAE,MAAM;YACb,CAAC,CAAC,eAAe,KAAK,CAAC,IAAI,sCAAsC;YACjE,CAAC,CAAC,eAAe,KAAK,CAAC,GAAG,wCAAwC;QACpE,KAAK,EAAE;YACL,MAAM;gBACJ,CAAC,CAAC,8BAA8B,KAAK,CAAC,IAAI,aAAa;gBACvD,CAAC,CAAC,8BAA8B,KAAK,CAAC,GAAG,gCAAgC;YAC3E,8EAA8E;YAC9E,2EAA2E;SAC5E;QACD,QAAQ,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;QAClE,KAAK,EAAE;YACL,MAAM;gBACJ,CAAC,CAAC;oBACE,IAAI,EAAE,8BAA8B,CAAC,OAAO;oBAC5C,IAAI,EAAE,yBAAyB,KAAK,CAAC,IAAI,qFAAqF;iBAC/H;gBACH,CAAC,CAAC;oBACE,IAAI,EAAE,8BAA8B,CAAC,GAAG;oBACxC,IAAI,EAAE,oBAAoB,KAAK,CAAC,GAAG,8DAA8D;iBAClG;YACL;gBACE,IAAI,EAAE,8BAA8B,CAAC,GAAG;gBACxC,IAAI,EAAE,4FAA4F;aACnG;SACF;QACD,SAAS,EAAE;YACT;gBACE,KAAK,EAAE,0BAA0B;gBACjC,UAAU,EAAE;oBACV,8HAA8H;iBAC/H;gBACD,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM;oBAClC,CAAC,CAAC,EAAE,KAAK,EAAE,oBAAoB,EAAE,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE;oBAC5D,CAAC,CAAC,SAAS;aACd;YACD,UAAU,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC;YAC9D,eAAe,CAAC,KAAK,CAAC;YACtB,oBAAoB,CAAC,KAAK,CAAC;YAC3B,gBAAgB,CAAC,KAAK,CAAC;SACxB;QACD,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;KACzB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,MAAM,GAA2B,CACrC,OAAsC,EACtC,KAAiB,EACjB,MAAe,EACS,EAAE;IAC1B,OAAO;QACL,OAAO,EAAE,MAAM;YACb,CAAC,CAAC,eAAe,KAAK,CAAC,IAAI,sCAAsC;YACjE,CAAC,CAAC,eAAe,KAAK,CAAC,GAAG,wCAAwC;QACpE,KAAK,EAAE;YACL,MAAM;gBACJ,CAAC,CAAC,8BAA8B,KAAK,CAAC,IAAI,aAAa;gBACvD,CAAC,CAAC,8BAA8B,KAAK,CAAC,GAAG,gCAAgC;YAC3E,2EAA2E;SAC5E;QACD,QAAQ,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;QAClE,KAAK,EAAE,MAAM;YACX,CAAC,CAAC;gBACE;oBACE,IAAI,EAAE,8BAA8B,CAAC,OAAO;oBAC5C,IAAI,EAAE,+DAA+D,KAAK,CAAC,GAAG,iFAAiF;iBAChK;gBACD;oBACE,IAAI,EAAE,8BAA8B,CAAC,GAAG;oBACxC,IAAI,EAAE,4FAA4F;iBACnG;aACF;YACH,CAAC,CAAC;gBACE;oBACE,IAAI,EAAE,8BAA8B,CAAC,OAAO;oBAC5C,IAAI,EAAE,mEAAmE;iBAC1E;gBACD;oBACE,IAAI,EAAE,8BAA8B,CAAC,GAAG;oBACxC,IAAI,EAAE,4FAA4F;iBACnG;aACF;QACL,SAAS,EAAE;YACT,UAAU,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC;YAC9D,eAAe,CAAC,KAAK,CAAC;YACtB,oBAAoB,CAAC,KAAK,CAAC;YAC3B,gBAAgB,CAAC,KAAK,CAAC;SACxB;QACD,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;KACzB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAA2B,CAC/C,OAAsC,EACtC,KAAiB,EACjB,QAAiB,EACO,EAAE;IAC1B,MAAM,KAAK,GAAW,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;IAEvD,OAAO;QACL,OAAO,EAAE,QAAQ;YACf,CAAC,CAAC,wDAAwD,KAAK,CAAC,IAAI,WAAW;YAC/E,CAAC,CAAC,wCAAwC,KAAK,CAAC,GAAG,8BAA8B;QACnF,KAAK,EAAE;YACL,GAAG,CAAC,QAAQ;gBACV,CAAC,CAAC;oBACE,+GAA+G;iBAChH;gBACH,CAAC,CAAC,EAAE,CAAC;YACP,qDAAqD,KAAK,CAAC,GAAG,oBAAoB;YAClF,0CAA0C;YAC1C,8BAA8B,KAAK,CAAC,IAAI,IAAI,KAAK,8BAA8B;SAChF;QACD,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,uBAAuB,KAAK,CAAC,GAAG,kBAAkB;gBACzD,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBACxD,WAAW,EACT,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,YAAY;oBAC/B,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC,KAAK,KAAK,CAAC,OAAO,CAAC,EAAE,0CAA0C;aACtE;SACF;QACD,KAAK,EAAE;YACL;gBACE,IAAI,EAAE,8BAA8B,CAAC,OAAO;gBAC5C,IAAI,EAAE,kFAAkF,KAAK,CAAC,GAAG,UAAU;aAC5G;YACD,GAAG,CAAC,QAAQ;gBACV,CAAC,CAAC;oBACE;wBACE,IAAI,EAAE,8BAA8B,CAAC,GAAG;wBACxC,IAAI,EAAE,sIAAsI;qBAC7I;iBACF;gBACH,CAAC,CAAC,EAAE,CAAC;SACR;QACD,SAAS,EAAE;YACT;gBACE,KAAK,EAAE,YAAY;gBACnB,UAAU,EAAE;oBACV,2EAA2E,KAAK,CAAC,GAAG,kCAAkC,KAAK,CAAC,GAAG,kBAAkB,KAAK,GAAG;iBAC1J;aACF;SACF;QACD,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC;KAC3B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAkB,CAC9B,OAAsC,EACtC,KAAiB,EACO,EAAE;IAC1B,OAAO;QACL,OAAO,EAAE,wDAAwD,KAAK,CAAC,IAAI,cAAc;QACzF,KAAK,EAAE;YACL,0CAA0C;YAC1C,8BAA8B,KAAK,CAAC,IAAI,sCAAsC;SAC/E;QACD,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,eAAe,KAAK,CAAC,GAAG,OAAO;gBACtC,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,YAAY,CAAC,CAAC;aACrD;SACF;QACD,KAAK,EAAE;YACL;gBACE,IAAI,EAAE,8BAA8B,CAAC,OAAO;gBAC5C,IAAI,EAAE,iCAAiC,KAAK,CAAC,GAAG,yFAAyF;aAC1I;SACF;QACD,SAAS,EAAE;YACT;gBACE,KAAK,EAAE,YAAY;gBACnB,UAAU,EAAE;oBACV,2EAA2E,KAAK,CAAC,GAAG,kCAAkC,KAAK,CAAC,GAAG,yBAAyB;iBACzJ;aACF;SACF;QACD,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC;KAC3B,CAAC;AACJ,CAAC,CAAC;AAMF;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAqC,CACxE,OAAsC,EACP,EAAE;IACjC,MAAM,SAAS,GAAuB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;IAEjE,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,SAAS,GAA6B,oBAAoB,CAAC;QAC/D,WAAW,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE;QAChC,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IACH,MAAM,KAAK,GAAqB,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE5D,IAAI,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAe;QACxB,KAAK,EAAE,KAAK;QACZ,GAAG,EAAE,KAAK,CAAC,YAAY,IAAI,SAAS;QACpC,IAAI,EAAE,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,YAAY,IAAI,SAAS;QACzD,OAAO,EAAE,gBAAgB,CAAC,KAAK,CAAC;KACjC,CAAC;IAEF,QAAQ,SAAS,EAAE,CAAC;QAClB,KAAK,iBAAiB,CAAC,OAAO;YAC5B,OAAO,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACjC,KAAK,iBAAiB,CAAC,QAAQ;YAC7B,OAAO,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAClC,KAAK,iBAAiB,CAAC,SAAS;YAC9B,OAAO,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACnC,KAAK,iBAAiB,CAAC,UAAU;YAC/B,OAAO,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACpC,KAAK,iBAAiB,CAAC,SAAS;YAC9B,OAAO,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QACvC,KAAK,iBAAiB,CAAC,UAAU;YAC/B,OAAO,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QACtC,KAAK,iBAAiB,CAAC,SAAS;YAC9B,OAAO,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QACvC,KAAK,iBAAiB,CAAC,UAAU;YAC/B,OAAO,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QACtC,KAAK,iBAAiB,CAAC,QAAQ;YAC7B,OAAO,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QACjD,KAAK,iBAAiB,CAAC,QAAQ;YAC7B,OAAO,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAChD,KAAK,iBAAiB,CAAC,QAAQ;YAC7B,OAAO,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;AACH,CAAC,CAAC"}

package/build/dist/Types/Workflow/Documentation/DocumentationContext.js

@@ -0,0 +1,139 @@
+/*
+ * What a step's help is written from: the step itself, the identifier it has
+ * in this workflow right now, and the other steps around it. That is what
+ * lets an example read "{{local.components.incident-create-one-1...}}" - the
+ * reference the user would actually paste - instead of a placeholder they
+ * have to work out how to fill in.
+ */
+import { ComponentType, NodeType, } from "../Component";
+import ComponentID from "../ComponentID";
+import { componentReturnValueReference } from "../TemplateSyntax";
+import { ID_COLUMN_ID, getDisplayColumn, getWorkflowModel, } from "./ModelExamples";
+/** A reference to one of this step's own return values. */
+export const ownReference = (context, returnValueId, path) => {
+    return componentReturnValueReference(context.stepId, returnValueId, path);
+};
+/*
+ * The return value a step is mostly read for, where that is not simply its
+ * first one. API steps lead with "Error", which is the last thing a message
+ * should be built from.
+ */
+const MAIN_RETURN_VALUE_BY_COMPONENT = {
+    [ComponentID.ApiGet]: "response-body",
+    [ComponentID.ApiPost]: "response-body",
+    [ComponentID.ApiPut]: "response-body",
+    [ComponentID.ApiPatch]: "response-body",
+    [ComponentID.ApiDelete]: "response-body",
+    [ComponentID.AIGenerateText]: "response",
+    [ComponentID.JavaScriptCode]: "returnValue",
+    [ComponentID.IncomingEmail]: "subject",
+};
+// What an example would read from one particular step, if anything.
+const sampleValueOfStep = (step) => {
+    const metadata = step.metadata;
+    const returnValueIds = (metadata.returnValues || []).map((returnValue) => {
+        return returnValue.id;
+    });
+    if (metadata.tableName) {
+        const model = getWorkflowModel(metadata.tableName);
+        const display = model
+            ? getDisplayColumn(model)
+            : null;
+        const column = display ? display.id : ID_COLUMN_ID;
+        const name = (model === null || model === void 0 ? void 0 : model.singularName) || metadata.tableName;
+        const columnTitle = display ? display.title : "ID";
+        if (returnValueIds.includes("model")) {
+            return {
+                reference: componentReturnValueReference(step.id, "model", [column]),
+                stepId: step.id,
+                description: `the ${columnTitle} of the ${name} from \`${step.id}\``,
+            };
+        }
+        if (returnValueIds.includes("models")) {
+            // The runtime reads list items as models[0] (VMAPI.deepFind).
+            return {
+                reference: componentReturnValueReference(step.id, "models[0]", [
+                    column,
+                ]),
+                stepId: step.id,
+                description: `the ${columnTitle} of the first ${name} from \`${step.id}\``,
+            };
+        }
+        return null;
+    }
+    if (metadata.id === ComponentID.Webhook) {
+        return {
+            reference: componentReturnValueReference(step.id, "request-body", [
+                "message",
+            ]),
+            stepId: step.id,
+            description: `the message field of the request body \`${step.id}\` received`,
+        };
+    }
+    const main = MAIN_RETURN_VALUE_BY_COMPONENT[metadata.id] ||
+        returnValueIds.find((id) => {
+            return id !== "error";
+        });
+    if (!main) {
+        return null;
+    }
+    const returnValue = (metadata.returnValues || []).find((candidate) => {
+        return candidate.id === main;
+    });
+    return {
+        reference: componentReturnValueReference(step.id, main),
+        stepId: step.id,
+        description: `the ${(returnValue === null || returnValue === void 0 ? void 0 : returnValue.name) || main} from \`${step.id}\``,
+    };
+};
+/** The workflow's other real steps: not this one, not a placeholder. */
+export const otherSteps = (context) => {
+    return (context.graphComponents || []).filter((step) => {
+        return (Boolean(step) &&
+            Boolean(step.metadata) &&
+            step.nodeType !== NodeType.PlaceholderNode &&
+            step.id !== context.stepId);
+    });
+};
+/**
+ * A value from another step of this workflow, for an example to put in a
+ * message or a setting: the trigger's first, since that is what most steps
+ * are about, then any other step's. Null when no other step returns anything,
+ * and the example then does without one.
+ */
+export const getSampleValue = (context) => {
+    const steps = otherSteps(context);
+    const ordered = [
+        ...steps.filter((step) => {
+            return step.metadata.componentType === ComponentType.Trigger;
+        }),
+        ...steps.filter((step) => {
+            return step.metadata.componentType !== ComponentType.Trigger;
+        }),
+    ];
+    for (const step of ordered) {
+        const sample = sampleValueOfStep(step);
+        if (sample) {
+            return sample;
+        }
+    }
+    return null;
+};
+/**
+ * Another step that hands on one record of this table - a trigger, a Find One
+ * or a Create One - so a query can pick that same record by its ID.
+ */
+export const findRecordStep = (context, tableName) => {
+    const steps = otherSteps(context).filter((step) => {
+        return (step.metadata.tableName === tableName &&
+            (step.metadata.returnValues || []).some((returnValue) => {
+                return returnValue.id === "model";
+            }));
+    });
+    return (steps.find((step) => {
+        return step.metadata.componentType === ComponentType.Trigger;
+    }) ||
+        steps[0] ||
+        null);
+};
+//# sourceMappingURL=DocumentationContext.js.map

package/build/dist/Types/Workflow/Documentation/DocumentationContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocumentationContext.js","sourceRoot":"","sources":["../../../../../Types/Workflow/Documentation/DocumentationContext.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAA0B,EACxB,aAAa,EAEb,QAAQ,GACT,MAAM,cAAc,CAAC;AACtB,OAAO,WAAW,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAE,6BAA6B,EAAE,MAAM,mBAAmB,CAAC;AAElE,OAAO,EAEL,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,iBAAiB,CAAC;AAoBzB,2DAA2D;AAC3D,MAAM,CAAC,MAAM,YAAY,GAAyB,CAChD,OAAsC,EACtC,aAAqB,EACrB,IAAgC,EACxB,EAAE;IACV,OAAO,6BAA6B,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AAC5E,CAAC,CAAC;AAeF;;;;GAIG;AACH,MAAM,8BAA8B,GAAoC;IACtE,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,eAAe;IACrC,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,eAAe;IACtC,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,eAAe;IACrC,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,eAAe;IACvC,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,eAAe;IACxC,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,UAAU;IACxC,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,aAAa;IAC3C,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,SAAS;CACvC,CAAC;AAIF,oEAAoE;AACpE,MAAM,iBAAiB,GAA8B,CACnD,IAAkB,EACE,EAAE;IACtB,MAAM,QAAQ,GAAsB,IAAI,CAAC,QAAQ,CAAC;IAClD,MAAM,cAAc,GAAkB,CAAC,QAAQ,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,GAAG,CACrE,CAAC,WAA2B,EAAU,EAAE;QACtC,OAAO,WAAW,CAAC,EAAE,CAAC;IACxB,CAAC,CACF,CAAC;IAEF,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,MAAM,KAAK,GAAqB,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACrE,MAAM,OAAO,GAAyB,KAAK;YACzC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC;YACzB,CAAC,CAAC,IAAI,CAAC;QACT,MAAM,MAAM,GAAW,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC;QAC3D,MAAM,IAAI,GAAW,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,KAAI,QAAQ,CAAC,SAAS,CAAC;QAC/D,MAAM,WAAW,GAAW,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QAE3D,IAAI,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,OAAO;gBACL,SAAS,EAAE,6BAA6B,CAAC,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;gBACpE,MAAM,EAAE,IAAI,CAAC,EAAE;gBACf,WAAW,EAAE,OAAO,WAAW,WAAW,IAAI,WAAW,IAAI,CAAC,EAAE,IAAI;aACrE,CAAC;QACJ,CAAC;QAED,IAAI,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACtC,8DAA8D;YAC9D,OAAO;gBACL,SAAS,EAAE,6BAA6B,CAAC,IAAI,CAAC,EAAE,EAAE,WAAW,EAAE;oBAC7D,MAAM;iBACP,CAAC;gBACF,MAAM,EAAE,IAAI,CAAC,EAAE;gBACf,WAAW,EAAE,OAAO,WAAW,iBAAiB,IAAI,WAAW,IAAI,CAAC,EAAE,IAAI;aAC3E,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,QAAQ,CAAC,EAAE,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;QACxC,OAAO;YACL,SAAS,EAAE,6BAA6B,CAAC,IAAI,CAAC,EAAE,EAAE,cAAc,EAAE;gBAChE,SAAS;aACV,CAAC;YACF,MAAM,EAAE,IAAI,CAAC,EAAE;YACf,WAAW,EAAE,2CAA2C,IAAI,CAAC,EAAE,aAAa;SAC7E,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,GACR,8BAA8B,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3C,cAAc,CAAC,IAAI,CAAC,CAAC,EAAU,EAAW,EAAE;YAC1C,OAAO,EAAE,KAAK,OAAO,CAAC;QACxB,CAAC,CAAC,CAAC;IAEL,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,WAAW,GAA6C,CAC5D,QAAQ,CAAC,YAAY,IAAI,EAAE,CAC5B,CAAC,IAAI,CAAC,CAAC,SAAyB,EAAW,EAAE;QAC5C,OAAO,SAAS,CAAC,EAAE,KAAK,IAAI,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,SAAS,EAAE,6BAA6B,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC;QACvD,MAAM,EAAE,IAAI,CAAC,EAAE;QACf,WAAW,EAAE,OAAO,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,KAAI,IAAI,WAAW,IAAI,CAAC,EAAE,IAAI;KACpE,CAAC;AACJ,CAAC,CAAC;AAMF,wEAAwE;AACxE,MAAM,CAAC,MAAM,UAAU,GAAuB,CAC5C,OAAsC,EACjB,EAAE;IACvB,OAAO,CAAC,OAAO,CAAC,eAAe,IAAI,EAAE,CAAC,CAAC,MAAM,CAC3C,CAAC,IAAkB,EAAW,EAAE;QAC9B,OAAO,CACL,OAAO,CAAC,IAAI,CAAC;YACb,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;YACtB,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,eAAe;YAC1C,IAAI,CAAC,EAAE,KAAK,OAAO,CAAC,MAAM,CAC3B,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAMF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAA2B,CACpD,OAAsC,EAClB,EAAE;IACtB,MAAM,KAAK,GAAwB,UAAU,CAAC,OAAO,CAAC,CAAC;IACvD,MAAM,OAAO,GAAwB;QACnC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAkB,EAAW,EAAE;YAC9C,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,KAAK,aAAa,CAAC,OAAO,CAAC;QAC/D,CAAC,CAAC;QACF,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAkB,EAAW,EAAE;YAC9C,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,KAAK,aAAa,CAAC,OAAO,CAAC;QAC/D,CAAC,CAAC;KACH,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC3B,MAAM,MAAM,GAAuB,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAE3D,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAC;QAChB,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAOF;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAA2B,CACpD,OAAsC,EACtC,SAAiB,EACI,EAAE;IACvB,MAAM,KAAK,GAAwB,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,CAC3D,CAAC,IAAkB,EAAW,EAAE;QAC9B,OAAO,CACL,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS;YACrC,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,IAAI,CACrC,CAAC,WAA2B,EAAW,EAAE;gBACvC,OAAO,WAAW,CAAC,EAAE,KAAK,OAAO,CAAC;YACpC,CAAC,CACF,CACF,CAAC;IACJ,CAAC,CACF,CAAC;IAEF,OAAO,CACL,KAAK,CAAC,IAAI,CAAC,CAAC,IAAkB,EAAW,EAAE;QACzC,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,KAAK,aAAa,CAAC,OAAO,CAAC;IAC/D,CAAC,CAAC;QACF,KAAK,CAAC,CAAC,CAAC;QACR,IAAI,CACL,CAAC;AACJ,CAAC,CAAC"}