microboard-temp 0.14.18 → 0.14.19

package/dist/types/Overlay/IconPack.d.ts

@@ -0,0 +1,4 @@
+import type { OverlayIcon } from "./OverlayMetadata";
+export declare const OVERLAY_ICON_SPRITE_PATH = "src/Overlay/overlay-icons.svg";
+export declare function overlaySymbolIcon(key: string): OverlayIcon;
+export declare function overlayAssetIcon(path: string): OverlayIcon;

package/dist/types/Overlay/OverlayMetadata.d.ts

@@ -6,6 +6,33 @@ export type OverlayValueSource = {
     kind: "toolProperty";
     property: string;
 };
+export type OverlayCondition = {
+    kind: "equals";
+    source: OverlayValueSource;
+    value: unknown;
+} | {
+    kind: "truthy";
+    source: OverlayValueSource;
+} | {
+    kind: "falsy";
+    source: OverlayValueSource;
+} | {
+    kind: "itemTypeIn";
+    itemTypes: string[];
+} | {
+    kind: "selectionSize";
+    min?: number;
+    max?: number;
+} | {
+    kind: "allOf";
+    conditions: OverlayCondition[];
+} | {
+    kind: "anyOf";
+    conditions: OverlayCondition[];
+} | {
+    kind: "not";
+    condition: OverlayCondition;
+};
 export interface OverlayIconStateHint {
     swatch?: OverlayValueSource;
     note?: string;
@@ -18,6 +45,7 @@ export type OverlayIcon = {
 } | {
     kind: "symbol";
     key: string;
+    sourcePath?: string;
     state?: OverlayIconStateHint;
 };
 export interface OverlayOptionDefinition {
@@ -26,6 +54,7 @@ export interface OverlayOptionDefinition {
     value: unknown;
     icon?: OverlayIcon;
     description?: string;
+    family?: string;
 }
 export interface OverlayCatalogDefinition {
     kind: "catalog";
@@ -42,11 +71,20 @@ export interface OverlayColorEditor extends OverlayEditorBase {
     kind: "color";
     palette?: string[];
     allowTransparent?: boolean;
+    presentation?: "circle" | "square" | "sticker";
+}
+export interface OverlayQuickOptionsDefinition {
+    family?: string;
+    optionIds?: string[];
+    maxVisible?: number;
+    overflow?: "clip" | "scroll" | "show-more";
 }
 export interface OverlayEnumIconEditor extends OverlayEditorBase {
     kind: "enum-icon";
     options: OverlayOptionDefinition[];
     catalog?: OverlayCatalogDefinition;
+    layout?: "row" | "grid" | "list";
+    quickOptions?: OverlayQuickOptionsDefinition;
 }
 export interface OverlayEnumListEditor extends OverlayEditorBase {
     kind: "enum-list";
@@ -79,6 +117,20 @@ export interface OverlayDynamicOptionsEditor extends OverlayEditorBase {
     providerId: string;
     presentation: "list" | "icon-grid";
 }
+export interface OverlayAssetUploadFieldDefinition {
+    id: string;
+    label: string;
+    description?: string;
+    accept?: string[];
+    multiple?: boolean;
+    required?: boolean;
+}
+export interface OverlayAssetUploadEditor extends OverlayEditorBase {
+    kind: "asset-upload";
+    mode: "single" | "multiple" | "paired";
+    accept?: string[];
+    fields?: OverlayAssetUploadFieldDefinition[];
+}
 export interface OverlayToggleEditor extends OverlayEditorBase {
     kind: "toggle";
     trueLabel?: string;
@@ -90,7 +142,7 @@ export interface OverlayCatalogEditor extends OverlayEditorBase {
     options: OverlayOptionDefinition[];
     presentation?: "grid" | "list";
 }
-export type OverlayEditor = OverlayColorEditor | OverlayEnumIconEditor | OverlayEnumListEditor | OverlayNumberEditor | OverlayNumberStepperEditor | OverlaySliderEditor | OverlayDynamicOptionsEditor | OverlayToggleEditor | OverlayCatalogEditor;
+export type OverlayEditor = OverlayColorEditor | OverlayEnumIconEditor | OverlayEnumListEditor | OverlayNumberEditor | OverlayNumberStepperEditor | OverlaySliderEditor | OverlayDynamicOptionsEditor | OverlayAssetUploadEditor | OverlayToggleEditor | OverlayCatalogEditor;
 export type OverlayInvocationArg = {
     kind: "control";
     controlId: string;
@@ -132,6 +184,7 @@ export interface OverlayControlDefinition {
     editor: OverlayEditor;
     valueAdapter?: OverlayControlValueAdapter;
     invoke?: OverlayInvocation;
+    when?: OverlayCondition;
 }
 export interface OverlayControlGroupDefinition {
     id: string;
@@ -139,6 +192,7 @@ export interface OverlayControlGroupDefinition {
     icon?: OverlayIcon;
     controlIds: string[];
     description?: string;
+    when?: OverlayCondition;
 }
 export type OverlayActionTarget = "single" | "each" | "selection";
 export interface OverlayActionDefinition {
@@ -150,10 +204,19 @@ export interface OverlayActionDefinition {
     invoke?: OverlayInvocation;
     controls?: OverlayControlDefinition[];
     groups?: OverlayControlGroupDefinition[];
+    when?: OverlayCondition;
+}
+export interface OverlayActionSectionDefinition {
+    id: string;
+    label: string;
+    icon?: OverlayIcon;
+    actionIds: string[];
+    description?: string;
 }
 export interface ItemOverlayDefinition {
     itemType: string;
     actions: OverlayActionDefinition[];
+    sections?: OverlayActionSectionDefinition[];
 }
 export interface SelectionOverlayActionDefinition {
     id: string;
@@ -169,6 +232,32 @@ export interface ToolDefaultsDefinition {
     controls: OverlayControlDefinition[];
     groups?: OverlayControlGroupDefinition[];
 }
+export interface OverlayWorkflowDefinition {
+    kind: "property-sheet";
+    controls: OverlayControlDefinition[];
+    groups?: OverlayControlGroupDefinition[];
+    submitLabel?: string;
+    description?: string;
+}
+export interface OverlayToolGroupDefinition {
+    id: string;
+    label: string;
+    icon?: OverlayIcon;
+    description?: string;
+    order?: number;
+    behavior?: "open-panel" | "activate-last-used";
+}
+export interface OverlayToolSurfaceDefinition {
+    order?: number;
+    group?: OverlayToolGroupDefinition;
+    relatedToolNames?: string[];
+}
+export type OverlayToolLaunchDefinition = {
+    kind: "activate-tool";
+} | {
+    kind: "workflow";
+    workflow: OverlayWorkflowDefinition;
+};
 export interface ToolOverlayDefinition {
     toolName: string;
     label: string;
@@ -178,5 +267,7 @@ export interface ToolOverlayDefinition {
     description?: string;
     createsItemType?: string;
     defaults?: ToolDefaultsDefinition;
+    launch?: OverlayToolLaunchDefinition;
+    surface?: OverlayToolSurfaceDefinition;
 }
 export {};

package/dist/types/Overlay/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./OverlayMetadata";
 export * from "./OverlayIcons";
 export * from "./overlayRegistry";
+export * from "./IconPack";

package/dist/types/Overlay/overlayRegistry.d.ts

@@ -1,12 +1,28 @@
 import type { BaseItem } from "../Items/BaseItem/BaseItem";
 import type { Tool } from "../Tools/Tool";
-import type { ItemOverlayDefinition, OverlayActionDefinition, OverlayOptionDefinition, SelectionOverlayActionDefinition, ToolOverlayDefinition } from "./OverlayMetadata";
+import type { ItemOverlayDefinition, OverlayActionDefinition, OverlayCondition, OverlayOptionDefinition, SelectionOverlayActionDefinition, ToolOverlayDefinition } from "./OverlayMetadata";
 export interface OverlayDynamicOptionsContext {
     item?: BaseItem;
     items?: readonly BaseItem[];
     tool?: Tool;
 }
 export type OverlayDynamicOptionsResolver = (context: OverlayDynamicOptionsContext) => OverlayOptionDefinition[];
+export interface OverlayCreateSurfaceGroupEntry {
+    kind: "group";
+    id: string;
+    label: string;
+    description?: string;
+    icon?: ToolOverlayDefinition["icon"];
+    order?: number;
+    behavior?: "open-panel" | "activate-last-used";
+    tools: ToolOverlayDefinition[];
+}
+export interface OverlayCreateSurfaceToolEntry {
+    kind: "tool";
+    tool: ToolOverlayDefinition;
+    order?: number;
+}
+export type OverlayCreateSurfaceEntry = OverlayCreateSurfaceGroupEntry | OverlayCreateSurfaceToolEntry;
 export declare const itemOverlays: Record<string, ItemOverlayDefinition>;
 export declare const toolOverlays: Record<string, ToolOverlayDefinition>;
 export declare const dynamicOptionsResolvers: Record<string, OverlayDynamicOptionsResolver>;
@@ -18,7 +34,9 @@ export declare function registerDynamicOptionsResolver(id: string, resolver: Ove
 export declare function getItemOverlay(itemOrType: BaseItem | string): ItemOverlayDefinition | undefined;
 export declare function getToolOverlay(toolName: string): ToolOverlayDefinition | undefined;
 export declare function listToolOverlays(): ToolOverlayDefinition[];
+export declare function listCreateSurfaceEntries(): OverlayCreateSurfaceEntry[];
 export declare function listSelectionActions(): SelectionOverlayActionDefinition[];
 export declare function getSelectionOverlayActions(items: readonly BaseItem[]): SelectionOverlayActionDefinition[];
 export declare function resolveDynamicOptions(providerId: string, context: OverlayDynamicOptionsContext): OverlayOptionDefinition[];
+export declare function matchesOverlayCondition(condition: OverlayCondition | undefined, context: OverlayDynamicOptionsContext): boolean;
 export declare function intersectOverlayActions(items: readonly BaseItem[]): OverlayActionDefinition[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "microboard-temp",
-  "version": "0.14.18",
+  "version": "0.14.19",
   "description": "A flexible interactive whiteboard library",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",