@lovision/plugin-dev 1.0.0

package/dist/templates/review-submitter/src/main.ts.template

@@ -0,0 +1,306 @@
+import { definePlugin } from "@lovision/plugin-sdk";
+
+type Vec2 = {
+  x: number;
+  y: number;
+};
+
+type Size = {
+  height: number;
+  width: number;
+};
+
+type SceneNodeSnapshot = {
+  children: SceneNodeSnapshot[];
+  id: string;
+  name: string;
+  parentId: string | null;
+  position: Vec2;
+  size: Size;
+  type: string;
+};
+
+type SceneSnapshot = {
+  root: SceneNodeSnapshot;
+  version: number;
+};
+
+type ContextSnapshot = {
+  project?: ContextEntity | null;
+  takenAt: number;
+  user?: ContextEntity | null;
+  workspace?: ContextEntity | null;
+};
+
+type ContextEntity = {
+  displayName?: string;
+  id: string;
+  role?: string;
+};
+
+type BinaryResourceRef = {
+  byteLength: number;
+  createdAt: number;
+  id: string;
+  kind: string;
+  mimeType: string;
+  name?: string;
+};
+
+type WorkflowSubmissionResult = {
+  id: string;
+  kind: string;
+  receipt?: unknown;
+  status: "accepted" | "queued" | "submitted";
+  submittedAt: number;
+  target: string;
+  url?: string;
+};
+
+type ReviewContext = {
+  context: {
+    current(params?: {
+      include?: Array<"project" | "user" | "workspace">;
+    }): Promise<ContextSnapshot>;
+  };
+  document: {
+    snapshot(): Promise<SceneSnapshot>;
+  };
+  export: {
+    screenshot(params?: {
+      background?: "current" | "transparent" | "white";
+      fileName?: string;
+      format?: "jpeg" | "png" | "webp";
+      nodeIds?: string[];
+      quality?: number;
+      scale?: number;
+    }): Promise<BinaryResourceRef>;
+  };
+  notify: {
+    send(
+      message: string,
+      options?: { kind?: "error" | "info" | "success" | "warning" },
+    ): Promise<void>;
+  };
+  selection: {
+    get(): Promise<string[]>;
+  };
+  workflow: {
+    submit(params: {
+      artifacts?: Array<{ resource: BinaryResourceRef; role?: string }>;
+      idempotencyKey?: string;
+      kind: string;
+      payload: unknown;
+      target: string;
+    }): Promise<WorkflowSubmissionResult>;
+  };
+};
+
+type ReviewDraft = {
+  context: ContextSnapshot;
+  nodeCount: number;
+  screenshot: BinaryResourceRef;
+  selectedIds: string[];
+  snapshotVersion: number;
+};
+
+type ReviewMessage =
+  | {
+      type: "captured";
+      payload: ReviewDraftSummary;
+    }
+  | {
+      type: "error";
+      payload: {
+        message: string;
+      };
+    }
+  | {
+      type: "ready";
+      payload: {
+        message: string;
+      };
+    }
+  | {
+      type: "submitted";
+      payload: {
+        draft: ReviewDraftSummary;
+        submission: WorkflowSubmissionResult;
+      };
+    };
+
+type ReviewDraftSummary = {
+  context: ContextSnapshot;
+  nodeCount: number;
+  screenshot: {
+    byteLength: number;
+    id: string;
+    mimeType: string;
+  };
+  selectedCount: number;
+  snapshotVersion: number;
+};
+
+definePlugin({
+  apiVersion: "1.0",
+  version: "0.1.0",
+  command: async (ctx) => {
+    const session = await ctx.ui.show({
+      mode: "modal",
+      entry: "./ui.html",
+      title: "Review Submitter",
+      width: 560,
+      height: 480,
+    });
+
+    let closed = false;
+    let latestDraft: ReviewDraft | null = null;
+    const postToUi = async (message: ReviewMessage): Promise<void> => {
+      if (closed) return;
+      await session.postMessage(message);
+    };
+    const modalClosed = new Promise<void>((resolve) => {
+      session.on("close", () => {
+        closed = true;
+        void ctx.notify.send("Review Submitter closed.", { kind: "info" });
+        resolve();
+      });
+    });
+
+    session.on("capture-review", async () => {
+      await handleUiAction(postToUi, async () => {
+        latestDraft = await captureReviewDraft(ctx);
+        await postToUi({
+          type: "captured",
+          payload: summarizeDraft(latestDraft),
+        });
+      });
+    });
+
+    session.on("submit-review", async () => {
+      await handleUiAction(postToUi, async () => {
+        const draft = latestDraft ?? (await captureReviewDraft(ctx));
+        latestDraft = draft;
+        const submission = await submitReview(ctx, draft);
+        await postToUi({
+          type: "submitted",
+          payload: {
+            draft: summarizeDraft(draft),
+            submission,
+          },
+        });
+        await ctx.notify.send(
+          `Review Submitter submitted ${submission.id}.`,
+          { kind: "success" },
+        );
+      });
+    });
+
+    await postToUi({
+      type: "ready",
+      payload: {
+        message:
+          "Ready. Capture the current context, then submit a review workflow.",
+      },
+    });
+
+    await modalClosed;
+    return { closed: true, ok: true };
+  },
+});
+
+async function handleUiAction(
+  postToUi: (message: ReviewMessage) => Promise<void>,
+  action: () => Promise<unknown>,
+): Promise<void> {
+  try {
+    await action();
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error);
+    await postToUi({ type: "error", payload: { message } });
+  }
+}
+
+async function captureReviewDraft(ctx: ReviewContext): Promise<ReviewDraft> {
+  const [snapshot, selectedIds, context] = await Promise.all([
+    ctx.document.snapshot(),
+    ctx.selection.get(),
+    ctx.context.current({ include: ["user", "workspace"] }),
+  ]);
+  const screenshotNodeIds =
+    selectedIds.length > 0 ? selectedIds : resolveFirstCanvasNodeId(snapshot);
+  const screenshot = await ctx.export.screenshot({
+    background: "current",
+    fileName: "review-snapshot.png",
+    format: "png",
+    nodeIds: screenshotNodeIds,
+  });
+
+  return {
+    context,
+    nodeCount: collectNodes(snapshot.root).filter(
+      (node) => node.id !== snapshot.root.id,
+    ).length,
+    screenshot,
+    selectedIds,
+    snapshotVersion: snapshot.version,
+  };
+}
+
+function resolveFirstCanvasNodeId(snapshot: SceneSnapshot): string[] {
+  const first = collectNodes(snapshot.root).find(
+    (node) => node.id !== snapshot.root.id,
+  );
+  if (!first) {
+    throw new Error("Review Submitter needs at least one canvas node.");
+  }
+  return [first.id];
+}
+
+async function submitReview(
+  ctx: ReviewContext,
+  draft: ReviewDraft,
+): Promise<WorkflowSubmissionResult> {
+  return await ctx.workflow.submit({
+    target: "review.submit",
+    kind: "design-review",
+    payload: {
+      context: {
+        userId: draft.context.user?.id ?? null,
+        userName: draft.context.user?.displayName ?? null,
+        workspaceId: draft.context.workspace?.id ?? null,
+        workspaceName: draft.context.workspace?.displayName ?? null,
+      },
+      nodeCount: draft.nodeCount,
+      selectedCount: draft.selectedIds.length,
+      snapshotVersion: draft.snapshotVersion,
+    },
+    artifacts: [{ role: "screenshot", resource: draft.screenshot }],
+    idempotencyKey: `review-${draft.snapshotVersion}-${draft.screenshot.id}`,
+  });
+}
+
+function summarizeDraft(draft: ReviewDraft): ReviewDraftSummary {
+  return {
+    context: draft.context,
+    nodeCount: draft.nodeCount,
+    screenshot: {
+      byteLength: draft.screenshot.byteLength,
+      id: draft.screenshot.id,
+      mimeType: draft.screenshot.mimeType,
+    },
+    selectedCount: draft.selectedIds.length,
+    snapshotVersion: draft.snapshotVersion,
+  };
+}
+
+function collectNodes(
+  node: SceneNodeSnapshot,
+  out: SceneNodeSnapshot[] = [],
+): SceneNodeSnapshot[] {
+  out.push(node);
+  for (const child of node.children) {
+    collectNodes(child, out);
+  }
+  return out;
+}

