runline 0.33.0 → 0.35.0

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

@@ -1,15 +1,11 @@
-const BASE_URL = "https://api.nasa.gov";
-async function apiRequest(apiKey, endpoint, qs = {}) {
-    const url = new URL(`${BASE_URL}${endpoint}`);
-    url.searchParams.set("api_key", apiKey);
-    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());
-    if (!res.ok)
-        throw new Error(`NASA API error ${res.status}: ${await res.text()}`);
-    return res.json();
+import { credentialJson, pathSegment } from "../../_shared/credentials.js";
+import { nasaCredential } from "./credentials.js";
+function apiRequest(ctx, path, qs = {}) {
+    return credentialJson(ctx, nasaCredential, "nasa", {
+        target: "api",
+        path,
+        query: qs,
+    });
 }
 function today() {
     return new Date().toISOString().split("T")[0];
@@ -22,6 +18,7 @@ function formatDate(d) {
 export default function nasa(rl) {
     rl.setName("nasa");
     rl.setVersion("0.1.0");
+    rl.setCredential(nasaCredential);
     rl.setConnectionSchema({
         apiKey: {
             type: "string",
@@ -30,7 +27,6 @@ export default function nasa(rl) {
             env: "NASA_API_KEY",
         },
     });
-    const key = (ctx) => ctx.connection.config.apiKey;
     rl.registerAction("apod.get", {
         access: "read",
         description: "Get the Astronomy Picture of the Day (returns metadata; image URL in 'hdurl' field)",
@@ -45,7 +41,7 @@ export default function nasa(rl) {
             const qs = {
                 date: formatDate(input?.date) ?? today(),
             };
-            return apiRequest(key(ctx), "/planetary/apod", qs);
+            return apiRequest(ctx, "planetary/apod", qs);
         },
     });
     rl.registerAction("asteroidNeoFeed.get", {
@@ -69,7 +65,7 @@ export default function nasa(rl) {
                 start_date: formatDate(p.startDate) ?? today(),
                 end_date: formatDate(p.endDate) ?? today(),
             };
-            const data = (await apiRequest(key(ctx), "/neo/rest/v1/feed", qs));
+            const data = (await apiRequest(ctx, "neo/rest/v1/feed", qs));
             return data.near_earth_objects;
         },
     });
@@ -86,7 +82,7 @@ export default function nasa(rl) {
         },
         async execute(input, ctx) {
             const { asteroidId, includeCloseApproachData } = input;
-            const data = (await apiRequest(key(ctx), `/neo/rest/v1/neo/${asteroidId}`));
+            const data = (await apiRequest(ctx, `neo/rest/v1/neo/${pathSegment(asteroidId)}`));
             if (!includeCloseApproachData)
                 delete data.close_approach_data;
             return data;
@@ -106,7 +102,7 @@ export default function nasa(rl) {
             const qs = {};
             if (input?.limit)
                 qs.size = input.limit;
-            const data = (await apiRequest(key(ctx), "/neo/rest/v1/neo/browse", qs));
+            const data = (await apiRequest(ctx, "neo/rest/v1/neo/browse", qs));
             return data.near_earth_objects;
         },
     });
@@ -114,42 +110,42 @@ export default function nasa(rl) {
     const donkiEndpoints = [
         {
             name: "coronalMassEjection",
-            path: "/DONKI/CME",
+            path: "DONKI/CME",
             description: "DONKI Coronal Mass Ejection data",
         },
         {
             name: "solarFlare",
-            path: "/DONKI/FLR",
+            path: "DONKI/FLR",
             description: "DONKI Solar Flare data",
         },
         {
             name: "solarEnergeticParticle",
-            path: "/DONKI/SEP",
+            path: "DONKI/SEP",
             description: "DONKI Solar Energetic Particle data",
         },
         {
             name: "magnetopauseCrossing",
-            path: "/DONKI/MPC",
+            path: "DONKI/MPC",
             description: "DONKI Magnetopause Crossing data",
         },
         {
             name: "radiationBeltEnhancement",
-            path: "/DONKI/RBE",
+            path: "DONKI/RBE",
             description: "DONKI Radiation Belt Enhancement data",
         },
         {
             name: "highSpeedStream",
-            path: "/DONKI/HSS",
+            path: "DONKI/HSS",
             description: "DONKI High Speed Stream data",
         },
         {
             name: "wsaEnlilSimulation",
-            path: "/DONKI/WSAEnlilSimulations",
+            path: "DONKI/WSAEnlilSimulations",
             description: "DONKI WSA+Enlil Simulation data",
         },
         {
             name: "notifications",
-            path: "/DONKI/notifications",
+            path: "DONKI/notifications",
             description: "DONKI Notifications data",
         },
     ];
@@ -176,7 +172,7 @@ export default function nasa(rl) {
                     qs.startDate = formatDate(p.startDate);
                 if (p.endDate)
                     qs.endDate = formatDate(p.endDate);
-                return apiRequest(key(ctx), ep.path, qs);
+                return apiRequest(ctx, ep.path, qs);
             },
         });
     }
