runline 0.33.0 → 0.34.0

package/dist/plugins/shiftWork/src/projects.js

@@ -1,5 +1,5 @@
 import * as t from "typebox";
-import { cursorSchema, enumSchema, idSchema, listParams, PROJECT_STATUS, pathSegment, request, STRICT_OBJECT, STRICT_UPDATE_OBJECT, timestampSchema, } from "./shared.js";
+import { cursorSchema, enumSchema, idSchema, PROJECT_STATUS, pathSegment, request, STRICT_OBJECT, STRICT_UPDATE_OBJECT, timestampSchema, } from "./shared.js";
 const projectListFields = {
     status: t.Optional(enumSchema("Project status", PROJECT_STATUS)),
     leadUserId: t.Optional(idSchema("Lead user ID")),
@@ -13,7 +13,7 @@ export function registerProjectActions(rl) {
         description: "List the first page of concrete Shift Labs Projects.",
         inputSchema: t.Object(projectListFields, STRICT_OBJECT),
         async execute(input, ctx) {
-            const body = await request(ctx, `/v1/projects?${listParams(input)}`);
+            const body = await request(ctx, "/v1/projects", { query: input });
             return body.projects;
         },
     });
@@ -22,7 +22,7 @@ export function registerProjectActions(rl) {
         description: "List a cursor-paginated page of concrete Projects.",
         inputSchema: t.Object(projectListFields, STRICT_OBJECT),
         async execute(input, ctx) {
-            return request(ctx, `/v1/projects?${listParams(input)}`);
+            return request(ctx, "/v1/projects", { query: input });
         },
     });
     rl.registerAction("project.get", {

package/dist/plugins/shiftWork/src/shared.js

@@ -1,4 +1,6 @@
-export { cursorSchema, enumDescription, enumSchema, idSchema, listParams, pathSegment, request, STRICT_OBJECT, STRICT_UPDATE_OBJECT, timestampSchema, withQuery, } from "../../_shared/shiftCloud.js";
+import { shiftClient } from "../../_shared/shiftCredentials.js";
+export { cursorSchema, enumDescription, enumSchema, idSchema, pathSegment, STRICT_OBJECT, STRICT_UPDATE_OBJECT, timestampSchema, } from "../../_shared/shiftCloud.js";
+export const { credential: shiftWorkCredential, request } = shiftClient("shiftWork");
 export const ISSUE_STATUS = [
     "backlog",
     "todo",

package/dist/plugins/shopify/src/credentials.js

@@ -0,0 +1,16 @@
+import { hostLabel, staticCredential } from "../../_shared/credentials.js";
+/**
+ * An Admin API access token, sent as the X-Shopify-Access-Token header to
+ * the store's own myshopify.com host beneath /admin/api/2024-07/.
+ */
+export const shopifyCredential = staticCredential({
+    id: "shopify",
+    auth: { kind: "apiKey", header: "X-Shopify-Access-Token" },
+    local: { secret: "accessToken" },
+    targets: (config) => ({
+        api: {
+            baseUrl: `https://${hostLabel(config.shopSubdomain)}.myshopify.com/admin/api/2024-07/`,
+            methods: ["GET", "POST", "PUT", "DELETE"],
+        },
+    }),
+});

package/dist/plugins/shopify/src/index.js

@@ -1,64 +1,39 @@
-function getConn(ctx) {
-    const c = ctx.connection.config;
-    const subdomain = c.shopSubdomain;
-    const base = `https://${subdomain}.myshopify.com/admin/api/2024-07`;
-    return { base, accessToken: c.accessToken };
-}
-async function apiRequest(conn, method, endpoint, body, qs) {
-    const url = new URL(`${conn.base}${endpoint}`);
-    if (qs) {
-        for (const [k, v] of Object.entries(qs)) {
-            if (v !== undefined && v !== null)
-                url.searchParams.set(k, String(v));
-        }
-    }
-    const init = {
+import { credentialJson, credentialOk, jsonAnswer, pathSegment, pathWithin, } from "../../_shared/credentials.js";
+import { shopifyCredential } from "./credentials.js";
+function apiRequest(ctx, method, path, body, qs) {
+    return credentialJson(ctx, shopifyCredential, "shopify", {
+        target: "api",
+        path,
         method,
-        headers: {
-            "X-Shopify-Access-Token": conn.accessToken,
-            "Content-Type": "application/json",
-        },
-    };
-    if (body !== undefined)
-        init.body = JSON.stringify(body);
-    const res = await fetch(url.toString(), init);
-    if (!res.ok)
-        throw new Error(`Shopify error ${res.status}: ${await res.text()}`);
-    const text = await res.text();
-    return text ? JSON.parse(text) : {};
+        query: qs,
+        ...(body !== undefined ? { json: body } : {}),
+    });
 }
-async function paginate(conn, propertyName, endpoint, qs = {}) {
+async function paginate(ctx, propertyName, path, qs = {}) {
     const all = [];
-    let nextUrl;
+    let nextPath;
     do {
-        const url = nextUrl ?? `${conn.base}${endpoint}`;
-        const u = new URL(url);
-        if (!nextUrl && qs) {
-            for (const [k, v] of Object.entries(qs)) {
-                if (v !== undefined && v !== null)
-                    u.searchParams.set(k, String(v));
-            }
-        }
-        const res = await fetch(u.toString(), {
-            headers: { "X-Shopify-Access-Token": conn.accessToken },
+        const res = await credentialOk(ctx, shopifyCredential, "shopify", {
+            target: "api",
+            path: nextPath ?? path,
+            ...(nextPath === undefined ? { query: qs } : {}),
         });
-        if (!res.ok)
-            throw new Error(`Shopify error ${res.status}: ${await res.text()}`);
-        const data = (await res.json());
+        const data = (await jsonAnswer(res));
         all.push(...(data[propertyName] ?? []));
-        nextUrl = undefined;
+        nextPath = undefined;
         const link = res.headers.get("link") ?? "";
         if (link.includes('rel="next"')) {
             const match = link.match(/<([^>]+)>;\s*rel="next"/);
             if (match)
-                nextUrl = match[1];
+                nextPath = pathWithin(ctx, shopifyCredential, "api", match[1]);
         }
-    } while (nextUrl);
+    } while (nextPath);
     return all;
 }
 export default function shopify(rl) {
     rl.setName("shopify");
     rl.setVersion("0.1.0");
+    rl.setCredential(shopifyCredential);
     rl.setConnectionSchema({
         shopSubdomain: {
             type: "string",
@@ -104,7 +79,7 @@ export default function shopify(rl) {
                 order.note = p.note;
             if (p.tags)
                 order.tags = p.tags;
-            const data = (await apiRequest(getConn(ctx), "POST", "/orders.json", {
+            const data = (await apiRequest(ctx, "POST", "orders.json", {
                 order,
             }));
             return data.order;
@@ -122,7 +97,7 @@ export default function shopify(rl) {
             const qs = {};
             if (p.fields)
                 qs.fields = p.fields;
-            const data = (await apiRequest(getConn(ctx), "GET", `/orders/${p.orderId}.json`, undefined, qs));
+            const data = (await apiRequest(ctx, "GET", `orders/${pathSegment(p.orderId)}.json`, undefined, qs));
             return data.order;
         },
     });
@@ -141,7 +116,6 @@ export default function shopify(rl) {
         },
         async execute(input, ctx) {
             const p = (input ?? {});
-            const conn = getConn(ctx);
             const qs = {};
             if (p.status)
                 qs.status = p.status;
@@ -151,10 +125,10 @@ export default function shopify(rl) {
                 qs.created_at_max = p.createdAtMax;
             if (p.limit) {
                 qs.limit = p.limit;
-                const d = (await apiRequest(conn, "GET", "/orders.json", undefined, qs));
+                const d = (await apiRequest(ctx, "GET", "orders.json", undefined, qs));
                 return d.orders;
             }
-            return paginate(conn, "orders", "/orders.json", qs);
+            return paginate(ctx, "orders", "orders.json", qs);
         },
     });
     rl.registerAction("order.update", {
@@ -175,7 +149,7 @@ export default function shopify(rl) {
                 order.tags = p.tags;
             if (p.email)
                 order.email = p.email;
-            const data = (await apiRequest(getConn(ctx), "PUT", `/orders/${p.orderId}.json`, { order }));
+            const data = (await apiRequest(ctx, "PUT", `orders/${pathSegment(p.orderId)}.json`, { order }));
             return data.order;
         },
     });
@@ -184,7 +158,7 @@ export default function shopify(rl) {
         description: "Delete an order",
         inputSchema: { orderId: { type: "string", required: true } },
         async execute(input, ctx) {
-            await apiRequest(getConn(ctx), "DELETE", `/orders/${input.orderId}.json`);
+            await apiRequest(ctx, "DELETE", `orders/${pathSegment(input.orderId)}.json`);
             return { success: true };
         },
     });
@@ -201,7 +175,7 @@ export default function shopify(rl) {
         },
         async execute(input, ctx) {
             const p = input;
-            const data = (await apiRequest(getConn(ctx), "POST", "/products.json", {
+            const data = (await apiRequest(ctx, "POST", "products.json", {
                 product: p,
             }));
             return data.product;
@@ -219,7 +193,7 @@ export default function shopify(rl) {
             const qs = {};
             if (p.fields)
                 qs.fields = p.fields;
-            const data = (await apiRequest(getConn(ctx), "GET", `/products/${p.productId}.json`, undefined, qs));
+            const data = (await apiRequest(ctx, "GET", `products/${pathSegment(p.productId)}.json`, undefined, qs));
             return data.product;
         },
     });
@@ -232,16 +206,15 @@ export default function shopify(rl) {
         },
         async execute(input, ctx) {
             const p = (input ?? {});
-            const conn = getConn(ctx);
             const qs = {};
             if (p.title)
                 qs.title = p.title;
             if (p.limit) {
                 qs.limit = p.limit;
-                const d = (await apiRequest(conn, "GET", "/products.json", undefined, qs));
+                const d = (await apiRequest(ctx, "GET", "products.json", undefined, qs));
                 return d.products;
             }
-            return paginate(conn, "products", "/products.json", qs);
+            return paginate(ctx, "products", "products.json", qs);
         },
     });
     rl.registerAction("product.update", {
@@ -257,7 +230,7 @@ export default function shopify(rl) {
         async execute(input, ctx) {
             const p = input;
             const { productId, ...fields } = p;
-            const data = (await apiRequest(getConn(ctx), "PUT", `/products/${productId}.json`, { product: fields }));
+            const data = (await apiRequest(ctx, "PUT", `products/${pathSegment(productId)}.json`, { product: fields }));
             return data.product;
         },
     });
@@ -266,7 +239,7 @@ export default function shopify(rl) {
         description: "Delete a product",
         inputSchema: { productId: { type: "string", required: true } },
         async execute(input, ctx) {
-            await apiRequest(getConn(ctx), "DELETE", `/products/${input.productId}.json`);
+            await apiRequest(ctx, "DELETE", `products/${pathSegment(input.productId)}.json`);
             return { success: true };
         },
     });

package/dist/plugins/signl4/src/credentials.js

@@ -0,0 +1,17 @@
+import { staticCredential } from "../../_shared/credentials.js";
+/** The team secret, which SIGNL4 takes as the webhook's path segment. */
+export const signl4Credential = staticCredential({
+    id: "signl4",
+    auth: {
+        kind: "static",
+        parts: ["teamSecret"],
+        placements: [{ in: "path", part: "teamSecret" }],
+    },
+    local: { teamSecret: "teamSecret" },
+    targets: {
+        webhook: {
+            baseUrl: "https://connect.signl4.com/webhook/",
+            methods: ["POST"],
+        },
+    },
+});

package/dist/plugins/signl4/src/index.js

@@ -1,6 +1,18 @@
+import { credentialJson } from "../../_shared/credentials.js";
+import { signl4Credential } from "./credentials.js";
+/** One alert event, posted as a form to the team's webhook. */
+function send(ctx, form) {
+    return credentialJson(ctx, signl4Credential, "signl4", {
+        target: "webhook",
+        path: "",
+        method: "POST",
+        form: { ...form, "X-S4-SourceSystem": "runline" },
+    });
+}
 export default function signl4(rl) {
     rl.setName("signl4");
     rl.setVersion("0.1.0");
+    rl.setCredential(signl4Credential);
     rl.setConnectionSchema({
         teamSecret: {
             type: "string",
@@ -9,7 +21,6 @@ export default function signl4(rl) {
             env: "SIGNL4_TEAM_SECRET",
         },
     });
-    const url = (ctx) => `https://connect.signl4.com/webhook/${ctx.connection.config.teamSecret}`;
     rl.registerAction("alert.send", {
         access: "write",
         description: "Send a SIGNL4 alert",
@@ -33,26 +44,18 @@ export default function signl4(rl) {
         },
         async execute(input, ctx) {
             const p = (input ?? {});
-            const form = new URLSearchParams();
-            form.set("message", p.message);
-            form.set("X-S4-Status", "new");
-            form.set("X-S4-SourceSystem", "runline");
-            if (p.title)
-                form.set("title", p.title);
-            if (p.service)
-                form.set("service", p.service);
-            if (p.externalId)
-                form.set("X-S4-ExternalID", p.externalId);
-            if (p.alertingScenario)
-                form.set("X-S4-AlertingScenario", p.alertingScenario);
-            if (p.latitude && p.longitude)
-                form.set("X-S4-Location", `${p.latitude},${p.longitude}`);
-            if (p.filtering !== undefined)
-                form.set("X-S4-Filtering", String(p.filtering));
-            const res = await fetch(url(ctx), { method: "POST", body: form });
-            if (!res.ok)
-                throw new Error(`SIGNL4 error ${res.status}: ${await res.text()}`);
-            return res.json();
+            return send(ctx, {
+                message: p.message,
+                "X-S4-Status": "new",
+                title: p.title || undefined,
+                service: p.service || undefined,
+                "X-S4-ExternalID": p.externalId || undefined,
+                "X-S4-AlertingScenario": p.alertingScenario || undefined,
+                "X-S4-Location": p.latitude && p.longitude
+                    ? `${p.latitude},${p.longitude}`
+                    : undefined,
+                "X-S4-Filtering": p.filtering,
+            });
         },
     });
     rl.registerAction("alert.resolve", {
@@ -63,14 +66,10 @@ export default function signl4(rl) {
         },
         async execute(input, ctx) {
             const { externalId } = input;
-            const form = new URLSearchParams();
-            form.set("X-S4-ExternalID", externalId);
-            form.set("X-S4-Status", "resolved");
-            form.set("X-S4-SourceSystem", "runline");
-            const res = await fetch(url(ctx), { method: "POST", body: form });
-            if (!res.ok)
-                throw new Error(`SIGNL4 error ${res.status}: ${await res.text()}`);
-            return res.json();
+            return send(ctx, {
+                "X-S4-ExternalID": externalId,
+                "X-S4-Status": "resolved",
+            });
         },
     });
 }

package/dist/plugins/slack/src/credentials.js

@@ -0,0 +1,19 @@
+import { staticCredential } from "../../_shared/credentials.js";
+/** A bot or user token, sent as a bearer to Slack's one API origin. */
+export const slackCredential = staticCredential({
+    id: "slack",
+    auth: { kind: "bearer" },
+    local: { secret: "accessToken" },
+    targets: {
+        api: {
+            baseUrl: "https://slack.com/api/",
+            methods: ["GET", "POST"],
+        },
+    },
+    probe: {
+        target: "api",
+        path: "auth.test",
+        method: "GET",
+        acceptedStatuses: [200],
+    },
+});