package/dist/templates/review-submitter/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "lib": ["ESNext", "WebWorker"],
+    "module": "Preserve",
+    "moduleResolution": "bundler",
+    "target": "ESNext",
+    "strict": true,
+    "skipLibCheck": true,
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true
+  },
+  "include": ["src/**/*"]
+}

package/dist/templates/review-submitter/ui.html.template

@@ -0,0 +1,114 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title>Review Submitter</title>
+    <style>
+      :root {
+        color-scheme: light dark;
+      }
+
+      body {
+        margin: 0;
+        color: CanvasText;
+        background: Canvas;
+      }
+
+      main {
+        display: grid;
+        gap: 1rem;
+        padding: 1rem;
+      }
+
+      .actions {
+        display: flex;
+        flex-wrap: wrap;
+        gap: 0.5rem;
+      }
+
+      .status {
+        min-height: 1.5rem;
+      }
+
+      pre {
+        max-height: 16rem;
+        overflow: auto;
+        padding: 0.75rem;
+        color: CanvasText;
+        background: Canvas;
+        border: 1px solid ButtonBorder;
+      }
+    </style>
+  </head>
+  <body>
+    <main>
+      <header>
+        <h1>Review Submitter</h1>
+        <p>Capture context and submit a host workflow review.</p>
+      </header>
+
+      <div class="actions">
+        <button id="capture-button" type="button">Capture review snapshot</button>
+        <button id="submit-button" type="button">Submit review</button>
+      </div>
+
+      <p id="status" class="status" role="status">Waiting for host...</p>
+      <pre id="details" aria-label="Review details"></pre>
+    </main>
+
+    <script>
+      const uiId = globalThis.__LOVISION_PLUGIN_UI_ID__;
+      const status = document.getElementById("status");
+      const details = document.getElementById("details");
+
+      function post(type, payload) {
+        parent.postMessage(
+          {
+            type: "plugin-ui-message",
+            direction: "ui-to-main",
+            uiId,
+            message: { type, payload },
+          },
+          "*",
+        );
+      }
+
+      document.getElementById("capture-button").addEventListener("click", () => {
+        status.textContent = "Capturing review snapshot...";
+        details.textContent = "";
+        post("capture-review", {});
+      });
+
+      document.getElementById("submit-button").addEventListener("click", () => {
+        status.textContent = "Submitting review...";
+        post("submit-review", {});
+      });
+
+      window.addEventListener("message", (event) => {
+        const envelope = event.data;
+        if (
+          !envelope ||
+          envelope.type !== "plugin-ui-message" ||
+          envelope.direction !== "main-to-ui" ||
+          envelope.uiId !== uiId
+        ) {
+          return;
+        }
+
+        const message = envelope.message;
+        if (message.type === "ready") {
+          status.textContent = message.payload.message;
+        } else if (message.type === "captured") {
+          status.textContent = "Captured review snapshot.";
+          details.textContent = JSON.stringify(message.payload, null, 2);
+        } else if (message.type === "submitted") {
+          status.textContent = `Submitted review ${message.payload.submission.id} (${message.payload.submission.status}).`;
+          details.textContent = JSON.stringify(message.payload, null, 2);
+        } else if (message.type === "error") {
+          status.textContent = message.payload.message;
+        }
+      });
+    </script>
+  </body>
+</html>

