@plurnk/plurnk-web 0.0.0-stage → 1.0.0

package/ai.plurnk/static-assets.js

@@ -0,0 +1,40 @@
+import { readFile } from "node:fs/promises";
+import Negotiator from "negotiator";
+import { RequestError } from "./http.js";
+
+/** @typedef {[string, string, string, Record<string, string>]} AssetEntry */
+
+/** {§web-asset-encoding} Load all declared representations before admitting requests.
+ * @param {string} file @param {string} mediaType @param {Record<string, string>} encoded
+ */
+export async function readAsset(file, mediaType, encoded) {
+    const body = await readFile(new URL(`dist/${file}`, import.meta.url));
+    const variants = await Promise.all(Object.entries(encoded).map(async ([encoding, path]) =>
+        /** @type {const} */ ([encoding, await readFile(new URL(`dist/${path}`, import.meta.url))])));
+    const representations = new Map([["identity", body], ...variants]);
+    const preferred = [...representations].toSorted(([, a], [, b]) => a.byteLength - b.byteLength).map(([encoding]) => encoding);
+    return { body, mediaType, representations, preferred };
+}
+
+/** {§web-asset-encoding} No response wrapper: only admitted static resources reach this path.
+ * @param {import("node:http").IncomingMessage} req
+ * @param {import("node:http").ServerResponse} res
+ * @param {Awaited<ReturnType<typeof readAsset>>} asset
+ */
+export function sendAsset(req, res, asset) {
+    res.appendHeader("vary", "Accept-Encoding");
+    const negotiator = new Negotiator(req);
+    // Published typings omit the documented same-quality preference option.
+    const choose = /** @type {(available: string[], options: { preferred: string[] }) => string | undefined} */ (negotiator.encoding);
+    const encoding = choose.call(negotiator, asset.preferred, { preferred: asset.preferred });
+    if (encoding === undefined) throw new RequestError(406, "No acceptable content encoding.");
+    const body = asset.representations.get(encoding);
+    if (body === undefined) throw new Error("Negotiated an undeclared asset representation.");
+    res.writeHead(200, {
+        "content-type": asset.mediaType.startsWith("text/") ? `${asset.mediaType}; charset=utf-8` : asset.mediaType,
+        "content-length": body.byteLength,
+        "x-content-type-options": "nosniff",
+        ...(encoding === "identity" ? {} : { "content-encoding": encoding }),
+    });
+    res.end(req.method === "HEAD" ? undefined : body);
+}

package/package.json

@@ -1,6 +1,93 @@
 {
-  "name": "@plurnk/plurnk-web",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+    "name": "@plurnk/plurnk-web",
+    "version": "1.0.0",
+    "description": "Plurnk daemon module serving an OTM document.",
+    "type": "module",
+    "license": "MIT",
+    "engines": {
+        "node": ">=26"
+    },
+    "homepage": "https://github.com/plurnk/plurnk-web#readme",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/plurnk/plurnk-web.git"
+    },
+    "bugs": {
+        "url": "https://repo.possumtech.com/plurnk/plurnk-web/issues"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "files": [
+        "plugin.json",
+        "ai.plurnk/module.js",
+        "ai.plurnk/index-document.js",
+        "ai.plurnk/directory-addresses.js",
+        "ai.plurnk/creations.js",
+        "ai.plurnk/documents.js",
+        "ai.plurnk/session.js",
+        "ai.plurnk/http.js",
+        "ai.plurnk/static-assets.js",
+        "ai.plurnk/diagrams.js",
+        "ai.plurnk/diagram-compiler.js",
+        "ai.plurnk/.env.defaults",
+        "ai.plurnk/assets.json",
+        "ai.plurnk/dist/",
+        "README.md",
+        "SPEC.md",
+        "LICENSE"
+    ],
+    "dependencies": {
+        "@plurnk/plurnk-meta": "^2.1.6",
+        "negotiator": "1.1.0",
+        "oauth4webapi": "3.8.8",
+        "ondine": "0.0.1",
+        "piscina": "5.3.2"
+    },
+    "peerDependencies": {
+        "@plurnk/plurnk-acp": "^1.3.1",
+        "@plurnk/plurnk-auth": "^1.0.1",
+        "@plurnk/plurnk-contracts": "^7.2.1",
+        "@plurnk/plurnk-modules": "^4.1.1"
+    },
+    "devDependencies": {
+        "@agentclientprotocol/sdk": "2.4.0",
+        "@eslint/js": "10.0.1",
+        "@fullhuman/postcss-purgecss": "8.0.0",
+        "@picocss/pico": "2.1.1",
+        "@plurnk/plurnk-spec-check": "0.2.0",
+        "@types/negotiator": "0.6.5",
+        "@types/node": "^26.1.1",
+        "@xterm/headless": "6.0.0",
+        "dompurify": "3.4.17",
+        "eslint": "10.12.0",
+        "eslint-plugin-no-unsanitized": "4.1.5",
+        "globals": "17.13.0",
+        "marked": "18.1.1",
+        "marked-footnote": "1.4.0",
+        "node-pty": "1.1.0",
+        "on_the_money": "0.11.0",
+        "playwright": "1.64.0",
+        "stylelint": "17.16.0",
+        "stylelint-config-standard": "40.0.0",
+        "temml": "0.14.0",
+        "typescript": "^7.0.2",
+        "vite": "8.3.4",
+        "zod": "3.25.76"
+    },
+    "allowScripts": {
+        "node-pty@1.1.0": true
+    },
+    "scripts": {
+        "dev": "node scripts/assets.mjs && vite",
+        "build": "node scripts/build.mjs",
+        "preview": "vite preview",
+        "test:lint": "plurnk-spec-check && tsc && tsc -p tsconfig.browser.json && tsc -p tsconfig.test.json && eslint . && otm-lint --check web && stylelint 'web/styles/*.css'",
+        "test:unit": "node --env-file=ai.plurnk/.env.defaults --test test/module.test.js test/creations.test.js test/workspace-creation.test.js test/route-settlement.test.js test/diagrams.test.js test/build.test.js test/development.test.js test/authoring.test.js test/directory-addresses.test.js test/session.test.js test/token.test.js test/documents.test.js test/session-status.test.js test/history-pages.test.js test/conversation.test.js test/package.test.js",
+        "test:installation": "node --test test/installation.test.js",
+        "test:candidate": "node scripts/test-candidate.mjs",
+        "test": "npm run build && npm run test:lint && npm run test:unit",
+        "prepack": "npm run build",
+        "prepublishOnly": "npm test"
+    }
+}

package/plugin.json

@@ -0,0 +1,13 @@
+{
+    "$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
+    "name": "plurnk-web",
+    "version": "1.0.0",
+    "description": "Serve an OTM document through the Plurnk daemon's HTTP listener.",
+    "license": "MIT",
+    "extensions": {
+        "ai.plurnk": {
+            "kind": "module",
+            "module": "ai.plurnk/module.js"
+        }
+    }
+}