@oneuptime/common 14.0.11 → 14.0.12

package/build/dist/Utils/DeveloperDocs/AiAssistantExamples.js

@@ -0,0 +1,278 @@
+import { ONEUPTIME_API_KEY_ENVIRONMENT_VARIABLE, toSentenceCaseName, } from "./ExampleValues";
+import { getTerraformTypeName } from "./TerraformSchema";
+/*
+ * The MCP server's tool-name rule (MCP/Tools/SchemaConverter.ts
+ * sanitizeToolName): "On-Call Policy" -> on_call_policy.
+ */
+export function sanitizeMcpToolName(name) {
+    return name
+        .replace(/([a-z])([A-Z])/g, "$1_$2")
+        .toLowerCase()
+        .replace(/[^a-z0-9]/g, "_")
+        .replace(/_+/g, "_")
+        .replace(/^_|_$/g, "");
+}
+// Whether the MCP server has tools for this model.
+export function hasMcpTools(modelType) {
+    const model = new modelType();
+    return Boolean(model.enableMCP && model.tableName && model.crudApiPath);
+}
+// The MCP server's tools for a model, or null when it has none.
+export function getMcpToolNames(modelType) {
+    if (!hasMcpTools(modelType)) {
+        return null;
+    }
+    const model = new modelType();
+    const singularName = model.singularName || model.tableName || "";
+    const pluralName = model.pluralName || `${singularName}s`;
+    const singular = sanitizeMcpToolName(singularName);
+    const plural = sanitizeMcpToolName(pluralName);
+    return {
+        create: `create_${singular}`,
+        get: `get_${singular}`,
+        list: `list_${plural}`,
+        update: `update_${singular}`,
+        delete: `delete_${singular}`,
+        count: `count_${plural}`,
+    };
+}
+// `https://oneuptime.com/mcp`.
+export function getMcpServerUrl(oneuptimeUrl) {
+    return `${oneuptimeUrl.replace(/\/+$/, "")}/mcp`;
+}
+const FENCE = "```";
+function codeBlock(language, code) {
+    return `${FENCE}${language}\n${code}\n${FENCE}`;
+}
+/*
+ * Connecting each common MCP client by signing in: the server URL is all a
+ * client needs; it opens OneUptime to sign in the first time.
+ */
+export function getMcpClientSetups(mcpUrl) {
+    return [
+        {
+            label: "Claude Code",
+            markdown: [
+                "Add the server, then run `/mcp` inside Claude Code and choose **oneuptime** to sign in:",
+                "",
+                codeBlock("bash", `claude mcp add --transport http oneuptime ${mcpUrl}`),
+            ].join("\n"),
+        },
+        {
+            label: "Claude",
+            markdown: [
+                "In Claude (web or desktop), open **Customize → Connectors**, choose **Add custom connector** and enter this URL. Claude asks you to sign in to OneUptime the first time it needs your data.",
+                "",
+                codeBlock("text", mcpUrl),
+            ].join("\n"),
+        },
+        {
+            label: "VS Code",
+            markdown: [
+                "Add this to `.vscode/mcp.json`. VS Code opens OneUptime for you to sign in when the server starts:",
+                "",
+                codeBlock("json", JSON.stringify({ servers: { oneuptime: { type: "http", url: mcpUrl } } }, null, 2)),
+            ].join("\n"),
+        },
+        {
+            label: "Cursor",
+            markdown: [
+                "Add this to `~/.cursor/mcp.json` (or `.cursor/mcp.json` in a project):",
+                "",
+                codeBlock("json", JSON.stringify({ mcpServers: { oneuptime: { url: mcpUrl } } }, null, 2)),
+            ].join("\n"),
+        },
+        {
+            label: "Other assistants",
+            markdown: [
+                "Any assistant that supports remote MCP servers works the same way: give it this URL, and sign in to OneUptime when it asks.",
+                "",
+                codeBlock("text", mcpUrl),
+            ].join("\n"),
+        },
+    ];
+}
+/*
+ * Connecting an agent that runs on its own (a scheduled job, a CI step),
+ * where nobody is there to sign in: an API key in a header.
+ */
+export function getMcpApiKeySetupMarkdown(mcpUrl) {
+    return [
+        `Give the agent a project API key in the \`x-api-key\` header. With Claude Code, for example, read it from the \`${ONEUPTIME_API_KEY_ENVIRONMENT_VARIABLE}\` environment variable:`,
+        "",
+        codeBlock("bash", `claude mcp add --transport http oneuptime ${mcpUrl} --header "x-api-key: $${ONEUPTIME_API_KEY_ENVIRONMENT_VARIABLE}"`),
+        "",
+        "Create the key with only the permissions the agent needs. Never give an agent a master API key.",
+    ].join("\n");
+}
+// `the workflow "Send weekly report" (ID 6e4f...)`.
+export function describeResourceForPrompt(context) {
+    const noun = toSentenceCaseName(context.singularName);
+    if (context.displayName && context.id) {
+        return `the ${noun} "${context.displayName}" (ID ${context.id})`;
+    }
+    if (context.id) {
+        return `the ${noun} with ID ${context.id}`;
+    }
+    return `the ${noun}`;
+}
+/*
+ * Prompts for the resources the MCP server has tools for, by table. Each one
+ * asks only for what those tools can do: the timelines, notes and
+ * acknowledge/resolve tools exist for incidents and alerts, announcements
+ * for status pages, and so on.
+ */
+const MCP_PROMPTS_BY_TABLE = {
+    Monitor: {
+        resource: (resource) => {
+            return [
+                `Is ${resource} up right now? Show me its status changes from the last 7 days.`,
+                `List the incidents ${resource} opened in the last 30 days and how long each took to resolve.`,
+                `Update the description of ${resource} to say what it checks and who to call when it is down.`,
+            ];
+        },
+        collection: [
+            "Which of my monitors are not operational right now?",
+            "List my monitors that have no labels.",
+            "Create a website monitor for https://example.com that checks it every 5 minutes.",
+        ],
+    },
+    Incident: {
+        resource: (resource) => {
+            return [
+                `Summarize ${resource}: what happened, its timeline and where it stands now.`,
+                `Acknowledge ${resource} and add an internal note that I am looking into it.`,
+                `Draft a public status page update for ${resource}, show it to me, and post it once I approve.`,
+            ];
+        },
+        collection: [
+            "Show me the incidents that are not resolved yet, most severe first.",
+            "How many incidents did we have in the last 30 days, by severity?",
+            "Which monitors caused the most incidents this month?",
+        ],
+    },
+    Alert: {
+        resource: (resource) => {
+            return [
+                `Summarize ${resource} and its timeline.`,
+                `Acknowledge ${resource} and add an internal note that I am looking into it.`,
+                `Resolve ${resource} with a note on what fixed it.`,
+            ];
+        },
+        collection: [
+            "Which alerts are open right now?",
+            "How many alerts fired in the last 7 days, by severity?",
+            "Acknowledge every open alert and add a note that I am on it.",
+        ],
+    },
+    ScheduledMaintenance: {
+        resource: (resource) => {
+            return [
+                `When does ${resource} start and end, and what does it affect?`,
+                `What state is ${resource} in, and when did that change?`,
+                `Move ${resource} one hour later.`,
+            ];
+        },
+        collection: [
+            "What maintenance is scheduled for the next 7 days?",
+            'Schedule maintenance called "Database upgrade" for next Saturday from 02:00 to 04:00 UTC.',
+        ],
+    },
+    StatusPage: {
+        resource: (resource) => {
+            return [
+                `Show me how ${resource} is set up: is it public, and how can people subscribe?`,
+                `Post an announcement on ${resource} saying we are investigating slow logins.`,
+                `List the announcements on ${resource} from the last 30 days.`,
+            ];
+        },
+        collection: [
+            "List my status pages and say which ones are public.",
+            "Post an announcement on every public status page about maintenance this Saturday.",
+        ],
+    },
+    StatusPageAnnouncement: {
+        resource: (resource) => {
+            return [
+                `Show me ${resource} and the status pages it is on.`,
+                `End ${resource} now.`,
+            ];
+        },
+        collection: [
+            "List the announcements that are showing on my status pages right now.",
+            "Post an announcement on every public status page about maintenance this Saturday.",
+        ],
+    },
+    Team: {
+        resource: (resource) => {
+            return [
+                `Show me ${resource} and what it is for.`,
+                `Update the description of ${resource} to say what the team owns.`,
+            ];
+        },
+        collection: [
+            "List the teams in this project.",
+            'Create a team called "Platform".',
+        ],
+    },
+    OnCallDutyPolicy: {
+        resource: (resource) => {
+            return [
+                `Show me ${resource} and how it is set up.`,
+                `List the incidents from the last 7 days that ${resource} was paged for.`,
+            ];
+        },
+        collection: [
+            "List my on-call policies.",
+            "Which on-call policies have no labels?",
+        ],
+    },
+};
+/*
+ * Prompts to start from. With MCP tools for the model, they ask the
+ * assistant to use OneUptime directly. Without, they are written for an
+ * assistant that can run commands (Claude Code, Cursor, GitHub Copilot):
+ * they point it at the API reference and the API key in the environment,
+ * and one asks for Terraform instead.
+ */
+export function getAssistantPrompts(context) {
+    const plural = toSentenceCaseName(context.pluralName);
+    const noun = toSentenceCaseName(context.singularName);
+    const terraformType = getTerraformTypeName(context.modelType);
+    const isResource = Boolean(context.id);
+    const resource = describeResourceForPrompt(context);
+    if (hasMcpTools(context.modelType)) {
+        const tableName = new context.modelType().tableName || "";
+        const curated = MCP_PROMPTS_BY_TABLE[tableName];
+        if (curated) {
+            return isResource ? curated.resource(resource) : [...curated.collection];
+        }
+        if (isResource) {
+            return [
+                `Show me ${resource} in OneUptime and summarize how it is set up.`,
+                `Update the description of ${resource} so it explains what it is for and who owns it.`,
+            ];
+        }
+        return [
+            `List my ${plural} in OneUptime.`,
+            `Create a ${noun} in OneUptime called "Example ${noun}" and show me what you set.`,
+        ];
+    }
+    const apiNote = `Use the OneUptime REST API (reference: ${context.apiReferenceUrl}) with the API key in the ${ONEUPTIME_API_KEY_ENVIRONMENT_VARIABLE} environment variable.`;
+    const prompts = isResource
+        ? [
+            `Show me ${resource} and explain what it does. ${apiNote}`,
+            `Update the description of ${resource} so it explains what it is for. ${apiNote}`,
+        ]
+        : [
+            `List my ${plural} and summarize them in a table. ${apiNote}`,
+            `Create a ${noun} called "Example ${noun}" and show me what you set. ${apiNote}`,
+        ];
+    if (terraformType) {
+        prompts.push(isResource
+            ? `Write Terraform for ${resource} with the oneuptime/oneuptime provider (resource ${terraformType}), with an import block so Terraform adopts the existing one.`
+            : `Write Terraform with the oneuptime/oneuptime provider to manage my ${plural} (resource ${terraformType}), and import blocks for the ones I already have.`);
+    }
+    return prompts;
+}
+//# sourceMappingURL=AiAssistantExamples.js.map

