@moloodev/editor-sdk 0.0.0-stage → 0.2.0

package/src/message-samples.ts

@@ -0,0 +1,377 @@
+import type { BundleConfirm, Composition, Publication } from "@moloodev/platform";
+import type {
+  EditorAccess,
+  EditorAsset,
+  EditorEvent,
+  EditorFailure,
+  EditorRequest,
+  EditorRevision,
+  EditorSession,
+  EditorSuccess,
+} from "./index";
+
+export const asset = {
+  id: "asset-1",
+  name: "Note",
+  type: "moloo.markdown",
+  path: "/Note",
+  epoch: 3,
+  headRevision: 2,
+  updatedAt: "2026-09-30T00:00:00.000Z",
+  contentBytes: 12,
+  locked: false,
+  lockHeld: false,
+  trashed: false,
+} satisfies EditorAsset;
+
+const revision = {
+  id: "rev-1",
+  assetId: "asset-1",
+  revision: 2,
+  message: "Pin note",
+  contentBytes: 12,
+  createdAt: "2026-09-30T00:00:00.000Z",
+} satisfies EditorRevision;
+
+export const publication = {
+  visibility: "private",
+} satisfies Publication;
+
+export const composition = {
+  bundleId: "bundle-1",
+  bundleName: "Pack",
+  bundleEpoch: 1,
+  bundleUpdatedAt: "2026-09-30T00:00:00.000Z",
+  headRevision: 2,
+  entries: {
+    "asset-1": { inclusion: "direct", revision: 1, type: "moloo.markdown" },
+  },
+  members: [
+    {
+      assetId: "asset-1",
+      name: "Note",
+      path: "/Note",
+      type: "moloo.markdown",
+      inclusion: "direct",
+      via: null,
+      selected: 1,
+      previous: null,
+      latest: 1,
+      locked: false,
+      size: 12,
+    },
+  ],
+  refs: [],
+  previousMembers: [],
+  previousRefs: [],
+  added: ["asset-1"],
+  removed: [],
+  issues: [],
+  reviewed: "rev-1",
+  totalBytes: 12,
+  deltaBytes: 12,
+} satisfies Composition;
+
+const confirmed = {
+  composition,
+  revision: 4,
+} satisfies BundleConfirm;
+
+export const requests = {
+  "asset.rename": { v: 1, id: "rename-1", type: "asset.rename", body: { name: "notes" } },
+  "asset.read": { v: 1, id: "read-1", type: "asset.read", body: { id: "asset-1" } },
+  "layout.load": { v: 1, id: "layout-load-1", type: "layout.load", body: {} },
+  "layout.save": { v: 1, id: "layout-save-1", type: "layout.save", body: { layout: { panels: { body: { visible: true, size: "50%" } } } } },
+  "asset.list": {
+    v: 1,
+    id: "list-1",
+    type: "asset.list",
+    body: { type: "moloo.markdown" },
+  },
+  "asset.listRevisions": {
+    v: 1,
+    id: "revisions-1",
+    type: "asset.listRevisions",
+    body: { id: "asset-1" },
+  },
+  "asset.getComposition": {
+    v: 1,
+    id: "composition-1",
+    type: "asset.getComposition",
+    body: { id: "bundle-1" },
+  },
+  "asset.getPublication": {
+    v: 1,
+    id: "publication-get-1",
+    type: "asset.getPublication",
+    body: { id: "bundle-1" },
+  },
+  "asset.confirmBundle": {
+    v: 1,
+    id: "confirm-1",
+    type: "asset.confirmBundle",
+    body: { id: "bundle-1", message: "Publish pack", reviewed: "rev-1" },
+  },
+  "asset.putPublication": {
+    v: 1,
+    id: "publication-put-1",
+    type: "asset.putPublication",
+    body: { id: "bundle-1", publication },
+  },
+  "host.pick": {
+    v: 1,
+    id: "pick-1",
+    type: "host.pick",
+    body: {
+      acceptedTypes: ["moloo.markdown"],
+      excludeTypes: ["moloo.folder"],
+      excludeIds: ["asset-1"],
+    },
+  },
+  "host.openAsset": {
+    v: 1,
+    id: "open-asset-1",
+    type: "host.openAsset",
+    body: { id: "asset-1", type: "moloo.markdown" },
+  },
+  "host.openInfo": {
+    v: 1,
+    id: "open-info-1",
+    type: "host.openInfo",
+    body: { id: "asset-1" },
+  },
+  "host.start": {
+    v: 1,
+    id: "start-1",
+    type: "host.start",
+    body: {},
+  },
+  "host.openBrowser": {
+    v: 1,
+    id: "browser-1",
+    type: "host.openBrowser",
+    body: {},
+  },
+  "host.clipboardWrite": { v: 1, id: "clipboard-1", type: "host.clipboardWrite", body: { text: "hello" } },
+  "host.download": { v: 1, id: "download-1", type: "host.download", body: { filename: "note.md", mimeType: "text/markdown;charset=utf-8", content: { kind: "text", text: "hello" } } },
+  "host.openPopup": { v: 1, id: "popup-1", type: "host.openPopup", body: { url: "https://example.com/" } },
+  "host.render": {
+    v: 1,
+    id: "render-1",
+    type: "host.render",
+    body: {
+      format: "pdf",
+      document: {
+        version: 1,
+        blocks: [{ type: "paragraph", inlines: [{ type: "text", text: "Hello" }] }],
+      },
+      name: "Note",
+    },
+  },
+  "doc.append": {
+    v: 1,
+    id: "append-1",
+    type: "doc.append",
+    body: { assetId: asset.id, update: "AA==" },
+  },
+  "chrome.submit": {
+    v: 1,
+    id: "chrome-1",
+    type: "chrome.submit",
+    body: {
+      contributes: {
+        commands: [{ id: "editor.undo", title: "Undo" }],
+        menus: [{ path: ["edit"], commandId: "editor.undo" }],
+        keybindings: [{ commandId: "editor.undo", key: "Mod+Z" }],
+      },
+      layout: {
+        root: "body",
+        elements: {
+          body: {
+            type: "Panel",
+            props: { contentId: "body" },
+          },
+          back: {
+            type: "ToolbarButton",
+            props: { commandId: "editor.undo", icon: "arrow-back-up" },
+          },
+        },
+      },
+      titles: { body: "Body" },
+    },
+  },
+} satisfies { [Type in EditorRequest["type"]]: Extract<EditorRequest, { type: Type }> };
+
+export const successes = {
+  "asset.rename": { v: 1, id: "rename-1", ok: true, body: { name: "notes" } },
+  "asset.read": { v: 1, id: "read-1", ok: true, body: { asset, payload: { body: "Note" }, fileUrl: null } },
+  "layout.load": { v: 1, id: "layout-load-1", ok: true, body: { layout: { panels: { body: { visible: true, size: "50%" } } } } },
+  "layout.save": { v: 1, id: "layout-save-1", ok: true, body: {} },
+  "asset.list": {
+    v: 1,
+    id: "list-1",
+    ok: true,
+    body: [asset],
+  },
+  "asset.listRevisions": {
+    v: 1,
+    id: "revisions-1",
+    ok: true,
+    body: [revision],
+  },
+  "asset.getComposition": {
+    v: 1,
+    id: "composition-1",
+    ok: true,
+    body: composition,
+  },
+  "asset.getPublication": {
+    v: 1,
+    id: "publication-get-1",
+    ok: true,
+    body: publication,
+  },
+  "asset.confirmBundle": {
+    v: 1,
+    id: "confirm-1",
+    ok: true,
+    body: confirmed,
+  },
+  "asset.putPublication": {
+    v: 1,
+    id: "publication-put-1",
+    ok: true,
+    body: publication,
+  },
+  "host.pick": {
+    v: 1,
+    id: "pick-1",
+    ok: true,
+    body: { cancelled: false, assets: [asset] },
+  },
+  "host.openAsset": {
+    v: 1,
+    id: "open-asset-1",
+    ok: true,
+    body: {},
+  },
+  "host.openInfo": {
+    v: 1,
+    id: "open-info-1",
+    ok: true,
+    body: {},
+  },
+  "host.start": {
+    v: 1,
+    id: "start-1",
+    ok: true,
+    body: {},
+  },
+  "host.openBrowser": {
+    v: 1,
+    id: "browser-1",
+    ok: true,
+    body: {},
+  },
+  "host.clipboardWrite": { v: 1, id: "clipboard-1", ok: true, body: {} },
+  "host.download": { v: 1, id: "download-1", ok: true, body: {} },
+  "host.openPopup": { v: 1, id: "popup-1", ok: true, body: {} },
+  "host.render": { v: 1, id: "render-1", ok: true, body: { url: "https://example.com/Note.pdf?download=1" } },
+  "doc.append": {
+    v: 1,
+    id: "append-1",
+    ok: true,
+    body: {},
+  },
+  "chrome.submit": {
+    v: 1,
+    id: "chrome-1",
+    ok: true,
+    body: {},
+  },
+} satisfies { [Type in EditorRequest["type"]]: EditorSuccess<Type> };
+
+export const cancelledPick = {
+  v: 1,
+  id: "pick-1",
+  ok: true,
+  body: { cancelled: true },
+} satisfies EditorSuccess<"host.pick">;
+
+export const failure = {
+  v: 1,
+  id: "pick-1",
+  ok: false,
+  code: "version",
+} satisfies EditorFailure;
+
+export const session = {
+  asset: { id: asset.id, type: asset.type, name: asset.name },
+  mode: "edit",
+  data: { text: "hello" },
+  syncStatus: "live",
+} satisfies EditorSession;
+
+export const events = {
+  "file.import": { v: 1, type: "file.import", body: { name: "notes.md", data: "" } },
+  session: {
+    v: 1,
+    type: "session",
+    body: session,
+  },
+  access: {
+    v: 1,
+    type: "access",
+    body: { canManage: true },
+  },
+  theme: {
+    v: 1,
+    type: "theme",
+    body: { theme: "dark" },
+  },
+  "doc.update": {
+    v: 1,
+    type: "doc.update",
+    body: { assetId: asset.id, update: "AA==" },
+  },
+  "host.createRequested": {
+    v: 1,
+    type: "host.createRequested",
+  },
+  "command.invoke": {
+    v: 1,
+    type: "command.invoke",
+    body: { commandId: "editor.copy" },
+  },
+  "command.shortcut": {
+    v: 1,
+    type: "command.shortcut",
+    body: { key: "Mod+Z", commandId: "editor.undo" },
+  },
+  "command.state": {
+    v: 1,
+    type: "command.state",
+    body: {
+      id: "editor.copy",
+      visible: true,
+      disabled: false,
+      pressed: false,
+      label: "Copy",
+    },
+  },
+} satisfies { [Type in EditorEvent["type"]]: Extract<EditorEvent, { type: Type }> };
+
+export const idleSession = {
+  v: 1,
+  type: "session",
+  body: {
+    asset: null,
+    mode: "idle",
+    data: null,
+    syncStatus: "offline",
+  },
+} satisfies Extract<EditorEvent, { type: "session" }>;
+
+export const access = {
+  canManage: false,
+} satisfies EditorAccess;

