@moloodev/editor-sdk 0.9.0 → 0.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moloodev/editor-sdk",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "type": "module",
   "exports": {
     ".": "./src/view.ts",
@@ -29,8 +29,8 @@
     "y-protocols": "^1.0.7",
     "yjs": "^13.6.32",
     "zod": "^4.5.4",
-    "@moloodev/platform": "0.9.0",
-    "@moloodev/ui": "0.9.0"
+    "@moloodev/platform": "0.10.0",
+    "@moloodev/ui": "0.10.0"
   },
   "peerDependencies": {
     "react": "^19.0.0",
@@ -48,7 +48,7 @@
     "react-dom": "^19.2.8",
     "tsx": "^4.23.13",
     "typescript": "^7.0.2",
-    "@moloodev/typescript-config": "0.9.0"
+    "@moloodev/typescript-config": "0.10.0"
   },
   "publishConfig": {
     "access": "public"

package/src/index.ts

@@ -207,7 +207,12 @@ export type EditorResponse<Type extends EditorRequestType = EditorRequestType> =
   | EditorSuccess<Type>
   | EditorFailure;
 
+export type EditorSettingValue = boolean | number | string;
+export type EditorSettingsValues = Record<string, EditorSettingValue>;
+
 export type EditorEvent =
+  | { v: 1; type: "settings.snapshot"; body: { values: EditorSettingsValues } }
+  | { v: 1; type: "settings.changed"; body: { values: EditorSettingsValues } }
   | { v: 1; type: "file.import"; body: { name: string; data: string } }
   | { v: 1; type: "session"; body: EditorSession }
   | { v: 1; type: "access"; body: EditorAccess }

package/src/message-samples.ts

@@ -313,6 +313,8 @@ export const session = {
 } satisfies EditorSession;
 
 export const events = {
+  "settings.snapshot": { v: 1, type: "settings.snapshot", body: { values: { "notes.indent": 2 } } },
+  "settings.changed": { v: 1, type: "settings.changed", body: { values: { "notes.indent": 4 } } },
   "file.import": { v: 1, type: "file.import", body: { name: "notes.md", data: "" } },
   session: {
     v: 1,

package/src/protocol-entry.ts

@@ -14,6 +14,8 @@ export type {
   EditorRevision,
   EditorSession,
   EditorSessionAsset,
+  EditorSettingValue,
+  EditorSettingsValues,
   EditorSuccess,
   Json,
 } from "./index";

package/src/protocol.ts

@@ -125,6 +125,10 @@ const themeSchema = z.strictObject({
   theme: z.enum(["dark", "light"]),
 });
 
+const settingsSchema = z.strictObject({
+  values: z.record(z.string(), z.union([z.boolean(), z.number(), z.string()])),
+});
+
 const commandIdSchema = z.string().min(1);
 
 const commandInvokeBodySchema = z.strictObject({
@@ -319,6 +323,8 @@ const handshakeReplySchema = z.discriminatedUnion("ok", [
 export type HandshakeReply = z.infer<typeof handshakeReplySchema>;
 
 export const editorEventSchema = z.discriminatedUnion("type", [
+  z.strictObject({ v: z.literal(1), type: z.literal("settings.snapshot"), body: settingsSchema }),
+  z.strictObject({ v: z.literal(1), type: z.literal("settings.changed"), body: settingsSchema }),
   z.strictObject({
     v: z.literal(1),
     type: z.literal("file.import"),

package/src/view/hooks.ts

@@ -9,6 +9,7 @@ import type {
   EditorRevision,
   EditorSession,
   EditorSessionAsset,
+  EditorSettingValue,
 } from "../index";
 
 export type { EditorAsset, EditorSessionAsset, EditorLayoutValues } from "../index";
@@ -30,6 +31,7 @@ export type EditorOpenBrowserArgs = {
 };
 
 export type EditorViewBinding = {
+  useEditorSetting(key: string): EditorSettingValue | undefined;
   useTheme(): { theme: "dark" | "light" };
   useKind(type: string): { id: string; label: string; color: string; icon: string };
   useKinds(): { id: string; label: string; color: string; icon: string }[];
@@ -136,6 +138,10 @@ export function useTheme() {
   return useBinding("useTheme").useTheme();
 }
 
+export function useEditorSetting(key: string): EditorSettingValue | undefined {
+  return useBinding("useEditorSetting").useEditorSetting(key);
+}
+
 export function useKind(type: string) {
   return useBinding("useKind").useKind(type);
 }

package/src/view/port-binding.ts

@@ -57,6 +57,9 @@ function createPortBinding(view: EditorView, acceptedTypes: readonly string[]):
   }
 
   return {
+    useEditorSetting(key) {
+      return useSyncExternalStore(view.onSettingsChange, () => view.getSetting(key), () => view.getSetting(key));
+    },
     useTheme() {
       const theme = useSnapshot().theme ?? "dark";
       return useMemo(() => ({ theme }), [theme]);

package/src/view.ts

@@ -25,10 +25,14 @@ import type {
   EditorRequestType,
   EditorResponse,
   EditorSession,
+  EditorSettingValue,
+  EditorSettingsValues,
 } from "./index";
 import { EDITOR_IMPORT_BYTES_MAX, parseEditorId, type ChromeManifest } from "./protocol";
 import { editorPort } from "./view/port";
 
+export type { EditorSettingValue, EditorSettingsValues } from "./index";
+
 export type EditorViewSnapshot = {
   session: EditorSession | null;
   access: EditorAccess | null;
@@ -59,6 +63,8 @@ export type EditorView = {
   subscribe(listener: () => void): () => void;
   onImportFile(listener: (file: File) => void): () => void;
   onCommand(listener: (commandId: string) => void): () => void;
+  getSetting(key: string): EditorSettingValue | undefined;
+  onSettingsChange(listener: (values: Readonly<EditorSettingsValues>) => void): () => void;
   sendCommandState(state: CommandStateBody): boolean;
   sendShortcut(body: ShortcutBody): boolean;
   close(): void;
@@ -124,6 +130,8 @@ export function connectEditorView(deps: EditorViewDeps): EditorView {
   const importFileListeners = new Set<(file: File) => void>();
   const pendingImportFiles: File[] = [];
   const commandListeners = new Set<(commandId: string) => void>();
+  let settings: Readonly<EditorSettingsValues> = {};
+  const settingsListeners = new Set<(values: Readonly<EditorSettingsValues>) => void>();
   let submitted: SubmittedChrome | null = null;
   let stopped = false;
   let channel: EditorChannel | undefined;
@@ -158,6 +166,12 @@ export function connectEditorView(deps: EditorViewDeps): EditorView {
   function onEvent(event: EditorEvent) {
     if (stopped) return;
     switch (event.type) {
+      case "settings.snapshot":
+      case "settings.changed": {
+        settings = Object.freeze(event.body.values);
+        for (const listener of [...settingsListeners]) listener(settings);
+        return;
+      }
       case "file.import": {
         const bytes = fromBase64(event.body.data);
         if (bytes.byteLength > EDITOR_IMPORT_BYTES_MAX) return;
@@ -281,6 +295,14 @@ export function connectEditorView(deps: EditorViewDeps): EditorView {
         commandListeners.delete(listener);
       };
     },
+    getSetting(key) {
+      return Object.hasOwn(settings, key) ? settings[key] : undefined;
+    },
+    onSettingsChange(listener) {
+      if (stopped) return () => {};
+      settingsListeners.add(listener);
+      return () => { settingsListeners.delete(listener); };
+    },
     sendCommandState(state) {
       if (!submitted?.commandIds.has(state.id)) return false;
       return channel?.emit({ v: 1, type: "command.state", body: state }) ?? false;
@@ -300,6 +322,7 @@ export function connectEditorView(deps: EditorViewDeps): EditorView {
       doc.off("update", onDocUpdate);
       listeners.clear();
       commandListeners.clear();
+      settingsListeners.clear();
       importFileListeners.clear();
       pendingImportFiles.length = 0;
       channel?.close();