@pixerate/editor 0.26.1 → 0.28.0

package/dist/{builtins-Chj6zv_O.d.ts → builtins-haN82vjT.d.ts}

@@ -131,7 +131,34 @@ interface ComponentCommandTarget {
     canGoToMainComponent(id?: string): true | string;
     list(): unknown;
     inspect(id?: string): unknown;
+    addVariant?(setId?: string, options?: {
+        from?: string;
+        variant?: Record<string, string>;
+        position?: {
+            x: number;
+            y: number;
+        };
+        defaultValue?: string;
+    }): ComponentActionResult;
+    canAddVariant?(setId?: string, options?: {
+        from?: string;
+        variant?: Record<string, string>;
+    }): true | string;
+    removeVariant?(variantId?: string): ComponentActionResult;
+    canRemoveVariant?(variantId?: string): true | string;
+    setVariantProperties?(values: Record<string, string>, variantId?: string, options?: {
+        defaultValue?: string;
+    }): ComponentActionResult;
+    canSetVariantProperties?(values?: Record<string, string>, variantId?: string): true | string;
+    renameVariantProperty?(name: string, newName: string, setId?: string): ComponentActionResult;
+    canRenameVariantProperty?(name?: string, newName?: string, setId?: string): true | string;
+    renameVariantValue?(property: string, value: string, newValue: string, setId?: string): ComponentActionResult;
+    canRenameVariantValue?(property?: string, value?: string, newValue?: string, setId?: string): true | string;
 }
