runline 0.33.0 → 0.35.0

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

@@ -1,24 +1,18 @@
-function getConn(ctx) {
-    const c = ctx.connection.config;
-    return { authId: c.authId, authToken: c.authToken };
-}
-async function apiRequest(conn, method, endpoint, body) {
-    const url = `https://api.plivo.com/v1/Account/${conn.authId}${endpoint}/`;
-    const res = await fetch(url, {
-        method,
-        headers: {
-            Authorization: "Basic " + btoa(`${conn.authId}:${conn.authToken}`),
-            "Content-Type": "application/json",
-        },
-        body: JSON.stringify(body),
+import { credentialJson } from "../../_shared/credentials.js";
+import { plivoCredential } from "./credentials.js";
+/** A Plivo JSON call beneath the account; Plivo's resource paths end in /. */
+function apiRequest(ctx, resource, body) {
+    return credentialJson(ctx, plivoCredential, "plivo", {
+        target: "api",
+        path: `${resource}/`,
+        method: "POST",
+        json: body,
     });
-    if (!res.ok)
-        throw new Error(`Plivo error ${res.status}: ${await res.text()}`);
-    return res.json();
 }
 export default function plivo(rl) {
     rl.setName("plivo");
     rl.setVersion("0.1.0");
+    rl.setCredential(plivoCredential);
     rl.setConnectionSchema({
         authId: {
             type: "string",
@@ -43,7 +37,7 @@ export default function plivo(rl) {
         },
         async execute(input, ctx) {
             const { from, to, message } = input;
-            return apiRequest(getConn(ctx), "POST", "/Message", {
+            return apiRequest(ctx, "Message", {
                 src: from,
                 dst: to,
                 text: message,
@@ -65,7 +59,7 @@ export default function plivo(rl) {
         },
         async execute(input, ctx) {
             const { from, to, message, mediaUrls } = input;
-            return apiRequest(getConn(ctx), "POST", "/Message", {
+            return apiRequest(ctx, "Message", {
                 src: from,
                 dst: to,
                 text: message,
@@ -93,7 +87,7 @@ export default function plivo(rl) {
         },
         async execute(input, ctx) {
             const { from, to, answerUrl, answerMethod } = input;
-            return apiRequest(getConn(ctx), "POST", "/Call", {
+            return apiRequest(ctx, "Call", {
                 from,
                 to,
                 answer_url: answerUrl,

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

@@ -0,0 +1,18 @@
+import { httpsBase, staticCredential } from "../../_shared/credentials.js";
+/**
+ * A project API key, added by the transport as the api_key field of every
+ * JSON capture call, on the connection's own PostHog instance. The
+ * instance URL is public config and must be HTTPS.
+ */
+export const posthogCredential = staticCredential({
+    id: "posthog",
+    auth: {
+        kind: "static",
+        parts: ["key"],
+        placements: [{ in: "body", part: "key", name: "api_key" }],
+    },
+    local: { key: "apiKey" },
+    targets: (config) => ({
+        api: { baseUrl: httpsBase(config.url, ""), methods: ["POST"] },
+    }),
+});

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

@@ -1,24 +1,18 @@
-function getConn(ctx) {
-    const c = ctx.connection.config;
-    return {
-        url: c.url.replace(/\/$/, ""),
-        apiKey: c.apiKey,
-    };
-}
-async function apiRequest(conn, endpoint, body) {
-    body.api_key = conn.apiKey;
-    const res = await fetch(`${conn.url}${endpoint}`, {
+import { credentialJson } from "../../_shared/credentials.js";
+import { posthogCredential } from "./credentials.js";
+/** Every PostHog capture call is a JSON POST. */
+function apiRequest(ctx, endpoint, body) {
+    return credentialJson(ctx, posthogCredential, "posthog", {
+        target: "api",
+        path: endpoint,
         method: "POST",
-        headers: { "Content-Type": "application/json" },
-        body: JSON.stringify(body),
+        json: body,
     });
-    if (!res.ok)
-        throw new Error(`PostHog error ${res.status}: ${await res.text()}`);
-    return res.json();
 }
 export default function posthog(rl) {
     rl.setName("posthog");
     rl.setVersion("0.1.0");
+    rl.setCredential(posthogCredential);
     rl.setConnectionSchema({
         url: {
             type: "string",
@@ -60,7 +54,7 @@ export default function posthog(rl) {
             };
             if (p.timestamp)
                 body.timestamp = p.timestamp;
-            return apiRequest(getConn(ctx), "/batch", body);
+            return apiRequest(ctx, "batch", body);
         },
     });
     rl.registerAction("event.create", {
@@ -75,7 +69,7 @@ export default function posthog(rl) {
         },
         async execute(input, ctx) {
             const { events } = input;
-            return apiRequest(getConn(ctx), "/capture", { batch: events });
+            return apiRequest(ctx, "capture", { batch: events });
         },
     });
     rl.registerAction("identity.create", {
@@ -99,7 +93,7 @@ export default function posthog(rl) {
             };
             if (p.timestamp)
                 body.timestamp = p.timestamp;
-            return apiRequest(getConn(ctx), "/batch", body);
+            return apiRequest(ctx, "batch", body);
         },
     });
     rl.registerAction("track.page", {
@@ -124,7 +118,7 @@ export default function posthog(rl) {
             };
             if (p.timestamp)
                 body.timestamp = p.timestamp;
-            return apiRequest(getConn(ctx), "/batch", body);
+            return apiRequest(ctx, "batch", body);
         },
     });
     rl.registerAction("track.screen", {
@@ -149,7 +143,7 @@ export default function posthog(rl) {
             };
             if (p.timestamp)
                 body.timestamp = p.timestamp;
-            return apiRequest(getConn(ctx), "/batch", body);
+            return apiRequest(ctx, "batch", body);
         },
     });
 }

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

@@ -0,0 +1,22 @@
+import { staticCredential } from "../../_shared/credentials.js";
+/**
+ * An API access token, sent raw in the Authorization header (no scheme)
+ * to ProfitWell's one API origin beneath /v2/.
+ */
+export const profitwellCredential = staticCredential({
+    id: "profitwell",
+    auth: { kind: "apiKey", header: "Authorization" },
+    local: { secret: "accessToken" },
+    targets: {
+        api: {
+            baseUrl: "https://api.profitwell.com/v2/",
+            methods: ["GET"],
+        },
+    },
+    probe: {
+        target: "api",
+        path: "company/settings/",
+        method: "GET",
+        acceptedStatuses: [200],
+    },
+});

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

@@ -1,22 +1,16 @@
-const BASE = "https://api.profitwell.com/v2";
-async function apiRequest(token, endpoint, qs) {
-    const url = new URL(`${BASE}${endpoint}`);
-    if (qs) {
-        for (const [k, v] of Object.entries(qs)) {
-            if (v !== undefined && v !== null)
-                url.searchParams.set(k, String(v));
-        }
-    }
-    const res = await fetch(url.toString(), {
-        headers: { Authorization: token },
+import { credentialJson, pathSegment } from "../../_shared/credentials.js";
+import { profitwellCredential } from "./credentials.js";
+function apiRequest(ctx, path, qs) {
+    return credentialJson(ctx, profitwellCredential, "profitwell", {
+        target: "api",
+        path,
+        query: qs,
     });
-    if (!res.ok)
-        throw new Error(`ProfitWell error ${res.status}: ${await res.text()}`);
-    return res.json();
 }
 export default function profitwell(rl) {
     rl.setName("profitwell");
     rl.setVersion("0.1.0");
+    rl.setCredential(profitwellCredential);
     rl.setConnectionSchema({
         accessToken: {
             type: "string",
@@ -25,13 +19,12 @@ export default function profitwell(rl) {
             env: "PROFITWELL_ACCESS_TOKEN",
         },
     });
-    const key = (ctx) => ctx.connection.config.accessToken;
     rl.registerAction("company.getSettings", {
         access: "read",
         description: "Get company settings",
         inputSchema: {},
         async execute(_input, ctx) {
-            return apiRequest(key(ctx), "/company/settings/");
+            return apiRequest(ctx, "company/settings/");
         },
     });
     rl.registerAction("metric.get", {
@@ -64,7 +57,7 @@ export default function profitwell(rl) {
                 qs.metrics = p.metrics;
             if (p.planId)
                 qs.plan_id = p.planId;
-            const data = (await apiRequest(key(ctx), `/metrics/${p.type}`, qs));
+            const data = (await apiRequest(ctx, `metrics/${pathSegment(p.type)}`, qs));
             return data.data;
         },
     });

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

@@ -0,0 +1,19 @@
+import { staticCredential } from "../../_shared/credentials.js";
+/** An access token in the Access-Token header, to Pushbullet's one API origin. */
+export const pushbulletCredential = staticCredential({
+    id: "pushbullet",
+    auth: { kind: "apiKey", header: "Access-Token" },
+    local: { secret: "accessToken" },
+    targets: {
+        api: {
+            baseUrl: "https://api.pushbullet.com/v2/",
+            methods: ["GET", "POST", "DELETE"],
+        },
+    },
+    probe: {
+        target: "api",
+        path: "users/me",
+        method: "GET",
+        acceptedStatuses: [200],
+    },
+});

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

@@ -1,31 +1,21 @@
-const BASE = "https://api.pushbullet.com/v2";
-async function apiRequest(token, method, path, body, qs) {
-    const url = new URL(`${BASE}${path}`);
-    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, pathSegment } from "../../_shared/credentials.js";
+import { pushbulletCredential } from "./credentials.js";
+function apiRequest(ctx, method, path, body, qs) {
+    return credentialJson(ctx, pushbulletCredential, "pushbullet", {
+        target: "api",
+        path: path.replace(/^\//, ""),
         method,
-        headers: { "Access-Token": token, "Content-Type": "application/json" },
-    };
-    if (body && Object.keys(body).length > 0)
-        init.body = JSON.stringify(body);
-    const res = await fetch(url.toString(), init);
-    if (!res.ok)
-        throw new Error(`Pushbullet error ${res.status}: ${await res.text()}`);
-    const text = await res.text();
-    return text ? JSON.parse(text) : {};
+        query: qs,
+        ...(body && Object.keys(body).length > 0 ? { json: body } : {}),
+    });
 }
-async function paginate(token, path, qs = {}) {
+async function paginate(ctx, path, qs = {}) {
     const all = [];
     let cursor;
     do {
         if (cursor)
             qs.cursor = cursor;
-        const data = (await apiRequest(token, "GET", path, undefined, qs));
+        const data = (await apiRequest(ctx, "GET", path, undefined, qs));
         const items = (data.pushes ?? []);
         all.push(...items);
         cursor = data.cursor;
@@ -35,6 +25,7 @@ async function paginate(token, path, qs = {}) {
 export default function pushbullet(rl) {
     rl.setName("pushbullet");
     rl.setVersion("0.1.0");
+    rl.setCredential(pushbulletCredential);
     rl.setConnectionSchema({
         accessToken: {
             type: "string",
@@ -43,7 +34,6 @@ export default function pushbullet(rl) {
             env: "PUSHBULLET_ACCESS_TOKEN",
         },
     });
-    const key = (ctx) => ctx.connection.config.accessToken;
     rl.registerAction("push.create", {
         access: "write",
         description: "Create a push (note or link)",
@@ -79,7 +69,7 @@ export default function pushbullet(rl) {
             const target = p.target ?? "default";
             if (target !== "default" && p.targetValue)
                 reqBody[target] = p.targetValue;
-            return apiRequest(key(ctx), "POST", "/pushes", reqBody);
+            return apiRequest(ctx, "POST", "/pushes", reqBody);
         },
     });
     rl.registerAction("push.list", {
@@ -107,10 +97,10 @@ export default function pushbullet(rl) {
                 qs.modified_after = String(Math.floor(new Date(p.modifiedAfter).getTime() / 1000));
             if (p.limit) {
                 qs.limit = p.limit;
-                const d = (await apiRequest(key(ctx), "GET", "/pushes", undefined, qs));
+                const d = (await apiRequest(ctx, "GET", "/pushes", undefined, qs));
                 return d.pushes;
             }
-            return paginate(key(ctx), "/pushes", qs);
+            return paginate(ctx, "/pushes", qs);
         },
     });
     rl.registerAction("push.delete", {
@@ -119,7 +109,7 @@ export default function pushbullet(rl) {
         inputSchema: { pushId: { type: "string", required: true } },
         async execute(input, ctx) {
             const { pushId } = input;
-            await apiRequest(key(ctx), "DELETE", `/pushes/${pushId}`);
+            await apiRequest(ctx, "DELETE", `/pushes/${pathSegment(pushId)}`);
             return { success: true };
         },
     });
@@ -136,7 +126,9 @@ export default function pushbullet(rl) {
         },
         async execute(input, ctx) {
             const { pushId, dismissed } = input;
-            return apiRequest(key(ctx), "POST", `/pushes/${pushId}`, { dismissed });
+            return apiRequest(ctx, "POST", `/pushes/${pathSegment(pushId)}`, {
+                dismissed,
+            });
         },
     });
 }

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

@@ -0,0 +1,19 @@
+import { staticCredential } from "../../_shared/credentials.js";
+/** An API key in the API-Key header, to Pushcut's one API origin. */
+export const pushcutCredential = staticCredential({
+    id: "pushcut",
+    auth: { kind: "apiKey", header: "API-Key" },
+    local: { secret: "apiKey" },
+    targets: {
+        api: {
+            baseUrl: "https://api.pushcut.io/v1/",
+            methods: ["GET", "POST"],
+        },
+    },
+    probe: {
+        target: "api",
+        path: "devices",
+        method: "GET",
+        acceptedStatuses: [200],
+    },
+});

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

@@ -1,7 +1,9 @@
-const BASE = "https://api.pushcut.io/v1";
+import { credentialJson, pathSegment } from "../../_shared/credentials.js";
+import { pushcutCredential } from "./credentials.js";
 export default function pushcut(rl) {
     rl.setName("pushcut");
     rl.setVersion("0.1.0");
+    rl.setCredential(pushcutCredential);
     rl.setConnectionSchema({
         apiKey: {
             type: "string",
@@ -10,7 +12,6 @@ export default function pushcut(rl) {
             env: "PUSHCUT_API_KEY",
         },
     });
-    const key = (ctx) => ctx.connection.config.apiKey;
     rl.registerAction("notification.send", {
         access: "write",
         description: "Send a Pushcut notification",
@@ -52,14 +53,12 @@ export default function pushcut(rl) {
                 body.input = p.input;
             if (p.devices)
                 body.devices = p.devices;
-            const res = await fetch(`${BASE}/notifications/${encodeURIComponent(p.notificationName)}`, {
+            return credentialJson(ctx, pushcutCredential, "pushcut", {
+                target: "api",
+                path: `notifications/${pathSegment(p.notificationName)}`,
                 method: "POST",
-                headers: { "API-Key": key(ctx), "Content-Type": "application/json" },
-                body: JSON.stringify(body),
+                json: body,
             });
-            if (!res.ok)
-                throw new Error(`Pushcut error ${res.status}: ${await res.text()}`);
-            return res.json();
         },
     });
 }

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

@@ -0,0 +1,14 @@
+import { staticCredential } from "../../_shared/credentials.js";
+/** An application token, added by the transport as the token field of Pushover's form body. */
+export const pushoverCredential = staticCredential({
+    id: "pushover",
+    auth: {
+        kind: "static",
+        parts: ["token"],
+        placements: [{ in: "body", part: "token", name: "token" }],
+    },
+    local: { token: "apiToken" },
+    targets: {
+        api: { baseUrl: "https://api.pushover.net/1/", methods: ["POST"] },
+    },
+});

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

@@ -1,7 +1,9 @@
-const BASE = "https://api.pushover.net/1";
+import { credentialJson } from "../../_shared/credentials.js";
+import { pushoverCredential } from "./credentials.js";
 export default function pushover(rl) {
     rl.setName("pushover");
     rl.setVersion("0.1.0");
+    rl.setCredential(pushoverCredential);
     rl.setConnectionSchema({
         apiToken: {
             type: "string",
@@ -10,7 +12,6 @@ export default function pushover(rl) {
             env: "PUSHOVER_API_TOKEN",
         },
     });
-    const token = (ctx) => ctx.connection.config.apiToken;
     rl.registerAction("message.push", {
         access: "write",
         description: "Send a push notification via Pushover",
@@ -67,7 +68,6 @@ export default function pushover(rl) {
         async execute(input, ctx) {
             const p = input;
             const body = {
-                token: token(ctx),
                 user: p.userKey,
                 message: p.message,
             };
@@ -91,17 +91,12 @@ export default function pushover(rl) {
                 body.expire = p.expire;
             if (p.ttl)
                 body.ttl = p.ttl;
-            const formBody = Object.entries(body)
-                .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`)
-                .join("&");
-            const res = await fetch(`${BASE}/messages.json`, {
+            return credentialJson(ctx, pushoverCredential, "pushover", {
+                target: "api",
+                path: "messages.json",
                 method: "POST",
-                headers: { "Content-Type": "application/x-www-form-urlencoded" },
-                body: formBody,
+                form: body,
             });
-            if (!res.ok)
-                throw new Error(`Pushover error ${res.status}: ${await res.text()}`);
-            return res.json();
         },
     });
 }

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

@@ -0,0 +1,15 @@
+import { staticCredential } from "../../_shared/credentials.js";
+/** A user token, sent as "QB-USER-TOKEN {token}" in Authorization, to QuickBase's
+ *  one API origin. The realm hostname rides along as a public caller header. */
+export const quickbaseCredential = staticCredential({
+    id: "quickbase",
+    auth: { kind: "apiKey", header: "Authorization", prefix: "QB-USER-TOKEN " },
+    local: { secret: "userToken" },
+    targets: {
+        api: {
+            baseUrl: "https://api.quickbase.com/v1/",
+            methods: ["GET", "POST", "DELETE"],
+            allowedHeaders: ["QB-Realm-Hostname"],
+        },
+    },
+});

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

@@ -1,35 +1,21 @@
-const BASE = "https://api.quickbase.com/v1";
-function getConn(ctx) {
-    const c = ctx.connection.config;
-    return { hostname: c.hostname, userToken: c.userToken };
-}
-async function apiRequest(conn, method, endpoint, body, qs) {
-    const url = new URL(`${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, pathSegment } from "../../_shared/credentials.js";
+import { quickbaseCredential } from "./credentials.js";
+function apiRequest(ctx, method, endpoint, body, qs) {
+    return credentialJson(ctx, quickbaseCredential, "quickbase", {
+        target: "api",
+        path: endpoint,
         method,
+        query: qs,
         headers: {
-            "QB-Realm-Hostname": conn.hostname,
-            Authorization: `QB-USER-TOKEN ${conn.userToken}`,
-            "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(`QuickBase error ${res.status}: ${await res.text()}`);
-    const text = await res.text();
-    return text ? JSON.parse(text) : {};
+            "QB-Realm-Hostname": String(ctx.connection.config.hostname ?? ""),
+        },
+        ...(body !== undefined ? { json: body } : {}),
+    });
 }
 export default function quickbase(rl) {
     rl.setName("quickbase");
     rl.setVersion("0.1.0");
+    rl.setCredential(quickbaseCredential);
     rl.setConnectionSchema({
         hostname: {
             type: "string",
@@ -53,7 +39,9 @@ export default function quickbase(rl) {
         },
         async execute(input, ctx) {
             const p = input;
-            const data = (await apiRequest(getConn(ctx), "GET", "/fields", undefined, { tableId: p.tableId }));
+            const data = (await apiRequest(ctx, "GET", "fields", undefined, {
+                tableId: p.tableId,
+            }));
             if (p.limit)
                 return data.slice(0, p.limit);
             return data;
@@ -70,7 +58,7 @@ export default function quickbase(rl) {
         },
         async execute(input, ctx) {
             const { tableId, recordId, fieldId, versionNumber } = input;
-            return apiRequest(getConn(ctx), "DELETE", `/files/${tableId}/${recordId}/${fieldId}/${versionNumber}`);
+            return apiRequest(ctx, "DELETE", `files/${pathSegment(tableId)}/${pathSegment(recordId)}/${pathSegment(fieldId)}/${pathSegment(versionNumber)}`);
         },
     });
     rl.registerAction("record.create", {
@@ -93,7 +81,7 @@ export default function quickbase(rl) {
             const p = input;
             const body = { to: p.tableId, data: p.data };
             body.fieldsToReturn = p.fieldsToReturn ?? [3];
-            return apiRequest(getConn(ctx), "POST", "/records", body);
+            return apiRequest(ctx, "POST", "records", body);
         },
     });
     rl.registerAction("record.delete", {
@@ -109,7 +97,7 @@ export default function quickbase(rl) {
         },
         async execute(input, ctx) {
             const { tableId, where } = input;
-            return apiRequest(getConn(ctx), "DELETE", "/records", {
+            return apiRequest(ctx, "DELETE", "records", {
                 from: tableId,
                 where,
             });
@@ -148,7 +136,7 @@ export default function quickbase(rl) {
                 body.sortBy = p.sortBy;
             if (p.limit)
                 body.options = { top: p.limit };
-            return apiRequest(getConn(ctx), "POST", "/records/query", body);
+            return apiRequest(ctx, "POST", "records/query", body);
         },
     });
     rl.registerAction("record.upsert", {
@@ -180,7 +168,7 @@ export default function quickbase(rl) {
                 mergeFieldId: p.mergeFieldId,
             };
             body.fieldsToReturn = p.fieldsToReturn ?? [3];
-            return apiRequest(getConn(ctx), "POST", "/records", body);
+            return apiRequest(ctx, "POST", "records", body);
         },
     });
     rl.registerAction("report.get", {
@@ -192,7 +180,9 @@ export default function quickbase(rl) {
         },
         async execute(input, ctx) {
             const { tableId, reportId } = input;
-            return apiRequest(getConn(ctx), "GET", `/reports/${reportId}`, undefined, { tableId });
+            return apiRequest(ctx, "GET", `reports/${pathSegment(reportId)}`, undefined, {
+                tableId,
+            });
         },
     });
     rl.registerAction("report.run", {
@@ -208,7 +198,7 @@ export default function quickbase(rl) {
             const qs = { tableId: p.tableId };
             if (p.limit)
                 qs.top = p.limit;
-            return apiRequest(getConn(ctx), "POST", `/reports/${p.reportId}/run`, {}, qs);
+            return apiRequest(ctx, "POST", `reports/${pathSegment(p.reportId)}/run`, {}, qs);
         },
     });
 }

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

@@ -0,0 +1,22 @@
+import { hostLabel, staticCredential } from "../../_shared/credentials.js";
+/** An OAuth2 access token, sent as a bearer to the company's own realm path on
+ *  Intuit's production or sandbox host, chosen by the sandbox flag. */
+export const quickbooksCredential = staticCredential({
+    id: "quickbooks",
+    auth: { kind: "bearer" },
+    local: { secret: "accessToken" },
+    targets: (config) => ({
+        api: {
+            baseUrl: `${config.sandbox === true
+                ? "https://sandbox-quickbooks.api.intuit.com"
+                : "https://quickbooks.api.intuit.com"}/v3/company/${hostLabel(config.companyId)}/`,
+            methods: ["GET", "POST"],
+        },
+    }),
+    probe: {
+        target: "api",
+        path: "query?query=select%20*%20from%20CompanyInfo",
+        method: "GET",
+        acceptedStatuses: [200],
+    },
+});