@joycostudio/studio 0.1.4 → 0.1.6

package/dist/client.d.ts

@@ -1,6 +1,12 @@
 import { DebugSchema, DebugFolder } from '@joycostudio/xyz/debug';
 import { f as StudioTool, T as ToolDefinition, j as ToolState, R as Result, i as ToolReference } from './protocol-DjrMADPm.js';
 
+type Change = {
+    path: string[];
+    before: unknown;
+    after: unknown;
+};
+
 type Connection = {
     phase: 'local';
 } | {
@@ -15,7 +21,7 @@ type ToolHandle<TConfig extends object = any> = {
     readonly definition: ToolDefinition<TConfig>;
     /** The live config. Writes sync to same-origin pages and, when connected, the runtime. */
     readonly config: TConfig;
-    /** Runtime-owned state; null until the runtime answers (always null without one). */
+    /** Runtime-owned state; null while no runtime is connected or until it answers. */
     readonly state: ToolState<TConfig> | null;
     /** Bumps on every config change. Handy as a React snapshot. */
     readonly version: number;
@@ -25,10 +31,12 @@ type ToolHandle<TConfig extends object = any> = {
     controls(): DebugSchema;
     /** Xyz `Debuggable`: `debugManager.register(handle)` mounts this tool in the app's floating pane. */
     debug(): DebugFolder;
-    /** The config on disk: the runtime's saved value or, until one answers, the bundled `initial`. */
+    /** The config on disk: the runtime's last reported saved value or, until one answers, the bundled `initial`. */
     readonly saved: TConfig;
     /** Dotted paths where the draft differs from `saved`. Tracked locally, so it works without a runtime too. */
     readonly changes: string[];
+    /** Each leaf where the draft differs from `saved`: `before` is the saved value, `after` the draft's. */
+    readonly diff: Change[];
     /** The draft differs from `saved`. */
     readonly dirty: boolean;
     /** True while `compare(true)` shows the saved config in place of the draft. */
@@ -47,10 +55,25 @@ type ToolHandle<TConfig extends object = any> = {
      */
     undo(): boolean;
     redo(): boolean;
+    /** Persist the draft. Needs a connected runtime. */
     save(options?: {
         force?: boolean;
     }): Promise<Result<ToolState<TConfig>>>;
-    discard(): Promise<Result<ToolState<TConfig>>>;
+    /**
+     * Reset the draft to `saved`, with or without a runtime, then sync it like any other edit.
+     * Undoable as its own step. Returns false when there is nothing to discard.
+     */
+    discard(): boolean;
+    /**
+     * Reset one changed leaf (a dotted path from `changes`, or its keys, which also address keys containing dots) to its saved value, then sync it like any
+     * other edit. Undoable as its own step. Returns false when that leaf is unchanged or while comparing.
+     */
+    revert(path: string | readonly string[]): boolean;
+    /**
+     * A link to `base` (the current page by default) carrying the draft. Opening it on another machine applies
+     * that draft as an unsaved, undoable edit; a draft that no longer fits the tool's controls is ignored.
+     */
+    shareUrl(base?: string | URL): string;
 };
 type Studio = {
     /** Every registered tool in order, including preview-only ones. */
@@ -78,4 +101,4 @@ declare function postCompare(target: Window | null | undefined, tool: string, sh
 declare function everyFrame(refresh: () => void): () => void;
 declare function createStudio(config: StudioOptions, options?: Pick<StudioOptions, 'runtime'>): Studio;
 
-export { type Connection, type Studio, type StudioOptions, type ToolHandle, createStudio, everyFrame, postCompare };
+export { type Change, type Connection, type Studio, type StudioOptions, type ToolHandle, createStudio, everyFrame, postCompare };

package/dist/client.js

@@ -2,7 +2,7 @@ import {
   createStudio,
   everyFrame,
   postCompare
-} from "./chunk-2RGQF5X5.js";
+} from "./chunk-6KZJEKOL.js";
 import "./chunk-DEJYGBPJ.js";
 export {
   createStudio,

package/dist/next.js

@@ -1,6 +1,6 @@
 import {
   createStudio
-} from "./chunk-2RGQF5X5.js";
+} from "./chunk-6KZJEKOL.js";
 import "./chunk-DEJYGBPJ.js";
 
 // src/next.ts

package/dist/react.d.ts

@@ -3,6 +3,12 @@ import { ComponentType, ComponentPropsWithRef, ReactNode, ComponentPropsWithoutR
 import { DebugSchema, DebugFolder } from '@joycostudio/xyz/debug';
 import { Select } from '@base-ui/react/select';
 
+type Change = {
+    path: string[];
+    before: unknown;
+    after: unknown;
+};
+
 type Success<T> = {
     ok: true;
     data: T;
@@ -93,7 +99,7 @@ type ToolHandle<TConfig extends object = any> = {
     readonly definition: ToolDefinition<TConfig>;
     /** The live config. Writes sync to same-origin pages and, when connected, the runtime. */
     readonly config: TConfig;
-    /** Runtime-owned state; null until the runtime answers (always null without one). */
+    /** Runtime-owned state; null while no runtime is connected or until it answers. */
     readonly state: ToolState<TConfig> | null;
     /** Bumps on every config change. Handy as a React snapshot. */
     readonly version: number;
@@ -103,10 +109,12 @@ type ToolHandle<TConfig extends object = any> = {
     controls(): DebugSchema;
     /** Xyz `Debuggable`: `debugManager.register(handle)` mounts this tool in the app's floating pane. */
     debug(): DebugFolder;
-    /** The config on disk: the runtime's saved value or, until one answers, the bundled `initial`. */
+    /** The config on disk: the runtime's last reported saved value or, until one answers, the bundled `initial`. */
     readonly saved: TConfig;
     /** Dotted paths where the draft differs from `saved`. Tracked locally, so it works without a runtime too. */
     readonly changes: string[];
+    /** Each leaf where the draft differs from `saved`: `before` is the saved value, `after` the draft's. */
+    readonly diff: Change[];
     /** The draft differs from `saved`. */
     readonly dirty: boolean;
     /** True while `compare(true)` shows the saved config in place of the draft. */
@@ -125,10 +133,25 @@ type ToolHandle<TConfig extends object = any> = {
      */
     undo(): boolean;
     redo(): boolean;
+    /** Persist the draft. Needs a connected runtime. */
     save(options?: {
         force?: boolean;
     }): Promise<Result<ToolState<TConfig>>>;
-    discard(): Promise<Result<ToolState<TConfig>>>;
+    /**
+     * Reset the draft to `saved`, with or without a runtime, then sync it like any other edit.
+     * Undoable as its own step. Returns false when there is nothing to discard.
+     */
+    discard(): boolean;
+    /**
+     * Reset one changed leaf (a dotted path from `changes`, or its keys, which also address keys containing dots) to its saved value, then sync it like any
+     * other edit. Undoable as its own step. Returns false when that leaf is unchanged or while comparing.
+     */
+    revert(path: string | readonly string[]): boolean;
+    /**
+     * A link to `base` (the current page by default) carrying the draft. Opening it on another machine applies
+     * that draft as an unsaved, undoable edit; a draft that no longer fits the tool's controls is ignored.
+     */
+    shareUrl(base?: string | URL): string;
 };
 type Studio$1 = {
     /** Every registered tool in order, including preview-only ones. */