@uniformdev/canvas 19.38.2 → 19.38.3-alpha.70

package/dist/index.d.ts

@@ -181,19 +181,15 @@ interface components$4 {
             value: unknown;
             /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
             type: string;
+            /** @deprecated */
             connectedData?: components$4["schemas"]["DataElementConnectionDefinition"];
         };
-        /**
-         * @description Defines a connection to a data element on a data resource.
-         *
-         * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-         * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
-         */
+        /** @description Defines a connection to a dynamic token on a data resource. */
         DataElementConnectionDefinition: {
-            /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
+            /** @description A JSON Pointer expression that defines the data resource dynamic token value. */
             pointer: string;
             /**
-             * @description The syntax used to select the data element to bind to
+             * @description The syntax used to select the dynamic token to bind to
              * @enum {string}
              */
             syntax: "jptr";
@@ -833,19 +829,15 @@ interface external$a {
                     value: unknown;
                     /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
                     type: string;
+                    /** @deprecated */
                     connectedData?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
                 };
-                /**
-                 * @description Defines a connection to a data element on a data resource.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
-                 */
+                /** @description Defines a connection to a dynamic token on a data resource. */
                 DataElementConnectionDefinition: {
-                    /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
+                    /** @description A JSON Pointer expression that defines the data resource dynamic token value. */
                     pointer: string;
                     /**
-                     * @description The syntax used to select the data element to bind to
+                     * @description The syntax used to select the dynamic token to bind to
                      * @enum {string}
                      */
                     syntax: "jptr";
@@ -1486,19 +1478,15 @@ interface external$9 {
                     value: unknown;
                     /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
                     type: string;
+                    /** @deprecated */
                     connectedData?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
                 };
-                /**
-                 * @description Defines a connection to a data element on a data resource.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
-                 */
+                /** @description Defines a connection to a dynamic token on a data resource. */
                 DataElementConnectionDefinition: {
-                    /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
+                    /** @description A JSON Pointer expression that defines the data resource dynamic token value. */
                     pointer: string;
                     /**
-                     * @description The syntax used to select the data element to bind to
+                     * @description The syntax used to select the dynamic token to bind to
                      * @enum {string}
                      */
                     syntax: "jptr";
@@ -2135,19 +2123,15 @@ interface external$8 {
                     value: unknown;
                     /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
                     type: string;
+                    /** @deprecated */
                     connectedData?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
                 };
-                /**
-                 * @description Defines a connection to a data element on a data resource.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
-                 */
+                /** @description Defines a connection to a dynamic token on a data resource. */
                 DataElementConnectionDefinition: {
-                    /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
+                    /** @description A JSON Pointer expression that defines the data resource dynamic token value. */
                     pointer: string;
                     /**
-                     * @description The syntax used to select the data element to bind to
+                     * @description The syntax used to select the dynamic token to bind to
                      * @enum {string}
                      */
                     syntax: "jptr";
@@ -2727,19 +2711,15 @@ interface external$7 {
                     value: unknown;
                     /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
                     type: string;
+                    /** @deprecated */
                     connectedData?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
                 };
-                /**
-                 * @description Defines a connection to a data element on a data resource.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
-                 */
+                /** @description Defines a connection to a dynamic token on a data resource. */
                 DataElementConnectionDefinition: {
-                    /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
+                    /** @description A JSON Pointer expression that defines the data resource dynamic token value. */
                     pointer: string;
                     /**
-                     * @description The syntax used to select the data element to bind to
+                     * @description The syntax used to select the dynamic token to bind to
                      * @enum {string}
                      */
                     syntax: "jptr";
@@ -3354,19 +3334,15 @@ interface external$6 {
                     value: unknown;
                     /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
                     type: string;
+                    /** @deprecated */
                     connectedData?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
                 };
-                /**
-                 * @description Defines a connection to a data element on a data resource.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
-                 */
+                /** @description Defines a connection to a dynamic token on a data resource. */
                 DataElementConnectionDefinition: {
-                    /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
+                    /** @description A JSON Pointer expression that defines the data resource dynamic token value. */
                     pointer: string;
                     /**
-                     * @description The syntax used to select the data element to bind to
+                     * @description The syntax used to select the dynamic token to bind to
                      * @enum {string}
                      */
                     syntax: "jptr";
@@ -4406,19 +4382,15 @@ interface external$5 {
                     value: unknown;
                     /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
                     type: string;
+                    /** @deprecated */
                     connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
                 };
-                /**
-                 * @description Defines a connection to a data element on a data resource.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
-                 */
+                /** @description Defines a connection to a dynamic token on a data resource. */
                 DataElementConnectionDefinition: {
-                    /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
+                    /** @description A JSON Pointer expression that defines the data resource dynamic token value. */
                     pointer: string;
                     /**
-                     * @description The syntax used to select the data element to bind to
+                     * @description The syntax used to select the dynamic token to bind to
                      * @enum {string}
                      */
                     syntax: "jptr";
@@ -5249,19 +5221,15 @@ interface external$3 {
                     value: unknown;
                     /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
                     type: string;
+                    /** @deprecated */
                     connectedData?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
                 };
-                /**
-                 * @description Defines a connection to a data element on a data resource.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
-                 */
+                /** @description Defines a connection to a dynamic token on a data resource. */
                 DataElementConnectionDefinition: {
-                    /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
+                    /** @description A JSON Pointer expression that defines the data resource dynamic token value. */
                     pointer: string;
                     /**
-                     * @description The syntax used to select the data element to bind to
+                     * @description The syntax used to select the dynamic token to bind to
                      * @enum {string}
                      */
                     syntax: "jptr";
@@ -6756,19 +6724,15 @@ interface external$2 {
                     value: unknown;
                     /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
                     type: string;
+                    /** @deprecated */
                     connectedData?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
                 };
-                /**
-                 * @description Defines a connection to a data element on a data resource.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
-                 */
+                /** @description Defines a connection to a dynamic token on a data resource. */
                 DataElementConnectionDefinition: {
-                    /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
+                    /** @description A JSON Pointer expression that defines the data resource dynamic token value. */
                     pointer: string;
                     /**
-                     * @description The syntax used to select the data element to bind to
+                     * @description The syntax used to select the dynamic token to bind to
                      * @enum {string}
                      */
                     syntax: "jptr";
@@ -7794,7 +7758,7 @@ type ComponentParameterContextualEditing<TValue = unknown> = ComponentParameter<
         isEditable?: boolean;
     };
 };
-/** Defines a connection to a data element on a data resource. */
+/** Defines a connection to a dynamic token on a data resource. */
 type DataElementConnectionDefinition = SharedComponents['DataElementConnectionDefinition'];
 /** Variable values for a data resource. */
 type DataResourceVariables = SharedComponents['DataResourceVariables'];
@@ -7872,7 +7836,7 @@ type CompositionPatternIssue = CompositionIssueCore & {
     type: 'pattern';
     code: NonNullable<ComponentInstance['_patternError']>;
 };
-/** An error while binding a data element from a data resource to a component parameter (i.e. a missing property in the data resource) */
+/** An error while binding a dynamic token from a data resource to a component parameter (i.e. a missing property in the data resource) */
 type DataElementBindingIssue = CompositionIssueCore & {
     type: 'binding';
     parameterName: string;
@@ -8606,7 +8570,7 @@ type ProjectMapLinkComponentParameterValue = ProjectMapLinkParamValue | undefine
 type LinkComponentParameterValue = LinkParamValue;
 
 type RichTextBuiltInFormat = 'code' | 'bold' | 'italic' | 'underline' | 'strikethrough' | 'superscript' | 'subscript';
-type RichTextBuiltInElement = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'unorderedList' | 'orderedList' | 'link' | 'quote' | 'code';
+type RichTextBuiltInElement = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'unorderedList' | 'orderedList' | 'link' | 'quote' | 'code' | 'variable';
 type RichTextParamConfiguration = {
     required?: boolean;
     formatting?: {
@@ -9062,50 +9026,6 @@ declare class RouteClient extends ApiClient<RouteClientOptions> {
     getRoute(options?: Omit<RouteGetParameters, 'projectId'>): Promise<ResolvedRouteGetResponse>;
 }
 
-type BindVariablesResult<TValue> = {
-    boundCount: number;
-    result: TValue;
-    errors?: string[];
-};
-type BindVariablesToObjectOptions<T> = {
-    /** The object to bind variables to. Only strings or objects are bound. */
-    value: T;
-} & Omit<BindVariablesOptions, 'value'>;
-/**
- * Binds composition variables to an object whose string keys may have variable expressions in them.
- * Binding is recursive.
- */
-declare function bindVariablesToObject<T>(options: BindVariablesToObjectOptions<T>): BindVariablesResult<T>;
-
-type BindVariablesOptions = {
-    /** Current variable values table */
-    variables: DataResourceVariables;
-    /** String value to bind variables to */
-    value: string;
-    /**
-     * Text prefix for any variable binding errors that might be returned
-     * @default "Variable"
-     */
-    errorPrefix?: string;
-    /**
-     * Optionally provide overridden binding behaviour with a function.
-     * Default behaviour:
-     * - If variable is not defined, its expression is replaced by empty string and an error is returned
-     * - If variable is defined, its expression is replaced by its value
-     * @param variableName The variable name referred to in the `value` string. This is the name inside the ${} expression.
-     * @param variables The current variables table.
-     * @param errors Errors array. Push to it to add errors to the result.
-     * @returns New value for the variable reference expression, will replace the whole ${} in the result.
-     */
-    handleBinding?: (variableName: string, variables: DataResourceVariables, errors: string[]) => string;
-};
-/**
- * Binds variables to a string that could have variable values in it.
- * Variables are referenced in the string as ${variableName}.
- * Literal variable values are escaped with a backslash, e.g. \${literal}
- */
-declare function bindVariables({ variables, value, errorPrefix, handleBinding, }: BindVariablesOptions): BindVariablesResult<string>;
-
 /** Public ID of Canvas personalization component type */
 declare const CANVAS_PERSONALIZE_TYPE = "$personalization";
 /** Public ID of Canvas A/B test component type */
@@ -9346,6 +9266,63 @@ declare function mapSlotToPersonalizedVariations(slot: ComponentInstance[] | und
  */
 declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined): Array<ComponentInstance & TestVariant>;
 
+type BindVariablesResult<TValue> = {
+    /** Number of dynamic expressions that attempted to be bound (regardless of the success of the binding) */
+    boundCount: number;
+    /** Result object after the binding */
+    result: TValue;
+    /** Any errors that occurred resolving bound values */
+    errors?: Array<string | Error>;
+};
+type BindVariablesToObjectOptions<T> = {
+    /** The object to bind variables to. Only strings or objects are bound. */
+    value: T;
+} & Omit<BindVariablesOptions, 'value'>;
+/**
+ * Binds composition variables to an object whose string keys may have variable expressions in them.
+ * Binding is recursive.
+ */
+declare function bindVariablesToObject<T>(options: BindVariablesToObjectOptions<T>): BindVariablesResult<T>;
+
+type BindVariablesOptions = {
+    /** Current variable values table */
+    variables: Record<string, unknown>;
+    /** String value to bind variables to */
+    value: string;
+    /**
+     * Text prefix for any variable binding errors that might be returned
+     * @default "Variable"
+     */
+    errorPrefix?: string;
+    /**
+     * Optionally provide overridden binding behaviour with a function.
+     * Default behaviour:
+     * - If variable is not defined, its expression is replaced by empty string and an error is returned
+     * - If variable is defined, its expression is replaced by its value
+     * @param variableName The variable name referred to in the `value` string. This is the name inside the ${} expression.
+     * @param variables The current variables table.
+     * @param errors Errors array. Push to it to add errors to the result.
+     * @returns New value for the variable reference expression, will replace the whole ${} in the result. If non-string value is returned, then:
+     *  - If the original string value contains ONLY the variable reference (i.e. "${foo}") then the value will be used literally, e.g. the property becomes an array, etc
+     *  - If the original value contains other text, then the value will be string-interpolated as a fallback (i.e. [object Object], 'array,elements', etc)
+     */
+    handleBinding?: (variableName: string, variables: Record<string, unknown>, errors: Array<string | Error>) => unknown;
+};
+/**
+ * Binds variables to a string that could have variable values in it.
+ * Variables are referenced in the string as ${variableName}.
+ * Literal variable values are escaped with a backslash, e.g. \${literal}
+ */
+declare function bindVariables({ variables, value, errorPrefix, handleBinding, }: BindVariablesOptions): BindVariablesResult<unknown>;
+
+declare function createVariableReference(variableName: string): string;
+
+/**
+ * Parses an expression that may contain Uniform variables and invokes a callback for each text or variable token found
+ * @returns the number of tokens found in the string (variable or text)
+ */
+declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable') => void | false): number;
+
 declare const CanvasClientError: typeof ApiClientError;
 
-export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByComponentIdParameters, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, ContextualEditingComponentReference, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, InvalidationResult, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };
+export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByComponentIdParameters, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, ContextualEditingComponentReference, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, InvalidationResult, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };

package/dist/index.esm.js

@@ -1658,80 +1658,6 @@ var RouteClient = class extends ApiClient6 {
   }
 };
 
-// src/utils/bindVariables.ts
-function bindVariables({
-  variables,
-  value,
-  errorPrefix = "Variable",
-  handleBinding
-}) {
-  let boundCount = 0;
-  const errors = [];
-  const defaultHandleBinding = (variableName, variables2, errors2) => {
-    const variableValue = variables2[variableName];
-    if (variableValue === void 0) {
-      errors2.push(`${errorPrefix} "${variableName}" is not defined`);
-      return "";
-    }
-    return variableValue;
-  };
-  const result = value.replace(/(?<!\\)\${([^}]+)}/g, (_match, variableName) => {
-    const variableValue = (handleBinding != null ? handleBinding : defaultHandleBinding)(variableName, variables, errors);
-    boundCount++;
-    return variableValue;
-  });
-  return { result, boundCount, errors: errors.length > 0 ? errors : void 0 };
-}
-
-// src/utils/bindVariablesToObject.ts
-import { produce } from "immer";
-function bindVariablesToObject(options) {
-  return bindVariablesToObjectRecursive(options);
-}
-function bindVariablesToObjectRecursive({
-  value,
-  recursivePath,
-  ...bindVariablesOptions
-}) {
-  let boundCount = 0;
-  const errors = [];
-  if (typeof value === "string") {
-    return bindVariables({ ...bindVariablesOptions, value });
-  }
-  if (typeof value !== "object" || value === null) {
-    return { boundCount: 0, result: value };
-  }
-  const result = produce(value, (draft) => {
-    Object.entries(draft).forEach(([property, oldValue]) => {
-      const currentObjectPath = recursivePath ? `${recursivePath}.${property}` : property;
-      if (typeof oldValue === "string") {
-        const bindResult = bindVariables({ ...bindVariablesOptions, value: oldValue });
-        if (oldValue !== bindResult.result || bindResult.errors) {
-          boundCount += bindResult.boundCount;
-          draft[property] = bindResult.result;
-          if (bindResult.errors) {
-            errors.push(...bindResult.errors.map((e) => `${currentObjectPath}: ${e}`));
-          }
-        }
-        return;
-      }
-      const childBind = bindVariablesToObjectRecursive({
-        ...bindVariablesOptions,
-        value: oldValue,
-        recursivePath: currentObjectPath
-      });
-      if (childBind.boundCount || childBind.errors) {
-        boundCount += childBind.boundCount;
-        draft[property] = childBind.result;
-        if (childBind.errors) {
-          errors.push(...childBind.errors.map((e) => `${currentObjectPath}: ${e}`));
-        }
-      }
-    });
-  });
-  return { boundCount, result, errors: errors.length > 0 ? errors : void 0 };
-}
-
 // src/utils/createApiEnhancer.ts
 var createUniformApiEnhancer = ({ apiUrl }) => {
   return async (message) => {
@@ -1821,6 +1747,180 @@ function mapSlotToTestVariations(slot) {
   });
 }
 
+// src/utils/variables/parseVariableExpression.ts
+var escapeCharacter = "\\";
+var variablePrefix = "${";
+var variableSuffix = "}";
+function parseVariableExpression(serialized, onToken) {
+  let bufferStartIndex = 0;
+  let bufferEndIndex = 0;
+  let tokenCount = 0;
+  const handleToken = (token, type) => {
+    tokenCount++;
+    return onToken == null ? void 0 : onToken(token, type);
+  };
+  let state = "text";
+  for (let index = 0; index < serialized.length; index++) {
+    const char = serialized[index];
+    if (bufferStartIndex > bufferEndIndex) {
+      bufferEndIndex = bufferStartIndex;
+    }
+    if (char === variablePrefix[0] && serialized[index + 1] === variablePrefix[1]) {
+      if (serialized[index - 1] === escapeCharacter) {
+        bufferEndIndex -= escapeCharacter.length;
+        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "text") === false) {
+          return tokenCount;
+        }
+        bufferStartIndex = index;
+        bufferEndIndex = index + 1;
+        continue;
+      }
+      state = "variable";
+      if (bufferEndIndex > bufferStartIndex) {
+        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "text") === false) {
+          return tokenCount;
+        }
+        bufferStartIndex = bufferEndIndex;
+      }
+      index += variablePrefix.length - 1;
+      bufferStartIndex += variablePrefix.length;
+      continue;
+    }
+    if (char === variableSuffix && state === "variable") {
+      state = "text";
+      if (bufferEndIndex > bufferStartIndex) {
+        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "variable") === false) {
+          return tokenCount;
+        }
+        bufferStartIndex = bufferEndIndex + variableSuffix.length;
+      }
+      continue;
+    }
+    bufferEndIndex++;
+  }
+  if (bufferEndIndex > bufferStartIndex) {
+    if (state === "variable") {
+      state = "text";
+      bufferStartIndex -= variablePrefix.length;
+    }
+    handleToken(serialized.substring(bufferStartIndex), state);
+  }
+  return tokenCount;
+}
+
+// src/utils/variables/bindVariables.ts
+function bindVariables({
+  variables,
+  value,
+  errorPrefix = "Variable",
+  handleBinding
+}) {
+  let boundCount = 0;
+  let tokenCount = 0;
+  const errors = [];
+  const defaultHandleBinding = (variableName, variables2, errors2) => {
+    const variableValue = variables2[variableName];
+    if (variableValue === void 0) {
+      errors2.push(`${errorPrefix} "${variableName}" is not defined`);
+      return "";
+    }
+    return variableValue;
+  };
+  const result = [];
+  parseVariableExpression(value, (token, tokenType) => {
+    tokenCount++;
+    if (tokenType === "text") {
+      result.push(token);
+      return;
+    }
+    const variableValue = (handleBinding != null ? handleBinding : defaultHandleBinding)(token, variables, errors);
+    boundCount++;
+    result.push(variableValue);
+  });
+  return {
+    result: tokenCount === 1 ? result[0] : result.join(""),
+    boundCount,
+    errors: errors.length > 0 ? errors : void 0
+  };
+}
+
+// src/utils/variables/bindVariablesToObject.ts
+import { produce } from "immer";
+
+// src/utils/variables/createVariableReference.ts
+function createVariableReference(variableName) {
+  return `\${${variableName}}`;
+}
+
+// src/utils/variables/bindVariablesToObject.ts
+function bindVariablesToObject(options) {
+  return bindVariablesToObjectRecursive(options);
+}
+function bindVariablesToObjectRecursive({
+  value,
+  recursivePath,
+  ...bindVariablesOptions
+}) {
+  let boundCount = 0;
+  const errors = [];
+  if (typeof value === "string") {
+    return bindVariables({ ...bindVariablesOptions, value });
+  }
+  if (typeof value !== "object" || value === null) {
+    return { boundCount: 0, result: value };
+  }
+  const richTextNodeResult = handleRichTextNodeBinding(value, bindVariablesOptions);
+  if (richTextNodeResult !== void 0) {
+    return richTextNodeResult;
+  }
+  const result = produce(value, (draft) => {
+    Object.entries(draft).forEach(([property, oldValue]) => {
+      const currentObjectPath = recursivePath ? `${recursivePath}.${property}` : property;
+      if (typeof oldValue === "string") {
+        const bindResult = bindVariables({ ...bindVariablesOptions, value: oldValue });
+        if (oldValue !== bindResult.result || bindResult.errors) {
+          boundCount += bindResult.boundCount;
+          draft[property] = bindResult.result;
+          if (bindResult.errors) {
+            errors.push(...bindResult.errors.map((e) => `${currentObjectPath}: ${e}`));
+          }
+        }
+        return;
+      }
+      const childBind = bindVariablesToObjectRecursive({
+        ...bindVariablesOptions,
+        value: oldValue,
+        recursivePath: currentObjectPath
+      });
+      if (childBind.boundCount || childBind.errors) {
+        boundCount += childBind.boundCount;
+        draft[property] = childBind.result;
+        if (childBind.errors) {
+          errors.push(...childBind.errors);
+        }
+      }
+    });
+  });
+  return { boundCount, result, errors: errors.length > 0 ? errors : void 0 };
+}
+function handleRichTextNodeBinding(object, options) {
+  if ("type" in object && object.type === "variable" && "reference" in object && typeof object.reference === "string" && "version" in object && object.version === 1) {
+    const value = createVariableReference(object.reference);
+    const bindResult = bindVariables({ ...options, value });
+    const bindResultAsTextNode = {
+      detail: 0,
+      format: 0,
+      mode: "normal",
+      style: "",
+      text: bindResult.result,
+      type: "text",
+      version: 1
+    };
+    return { ...bindResult, result: bindResultAsTextNode };
+  }
+  return void 0;
+}
+
 // src/index.ts
 import { ApiClientError as ApiClientError2 } from "@uniformdev/context/api";
 var CanvasClientError = ApiClientError2;
@@ -1879,6 +1979,7 @@ export {
   createEventBus,
   createLimitPolicy,
   createUniformApiEnhancer,
+  createVariableReference,
   enhance,
   extractLocales,
   generateHash,
@@ -1904,6 +2005,7 @@ export {
   mapSlotToPersonalizedVariations,
   mapSlotToTestVariations,
   nullLimitPolicy,
+  parseVariableExpression,
   subscribeToComposition,
   unstable_CompositionRelationshipClient,
   walkComponentTree