@uniformdev/mesh-sdk-react 20.35.0 → 20.35.1-alpha.188

package/dist/index.d.mts

@@ -8,7 +8,7 @@ import { DataVariableDefinition, DataResourceVariables, DataType, DataSourceVari
 import { Emitter } from 'mitt';
 import { TDate } from 'timeago.js';
 import * as lexical from 'lexical';
-import { SerializedEditorState, SerializedLexicalNode, Spread, DecoratorNode, NodeKey, LexicalNode, LexicalEditor, EditorState, SerializedRootNode } from 'lexical';
+import { SerializedEditorState, SerializedLexicalNode, Spread, DecoratorNode, NodeKey, DOMConversionMap, LexicalNode, LexicalEditor, EditorState, SerializedRootNode } from 'lexical';
 import { Interpolation, Theme, SerializedStyles } from '@emotion/react';
 import { InputSelectProps, IconType } from '@uniformdev/design-system';
 export { AddListButton, AddListButtonProps, Button, ButtonProps, Callout, CalloutProps, DrawerContent, Heading, HeadingProps, Input, InputComboBox, InputComboBoxProps, InputKeywordSearch, InputProps, InputSelect, InputToggle, InputToggleProps, Label, LabelProps, LoadingIndicator, LoadingOverlay, Menu, MenuItem, MenuItemProps, MenuProps, ParameterGroup, ParameterGroupProps, ParameterImage, ParameterImageInner, ParameterImageProps, ParameterInput, ParameterInputInner, ParameterInputProps, ParameterLabel, ParameterLabelProps, ParameterMenuButton, ParameterMenuButtonProps, ParameterSelect, ParameterSelectInner, ParameterSelectProps, ParameterShell, ParameterShellContext, ParameterShellProps, ParameterTextarea, ParameterTextareaInner, ParameterTextareaProps, ParameterToggle, ParameterToggleInner, ParameterToggleProps, ScrollableList, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, Switch, SwitchProps, Textarea, TextareaProps, Theme, ThemeProps, useParameterShell, utilityColors } from '@uniformdev/design-system';
@@ -186,7 +186,7 @@ declare function ControlledValuePlugin({ enabled, value, extraDependencies, }: {
     enabled: boolean;
     value: string | undefined | SerializedEditorState<SerializedLexicalNode>;
     extraDependencies?: unknown[];
-}): JSX.Element | null;
+}): ReactNode | null;
 
 type SerializedVariableNode = Spread<{
     reference: string;
@@ -217,9 +217,9 @@ type VariableNodeState = {
     isLoading: boolean;
 };
 /** Renders a variable reference node within a Lexical editor */
-declare class VariableNode extends DecoratorNode<JSX.Element> {
+declare class VariableNode extends DecoratorNode<ReactNode> {
     reference: Readonly<string>;
-    private __state;
+    private __variableState;
     static getType(): string;
     static clone(node: VariableNode): VariableNode;
     /** Imports the node from serialized JSON (i.e. the data provided to the editor's initial state) */
@@ -248,6 +248,7 @@ declare class VariableNode extends DecoratorNode<JSX.Element> {
     /** Creates the DOM wrapper that hosts the node */
     createDOM(): HTMLSpanElement;
     updateDOM(): boolean;
+    static importDOM(): DOMConversionMap | null;
     /**
      * Render the variable node using React.
      * NOTE: this is effectively an island of React, and you may not call hooks,
@@ -415,6 +416,11 @@ type VariablesPluginProps<TEditorContext = unknown> = {
     filterVariable?: SelectVariableMenuProps<TEditorContext>['filterVariable'];
     /** If true, the whole value of the editor is replaced when a variable is inserted */
     replaceValueOnVariableInsert: boolean;
+    /**
+     * Disables display names for variables; the variable's (prettified) name is used instead even if a DN exists
+     * Use this to render dynamic tokens as paths instead of bound values.
+     */
+    disableVariableDisplayNames?: boolean;
 };
 type UseVariablesMenuInput<TEditorContext> = Pick<VariablesPluginProps<TEditorContext>, 'showAddVariableMenuOption' | 'enableEditingVariables' | 'filterVariable' | 'getEditorContext'>;
 type OnVariableSelectInput = {
@@ -435,7 +441,7 @@ declare function useVariablesMenu<TEditorContext>({ showAddVariableMenuOption, e
  * Enables variables auto-complete and reference management to a Lexical editor.
  * Must also activate the VariableNode node to make this work.
  */
-declare function VariablesPlugin<TEditorContext = unknown>({ disableVariables, showAddVariableMenuOption, enableEditingVariables, getEditorContext, replaceValueOnVariableInsert, filterVariable, }: VariablesPluginProps<TEditorContext>): JSX.Element | null;
+declare function VariablesPlugin<TEditorContext = unknown>({ disableVariables, showAddVariableMenuOption, enableEditingVariables, getEditorContext, replaceValueOnVariableInsert, filterVariable, disableVariableDisplayNames, }: VariablesPluginProps<TEditorContext>): ReactNode | null;
 
 type PasteTransformerPluginProps = {
     /**
@@ -475,7 +481,7 @@ type UseInputVariablesStateProps<TEditorContext = unknown> = {
      * in the input will be replaced with the variable reference. Once in variables-mode, additional
      * insertions are inserted at the current selection (or end) of the variables value.
      */
-    inputWhenNoVariables?: JSX.Element;
+    inputWhenNoVariables?: ReactNode;
     /** Computes the editor context when a variable is added or edited from this composer */
     getEditorContext?: () => TEditorContext;
     /** Filters available variables in menus and auto-completes */
@@ -552,6 +558,11 @@ type InputVariablesProps<TEditorContext = unknown> = {
      * any existing value on insert a new dynamic token.
      */
     singleTokenMode?: boolean;
+    /**
+     * Disables display names for variables; the variable's (prettified) name is used instead even if a DN exists
+     * Use this to render dynamic tokens as paths instead of bound values.
+     */
+    disableVariableDisplayNames?: boolean;
 } & PasteTransformerPluginProps & UseInputVariablesStateProps<TEditorContext>;
 /**
  * An input box that enables insertion of 'variables', provided by VariablesProvider,
@@ -588,7 +599,7 @@ declare function ParameterConnectionIndicator({ children, value, menuOptions, di
 
 type ParameterOrSingleVariableProps<TEditorContext = unknown> = {
     disabled?: boolean;
-    inputWhenNoVariables: JSX.Element;
+    inputWhenNoVariables: ReactNode;
     enableEditingVariables?: boolean;
     /**
      * Optional ref to get a handle to the variables editor.

package/dist/index.d.ts

@@ -8,7 +8,7 @@ import { DataVariableDefinition, DataResourceVariables, DataType, DataSourceVari
 import { Emitter } from 'mitt';
 import { TDate } from 'timeago.js';
 import * as lexical from 'lexical';
-import { SerializedEditorState, SerializedLexicalNode, Spread, DecoratorNode, NodeKey, LexicalNode, LexicalEditor, EditorState, SerializedRootNode } from 'lexical';
+import { SerializedEditorState, SerializedLexicalNode, Spread, DecoratorNode, NodeKey, DOMConversionMap, LexicalNode, LexicalEditor, EditorState, SerializedRootNode } from 'lexical';
 import { Interpolation, Theme, SerializedStyles } from '@emotion/react';
 import { InputSelectProps, IconType } from '@uniformdev/design-system';
 export { AddListButton, AddListButtonProps, Button, ButtonProps, Callout, CalloutProps, DrawerContent, Heading, HeadingProps, Input, InputComboBox, InputComboBoxProps, InputKeywordSearch, InputProps, InputSelect, InputToggle, InputToggleProps, Label, LabelProps, LoadingIndicator, LoadingOverlay, Menu, MenuItem, MenuItemProps, MenuProps, ParameterGroup, ParameterGroupProps, ParameterImage, ParameterImageInner, ParameterImageProps, ParameterInput, ParameterInputInner, ParameterInputProps, ParameterLabel, ParameterLabelProps, ParameterMenuButton, ParameterMenuButtonProps, ParameterSelect, ParameterSelectInner, ParameterSelectProps, ParameterShell, ParameterShellContext, ParameterShellProps, ParameterTextarea, ParameterTextareaInner, ParameterTextareaProps, ParameterToggle, ParameterToggleInner, ParameterToggleProps, ScrollableList, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, Switch, SwitchProps, Textarea, TextareaProps, Theme, ThemeProps, useParameterShell, utilityColors } from '@uniformdev/design-system';
@@ -186,7 +186,7 @@ declare function ControlledValuePlugin({ enabled, value, extraDependencies, }: {
     enabled: boolean;
     value: string | undefined | SerializedEditorState<SerializedLexicalNode>;
     extraDependencies?: unknown[];
-}): JSX.Element | null;
+}): ReactNode | null;
 
 type SerializedVariableNode = Spread<{
     reference: string;
@@ -217,9 +217,9 @@ type VariableNodeState = {
     isLoading: boolean;
 };
 /** Renders a variable reference node within a Lexical editor */
-declare class VariableNode extends DecoratorNode<JSX.Element> {
+declare class VariableNode extends DecoratorNode<ReactNode> {
     reference: Readonly<string>;
-    private __state;
+    private __variableState;
     static getType(): string;
     static clone(node: VariableNode): VariableNode;
     /** Imports the node from serialized JSON (i.e. the data provided to the editor's initial state) */
@@ -248,6 +248,7 @@ declare class VariableNode extends DecoratorNode<JSX.Element> {
     /** Creates the DOM wrapper that hosts the node */
     createDOM(): HTMLSpanElement;
     updateDOM(): boolean;
+    static importDOM(): DOMConversionMap | null;
     /**
      * Render the variable node using React.
      * NOTE: this is effectively an island of React, and you may not call hooks,
@@ -415,6 +416,11 @@ type VariablesPluginProps<TEditorContext = unknown> = {
     filterVariable?: SelectVariableMenuProps<TEditorContext>['filterVariable'];
     /** If true, the whole value of the editor is replaced when a variable is inserted */
     replaceValueOnVariableInsert: boolean;
+    /**
+     * Disables display names for variables; the variable's (prettified) name is used instead even if a DN exists
+     * Use this to render dynamic tokens as paths instead of bound values.
+     */
+    disableVariableDisplayNames?: boolean;
 };
 type UseVariablesMenuInput<TEditorContext> = Pick<VariablesPluginProps<TEditorContext>, 'showAddVariableMenuOption' | 'enableEditingVariables' | 'filterVariable' | 'getEditorContext'>;
 type OnVariableSelectInput = {
@@ -435,7 +441,7 @@ declare function useVariablesMenu<TEditorContext>({ showAddVariableMenuOption, e
  * Enables variables auto-complete and reference management to a Lexical editor.
  * Must also activate the VariableNode node to make this work.
  */
-declare function VariablesPlugin<TEditorContext = unknown>({ disableVariables, showAddVariableMenuOption, enableEditingVariables, getEditorContext, replaceValueOnVariableInsert, filterVariable, }: VariablesPluginProps<TEditorContext>): JSX.Element | null;
+declare function VariablesPlugin<TEditorContext = unknown>({ disableVariables, showAddVariableMenuOption, enableEditingVariables, getEditorContext, replaceValueOnVariableInsert, filterVariable, disableVariableDisplayNames, }: VariablesPluginProps<TEditorContext>): ReactNode | null;
 
 type PasteTransformerPluginProps = {
     /**
@@ -475,7 +481,7 @@ type UseInputVariablesStateProps<TEditorContext = unknown> = {
      * in the input will be replaced with the variable reference. Once in variables-mode, additional
      * insertions are inserted at the current selection (or end) of the variables value.
      */
-    inputWhenNoVariables?: JSX.Element;
+    inputWhenNoVariables?: ReactNode;
     /** Computes the editor context when a variable is added or edited from this composer */
     getEditorContext?: () => TEditorContext;
     /** Filters available variables in menus and auto-completes */
@@ -552,6 +558,11 @@ type InputVariablesProps<TEditorContext = unknown> = {
      * any existing value on insert a new dynamic token.
      */
     singleTokenMode?: boolean;
+    /**
+     * Disables display names for variables; the variable's (prettified) name is used instead even if a DN exists
+     * Use this to render dynamic tokens as paths instead of bound values.
+     */
+    disableVariableDisplayNames?: boolean;
 } & PasteTransformerPluginProps & UseInputVariablesStateProps<TEditorContext>;
 /**
  * An input box that enables insertion of 'variables', provided by VariablesProvider,
@@ -588,7 +599,7 @@ declare function ParameterConnectionIndicator({ children, value, menuOptions, di
 
 type ParameterOrSingleVariableProps<TEditorContext = unknown> = {
     disabled?: boolean;
-    inputWhenNoVariables: JSX.Element;
+    inputWhenNoVariables: ReactNode;
     enableEditingVariables?: boolean;
     /**
      * Optional ref to get a handle to the variables editor.