package/dist/validate.d.ts

@@ -0,0 +1,8 @@
+import { type ToolDiagnostic } from "./shared.js";
+export type ValidationReport = {
+    diagnostics: readonly ToolDiagnostic[];
+    ok: boolean;
+};
+export declare function validatePluginProject(projectRoot?: string): Promise<ValidationReport>;
+export declare function validateBundleFile(bundlePath: string): Promise<ValidationReport>;
+//# sourceMappingURL=validate.d.ts.map

package/dist/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,KAAK,cAAc,EAEpB,MAAM,aAAa,CAAC;AAErB,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,EAAE,SAAS,cAAc,EAAE,CAAC;IACvC,EAAE,EAAE,OAAO,CAAC;CACb,CAAC;AAEF,wBAAsB,qBAAqB,CACzC,WAAW,SAAgB,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAmB3B;AAED,wBAAsB,kBAAkB,CACtC,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,gBAAgB,CAAC,CAiB3B"}

package/dist/validate.js

@@ -0,0 +1,42 @@
+import { readFile } from "node:fs/promises";
+import { loadBundle } from "@lovision/plugin-host";
+import { buildPluginBundle } from "./build.js";
+import { manifestDiagnosticToToolDiagnostic, ToolingError, } from "./shared.js";
+export async function validatePluginProject(projectRoot = process.cwd()) {
+    try {
+        const built = await buildPluginBundle({
+            projectRoot,
+            write: false,
+        });
+        return {
+            diagnostics: built.warnings,
+            ok: true,
+        };
+    }
+    catch (error) {
+        if (error instanceof ToolingError) {
+            return {
+                diagnostics: error.diagnostics,
+                ok: false,
+            };
+        }
+        throw error;
+    }
+}
+export async function validateBundleFile(bundlePath) {
+    const input = await readFile(bundlePath, "utf8");
+    const result = loadBundle(input);
+    if (!result.ok) {
+        return {
+            diagnostics: result.errors
+                .map(manifestDiagnosticToToolDiagnostic)
+                .concat(result.warnings.map(manifestDiagnosticToToolDiagnostic)),
+            ok: false,
+        };
+    }
+    return {
+        diagnostics: result.warnings.map(manifestDiagnosticToToolDiagnostic),
+        ok: true,
+    };
+}
+//# sourceMappingURL=validate.js.map