package/src/origin-headers.ts

@@ -0,0 +1,57 @@
+import { getWorkspaceHostUrl } from "@moloodev/platform";
+
+type EditorOriginDroppedHeader =
+  | "set-cookie"
+  | "service-worker-allowed";
+
+export type EditorOriginHeaderPolicy = {
+  readonly "content-security-policy": string;
+  readonly "x-content-type-options": "nosniff";
+  readonly drop: readonly EditorOriginDroppedHeader[];
+};
+
+export function editorOriginHeaders(input: {
+  readonly parent: string | null;
+  readonly verifiedOrigins: readonly string[];
+}): EditorOriginHeaderPolicy {
+  return {
+    "content-security-policy": `sandbox allow-scripts; frame-ancestors ${frameAncestor(input.parent, input.verifiedOrigins)}; font-src https://ui.moloo.dev`,
+    "x-content-type-options": "nosniff",
+    drop: ["set-cookie", "service-worker-allowed"],
+  };
+}
+
+export function allowedFrameAncestor(
+  parent: string | null,
+  verifiedOrigins: readonly string[],
+): string | null {
+  if (parent !== null && isBareOrigin(parent) && allowed(parent, verifiedOrigins)) {
+    return parent;
+  }
+  return null;
+}
+
+function frameAncestor(
+  parent: string | null,
+  verifiedOrigins: readonly string[],
+): string {
+  return allowedFrameAncestor(parent, verifiedOrigins) ?? "'none'";
+}
+
+function allowed(parent: string, verifiedOrigins: readonly string[]): boolean {
+  if (
+    parent === getWorkspaceHostUrl("production") ||
+    parent === getWorkspaceHostUrl("development")
+  ) {
+    return true;
+  }
+  return verifiedOrigins.includes(parent);
+}
+
+function isBareOrigin(value: string): boolean {
+  try {
+    return new URL(value).origin === value;
+  } catch {
+    return false;
+  }
+}