package/build/dist/Utils/DeveloperDocs/AiAssistantExamples.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AiAssistantExamples.js","sourceRoot":"","sources":["../../../../Utils/DeveloperDocs/AiAssistantExamples.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,sCAAsC,EACtC,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAuBzD;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAY;IAC9C,OAAO,IAAI;SACR,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC;SACnC,WAAW,EAAE;SACb,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC;SAC1B,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAC3B,CAAC;AAED,mDAAmD;AACnD,MAAM,UAAU,WAAW,CAAC,SAAgC;IAC1D,MAAM,KAAK,GAAsB,IAAI,SAAS,EAAE,CAAC;IAEjD,OAAO,OAAO,CAAC,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;AAC1E,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,eAAe,CAC7B,SAAgC;IAEhC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAsB,IAAI,SAAS,EAAE,CAAC;IACjD,MAAM,YAAY,GAAW,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,SAAS,IAAI,EAAE,CAAC;IACzE,MAAM,UAAU,GAAW,KAAK,CAAC,UAAU,IAAI,GAAG,YAAY,GAAG,CAAC;IAClE,MAAM,QAAQ,GAAW,mBAAmB,CAAC,YAAY,CAAC,CAAC;IAC3D,MAAM,MAAM,GAAW,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAEvD,OAAO;QACL,MAAM,EAAE,UAAU,QAAQ,EAAE;QAC5B,GAAG,EAAE,OAAO,QAAQ,EAAE;QACtB,IAAI,EAAE,QAAQ,MAAM,EAAE;QACtB,MAAM,EAAE,UAAU,QAAQ,EAAE;QAC5B,MAAM,EAAE,UAAU,QAAQ,EAAE;QAC5B,KAAK,EAAE,SAAS,MAAM,EAAE;KACzB,CAAC;AACJ,CAAC;AAED,+BAA+B;AAC/B,MAAM,UAAU,eAAe,CAAC,YAAoB;IAClD,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC;AACnD,CAAC;AASD,MAAM,KAAK,GAAW,KAAK,CAAC;AAE5B,SAAS,SAAS,CAAC,QAAgB,EAAE,IAAY;IAC/C,OAAO,GAAG,KAAK,GAAG,QAAQ,KAAK,IAAI,KAAK,KAAK,EAAE,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAc;IAC/C,OAAO;QACL;YACE,KAAK,EAAE,aAAa;YACpB,QAAQ,EAAE;gBACR,yFAAyF;gBACzF,EAAE;gBACF,SAAS,CACP,MAAM,EACN,6CAA6C,MAAM,EAAE,CACtD;aACF,CAAC,IAAI,CAAC,IAAI,CAAC;SACb;QACD;YACE,KAAK,EAAE,QAAQ;YACf,QAAQ,EAAE;gBACR,6LAA6L;gBAC7L,EAAE;gBACF,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;aAC1B,CAAC,IAAI,CAAC,IAAI,CAAC;SACb;QACD;YACE,KAAK,EAAE,SAAS;YAChB,QAAQ,EAAE;gBACR,oGAAoG;gBACpG,EAAE;gBACF,SAAS,CACP,MAAM,EACN,IAAI,CAAC,SAAS,CACZ,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,EACzD,IAAI,EACJ,CAAC,CACF,CACF;aACF,CAAC,IAAI,CAAC,IAAI,CAAC;SACb;QACD;YACE,KAAK,EAAE,QAAQ;YACf,QAAQ,EAAE;gBACR,wEAAwE;gBACxE,EAAE;gBACF,SAAS,CACP,MAAM,EACN,IAAI,CAAC,SAAS,CACZ,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,EAC9C,IAAI,EACJ,CAAC,CACF,CACF;aACF,CAAC,IAAI,CAAC,IAAI,CAAC;SACb;QACD;YACE,KAAK,EAAE,kBAAkB;YACzB,QAAQ,EAAE;gBACR,6HAA6H;gBAC7H,EAAE;gBACF,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;aAC1B,CAAC,IAAI,CAAC,IAAI,CAAC;SACb;KACF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAAc;IACtD,OAAO;QACL,mHAAmH,sCAAsC,0BAA0B;QACnL,EAAE;QACF,SAAS,CACP,MAAM,EACN,6CAA6C,MAAM,0BAA0B,sCAAsC,GAAG,CACvH;QACD,EAAE;QACF,iGAAiG;KAClG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAcD,oDAAoD;AACpD,MAAM,UAAU,yBAAyB,CACvC,OAA+B;IAE/B,MAAM,IAAI,GAAW,kBAAkB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAE9D,IAAI,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC;QACtC,OAAO,OAAO,IAAI,KAAK,OAAO,CAAC,WAAW,SAAS,OAAO,CAAC,EAAE,GAAG,CAAC;IACnE,CAAC;IAED,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,OAAO,IAAI,YAAY,OAAO,CAAC,EAAE,EAAE,CAAC;IAC7C,CAAC;IAED,OAAO,OAAO,IAAI,EAAE,CAAC;AACvB,CAAC;AASD;;;;;GAKG;AACH,MAAM,oBAAoB,GAAwC;IAChE,OAAO,EAAE;QACP,QAAQ,EAAE,CAAC,QAAgB,EAAiB,EAAE;YAC5C,OAAO;gBACL,MAAM,QAAQ,iEAAiE;gBAC/E,sBAAsB,QAAQ,gEAAgE;gBAC9F,6BAA6B,QAAQ,yDAAyD;aAC/F,CAAC;QACJ,CAAC;QACD,UAAU,EAAE;YACV,qDAAqD;YACrD,uCAAuC;YACvC,kFAAkF;SACnF;KACF;IACD,QAAQ,EAAE;QACR,QAAQ,EAAE,CAAC,QAAgB,EAAiB,EAAE;YAC5C,OAAO;gBACL,aAAa,QAAQ,wDAAwD;gBAC7E,eAAe,QAAQ,sDAAsD;gBAC7E,yCAAyC,QAAQ,8CAA8C;aAChG,CAAC;QACJ,CAAC;QACD,UAAU,EAAE;YACV,qEAAqE;YACrE,kEAAkE;YAClE,sDAAsD;SACvD;KACF;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,CAAC,QAAgB,EAAiB,EAAE;YAC5C,OAAO;gBACL,aAAa,QAAQ,oBAAoB;gBACzC,eAAe,QAAQ,sDAAsD;gBAC7E,WAAW,QAAQ,gCAAgC;aACpD,CAAC;QACJ,CAAC;QACD,UAAU,EAAE;YACV,kCAAkC;YAClC,wDAAwD;YACxD,8DAA8D;SAC/D;KACF;IACD,oBAAoB,EAAE;QACpB,QAAQ,EAAE,CAAC,QAAgB,EAAiB,EAAE;YAC5C,OAAO;gBACL,aAAa,QAAQ,0CAA0C;gBAC/D,iBAAiB,QAAQ,gCAAgC;gBACzD,QAAQ,QAAQ,kBAAkB;aACnC,CAAC;QACJ,CAAC;QACD,UAAU,EAAE;YACV,oDAAoD;YACpD,2FAA2F;SAC5F;KACF;IACD,UAAU,EAAE;QACV,QAAQ,EAAE,CAAC,QAAgB,EAAiB,EAAE;YAC5C,OAAO;gBACL,eAAe,QAAQ,yDAAyD;gBAChF,2BAA2B,QAAQ,2CAA2C;gBAC9E,6BAA6B,QAAQ,yBAAyB;aAC/D,CAAC;QACJ,CAAC;QACD,UAAU,EAAE;YACV,qDAAqD;YACrD,mFAAmF;SACpF;KACF;IACD,sBAAsB,EAAE;QACtB,QAAQ,EAAE,CAAC,QAAgB,EAAiB,EAAE;YAC5C,OAAO;gBACL,WAAW,QAAQ,iCAAiC;gBACpD,OAAO,QAAQ,OAAO;aACvB,CAAC;QACJ,CAAC;QACD,UAAU,EAAE;YACV,uEAAuE;YACvE,mFAAmF;SACpF;KACF;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,CAAC,QAAgB,EAAiB,EAAE;YAC5C,OAAO;gBACL,WAAW,QAAQ,sBAAsB;gBACzC,6BAA6B,QAAQ,6BAA6B;aACnE,CAAC;QACJ,CAAC;QACD,UAAU,EAAE;YACV,iCAAiC;YACjC,kCAAkC;SACnC;KACF;IACD,gBAAgB,EAAE;QAChB,QAAQ,EAAE,CAAC,QAAgB,EAAiB,EAAE;YAC5C,OAAO;gBACL,WAAW,QAAQ,wBAAwB;gBAC3C,gDAAgD,QAAQ,iBAAiB;aAC1E,CAAC;QACJ,CAAC;QACD,UAAU,EAAE;YACV,2BAA2B;YAC3B,wCAAwC;SACzC;KACF;CACF,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAA+B;IAE/B,MAAM,MAAM,GAAW,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC9D,MAAM,IAAI,GAAW,kBAAkB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC9D,MAAM,aAAa,GAAkB,oBAAoB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC7E,MAAM,UAAU,GAAY,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAChD,MAAM,QAAQ,GAAW,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAE5D,IAAI,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QACnC,MAAM,SAAS,GAAW,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC,SAAS,IAAI,EAAE,CAAC;QAClE,MAAM,OAAO,GAA0B,oBAAoB,CAAC,SAAS,CAAC,CAAC;QAEvE,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;QAC3E,CAAC;QAED,IAAI,UAAU,EAAE,CAAC;YACf,OAAO;gBACL,WAAW,QAAQ,+CAA+C;gBAClE,6BAA6B,QAAQ,iDAAiD;aACvF,CAAC;QACJ,CAAC;QAED,OAAO;YACL,WAAW,MAAM,gBAAgB;YACjC,YAAY,IAAI,iCAAiC,IAAI,6BAA6B;SACnF,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAW,0CAA0C,OAAO,CAAC,eAAe,6BAA6B,sCAAsC,wBAAwB,CAAC;IAErL,MAAM,OAAO,GAAkB,UAAU;QACvC,CAAC,CAAC;YACE,WAAW,QAAQ,8BAA8B,OAAO,EAAE;YAC1D,6BAA6B,QAAQ,mCAAmC,OAAO,EAAE;SAClF;QACH,CAAC,CAAC;YACE,WAAW,MAAM,mCAAmC,OAAO,EAAE;YAC7D,YAAY,IAAI,oBAAoB,IAAI,+BAA+B,OAAO,EAAE;SACjF,CAAC;IAEN,IAAI,aAAa,EAAE,CAAC;QAClB,OAAO,CAAC,IAAI,CACV,UAAU;YACR,CAAC,CAAC,uBAAuB,QAAQ,oDAAoD,aAAa,+DAA+D;YACjK,CAAC,CAAC,sEAAsE,MAAM,cAAc,aAAa,mDAAmD,CAC/J,CAAC;IACJ,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/build/dist/Utils/DeveloperDocs/ApiExamples.js

