initiative-plugin-sdk 2.0.0

package/dist/pack.js

@@ -0,0 +1,84 @@
+/**
+ * `initiative-plugin pack`: the plug-in as one listing file, the file a self-hosted
+ * deployment publishes as its own plug-in.
+ *
+ * The listing file is the shape a deployment's listing upload
+ * (`POST /api/v1/marketplace/local/upload`, as `{"manifest": <file>}`) and its
+ * catalog directory (`MARKETPLACE_EXTRA_CATALOG_DIR`) read: what the catalogue
+ * shows, this version's manifest as its `definition`, and its registration.
+ * The manifest is the one `build` makes, checked the same way.
+ *
+ * The listing's picture is named by the path the deployment keeps it under,
+ * which is the SHA-256 of its bytes, so it is uploaded beside the file
+ * (`POST /api/v1/marketplace/local/media`). A deployment keeps PNG, JPEG, GIF
+ * and WebP; any other picture is left out, and the listing shows the
+ * deployment's default mark.
+ */
+import { createHash } from "node:crypto";
+import { readFileSync, writeFileSync } from "node:fs";
+import { relative, resolve } from "node:path";
+import { bundler, compile, registrationOf } from "./build.js";
+/** Where a deployment serves the pictures uploaded for its listings. */
+const MEDIA_PATH = "/api/v1/marketplace/media/";
+const KEPT_PICTURES = /\.(png|jpe?g|gif|webp)$/i;
+/** The listing file for a plug-in whose manifest `compile` made. */
+export function listingFile(plugin, manifest, root) {
+    const listing = plugin.listing;
+    if (!listing)
+        throw new Error("pack needs the plug-in's listing: declare `listing` in its definition");
+    const avatar = KEPT_PICTURES.test(listing.avatar) ? readFileSync(resolve(root, listing.avatar)) : null;
+    // A deployment honours reference sectors only from a registry.
+    const { reference_sectors: _sectors, ...registration } = registrationOf(plugin);
+    return {
+        avatar,
+        listing: {
+            uid: plugin.uid,
+            public_id: plugin.publicId,
+            kind: "plugin",
+            name: plugin.name,
+            publisher: listing.publisher,
+            description: listing.summary,
+            ...(listing.description !== undefined ? { long_description: listing.description } : {}),
+            ...(avatar ? { avatar_url: `${MEDIA_PATH}${createHash("sha256").update(avatar).digest("hex")}` } : {}),
+            version: listing.version,
+            ...(listing.minAppVersion !== undefined ? { min_app_version: listing.minAppVersion } : {}),
+            ...(listing.releaseNotes !== undefined ? { release_notes: listing.releaseNotes } : {}),
+            definition: manifest,
+            registration,
+        },
+    };
+}
+/** Write the plug-in's listing file. Answers the process's exit code. */
+export async function pack(options) {
+    const esbuild = await bundler("pack");
+    if (!esbuild)
+        return 1;
+    const root = resolve(options.root);
+    const compiled = await compile(esbuild, root, options.plugin);
+    if (compiled.problems) {
+        for (const problem of compiled.problems)
+            process.stderr.write(`${problem}\n`);
+        return 1;
+    }
+    const { plugin } = compiled;
+    let packed;
+    try {
+        packed = listingFile(plugin, compiled.manifest, root);
+    }
+    catch (error) {
+        process.stderr.write(`${error.message}\n`);
+        return 1;
+    }
+    const { avatar: picture, version } = plugin.listing;
+    const path = resolve(root, options.out ?? `${plugin.publicId}-${version}.json`);
+    writeFileSync(path, `${JSON.stringify(packed.listing, null, 2)}\n`);
+    process.stdout.write([
+        `wrote ${relative(process.cwd(), path)}: ${plugin.publicId} ${version}, uid ${plugin.uid}`,
+        packed.avatar
+            ? `upload it with its picture, ${picture}, or run initiative-plugin dev --initiative <url> to do both`
+            : `${picture} is not PNG, JPEG, GIF or WebP, so the listing shows the deployment's default mark`,
+        "",
+    ].join("\n"));
+    return 0;
+}
+//# sourceMappingURL=pack.js.map

package/dist/pack.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pack.js","sourceRoot":"","sources":["../src/pack.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAE9C,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAa9D,wEAAwE;AACxE,MAAM,UAAU,GAAG,4BAA4B,CAAC;AAChD,MAAM,aAAa,GAAG,0BAA0B,CAAC;AAQjD,oEAAoE;AACpE,MAAM,UAAU,WAAW,CAAC,MAAiB,EAAE,QAAkB,EAAE,IAAY;IAC7E,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAC/B,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;IACvG,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACvG,+DAA+D;IAC/D,MAAM,EAAE,iBAAiB,EAAE,QAAQ,EAAE,GAAG,YAAY,EAAE,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAChF,OAAO;QACL,MAAM;QACN,OAAO,EAAE;YACP,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,SAAS,EAAE,MAAM,CAAC,QAAQ;YAC1B,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,WAAW,EAAE,OAAO,CAAC,OAAO;YAC5B,GAAG,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACvF,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,GAAG,UAAU,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACtG,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,GAAG,CAAC,OAAO,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1F,GAAG,CAAC,OAAO,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACtF,UAAU,EAAE,QAAQ;YACpB,YAAY;SACb;KACF,CAAC;AACJ,CAAC;AAED,yEAAyE;AACzE,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAAoB;IAC7C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IACtC,IAAI,CAAC,OAAO;QAAE,OAAO,CAAC,CAAC;IACvB,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9D,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACtB,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,QAAQ;YAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC;QAC9E,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC;IAC5B,IAAI,MAAc,CAAC;IACnB,IAAI,CAAC;QACH,MAAM,GAAG,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACxD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAI,KAAe,CAAC,OAAO,IAAI,CAAC,CAAC;QACtD,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,OAAQ,CAAC;IACrD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,MAAM,CAAC,QAAQ,IAAI,OAAO,OAAO,CAAC,CAAC;IAChF,aAAa,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IACpE,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB;QACE,SAAS,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,KAAK,MAAM,CAAC,QAAQ,IAAI,OAAO,SAAS,MAAM,CAAC,GAAG,EAAE;QAC1F,MAAM,CAAC,MAAM;YACX,CAAC,CAAC,+BAA+B,OAAO,8DAA8D;YACtG,CAAC,CAAC,GAAG,OAAO,oFAAoF;QAClG,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;IACF,OAAO,CAAC,CAAC;AACX,CAAC"}