@uniformdev/canvas 19.81.1 → 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'];
@@ -12851,10 +12858,6 @@ type schemas = components$1['schemas'];
 type InvalidationPayload = schemas['InvalidationPayload'];
 type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
 
-/** This is the type value for the asset parameter or field */
-declare const ASSET_PARAMETER_TYPE = "asset";
-declare const ASSETS_SOURCE_UNIFORM = "uniform-assets";
-declare const ASSETS_SOURCE_CUSTOM_URL = "custom-url";
 type AssetParamValue = AssetParamValueItem[];
 type AssetParamValueItem = {
     type: string;
@@ -13281,6 +13284,11 @@ 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;
 
@@ -13290,6 +13298,20 @@ interface FindInNodeTreeReference {
     /** 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 */
@@ -13741,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";
@@ -13786,13 +13803,13 @@ declare function isRootEntryReference(root: NodeLocationReference): root is Root
  */
 declare function isEntryData(entryData: ComponentInstance | EntryData | null | undefined | unknown): entryData is EntryData;
 /**
- * A fast, non-exhaustive guard which checks the value is an array
- * as well as the first item if there is one.
+ * 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
+ * required structure of an asset item
  */
 declare function isAssetParamValueItem(item: unknown): item is AssetParamValueItem;
 
@@ -13825,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;
@@ -13884,4 +13935,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
 
 declare const CanvasClientError: typeof ApiClientError;
 
-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, EventNames, FindInNodeTreeReference, 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, findParameterInNodeTree, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, 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'];
@@ -12851,10 +12858,6 @@ type schemas = components$1['schemas'];
 type InvalidationPayload = schemas['InvalidationPayload'];
 type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
 
-/** This is the type value for the asset parameter or field */
-declare const ASSET_PARAMETER_TYPE = "asset";
-declare const ASSETS_SOURCE_UNIFORM = "uniform-assets";
-declare const ASSETS_SOURCE_CUSTOM_URL = "custom-url";
 type AssetParamValue = AssetParamValueItem[];
 type AssetParamValueItem = {
     type: string;
@@ -13281,6 +13284,11 @@ 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;
 
@@ -13290,6 +13298,20 @@ interface FindInNodeTreeReference {
     /** 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 */
@@ -13741,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";
@@ -13786,13 +13803,13 @@ declare function isRootEntryReference(root: NodeLocationReference): root is Root
  */
 declare function isEntryData(entryData: ComponentInstance | EntryData | null | undefined | unknown): entryData is EntryData;
 /**
- * A fast, non-exhaustive guard which checks the value is an array
- * as well as the first item if there is one.
+ * 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
+ * required structure of an asset item
  */
 declare function isAssetParamValueItem(item: unknown): item is AssetParamValueItem;
 
@@ -13825,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;
@@ -13884,4 +13935,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
 
 declare const CanvasClientError: typeof ApiClientError;
 
-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, EventNames, FindInNodeTreeReference, 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, findParameterInNodeTree, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, 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) {
@@ -1036,6 +1020,37 @@ function isAssetParamValueItem(item) {
   );
 }
 
+// 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) {
   var _a, _b;
@@ -1258,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--) {
@@ -1284,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];
@@ -2199,11 +2217,6 @@ var RouteClient = class extends ApiClient8 {
   }
 };
 
-// src/types/parameters/assetParameterTypes.ts
-var ASSET_PARAMETER_TYPE = "asset";
-var ASSETS_SOURCE_UNIFORM = "uniform-assets";
-var ASSETS_SOURCE_CUSTOM_URL = "custom-url";
-
 // src/utils/createApiEnhancer.ts
 var createUniformApiEnhancer = ({ apiUrl }) => {
   return async (message) => {
@@ -2226,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";
@@ -2574,10 +2603,13 @@ export {
   getChannelName,
   getComponentJsonPointer,
   getComponentPath,
+  getNodeValues,
   getNounForLocation,
   getNounForNode,
   getParameterAttributes,
   getPropertiesValue,
+  getPropertyValue,
+  getSingleNodeValues,
   isAddComponentMessage,
   isAllowedReferrer,
   isAssetParamValue,
@@ -2587,6 +2619,7 @@ export {
   isDismissPlaceholderMessage,
   isEntryData,
   isMovingComponentMessage,
+  isNestedNodeType,
   isOpenParameterEditorMessage,
   isReadyMessage,
   isReportRenderedCompositionsMessage,

package/dist/index.js

@@ -350,10 +350,13 @@ __export(src_exports, {
   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,
@@ -363,6 +366,7 @@ __export(src_exports, {
   isDismissPlaceholderMessage: () => isDismissPlaceholderMessage,
   isEntryData: () => isEntryData,
   isMovingComponentMessage: () => isMovingComponentMessage,
+  isNestedNodeType: () => isNestedNodeType,
   isOpenParameterEditorMessage: () => isOpenParameterEditorMessage,
   isReadyMessage: () => isReadyMessage,
   isReportRenderedCompositionsMessage: () => isReportRenderedCompositionsMessage,
@@ -1122,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) {
@@ -1158,6 +1146,37 @@ function isAssetParamValueItem(item) {
   );
 }
 
+// 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) {
   var _a, _b;
@@ -1380,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--) {
@@ -1406,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];
@@ -2321,11 +2343,6 @@ var RouteClient = class extends import_api9.ApiClient {
   }
 };
 
-// src/types/parameters/assetParameterTypes.ts
-var ASSET_PARAMETER_TYPE = "asset";
-var ASSETS_SOURCE_UNIFORM = "uniform-assets";
-var ASSETS_SOURCE_CUSTOM_URL = "custom-url";
-
 // src/utils/createApiEnhancer.ts
 var createUniformApiEnhancer = ({ apiUrl }) => {
   return async (message) => {
@@ -2348,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";
@@ -2697,10 +2730,13 @@ var CanvasClientError = import_api10.ApiClientError;
   getChannelName,
   getComponentJsonPointer,
   getComponentPath,
+  getNodeValues,
   getNounForLocation,
   getNounForNode,
   getParameterAttributes,
   getPropertiesValue,
+  getPropertyValue,
+  getSingleNodeValues,
   isAddComponentMessage,
   isAllowedReferrer,
   isAssetParamValue,
@@ -2710,6 +2746,7 @@ var CanvasClientError = import_api10.ApiClientError;
   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) {
@@ -1036,6 +1020,37 @@ function isAssetParamValueItem(item) {
   );
 }
 
+// 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) {
   var _a, _b;
@@ -1258,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--) {
@@ -1284,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];
@@ -2199,11 +2217,6 @@ var RouteClient = class extends ApiClient8 {
   }
 };
 
-// src/types/parameters/assetParameterTypes.ts
-var ASSET_PARAMETER_TYPE = "asset";
-var ASSETS_SOURCE_UNIFORM = "uniform-assets";
-var ASSETS_SOURCE_CUSTOM_URL = "custom-url";
-
 // src/utils/createApiEnhancer.ts
 var createUniformApiEnhancer = ({ apiUrl }) => {
   return async (message) => {
@@ -2226,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";
@@ -2574,10 +2603,13 @@ export {
   getChannelName,
   getComponentJsonPointer,
   getComponentPath,
+  getNodeValues,
   getNounForLocation,
   getNounForNode,
   getParameterAttributes,
   getPropertiesValue,
+  getPropertyValue,
+  getSingleNodeValues,
   isAddComponentMessage,
   isAllowedReferrer,
   isAssetParamValue,
@@ -2587,6 +2619,7 @@ export {
   isDismissPlaceholderMessage,
   isEntryData,
   isMovingComponentMessage,
+  isNestedNodeType,
   isOpenParameterEditorMessage,
   isReadyMessage,
   isReportRenderedCompositionsMessage,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "19.81.1",
+  "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.81.1",
-    "@uniformdev/context": "19.81.1",
+    "@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": "e72e4f188122bfe8b9944515be927d1f3febf257"
+  "gitHead": "2fbda83df1085a9a91c7fbe9ac53056cc64707d2"
 }