@@ -0,0 +1,225 @@
+import { getNameColumn, getTerraformAttributes, getTerraformModelOperations, isModelInPublicApi, TerraformValueKind, } from "./TerraformSchema";
+import { getExampleJsonValue, ONEUPTIME_API_KEY_ENVIRONMENT_VARIABLE, } from "./ExampleValues";
+// How many fields a read example asks for, besides the id.
+const MAX_READ_EXAMPLE_FIELDS = 6;
+// Characters a POSIX shell leaves alone in an unquoted word.
+const SHELL_SAFE_WORD = /^[A-Za-z0-9._:@%+,/=-]+$/;
+/*
+ * One shell word that reaches the command exactly as written: bare when made
+ * only of characters the shell leaves alone, otherwise single-quoted (a `'`
+ * inside closes the quote, adds an escaped quote and opens it again). A
+ * resource named "Bob's API" can therefore not end the quoted JSON early.
+ */
+export function shellQuote(value) {
+    return SHELL_SAFE_WORD.test(value)
+        ? value
+        : `'${value.split("'").join("'\\''")}'`;
+}
+/*
+ * `https://oneuptime.com/api`: the API's base URL, from the dashboard's
+ * origin.
+ */
+export function getApiBaseUrl(oneuptimeUrl) {
+    return `${oneuptimeUrl.replace(/\/+$/, "")}/api`;
+}
+// `/workflow`, the model's path under the API.
+export function getModelApiPath(modelType) {
+    var _a;
+    const model = new modelType();
+    const path = (_a = model.crudApiPath) === null || _a === void 0 ? void 0 : _a.toString();
+    return path ? `/${path.replace(/^\/+/, "")}` : null;
+}
+/*
+ * A curl command for one request: the API key from the environment, and
+ * the JSON body pretty-printed inside single quotes.
+ */
+export function getCurlCommand(data) {
+    const lines = [
+        `curl -X ${data.method} ${shellQuote(data.url)}`,
+        `-H "ApiKey: $${ONEUPTIME_API_KEY_ENVIRONMENT_VARIABLE}"`,
+    ];
+    if (data.body) {
+        lines.push(`-H "Content-Type: application/json"`);
+        lines.push(`-d ${shellQuote(JSON.stringify(data.body, null, 2))}`);
+    }
+    return lines.join(" \\\n  ");
+}
+function example(data) {
+    return {
+        method: data.method,
+        url: data.url,
+        body: data.body,
+        curl: getCurlCommand(data),
+    };
+}
+function isReadableExampleField(descriptor) {
+    return (!descriptor.secretKind &&
+        !descriptor.isServerManaged &&
+        (descriptor.kind === TerraformValueKind.String ||
+            descriptor.kind === TerraformValueKind.Number ||
+            descriptor.kind === TerraformValueKind.Bool ||
+            descriptor.kind === TerraformValueKind.DateTime));
+}
+/*
+ * The `select` of a read example: the name, then the first few plain fields
+ * the model declares (no secrets, no large JSON).
+ */
+export function getExampleSelect(modelType) {
+    const select = { _id: true };
+    const nameColumn = getNameColumn(modelType);
+    if (nameColumn) {
+        select[nameColumn] = true;
+    }
+    for (const descriptor of getTerraformAttributes(modelType)) {
+        if (Object.keys(select).length > MAX_READ_EXAMPLE_FIELDS) {
+            break;
+        }
+        if (isReadableExampleField(descriptor)) {
+            select[descriptor.columnName] = true;
+        }
+    }
+    return select;
+}
+/*
+ * The `data` of a change example: a new description when the resource has
+ * one, otherwise a new name.
+ */
+function getExampleUpdateData(data) {
+    const attributes = getTerraformAttributes(data.modelType).filter((descriptor) => {
+        return descriptor.inUpdateSchema;
+    });
+    const hasColumn = (columnName) => {
+        return attributes.some((descriptor) => {
+            return descriptor.columnName === columnName;
+        });
+    };
+    if (hasColumn("description")) {
+        return { description: "Updated with the OneUptime API" };
+    }
+    const nameColumn = getNameColumn(data.modelType);
+    if (nameColumn && hasColumn(nameColumn)) {
+        return {
+            [nameColumn]: data.displayName
+                ? `${data.displayName} (renamed)`
+                : "New name",
+        };
+    }
+    return null;
+}
+/*
+ * The `data` of a create example: every field the API requires, with
+ * example values, plus the description.
+ */
+export function getExampleCreateData(data) {
+    var _a;
+    const nameColumn = getNameColumn(data.modelType);
+    const createData = {};
+    for (const descriptor of getTerraformAttributes(data.modelType)) {
+        if (!descriptor.inCreateSchema) {
+            continue;
+        }
+        const isNameColumn = descriptor.columnName === nameColumn;
+        const isDescription = descriptor.columnName === "description";
+        if (!descriptor.isRequired && !isNameColumn && !isDescription) {
+            continue;
+        }
+        if (descriptor.kind === TerraformValueKind.Unsupported) {
+            continue;
+        }
+        const exampleValue = (_a = data.exampleValues) === null || _a === void 0 ? void 0 : _a[descriptor.columnName];
+        if (exampleValue !== undefined) {
+            createData[descriptor.columnName] = exampleValue;
+        }
+        else if (isDescription) {
+            createData[descriptor.columnName] = "Created with the OneUptime API";
+        }
+        else {
+            createData[descriptor.columnName] = getExampleJsonValue({
+                descriptor,
+                singularName: data.singularName,
+                isNameColumn,
+            });
+        }
+    }
+    // The name first, as people read it.
+    if (nameColumn && nameColumn in createData) {
+        return Object.assign({ [nameColumn]: createData[nameColumn] }, createData);
+    }
+    return createData;
+}
+// Read, change and delete examples for one resource.
+export function getResourceApiExamples(data) {
+    const path = getModelApiPath(data.modelType);
+    if (!path || !isModelInPublicApi(data.modelType)) {
+        return { read: null, update: null, delete: null };
+    }
+    const operations = getTerraformModelOperations(data.modelType);
+    const itemUrl = `${data.apiBaseUrl}${path}/${data.id}`;
+    const updateData = operations.canUpdate
+        ? getExampleUpdateData({
+            modelType: data.modelType,
+            displayName: data.displayName || null,
+        })
+        : null;
+    return {
+        read: operations.canRead
+            ? example({
+                method: "POST",
+                url: `${itemUrl}/get-item`,
+                body: { select: getExampleSelect(data.modelType) },
+            })
+            : null,
+        update: updateData
+            ? example({ method: "PUT", url: itemUrl, body: { data: updateData } })
+            : null,
+        delete: operations.canDelete
+            ? example({ method: "DELETE", url: itemUrl })
+            : null,
+    };
+}
+// List, count and create examples for a resource type.
+export function getCollectionApiExamples(data) {
+    const path = getModelApiPath(data.modelType);
+    if (!path || !isModelInPublicApi(data.modelType)) {
+        return { list: null, count: null, create: null };
+    }
+    const operations = getTerraformModelOperations(data.modelType);
+    const collectionUrl = `${data.apiBaseUrl}${path}`;
+    const createData = getExampleCreateData({
+        modelType: data.modelType,
+        singularName: data.singularName,
+        exampleValues: data.exampleValues,
+    });
+    return {
+        list: operations.canRead
+            ? example({
+                method: "POST",
+                url: `${collectionUrl}/get-list?skip=0&limit=10`,
+                body: {
+                    select: getExampleSelect(data.modelType),
+                    sort: { createdAt: "DESC" },
+                },
+            })
+            : null,
+        count: operations.canRead
+            ? example({
+                method: "POST",
+                url: `${collectionUrl}/count`,
+                body: { query: {} },
+            })
+            : null,
+        create: operations.canCreate && Object.keys(createData).length > 0
+            ? example({
+                method: "POST",
+                url: collectionUrl,
+                body: { data: createData },
+            })
+            : null,
+    };
+}
+// The API reference page for a model: `https://oneuptime.com/reference/workflow`.
+export function getApiReferenceUrl(data) {
+    const model = new data.modelType();
+    return `${data.oneuptimeUrl.replace(/\/+$/, "")}/reference/${model.getAPIDocumentationPath()}`;
+}
+//# sourceMappingURL=ApiExamples.js.map

