@uniformdev/canvas 19.80.0 → 19.80.1-alpha.149

package/dist/index.d.ts

@@ -1372,6 +1372,12 @@ declare const EDGE_MAX_CACHE_TTL: number;
 declare const EDGE_DEFAULT_CACHE_TTL = 30;
 /** A value that indicates that Edgehancers caching is disabled */
 declare const EDGE_CACHE_DISABLED = -1;
+/** This is the type value for the asset parameter or field */
+declare const ASSET_PARAMETER_TYPE = "asset";
+/** The _source for any assets coming from the Uniform Asset Library */
+declare const ASSETS_SOURCE_UNIFORM = "uniform-assets";
+/** The _source for any assets which have manually set fields */
+declare const ASSETS_SOURCE_CUSTOM_URL = "custom-url";
 
 /**
  * This file was auto-generated by openapi-typescript.
@@ -4327,6 +4333,7 @@ type DeleteContentTypeOptions = paths$b['/api/v1/content-types']['delete']['requ
 type PutContentTypeBody = paths$b['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
 type GetContentTypesResponse = paths$b['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
 type Entry = components$3['schemas']['EntryApiResponse'];
+type EntryList = components$3['schemas']['EntryListResponse'];
 type EntryData = Entry['entry'];
 type GetEntriesOptions = paths$a['/api/v1/entries']['get']['parameters']['query'];
 type GetEntriesResponse = paths$a['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
@@ -12489,8 +12496,9 @@ interface paths$1 {
             parameters: {
                 query: {
                     projectId: string;
-                    type: "definition";
+                    type: "definition" | "instance";
                     definitionIds?: string;
+                    instanceIds?: string;
                     withCompositions?: boolean | null;
                 };
             };
@@ -12850,6 +12858,81 @@ type schemas = components$1['schemas'];
 type InvalidationPayload = schemas['InvalidationPayload'];
 type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
 
+type AssetParamValue = AssetParamValueItem[];
+type AssetParamValueItem = {
+    type: string;
+    _id: string;
+    /**
+     * Internal Uniform source ID or
+     * dataType ID of the global integration library
+     * which created this asset item
+     */
+    _source?: string;
+    fields: {
+        url: {
+            type: 'text';
+            value: string;
+        };
+        id?: {
+            type: 'text';
+            value: string | undefined;
+        };
+        title?: {
+            type: 'text';
+            value: string | undefined;
+        };
+        description?: {
+            type: 'text';
+            value: string | undefined;
+        };
+        mediaType?: {
+            type: 'text';
+            value: string | undefined;
+        };
+        /**
+         * The width of the original asset
+         *
+         * Should resolve to a number but might
+         * be a string with a pointer reference
+         */
+        width?: {
+            type: 'number';
+            value: number | string | undefined;
+        };
+        /**
+         * The height of the original asset
+         *
+         * Should resolve to a number but might
+         * be a string with a pointer reference
+         */
+        height?: {
+            type: 'number';
+            value: number | string | undefined;
+        };
+        /**
+         * The size in bytes of the original asset
+         *
+         * Should resolve to a number but might
+         * be a string with a pointer reference
+         */
+        size?: {
+            type: 'number';
+            value: number | string | undefined;
+        };
+        /**
+         * Any key/value properties which the source
+         * wants to attach to the asset data
+         */
+        custom?: {
+            type: string;
+            value: Record<string, unknown>;
+        };
+    };
+    _overrides?: {
+        fields: ComponentOverride['parameters'];
+    };
+};
+
 type LinkParameterType = 'projectMapNode' | 'url' | 'tel' | 'email';
 type LinkTypeConfiguration = Partial<Record<LinkParameterType, boolean>>;
 type LinkParamConfiguration = {
@@ -13137,37 +13220,6 @@ declare function enhance<TContext extends EnhancerContext = EnhancerContext>({ c
     onErrors?: (errors: EnhancerError[]) => void;
 }): Promise<void>;
 
-/** @deprecated use walkNodeTree */
-type ComponentLocationReference = {
-    component: ComponentInstance;
-    parentSlot?: string;
-    parentSlotIndex?: number;
-};
-/** @deprecated use walkNodeTree and check for type = slot */
-type WalkComponentTreeActions<TContext> = {
-    /** Replaces the component being visited with a new object */
-    replaceComponent: (replacementComponent: ComponentInstance) => void;
-    /** Removes the component being visited from the composition */
-    removeComponent: () => void;
-    /** Inserts a new component immediately after the current component in its parent slot */
-    insertAfter: (components: ComponentInstance | ComponentInstance[]) => void;
-    /** Aborts visitation of components that are in child slots of the current component */
-    stopProcessingDescendants: () => void;
-    /**
-     * Set a new traversal context for descendants of this node.
-     * If this is not called, `context` will automatically pass through.
-     */
-    setDescendantsContext: (context: TContext) => void;
-    setChildContext: (child: ComponentInstance, context: TContext) => void;
-};
-/**
- * Walks a composition's component tree, visiting each component instance depth-first, in order.
- * @deprecated use walkNodeTree
- */
-declare function walkComponentTree<TContext = unknown>(component: ComponentInstance, visitor: (component: ComponentInstance, ancestorsAndSelf: Array<ComponentLocationReference>, actions: WalkComponentTreeActions<TContext>, 
-/** Traversal context for this node */
-currentContext: TContext | undefined) => void, initialContext?: TContext): void;
-
 /** Ancestor location that is in a slot on a component */
 type ComponentLocationReferenceV2 = {
     type: 'slot';
@@ -13232,11 +13284,71 @@ type WalkNodeTreeOptions<TContext> = {
 };
 /** Walks a composition's content tree, visiting each component in a slot or block parameter/field depth-first, in order. */
 declare function walkNodeTree<TContext = unknown>(node: ComponentInstance | EntryData | Array<NodeLocationReference>, visitor: (info: TreeNodeInfoTypes<TContext>) => void, options?: WalkNodeTreeOptions<TContext>): void;
+/**
+ * Any types which hold an array of nodes and
+ * therefore should be iterated over as child nodes
+ */
+declare function isNestedNodeType(type: string): boolean;
 /** Gets the typed value of a block parameter or block field */
 declare function getBlockValue(component: ComponentInstance | EntryData, parameterName: string): BlockValue;
 
+interface FindInNodeTreeReference {
+    key: string;
+    pointer: string;
+    /** This might be the composition parameter, or entry field */
+    parameter: ComponentParameter;
+}
+/**
+ * Walk a Composition or Entry tree to find parameters or fields
+ * based on the predicate returning true
+ *
+ * @example
+ *
+ * const textReferences = findParameterInNodeTree(
+ *   composition,
+ *   (parameter) => parameter.type === 'text'
+ * )
+ *
+ * @param data The composition or entry data
+ * @param predicate Return true from this function to include the parameter in the results
+ */
+declare function findParameterInNodeTree(data: ComponentInstance | EntryData | Array<NodeLocationReference>, predicate: (parameter: ComponentParameter, parameterKey: string, node: ComponentInstance | EntryData | Array<NodeLocationReference>) => boolean): FindInNodeTreeReference[];
+
+/** @deprecated use walkNodeTree */
+type ComponentLocationReference = {
+    component: ComponentInstance;
+    parentSlot?: string;
+    parentSlotIndex?: number;
+};
+/** @deprecated use walkNodeTree and check for type = slot */
+type WalkComponentTreeActions<TContext> = {
+    /** Replaces the component being visited with a new object */
+    replaceComponent: (replacementComponent: ComponentInstance) => void;
+    /** Removes the component being visited from the composition */
+    removeComponent: () => void;
+    /** Inserts a new component immediately after the current component in its parent slot */
+    insertAfter: (components: ComponentInstance | ComponentInstance[]) => void;
+    /** Aborts visitation of components that are in child slots of the current component */
+    stopProcessingDescendants: () => void;
+    /**
+     * Set a new traversal context for descendants of this node.
+     * If this is not called, `context` will automatically pass through.
+     */
+    setDescendantsContext: (context: TContext) => void;
+    setChildContext: (child: ComponentInstance, context: TContext) => void;
+};
+/**
+ * Walks a composition's component tree, visiting each component instance depth-first, in order.
+ * @deprecated use walkNodeTree
+ */
+declare function walkComponentTree<TContext = unknown>(component: ComponentInstance, visitor: (component: ComponentInstance, ancestorsAndSelf: Array<ComponentLocationReference>, actions: WalkComponentTreeActions<TContext>, 
+/** Traversal context for this node */
+currentContext: TContext | undefined) => void, initialContext?: TContext): void;
+
 /** Returns the JSON pointer of a component based on its location */
 declare function getComponentJsonPointer(ancestorsAndSelf: Array<NodeLocationReference | ComponentLocationReference>): string;
+declare function getNounForLocation(parentLocation: NodeLocationReference | ComponentLocationReference | undefined): "parameters" | "fields";
+declare function getNounForNode(node: ComponentInstance | EntryData | Array<NodeLocationReference>): "parameters" | "fields";
 
 declare function getComponentPath(ancestorsAndSelf: Array<ComponentLocationReference | NodeLocationReference>): string;
 
@@ -13651,11 +13763,6 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
  * Removes things like author, stats, etc.
  */
 declare function convertEntryToPutEntry(entry: Entry): PutEntryBody;
-/**
- * Gets the object holding the properties (fields or parameters) of an entry or component instance
- * If no properties are defined, returns undefined.
- */
-declare function getPropertiesValue(entity: Pick<ComponentInstance, 'parameters'> | Pick<EntryData, 'fields'>): ComponentInstance['parameters'];
 
 declare const ATTRIBUTE_COMPONENT_ID = "data-uniform-component-id";
 declare const ATTRIBUTE_PARAMETER_ID = "data-uniform-parameter-id";
@@ -13694,7 +13801,17 @@ declare function isRootEntryReference(root: NodeLocationReference): root is Root
  * Check to see if some generic composition data structure
  * looks like Entry data
  */
-declare function isEntryData(entryData: ComponentInstance | EntryData | null | undefined): entryData is EntryData;
+declare function isEntryData(entryData: ComponentInstance | EntryData | null | undefined | unknown): entryData is EntryData;
+/**
+ * A fast, non-exhaustive guard which checks that the value is an array
+ * as well as the first item, if there is one, looks like an asset item
+ */
+declare function isAssetParamValue(value: unknown): value is AssetParamValue;
+/**
+ * A fast, non-exhaustive guard which checks the
+ * required structure of an asset item
+ */
+declare function isAssetParamValueItem(item: unknown): item is AssetParamValueItem;
 
 declare const generateHash: ({ composition, secret, }: {
     composition: RootComponentInstance;
@@ -13725,6 +13842,57 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
 declare const isComponentPlaceholderId: (id: string | undefined) => boolean;
 declare const generateComponentPlaceholderId: (randomId: string, sdkVersion: number | undefined) => string;
 
+type FlattenProperty<P> = P extends {
+    value: unknown;
+} ? P['value'] : P;
+type FlattenValues<T extends DataWithProperties> = T extends Pick<ComponentInstance, 'parameters'> ? Record<string, unknown> & {
+    [Property in keyof T['parameters']]: FlattenProperty<T['parameters'][Property]>;
+} : T extends Pick<EntryData, 'fields'> ? Record<string, unknown> & {
+    [Property in keyof T['fields']]: FlattenProperty<T['fields'][Property]>;
+} : unknown;
+/**
+ * Gets the object holding the properties (fields or parameters) of an entry or component instance
+ * If no properties are defined, returns undefined.
+ */
+declare function getPropertiesValue(entity: Pick<ComponentInstance, 'parameters'> | Pick<EntryData, 'fields'>): ComponentInstance['parameters'];
+interface FlattenValuesOptions {
+    /**
+     * Take only the first item from an array
+     * of values, flatten it and return it as a single object
+     */
+    toSingle?: boolean;
+    /**
+     * If the property has nested properties, like Blocks or Assets
+     * can, then how many levels should we traverse.
+     *
+     * You can set this to `Infinity` although it would be more
+     * advisable, for performance, to use the number you need in your code.
+     *
+     * Where:
+     * levels=0 will only extract the properties of the current object
+     * levels=1 will include any child blocks or assets on the current object
+     *          but not any grandchildren
+     *
+     * @default 1
+     */
+    levels?: number;
+}
+/**
+ * Get the data stored in the value of a component parameter
+ * or a field attached to an Entry, Block or Asset
+ */
+declare function getPropertyValue<TValue, T extends ComponentParameter<TValue>>(parameter: T): TValue;
+declare function getPropertyValue(parameter: null): null;
+declare function getPropertyValue(parameter: undefined): undefined;
+type DataWithProperties = Pick<ComponentInstance, 'parameters'> | Pick<EntryData, 'fields'>;
+declare function flattenValues(data: null, options?: FlattenValuesOptions): null;
+declare function flattenValues(data: undefined, options?: FlattenValuesOptions): undefined;
+declare function flattenValues<Data extends DataWithProperties>(data: Data | null | undefined, options?: FlattenValuesOptions): FlattenValues<Data> | null | undefined;
+declare function flattenValues<Data extends DataWithProperties>(data: Array<Data> | null | undefined, options: {
+    toSingle: true;
+} & Omit<FlattenValuesOptions, 'toSingle'>): FlattenValues<Data> | null | undefined;
+declare function flattenValues<Data extends DataWithProperties>(data: Array<Data> | null | undefined, options?: FlattenValuesOptions): Array<FlattenValues<Data>> | null | undefined;
+
 type BindVariablesResult<TValue> = {
     /** Number of dynamic expressions that attempted to be bound (regardless of the success of the binding) */
     boundCount: number;
@@ -13784,4 +13952,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
 
 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, BlockLocationReference, BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_DRAFT_STATE, CANVAS_EDITOR_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, ComponentInstanceContextualEditing, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentLocationReferenceV2, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterBlock, 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, CompositionResolvedListResponse, CompositionUIStatus, ContentClient, ContentType, ContentTypeField, ContextualEditingComponentReference, DataDiagnostic, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DeleteContentTypeOptions, DeleteEntryOptions, DismissPlaceholderMessage, DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, EdgehancersDiagnostics, EditorStateUpdatedMessage, EnhancerBuilder, EnhancerContext, EnhancerError, EntriesGetParameters, EntriesGetResponse, EntriesHistoryGetParameters, EntriesHistoryGetResponse, EntriesResolvedListResponse, Entry, EntryData, EventNames, GetContentTypesOptions, GetContentTypesResponse, GetEntriesOptions, GetEntriesResponse, GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NodeLocationReference, NonProjectMapLinkParamValue, OpenParameterEditorMessage, OverrideOptions, PLACEHOLDER_ID, PatternIssue, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, Prompt, PromptClient, PromptsDeleteParameters, PromptsGetParameters, PromptsGetResponse, PromptsPutParameters, PutContentTypeBody, PutEntryBody, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RootEntryReference, RootLocationReference, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TreeNodeInfoTypes, TriggerComponentActionMessage, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateComponentReferencesMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdateFeatureFlagsMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, WalkNodeTreeActions, WalkNodeTreeOptions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, getPropertiesValue, isAddComponentMessage, isAllowedReferrer, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isEntryData, isMovingComponentMessage, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree, walkNodeTree };
+export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AssetParamValue, type AssetParamValueItem, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_DRAFT_STATE, CANVAS_EDITOR_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, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, type ChannelSubscription, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentLocationReferenceV2, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDataDiagnostic, type CompositionDeleteParameters, type CompositionDiagnostics, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetOrderBy, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionIssue, type CompositionPatternIssue, type CompositionPutParameters, type CompositionRelationshipsClientOptions, type CompositionRelationshipsDDefinitionGetResponse, type CompositionRelationshipsDefinitionApi, type CompositionRelationshipsDefinitionGetParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextualEditingComponentReference, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryList, type EventNames, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, type InvalidationPayload, type LimitPolicy, type LinkComponentParameterValue, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type MessageHandler, type MoveComponentMessage, type NodeLocationReference, type NonProjectMapLinkParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, type PreviewEventBus, type PreviewPanelSettings, type ProjectMapLinkComponentParameterValue, type ProjectMapLinkParamValue, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PutContentTypeBody, type PutEntryBody, type ReadyMessage, type ReportRenderedCompositionsMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParameterMessage, type SpecificProjectMap, type SubscribeToCompositionOptions, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UnsubscribeCallback, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type UsageTrackingApi, type UsageTrackingGetParameters, type UsageTrackingGetResponse, type UsageTrackingPostParameters, type UsageTrackingPostResponse, type WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isEntryData, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree, walkNodeTree };

package/dist/index.esm.js

@@ -1000,25 +1000,9 @@ var EDGE_MIN_CACHE_TTL = 10;
 var EDGE_MAX_CACHE_TTL = 24 * 60 * 60;
 var EDGE_DEFAULT_CACHE_TTL = 30;
 var EDGE_CACHE_DISABLED = -1;
-
-// src/utils/entryConverter.ts
-function convertEntryToPutEntry(entry) {
-  return {
-    entry: {
-      type: entry.entry.type,
-      _dataResources: entry.entry._dataResources,
-      _id: entry.entry._id,
-      _name: entry.entry._name,
-      _slug: entry.entry._slug,
-      fields: entry.entry.fields
-    },
-    state: entry.state,
-    projectId: entry.projectId
-  };
-}
-function getPropertiesValue(entity) {
-  return "parameters" in entity && entity.parameters ? entity.parameters : "fields" in entity && entity.fields ? entity.fields : void 0;
-}
+var ASSET_PARAMETER_TYPE = "asset";
+var ASSETS_SOURCE_UNIFORM = "uniform-assets";
+var ASSETS_SOURCE_CUSTOM_URL = "custom-url";
 
 // src/utils/guards.ts
 function isRootEntryReference(root) {
@@ -1027,6 +1011,49 @@ function isRootEntryReference(root) {
 function isEntryData(entryData) {
   return Boolean(entryData && typeof entryData === "object" && "fields" in entryData);
 }
+function isAssetParamValue(value) {
+  return Array.isArray(value) && (value.length > 0 ? isAssetParamValueItem(value[0]) : true);
+}
+function isAssetParamValueItem(item) {
+  return Boolean(
+    item instanceof Object && "_source" in item && "fields" in item && item.fields instanceof Object && "url" in item.fields && item.fields.url instanceof Object
+  );
+}
+
+// src/utils/properties.ts
+function getPropertiesValue(entity) {
+  return "parameters" in entity && entity.parameters ? entity.parameters : "fields" in entity && entity.fields ? entity.fields : void 0;
+}
+function getPropertyValue(parameter) {
+  return parameter ? parameter.value : parameter;
+}
+function flattenValues(data, options = {}) {
+  if (!data) {
+    return data;
+  } else if (Array.isArray(data) && options.toSingle) {
+    return data.length > 0 ? flattenSingleNodeValues(data[0]) : void 0;
+  } else if (Array.isArray(data)) {
+    return data.map((node) => flattenSingleNodeValues(node, options));
+  } else {
+    return flattenSingleNodeValues(data, options);
+  }
+}
+function flattenSingleNodeValues(data, options = {}) {
+  const { levels = 1 } = options;
+  const properties = getPropertiesValue(data);
+  return properties ? Object.fromEntries(
+    Object.entries(properties).map(([id, parameter]) => {
+      const value = getPropertyValue(parameter);
+      if (levels > 0 && Array.isArray(value) && // In the future ASSET_PARAMETER_TYPE will be a nested data type
+      (isNestedNodeType(parameter.type) || parameter.type === ASSET_PARAMETER_TYPE)) {
+        const nestedOptions = { ...options, levels: levels - 1 };
+        return [id, value.map((item) => flattenValues(item, nestedOptions))];
+      } else {
+        return [id, value];
+      }
+    })
+  ) : properties;
+}
 
 // src/enhancement/walkNodeTree.ts
 function walkNodeTree(node, visitor, options) {
@@ -1250,7 +1277,7 @@ function walkNodeTree(node, visitor, options) {
       const propertyEntries = Object.entries(properties);
       for (let propIndex = propertyEntries.length - 1; propIndex >= 0; propIndex--) {
         const [propKey, propObject] = propertyEntries[propIndex];
-        if (propObject.type !== CANVAS_BLOCK_PARAM_TYPE)
+        if (!isNestedNodeType(propObject.type))
           continue;
         const blocks = (_b = propObject.value) != null ? _b : [];
         for (let blockIndex = blocks.length - 1; blockIndex >= 0; blockIndex--) {
@@ -1276,6 +1303,9 @@ function walkNodeTree(node, visitor, options) {
     }
   } while (componentQueue.length > 0);
 }
+function isNestedNodeType(type) {
+  return type === CANVAS_BLOCK_PARAM_TYPE;
+}
 function getBlockValue(component, parameterName) {
   var _a;
   const parameter = (_a = getPropertiesValue(component)) == null ? void 0 : _a[parameterName];
@@ -1567,6 +1597,31 @@ function getNounForLocation(parentLocation) {
   }
   return noun;
 }
+function getNounForNode(node) {
+  let noun = "parameters";
+  if (isEntryData(node)) {
+    noun = "fields";
+  }
+  return noun;
+}
+
+// src/enhancement/findInNodeTree.ts
+function findParameterInNodeTree(data, predicate) {
+  const results = [];
+  walkNodeTree(data, ({ node, ancestorsAndSelf }) => {
+    const parameters = getPropertiesValue(node);
+    if (parameters) {
+      Object.entries(parameters).filter(([key, field]) => predicate(field, key, node)).forEach(([key, field]) => {
+        results.push({
+          key,
+          pointer: (ancestorsAndSelf.length === 1 ? "" : getComponentJsonPointer(ancestorsAndSelf)) + `/${getNounForNode(node)}/${key}`,
+          parameter: field
+        });
+      });
+    }
+  });
+  return results;
+}
 
 // src/enhancement/localize.ts
 function extractLocales({ component }) {
@@ -2188,6 +2243,22 @@ var createUniformApiEnhancer = ({ apiUrl }) => {
   };
 };
 
+// src/utils/entryConverter.ts
+function convertEntryToPutEntry(entry) {
+  return {
+    entry: {
+      type: entry.entry.type,
+      _dataResources: entry.entry._dataResources,
+      _id: entry.entry._id,
+      _name: entry.entry._name,
+      _slug: entry.entry._slug,
+      fields: entry.entry.fields
+    },
+    state: entry.state,
+    projectId: entry.projectId
+  };
+}
+
 // src/utils/getParameterAttributes.ts
 var ATTRIBUTE_COMPONENT_ID = "data-uniform-component-id";
 var ATTRIBUTE_PARAMETER_ID = "data-uniform-parameter-id";
@@ -2317,9 +2388,14 @@ function parseVariableExpression(serialized, onToken) {
       continue;
     }
     if (char === variableSuffix && state === "variable") {
+      if (serialized[index - 1] === escapeCharacter) {
+        bufferEndIndex++;
+        continue;
+      }
       state = "text";
       if (bufferEndIndex > bufferStartIndex) {
-        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "variable") === false) {
+        const unescapedVariableName = serialized.substring(bufferStartIndex, bufferEndIndex).replace(/\\([${}])/g, "$1");
+        if (handleToken(unescapedVariableName, "variable") === false) {
           return tokenCount;
         }
         bufferStartIndex = bufferEndIndex + variableSuffix.length;
@@ -2379,7 +2455,7 @@ import { produce } from "immer";
 
 // src/utils/variables/createVariableReference.ts
 function createVariableReference(variableName) {
-  return `\${${variableName}}`;
+  return `\${${variableName.replace(/([${}])/g, "\\$1")}}`;
 }
 
 // src/utils/variables/bindVariablesToObject.ts
@@ -2463,6 +2539,9 @@ function handleRichTextNodeBinding(object, options) {
 import { ApiClientError as ApiClientError2 } from "@uniformdev/context/api";
 var CanvasClientError = ApiClientError2;
 export {
+  ASSETS_SOURCE_CUSTOM_URL,
+  ASSETS_SOURCE_UNIFORM,
+  ASSET_PARAMETER_TYPE,
   ATTRIBUTE_COMPONENT_ID,
   ATTRIBUTE_MULTILINE,
   ATTRIBUTE_PARAMETER_ID,
@@ -2526,21 +2605,29 @@ export {
   createVariableReference,
   enhance,
   extractLocales,
+  findParameterInNodeTree,
+  flattenValues,
   generateComponentPlaceholderId,
   generateHash,
   getBlockValue,
   getChannelName,
   getComponentJsonPointer,
   getComponentPath,
+  getNounForLocation,
+  getNounForNode,
   getParameterAttributes,
   getPropertiesValue,
+  getPropertyValue,
   isAddComponentMessage,
   isAllowedReferrer,
+  isAssetParamValue,
+  isAssetParamValueItem,
   isComponentActionMessage,
   isComponentPlaceholderId,
   isDismissPlaceholderMessage,
   isEntryData,
   isMovingComponentMessage,
+  isNestedNodeType,
   isOpenParameterEditorMessage,
   isReadyMessage,
   isReportRenderedCompositionsMessage,