@vormio/plugin-sdk 0.0.0-stage → 0.0.5

package/dist/runtime.js

@@ -0,0 +1,84 @@
+/** The host bridge; throws outside a Vormio plugin page. */
+export function bridge() {
+    const host = globalThis.vormio;
+    if (!host)
+        throw new Error('This page is not running inside Vormio');
+    return host;
+}
+const statuses = {
+    400: 'out-of-bounds',
+    403: 'unauthorized',
+    429: 'over-limit',
+    404: 'missing',
+    409: 'changed',
+};
+/**
+ * Reads a file next to the input, relative to the input's folder (`../` may move up within the
+ * linked folder). The host allows only extensions the contribution declares.
+ */
+export async function readCompanion(input, relativePath) {
+    const url = new URL(relativePath, input.url).href;
+    let response;
+    try {
+        response = await fetch(url);
+    }
+    catch {
+        return { status: 'unavailable', url };
+    }
+    if (response.ok)
+        return { status: 'ok', url, bytes: await response.arrayBuffer() };
+    return { status: statuses[response.status] ?? 'unavailable', url };
+}
+/** Reads the input's own bytes. */
+export async function readInput(input) {
+    const response = await fetch(input.url);
+    if (!response.ok)
+        throw new Error(`The file could not be read (${response.status})`);
+    return response.arrayBuffer();
+}
+/**
+ * Runs a viewer: `show` is called for the first input and again whenever the host moves to another
+ * file, with the previous call's signal aborted. Resolving reports ready; throwing reports the
+ * error message.
+ */
+export function viewer(show) {
+    const host = bridge();
+    let current;
+    const run = async (input) => {
+        current?.abort();
+        const controller = new AbortController();
+        current = controller;
+        try {
+            await show(input, controller.signal);
+            if (!controller.signal.aborted)
+                host.ready(input);
+        }
+        catch (error) {
+            if (!controller.signal.aborted)
+                host.fail(input, error instanceof Error ? error.message : String(error));
+        }
+    };
+    host.onInput((input) => void run(input));
+    void host.getInput().then(run);
+}
+/** Runs a thumbnail provider; a canvas is converted to PNG. */
+export function thumbnail(render) {
+    bridge().onThumbnailRequest(async (input, size) => {
+        const result = await render(input, size);
+        let blob;
+        if (result instanceof Blob)
+            blob = result;
+        else if ('convertToBlob' in result)
+            blob = await result.convertToBlob({ type: 'image/png' });
+        else
+            blob = await new Promise((resolve, reject) => result.toBlob((png) => (png ? resolve(png) : reject(new Error('The canvas is empty'))), 'image/png'));
+        return blob.arrayBuffer();
+    });
+}
+/**
+ * Runs an analyzer: `analyze` is called once per request and returns the composition report of
+ * the input. Throwing reports the analysis as failed with the error message.
+ */
+export function analyzer(analyze) {
+    bridge().onAnalyzeRequest(analyze);
+}

package/package.json

@@ -1,6 +1,44 @@
 {
   "name": "@vormio/plugin-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.5",
+  "description": "Manifest schema, runtime helpers and packaging for Vormio plugins.",
+  "license": "MIT",
+  "keywords": [
+    "vormio",
+    "plugin",
+    "sdk"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./node": {
+      "types": "./dist/node/index.d.ts",
+      "default": "./dist/node/index.js"
+    },
+    "./bridge": {
+      "types": "./dist/bridge.d.ts",
+      "default": "./dist/bridge.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=24.21.0"
+  },
+  "dependencies": {
+    "zod": "^4.6.6"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "vormio-plugin": "./dist/node/cli.js"
+  }
 }