@oneuptime/common 14.0.11 → 14.0.12

package/build/dist/Types/Workflow/Components/Webhook.js

@@ -1,4 +1,3 @@
-import Route from "../../API/Route";
 import IconProp from "../../Icon/IconProp";
 import ComponentID from "../ComponentID";
 import { ComponentInputType, ComponentType, } from "./../Component";
@@ -10,7 +9,6 @@ const components = [
         description: "Hook any of your external apps and services with this workflow.",
         iconProp: IconProp.AltGlobe,
         componentType: ComponentType.Trigger,
-        documentationLink: Route.fromString("/workflow/docs/Webhook.md"),
         arguments: [],
         runWorkflowManuallyArguments: [
             {
@@ -42,7 +40,7 @@ const components = [
             {
                 id: "request-headers",
                 name: "Request Headers",
-                description: "Request Headers for this request",
+                description: "The headers the caller sent, by header name.",
                 type: ComponentInputType.StringDictionary,
                 required: false,
                 placeholder: '{"header1": "value1", "header2": "value2", ....}',
@@ -50,7 +48,7 @@ const components = [
             {
                 id: "request-params",
                 name: "Request Query Params",
-                description: "Request Query Params for this request",
+                description: "The query string parameters in the URL, by name.",
                 type: ComponentInputType.StringDictionary,
                 required: false,
                 placeholder: '{"query1": "value1", "query2": "value2", ....}',
@@ -58,7 +56,7 @@ const components = [
             {
                 id: "request-body",
                 name: "Request Body",
-                description: "Request Body",
+                description: "The body the caller sent. A JSON body can be read field by field.",
                 type: ComponentInputType.JSON,
                 required: false,
                 placeholder: '{"key1": "value1", "key2": "value2", ....}',
@@ -68,7 +66,7 @@ const components = [
         outPorts: [
             {
                 title: "Out",
-                description: "Connect to this port if you want other components to execute after the value has been logged.",
+                description: "Connect the steps to run each time the URL is called.",
                 id: "out",
             },
         ],

package/build/dist/Types/Workflow/Components/Webhook.js.map

@@ -1 +1 @@
-{"version":3,"file":"Webhook.js","sourceRoot":"","sources":["../../../../../Types/Workflow/Components/Webhook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,iBAAiB,CAAC;AACpC,OAAO,QAAQ,MAAM,qBAAqB,CAAC;AAC3C,OAAO,WAAW,MAAM,gBAAgB,CAAC;AACzC,OAA0B,EACxB,kBAAkB,EAClB,aAAa,GACd,MAAM,gBAAgB,CAAC;AAExB,MAAM,UAAU,GAA6B;IAC3C;QACE,EAAE,EAAE,WAAW,CAAC,OAAO;QACvB,KAAK,EAAE,SAAS;QAChB,QAAQ,EAAE,SAAS;QACnB,WAAW,EACT,iEAAiE;QACnE,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,aAAa,EAAE,aAAa,CAAC,OAAO;QACpC,iBAAiB,EAAE,KAAK,CAAC,UAAU,CAAC,2BAA2B,CAAC;QAChE,SAAS,EAAE,EAAE;QACb,4BAA4B,EAAE;YAC5B;gBACE,EAAE,EAAE,iBAAiB;gBACrB,IAAI,EAAE,iBAAiB;gBACvB,WAAW,EAAE,kCAAkC;gBAC/C,IAAI,EAAE,kBAAkB,CAAC,gBAAgB;gBACzC,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,kDAAkD;aAChE;YACD;gBACE,EAAE,EAAE,gBAAgB;gBACpB,IAAI,EAAE,sBAAsB;gBAC5B,WAAW,EAAE,uCAAuC;gBACpD,IAAI,EAAE,kBAAkB,CAAC,gBAAgB;gBACzC,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,gDAAgD;aAC9D;YACD;gBACE,EAAE,EAAE,cAAc;gBAClB,IAAI,EAAE,cAAc;gBACpB,WAAW,EAAE,cAAc;gBAC3B,IAAI,EAAE,kBAAkB,CAAC,IAAI;gBAC7B,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,4CAA4C;aAC1D;SACF;QACD,YAAY,EAAE;YACZ;gBACE,EAAE,EAAE,iBAAiB;gBACrB,IAAI,EAAE,iBAAiB;gBACvB,WAAW,EAAE,kCAAkC;gBAC/C,IAAI,EAAE,kBAAkB,CAAC,gBAAgB;gBACzC,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,kDAAkD;aAChE;YACD;gBACE,EAAE,EAAE,gBAAgB;gBACpB,IAAI,EAAE,sBAAsB;gBAC5B,WAAW,EAAE,uCAAuC;gBACpD,IAAI,EAAE,kBAAkB,CAAC,gBAAgB;gBACzC,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,gDAAgD;aAC9D;YACD;gBACE,EAAE,EAAE,cAAc;gBAClB,IAAI,EAAE,cAAc;gBACpB,WAAW,EAAE,cAAc;gBAC3B,IAAI,EAAE,kBAAkB,CAAC,IAAI;gBAC7B,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,4CAA4C;aAC1D;SACF;QACD,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,KAAK;gBACZ,WAAW,EACT,+FAA+F;gBACjG,EAAE,EAAE,KAAK;aACV;SACF;KACF;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}
+{"version":3,"file":"Webhook.js","sourceRoot":"","sources":["../../../../../Types/Workflow/Components/Webhook.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,qBAAqB,CAAC;AAC3C,OAAO,WAAW,MAAM,gBAAgB,CAAC;AACzC,OAA0B,EACxB,kBAAkB,EAClB,aAAa,GACd,MAAM,gBAAgB,CAAC;AAExB,MAAM,UAAU,GAA6B;IAC3C;QACE,EAAE,EAAE,WAAW,CAAC,OAAO;QACvB,KAAK,EAAE,SAAS;QAChB,QAAQ,EAAE,SAAS;QACnB,WAAW,EACT,iEAAiE;QACnE,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,aAAa,EAAE,aAAa,CAAC,OAAO;QACpC,SAAS,EAAE,EAAE;QACb,4BAA4B,EAAE;YAC5B;gBACE,EAAE,EAAE,iBAAiB;gBACrB,IAAI,EAAE,iBAAiB;gBACvB,WAAW,EAAE,kCAAkC;gBAC/C,IAAI,EAAE,kBAAkB,CAAC,gBAAgB;gBACzC,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,kDAAkD;aAChE;YACD;gBACE,EAAE,EAAE,gBAAgB;gBACpB,IAAI,EAAE,sBAAsB;gBAC5B,WAAW,EAAE,uCAAuC;gBACpD,IAAI,EAAE,kBAAkB,CAAC,gBAAgB;gBACzC,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,gDAAgD;aAC9D;YACD;gBACE,EAAE,EAAE,cAAc;gBAClB,IAAI,EAAE,cAAc;gBACpB,WAAW,EAAE,cAAc;gBAC3B,IAAI,EAAE,kBAAkB,CAAC,IAAI;gBAC7B,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,4CAA4C;aAC1D;SACF;QACD,YAAY,EAAE;YACZ;gBACE,EAAE,EAAE,iBAAiB;gBACrB,IAAI,EAAE,iBAAiB;gBACvB,WAAW,EAAE,8CAA8C;gBAC3D,IAAI,EAAE,kBAAkB,CAAC,gBAAgB;gBACzC,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,kDAAkD;aAChE;YACD;gBACE,EAAE,EAAE,gBAAgB;gBACpB,IAAI,EAAE,sBAAsB;gBAC5B,WAAW,EAAE,kDAAkD;gBAC/D,IAAI,EAAE,kBAAkB,CAAC,gBAAgB;gBACzC,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,gDAAgD;aAC9D;YACD;gBACE,EAAE,EAAE,cAAc;gBAClB,IAAI,EAAE,cAAc;gBACpB,WAAW,EACT,mEAAmE;gBACrE,IAAI,EAAE,kBAAkB,CAAC,IAAI;gBAC7B,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,4CAA4C;aAC1D;SACF;QACD,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,KAAK;gBACZ,WAAW,EAAE,uDAAuD;gBACpE,EAAE,EAAE,KAAK;aACV;SACF;KACF;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

@@ -4,6 +4,7 @@ import AIComponents from "./Components/AI";
 import ConditionComponents from "./Components/Condition";
 import DiscordComponents from "./Components/Discord";
 import EmailComponents from "./Components/Email";
+import IncomingEmailComponents from "./Components/IncomingEmail";
 import JsonComponents from "./Components/JSON";
 import JavaScriptComponents from "./Components/JavaScript";
 import LogComponents from "./Components/Log";
@@ -28,6 +29,7 @@ const components = [
     ...JavaScriptComponents,
     ...EmailComponents,
     ...WebhookComponents,
+    ...IncomingEmailComponents,
     ...WorkflowComponents,
     ...ManualComponents,
     ...MicrosoftTeamsComponents,
@@ -92,8 +94,8 @@ export const Categories = [
     },
     {
         name: "Email",
-        description: "Send email to anyone in your workflows.",
-        icon: IconProp.Clock,
+        description: "Receive email to start a workflow, and send email from one.",
+        icon: IconProp.Email,
     },
     {
         name: "Utils",

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

@@ -1 +1 @@
-{"version":3,"file":"Components.js","sourceRoot":"","sources":["../../../../Types/Workflow/Components.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,kBAAkB,CAAC;AAExC,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAC7C,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAC3C,OAAO,mBAAmB,MAAM,wBAAwB,CAAC;AACzD,OAAO,iBAAiB,MAAM,sBAAsB,CAAC;AACrD,OAAO,eAAe,MAAM,oBAAoB,CAAC;AACjD,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAC/C,OAAO,oBAAoB,MAAM,yBAAyB,CAAC;AAC3D,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAC7C,OAAO,gBAAgB,MAAM,qBAAqB,CAAC;AACnD,OAAO,wBAAwB,MAAM,6BAA6B,CAAC;AACnE,OAAO,kBAAkB,MAAM,uBAAuB,CAAC;AACvD,OAAO,eAAe,MAAM,oBAAoB,CAAC;AACjD,OAAO,eAAe,MAAM,oBAAoB,CAAC;AACjD,OAAO,kBAAkB,MAAM,uBAAuB,CAAC;AACvD,OAAO,iBAAiB,MAAM,sBAAsB,CAAC;AACrD,OAAO,kBAAkB,MAAM,uBAAuB,CAAC;AAEvD,MAAM,UAAU,GAA6B;IAC3C,GAAG,YAAY;IACf,GAAG,aAAa;IAChB,GAAG,aAAa;IAChB,GAAG,kBAAkB;IACrB,GAAG,eAAe;IAClB,GAAG,iBAAiB;IACpB,GAAG,kBAAkB;IACrB,GAAG,mBAAmB;IACtB,GAAG,cAAc;IACjB,GAAG,oBAAoB;IACvB,GAAG,eAAe;IAClB,GAAG,iBAAiB;IACpB,GAAG,kBAAkB;IACrB,GAAG,gBAAgB;IACnB,GAAG,wBAAwB;IAC3B,GAAG,eAAe;CACnB,CAAC;AAEF,eAAe,UAAU,CAAC;AAE1B,MAAM,CAAC,MAAM,UAAU,GAA6B;IAClD;QACE,IAAI,EAAE,IAAI;QACV,WAAW,EACT,qEAAqE;QACvE,IAAI,EAAE,QAAQ,CAAC,QAAQ;KACxB;IACD;QACE,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,qDAAqD;QAClE,IAAI,EAAE,QAAQ,CAAC,QAAQ;KACxB;IACD;QACE,IAAI,EAAE,KAAK;QACX,WAAW,EAAE,wCAAwC;QACrD,IAAI,EAAE,QAAQ,CAAC,KAAK;KACrB;IACD;QACE,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,2CAA2C;QACxD,IAAI,EAAE,QAAQ,CAAC,WAAW;KAC3B;IACD;QACE,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,+CAA+C;QAC5D,IAAI,EAAE,QAAQ,CAAC,WAAW;KAC3B;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,WAAW,EAAE,gDAAgD;QAC7D,IAAI,EAAE,QAAQ,CAAC,WAAW;KAC3B;IACD;QACE,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE,4DAA4D;QACzE,IAAI,EAAE,QAAQ,CAAC,WAAW;KAC3B;IACD;QACE,IAAI,EAAE,YAAY;QAClB,WAAW,EAAE,8BAA8B;QAC3C,IAAI,EAAE,QAAQ,CAAC,SAAS;KACzB;IACD;QACE,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,mCAAmC;QAChD,IAAI,EAAE,QAAQ,CAAC,IAAI;KACpB;IACD;QACE,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,0CAA0C;QACvD,IAAI,EAAE,QAAQ,CAAC,IAAI;KACpB;IACD;QACE,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE,+CAA+C;QAC5D,IAAI,EAAE,QAAQ,CAAC,KAAK;KACrB;IACD;QACE,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,yCAAyC;QACtD,IAAI,EAAE,QAAQ,CAAC,KAAK;KACrB;IACD;QACE,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,0CAA0C;QACvD,IAAI,EAAE,QAAQ,CAAC,MAAM;KACtB;CACF,CAAC"}
+{"version":3,"file":"Components.js","sourceRoot":"","sources":["../../../../Types/Workflow/Components.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,kBAAkB,CAAC;AAExC,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAC7C,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAC3C,OAAO,mBAAmB,MAAM,wBAAwB,CAAC;AACzD,OAAO,iBAAiB,MAAM,sBAAsB,CAAC;AACrD,OAAO,eAAe,MAAM,oBAAoB,CAAC;AACjD,OAAO,uBAAuB,MAAM,4BAA4B,CAAC;AACjE,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAC/C,OAAO,oBAAoB,MAAM,yBAAyB,CAAC;AAC3D,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAC7C,OAAO,gBAAgB,MAAM,qBAAqB,CAAC;AACnD,OAAO,wBAAwB,MAAM,6BAA6B,CAAC;AACnE,OAAO,kBAAkB,MAAM,uBAAuB,CAAC;AACvD,OAAO,eAAe,MAAM,oBAAoB,CAAC;AACjD,OAAO,eAAe,MAAM,oBAAoB,CAAC;AACjD,OAAO,kBAAkB,MAAM,uBAAuB,CAAC;AACvD,OAAO,iBAAiB,MAAM,sBAAsB,CAAC;AACrD,OAAO,kBAAkB,MAAM,uBAAuB,CAAC;AAEvD,MAAM,UAAU,GAA6B;IAC3C,GAAG,YAAY;IACf,GAAG,aAAa;IAChB,GAAG,aAAa;IAChB,GAAG,kBAAkB;IACrB,GAAG,eAAe;IAClB,GAAG,iBAAiB;IACpB,GAAG,kBAAkB;IACrB,GAAG,mBAAmB;IACtB,GAAG,cAAc;IACjB,GAAG,oBAAoB;IACvB,GAAG,eAAe;IAClB,GAAG,iBAAiB;IACpB,GAAG,uBAAuB;IAC1B,GAAG,kBAAkB;IACrB,GAAG,gBAAgB;IACnB,GAAG,wBAAwB;IAC3B,GAAG,eAAe;CACnB,CAAC;AAEF,eAAe,UAAU,CAAC;AAE1B,MAAM,CAAC,MAAM,UAAU,GAA6B;IAClD;QACE,IAAI,EAAE,IAAI;QACV,WAAW,EACT,qEAAqE;QACvE,IAAI,EAAE,QAAQ,CAAC,QAAQ;KACxB;IACD;QACE,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,qDAAqD;QAClE,IAAI,EAAE,QAAQ,CAAC,QAAQ;KACxB;IACD;QACE,IAAI,EAAE,KAAK;QACX,WAAW,EAAE,wCAAwC;QACrD,IAAI,EAAE,QAAQ,CAAC,KAAK;KACrB;IACD;QACE,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,2CAA2C;QACxD,IAAI,EAAE,QAAQ,CAAC,WAAW;KAC3B;IACD;QACE,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,+CAA+C;QAC5D,IAAI,EAAE,QAAQ,CAAC,WAAW;KAC3B;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,WAAW,EAAE,gDAAgD;QAC7D,IAAI,EAAE,QAAQ,CAAC,WAAW;KAC3B;IACD;QACE,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE,4DAA4D;QACzE,IAAI,EAAE,QAAQ,CAAC,WAAW;KAC3B;IACD;QACE,IAAI,EAAE,YAAY;QAClB,WAAW,EAAE,8BAA8B;QAC3C,IAAI,EAAE,QAAQ,CAAC,SAAS;KACzB;IACD;QACE,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,mCAAmC;QAChD,IAAI,EAAE,QAAQ,CAAC,IAAI;KACpB;IACD;QACE,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,0CAA0C;QACvD,IAAI,EAAE,QAAQ,CAAC,IAAI;KACpB;IACD;QACE,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE,+CAA+C;QAC5D,IAAI,EAAE,QAAQ,CAAC,KAAK;KACrB;IACD;QACE,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,6DAA6D;QAC1E,IAAI,EAAE,QAAQ,CAAC,KAAK;KACrB;IACD;QACE,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,0CAA0C;QACvD,IAAI,EAAE,QAAQ,CAAC,MAAM;KACtB;CACF,CAAC"}

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

@@ -0,0 +1,50 @@
+import Text from "../Text";
+/*
+ * The eleven kinds of step BaseModelComponent.getComponents generates for
+ * every model a workflow can use, by the end of their component id:
+ * Find, Create, Update and Delete (one and many), and the On Create, On
+ * Update and On Delete triggers.
+ *
+ * Kept apart from the documentation that explains them, so anything that
+ * only needs to know which operation a step is - the Add Component picker
+ * orders and searches by it - can ask without loading that documentation.
+ * Types/Workflow/Documentation/DatabaseDocumentation re-exports both.
+ */
+export var DatabaseOperation;
+(function (DatabaseOperation) {
+    DatabaseOperation["FindOne"] = "find-one";
+    DatabaseOperation["FindMany"] = "find-many";
+    DatabaseOperation["CreateOne"] = "create-one";
+    DatabaseOperation["CreateMany"] = "create-many";
+    DatabaseOperation["UpdateOne"] = "update-one";
+    DatabaseOperation["UpdateMany"] = "update-many";
+    DatabaseOperation["DeleteOne"] = "delete-one";
+    DatabaseOperation["DeleteMany"] = "delete-many";
+    DatabaseOperation["OnCreate"] = "on-create";
+    DatabaseOperation["OnUpdate"] = "on-update";
+    DatabaseOperation["OnDelete"] = "on-delete";
+})(DatabaseOperation || (DatabaseOperation = {}));
+// The steps that write rows, as opposed to reading them or reacting to a write.
+export const WRITE_DATABASE_OPERATIONS = Object.freeze([
+    DatabaseOperation.CreateOne,
+    DatabaseOperation.CreateMany,
+    DatabaseOperation.UpdateOne,
+    DatabaseOperation.UpdateMany,
+    DatabaseOperation.DeleteOne,
+    DatabaseOperation.DeleteMany,
+]);
+/*
+ * BaseModelComponent.getComponents names each step
+ * `<table name in dashes>-<operation>`.
+ */
+export const getDatabaseOperation = (data) => {
+    const prefix = `${Text.pascalCaseToDashes(data.tableName)}-`;
+    if (!data.componentId.startsWith(prefix)) {
+        return null;
+    }
+    const suffix = data.componentId.slice(prefix.length);
+    return (Object.values(DatabaseOperation).find((operation) => {
+        return operation === suffix;
+    }) || null);
+};
+//# sourceMappingURL=DatabaseOperation.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DatabaseOperation.js","sourceRoot":"","sources":["../../../../Types/Workflow/DatabaseOperation.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,SAAS,CAAC;AAE3B;;;;;;;;;;GAUG;AACH,MAAM,CAAN,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,yCAAoB,CAAA;IACpB,2CAAsB,CAAA;IACtB,6CAAwB,CAAA;IACxB,+CAA0B,CAAA;IAC1B,6CAAwB,CAAA;IACxB,+CAA0B,CAAA;IAC1B,6CAAwB,CAAA;IACxB,+CAA0B,CAAA;IAC1B,2CAAsB,CAAA;IACtB,2CAAsB,CAAA;IACtB,2CAAsB,CAAA;AACxB,CAAC,EAZW,iBAAiB,KAAjB,iBAAiB,QAY5B;AAED,gFAAgF;AAChF,MAAM,CAAC,MAAM,yBAAyB,GACpC,MAAM,CAAC,MAAM,CAAC;IACZ,iBAAiB,CAAC,SAAS;IAC3B,iBAAiB,CAAC,UAAU;IAC5B,iBAAiB,CAAC,SAAS;IAC3B,iBAAiB,CAAC,UAAU;IAC5B,iBAAiB,CAAC,SAAS;IAC3B,iBAAiB,CAAC,UAAU;CAC7B,CAAC,CAAC;AAOL;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAiC,CAAC,IAGlE,EAA4B,EAAE;IAC7B,MAAM,MAAM,GAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;IAErE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAW,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAE7D,OAAO,CACL,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,IAAI,CACnC,CAAC,SAA4B,EAAW,EAAE;QACxC,OAAO,SAAS,KAAK,MAAM,CAAC;IAC9B,CAAC,CACF,IAAI,IAAI,CACV,CAAC;AACJ,CAAC,CAAC"}

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

@@ -0,0 +1,78 @@
+/*
+ * Help for Generate Text with AI.
+ *
+ * Its old documentation ran to some 2,700 pixels: provider configuration,
+ * request filtering, logging, billing and safety, all at full length above the
+ * first word about writing a prompt. What a builder needs first is the three
+ * settings that matter and how to use the answer; the rest is still here,
+ * under Learn more, and on the docs site in full.
+ */
+import { ComponentDocumentationNoteType, } from "./ComponentDocumentation";
+import { getSampleValue, ownReference, } from "./DocumentationContext";
+import { WorkflowDocsPaths, docsLink } from "./DocumentationLinks";
+export const getAIGenerateTextDocumentation = (context) => {
+    const sample = getSampleValue(context);
+    return {
+        summary: "Asks your project's AI model to write text, such as a summary or a draft update, from data you choose.",
+        steps: [
+            "Check that the project has an AI provider, under **Project Settings → AI → LLM Providers**.",
+            "Write the task in **Prompt**, and put the data it should work from in **Context**, as JSON.",
+            "Use the answer in later steps: it is the **Response**.",
+            "Connect **Error** to a fallback. It runs when the provider, a limit or the budget stops the request.",
+        ],
+        examples: [
+            sample
+                ? {
+                    title: "Context with a value from another step",
+                    code: `{"details": "${sample.reference}"}`,
+                    description: `The reference puts in ${sample.description}.`,
+                }
+                : {
+                    title: "Context",
+                    code: '{"service": "Checkout", "errorRate": "12%"}',
+                },
+            {
+                title: "The answer, in a later step",
+                code: ownReference(context, "response"),
+            },
+        ],
+        notes: [
+            {
+                type: ComponentDocumentationNoteType.Tip,
+                text: "Only what you put in **System Instructions**, **Prompt** and **Context** is sent to the provider. Nothing else from the workflow is.",
+            },
+            {
+                type: ComponentDocumentationNoteType.Warning,
+                text: "Treat the answer as untrusted text. Review it before customers see it, and never let it alone decide something that cannot be undone.",
+            },
+        ],
+        learnMore: [
+            {
+                title: "Before you use it",
+                paragraphs: [
+                    "AI must be turned on for the project. On OneUptime Cloud the subscription must be paid and on the Growth plan or above; self-hosted installs without billing have no plan check.",
+                    "Each call uses the project's default provider, or the installation's global one. A costed global provider uses the project's AI credits, and every call counts toward the project's daily AI token budget.",
+                ],
+            },
+            {
+                title: "Limits",
+                paragraphs: [
+                    "System Instructions, Prompt and Context together can be up to 50,000 characters. A request is tried once and stops after at most 60 seconds, and at most three AI steps run at once in a project. Anything over a limit takes **Error**.",
+                    "**Temperature** (0 to 1, default 0.2) controls how much the wording varies. **Maximum Output Tokens** (1 to 4096, default 1024) caps the length of the answer.",
+                ],
+            },
+            {
+                title: "Logs and privacy",
+                paragraphs: [
+                    "The prompt, context and answer are hidden in this step's entries in the run log. A later step that uses the answer logs it by its own rules, so treat reusing it as sharing it.",
+                    "Each call is listed in **Project Settings → AI → AI Logs**, with its provider, model, tokens and cost, but not the prompt or the answer.",
+                ],
+            },
+        ],
+        links: [
+            docsLink("Generate Text with AI guide", WorkflowDocsPaths.ai),
+            docsLink("AI safety and costs", WorkflowDocsPaths.aiSafety),
+        ],
+    };
+};
+//# sourceMappingURL=AIDocumentation.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AIDocumentation.js","sourceRoot":"","sources":["../../../../../Types/Workflow/Documentation/AIDocumentation.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAA+B,EAC7B,8BAA8B,GAC/B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAGL,cAAc,EACd,YAAY,GACb,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAMnE,MAAM,CAAC,MAAM,8BAA8B,GAA4B,CACrE,OAAsC,EACd,EAAE;IAC1B,MAAM,MAAM,GAAuB,cAAc,CAAC,OAAO,CAAC,CAAC;IAE3D,OAAO;QACL,OAAO,EACL,wGAAwG;QAC1G,KAAK,EAAE;YACL,6FAA6F;YAC7F,6FAA6F;YAC7F,wDAAwD;YACxD,sGAAsG;SACvG;QACD,QAAQ,EAAE;YACR,MAAM;gBACJ,CAAC,CAAC;oBACE,KAAK,EAAE,wCAAwC;oBAC/C,IAAI,EAAE,gBAAgB,MAAM,CAAC,SAAS,IAAI;oBAC1C,WAAW,EAAE,yBAAyB,MAAM,CAAC,WAAW,GAAG;iBAC5D;gBACH,CAAC,CAAC;oBACE,KAAK,EAAE,SAAS;oBAChB,IAAI,EAAE,6CAA6C;iBACpD;YACL;gBACE,KAAK,EAAE,6BAA6B;gBACpC,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,UAAU,CAAC;aACxC;SACF;QACD,KAAK,EAAE;YACL;gBACE,IAAI,EAAE,8BAA8B,CAAC,GAAG;gBACxC,IAAI,EAAE,sIAAsI;aAC7I;YACD;gBACE,IAAI,EAAE,8BAA8B,CAAC,OAAO;gBAC5C,IAAI,EAAE,uIAAuI;aAC9I;SACF;QACD,SAAS,EAAE;YACT;gBACE,KAAK,EAAE,mBAAmB;gBAC1B,UAAU,EAAE;oBACV,kLAAkL;oBAClL,4MAA4M;iBAC7M;aACF;YACD;gBACE,KAAK,EAAE,QAAQ;gBACf,UAAU,EAAE;oBACV,0OAA0O;oBAC1O,gKAAgK;iBACjK;aACF;YACD;gBACE,KAAK,EAAE,kBAAkB;gBACzB,UAAU,EAAE;oBACV,iLAAiL;oBACjL,0IAA0I;iBAC3I;aACF;SACF;QACD,KAAK,EAAE;YACL,QAAQ,CAAC,6BAA6B,EAAE,iBAAiB,CAAC,EAAE,CAAC;YAC7D,QAAQ,CAAC,qBAAqB,EAAE,iBAAiB,CAAC,QAAQ,CAAC;SAC5D;KACF,CAAC;AACJ,CAAC,CAAC"}

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

@@ -0,0 +1,69 @@
+/*
+ * Help for the five API steps. They differ only in the HTTP method, and in
+ * whether a body is the point of the request, so one builder writes all five.
+ */
+import { ComponentDocumentationNoteType, } from "./ComponentDocumentation";
+import { ownReference, } from "./DocumentationContext";
+import { WorkflowDocsPaths, docsLink } from "./DocumentationLinks";
+const getAPIDocumentation = (method) => {
+    // A GET or a DELETE carries no body in practice, so its help leaves it out.
+    const sendsBody = method === "POST" || method === "PUT" || method === "PATCH";
+    return (context) => {
+        return {
+            summary: sendsBody
+                ? `Sends a ${method} request with a JSON body to a URL, and passes the response to the next steps.`
+                : `Sends a ${method} request to a URL, and passes the response to the next steps.`,
+            steps: [
+                sendsBody
+                    ? "Enter the address in **URL**, and the JSON to send in **Request Body**."
+                    : "Enter the address in **URL**.",
+                "Add headers, such as an API key, in **Request Headers** under the advanced settings.",
+                "Connect **Success** for an answer in the 2xx range, and **Error** for anything else.",
+            ],
+            examples: [
+                {
+                    title: "Read a field of the response in a later step",
+                    code: ownReference(context, "response-body", ["id"]),
+                    description: "Change `id` to the field you need. **Response Status** holds the status code, such as `200`.",
+                },
+            ],
+            notes: [
+                {
+                    type: ComponentDocumentationNoteType.Tip,
+                    text: "Redirects are not followed, so use the address the API finally answers on.",
+                },
+            ],
+            learnMore: [
+                {
+                    title: "Sending an API key",
+                    paragraphs: [
+                        "Save the key in a secret global variable and use the variable in **Request Headers**. Secret values are hidden in run logs.",
+                    ],
+                    example: {
+                        title: "Request Headers",
+                        code: '{"Authorization": "Bearer {{global.variables.API_TOKEN}}"}',
+                    },
+                },
+                {
+                    title: "When it fails",
+                    paragraphs: [
+                        "**Error** runs when the request cannot be sent or the answer is not in the 2xx range. **Response Status** and **Response Body** still hold the answer, and **Error** says what went wrong.",
+                    ],
+                },
+                {
+                    title: "Which addresses it can reach",
+                    paragraphs: [
+                        "Requests go out from OneUptime's servers. Addresses on a private network, `localhost` and cloud metadata addresses are refused, unless a self-hosted install is set up to allow private ones.",
+                    ],
+                },
+            ],
+            links: [docsLink("API step guide", WorkflowDocsPaths.api)],
+        };
+    };
+};
+export const getApiGetDocumentation = getAPIDocumentation("GET");
+export const getApiPostDocumentation = getAPIDocumentation("POST");
+export const getApiPutDocumentation = getAPIDocumentation("PUT");
+export const getApiPatchDocumentation = getAPIDocumentation("PATCH");
+export const getApiDeleteDocumentation = getAPIDocumentation("DELETE");
+//# sourceMappingURL=APIDocumentation.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"APIDocumentation.js","sourceRoot":"","sources":["../../../../../Types/Workflow/Documentation/APIDocumentation.ts"],"names":[],"mappings":"AAAA;;;GAGG;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;AAUnE,MAAM,mBAAmB,GAAgC,CACvD,MAAmD,EACzB,EAAE;IAC5B,4EAA4E;IAC5E,MAAM,SAAS,GACb,MAAM,KAAK,MAAM,IAAI,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,OAAO,CAAC;IAE9D,OAAO,CAAC,OAAsC,EAA0B,EAAE;QACxE,OAAO;YACL,OAAO,EAAE,SAAS;gBAChB,CAAC,CAAC,WAAW,MAAM,gFAAgF;gBACnG,CAAC,CAAC,WAAW,MAAM,+DAA+D;YACpF,KAAK,EAAE;gBACL,SAAS;oBACP,CAAC,CAAC,yEAAyE;oBAC3E,CAAC,CAAC,+BAA+B;gBACnC,sFAAsF;gBACtF,sFAAsF;aACvF;YACD,QAAQ,EAAE;gBACR;oBACE,KAAK,EAAE,8CAA8C;oBACrD,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,eAAe,EAAE,CAAC,IAAI,CAAC,CAAC;oBACpD,WAAW,EACT,8FAA8F;iBACjG;aACF;YACD,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,8BAA8B,CAAC,GAAG;oBACxC,IAAI,EAAE,4EAA4E;iBACnF;aACF;YACD,SAAS,EAAE;gBACT;oBACE,KAAK,EAAE,oBAAoB;oBAC3B,UAAU,EAAE;wBACV,6HAA6H;qBAC9H;oBACD,OAAO,EAAE;wBACP,KAAK,EAAE,iBAAiB;wBACxB,IAAI,EAAE,4DAA4D;qBACnE;iBACF;gBACD;oBACE,KAAK,EAAE,eAAe;oBACtB,UAAU,EAAE;wBACV,4LAA4L;qBAC7L;iBACF;gBACD;oBACE,KAAK,EAAE,8BAA8B;oBACrC,UAAU,EAAE;wBACV,+LAA+L;qBAChM;iBACF;aACF;YACD,KAAK,EAAE,CAAC,QAAQ,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC;SAC3D,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GACjC,mBAAmB,CAAC,KAAK,CAAC,CAAC;AAC7B,MAAM,CAAC,MAAM,uBAAuB,GAClC,mBAAmB,CAAC,MAAM,CAAC,CAAC;AAC9B,MAAM,CAAC,MAAM,sBAAsB,GACjC,mBAAmB,CAAC,KAAK,CAAC,CAAC;AAC7B,MAAM,CAAC,MAAM,wBAAwB,GACnC,mBAAmB,CAAC,OAAO,CAAC,CAAC;AAC/B,MAAM,CAAC,MAAM,yBAAyB,GACpC,mBAAmB,CAAC,QAAQ,CAAC,CAAC"}

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

@@ -0,0 +1,44 @@
+/*
+ * The help a workflow step's settings dialog shows under "How to use".
+ *
+ * It replaces one Markdown file per family of steps, fetched from the server
+ * and rendered as a manual: a heading and a paragraph per topic, the same text
+ * for Create One Incident as for Create One Monitor, with nothing in it about
+ * the step that was actually open. The feedback on it was that it should be
+ * "made simpler to understand and use", so the shape below is the whole
+ * format, and every step's help is written to it:
+ *
+ *   - summary   one sentence: what the step does.
+ *   - steps     how to use it, in order, two to four short lines.
+ *   - examples  something concrete to copy, built from this step's own
+ *               identifier and the workflow it sits in.
+ *   - notes     the gotchas, one or two sentences each, shown as callouts.
+ *   - learnMore everything longer, collapsed until asked for.
+ *   - links     where the full guide is.
+ *
+ * Text takes three pieces of inline markup and nothing else (see
+ * DocumentationText.ts):
+ *
+ *   **Name**               a setting, port, value or button, by the name the
+ *                          dialog shows. ComponentDocumentation.test.ts checks
+ *                          every one of these against the step it is about.
+ *   `literal`              something to type or copy exactly.
+ *   [label](https://...)   a link out of the product.
+ */
+export var ComponentDocumentationNoteType;
+(function (ComponentDocumentationNoteType) {
+    /** Worth knowing; nothing breaks if it is missed. */
+    ComponentDocumentationNoteType["Tip"] = "Tip";
+    /** Something that goes wrong, or cannot be undone, if it is missed. */
+    ComponentDocumentationNoteType["Warning"] = "Warning";
+})(ComponentDocumentationNoteType || (ComponentDocumentationNoteType = {}));
+export var ComponentDocumentationLinkSite;
+(function (ComponentDocumentationLinkSite) {
+    /** A page of OneUptime's docs. The path is under /docs. */
+    ComponentDocumentationLinkSite["Docs"] = "Docs";
+    /** OneUptime's API reference. The path is under the reference's root. */
+    ComponentDocumentationLinkSite["APIReference"] = "APIReference";
+    /** Anywhere else. The path is a full https URL. */
+    ComponentDocumentationLinkSite["External"] = "External";
+})(ComponentDocumentationLinkSite || (ComponentDocumentationLinkSite = {}));
+//# sourceMappingURL=ComponentDocumentation.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ComponentDocumentation.js","sourceRoot":"","sources":["../../../../../Types/Workflow/Documentation/ComponentDocumentation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,MAAM,CAAN,IAAY,8BAKX;AALD,WAAY,8BAA8B;IACxC,qDAAqD;IACrD,6CAAW,CAAA;IACX,uEAAuE;IACvE,qDAAmB,CAAA;AACrB,CAAC,EALW,8BAA8B,KAA9B,8BAA8B,QAKzC;AAgCD,MAAM,CAAN,IAAY,8BAOX;AAPD,WAAY,8BAA8B;IACxC,2DAA2D;IAC3D,+CAAa,CAAA;IACb,yEAAyE;IACzE,+DAA6B,CAAA;IAC7B,mDAAmD;IACnD,uDAAqB,CAAA;AACvB,CAAC,EAPW,8BAA8B,KAA9B,8BAA8B,QAOzC"}