@oneuptime/common 14.0.11 → 14.0.12

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

@@ -0,0 +1,210 @@
+/*
+ * Concrete values for the help on a database step, read off the model itself.
+ *
+ * The help used to say "Create writes new records. The fields are this
+ * model's own columns" - true of every one of the 227 models and specific to
+ * none. These read a model's real columns, so Find One Incident's example
+ * reads the incident's title and Create Many Monitors' example is a monitor
+ * with a name and a monitor type, using the example values the models already
+ * carry for the API reference.
+ *
+ * The column rules mirror the record editor's (ColumnUse.ts and the
+ * /model-schema endpoint): a create example never sets a column OneUptime
+ * fills in itself, the project, a relation, or one the model will not let a
+ * create set.
+ */
+import { getModelTypeByName } from "../../../Models/DatabaseModels/Index";
+import { getTableColumns, } from "../../Database/TableColumn";
+import TableColumnType from "../../Database/TableColumnType";
+import { isSystemColumnId } from "../SystemColumns";
+/*
+ * The column that says which record this is, in the order a person would
+ * look for one. A model with none of these is referred to by its ID.
+ */
+const DISPLAY_COLUMN_IDS = ["name", "title", "subject", "email"];
+// The ID every record has, used when a model has no better column.
+export const ID_COLUMN_ID = "_id";
+// The placeholder the database steps' own Query box shows.
+export const EXAMPLE_ID = "00000000-0000-0000-0000-000000000000";
+/** The model a database step reads or writes, from its table name. */
+export const getWorkflowModel = (tableName) => {
+    const modelType = getModelTypeByName(tableName);
+    return modelType ? new modelType() : null;
+};
+const isRelationType = (type) => {
+    return (type === TableColumnType.Entity || type === TableColumnType.EntityArray);
+};
+const describeColumns = (model) => {
+    const columns = getTableColumns(model);
+    const accessControl = model.getColumnAccessControlForAllColumns();
+    const tenantColumn = model.getTenantColumn();
+    return Object.keys(columns).map((id) => {
+        const metadata = columns[id];
+        const acl = accessControl[id];
+        return {
+            id: id,
+            metadata: metadata,
+            canCreate: Boolean(acl && acl.create && acl.create.length > 0),
+            canUpdate: Boolean(acl && acl.update && acl.update.length > 0),
+            isSystem: isSystemColumnId(id) ||
+                Boolean(metadata.computed) ||
+                Boolean(metadata.forceGetDefaultValueOnCreate),
+            /*
+             * The project column and the relation that shares it. The runner stamps
+             * both, so no example should suggest setting either.
+             */
+            isTenant: Boolean(tenantColumn) &&
+                (id === tenantColumn ||
+                    metadata.manyToOneRelationColumn === tenantColumn),
+            hasDefault: Boolean(metadata.isDefaultValueColumn) ||
+                metadata.defaultValue !== undefined,
+        };
+    });
+};
+// A value of the right kind, for a column the model gives no example for.
+const placeholderForType = (metadata) => {
+    switch (metadata.type) {
+        case TableColumnType.Boolean:
+            return true;
+        case TableColumnType.Number:
+        case TableColumnType.SmallNumber:
+        case TableColumnType.BigNumber:
+        case TableColumnType.PositiveNumber:
+        case TableColumnType.SmallPositiveNumber:
+        case TableColumnType.BigPositiveNumber:
+        case TableColumnType.Port:
+            return 1;
+        case TableColumnType.ObjectID:
+            return EXAMPLE_ID;
+        case TableColumnType.Date:
+            return "2026-01-01T00:00:00.000Z";
+        case TableColumnType.Color:
+            return "#2563eb";
+        case TableColumnType.Email:
+            return "someone@example.com";
+        default:
+            return metadata.title ? `Example ${metadata.title}` : "Example";
+    }
+};
+/*
+ * The model's own example where it is a plain value. Objects and lists are
+ * left out: a monitor's steps or a JSON blob would swamp a one-line example.
+ */
+const exampleValue = (metadata) => {
+    const example = metadata.example;
+    /*
+     * An ID in an example stands for one to paste in. The models' own example
+     * IDs are opaque - some are not even hexadecimal - so every ID column shows
+     * the same obvious placeholder instead.
+     */
+    if (metadata.type === TableColumnType.ObjectID) {
+        return EXAMPLE_ID;
+    }
+    if (typeof example === "string" ||
+        typeof example === "number" ||
+        typeof example === "boolean") {
+        return example;
+    }
+    return placeholderForType(metadata);
+};
+const toExampleColumn = (column) => {
+    return {
+        id: column.id,
+        title: column.metadata.title || column.id,
+        example: exampleValue(column.metadata),
+    };
+};
+/**
+ * The column that names a record - an incident's title, a monitor's name -
+ * or its ID when the model has no such column.
+ */
+export const getDisplayColumn = (model) => {
+    const columns = describeColumns(model);
+    for (const id of DISPLAY_COLUMN_IDS) {
+        const column = columns.find((candidate) => {
+            return candidate.id === id && !isRelationType(candidate.metadata.type);
+        });
+        if (column) {
+            return toExampleColumn(column);
+        }
+    }
+    return { id: ID_COLUMN_ID, title: "ID", example: EXAMPLE_ID };
+};
+/**
+ * The columns a create must be given, by the server's own rule: required and
+ * without a default, less what OneUptime fills in and what a create may not
+ * set. The record editor opens with a row for each of these.
+ */
+export const getRequiredCreateColumns = (model) => {
+    return describeColumns(model)
+        .filter((column) => {
+        return (Boolean(column.metadata.required) &&
+            !column.hasDefault &&
+            !column.isSystem &&
+            !column.isTenant &&
+            !isRelationType(column.metadata.type) &&
+            column.canCreate);
+    })
+        .map(toExampleColumn);
+};
+// At most this many fields in an example record: enough to see the shape.
+const MAX_EXAMPLE_FIELDS = 3;
+/**
+ * A record that a create would accept: the required fields, then the column
+ * that names a record, with the model's example values.
+ */
+export const getExampleRecord = (model) => {
+    const record = {};
+    const columns = describeColumns(model);
+    const display = getDisplayColumn(model);
+    const displayColumn = columns.find((column) => {
+        return column.id === display.id;
+    });
+    const fields = getRequiredCreateColumns(model);
+    if (displayColumn &&
+        displayColumn.canCreate &&
+        !displayColumn.isSystem &&
+        !fields.some((field) => {
+            return field.id === display.id;
+        })) {
+        fields.unshift(display);
+    }
+    for (const field of fields.slice(0, MAX_EXAMPLE_FIELDS)) {
+        record[field.id] = field.example;
+    }
+    return record;
+};
+/**
+ * One field an update could change, with a new value. Not the field that
+ * names a record where there is another choice: the query example matches on
+ * that one, and an update that sets the field it matched on to the value it
+ * matched reads as if it did nothing. So the first other field an update may
+ * set that the model gives a plain example for, else the naming field, else
+ * any field an update may set.
+ */
+export const getExampleUpdate = (model) => {
+    const columns = describeColumns(model).filter((column) => {
+        return (column.canUpdate &&
+            !column.isSystem &&
+            !column.isTenant &&
+            !isRelationType(column.metadata.type));
+    });
+    const display = getDisplayColumn(model);
+    const chosen = columns.find((column) => {
+        const example = column.metadata.example;
+        return (column.id !== display.id &&
+            column.metadata.type !== TableColumnType.ObjectID &&
+            (typeof example === "string" ||
+                typeof example === "number" ||
+                typeof example === "boolean"));
+    }) ||
+        columns.find((column) => {
+            return column.id === display.id;
+        }) ||
+        columns[0];
+    if (!chosen) {
+        return {};
+    }
+    return { [chosen.id]: exampleValue(chosen.metadata) };
+};
+//# sourceMappingURL=ModelExamples.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ModelExamples.js","sourceRoot":"","sources":["../../../../../Types/Workflow/Documentation/ModelExamples.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAE1E,OAAO,EAEL,eAAe,GAChB,MAAM,4BAA4B,CAAC;AACpC,OAAO,eAAe,MAAM,gCAAgC,CAAC;AAG7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAYpD;;;GAGG;AACH,MAAM,kBAAkB,GAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AAEhF,mEAAmE;AACnE,MAAM,CAAC,MAAM,YAAY,GAAW,KAAK,CAAC;AAE1C,2DAA2D;AAC3D,MAAM,CAAC,MAAM,UAAU,GAAW,sCAAsC,CAAC;AAIzE,sEAAsE;AACtE,MAAM,CAAC,MAAM,gBAAgB,GAA6B,CACxD,SAAiB,EACC,EAAE;IACpB,MAAM,SAAS,GAAiC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAE9E,OAAO,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AAC5C,CAAC,CAAC;AAIF,MAAM,cAAc,GAA2B,CAC7C,IAAqB,EACZ,EAAE;IACX,OAAO,CACL,IAAI,KAAK,eAAe,CAAC,MAAM,IAAI,IAAI,KAAK,eAAe,CAAC,WAAW,CACxE,CAAC;AACJ,CAAC,CAAC;AAcF,MAAM,eAAe,GAA4B,CAC/C,KAAgB,EACM,EAAE;IACxB,MAAM,OAAO,GAAoC,eAAe,CAAC,KAAK,CAAC,CAAC;IACxE,MAAM,aAAa,GACjB,KAAK,CAAC,mCAAmC,EAAE,CAAC;IAC9C,MAAM,YAAY,GAAkB,KAAK,CAAC,eAAe,EAAE,CAAC;IAE5D,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,EAAU,EAAiB,EAAE;QAC5D,MAAM,QAAQ,GAAwB,OAAO,CAAC,EAAE,CAAwB,CAAC;QACzE,MAAM,GAAG,GAAoC,aAAa,CAAC,EAAE,CAAC,CAAC;QAE/D,OAAO;YACL,EAAE,EAAE,EAAE;YACN,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;YAC9D,SAAS,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;YAC9D,QAAQ,EACN,gBAAgB,CAAC,EAAE,CAAC;gBACpB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAC1B,OAAO,CAAC,QAAQ,CAAC,4BAA4B,CAAC;YAChD;;;eAGG;YACH,QAAQ,EACN,OAAO,CAAC,YAAY,CAAC;gBACrB,CAAC,EAAE,KAAK,YAAY;oBAClB,QAAQ,CAAC,uBAAuB,KAAK,YAAY,CAAC;YACtD,UAAU,EACR,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC;gBACtC,QAAQ,CAAC,YAAY,KAAK,SAAS;SACtC,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAIF,0EAA0E;AAC1E,MAAM,kBAAkB,GAA+B,CACrD,QAA6B,EAClB,EAAE;IACb,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtB,KAAK,eAAe,CAAC,OAAO;YAC1B,OAAO,IAAI,CAAC;QACd,KAAK,eAAe,CAAC,MAAM,CAAC;QAC5B,KAAK,eAAe,CAAC,WAAW,CAAC;QACjC,KAAK,eAAe,CAAC,SAAS,CAAC;QAC/B,KAAK,eAAe,CAAC,cAAc,CAAC;QACpC,KAAK,eAAe,CAAC,mBAAmB,CAAC;QACzC,KAAK,eAAe,CAAC,iBAAiB,CAAC;QACvC,KAAK,eAAe,CAAC,IAAI;YACvB,OAAO,CAAC,CAAC;QACX,KAAK,eAAe,CAAC,QAAQ;YAC3B,OAAO,UAAU,CAAC;QACpB,KAAK,eAAe,CAAC,IAAI;YACvB,OAAO,0BAA0B,CAAC;QACpC,KAAK,eAAe,CAAC,KAAK;YACxB,OAAO,SAAS,CAAC;QACnB,KAAK,eAAe,CAAC,KAAK;YACxB,OAAO,qBAAqB,CAAC;QAC/B;YACE,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IACpE,CAAC;AACH,CAAC,CAAC;AAIF;;;GAGG;AACH,MAAM,YAAY,GAAyB,CACzC,QAA6B,EAClB,EAAE;IACb,MAAM,OAAO,GAAY,QAAQ,CAAC,OAAO,CAAC;IAE1C;;;;OAIG;IACH,IAAI,QAAQ,CAAC,IAAI,KAAK,eAAe,CAAC,QAAQ,EAAE,CAAC;QAC/C,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,IACE,OAAO,OAAO,KAAK,QAAQ;QAC3B,OAAO,OAAO,KAAK,QAAQ;QAC3B,OAAO,OAAO,KAAK,SAAS,EAC5B,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,OAAO,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AACtC,CAAC,CAAC;AAIF,MAAM,eAAe,GAA4B,CAC/C,MAAqB,EACN,EAAE;IACjB,OAAO;QACL,EAAE,EAAE,MAAM,CAAC,EAAE;QACb,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,IAAI,MAAM,CAAC,EAAE;QACzC,OAAO,EAAE,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC;KACvC,CAAC;AACJ,CAAC,CAAC;AAIF;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAA6B,CACxD,KAAgB,EACD,EAAE;IACjB,MAAM,OAAO,GAAyB,eAAe,CAAC,KAAK,CAAC,CAAC;IAE7D,KAAK,MAAM,EAAE,IAAI,kBAAkB,EAAE,CAAC;QACpC,MAAM,MAAM,GAA8B,OAAO,CAAC,IAAI,CACpD,CAAC,SAAwB,EAAW,EAAE;YACpC,OAAO,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzE,CAAC,CACF,CAAC;QAEF,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AAChE,CAAC,CAAC;AAMF;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAqC,CACxE,KAAgB,EACM,EAAE;IACxB,OAAO,eAAe,CAAC,KAAK,CAAC;SAC1B,MAAM,CAAC,CAAC,MAAqB,EAAW,EAAE;QACzC,OAAO,CACL,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACjC,CAAC,MAAM,CAAC,UAAU;YAClB,CAAC,MAAM,CAAC,QAAQ;YAChB,CAAC,MAAM,CAAC,QAAQ;YAChB,CAAC,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACrC,MAAM,CAAC,SAAS,CACjB,CAAC;IACJ,CAAC,CAAC;SACD,GAAG,CAAC,eAAe,CAAC,CAAC;AAC1B,CAAC,CAAC;AAEF,0EAA0E;AAC1E,MAAM,kBAAkB,GAAW,CAAC,CAAC;AAIrC;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAA6B,CACxD,KAAgB,EACJ,EAAE;IACd,MAAM,MAAM,GAAe,EAAE,CAAC;IAC9B,MAAM,OAAO,GAAyB,eAAe,CAAC,KAAK,CAAC,CAAC;IAC7D,MAAM,OAAO,GAAkB,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACvD,MAAM,aAAa,GAA8B,OAAO,CAAC,IAAI,CAC3D,CAAC,MAAqB,EAAW,EAAE;QACjC,OAAO,MAAM,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,CAAC;IAClC,CAAC,CACF,CAAC;IAEF,MAAM,MAAM,GAAyB,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAErE,IACE,aAAa;QACb,aAAa,CAAC,SAAS;QACvB,CAAC,aAAa,CAAC,QAAQ;QACvB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAoB,EAAW,EAAE;YAC7C,OAAO,KAAK,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,CAAC;QACjC,CAAC,CAAC,EACF,CAAC;QACD,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,kBAAkB,CAAC,EAAE,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC;IACnC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAIF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAA6B,CACxD,KAAgB,EACJ,EAAE;IACd,MAAM,OAAO,GAAyB,eAAe,CAAC,KAAK,CAAC,CAAC,MAAM,CACjE,CAAC,MAAqB,EAAW,EAAE;QACjC,OAAO,CACL,MAAM,CAAC,SAAS;YAChB,CAAC,MAAM,CAAC,QAAQ;YAChB,CAAC,MAAM,CAAC,QAAQ;YAChB,CAAC,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CACtC,CAAC;IACJ,CAAC,CACF,CAAC;IAEF,MAAM,OAAO,GAAkB,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACvD,MAAM,MAAM,GACV,OAAO,CAAC,IAAI,CAAC,CAAC,MAAqB,EAAW,EAAE;QAC9C,MAAM,OAAO,GAAY,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;QAEjD,OAAO,CACL,MAAM,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE;YACxB,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,eAAe,CAAC,QAAQ;YACjD,CAAC,OAAO,OAAO,KAAK,QAAQ;gBAC1B,OAAO,OAAO,KAAK,QAAQ;gBAC3B,OAAO,OAAO,KAAK,SAAS,CAAC,CAChC,CAAC;IACJ,CAAC,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,MAAqB,EAAW,EAAE;YAC9C,OAAO,MAAM,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,CAAC;QAClC,CAAC,CAAC;QACF,OAAO,CAAC,CAAC,CAAC,CAAC;IAEb,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;AACxD,CAAC,CAAC"}

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