package/src/print/index.ts

@@ -0,0 +1,10 @@
+export { inspectPrint } from "./inspect";
+export {
+  PRINT_BYTES_MAX,
+  PRINT_SCHEMA_VERSION,
+  documentSchema,
+  type Block,
+  type Inline,
+  type Mark,
+  type PrintDocument,
+} from "./schema";

package/src/print/inspect.ts

@@ -0,0 +1,16 @@
+import { PRINT_BYTES_MAX, documentSchema, type PrintDocument } from "./schema";
+
+type Inspection =
+  | { ok: true; document: PrintDocument }
+  | { ok: false; code: "invalid" | "too-large" };
+
+const utf8 = new TextEncoder();
+
+export function inspectPrint(value: unknown): Inspection {
+  const parsed = documentSchema.safeParse(value);
+  if (!parsed.success) return { ok: false, code: "invalid" };
+  if (utf8.encode(JSON.stringify(parsed.data)).byteLength > PRINT_BYTES_MAX) {
+    return { ok: false, code: "too-large" };
+  }
+  return { ok: true, document: parsed.data };
+}

package/src/print/schema.ts

@@ -0,0 +1,122 @@
+import { z } from "zod";
+
+export const PRINT_SCHEMA_VERSION = 1;
+
+/** UTF-8 byte length of `JSON.stringify` of the document. */
+export const PRINT_BYTES_MAX = 4 * 1024 * 1024;
+
+export type Mark = "bold" | "italic" | "strike" | "code";
+
+export type Inline =
+  | { type: "text"; text: string; marks?: Mark[] }
+  | {
+      type: "link";
+      href: string;
+      inlines: (
+        | { type: "text"; text: string; marks?: Mark[] }
+        | { type: "break" }
+      )[];
+    }
+  | { type: "break" };
+
+export type Block =
+  | { type: "heading"; level: 1 | 2 | 3 | 4 | 5 | 6; inlines: Inline[] }
+  | { type: "paragraph"; inlines: Inline[] }
+  | {
+      type: "list";
+      ordered: boolean;
+      items: { checked?: boolean; inlines: Inline[] }[];
+    }
+  | { type: "quote"; inlines: Inline[] }
+  | { type: "code"; text: string }
+  | { type: "table"; rows: { cells: Inline[][] }[] }
+  | { type: "rule" };
+
+export type PrintDocument = {
+  version: typeof PRINT_SCHEMA_VERSION;
+  blocks: Block[];
+};
+
+const markSchema: z.ZodType<Mark> = z.enum([
+  "bold",
+  "italic",
+  "strike",
+  "code",
+]);
+
+const headingLevelSchema: z.ZodType<1 | 2 | 3 | 4 | 5 | 6> = z.union([
+  z.literal(1),
+  z.literal(2),
+  z.literal(3),
+  z.literal(4),
+  z.literal(5),
+  z.literal(6),
+]);
+
+const textSchema = z.strictObject({
+  type: z.literal("text"),
+  text: z.string(),
+  marks: z.array(markSchema).exactOptional(),
+});
+
+const breakSchema = z.strictObject({
+  type: z.literal("break"),
+});
+
+const inlineSchema: z.ZodType<Inline> = z.discriminatedUnion("type", [
+  textSchema,
+  z.strictObject({
+    type: z.literal("link"),
+    href: z.string().regex(/^(https|http|mailto):/i),
+    inlines: z.array(z.discriminatedUnion("type", [textSchema, breakSchema])),
+  }),
+  breakSchema,
+]);
+
+const inlinesSchema = z.array(inlineSchema);
+
+const blockSchema: z.ZodType<Block> = z.discriminatedUnion("type", [
+  z.strictObject({
+    type: z.literal("heading"),
+    level: headingLevelSchema,
+    inlines: inlinesSchema,
+  }),
+  z.strictObject({
+    type: z.literal("paragraph"),
+    inlines: inlinesSchema,
+  }),
+  z.strictObject({
+    type: z.literal("list"),
+    ordered: z.boolean(),
+    items: z.array(
+      z.strictObject({
+        checked: z.boolean().exactOptional(),
+        inlines: inlinesSchema,
+      }),
+    ),
+  }),
+  z.strictObject({
+    type: z.literal("quote"),
+    inlines: inlinesSchema,
+  }),
+  z.strictObject({
+    type: z.literal("code"),
+    text: z.string(),
+  }),
+  z.strictObject({
+    type: z.literal("table"),
+    rows: z.array(
+      z.strictObject({
+        cells: z.array(inlinesSchema),
+      }),
+    ),
+  }),
+  z.strictObject({
+    type: z.literal("rule"),
+  }),
+]);
+
+export const documentSchema: z.ZodType<PrintDocument> = z.strictObject({
+  version: z.literal(PRINT_SCHEMA_VERSION),
+  blocks: z.array(blockSchema),
+});

package/src/protocol-entry.ts

@@ -0,0 +1,19 @@
+export * from "./protocol";
+export * from "./channel";
+export { editorFrameAttributes } from "./frame-attributes";
+export type {
+  EditorAccess,
+  EditorAsset,
+  EditorEvent,
+  EditorFailure,
+  EditorLayoutValues,
+  EditorOperation,
+  EditorRequest,
+  EditorRequestType,
+  EditorResponse,
+  EditorRevision,
+  EditorSession,
+  EditorSessionAsset,
+  EditorSuccess,
+  Json,
+} from "./index";