+/** The variant-editing part of a `ComponentCommandTarget` (present on the components controller). */
+type VariantCommandTarget = Required<Pick<ComponentCommandTarget, 'addVariant' | 'canAddVariant' | 'removeVariant' | 'canRemoveVariant' | 'setVariantProperties' | 'canSetVariantProperties' | 'renameVariantProperty' | 'canRenameVariantProperty' | 'renameVariantValue' | 'canRenameVariantValue'>>;
+/** Whether a command target can edit variants. */
+declare function hasVariantCommands(controller: ComponentCommandTarget): controller is ComponentCommandTarget & VariantCommandTarget;
 interface ComponentCommandOptions {
     /** Id prefix (default `canvas.`). */
     prefix?: string;
@@ -145,8 +172,11 @@ interface ComponentCommandOptions {
  * (`{ componentId, parentId?, x?, y?, properties? }`), `canvas.detachInstance`,
  * `canvas.resetOverrides` (`{ id?, group? }`), `canvas.pushOverrides`, `canvas.goToMainComponent`,
  * `canvas.swapInstance` (`{ componentId, ids? }`), `canvas.setInstanceProperties`
- * (`{ properties, ids? }`: variant and component property values), `canvas.restoreMainComponent`
- * and the read-only `canvas.listComponents` / `canvas.inspectInstance`. Each action is one
+ * (`{ properties, ids? }`: variant and component property values), `canvas.restoreMainComponent`,
+ * the variant editors `canvas.addVariant` (`{ setId?, from?, variant?, x?, y? }`),
+ * `canvas.removeVariant` (`{ id? }`), `canvas.setVariantProperties` (`{ values, id? }`),
+ * `canvas.renameVariantProperty` (`{ name, newName, setId? }`) and `canvas.renameVariantValue`
+ * (`{ property, value, newValue, setId? }`) when the target has them, and the read-only `canvas.listComponents` / `canvas.inspectInstance`. Each action is one
  * undoable step when the controller has a history; enablement explains why it cannot run.
  */
 declare function createComponentCommands(controller: ComponentCommandTarget, options?: ComponentCommandOptions): CommandSpec[];
@@ -173,4 +203,4 @@ interface SpreadsheetCommandOptions {
 /** Palette / agent commands for common spreadsheet table actions (no default shortcuts). */
 declare function createSpreadsheetCommands(controller: SpreadsheetCommandTarget, options?: SpreadsheetCommandOptions): CommandSpec[];
 
-export { type ArrangeCommandOptions as A, type ComponentCommandOptions as C, DEFAULT_HISTORY_SHORTCUTS as D, type HistoryCommandOptions as H, type ShapeCommandOptions as S, type ArrangeCommandTarget as a, type ComponentCommandTarget as b, type HistoryCommandTarget as c, type ShapeCommandTarget as d, type SpreadsheetCommandOptions as e, type SpreadsheetCommandTarget as f, createArrangeCommands as g, createComponentCommands as h, createHistoryCommands as i, createShapeCommands as j, createSpreadsheetCommands as k, matchHistoryShortcut as m };
+export { type ArrangeCommandOptions as A, type ComponentCommandOptions as C, DEFAULT_HISTORY_SHORTCUTS as D, type HistoryCommandOptions as H, type ShapeCommandOptions as S, type ArrangeCommandTarget as a, type ComponentCommandTarget as b, type HistoryCommandTarget as c, type ShapeCommandTarget as d, type SpreadsheetCommandOptions as e, type SpreadsheetCommandTarget as f, createArrangeCommands as g, createComponentCommands as h, createHistoryCommands as i, createShapeCommands as j, createSpreadsheetCommands as k, hasVariantCommands as l, matchHistoryShortcut as m };

package/dist/{builtins-CdPcLwwF.d.cts → builtins-nMXh9sT3.d.cts}

@@ -131,7 +131,34 @@ interface ComponentCommandTarget {
     canGoToMainComponent(id?: string): true | string;
     list(): unknown;
     inspect(id?: string): unknown;
+    addVariant?(setId?: string, options?: {
+        from?: string;
+        variant?: Record<string, string>;
+        position?: {
+            x: number;
+            y: number;
+        };
+        defaultValue?: string;
+    }): ComponentActionResult;
+    canAddVariant?(setId?: string, options?: {
+        from?: string;
+        variant?: Record<string, string>;
+    }): true | string;
+    removeVariant?(variantId?: string): ComponentActionResult;
+    canRemoveVariant?(variantId?: string): true | string;
+    setVariantProperties?(values: Record<string, string>, variantId?: string, options?: {
+        defaultValue?: string;
+    }): ComponentActionResult;
+    canSetVariantProperties?(values?: Record<string, string>, variantId?: string): true | string;
+    renameVariantProperty?(name: string, newName: string, setId?: string): ComponentActionResult;
+    canRenameVariantProperty?(name?: string, newName?: string, setId?: string): true | string;
+    renameVariantValue?(property: string, value: string, newValue: string, setId?: string): ComponentActionResult;
+    canRenameVariantValue?(property?: string, value?: string, newValue?: string, setId?: string): true | string;
 }
+/** The variant-editing part of a `ComponentCommandTarget` (present on the components controller). */
+type VariantCommandTarget = Required<Pick<ComponentCommandTarget, 'addVariant' | 'canAddVariant' | 'removeVariant' | 'canRemoveVariant' | 'setVariantProperties' | 'canSetVariantProperties' | 'renameVariantProperty' | 'canRenameVariantProperty' | 'renameVariantValue' | 'canRenameVariantValue'>>;
+/** Whether a command target can edit variants. */
+declare function hasVariantCommands(controller: ComponentCommandTarget): controller is ComponentCommandTarget & VariantCommandTarget;
 interface ComponentCommandOptions {
     /** Id prefix (default `canvas.`). */
     prefix?: string;
@@ -145,8 +172,11 @@ interface ComponentCommandOptions {
  * (`{ componentId, parentId?, x?, y?, properties? }`), `canvas.detachInstance`,
  * `canvas.resetOverrides` (`{ id?, group? }`), `canvas.pushOverrides`, `canvas.goToMainComponent`,
  * `canvas.swapInstance` (`{ componentId, ids? }`), `canvas.setInstanceProperties`
- * (`{ properties, ids? }`: variant and component property values), `canvas.restoreMainComponent`
- * and the read-only `canvas.listComponents` / `canvas.inspectInstance`. Each action is one
+ * (`{ properties, ids? }`: variant and component property values), `canvas.restoreMainComponent`,
+ * the variant editors `canvas.addVariant` (`{ setId?, from?, variant?, x?, y? }`),
+ * `canvas.removeVariant` (`{ id? }`), `canvas.setVariantProperties` (`{ values, id? }`),
+ * `canvas.renameVariantProperty` (`{ name, newName, setId? }`) and `canvas.renameVariantValue`
+ * (`{ property, value, newValue, setId? }`) when the target has them, and the read-only `canvas.listComponents` / `canvas.inspectInstance`. Each action is one
  * undoable step when the controller has a history; enablement explains why it cannot run.
  */
 declare function createComponentCommands(controller: ComponentCommandTarget, options?: ComponentCommandOptions): CommandSpec[];
@@ -173,4 +203,4 @@ interface SpreadsheetCommandOptions {
 /** Palette / agent commands for common spreadsheet table actions (no default shortcuts). */
 declare function createSpreadsheetCommands(controller: SpreadsheetCommandTarget, options?: SpreadsheetCommandOptions): CommandSpec[];
 
-export { type ArrangeCommandOptions as A, type ComponentCommandOptions as C, DEFAULT_HISTORY_SHORTCUTS as D, type HistoryCommandOptions as H, type ShapeCommandOptions as S, type ArrangeCommandTarget as a, type ComponentCommandTarget as b, type HistoryCommandTarget as c, type ShapeCommandTarget as d, type SpreadsheetCommandOptions as e, type SpreadsheetCommandTarget as f, createArrangeCommands as g, createComponentCommands as h, createHistoryCommands as i, createShapeCommands as j, createSpreadsheetCommands as k, matchHistoryShortcut as m };
+export { type ArrangeCommandOptions as A, type ComponentCommandOptions as C, DEFAULT_HISTORY_SHORTCUTS as D, type HistoryCommandOptions as H, type ShapeCommandOptions as S, type ArrangeCommandTarget as a, type ComponentCommandTarget as b, type HistoryCommandTarget as c, type ShapeCommandTarget as d, type SpreadsheetCommandOptions as e, type SpreadsheetCommandTarget as f, createArrangeCommands as g, createComponentCommands as h, createHistoryCommands as i, createShapeCommands as j, createSpreadsheetCommands as k, hasVariantCommands as l, matchHistoryShortcut as m };