runline 0.33.0 → 0.34.0

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

@@ -8,14 +8,15 @@
  * text rendering well. Sized via aspect_ratio rather than W×H —
  * the API does the math.
  */
-import { readImageInput, SEND_FILE_NOTE, writeImageFile } from "../../_shared/mediaFile.js";
-const ENDPOINT = "https://api.x.ai/v1/images/generations";
-const EDIT_ENDPOINT = "https://api.x.ai/v1/images/edits";
+import { credentialJson } from "../../_shared/credentials.js";
+import { readImageInput, SEND_FILE_NOTE, writeImageFile, } from "../../_shared/mediaFile.js";
+import { xaiCredential } from "./credentials.js";
 const MODEL = "grok-imagine-image";
 const EDIT_MODEL = "grok-imagine-image-2.0";
 export default function xai(rl) {
     rl.setName("xai");
     rl.setVersion("0.1.0");
+    rl.setCredential(xaiCredential);
     rl.setConnectionSchema({
         apiKey: {
             type: "string",
@@ -54,7 +55,6 @@ export default function xai(rl) {
             if (typeof p.prompt !== "string" || p.prompt.length === 0) {
                 throw new Error("xai: prompt is required");
             }
-            const apiKey = ctx.connection.config.apiKey;
             const body = {
                 model: MODEL,
                 prompt: p.prompt,
@@ -63,21 +63,22 @@ export default function xai(rl) {
             };
             if (p.aspectRatio)
                 body.aspect_ratio = p.aspectRatio;
-            const res = await fetch(ENDPOINT, {
+            const data = (await credentialJson(ctx, xaiCredential, "xai", {
+                target: "api",
+                path: "images/generations",
                 method: "POST",
-                headers: {
-                    "Content-Type": "application/json",
-                    Authorization: `Bearer ${apiKey}`,
-                },
-                body: JSON.stringify(body),
-            });
-            if (!res.ok) {
-                throw new Error(`xAI API error ${res.status}: ${await res.text()}`);
-            }
-            const data = (await res.json());
+                json: body,
+            }));
             const stamp = Date.now();
             const images = (data.data ?? []).map((d, i) => ({
-                ...writeImageFile({ base64: d.b64_json, mimeType: d.mime_type ?? "image/jpeg", provider: "xai", index: i, saveDir: p.saveDir, stamp }),
+                ...writeImageFile({
+                    base64: d.b64_json,
+                    mimeType: d.mime_type ?? "image/jpeg",
+                    provider: "xai",
+                    index: i,
+                    saveDir: p.saveDir,
+                    stamp,
+                }),
                 ...(d.revised_prompt ? { revisedPrompt: d.revised_prompt } : {}),
             }));
             return { provider: "xai", model: MODEL, images, note: SEND_FILE_NOTE };
@@ -119,29 +120,29 @@ export default function xai(rl) {
                 throw new Error("xai: prompt is required");
             }
             const img = readImageInput(p.imagePath, "xai");
-            const apiKey = ctx.connection.config.apiKey;
             const model = p.model ?? EDIT_MODEL;
-            const res = await fetch(EDIT_ENDPOINT, {
+            const data = (await credentialJson(ctx, xaiCredential, "xai", {
+                target: "api",
+                path: "images/edits",
                 method: "POST",
-                headers: {
-                    "Content-Type": "application/json",
-                    Authorization: `Bearer ${apiKey}`,
-                },
-                body: JSON.stringify({
+                json: {
                     model,
                     prompt: p.prompt,
                     image: { url: img.dataUri },
                     n: Math.min(p.n ?? 1, 10),
                     response_format: "b64_json",
-                }),
-            });
-            if (!res.ok) {
-                throw new Error(`xAI API error ${res.status}: ${await res.text()}`);
-            }
-            const data = (await res.json());
+                },
+            }));
             const stamp = Date.now();
             const images = (data.data ?? []).map((d, i) => ({
-                ...writeImageFile({ base64: d.b64_json, mimeType: d.mime_type ?? "image/jpeg", provider: "xai", index: i, saveDir: p.saveDir, stamp }),
+                ...writeImageFile({
+                    base64: d.b64_json,
+                    mimeType: d.mime_type ?? "image/jpeg",
+                    provider: "xai",
+                    index: i,
+                    saveDir: p.saveDir,
+                    stamp,
+                }),
                 ...(d.revised_prompt ? { revisedPrompt: d.revised_prompt } : {}),
             }));
             return { provider: "xai", model, images, note: SEND_FILE_NOTE };

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

@@ -0,0 +1,17 @@
+import { staticCredential } from "../../_shared/credentials.js";
+/**
+ * An OAuth2 access token, sent as a bearer to Xero's accounting API. The
+ * public Xero-tenant-id companion header names the organization.
+ */
+export const xeroCredential = staticCredential({
+    id: "xero",
+    auth: { kind: "bearer" },
+    local: { secret: "accessToken" },
+    targets: {
+        api: {
+            baseUrl: "https://api.xero.com/api.xro/2.0/",
+            methods: ["GET", "POST"],
+            allowedHeaders: ["Xero-tenant-id"],
+        },
+    },
+});

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

@@ -1,36 +1,19 @@
-const BASE = "https://api.xero.com/api.xro/2.0";
-function getConn(ctx) {
-    return {
-        accessToken: ctx.connection.config.accessToken,
-        tenantId: ctx.connection.config.tenantId,
-    };
-}
-async function api(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 { xeroCredential } from "./credentials.js";
+function api(ctx, method, endpoint, body, qs) {
+    return credentialJson(ctx, xeroCredential, "xero", {
+        target: "api",
+        path: endpoint,
         method,
-        headers: {
-            Authorization: `Bearer ${conn.accessToken}`,
-            "Xero-tenant-id": conn.tenantId,
-            "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(`Xero error ${res.status}: ${await res.text()}`);
-    return res.json();
+        query: qs,
+        headers: { "Xero-tenant-id": ctx.connection.config.tenantId },
+        ...(body && Object.keys(body).length > 0 ? { json: body } : {}),
+    });
 }
 export default function xero(rl) {
     rl.setName("xero");
     rl.setVersion("0.1.0");
+    rl.setCredential(xeroCredential);
     rl.setConnectionSchema({
         accessToken: {
             type: "string",
@@ -89,7 +72,7 @@ export default function xero(rl) {
                 body.Reference = p.Reference;
             if (p.CurrencyCode)
                 body.CurrencyCode = p.CurrencyCode;
-            const data = (await api(getConn(ctx), "POST", "/Invoices", body));
+            const data = (await api(ctx, "POST", "Invoices", body));
             return data.Invoices;
         },
     });
@@ -98,7 +81,7 @@ export default function xero(rl) {
         description: "Get an invoice by ID",
         inputSchema: { invoiceId: { type: "string", required: true } },
         async execute(input, ctx) {
-            const data = (await api(getConn(ctx), "GET", `/Invoices/${input.invoiceId}`));
+            const data = (await api(ctx, "GET", `Invoices/${pathSegment(input.invoiceId)}`));
             return data.Invoices;
         },
     });
@@ -121,7 +104,7 @@ export default function xero(rl) {
                 qs.statuses = p.statuses;
             if (p.where)
                 qs.where = p.where;
-            const data = (await api(getConn(ctx), "GET", "/Invoices", undefined, qs));
+            const data = (await api(ctx, "GET", "Invoices", undefined, qs));
             const invoices = data.Invoices;
             return p.limit ? invoices.slice(0, p.limit) : invoices;
         },
@@ -139,7 +122,7 @@ export default function xero(rl) {
         },
         async execute(input, ctx) {
             const p = input;
-            const result = (await api(getConn(ctx), "POST", `/Invoices/${p.invoiceId}`, p.data));
+            const result = (await api(ctx, "POST", `Invoices/${pathSegment(p.invoiceId)}`, p.data));
             return result.Invoices;
         },
     });
@@ -156,7 +139,7 @@ export default function xero(rl) {
         async execute(input, ctx) {
             const p = input;
             const body = { Contacts: [p] };
-            const data = (await api(getConn(ctx), "POST", "/Contacts", body));
+            const data = (await api(ctx, "POST", "Contacts", body));
             return data.Contacts;
         },
     });
@@ -165,7 +148,7 @@ export default function xero(rl) {
         description: "Get a contact by ID",
         inputSchema: { contactId: { type: "string", required: true } },
         async execute(input, ctx) {
-            const data = (await api(getConn(ctx), "GET", `/Contacts/${input.contactId}`));
+            const data = (await api(ctx, "GET", `Contacts/${pathSegment(input.contactId)}`));
             return data.Contacts;
         },
     });
@@ -184,7 +167,7 @@ export default function xero(rl) {
                 qs.where = p.where;
             if (p.includeArchived)
                 qs.includeArchived = "true";
-            const data = (await api(getConn(ctx), "GET", "/Contacts", undefined, qs));
+            const data = (await api(ctx, "GET", "Contacts", undefined, qs));
             const contacts = data.Contacts;
             return p.limit ? contacts.slice(0, p.limit) : contacts;
         },
@@ -203,7 +186,7 @@ export default function xero(rl) {
         async execute(input, ctx) {
             const p = input;
             const body = { Contacts: [p.data] };
-            const result = (await api(getConn(ctx), "POST", `/Contacts/${p.contactId}`, body));
+            const result = (await api(ctx, "POST", `Contacts/${pathSegment(p.contactId)}`, body));
             return result.Contacts;
         },
     });

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

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

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

@@ -1,29 +1,19 @@
-function getConn(ctx) {
-    const c = ctx.connection.config;
-    return {
-        url: c.url.replace(/\/$/, ""),
-        signature: c.signature,
-    };
-}
-async function apiRequest(conn, qs) {
-    const url = new URL(`${conn.url}/yourls-api.php`);
-    qs.signature = conn.signature;
-    qs.format = "json";
-    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(`Yourls error ${res.status}: ${await res.text()}`);
-    const data = (await res.json());
+import { answerFailed, credentialJson } from "../../_shared/credentials.js";
+import { yourlsCredential } from "./credentials.js";
+async function apiRequest(ctx, qs) {
+    const data = (await credentialJson(ctx, yourlsCredential, "yourls", {
+        target: "api",
+        path: "yourls-api.php",
+        query: { ...qs, format: "json" },
+    }));
     if (data.status === "fail")
-        throw new Error(`Yourls error: ${data.message}`);
+        throw answerFailed("yourls", { code: data.code, message: data.message });
     return data;
 }
 export default function yourls(rl) {
     rl.setName("yourls");
     rl.setVersion("0.1.0");
+    rl.setCredential(yourlsCredential);
     rl.setConnectionSchema({
         url: {
             type: "string",
@@ -57,7 +47,7 @@ export default function yourls(rl) {
                 qs.keyword = p.keyword;
             if (p.title)
                 qs.title = p.title;
-            return apiRequest(getConn(ctx), qs);
+            return apiRequest(ctx, qs);
         },
     });
     rl.registerAction("url.expand", {
@@ -65,7 +55,7 @@ export default function yourls(rl) {
         description: "Expand a short URL to its original",
         inputSchema: { shortUrl: { type: "string", required: true } },
         async execute(input, ctx) {
-            return apiRequest(getConn(ctx), {
+            return apiRequest(ctx, {
                 action: "expand",
                 shorturl: input.shortUrl,
             });
@@ -76,7 +66,7 @@ export default function yourls(rl) {
         description: "Get stats for a short URL",
         inputSchema: { shortUrl: { type: "string", required: true } },
         async execute(input, ctx) {
-            const data = (await apiRequest(getConn(ctx), {
+            const data = (await apiRequest(ctx, {
                 action: "url-stats",
                 shorturl: input.shortUrl,
             }));

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

@@ -0,0 +1,15 @@
+import { httpsBase, staticCredential } from "../../_shared/credentials.js";
+/** An access token, sent as `Authorization: Token token={token}` to the
+ *  connection's own Zammad instance beneath /api/v1/. The instance URL is
+ *  public config and must be HTTPS. */
+export const zammadCredential = staticCredential({
+    id: "zammad",
+    auth: { kind: "apiKey", header: "Authorization", prefix: "Token token=" },
+    local: { secret: "token" },
+    targets: (config) => ({
+        api: {
+            baseUrl: httpsBase(config.url, "api/v1/"),
+            methods: ["GET", "POST", "PUT", "DELETE"],
+        },
+    }),
+});

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

@@ -1,41 +1,21 @@
-function getConn(ctx) {
-    const c = ctx.connection.config;
-    return {
-        url: c.url.replace(/\/$/, ""),
-        token: c.token,
-    };
-}
-async function api(conn, method, endpoint, body, qs) {
-    const url = new URL(`${conn.url}/api/v1${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 { zammadCredential } from "./credentials.js";
+async function api(ctx, method, endpoint, body, qs) {
+    return credentialJson(ctx, zammadCredential, "zammad", {
+        target: "api",
+        path: endpoint,
         method,
-        headers: {
-            Authorization: `Token token=${conn.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(`Zammad error ${res.status}: ${await res.text()}`);
-    if (res.status === 204)
-        return { success: true };
-    return res.json();
+        query: qs,
+        ...(body && Object.keys(body).length > 0 ? { json: body } : {}),
+    });
 }
-function registerCrud(rl, resource, plural, conn, createSchema) {
+function registerCrud(rl, resource, plural, createSchema) {
     rl.registerAction(`${resource}.create`, {
         access: "write",
         description: `Create a ${resource}`,
         inputSchema: createSchema,
         async execute(input, ctx) {
-            return api(conn(ctx), "POST", `/${plural}`, input);
+            return api(ctx, "POST", plural, input);
         },
     });
     rl.registerAction(`${resource}.get`, {
@@ -43,7 +23,7 @@ function registerCrud(rl, resource, plural, conn, createSchema) {
         description: `Get a ${resource} by ID`,
         inputSchema: { id: { type: "string", required: true } },
         async execute(input, ctx) {
-            return api(conn(ctx), "GET", `/${plural}/${input.id}`);
+            return api(ctx, "GET", `${plural}/${pathSegment(input.id)}`);
         },
     });
     rl.registerAction(`${resource}.list`, {
@@ -53,7 +33,7 @@ function registerCrud(rl, resource, plural, conn, createSchema) {
         async execute(input, ctx) {
             const p = (input ?? {});
             const qs = { per_page: p.limit ?? 100 };
-            return api(conn(ctx), "GET", `/${plural}`, undefined, qs);
+            return api(ctx, "GET", plural, undefined, qs);
         },
     });
     rl.registerAction(`${resource}.update`, {
@@ -65,7 +45,7 @@ function registerCrud(rl, resource, plural, conn, createSchema) {
         },
         async execute(input, ctx) {
             const p = input;
-            return api(conn(ctx), "PUT", `/${plural}/${p.id}`, p.data);
+            return api(ctx, "PUT", `${plural}/${pathSegment(p.id)}`, p.data);
         },
     });
     rl.registerAction(`${resource}.delete`, {
@@ -73,7 +53,7 @@ function registerCrud(rl, resource, plural, conn, createSchema) {
         description: `Delete a ${resource}`,
         inputSchema: { id: { type: "string", required: true } },
         async execute(input, ctx) {
-            await api(conn(ctx), "DELETE", `/${plural}/${input.id}`);
+            await api(ctx, "DELETE", `${plural}/${pathSegment(input.id)}`);
             return { success: true };
         },
     });
@@ -81,6 +61,7 @@ function registerCrud(rl, resource, plural, conn, createSchema) {
 export default function zammad(rl) {
     rl.setName("zammad");
     rl.setVersion("0.1.0");
+    rl.setCredential(zammadCredential);
     rl.setConnectionSchema({
         url: {
             type: "string",
@@ -95,15 +76,15 @@ export default function zammad(rl) {
             env: "ZAMMAD_TOKEN",
         },
     });
-    registerCrud(rl, "user", "users", getConn, {
+    registerCrud(rl, "user", "users", {
         firstname: { type: "string", required: true },
         lastname: { type: "string", required: true },
         email: { type: "string", required: false },
     });
-    registerCrud(rl, "organization", "organizations", getConn, {
+    registerCrud(rl, "organization", "organizations", {
         name: { type: "string", required: true },
     });
-    registerCrud(rl, "group", "groups", getConn, {
+    registerCrud(rl, "group", "groups", {
         name: { type: "string", required: true },
     });
     // ── Ticket (special: includes article) ──────────────
@@ -132,7 +113,7 @@ export default function zammad(rl) {
             };
             if (p.articleSubject)
                 body.article.subject = p.articleSubject;
-            return api(getConn(ctx), "POST", "/tickets", body);
+            return api(ctx, "POST", "tickets", body);
         },
     });
     rl.registerAction("ticket.get", {
@@ -140,10 +121,9 @@ export default function zammad(rl) {
         description: "Get a ticket with articles",
         inputSchema: { id: { type: "string", required: true } },
         async execute(input, ctx) {
-            const c = getConn(ctx);
             const id = input.id;
-            const ticket = (await api(c, "GET", `/tickets/${id}`));
-            ticket.articles = await api(c, "GET", `/ticket_articles/by_ticket/${id}`);
+            const ticket = (await api(ctx, "GET", `tickets/${pathSegment(id)}`));
+            ticket.articles = await api(ctx, "GET", `ticket_articles/by_ticket/${pathSegment(id)}`);
             return ticket;
         },
     });
@@ -155,7 +135,7 @@ export default function zammad(rl) {
             const qs = {
                 per_page: (input ?? {}).limit ?? 100,
             };
-            return api(getConn(ctx), "GET", "/tickets", undefined, qs);
+            return api(ctx, "GET", "tickets", undefined, qs);
         },
     });
     rl.registerAction("ticket.update", {
@@ -167,7 +147,7 @@ export default function zammad(rl) {
         },
         async execute(input, ctx) {
             const p = input;
-            return api(getConn(ctx), "PUT", `/tickets/${p.id}`, p.data);
+            return api(ctx, "PUT", `tickets/${pathSegment(p.id)}`, p.data);
         },
     });
     rl.registerAction("ticket.delete", {
@@ -175,7 +155,7 @@ export default function zammad(rl) {
         description: "Delete a ticket",
         inputSchema: { id: { type: "string", required: true } },
         async execute(input, ctx) {
-            await api(getConn(ctx), "DELETE", `/tickets/${input.id}`);
+            await api(ctx, "DELETE", `tickets/${pathSegment(input.id)}`);
             return { success: true };
         },
     });
@@ -185,7 +165,7 @@ export default function zammad(rl) {
         description: "Get the current user",
         inputSchema: {},
         async execute(_input, ctx) {
-            return api(getConn(ctx), "GET", "/users/me");
+            return api(ctx, "GET", "users/me");
         },
     });
     rl.registerAction("user.search", {
@@ -200,7 +180,7 @@ export default function zammad(rl) {
             const qs = { query: p.query };
             if (p.limit)
                 qs.per_page = p.limit;
-            return api(getConn(ctx), "GET", "/users/search", undefined, qs);
+            return api(ctx, "GET", "users/search", undefined, qs);
         },
     });
 }

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

@@ -0,0 +1,26 @@
+import { hostLabel, staticCredential } from "../../_shared/credentials.js";
+/**
+ * An API token as the Basic password, with the agent email joined to the
+ * fixed /token suffix as the username, on the account's own Zendesk
+ * subdomain.
+ */
+export const zendeskCredential = staticCredential({
+    id: "zendesk",
+    auth: { kind: "basic" },
+    local: {
+        username: { concat: [{ field: "email" }, { value: "/token" }] },
+        password: "apiToken",
+    },
+    targets: (config) => ({
+        api: {
+            baseUrl: `https://${hostLabel(config.subdomain)}.zendesk.com/api/v2/`,
+            methods: ["GET", "POST", "PUT", "DELETE"],
+        },
+    }),
+    probe: {
+        target: "api",
+        path: "users/me.json",
+        method: "GET",
+        acceptedStatuses: [200],
+    },
+});