package/build/dist/Utils/DeveloperDocs/ApiExamples.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiExamples.js","sourceRoot":"","sources":["../../../../Utils/DeveloperDocs/ApiExamples.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,aAAa,EACb,sBAAsB,EACtB,2BAA2B,EAC3B,kBAAkB,EAGlB,kBAAkB,GACnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,mBAAmB,EACnB,sCAAsC,GACvC,MAAM,iBAAiB,CAAC;AAiCzB,2DAA2D;AAC3D,MAAM,uBAAuB,GAAW,CAAC,CAAC;AAE1C,6DAA6D;AAC7D,MAAM,eAAe,GAAW,0BAA0B,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC;QAChC,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;AAC5C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,YAAoB;IAChD,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC;AACnD,CAAC;AAED,+CAA+C;AAC/C,MAAM,UAAU,eAAe,CAC7B,SAAgC;;IAEhC,MAAM,KAAK,GAAsB,IAAI,SAAS,EAAE,CAAC;IACjD,MAAM,IAAI,GAAuB,MAAA,KAAK,CAAC,WAAW,0CAAE,QAAQ,EAAE,CAAC;IAE/D,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AACtD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,IAI9B;IACC,MAAM,KAAK,GAAkB;QAC3B,WAAW,IAAI,CAAC,MAAM,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAChD,gBAAgB,sCAAsC,GAAG;KAC1D,CAAC;IAEF,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,KAAK,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;QAClD,KAAK,CAAC,IAAI,CAAC,MAAM,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AAC/B,CAAC;AAED,SAAS,OAAO,CAAC,IAIhB;IACC,OAAO;QACL,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC;KAC3B,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB,CAC7B,UAAwC;IAExC,OAAO,CACL,CAAC,UAAU,CAAC,UAAU;QACtB,CAAC,UAAU,CAAC,eAAe;QAC3B,CAAC,UAAU,CAAC,IAAI,KAAK,kBAAkB,CAAC,MAAM;YAC5C,UAAU,CAAC,IAAI,KAAK,kBAAkB,CAAC,MAAM;YAC7C,UAAU,CAAC,IAAI,KAAK,kBAAkB,CAAC,IAAI;YAC3C,UAAU,CAAC,IAAI,KAAK,kBAAkB,CAAC,QAAQ,CAAC,CACnD,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,SAAgC;IAC/D,MAAM,MAAM,GAAe,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;IACzC,MAAM,UAAU,GAAkB,aAAa,CAAC,SAAS,CAAC,CAAC;IAE3D,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAC5B,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,sBAAsB,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3D,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,uBAAuB,EAAE,CAAC;YACzD,MAAM;QACR,CAAC;QAED,IAAI,sBAAsB,CAAC,UAAU,CAAC,EAAE,CAAC;YACvC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QACvC,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,IAG7B;IACC,MAAM,UAAU,GACd,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAC3C,CAAC,UAAwC,EAAW,EAAE;QACpD,OAAO,UAAU,CAAC,cAAc,CAAC;IACnC,CAAC,CACF,CAAC;IAEJ,MAAM,SAAS,GAAoC,CACjD,UAAkB,EACT,EAAE;QACX,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,UAAwC,EAAE,EAAE;YAClE,OAAO,UAAU,CAAC,UAAU,KAAK,UAAU,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,IAAI,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;QAC7B,OAAO,EAAE,WAAW,EAAE,gCAAgC,EAAE,CAAC;IAC3D,CAAC;IAED,MAAM,UAAU,GAAkB,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAEhE,IAAI,UAAU,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;QACxC,OAAO;YACL,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,WAAW;gBAC5B,CAAC,CAAC,GAAG,IAAI,CAAC,WAAW,YAAY;gBACjC,CAAC,CAAC,UAAU;SACf,CAAC;IACJ,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAIpC;;IACC,MAAM,UAAU,GAAkB,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAChE,MAAM,UAAU,GAAe,EAAE,CAAC;IAElC,KAAK,MAAM,UAAU,IAAI,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAChE,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC;YAC/B,SAAS;QACX,CAAC;QAED,MAAM,YAAY,GAAY,UAAU,CAAC,UAAU,KAAK,UAAU,CAAC;QACnE,MAAM,aAAa,GAAY,UAAU,CAAC,UAAU,KAAK,aAAa,CAAC;QAEvE,IAAI,CAAC,UAAU,CAAC,UAAU,IAAI,CAAC,YAAY,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9D,SAAS;QACX,CAAC;QAED,IAAI,UAAU,CAAC,IAAI,KAAK,kBAAkB,CAAC,WAAW,EAAE,CAAC;YACvD,SAAS;QACX,CAAC;QAED,MAAM,YAAY,GAChB,MAAA,IAAI,CAAC,aAAa,0CAAG,UAAU,CAAC,UAAU,CAAC,CAAC;QAE9C,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,YAAY,CAAC;QACnD,CAAC;aAAM,IAAI,aAAa,EAAE,CAAC;YACzB,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,gCAAgC,CAAC;QACvE,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,mBAAmB,CAAC;gBACtD,UAAU;gBACV,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,YAAY;aACb,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,qCAAqC;IACrC,IAAI,UAAU,IAAI,UAAU,IAAI,UAAU,EAAE,CAAC;QAC3C,uBACE,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,CAAc,IAC9C,UAAU,EACb;IACJ,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,qDAAqD;AACrD,MAAM,UAAU,sBAAsB,CAAC,IAKtC;IACC,MAAM,IAAI,GAAkB,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAE5D,IAAI,CAAC,IAAI,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QACjD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACpD,CAAC;IAED,MAAM,UAAU,GAA6B,2BAA2B,CACtE,IAAI,CAAC,SAAS,CACf,CAAC;IACF,MAAM,OAAO,GAAW,GAAG,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;IAC/D,MAAM,UAAU,GAAsB,UAAU,CAAC,SAAS;QACxD,CAAC,CAAC,oBAAoB,CAAC;YACnB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,IAAI;SACtC,CAAC;QACJ,CAAC,CAAC,IAAI,CAAC;IAET,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,OAAO;YACtB,CAAC,CAAC,OAAO,CAAC;gBACN,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,GAAG,OAAO,WAAW;gBAC1B,IAAI,EAAE,EAAE,MAAM,EAAE,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;aACnD,CAAC;YACJ,CAAC,CAAC,IAAI;QACR,MAAM,EAAE,UAAU;YAChB,CAAC,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,CAAC;YACtE,CAAC,CAAC,IAAI;QACR,MAAM,EAAE,UAAU,CAAC,SAAS;YAC1B,CAAC,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;YAC7C,CAAC,CAAC,IAAI;KACT,CAAC;AACJ,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,wBAAwB,CAAC,IAKxC;IACC,MAAM,IAAI,GAAkB,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAE5D,IAAI,CAAC,IAAI,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QACjD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAED,MAAM,UAAU,GAA6B,2BAA2B,CACtE,IAAI,CAAC,SAAS,CACf,CAAC;IACF,MAAM,aAAa,GAAW,GAAG,IAAI,CAAC,UAAU,GAAG,IAAI,EAAE,CAAC;IAC1D,MAAM,UAAU,GAAe,oBAAoB,CAAC;QAClD,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,aAAa,EAAE,IAAI,CAAC,aAAa;KAClC,CAAC,CAAC;IAEH,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,OAAO;YACtB,CAAC,CAAC,OAAO,CAAC;gBACN,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,GAAG,aAAa,2BAA2B;gBAChD,IAAI,EAAE;oBACJ,MAAM,EAAE,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC;oBACxC,IAAI,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE;iBAC5B;aACF,CAAC;YACJ,CAAC,CAAC,IAAI;QACR,KAAK,EAAE,UAAU,CAAC,OAAO;YACvB,CAAC,CAAC,OAAO,CAAC;gBACN,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,GAAG,aAAa,QAAQ;gBAC7B,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;aACpB,CAAC;YACJ,CAAC,CAAC,IAAI;QACR,MAAM,EACJ,UAAU,CAAC,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC;YACxD,CAAC,CAAC,OAAO,CAAC;gBACN,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,aAAa;gBAClB,IAAI,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE;aAC3B,CAAC;YACJ,CAAC,CAAC,IAAI;KACX,CAAC;AACJ,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,kBAAkB,CAAC,IAGlC;IACC,MAAM,KAAK,GAAsB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;IAEtD,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,cAAc,KAAK,CAAC,uBAAuB,EAAE,EAAE,CAAC;AACjG,CAAC"}

