@uniformdev/canvas 19.80.0 → 19.81.2-alpha.22

package/dist/index.d.mts

@@ -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,40 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
 declare const isComponentPlaceholderId: (id: string | undefined) => boolean;
 declare const generateComponentPlaceholderId: (randomId: string, sdkVersion: number | undefined) => string;
 
+/**
+ * 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 GetNodeValuesOptions {
+    /**
+     * 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 NodeWithProperties = Pick<ComponentInstance, 'parameters'> | Pick<EntryData, 'fields'>;
+declare function getNodeValues(node: NodeWithProperties, options?: GetNodeValuesOptions): Record<string, unknown>;
+declare function getNodeValues(node: Array<NodeWithProperties>, options?: GetNodeValuesOptions): Array<Record<string, unknown>>;
+declare function getSingleNodeValues(node: NodeWithProperties, options?: GetNodeValuesOptions): Record<string, unknown>;
+
 type BindVariablesResult<TValue> = {
     /** Number of dynamic expressions that attempted to be bound (regardless of the success of the binding) */
     boundCount: number;
@@ -13784,4 +13935,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, AddComponentMessage, AssetParamValue, AssetParamValueItem, 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, EntryList, EventNames, FindInNodeTreeReference, GetContentTypesOptions, GetContentTypesResponse, GetEntriesOptions, GetEntriesResponse, GetNodeValuesOptions, 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, NodeWithProperties, 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, findParameterInNodeTree, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getNodeValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, getSingleNodeValues, 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.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,40 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
 declare const isComponentPlaceholderId: (id: string | undefined) => boolean;
 declare const generateComponentPlaceholderId: (randomId: string, sdkVersion: number | undefined) => string;
 
+/**
+ * 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 GetNodeValuesOptions {
+    /**
+     * 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 NodeWithProperties = Pick<ComponentInstance, 'parameters'> | Pick<EntryData, 'fields'>;
+declare function getNodeValues(node: NodeWithProperties, options?: GetNodeValuesOptions): Record<string, unknown>;
+declare function getNodeValues(node: Array<NodeWithProperties>, options?: GetNodeValuesOptions): Array<Record<string, unknown>>;
+declare function getSingleNodeValues(node: NodeWithProperties, options?: GetNodeValuesOptions): Record<string, unknown>;
+
 type BindVariablesResult<TValue> = {
     /** Number of dynamic expressions that attempted to be bound (regardless of the success of the binding) */
     boundCount: number;