@@ -0,0 +1,184 @@
+/*
+ * Help for the triggers that are not about a database record: Webhook,
+ * Incoming Email, Schedule and Manual. The database triggers are in
+ * DatabaseDocumentation.ts.
+ *
+ * Webhook, Incoming Email and Manual open on a panel of their own
+ * (ComponentPrimaryPanel), so their help does not repeat what that panel
+ * already says - the URL or address, how a run is started - and is about what
+ * comes next.
+ */
+import { ComponentDocumentationNoteType, } from "./ComponentDocumentation";
+import { ownReference, } from "./DocumentationContext";
+import { WorkflowDocsPaths, docsLink } from "./DocumentationLinks";
+import { IncomingEmailTriggerValue } from "../IncomingEmailTrigger";
+export const getWebhookDocumentation = (context) => {
+    return {
+        summary: "Starts this workflow each time another app or service calls its URL.",
+        steps: [
+            "Copy the URL at the top of this dialog into the app that should start the workflow.",
+            "Connect **Out** to the steps that should run on each call.",
+            "Turn the workflow on. While it is off, calls to the URL are refused.",
+        ],
+        examples: [
+            {
+                title: "Read one field of a JSON body in a later step",
+                code: ownReference(context, "request-body", ["message"]),
+                description: "Change `message` to the name of the field you need.",
+            },
+        ],
+        notes: [
+            {
+                type: ComponentDocumentationNoteType.Tip,
+                text: 'The caller is answered at once with `{"status": "Scheduled"}`, and the workflow runs after that, so the caller never sees what it does.',
+            },
+        ],
+        learnMore: [
+            {
+                title: "Testing it without the other app",
+                paragraphs: [
+                    "Click **Run Workflow** in the builder's toolbar to start a run with headers, query parameters and a body you type in.",
+                    "Or copy the request under **Try it** at the top of this dialog and run it in a terminal.",
+                ],
+            },
+            {
+                title: "Reading headers and query parameters",
+                paragraphs: [
+                    "They work like the body: add the name to the end of the reference. Header names arrive in lower case.",
+                ],
+                example: {
+                    title: "The Content-Type header",
+                    code: ownReference(context, "request-headers", ["content-type"]),
+                },
+            },
+        ],
+        links: [
+            docsLink("Webhook trigger guide", WorkflowDocsPaths.webhookTrigger),
+        ],
+    };
+};
+export const getIncomingEmailDocumentation = (context) => {
+    return {
+        summary: "Starts this workflow each time an email arrives at its own address.",
+        steps: [
+            "Copy the address at the top of this dialog, and have the email that should start the workflow sent or forwarded to it.",
+            "Connect **Out** to the steps that should run for each email.",
+            "Turn the workflow on. While it is off, email to the address is ignored.",
+        ],
+        examples: [
+            {
+                title: "The subject of the email in a later step",
+                code: ownReference(context, IncomingEmailTriggerValue.Subject),
+            },
+            {
+                title: "One header, such as the email's Message-ID",
+                code: ownReference(context, IncomingEmailTriggerValue.Headers, [
+                    "message-id",
+                ]),
+                description: "Header names are in lower case. Change `message-id` to the one you need.",
+            },
+        ],
+        notes: [
+            {
+                type: ComponentDocumentationNoteType.Tip,
+                text: "Every email starts its own run. **Attachments** lists each file's name, type and size; the files themselves are not kept.",
+            },
+            {
+                type: ComponentDocumentationNoteType.Warning,
+                text: "Anyone can send email to any address, so check **From** before a step does anything that matters.",
+            },
+        ],
+        learnMore: [
+            {
+                title: "Testing it without sending an email",
+                paragraphs: [
+                    "Click **Run Workflow** in the builder's toolbar and fill in a sender, a subject and a body. The values you leave out arrive empty.",
+                    "Or send a real email to the address and open the workflow's runs to see what it brought.",
+                ],
+            },
+            {
+                title: "Which emails reach it",
+                paragraphs: [
+                    "An email starts a run whether the address is in **To** or **CC**, was a blind copy, or was reached through a forwarding rule. An email that names the address twice still starts one run.",
+                    "**Body** is the email's plain text and **HTML Body** its HTML. Each is cut at 1 MB.",
+                ],
+            },
+        ],
+        links: [
+            docsLink("Incoming Email trigger guide", WorkflowDocsPaths.incomingEmailTrigger),
+            docsLink("Setting up inbound email", WorkflowDocsPaths.inboundEmailSetup),
+        ],
+    };
+};
+export const getScheduleDocumentation = (_context) => {
+    return {
+        summary: "Starts this workflow on a repeating schedule, such as every hour or every Monday morning.",
+        steps: [
+            "Choose how often in **Schedule at**, or write your own cron expression.",
+            "Connect **Execute** to the steps to run each time.",
+            "Turn the workflow on. Nothing is scheduled while it is off.",
+        ],
+        examples: [
+            {
+                title: "Every weekday at 9:00 UTC",
+                code: "0 9 * * 1-5",
+                description: "The five parts are the minute, the hour, the day of the month, the month and the day of the week.",
+            },
+        ],
+        notes: [
+            {
+                type: ComponentDocumentationNoteType.Tip,
+                text: "Times are in UTC, so convert from your own time zone when you pick the hour.",
+            },
+        ],
+        learnMore: [
+            {
+                title: "More cron expressions",
+                paragraphs: [
+                    "`*/15 * * * *` runs every 15 minutes, `0 * * * *` every hour on the hour, `0 0 * * *` every day at midnight and `0 9 * * 1` every Monday at 9:00.",
+                ],
+            },
+            {
+                title: "Testing it",
+                paragraphs: [
+                    "Click **Run Workflow** in the builder's toolbar to start a run straight away, without waiting for the schedule.",
+                ],
+            },
+        ],
+        links: [
+            docsLink("Schedule trigger guide", WorkflowDocsPaths.scheduleTrigger),
+        ],
+    };
+};
+export const getManualDocumentation = (context) => {
+    return {
+        summary: "Starts this workflow when you run it from the builder, or when another workflow starts it.",
+        steps: [
+            "Connect **Execute** to the first step to run.",
+            "Start a run as shown at the top of this dialog, with any JSON the run needs.",
+            "Use that JSON in later steps with the reference under **Returns**.",
+        ],
+        examples: [
+            {
+                title: "The JSON this run started with",
+                code: ownReference(context, "value"),
+            },
+        ],
+        notes: [
+            {
+                type: ComponentDocumentationNoteType.Tip,
+                text: `When an **Execute Workflow** step starts this workflow, each key it passes is a value of its own: \`${ownReference(context, "<key>")}\`.`,
+            },
+        ],
+        learnMore: [
+            {
+                title: "Reading one field of the JSON",
+                paragraphs: [
+                    "JSON typed into **Run Workflow** arrives as one piece of text. To read a single field, pass it through a **Text to JSON** step, then read the field from that step's **JSON**.",
+                ],
+            },
+        ],
+        links: [docsLink("Manual trigger guide", WorkflowDocsPaths.manualTrigger)],
+    };
+};
+//# sourceMappingURL=TriggerDocumentation.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TriggerDocumentation.js","sourceRoot":"","sources":["../../../../../Types/Workflow/Documentation/TriggerDocumentation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAA+B,EAC7B,8BAA8B,GAC/B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAEL,YAAY,GACb,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AAMpE,MAAM,CAAC,MAAM,uBAAuB,GAAiC,CACnE,OAAsC,EACd,EAAE;IAC1B,OAAO;QACL,OAAO,EACL,sEAAsE;QACxE,KAAK,EAAE;YACL,qFAAqF;YACrF,4DAA4D;YAC5D,sEAAsE;SACvE;QACD,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,+CAA+C;gBACtD,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,cAAc,EAAE,CAAC,SAAS,CAAC,CAAC;gBACxD,WAAW,EAAE,qDAAqD;aACnE;SACF;QACD,KAAK,EAAE;YACL;gBACE,IAAI,EAAE,8BAA8B,CAAC,GAAG;gBACxC,IAAI,EAAE,yIAAyI;aAChJ;SACF;QACD,SAAS,EAAE;YACT;gBACE,KAAK,EAAE,kCAAkC;gBACzC,UAAU,EAAE;oBACV,uHAAuH;oBACvH,0FAA0F;iBAC3F;aACF;YACD;gBACE,KAAK,EAAE,sCAAsC;gBAC7C,UAAU,EAAE;oBACV,uGAAuG;iBACxG;gBACD,OAAO,EAAE;oBACP,KAAK,EAAE,yBAAyB;oBAChC,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,iBAAiB,EAAE,CAAC,cAAc,CAAC,CAAC;iBACjE;aACF;SACF;QACD,KAAK,EAAE;YACL,QAAQ,CAAC,uBAAuB,EAAE,iBAAiB,CAAC,cAAc,CAAC;SACpE;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,6BAA6B,GAAiC,CACzE,OAAsC,EACd,EAAE;IAC1B,OAAO;QACL,OAAO,EACL,qEAAqE;QACvE,KAAK,EAAE;YACL,wHAAwH;YACxH,8DAA8D;YAC9D,yEAAyE;SAC1E;QACD,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,0CAA0C;gBACjD,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,yBAAyB,CAAC,OAAO,CAAC;aAC/D;YACD;gBACE,KAAK,EAAE,4CAA4C;gBACnD,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,yBAAyB,CAAC,OAAO,EAAE;oBAC7D,YAAY;iBACb,CAAC;gBACF,WAAW,EACT,0EAA0E;aAC7E;SACF;QACD,KAAK,EAAE;YACL;gBACE,IAAI,EAAE,8BAA8B,CAAC,GAAG;gBACxC,IAAI,EAAE,2HAA2H;aAClI;YACD;gBACE,IAAI,EAAE,8BAA8B,CAAC,OAAO;gBAC5C,IAAI,EAAE,mGAAmG;aAC1G;SACF;QACD,SAAS,EAAE;YACT;gBACE,KAAK,EAAE,qCAAqC;gBAC5C,UAAU,EAAE;oBACV,oIAAoI;oBACpI,0FAA0F;iBAC3F;aACF;YACD;gBACE,KAAK,EAAE,uBAAuB;gBAC9B,UAAU,EAAE;oBACV,2LAA2L;oBAC3L,qFAAqF;iBACtF;aACF;SACF;QACD,KAAK,EAAE;YACL,QAAQ,CACN,8BAA8B,EAC9B,iBAAiB,CAAC,oBAAoB,CACvC;YACD,QAAQ,CAAC,0BAA0B,EAAE,iBAAiB,CAAC,iBAAiB,CAAC;SAC1E;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,wBAAwB,GAAiC,CACpE,QAAuC,EACf,EAAE;IAC1B,OAAO;QACL,OAAO,EACL,2FAA2F;QAC7F,KAAK,EAAE;YACL,yEAAyE;YACzE,oDAAoD;YACpD,6DAA6D;SAC9D;QACD,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,2BAA2B;gBAClC,IAAI,EAAE,aAAa;gBACnB,WAAW,EACT,mGAAmG;aACtG;SACF;QACD,KAAK,EAAE;YACL;gBACE,IAAI,EAAE,8BAA8B,CAAC,GAAG;gBACxC,IAAI,EAAE,8EAA8E;aACrF;SACF;QACD,SAAS,EAAE;YACT;gBACE,KAAK,EAAE,uBAAuB;gBAC9B,UAAU,EAAE;oBACV,mJAAmJ;iBACpJ;aACF;YACD;gBACE,KAAK,EAAE,YAAY;gBACnB,UAAU,EAAE;oBACV,iHAAiH;iBAClH;aACF;SACF;QACD,KAAK,EAAE;YACL,QAAQ,CAAC,wBAAwB,EAAE,iBAAiB,CAAC,eAAe,CAAC;SACtE;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAiC,CAClE,OAAsC,EACd,EAAE;IAC1B,OAAO;QACL,OAAO,EACL,4FAA4F;QAC9F,KAAK,EAAE;YACL,+CAA+C;YAC/C,8EAA8E;YAC9E,oEAAoE;SACrE;QACD,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,gCAAgC;gBACvC,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC;aACrC;SACF;QACD,KAAK,EAAE;YACL;gBACE,IAAI,EAAE,8BAA8B,CAAC,GAAG;gBACxC,IAAI,EAAE,uGAAuG,YAAY,CACvH,OAAO,EACP,OAAO,CACR,KAAK;aACP;SACF;QACD,SAAS,EAAE;YACT;gBACE,KAAK,EAAE,+BAA+B;gBACtC,UAAU,EAAE;oBACV,gLAAgL;iBACjL;aACF;SACF;QACD,KAAK,EAAE,CAAC,QAAQ,CAAC,sBAAsB,EAAE,iBAAiB,CAAC,aAAa,CAAC,CAAC;KAC3E,CAAC;AACJ,CAAC,CAAC"}