runline 0.33.0 → 0.35.0

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

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

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

@@ -1,40 +1,25 @@
-const BASE_URL = "https://api.clockify.me/api/v1";
-async function apiRequest(apiKey, method, endpoint, body, qs) {
-    const url = new URL(`${BASE_URL}/${endpoint}`);
-    if (qs) {
-        for (const [k, v] of Object.entries(qs)) {
-            if (v !== undefined && v !== null)
-                url.searchParams.set(k, String(v));
-        }
-    }
-    const opts = {
+import { credentialJson, pathSegment } from "../../_shared/credentials.js";
+import { clockifyCredential } from "./credentials.js";
+async function apiRequest(ctx, method, path, body, qs) {
+    return credentialJson(ctx, clockifyCredential, "clockify", {
+        target: "api",
+        path,
         method,
-        headers: { "Content-Type": "application/json", "X-Api-Key": apiKey },
-    };
-    if (body &&
-        Object.keys(body).length > 0 &&
-        method !== "GET" &&
-        method !== "DELETE") {
-        opts.body = JSON.stringify(body);
-    }
-    const res = await fetch(url.toString(), opts);
-    if (!res.ok) {
-        const text = await res.text();
-        throw new Error(`Clockify API error ${res.status}: ${text}`);
-    }
-    if (res.status === 204)
-        return { success: true };
-    const ct = res.headers.get("content-type") ?? "";
-    if (ct.includes("application/json"))
-        return res.json();
-    return { success: true };
+        query: qs,
+        ...(body &&
+            Object.keys(body).length > 0 &&
+            method !== "GET" &&
+            method !== "DELETE"
+            ? { json: body }
+            : {}),
+    });
 }
-async function paginateAll(apiKey, endpoint, qs, limit) {
+async function paginateAll(ctx, path, qs, limit) {
     const results = [];
     let page = 1;
     const size = 50;
     while (true) {
-        const data = (await apiRequest(apiKey, "GET", endpoint, undefined, {
+        const data = (await apiRequest(ctx, "GET", path, undefined, {
             ...qs,
             page,
             "page-size": size,
@@ -50,12 +35,10 @@ async function paginateAll(apiKey, endpoint, qs, limit) {
     }
     return results;
 }
-function getKey(ctx) {
-    return ctx.connection.config.apiKey;
-}
 export default function clockify(rl) {
     rl.setName("clockify");
     rl.setVersion("0.1.0");
+    rl.setCredential(clockifyCredential);
     rl.setConnectionSchema({
         apiKey: {
             type: "string",
@@ -78,7 +61,9 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, name } = input;
-            return apiRequest(getKey(ctx), "POST", `workspaces/${workspaceId}/clients`, { name });
+            return apiRequest(ctx, "POST", `workspaces/${pathSegment(workspaceId)}/clients`, {
+                name,
+            });
         },
     });
     rl.registerAction("client.get", {
@@ -94,7 +79,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, clientId } = input;
-            return apiRequest(getKey(ctx), "GET", `workspaces/${workspaceId}/clients/${clientId}`);
+            return apiRequest(ctx, "GET", `workspaces/${pathSegment(workspaceId)}/clients/${pathSegment(clientId)}`);
         },
     });
     rl.registerAction("client.list", {
@@ -121,7 +106,7 @@ export default function clockify(rl) {
                 qs.name = name;
             if (archived !== undefined)
                 qs.archived = archived;
-            return paginateAll(getKey(ctx), `workspaces/${workspaceId}/clients`, qs, limit);
+            return paginateAll(ctx, `workspaces/${pathSegment(workspaceId)}/clients`, qs, limit);
         },
     });
     rl.registerAction("client.update", {
@@ -139,7 +124,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, clientId, ...body } = input;
-            return apiRequest(getKey(ctx), "PUT", `workspaces/${workspaceId}/clients/${clientId}`, body);
+            return apiRequest(ctx, "PUT", `workspaces/${pathSegment(workspaceId)}/clients/${pathSegment(clientId)}`, body);
         },
     });
     rl.registerAction("client.delete", {
@@ -155,7 +140,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, clientId } = input;
-            await apiRequest(getKey(ctx), "DELETE", `workspaces/${workspaceId}/clients/${clientId}`);
+            await apiRequest(ctx, "DELETE", `workspaces/${pathSegment(workspaceId)}/clients/${pathSegment(clientId)}`);
             return { success: true };
         },
     });
@@ -182,7 +167,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, ...body } = input;
-            return apiRequest(getKey(ctx), "POST", `workspaces/${workspaceId}/projects`, body);
+            return apiRequest(ctx, "POST", `workspaces/${pathSegment(workspaceId)}/projects`, body);
         },
     });
     rl.registerAction("project.get", {
@@ -198,7 +183,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, projectId } = input;
-            return apiRequest(getKey(ctx), "GET", `workspaces/${workspaceId}/projects/${projectId}`);
+            return apiRequest(ctx, "GET", `workspaces/${pathSegment(workspaceId)}/projects/${pathSegment(projectId)}`);
         },
     });
     rl.registerAction("project.list", {
@@ -225,7 +210,7 @@ export default function clockify(rl) {
                 qs.name = name;
             if (archived !== undefined)
                 qs.archived = archived;
-            return paginateAll(getKey(ctx), `workspaces/${workspaceId}/projects`, qs, limit);
+            return paginateAll(ctx, `workspaces/${pathSegment(workspaceId)}/projects`, qs, limit);
         },
     });
     rl.registerAction("project.update", {
@@ -248,7 +233,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, projectId, ...body } = input;
-            return apiRequest(getKey(ctx), "PUT", `workspaces/${workspaceId}/projects/${projectId}`, body);
+            return apiRequest(ctx, "PUT", `workspaces/${pathSegment(workspaceId)}/projects/${pathSegment(projectId)}`, body);
         },
     });
     rl.registerAction("project.delete", {
@@ -264,7 +249,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, projectId } = input;
-            await apiRequest(getKey(ctx), "DELETE", `workspaces/${workspaceId}/projects/${projectId}`);
+            await apiRequest(ctx, "DELETE", `workspaces/${pathSegment(workspaceId)}/projects/${pathSegment(projectId)}`);
             return { success: true };
         },
     });