@@ -208,7 +204,7 @@ export default function nasa(rl) {
                 qs.location = p.location;
             if (p.catalog)
                 qs.catalog = p.catalog;
-            return apiRequest(key(ctx), "/DONKI/IPS", qs);
+            return apiRequest(ctx, "DONKI/IPS", qs);
         },
     });
     // ── Earth ───────────────────────────────────────────
@@ -234,7 +230,7 @@ export default function nasa(rl) {
             const qs = { lat, lon, dim: dim ?? 0.025 };
             if (date)
                 qs.date = formatDate(date);
-            return apiRequest(key(ctx), "/planetary/earth/assets", qs);
+            return apiRequest(ctx, "planetary/earth/assets", qs);
         },
     });
 }

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

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

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

@@ -1,51 +1,28 @@
-const BASE = "https://api.netlify.com/api/v1";
-function getToken(ctx) {
-    return ctx.connection.config.accessToken;
-}
-async function apiRequest(token, 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, credentialOk, jsonAnswer, pathSegment, } from "../../_shared/credentials.js";
+import { netlifyCredential } from "./credentials.js";
+function apiRequest(ctx, method, path, body, query) {
+    return credentialJson(ctx, netlifyCredential, "netlify", {
+        target: "api",
+        path,
         method,
-        headers: {
-            Authorization: `Bearer ${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(`Netlify API error ${res.status}: ${await res.text()}`);
-    const text = await res.text();
-    return text ? JSON.parse(text) : {};
+        query,
+        ...(body && Object.keys(body).length > 0 ? { json: body } : {}),
+    });
 }
-async function paginate(token, endpoint, qs = {}) {
+/** Page-numbered listing; the Link header only says whether a next page exists. */
+async function paginate(ctx, path, query = {}) {
     const all = [];
     let page = 0;
     const perPage = 100;
-    // eslint-disable-next-line no-constant-condition
     while (true) {
-        const url = new URL(`${BASE}${endpoint}`);
-        url.searchParams.set("page", String(page));
-        url.searchParams.set("per_page", String(perPage));
-        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: `Bearer ${token}` },
+        const response = await credentialOk(ctx, netlifyCredential, "netlify", {
+            target: "api",
+            path,
+            query: { page, per_page: perPage, ...query },
         });
-        if (!res.ok)
-            throw new Error(`Netlify API error ${res.status}: ${await res.text()}`);
-        const items = (await res.json());
+        const items = (await jsonAnswer(response));
         all.push(...items);
-        const link = res.headers.get("link") ?? "";
+        const link = response.headers.get("link") ?? "";
         if (!link.includes("next"))
             break;
         page++;
@@ -55,6 +32,7 @@ async function paginate(token, endpoint, qs = {}) {
 export default function netlify(rl) {
     rl.setName("netlify");
     rl.setVersion("0.1.0");
+    rl.setCredential(netlifyCredential);
     rl.setConnectionSchema({
         accessToken: {
             type: "string",
@@ -72,7 +50,7 @@ export default function netlify(rl) {
         },
         async execute(input, ctx) {
             const { deployId } = input;
-            return apiRequest(getToken(ctx), "POST", `/deploys/${deployId}/cancel`);
+            return apiRequest(ctx, "POST", `deploys/${pathSegment(deployId)}/cancel`);
         },
     });
     rl.registerAction("deploy.create", {
@@ -95,7 +73,7 @@ export default function netlify(rl) {
                 body.branch = branch;
             if (title)
                 qs.title = title;
-            return apiRequest(getToken(ctx), "POST", `/sites/${siteId}/deploys`, body, qs);
+            return apiRequest(ctx, "POST", `sites/${pathSegment(siteId)}/deploys`, body, qs);
         },
     });
     rl.registerAction("deploy.get", {
@@ -107,7 +85,7 @@ export default function netlify(rl) {
         },
         async execute(input, ctx) {
             const { siteId, deployId } = input;
-            return apiRequest(getToken(ctx), "GET", `/sites/${siteId}/deploys/${deployId}`);
+            return apiRequest(ctx, "GET", `sites/${pathSegment(siteId)}/deploys/${pathSegment(deployId)}`);
         },
     });
     rl.registerAction("deploy.list", {
@@ -123,13 +101,12 @@ export default function netlify(rl) {
         },
         async execute(input, ctx) {
             const { siteId, limit } = input;
-            const token = getToken(ctx);
             if (limit) {
-                return apiRequest(token, "GET", `/sites/${siteId}/deploys`, undefined, {
+                return apiRequest(ctx, "GET", `sites/${pathSegment(siteId)}/deploys`, undefined, {
                     per_page: limit,
                 });
             }
-            return paginate(token, `/sites/${siteId}/deploys`);
+            return paginate(ctx, `sites/${pathSegment(siteId)}/deploys`);
         },
     });
     // ── Site ────────────────────────────────────────────
@@ -141,7 +118,7 @@ export default function netlify(rl) {
         },
         async execute(input, ctx) {
             const { siteId } = input;
-            return apiRequest(getToken(ctx), "DELETE", `/sites/${siteId}`);
+            return apiRequest(ctx, "DELETE", `sites/${pathSegment(siteId)}`);
         },
     });
     rl.registerAction("site.get", {
@@ -152,7 +129,7 @@ export default function netlify(rl) {
         },
         async execute(input, ctx) {
             const { siteId } = input;
-            return apiRequest(getToken(ctx), "GET", `/sites/${siteId}`);
+            return apiRequest(ctx, "GET", `sites/${pathSegment(siteId)}`);
         },
     });
     rl.registerAction("site.list", {
@@ -166,15 +143,14 @@ export default function netlify(rl) {
             },
         },
         async execute(input, ctx) {
-            const token = getToken(ctx);
             const limit = input?.limit;
             if (limit) {
-                return apiRequest(token, "GET", "/sites", undefined, {
+                return apiRequest(ctx, "GET", "sites", undefined, {
                     filter: "all",
                     per_page: limit,
                 });
             }
-            return paginate(token, "/sites", { filter: "all" });
+            return paginate(ctx, "sites", { filter: "all" });
         },
     });
 }

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

@@ -0,0 +1,18 @@
+import { httpsBase, staticCredential } from "../../_shared/credentials.js";
+/**
+ * The Nitro admin password, sent as the X-NITRO-PASS header to the
+ * appliance's /nitro/v1/ base. The username is public config and rides
+ * as the X-NITRO-USER companion header. The appliance URL must be HTTPS.
+ */
+export const netscalerAdcCredential = staticCredential({
+    id: "netscalerAdc",
+    auth: { kind: "apiKey", header: "X-NITRO-PASS" },
+    local: { secret: "password" },
+    targets: (config) => ({
+        api: {
+            baseUrl: httpsBase(config.url, "nitro/v1/"),
+            methods: ["POST", "DELETE"],
+            allowedHeaders: ["X-NITRO-USER"],
+        },
+    }),
+});

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

@@ -1,32 +1,18 @@
-function getConn(ctx) {
-    const c = ctx.connection.config;
-    const url = c.url.replace(/\/$/, "");
-    return {
-        url,
-        username: c.username,
-        password: c.password,
-    };
-}
-async function apiRequest(conn, method, resource, body) {
-    const init = {
+import { credentialJson } from "../../_shared/credentials.js";
+import { netscalerAdcCredential } from "./credentials.js";
+function apiRequest(ctx, method, resource, body) {
+    return credentialJson(ctx, netscalerAdcCredential, "netscalerAdc", {
+        target: "api",
+        path: resource,
         method,
-        headers: {
-            "Content-Type": "application/json",
-            "X-NITRO-USER": conn.username,
-            "X-NITRO-PASS": conn.password,
-        },
-    };
-    if (body && Object.keys(body).length > 0)
-        init.body = JSON.stringify(body);
-    const res = await fetch(`${conn.url}/nitro/v1${resource}`, init);
-    if (!res.ok)
-        throw new Error(`Netscaler ADC API error ${res.status}: ${await res.text()}`);
-    const text = await res.text();
-    return text ? JSON.parse(text) : {};
+        headers: { "X-NITRO-USER": String(ctx.connection.config.username) },
+        ...(body && Object.keys(body).length > 0 ? { json: body } : {}),
+    });
 }
 export default function netscalerAdc(rl) {
     rl.setName("netscalerAdc");
     rl.setVersion("0.1.0");
+    rl.setCredential(netscalerAdcCredential);
     rl.setConnectionSchema({
         url: {
             type: "string",
@@ -119,7 +105,6 @@ export default function netscalerAdc(rl) {
         },
         async execute(input, ctx) {
             const p = input;
-            const conn = getConn(ctx);
             const body = {
                 reqfile: p.certificateRequestFileName,
                 certfile: p.certificateFileName,
@@ -148,7 +133,7 @@ export default function netscalerAdc(rl) {
                 body.subjectaltname = p.subjectaltname;
             if (p.days)
                 body.days = p.days;
-            await apiRequest(conn, "POST", "/config/sslcert?action=create", {
+            await apiRequest(ctx, "POST", "config/sslcert?action=create", {
                 sslcert: body,
             });
             return { success: true };
@@ -201,7 +186,6 @@ export default function netscalerAdc(rl) {
         },
         async execute(input, ctx) {
             const p = input;
-            const conn = getConn(ctx);
             const body = {
                 certkey: p.certificateKeyPairName,
                 cert: p.certificateFileName,
@@ -217,7 +201,7 @@ export default function netscalerAdc(rl) {
                 body.expirymonitor = "ENABLED";
                 body.notificationperiod = p.notificationPeriod ?? 10;
             }
-            await apiRequest(conn, "POST", "/config/sslcertkey", {
+            await apiRequest(ctx, "POST", "config/sslcertkey", {
                 sslcertkey: body,
             });
             return { success: true };
@@ -240,9 +224,10 @@ export default function netscalerAdc(rl) {
         },
         async execute(input, ctx) {
             const { fileName, fileLocation } = input;
-            const conn = getConn(ctx);
-            const loc = encodeURIComponent(fileLocation ?? "/nsconfig/ssl/");
-            await apiRequest(conn, "DELETE", `/config/systemfile?args=filename:${fileName},filelocation:${loc}`);
+            // Both are values inside the args query parameter, not path segments.
+            const name = encodeURIComponent(String(fileName));
+            const loc = encodeURIComponent(String(fileLocation ?? "/nsconfig/ssl/"));
+            await apiRequest(ctx, "DELETE", `config/systemfile?args=filename:${name},filelocation:${loc}`);
             return { success: true };
         },
     });

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

@@ -0,0 +1,27 @@
+import { AuthError } from "runline";
+import { httpsBase, staticCredential } from "../../_shared/credentials.js";
+/**
+ * A username and password (or app token) as HTTP Basic, on two targets of
+ * the connection's HTTPS server: the WebDAV base it names, and the OCS
+ * API beneath the server root, found before `/remote.php/`. A WebDAV URL
+ * without that segment is refused: its OCS base cannot be known.
+ */
+export const nextcloudCredential = staticCredential({
+    id: "nextcloud",
+    auth: { kind: "basic" },
+    local: { username: "username", password: "password" },
+    targets: (config) => {
+        const dav = httpsBase(config.webDavUrl, "");
+        const root = dav.indexOf("/remote.php/");
+        if (root < 0)
+            throw new AuthError("invalid_credentials");
+        return {
+            dav: { baseUrl: dav, methods: ["DELETE", "MKCOL", "COPY", "MOVE"] },
+            ocs: {
+                baseUrl: `${dav.slice(0, root)}/ocs/`,
+                methods: ["GET", "POST", "PUT", "DELETE"],
+                allowedHeaders: ["OCS-APIRequest"],
+            },
+        };
+    },
+});