@uniformdev/canvas 19.131.1-alpha.2 → 19.131.1-alpha.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +115 -3
- package/dist/index.d.ts +115 -3
- package/dist/index.esm.js +10 -3
- package/dist/index.js +10 -3
- package/dist/index.mjs +10 -3
- package/package.json +4 -4
package/dist/index.d.mts
CHANGED
|
@@ -8272,6 +8272,12 @@ interface paths$6 {
|
|
|
8272
8272
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null.
|
|
8273
8273
|
*/
|
|
8274
8274
|
releaseId?: components$4["parameters"]["releaseId"];
|
|
8275
|
+
/**
|
|
8276
|
+
* @deprecated Search on textual fields of a composition.
|
|
8277
|
+
* Note: for long text fields the tail of the text is not guaranteed to be searchable.
|
|
8278
|
+
* Example: ?search=hello
|
|
8279
|
+
*/
|
|
8280
|
+
search?: components$4["parameters"]["search"];
|
|
8275
8281
|
};
|
|
8276
8282
|
};
|
|
8277
8283
|
responses: {
|
|
@@ -8629,6 +8635,13 @@ interface components$4 {
|
|
|
8629
8635
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null.
|
|
8630
8636
|
*/
|
|
8631
8637
|
releaseId: string;
|
|
8638
|
+
/**
|
|
8639
|
+
* @deprecated
|
|
8640
|
+
* @description Search on textual fields of a composition.
|
|
8641
|
+
* Note: for long text fields the tail of the text is not guaranteed to be searchable.
|
|
8642
|
+
* Example: ?search=hello
|
|
8643
|
+
*/
|
|
8644
|
+
search: string;
|
|
8632
8645
|
};
|
|
8633
8646
|
}
|
|
8634
8647
|
interface external$7 {
|
|
@@ -11045,6 +11058,12 @@ interface external$5 {
|
|
|
11045
11058
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null.
|
|
11046
11059
|
*/
|
|
11047
11060
|
releaseId?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["releaseId"];
|
|
11061
|
+
/**
|
|
11062
|
+
* @deprecated Search on textual fields of a composition.
|
|
11063
|
+
* Note: for long text fields the tail of the text is not guaranteed to be searchable.
|
|
11064
|
+
* Example: ?search=hello
|
|
11065
|
+
*/
|
|
11066
|
+
search?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["search"];
|
|
11048
11067
|
};
|
|
11049
11068
|
};
|
|
11050
11069
|
responses: {
|
|
@@ -11402,6 +11421,13 @@ interface external$5 {
|
|
|
11402
11421
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null.
|
|
11403
11422
|
*/
|
|
11404
11423
|
releaseId: string;
|
|
11424
|
+
/**
|
|
11425
|
+
* @deprecated
|
|
11426
|
+
* @description Search on textual fields of a composition.
|
|
11427
|
+
* Note: for long text fields the tail of the text is not guaranteed to be searchable.
|
|
11428
|
+
* Example: ?search=hello
|
|
11429
|
+
*/
|
|
11430
|
+
search: string;
|
|
11405
11431
|
};
|
|
11406
11432
|
};
|
|
11407
11433
|
operations: {};
|
|
@@ -13339,6 +13365,12 @@ interface external$4 {
|
|
|
13339
13365
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null.
|
|
13340
13366
|
*/
|
|
13341
13367
|
releaseId?: external$4["v1-canvas.swagger.yml"]["components"]["parameters"]["releaseId"];
|
|
13368
|
+
/**
|
|
13369
|
+
* @deprecated Search on textual fields of a composition.
|
|
13370
|
+
* Note: for long text fields the tail of the text is not guaranteed to be searchable.
|
|
13371
|
+
* Example: ?search=hello
|
|
13372
|
+
*/
|
|
13373
|
+
search?: external$4["v1-canvas.swagger.yml"]["components"]["parameters"]["search"];
|
|
13342
13374
|
};
|
|
13343
13375
|
};
|
|
13344
13376
|
responses: {
|
|
@@ -13696,6 +13728,13 @@ interface external$4 {
|
|
|
13696
13728
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null.
|
|
13697
13729
|
*/
|
|
13698
13730
|
releaseId: string;
|
|
13731
|
+
/**
|
|
13732
|
+
* @deprecated
|
|
13733
|
+
* @description Search on textual fields of a composition.
|
|
13734
|
+
* Note: for long text fields the tail of the text is not guaranteed to be searchable.
|
|
13735
|
+
* Example: ?search=hello
|
|
13736
|
+
*/
|
|
13737
|
+
search: string;
|
|
13699
13738
|
};
|
|
13700
13739
|
};
|
|
13701
13740
|
operations: {};
|
|
@@ -14098,12 +14137,86 @@ type CanvasClientOptions = ClientOptions & {
|
|
|
14098
14137
|
edgeApiHost?: string;
|
|
14099
14138
|
disableSWR?: boolean;
|
|
14100
14139
|
};
|
|
14140
|
+
type CompositionFilters = Partial<Record<'entityId' | 'releaseId' | 'type' | 'uiStatus', {
|
|
14141
|
+
eq: string;
|
|
14142
|
+
} | {
|
|
14143
|
+
neq: string;
|
|
14144
|
+
} | {
|
|
14145
|
+
in: string[];
|
|
14146
|
+
} | {
|
|
14147
|
+
nin: string[];
|
|
14148
|
+
}> | Record<`${'entityId' | 'releaseId' | 'type' | 'uiStatus'}[${'eq' | 'neq'}]`, string> | Record<`${'entityId' | 'releaseId' | 'type' | 'uiStatus'}[${'in' | 'nin'}]`, string[]> | Record<'created' | 'modified', {
|
|
14149
|
+
eq: string;
|
|
14150
|
+
} | {
|
|
14151
|
+
neq: string;
|
|
14152
|
+
} | {
|
|
14153
|
+
in: string[];
|
|
14154
|
+
} | {
|
|
14155
|
+
nin: string[];
|
|
14156
|
+
} | {
|
|
14157
|
+
gt: string;
|
|
14158
|
+
} | {
|
|
14159
|
+
gte: string;
|
|
14160
|
+
} | {
|
|
14161
|
+
lt: string;
|
|
14162
|
+
} | {
|
|
14163
|
+
lte: string;
|
|
14164
|
+
}> | Record<`${'created' | 'modified'}[${'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte'}]`, string> | Record<`${'created' | 'modified'}[${'in' | 'nin'}]`, string[]> | Record<'locale' | 'patternId', {
|
|
14165
|
+
eq: string;
|
|
14166
|
+
} | {
|
|
14167
|
+
neq: string;
|
|
14168
|
+
} | {
|
|
14169
|
+
in: string[];
|
|
14170
|
+
} | {
|
|
14171
|
+
nin: string[];
|
|
14172
|
+
} | {
|
|
14173
|
+
def: boolean | 'true' | 'false';
|
|
14174
|
+
}> | Record<`${'locale' | 'patternId'}[${'eq' | 'neq'}]`, string> | Record<`${'locale' | 'patternId'}[${'in' | 'nin'}]`, string[]> | Record<`${'locale' | 'patternId'}[def]`, boolean | 'true' | 'false'> | Record<'name' | 'slug', {
|
|
14175
|
+
match: string;
|
|
14176
|
+
} | {
|
|
14177
|
+
eq: string;
|
|
14178
|
+
} | {
|
|
14179
|
+
neq: string;
|
|
14180
|
+
} | {
|
|
14181
|
+
in: string[];
|
|
14182
|
+
} | {
|
|
14183
|
+
nin: string[];
|
|
14184
|
+
} | {
|
|
14185
|
+
def: boolean | 'true' | 'false';
|
|
14186
|
+
}> | Record<`${'name' | 'slug'}[${'match' | 'eq' | 'neq'}]`, string> | Record<`${'name' | 'slug'}[${'in' | 'nin'}]`, string[]> | Record<`${'name' | 'slug'}[def]`, boolean | 'true' | 'false'> | Record<'isPattern', {
|
|
14187
|
+
eq: boolean | 'true' | 'false';
|
|
14188
|
+
} | {
|
|
14189
|
+
neq: boolean | 'true' | 'false';
|
|
14190
|
+
}> | Record<`isPattern[${'eq' | 'neq'}]`, boolean | 'true' | 'false'> | Record<`parameters.${string}`, {
|
|
14191
|
+
match: string;
|
|
14192
|
+
} | {
|
|
14193
|
+
eq: string | number | boolean;
|
|
14194
|
+
} | {
|
|
14195
|
+
neq: string | number | boolean;
|
|
14196
|
+
} | {
|
|
14197
|
+
in: (string | number | boolean)[];
|
|
14198
|
+
} | {
|
|
14199
|
+
nin: (string | number | boolean)[];
|
|
14200
|
+
} | {
|
|
14201
|
+
gt: string | number;
|
|
14202
|
+
} | {
|
|
14203
|
+
gte: string | number;
|
|
14204
|
+
} | {
|
|
14205
|
+
lt: string | number;
|
|
14206
|
+
} | {
|
|
14207
|
+
lte: string | number;
|
|
14208
|
+
} | {
|
|
14209
|
+
def: boolean | 'true' | 'false';
|
|
14210
|
+
}> | Record<`parameters.${string}[match]`, string> | Record<`parameters.${string}[${'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte'}]`, string | number> | Record<`parameters.${string}[${'in' | 'nin'}]`, (string | number)[]> | Record<`parameters.${string}[def]`, boolean | 'true' | 'false'>>;
|
|
14101
14211
|
declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
14102
14212
|
private edgeApiHost;
|
|
14103
14213
|
private edgeApiRequestInit?;
|
|
14104
14214
|
constructor(options: CanvasClientOptions);
|
|
14105
14215
|
/** Fetches lists of Canvas compositions, optionally by type */
|
|
14106
|
-
getCompositionList(params?: Omit<CompositionGetParameters, 'projectId' | 'componentId' | 'compositionId' | 'slug'> &
|
|
14216
|
+
getCompositionList(params?: Omit<CompositionGetParameters, 'projectId' | 'componentId' | 'compositionId' | 'slug'> & {
|
|
14217
|
+
/** @deprecated do not use */
|
|
14218
|
+
filters?: CompositionFilters;
|
|
14219
|
+
} & ({
|
|
14107
14220
|
resolveData: true;
|
|
14108
14221
|
diagnostics?: boolean;
|
|
14109
14222
|
} | {
|
|
@@ -14157,7 +14270,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
|
14157
14270
|
canBeComposition?: boolean | undefined;
|
|
14158
14271
|
parameters?: {
|
|
14159
14272
|
id: string;
|
|
14160
|
-
/** Fetches a component definition's composition defaults */
|
|
14161
14273
|
name: string;
|
|
14162
14274
|
helpText?: string | undefined;
|
|
14163
14275
|
type: string;
|
|
@@ -17067,4 +17179,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
|
|
|
17067
17179
|
|
|
17068
17180
|
declare const CanvasClientError: typeof ApiClientError;
|
|
17069
17181
|
|
|
17070
|
-
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AssetParamValue, type AssetParamValueItem, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, type ChannelSubscription, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentLocationReferenceV2, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDataDiagnostic, type CompositionDeleteParameters, type CompositionDiagnostics, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetOrderBy, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionIssue, type CompositionPatternIssue, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextualEditingComponentReference, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryList, type EventNames, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type LimitPolicy, type LinkComponentParameterValue, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeDeprecatedOptions, type LocalizeModernOptions, type MessageHandler, type MoveComponentMessage, type NodeLocationReference, type NonProjectMapLinkParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, type PreviewEventBus, type PreviewPanelSettings, type ProjectMapLinkComponentParameterValue, type ProjectMapLinkParamValue, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PutContentTypeBody, type PutEntryBody, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParameterMessage, type SpecificProjectMap, type SubscribeToCompositionOptions, type SuggestComponentMessage, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UnsubscribeCallback, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isEntryData, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, subscribeToComposition, walkComponentTree, walkNodeTree };
|
|
17182
|
+
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AssetParamValue, type AssetParamValueItem, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, type ChannelSubscription, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentLocationReferenceV2, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDataDiagnostic, type CompositionDeleteParameters, type CompositionDiagnostics, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetOrderBy, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionIssue, type CompositionPatternIssue, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextualEditingComponentReference, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryList, type EventNames, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type LimitPolicy, type LinkComponentParameterValue, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeDeprecatedOptions, type LocalizeModernOptions, type MessageHandler, type MoveComponentMessage, type NodeLocationReference, type NonProjectMapLinkParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, type PreviewEventBus, type PreviewPanelSettings, type ProjectMapLinkComponentParameterValue, type ProjectMapLinkParamValue, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PutContentTypeBody, type PutEntryBody, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParameterMessage, type SpecificProjectMap, type SubscribeToCompositionOptions, type SuggestComponentMessage, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UnsubscribeCallback, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isEntryData, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, subscribeToComposition, walkComponentTree, walkNodeTree };
|
package/dist/index.d.ts
CHANGED
|
@@ -8272,6 +8272,12 @@ interface paths$6 {
|
|
|
8272
8272
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null.
|
|
8273
8273
|
*/
|
|
8274
8274
|
releaseId?: components$4["parameters"]["releaseId"];
|
|
8275
|
+
/**
|
|
8276
|
+
* @deprecated Search on textual fields of a composition.
|
|
8277
|
+
* Note: for long text fields the tail of the text is not guaranteed to be searchable.
|
|
8278
|
+
* Example: ?search=hello
|
|
8279
|
+
*/
|
|
8280
|
+
search?: components$4["parameters"]["search"];
|
|
8275
8281
|
};
|
|
8276
8282
|
};
|
|
8277
8283
|
responses: {
|
|
@@ -8629,6 +8635,13 @@ interface components$4 {
|
|
|
8629
8635
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null.
|
|
8630
8636
|
*/
|
|
8631
8637
|
releaseId: string;
|
|
8638
|
+
/**
|
|
8639
|
+
* @deprecated
|
|
8640
|
+
* @description Search on textual fields of a composition.
|
|
8641
|
+
* Note: for long text fields the tail of the text is not guaranteed to be searchable.
|
|
8642
|
+
* Example: ?search=hello
|
|
8643
|
+
*/
|
|
8644
|
+
search: string;
|
|
8632
8645
|
};
|
|
8633
8646
|
}
|
|
8634
8647
|
interface external$7 {
|
|
@@ -11045,6 +11058,12 @@ interface external$5 {
|
|
|
11045
11058
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null.
|
|
11046
11059
|
*/
|
|
11047
11060
|
releaseId?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["releaseId"];
|
|
11061
|
+
/**
|
|
11062
|
+
* @deprecated Search on textual fields of a composition.
|
|
11063
|
+
* Note: for long text fields the tail of the text is not guaranteed to be searchable.
|
|
11064
|
+
* Example: ?search=hello
|
|
11065
|
+
*/
|
|
11066
|
+
search?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["search"];
|
|
11048
11067
|
};
|
|
11049
11068
|
};
|
|
11050
11069
|
responses: {
|
|
@@ -11402,6 +11421,13 @@ interface external$5 {
|
|
|
11402
11421
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null.
|
|
11403
11422
|
*/
|
|
11404
11423
|
releaseId: string;
|
|
11424
|
+
/**
|
|
11425
|
+
* @deprecated
|
|
11426
|
+
* @description Search on textual fields of a composition.
|
|
11427
|
+
* Note: for long text fields the tail of the text is not guaranteed to be searchable.
|
|
11428
|
+
* Example: ?search=hello
|
|
11429
|
+
*/
|
|
11430
|
+
search: string;
|
|
11405
11431
|
};
|
|
11406
11432
|
};
|
|
11407
11433
|
operations: {};
|
|
@@ -13339,6 +13365,12 @@ interface external$4 {
|
|
|
13339
13365
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null.
|
|
13340
13366
|
*/
|
|
13341
13367
|
releaseId?: external$4["v1-canvas.swagger.yml"]["components"]["parameters"]["releaseId"];
|
|
13368
|
+
/**
|
|
13369
|
+
* @deprecated Search on textual fields of a composition.
|
|
13370
|
+
* Note: for long text fields the tail of the text is not guaranteed to be searchable.
|
|
13371
|
+
* Example: ?search=hello
|
|
13372
|
+
*/
|
|
13373
|
+
search?: external$4["v1-canvas.swagger.yml"]["components"]["parameters"]["search"];
|
|
13342
13374
|
};
|
|
13343
13375
|
};
|
|
13344
13376
|
responses: {
|
|
@@ -13696,6 +13728,13 @@ interface external$4 {
|
|
|
13696
13728
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null.
|
|
13697
13729
|
*/
|
|
13698
13730
|
releaseId: string;
|
|
13731
|
+
/**
|
|
13732
|
+
* @deprecated
|
|
13733
|
+
* @description Search on textual fields of a composition.
|
|
13734
|
+
* Note: for long text fields the tail of the text is not guaranteed to be searchable.
|
|
13735
|
+
* Example: ?search=hello
|
|
13736
|
+
*/
|
|
13737
|
+
search: string;
|
|
13699
13738
|
};
|
|
13700
13739
|
};
|
|
13701
13740
|
operations: {};
|
|
@@ -14098,12 +14137,86 @@ type CanvasClientOptions = ClientOptions & {
|
|
|
14098
14137
|
edgeApiHost?: string;
|
|
14099
14138
|
disableSWR?: boolean;
|
|
14100
14139
|
};
|
|
14140
|
+
type CompositionFilters = Partial<Record<'entityId' | 'releaseId' | 'type' | 'uiStatus', {
|
|
14141
|
+
eq: string;
|
|
14142
|
+
} | {
|
|
14143
|
+
neq: string;
|
|
14144
|
+
} | {
|
|
14145
|
+
in: string[];
|
|
14146
|
+
} | {
|
|
14147
|
+
nin: string[];
|
|
14148
|
+
}> | Record<`${'entityId' | 'releaseId' | 'type' | 'uiStatus'}[${'eq' | 'neq'}]`, string> | Record<`${'entityId' | 'releaseId' | 'type' | 'uiStatus'}[${'in' | 'nin'}]`, string[]> | Record<'created' | 'modified', {
|
|
14149
|
+
eq: string;
|
|
14150
|
+
} | {
|
|
14151
|
+
neq: string;
|
|
14152
|
+
} | {
|
|
14153
|
+
in: string[];
|
|
14154
|
+
} | {
|
|
14155
|
+
nin: string[];
|
|
14156
|
+
} | {
|
|
14157
|
+
gt: string;
|
|
14158
|
+
} | {
|
|
14159
|
+
gte: string;
|
|
14160
|
+
} | {
|
|
14161
|
+
lt: string;
|
|
14162
|
+
} | {
|
|
14163
|
+
lte: string;
|
|
14164
|
+
}> | Record<`${'created' | 'modified'}[${'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte'}]`, string> | Record<`${'created' | 'modified'}[${'in' | 'nin'}]`, string[]> | Record<'locale' | 'patternId', {
|
|
14165
|
+
eq: string;
|
|
14166
|
+
} | {
|
|
14167
|
+
neq: string;
|
|
14168
|
+
} | {
|
|
14169
|
+
in: string[];
|
|
14170
|
+
} | {
|
|
14171
|
+
nin: string[];
|
|
14172
|
+
} | {
|
|
14173
|
+
def: boolean | 'true' | 'false';
|
|
14174
|
+
}> | Record<`${'locale' | 'patternId'}[${'eq' | 'neq'}]`, string> | Record<`${'locale' | 'patternId'}[${'in' | 'nin'}]`, string[]> | Record<`${'locale' | 'patternId'}[def]`, boolean | 'true' | 'false'> | Record<'name' | 'slug', {
|
|
14175
|
+
match: string;
|
|
14176
|
+
} | {
|
|
14177
|
+
eq: string;
|
|
14178
|
+
} | {
|
|
14179
|
+
neq: string;
|
|
14180
|
+
} | {
|
|
14181
|
+
in: string[];
|
|
14182
|
+
} | {
|
|
14183
|
+
nin: string[];
|
|
14184
|
+
} | {
|
|
14185
|
+
def: boolean | 'true' | 'false';
|
|
14186
|
+
}> | Record<`${'name' | 'slug'}[${'match' | 'eq' | 'neq'}]`, string> | Record<`${'name' | 'slug'}[${'in' | 'nin'}]`, string[]> | Record<`${'name' | 'slug'}[def]`, boolean | 'true' | 'false'> | Record<'isPattern', {
|
|
14187
|
+
eq: boolean | 'true' | 'false';
|
|
14188
|
+
} | {
|
|
14189
|
+
neq: boolean | 'true' | 'false';
|
|
14190
|
+
}> | Record<`isPattern[${'eq' | 'neq'}]`, boolean | 'true' | 'false'> | Record<`parameters.${string}`, {
|
|
14191
|
+
match: string;
|
|
14192
|
+
} | {
|
|
14193
|
+
eq: string | number | boolean;
|
|
14194
|
+
} | {
|
|
14195
|
+
neq: string | number | boolean;
|
|
14196
|
+
} | {
|
|
14197
|
+
in: (string | number | boolean)[];
|
|
14198
|
+
} | {
|
|
14199
|
+
nin: (string | number | boolean)[];
|
|
14200
|
+
} | {
|
|
14201
|
+
gt: string | number;
|
|
14202
|
+
} | {
|
|
14203
|
+
gte: string | number;
|
|
14204
|
+
} | {
|
|
14205
|
+
lt: string | number;
|
|
14206
|
+
} | {
|
|
14207
|
+
lte: string | number;
|
|
14208
|
+
} | {
|
|
14209
|
+
def: boolean | 'true' | 'false';
|
|
14210
|
+
}> | Record<`parameters.${string}[match]`, string> | Record<`parameters.${string}[${'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte'}]`, string | number> | Record<`parameters.${string}[${'in' | 'nin'}]`, (string | number)[]> | Record<`parameters.${string}[def]`, boolean | 'true' | 'false'>>;
|
|
14101
14211
|
declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
14102
14212
|
private edgeApiHost;
|
|
14103
14213
|
private edgeApiRequestInit?;
|
|
14104
14214
|
constructor(options: CanvasClientOptions);
|
|
14105
14215
|
/** Fetches lists of Canvas compositions, optionally by type */
|
|
14106
|
-
getCompositionList(params?: Omit<CompositionGetParameters, 'projectId' | 'componentId' | 'compositionId' | 'slug'> &
|
|
14216
|
+
getCompositionList(params?: Omit<CompositionGetParameters, 'projectId' | 'componentId' | 'compositionId' | 'slug'> & {
|
|
14217
|
+
/** @deprecated do not use */
|
|
14218
|
+
filters?: CompositionFilters;
|
|
14219
|
+
} & ({
|
|
14107
14220
|
resolveData: true;
|
|
14108
14221
|
diagnostics?: boolean;
|
|
14109
14222
|
} | {
|
|
@@ -14157,7 +14270,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
|
14157
14270
|
canBeComposition?: boolean | undefined;
|
|
14158
14271
|
parameters?: {
|
|
14159
14272
|
id: string;
|
|
14160
|
-
/** Fetches a component definition's composition defaults */
|
|
14161
14273
|
name: string;
|
|
14162
14274
|
helpText?: string | undefined;
|
|
14163
14275
|
type: string;
|
|
@@ -17067,4 +17179,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
|
|
|
17067
17179
|
|
|
17068
17180
|
declare const CanvasClientError: typeof ApiClientError;
|
|
17069
17181
|
|
|
17070
|
-
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AssetParamValue, type AssetParamValueItem, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, type ChannelSubscription, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentLocationReferenceV2, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDataDiagnostic, type CompositionDeleteParameters, type CompositionDiagnostics, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetOrderBy, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionIssue, type CompositionPatternIssue, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextualEditingComponentReference, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryList, type EventNames, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type LimitPolicy, type LinkComponentParameterValue, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeDeprecatedOptions, type LocalizeModernOptions, type MessageHandler, type MoveComponentMessage, type NodeLocationReference, type NonProjectMapLinkParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, type PreviewEventBus, type PreviewPanelSettings, type ProjectMapLinkComponentParameterValue, type ProjectMapLinkParamValue, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PutContentTypeBody, type PutEntryBody, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParameterMessage, type SpecificProjectMap, type SubscribeToCompositionOptions, type SuggestComponentMessage, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UnsubscribeCallback, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isEntryData, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, subscribeToComposition, walkComponentTree, walkNodeTree };
|
|
17182
|
+
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AssetParamValue, type AssetParamValueItem, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, type ChannelSubscription, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentLocationReferenceV2, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDataDiagnostic, type CompositionDeleteParameters, type CompositionDiagnostics, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetOrderBy, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionIssue, type CompositionPatternIssue, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextualEditingComponentReference, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryList, type EventNames, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type LimitPolicy, type LinkComponentParameterValue, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeDeprecatedOptions, type LocalizeModernOptions, type MessageHandler, type MoveComponentMessage, type NodeLocationReference, type NonProjectMapLinkParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, type PreviewEventBus, type PreviewPanelSettings, type ProjectMapLinkComponentParameterValue, type ProjectMapLinkParamValue, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PutContentTypeBody, type PutEntryBody, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParameterMessage, type SpecificProjectMap, type SubscribeToCompositionOptions, type SuggestComponentMessage, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UnsubscribeCallback, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isEntryData, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, subscribeToComposition, walkComponentTree, walkNodeTree };
|
package/dist/index.esm.js
CHANGED
|
@@ -481,15 +481,22 @@ var CanvasClient = class extends ApiClient {
|
|
|
481
481
|
/** Fetches lists of Canvas compositions, optionally by type */
|
|
482
482
|
async getCompositionList(params = {}) {
|
|
483
483
|
const { projectId } = this.options;
|
|
484
|
-
const { resolveData, ...originParams } = params;
|
|
484
|
+
const { resolveData, filters, ...originParams } = params;
|
|
485
|
+
const rewrittenFilters = Object.entries(filters != null ? filters : {}).reduce((acc, [key, value]) => {
|
|
486
|
+
const lhs = `filters.${key}` + (typeof value === "object" ? `[${Object.keys(value)[0]}]` : "");
|
|
487
|
+
let rhs = typeof value === "object" ? Object.values(value)[0] : value;
|
|
488
|
+
rhs = Array.isArray(rhs) ? rhs.map((v) => `${v}`.trim()).join(",") : `${rhs}`.trim();
|
|
489
|
+
return { ...acc, [lhs]: rhs };
|
|
490
|
+
}, {});
|
|
485
491
|
if (!resolveData) {
|
|
486
|
-
const fetchUri = this.createUrl(CANVAS_URL, { ...originParams, projectId });
|
|
492
|
+
const fetchUri = this.createUrl(CANVAS_URL, { ...originParams, projectId, ...rewrittenFilters });
|
|
487
493
|
return this.apiClient(fetchUri);
|
|
488
494
|
}
|
|
489
495
|
const edgeParams = {
|
|
490
496
|
...originParams,
|
|
491
497
|
projectId,
|
|
492
|
-
...params.diagnostics ? { diagnostics: "true" } : {}
|
|
498
|
+
...params.diagnostics ? { diagnostics: "true" } : {},
|
|
499
|
+
...rewrittenFilters
|
|
493
500
|
};
|
|
494
501
|
const edgeUrl = this.createUrl("/api/v1/compositions", edgeParams, this.edgeApiHost);
|
|
495
502
|
return this.apiClient(edgeUrl, this.edgeApiRequestInit);
|
package/dist/index.js
CHANGED
|
@@ -616,15 +616,22 @@ var CanvasClient = class extends import_api2.ApiClient {
|
|
|
616
616
|
/** Fetches lists of Canvas compositions, optionally by type */
|
|
617
617
|
async getCompositionList(params = {}) {
|
|
618
618
|
const { projectId } = this.options;
|
|
619
|
-
const { resolveData, ...originParams } = params;
|
|
619
|
+
const { resolveData, filters, ...originParams } = params;
|
|
620
|
+
const rewrittenFilters = Object.entries(filters != null ? filters : {}).reduce((acc, [key, value]) => {
|
|
621
|
+
const lhs = `filters.${key}` + (typeof value === "object" ? `[${Object.keys(value)[0]}]` : "");
|
|
622
|
+
let rhs = typeof value === "object" ? Object.values(value)[0] : value;
|
|
623
|
+
rhs = Array.isArray(rhs) ? rhs.map((v) => `${v}`.trim()).join(",") : `${rhs}`.trim();
|
|
624
|
+
return { ...acc, [lhs]: rhs };
|
|
625
|
+
}, {});
|
|
620
626
|
if (!resolveData) {
|
|
621
|
-
const fetchUri = this.createUrl(CANVAS_URL, { ...originParams, projectId });
|
|
627
|
+
const fetchUri = this.createUrl(CANVAS_URL, { ...originParams, projectId, ...rewrittenFilters });
|
|
622
628
|
return this.apiClient(fetchUri);
|
|
623
629
|
}
|
|
624
630
|
const edgeParams = {
|
|
625
631
|
...originParams,
|
|
626
632
|
projectId,
|
|
627
|
-
...params.diagnostics ? { diagnostics: "true" } : {}
|
|
633
|
+
...params.diagnostics ? { diagnostics: "true" } : {},
|
|
634
|
+
...rewrittenFilters
|
|
628
635
|
};
|
|
629
636
|
const edgeUrl = this.createUrl("/api/v1/compositions", edgeParams, this.edgeApiHost);
|
|
630
637
|
return this.apiClient(edgeUrl, this.edgeApiRequestInit);
|
package/dist/index.mjs
CHANGED
|
@@ -481,15 +481,22 @@ var CanvasClient = class extends ApiClient {
|
|
|
481
481
|
/** Fetches lists of Canvas compositions, optionally by type */
|
|
482
482
|
async getCompositionList(params = {}) {
|
|
483
483
|
const { projectId } = this.options;
|
|
484
|
-
const { resolveData, ...originParams } = params;
|
|
484
|
+
const { resolveData, filters, ...originParams } = params;
|
|
485
|
+
const rewrittenFilters = Object.entries(filters != null ? filters : {}).reduce((acc, [key, value]) => {
|
|
486
|
+
const lhs = `filters.${key}` + (typeof value === "object" ? `[${Object.keys(value)[0]}]` : "");
|
|
487
|
+
let rhs = typeof value === "object" ? Object.values(value)[0] : value;
|
|
488
|
+
rhs = Array.isArray(rhs) ? rhs.map((v) => `${v}`.trim()).join(",") : `${rhs}`.trim();
|
|
489
|
+
return { ...acc, [lhs]: rhs };
|
|
490
|
+
}, {});
|
|
485
491
|
if (!resolveData) {
|
|
486
|
-
const fetchUri = this.createUrl(CANVAS_URL, { ...originParams, projectId });
|
|
492
|
+
const fetchUri = this.createUrl(CANVAS_URL, { ...originParams, projectId, ...rewrittenFilters });
|
|
487
493
|
return this.apiClient(fetchUri);
|
|
488
494
|
}
|
|
489
495
|
const edgeParams = {
|
|
490
496
|
...originParams,
|
|
491
497
|
projectId,
|
|
492
|
-
...params.diagnostics ? { diagnostics: "true" } : {}
|
|
498
|
+
...params.diagnostics ? { diagnostics: "true" } : {},
|
|
499
|
+
...rewrittenFilters
|
|
493
500
|
};
|
|
494
501
|
const edgeUrl = this.createUrl("/api/v1/compositions", edgeParams, this.edgeApiHost);
|
|
495
502
|
return this.apiClient(edgeUrl, this.edgeApiRequestInit);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uniformdev/canvas",
|
|
3
|
-
"version": "19.131.1-alpha.
|
|
3
|
+
"version": "19.131.1-alpha.8+d326c2787d",
|
|
4
4
|
"description": "Common functionality and types for Uniform Canvas",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -38,8 +38,8 @@
|
|
|
38
38
|
"pusher-js": "8.2.0"
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@uniformdev/assets": "19.131.1-alpha.
|
|
42
|
-
"@uniformdev/context": "19.131.1-alpha.
|
|
41
|
+
"@uniformdev/assets": "19.131.1-alpha.8+d326c2787d",
|
|
42
|
+
"@uniformdev/context": "19.131.1-alpha.8+d326c2787d",
|
|
43
43
|
"immer": "10.0.3"
|
|
44
44
|
},
|
|
45
45
|
"files": [
|
|
@@ -48,5 +48,5 @@
|
|
|
48
48
|
"publishConfig": {
|
|
49
49
|
"access": "public"
|
|
50
50
|
},
|
|
51
|
-
"gitHead": "
|
|
51
|
+
"gitHead": "d326c2787d0b159fcd7edb45b165a8eae54862e6"
|
|
52
52
|
}
|