@@ -282,7 +267,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, name } = input;
-            return apiRequest(getKey(ctx), "POST", `workspaces/${workspaceId}/tags`, {
+            return apiRequest(ctx, "POST", `workspaces/${pathSegment(workspaceId)}/tags`, {
                 name,
             });
         },
@@ -311,7 +296,7 @@ export default function clockify(rl) {
                 qs.name = name;
             if (archived !== undefined)
                 qs.archived = archived;
-            return paginateAll(getKey(ctx), `workspaces/${workspaceId}/tags`, qs, limit);
+            return paginateAll(ctx, `workspaces/${pathSegment(workspaceId)}/tags`, qs, limit);
         },
     });
     rl.registerAction("tag.update", {
@@ -329,7 +314,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, tagId, ...body } = input;
-            return apiRequest(getKey(ctx), "PUT", `workspaces/${workspaceId}/tags/${tagId}`, body);
+            return apiRequest(ctx, "PUT", `workspaces/${pathSegment(workspaceId)}/tags/${pathSegment(tagId)}`, body);
         },
     });
     rl.registerAction("tag.delete", {
@@ -345,7 +330,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, tagId } = input;
-            await apiRequest(getKey(ctx), "DELETE", `workspaces/${workspaceId}/tags/${tagId}`);
+            await apiRequest(ctx, "DELETE", `workspaces/${pathSegment(workspaceId)}/tags/${pathSegment(tagId)}`);
             return { success: true };
         },
     });
@@ -383,7 +368,7 @@ export default function clockify(rl) {
                 const [h, m] = estimate.split(":");
                 body.estimate = `PT${h}H${m}M`;
             }
-            return apiRequest(getKey(ctx), "POST", `workspaces/${workspaceId}/projects/${projectId}/tasks`, body);
+            return apiRequest(ctx, "POST", `workspaces/${pathSegment(workspaceId)}/projects/${pathSegment(projectId)}/tasks`, body);
         },
     });
     rl.registerAction("task.get", {
@@ -400,7 +385,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, projectId, taskId } = input;
-            return apiRequest(getKey(ctx), "GET", `workspaces/${workspaceId}/projects/${projectId}/tasks/${taskId}`);
+            return apiRequest(ctx, "GET", `workspaces/${pathSegment(workspaceId)}/projects/${pathSegment(projectId)}/tasks/${pathSegment(taskId)}`);
         },
     });
     rl.registerAction("task.list", {
@@ -431,9 +416,9 @@ export default function clockify(rl) {
                 qs.name = name;
             if (limit) {
                 qs["page-size"] = limit;
-                return apiRequest(getKey(ctx), "GET", `workspaces/${workspaceId}/projects/${projectId}/tasks`, undefined, qs);
+                return apiRequest(ctx, "GET", `workspaces/${pathSegment(workspaceId)}/projects/${pathSegment(projectId)}/tasks`, undefined, qs);
             }
-            return paginateAll(getKey(ctx), `workspaces/${workspaceId}/projects/${projectId}/tasks`, qs);
+            return paginateAll(ctx, `workspaces/${pathSegment(workspaceId)}/projects/${pathSegment(projectId)}/tasks`, qs);
         },
     });
     rl.registerAction("task.update", {
@@ -466,7 +451,7 @@ export default function clockify(rl) {
                 const [h, m] = estimate.split(":");
                 body.estimate = `PT${h}H${m}M`;
             }
-            return apiRequest(getKey(ctx), "PUT", `workspaces/${workspaceId}/projects/${projectId}/tasks/${taskId}`, body);
+            return apiRequest(ctx, "PUT", `workspaces/${pathSegment(workspaceId)}/projects/${pathSegment(projectId)}/tasks/${pathSegment(taskId)}`, body);
         },
     });
     rl.registerAction("task.delete", {
@@ -483,7 +468,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, projectId, taskId } = input;
-            await apiRequest(getKey(ctx), "DELETE", `workspaces/${workspaceId}/projects/${projectId}/tasks/${taskId}`);
+            await apiRequest(ctx, "DELETE", `workspaces/${pathSegment(workspaceId)}/projects/${pathSegment(projectId)}/tasks/${pathSegment(taskId)}`);
             return { success: true };
         },
     });