@@ -13784,4 +13935,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, AddComponentMessage, AssetParamValue, AssetParamValueItem, 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, EntryList, EventNames, FindInNodeTreeReference, GetContentTypesOptions, GetContentTypesResponse, GetEntriesOptions, GetEntriesResponse, GetNodeValuesOptions, 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, NodeWithProperties, 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, findParameterInNodeTree, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getNodeValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, getSingleNodeValues, 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,45 @@ 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 getNodeValues(node, options = {}) {
+  if (Array.isArray(node)) {
+    return node.map((node2) => getSingleNodeValues(node2, options));
+  } else {
+    return getSingleNodeValues(node, options);
+  }
+}
+function getSingleNodeValues(node, options = {}) {
+  const { levels = 1 } = options;
+  const properties = getPropertiesValue(node);
+  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 node type
+      (isNestedNodeType(parameter.type) || parameter.type === ASSET_PARAMETER_TYPE)) {
+        const nestedOptions = { ...options, levels: levels - 1 };
+        return [id, value.map((item) => getNodeValues(item, nestedOptions))];
+      } else {
+        return [id, value];
+      }
+    })
+  ) : properties;
+}
 
 // src/enhancement/walkNodeTree.ts
 function walkNodeTree(node, visitor, options) {
@@ -1250,7 +1273,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 +1299,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 +1593,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 +2239,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";
@@ -2463,6 +2530,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 +2596,30 @@ export {
   createVariableReference,
   enhance,
   extractLocales,
+  findParameterInNodeTree,
   generateComponentPlaceholderId,
   generateHash,
   getBlockValue,
   getChannelName,
   getComponentJsonPointer,
   getComponentPath,
+  getNodeValues,
+  getNounForLocation,
+  getNounForNode,
   getParameterAttributes,
   getPropertiesValue,
+  getPropertyValue,
+  getSingleNodeValues,
   isAddComponentMessage,
   isAllowedReferrer,
+  isAssetParamValue,
+  isAssetParamValueItem,
   isComponentActionMessage,
   isComponentPlaceholderId,
   isDismissPlaceholderMessage,
   isEntryData,
   isMovingComponentMessage,
+  isNestedNodeType,
   isOpenParameterEditorMessage,
   isReadyMessage,
   isReportRenderedCompositionsMessage,

package/dist/index.js

@@ -277,6 +277,9 @@ var require_retry2 = __commonJS({
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  ASSETS_SOURCE_CUSTOM_URL: () => ASSETS_SOURCE_CUSTOM_URL,
+  ASSETS_SOURCE_UNIFORM: () => ASSETS_SOURCE_UNIFORM,
+  ASSET_PARAMETER_TYPE: () => ASSET_PARAMETER_TYPE,
   ATTRIBUTE_COMPONENT_ID: () => ATTRIBUTE_COMPONENT_ID,
   ATTRIBUTE_MULTILINE: () => ATTRIBUTE_MULTILINE,
   ATTRIBUTE_PARAMETER_ID: () => ATTRIBUTE_PARAMETER_ID,
@@ -340,21 +343,30 @@ __export(src_exports, {
   createVariableReference: () => createVariableReference,
   enhance: () => enhance,
   extractLocales: () => extractLocales,
+  findParameterInNodeTree: () => findParameterInNodeTree,
   generateComponentPlaceholderId: () => generateComponentPlaceholderId,
   generateHash: () => generateHash,
   getBlockValue: () => getBlockValue,
   getChannelName: () => getChannelName,
   getComponentJsonPointer: () => getComponentJsonPointer,
   getComponentPath: () => getComponentPath,
+  getNodeValues: () => getNodeValues,
+  getNounForLocation: () => getNounForLocation,
+  getNounForNode: () => getNounForNode,
   getParameterAttributes: () => getParameterAttributes,
   getPropertiesValue: () => getPropertiesValue,
+  getPropertyValue: () => getPropertyValue,
+  getSingleNodeValues: () => getSingleNodeValues,
   isAddComponentMessage: () => isAddComponentMessage,
   isAllowedReferrer: () => isAllowedReferrer,
+  isAssetParamValue: () => isAssetParamValue,
+  isAssetParamValueItem: () => isAssetParamValueItem,
   isComponentActionMessage: () => isComponentActionMessage,
   isComponentPlaceholderId: () => isComponentPlaceholderId,
   isDismissPlaceholderMessage: () => isDismissPlaceholderMessage,
   isEntryData: () => isEntryData,
   isMovingComponentMessage: () => isMovingComponentMessage,
+  isNestedNodeType: () => isNestedNodeType,
   isOpenParameterEditorMessage: () => isOpenParameterEditorMessage,
   isReadyMessage: () => isReadyMessage,
   isReportRenderedCompositionsMessage: () => isReportRenderedCompositionsMessage,
@@ -1114,25 +1126,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) {
@@ -1141,6 +1137,45 @@ 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 getNodeValues(node, options = {}) {
+  if (Array.isArray(node)) {
+    return node.map((node2) => getSingleNodeValues(node2, options));
+  } else {
+    return getSingleNodeValues(node, options);
+  }
+}
+function getSingleNodeValues(node, options = {}) {
+  const { levels = 1 } = options;
+  const properties = getPropertiesValue(node);
+  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 node type
+      (isNestedNodeType(parameter.type) || parameter.type === ASSET_PARAMETER_TYPE)) {
+        const nestedOptions = { ...options, levels: levels - 1 };
+        return [id, value.map((item) => getNodeValues(item, nestedOptions))];
+      } else {
+        return [id, value];
+      }
+    })
+  ) : properties;
+}
 
 // src/enhancement/walkNodeTree.ts
 function walkNodeTree(node, visitor, options) {
@@ -1364,7 +1399,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--) {
@@ -1390,6 +1425,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];
@@ -1681,6 +1719,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 }) {
@@ -2302,6 +2365,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";
@@ -2578,6 +2657,9 @@ var import_api10 = require("@uniformdev/context/api");
 var CanvasClientError = import_api10.ApiClientError;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ASSETS_SOURCE_CUSTOM_URL,
+  ASSETS_SOURCE_UNIFORM,
+  ASSET_PARAMETER_TYPE,
   ATTRIBUTE_COMPONENT_ID,
   ATTRIBUTE_MULTILINE,
   ATTRIBUTE_PARAMETER_ID,
@@ -2641,21 +2723,30 @@ var CanvasClientError = import_api10.ApiClientError;
   createVariableReference,
   enhance,
   extractLocales,
+  findParameterInNodeTree,
   generateComponentPlaceholderId,
   generateHash,
   getBlockValue,
   getChannelName,
   getComponentJsonPointer,
   getComponentPath,
+  getNodeValues,
+  getNounForLocation,
+  getNounForNode,
   getParameterAttributes,
   getPropertiesValue,
+  getPropertyValue,
+  getSingleNodeValues,
   isAddComponentMessage,
   isAllowedReferrer,
+  isAssetParamValue,
+  isAssetParamValueItem,
   isComponentActionMessage,
   isComponentPlaceholderId,
   isDismissPlaceholderMessage,
   isEntryData,
   isMovingComponentMessage,
+  isNestedNodeType,
   isOpenParameterEditorMessage,
   isReadyMessage,
   isReportRenderedCompositionsMessage,

package/dist/index.mjs

@@ -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,45 @@ 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 getNodeValues(node, options = {}) {
+  if (Array.isArray(node)) {
+    return node.map((node2) => getSingleNodeValues(node2, options));
+  } else {
+    return getSingleNodeValues(node, options);
+  }
+}
+function getSingleNodeValues(node, options = {}) {
+  const { levels = 1 } = options;
+  const properties = getPropertiesValue(node);
+  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 node type
+      (isNestedNodeType(parameter.type) || parameter.type === ASSET_PARAMETER_TYPE)) {
+        const nestedOptions = { ...options, levels: levels - 1 };
+        return [id, value.map((item) => getNodeValues(item, nestedOptions))];
+      } else {
+        return [id, value];
+      }
+    })
+  ) : properties;
+}
 
 // src/enhancement/walkNodeTree.ts
 function walkNodeTree(node, visitor, options) {
@@ -1250,7 +1273,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 +1299,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 +1593,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 +2239,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";
@@ -2463,6 +2530,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 +2596,30 @@ export {
   createVariableReference,
   enhance,
   extractLocales,
+  findParameterInNodeTree,
   generateComponentPlaceholderId,
   generateHash,
   getBlockValue,
   getChannelName,
   getComponentJsonPointer,
   getComponentPath,
+  getNodeValues,
+  getNounForLocation,
+  getNounForNode,
   getParameterAttributes,
   getPropertiesValue,
+  getPropertyValue,
+  getSingleNodeValues,
   isAddComponentMessage,
   isAllowedReferrer,
+  isAssetParamValue,
+  isAssetParamValueItem,
   isComponentActionMessage,
   isComponentPlaceholderId,
   isDismissPlaceholderMessage,
   isEntryData,
   isMovingComponentMessage,
+  isNestedNodeType,
   isOpenParameterEditorMessage,
   isReadyMessage,
   isReportRenderedCompositionsMessage,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "19.80.0",
+  "version": "19.81.2-alpha.22+2fbda83df",
   "description": "Common functionality and types for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -38,8 +38,8 @@
     "pusher-js": "8.2.0"
   },
   "dependencies": {
-    "@uniformdev/assets": "19.80.0",
-    "@uniformdev/context": "19.80.0",
+    "@uniformdev/assets": "19.81.2-alpha.22+2fbda83df",
+    "@uniformdev/context": "19.81.2-alpha.22+2fbda83df",
     "immer": "9.0.21"
   },
   "files": [
@@ -48,5 +48,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8c61dce79f176cb5aa3cb163657326407f17dee6"
+  "gitHead": "2fbda83df1085a9a91c7fbe9ac53056cc64707d2"
 }