package/build/dist/Utils/DeveloperDocs/ExampleValues.js

@@ -0,0 +1,90 @@
+import { TerraformValueKind, } from "./TerraformSchema";
+/*
+ * What the Developer pages' examples share: where the API key comes from,
+ * and the example values a new resource is started from.
+ */
+/*
+ * The environment variable every example reads the API key from. It is the
+ * one the Terraform provider reads, so a single `export` serves the
+ * Terraform, API and AI pages alike, and no key is ever written into a
+ * command or a configuration.
+ */
+export const ONEUPTIME_API_KEY_ENVIRONMENT_VARIABLE = "ONEUPTIME_API_KEY";
+/*
+ * Product and technology names that keep their capital in a sentence:
+ * "Kubernetes cluster", not "kubernetes cluster".
+ */
+const PROPER_NOUNS = [
+    "Docker",
+    "Swarm",
+    "Kubernetes",
+    "Podman",
+    "Proxmox",
+    "Ceph",
+    "VMware",
+    "OneUptime",
+];
+// A word written the ordinary way: a capital, then lower case ("Policy", "On").
+const TITLE_CASE_WORD = /^[A-Z][a-z0-9']*$/;
+/*
+ * A resource's name for use inside a sentence: "Status Page" -> "status
+ * page", "On-Call Policy" -> "on-call policy", while acronyms and names keep
+ * their capitals: "AI insight", "SLOs", "IoT fleet", "Kubernetes cluster",
+ * "vCenter".
+ */
+export function toSentenceCaseName(name) {
+    return name
+        .split(" ")
+        .map((word) => {
+        return word
+            .split("-")
+            .map((part) => {
+            return TITLE_CASE_WORD.test(part) && !PROPER_NOUNS.includes(part)
+                ? part.toLowerCase()
+                : part;
+        })
+            .join("-");
+    })
+        .join(" ");
+}
+// `export ONEUPTIME_API_KEY="your-api-key"`.
+export function getApiKeyExportCommand() {
+    return `export ${ONEUPTIME_API_KEY_ENVIRONMENT_VARIABLE}="your-api-key"`;
+}
+/*
+ * An example value for a field a new resource must have: "My workflow" for
+ * its name, the field's default or documented example when it has one, and
+ * a placeholder to replace otherwise ("<incident severity id>").
+ */
+export function getExampleJsonValue(data) {
+    const { descriptor } = data;
+    if (data.isNameColumn) {
+        return `My ${toSentenceCaseName(data.singularName)}`;
+    }
+    if (descriptor.defaultValue !== undefined) {
+        return descriptor.defaultValue;
+    }
+    switch (descriptor.kind) {
+        case TerraformValueKind.Number:
+            return typeof descriptor.example === "number" ? descriptor.example : 1;
+        case TerraformValueKind.Bool:
+            return true;
+        case TerraformValueKind.DateTime:
+            return "2030-01-01T00:00:00.000Z";
+        case TerraformValueKind.IdSet:
+        case TerraformValueKind.StringSet:
+            return [];
+        case TerraformValueKind.Json:
+            return {};
+        default:
+            break;
+    }
+    if (descriptor.columnName.endsWith("Id")) {
+        return `<${descriptor.title.replace(/\s*ID$/i, "").toLowerCase()} id>`;
+    }
+    if (typeof descriptor.example === "string" && descriptor.example.length > 0) {
+        return descriptor.example;
+    }
+    return `<${descriptor.title.toLowerCase()}>`;
+}
+//# sourceMappingURL=ExampleValues.js.map

package/build/dist/Utils/DeveloperDocs/ExampleValues.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExampleValues.js","sourceRoot":"","sources":["../../../../Utils/DeveloperDocs/ExampleValues.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,kBAAkB,GACnB,MAAM,mBAAmB,CAAC;AAE3B;;;GAGG;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sCAAsC,GACjD,mBAAmB,CAAC;AAEtB;;;GAGG;AACH,MAAM,YAAY,GAA0B;IAC1C,QAAQ;IACR,OAAO;IACP,YAAY;IACZ,QAAQ;IACR,SAAS;IACT,MAAM;IACN,QAAQ;IACR,WAAW;CACZ,CAAC;AAEF,gFAAgF;AAChF,MAAM,eAAe,GAAW,mBAAmB,CAAC;AAEpD;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,OAAO,IAAI;SACR,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,IAAY,EAAU,EAAE;QAC5B,OAAO,IAAI;aACR,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,CAAC,IAAY,EAAU,EAAE;YAC5B,OAAO,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC/D,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE;gBACpB,CAAC,CAAC,IAAI,CAAC;QACX,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,CAAC,CAAC;IACf,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,sBAAsB;IACpC,OAAO,UAAU,sCAAsC,iBAAiB,CAAC;AAC3E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAInC;IACC,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IAE5B,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QACtB,OAAO,MAAM,kBAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;IACvD,CAAC;IAED,IAAI,UAAU,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,UAAU,CAAC,YAAY,CAAC;IACjC,CAAC;IAED,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;QACxB,KAAK,kBAAkB,CAAC,MAAM;YAC5B,OAAO,OAAO,UAAU,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACzE,KAAK,kBAAkB,CAAC,IAAI;YAC1B,OAAO,IAAI,CAAC;QACd,KAAK,kBAAkB,CAAC,QAAQ;YAC9B,OAAO,0BAA0B,CAAC;QACpC,KAAK,kBAAkB,CAAC,KAAK,CAAC;QAC9B,KAAK,kBAAkB,CAAC,SAAS;YAC/B,OAAO,EAAE,CAAC;QACZ,KAAK,kBAAkB,CAAC,IAAI;YAC1B,OAAO,EAAE,CAAC;QACZ;YACE,MAAM;IACV,CAAC;IAED,IAAI,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACzC,OAAO,IAAI,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,MAAM,CAAC;IACzE,CAAC;IAED,IAAI,OAAO,UAAU,CAAC,OAAO,KAAK,QAAQ,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5E,OAAO,UAAU,CAAC,OAAO,CAAC;IAC5B,CAAC;IAED,OAAO,IAAI,UAAU,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC;AAC/C,CAAC"}