@@ -519,7 +504,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, ...body } = input;
-            return apiRequest(getKey(ctx), "POST", `workspaces/${workspaceId}/time-entries`, body);
+            return apiRequest(ctx, "POST", `workspaces/${pathSegment(workspaceId)}/time-entries`, body);
         },
     });
     rl.registerAction("timeEntry.get", {
@@ -539,7 +524,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, timeEntryId } = input;
-            return apiRequest(getKey(ctx), "GET", `workspaces/${workspaceId}/time-entries/${timeEntryId}`);
+            return apiRequest(ctx, "GET", `workspaces/${pathSegment(workspaceId)}/time-entries/${pathSegment(timeEntryId)}`);
         },
     });
     rl.registerAction("timeEntry.update", {
@@ -572,11 +557,11 @@ export default function clockify(rl) {
             const { workspaceId, timeEntryId, ...body } = input;
             // start is required by API — fetch current if not set
             if (!body.start) {
-                const current = (await apiRequest(getKey(ctx), "GET", `workspaces/${workspaceId}/time-entries/${timeEntryId}`));
+                const current = (await apiRequest(ctx, "GET", `workspaces/${pathSegment(workspaceId)}/time-entries/${pathSegment(timeEntryId)}`));
                 const interval = current.timeInterval;
                 body.start = interval.start;
             }
-            return apiRequest(getKey(ctx), "PUT", `workspaces/${workspaceId}/time-entries/${timeEntryId}`, body);
+            return apiRequest(ctx, "PUT", `workspaces/${pathSegment(workspaceId)}/time-entries/${pathSegment(timeEntryId)}`, body);
         },
     });
     rl.registerAction("timeEntry.delete", {
@@ -596,7 +581,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { workspaceId, timeEntryId } = input;
-            await apiRequest(getKey(ctx), "DELETE", `workspaces/${workspaceId}/time-entries/${timeEntryId}`);
+            await apiRequest(ctx, "DELETE", `workspaces/${pathSegment(workspaceId)}/time-entries/${pathSegment(timeEntryId)}`);
             return { success: true };
         },
     });
@@ -629,7 +614,7 @@ export default function clockify(rl) {
                 qs.email = email;
             if (status)
                 qs.status = status;
-            return paginateAll(getKey(ctx), `workspaces/${workspaceId}/users`, qs, limit);
+            return paginateAll(ctx, `workspaces/${pathSegment(workspaceId)}/users`, qs, limit);
         },
     });
     // ── Workspace ───────────────────────────────────────