package/dist/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EACL,kCAAkC,EAElC,YAAY,GACb,MAAM,aAAa,CAAC;AAOrB,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,WAAW,GAAG,OAAO,CAAC,GAAG,EAAE;IAE3B,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,iBAAiB,CAAC;YACpC,WAAW;YACX,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;QACH,OAAO;YACL,WAAW,EAAE,KAAK,CAAC,QAAQ;YAC3B,EAAE,EAAE,IAAI;SACT,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,YAAY,EAAE,CAAC;YAClC,OAAO;gBACL,WAAW,EAAE,KAAK,CAAC,WAAW;gBAC9B,EAAE,EAAE,KAAK;aACV,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,UAAkB;IAElB,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IAEjC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO;YACL,WAAW,EAAE,MAAM,CAAC,MAAM;iBACvB,GAAG,CAAC,kCAAkC,CAAC;iBACvC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;YAClE,EAAE,EAAE,KAAK;SACV,CAAC;IACJ,CAAC;IAED,OAAO;QACL,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,kCAAkC,CAAC;QACpE,EAAE,EAAE,IAAI;KACT,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@lovision/plugin-dev",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "plugin-dev": "./dist/cli.js",
+    "create-instinct-plugin": "./dist/create-plugin.js"
+  },
+  "files": [
+    "README.md",
+    "dist/**"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/choice-form/instinct.git",
+    "directory": "packages/plugin-dev"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "bun": ">=1.3.0"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.build.json && bun ../../scripts/rewrite-dts-extensions.ts dist && cp -R src/templates dist/templates",
+    "prepack": "bun run build",
+    "test": "bun run --filter @lovision/plugin-spec build && bun run --filter @lovision/plugin-host build && bun run --filter @lovision/plugin-sdk build && bun run build && bun test src/toolchain.test.ts src/package-surface.test.ts",
+    "lint:types": "bun run --filter @lovision/plugin-spec build && bun run --filter @lovision/plugin-host build && tsc -b"
+  },
+  "dependencies": {
+    "@lovision/plugin-host": "1.0.0",
+    "@lovision/plugin-spec": "1.0.0"
+  },
+  "devDependencies": {
+    "bun-types": "^1.3.9"
+  }
+}