@@ -641,7 +626,7 @@ export default function clockify(rl) {
         },
         async execute(input, ctx) {
             const { limit } = (input ?? {});
-            const data = (await apiRequest(getKey(ctx), "GET", "workspaces"));
+            const data = (await apiRequest(ctx, "GET", "workspaces"));
             if (limit)
                 return data.slice(0, limit);
             return data;

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

@@ -0,0 +1,19 @@
+import { staticCredential } from "../../_shared/credentials.js";
+/** An API token, sent as a bearer to Cloudflare's one API origin. */
+export const cloudflareCredential = staticCredential({
+    id: "cloudflare",
+    auth: { kind: "bearer" },
+    local: { secret: "apiToken" },
+    targets: {
+        api: {
+            baseUrl: "https://api.cloudflare.com/client/v4/",
+            methods: ["GET", "POST", "DELETE"],
+        },
+    },
+    probe: {
+        target: "api",
+        path: "user/tokens/verify",
+        method: "GET",
+        acceptedStatuses: [200],
+    },
+});

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

@@ -1,38 +1,23 @@
-const BASE_URL = "https://api.cloudflare.com/client/v4";
-async function apiRequest(token, method, endpoint, body, qs) {
-    const url = new URL(`${BASE_URL}${endpoint}`);
-    if (qs) {
-        for (const [k, v] of Object.entries(qs)) {
-            if (v !== undefined && v !== null)
-                url.searchParams.set(k, String(v));
-        }
-    }
-    const opts = {
+import { credentialJson, pathSegment } from "../../_shared/credentials.js";
+import { cloudflareCredential } from "./credentials.js";
+function apiRequest(ctx, method, path, body, qs) {
+    return credentialJson(ctx, cloudflareCredential, "cloudflare", {
+        target: "api",
+        path,
         method,
-        headers: {
-            "Content-Type": "application/json",
-            Authorization: `Bearer ${token}`,
-        },
-    };
-    if (body &&
-        Object.keys(body).length > 0 &&
-        method !== "GET" &&
-        method !== "DELETE") {
-        opts.body = JSON.stringify(body);
-    }
-    const res = await fetch(url.toString(), opts);
-    if (!res.ok) {
-        const text = await res.text();
-        throw new Error(`Cloudflare API error ${res.status}: ${text}`);
-    }
-    return res.json();
-}
-function getToken(ctx) {
-    return ctx.connection.config.apiToken;
+        query: qs,
+        ...(body &&
+            Object.keys(body).length > 0 &&
+            method !== "GET" &&
+            method !== "DELETE"
+            ? { json: body }
+            : {}),
+    });
 }
 export default function cloudflare(rl) {
     rl.setName("cloudflare");
     rl.setVersion("0.1.0");
+    rl.setCredential(cloudflareCredential);
     rl.setConnectionSchema({
         apiToken: {
             type: "string",
@@ -54,7 +39,7 @@ export default function cloudflare(rl) {
         },
         async execute(input, ctx) {
             const { zoneId, certificateId } = input;
-            const data = (await apiRequest(getToken(ctx), "GET", `/zones/${zoneId}/origin_tls_client_auth/${certificateId}`));
+            const data = (await apiRequest(ctx, "GET", `zones/${pathSegment(zoneId)}/origin_tls_client_auth/${pathSegment(certificateId)}`));
             return data.result;
         },
     });
@@ -70,7 +55,7 @@ export default function cloudflare(rl) {
             const qs = {};
             if (limit)
                 qs.per_page = limit;
-            const data = (await apiRequest(getToken(ctx), "GET", `/zones/${zoneId}/origin_tls_client_auth`, undefined, qs));
+            const data = (await apiRequest(ctx, "GET", `zones/${pathSegment(zoneId)}/origin_tls_client_auth`, undefined, qs));
             return data.result;
         },
     });
@@ -92,7 +77,7 @@ export default function cloudflare(rl) {
         },
         async execute(input, ctx) {
             const { zoneId, certificate, privateKey } = input;
-            const data = (await apiRequest(getToken(ctx), "POST", `/zones/${zoneId}/origin_tls_client_auth`, {
+            const data = (await apiRequest(ctx, "POST", `zones/${pathSegment(zoneId)}/origin_tls_client_auth`, {
                 certificate,
                 private_key: privateKey,
             }));
@@ -112,7 +97,7 @@ export default function cloudflare(rl) {
         },
         async execute(input, ctx) {
             const { zoneId, certificateId } = input;
-            const data = (await apiRequest(getToken(ctx), "DELETE", `/zones/${zoneId}/origin_tls_client_auth/${certificateId}`));
+            const data = (await apiRequest(ctx, "DELETE", `zones/${pathSegment(zoneId)}/origin_tls_client_auth/${pathSegment(certificateId)}`));
             return data.result;
         },
     });

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

@@ -0,0 +1,17 @@
+import { httpsBase, staticCredential } from "../../_shared/credentials.js";
+/**
+ * An API token, appended by the transport as the token query parameter on
+ * the connection's own Cockpit instance beneath /api/. The instance URL is
+ * public config and must be HTTPS.
+ */
+export const cockpitCredential = staticCredential({
+    id: "cockpit",
+    auth: { kind: "queryKey", param: "token" },
+    local: { secret: "accessToken" },
+    targets: (config) => ({
+        api: {
+            baseUrl: httpsBase(config.url, "api/"),
+            methods: ["GET", "POST"],
+        },
+    }),
+});

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

@@ -1,29 +1,19 @@
-async function apiRequest(baseUrl, token, method, endpoint, body) {
-    const url = new URL(`${baseUrl}/api${endpoint}`);
-    url.searchParams.set("token", token);
-    const opts = {
+import { credentialJson, pathSegment } from "../../_shared/credentials.js";
+import { cockpitCredential } from "./credentials.js";
+function apiRequest(ctx, method, path, body) {
+    return credentialJson(ctx, cockpitCredential, "cockpit", {
+        target: "api",
+        path,
         method,
-        headers: { "Content-Type": "application/json", Accept: "application/json" },
-    };
-    if (body && Object.keys(body).length > 0 && method !== "GET") {
-        opts.body = JSON.stringify(body);
-    }
-    const res = await fetch(url.toString(), opts);
-    if (!res.ok) {
-        const text = await res.text();
-        throw new Error(`Cockpit API error ${res.status}: ${text}`);
-    }
-    return res.json();
-}
-function getConn(ctx) {
-    return {
-        baseUrl: ctx.connection.config.url.replace(/\/$/, ""),
-        token: ctx.connection.config.accessToken,
-    };
+        ...(body && Object.keys(body).length > 0 && method !== "GET"
+            ? { json: body }
+            : {}),
+    });
 }
 export default function cockpit(rl) {
     rl.setName("cockpit");
     rl.setVersion("0.1.0");
+    rl.setCredential(cockpitCredential);
     rl.setConnectionSchema({
         url: {
             type: "string",
@@ -56,8 +46,9 @@ export default function cockpit(rl) {
         },
         async execute(input, ctx) {
             const { collection, data } = input;
-            const { baseUrl, token } = getConn(ctx);
-            return apiRequest(baseUrl, token, "POST", `/collections/save/${collection}`, { data });
+            return apiRequest(ctx, "POST", `collections/save/${pathSegment(collection)}`, {
+                data,
+            });
         },
     });
     rl.registerAction("collection.list", {
@@ -95,7 +86,6 @@ export default function cockpit(rl) {
         },
         async execute(input, ctx) {
             const { collection, filter, fields, sort, limit, skip, populate, language, } = (input ?? {});
-            const { baseUrl, token } = getConn(ctx);
             const body = { simple: true };
             if (filter)
                 body.filter = filter;
@@ -115,7 +105,7 @@ export default function cockpit(rl) {
                 body.populate = populate;
             if (language)
                 body.lang = language;
-            return apiRequest(baseUrl, token, "POST", `/collections/get/${collection}`, body);
+            return apiRequest(ctx, "POST", `collections/get/${pathSegment(collection)}`, body);
         },
     });
     rl.registerAction("collection.update", {
@@ -132,8 +122,7 @@ export default function cockpit(rl) {
         },
         async execute(input, ctx) {
             const { collection, id, data } = input;
-            const { baseUrl, token } = getConn(ctx);
-            return apiRequest(baseUrl, token, "POST", `/collections/save/${collection}`, {
+            return apiRequest(ctx, "POST", `collections/save/${pathSegment(collection)}`, {
                 data: { _id: id, ...data },
             });
         },
@@ -152,8 +141,7 @@ export default function cockpit(rl) {
         },
         async execute(input, ctx) {
             const { form, data } = input;
-            const { baseUrl, token } = getConn(ctx);
-            return apiRequest(baseUrl, token, "POST", `/forms/submit/${form}`, {
+            return apiRequest(ctx, "POST", `forms/submit/${pathSegment(form)}`, {
                 form: data,
             });
         },
@@ -171,8 +159,7 @@ export default function cockpit(rl) {
         },
         async execute(input, ctx) {
             const { singleton } = input;
-            const { baseUrl, token } = getConn(ctx);
-            return apiRequest(baseUrl, token, "GET", `/singletons/get/${singleton}`);
+            return apiRequest(ctx, "GET", `singletons/get/${pathSegment(singleton)}`);
         },
     });
 }

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

@@ -0,0 +1,19 @@
+import { staticCredential } from "../../_shared/credentials.js";
+/** An API token, sent as a bearer to Coda's one API origin. */
+export const codaCredential = staticCredential({
+    id: "coda",
+    auth: { kind: "bearer" },
+    local: { secret: "accessToken" },
+    targets: {
+        api: {
+            baseUrl: "https://coda.io/apis/v1/",
+            methods: ["GET", "POST", "PUT", "DELETE"],
+        },
+    },
+    probe: {
+        target: "api",
+        path: "whoami",
+        method: "GET",
+        acceptedStatuses: [200],
+    },
+});