| AddComponentMessage | |
| BatchEnhancer | An enhancer that queues up promises for each component that needs enhancing, and once all enhancements have been queued handles them all in a batch. Note: this type is adaptable to both ComponentParameterEnhancer and ComponentEnhancer types. |
| BatchInvalidationPayload | |
| BindVariablesOptions | |
| BindVariablesResult | |
| BindVariablesToObjectOptions | |
| CanvasDefinitions | Defines single structure to keep all canvas models (used in CLI commands and Starter content generations) |
| CategoriesDeleteParameters | Shape of the DELETE request body for /api/v1/category |
| CategoriesGetParameters | Query parameter options for GET /api/v1/category |
| CategoriesGetResponse | Shape of the GET response from /api/v1/category |
| CategoriesPutParameters | Shape of the PUT request body for /api/v1/category |
| Category | Defines a component type that can live on a Composition |
| Channel | |
| ChannelMessage | |
| ChannelSubscription | Pusher-js is large (80k) and not tree shakable so it is always bundled if directly referenced, when it's only needed during preview mode. To avoid bundling it for all, we use an old-school write-a-script-tag hack to load it in a poor man's approximation of a dynamic import ;) |
| ComponentDefinition | Defines a component type that can live on a Composition |
| ComponentDefinitionDeleteParameters | Shape of the DELETE request body for /api/v1/canvas-definitions |
| ComponentDefinitionGetParameters | Query parameter options for GET /api/v1/canvas-definitions |
| ComponentDefinitionGetResponse | Shape of the GET response from /api/v1/canvas-definitions |
| ComponentDefinitionParameter | The definition of a component parameter |
| ComponentDefinitionPermission | Permission set for a component defintion |
| ComponentDefinitionPutParameters | Shape of the PUT request body for /api/v1/canvas-definitions |
| ComponentDefinitionSlot | The definition of a named component slot that can contain other components |
| ComponentDefinitionSlugSettings | The definition of a composition's slug settings |
| ComponentDefinitionVariant | The definition of a component visual variant |
| ComponentEnhancer | Defines logic to add arbitrary async data to a component's <code>data</code> property. Used to enhance layout data with information from other platforms, such as private APIs, where the value is not tied to a parameter and is intrinsic to the component itself. |
| ComponentEnhancerFunction | <p>A function which is called for each matching component in a composition, which can manipulate the value of a specific key in the component's <code>data</code> property. Used to enhance layout data with information from other platforms, such as private APIs, where the value is not tied to a parameter and is intrinsic to the component itself.</p><p>Note: the configuration of enhancers namespaces component enhancers into a named property on the data object to avoid collisions, thus an enhancer need not worry about merging values with other enhancers, nor which key it has been registered under.</p><p>Return values: TValue - sets the configured key in the component's data value to this value undefined - do not set the component's data key</p> |
| ComponentEnhancerOptions | Options passed to a ComponentEnhancer function |
| ComponentInstance | Defines the shape of a component instance served by the composition API. |
| ComponentInstanceContextualEditing | The type of the component instance in contextual editing mode. |
| ComponentInstanceHistoryEntry | A historical version of a composition |
| ComponentInstanceHistoryGetParameters | The GET response from /api/v1/canvas-history (history for one composition) |
| ComponentInstanceHistoryGetResponse | The GET response from /api/v1/canvas-history |
| ComponentLocationReference | |
| ComponentOverridability | Defines how a component on a pattern may have its values overridden |
| ComponentOverride | Defines the shape of a component override |
| ComponentOverrides | Defines a set of component overrides by component ID |
| ComponentParameter | Defines an editable parameter on a component. |
| ComponentParameterContextualEditing | The type of the parameters in contextual editing mode. |
| ComponentParameterEnhancer | Defines logic to replace the value of a component parameter with arbitrary async data. Used to enhance layout data with information from other platforms, such as CMS, commerce, indexing, etc, where that data is directly expandable from a parameter value. |
| ComponentParameterEnhancerFunction | <p>A function which is called for each component parameter in a component tree, which can manipulate the value of the parameter. Used to enhance layout data with information from other platforms, such as CMS, commerce, indexing, etc.</p><p>Return values: TValue - replaces the original parameter value with this value undefined - do not change the original parameter value null - sets the parameter value to null, replacing any existing value (i.e. if its value could not be resolved in an external system)</p> |
| ComponentParameterEnhancerOptions | Options passed to a ComponentParameterEnhancer function |
| CompositionDataDiagnostic | |
| CompositionDeleteParameters | Shape of the DELETE request body for /api/v1/canvas |
| CompositionDiagnostics | |
| CompositionGetByComponentIdParameters | |
| CompositionGetByIdParameters | |
| CompositionGetByNodeIdParameters | |
| CompositionGetByNodePathParameters | Defines exact parameters for specific requests getting a single composition |
| CompositionGetBySlugParameters | |
| CompositionGetListResponse | The GET response from /api/v1/canvas when <code>component</code> or <code>slug</code> are not specified |
| CompositionGetOrderBy | |
| CompositionGetParameters | Query parameter options for GET /api/v1/canvas |
| CompositionGetResponse | The GET response from /api/v1/canvas when <code>component</code> or <code>slug</code> params are specified |
| CompositionGetValidResponses | All valid response types |
| CompositionIssue | |
| CompositionPatternIssue | |
| CompositionPutParameters | The PUT request body for /api/v1/canvas |
| CompositionRelationshipsClientOptions | |
| CompositionRelationshipsDDefinitionGetResponse | |
| CompositionRelationshipsDefinitionApi | |
| CompositionRelationshipsDefinitionGetParameters | |
| CompositionResolvedGetResponse | Response as it comes from uniform.global/api/v1/composition |
| CompositionResolvedListResponse | |
| CompositionUIStatus | |
| ContentType | |
| ContentTypeField | |
| ContextualEditingComponentReference | |
| DataDiagnostic | Diagnostic data about the load performance of attached composition datas |
| DataElementBindingIssue | An error while binding a dynamic token from a data resource to a component parameter (i.e. a missing property in the data resource) |
| DataElementConnectionDefinition | Defines a connection to a dynamic token on a data resource. |
| DataResolutionConfigIssue | Error in data resolution configuration (internal error) |
| DataResolutionIssue | Types of issue that can occur when fetching composition data |
| DataResolutionOption | Switches for data resolution |
| DataResolutionOptionNegative | |
| DataResolutionOptionPositive | |
| DataResolutionParameters | |
| DataResourceDefinition | Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters |
| DataResourceDefinitions | Data definitions attached to this component. The property name is the key of the data in the data document. Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key). |
| DataResourceIssue | An error that occurred fetching a data defined on the composition or a pattern within |
| DataResourceVariables | Variable values for a data resource. |
| DataSource | |
| DataSourceDeleteParameters | Shape of the DELETE request body for /api/v1/data-source |
| DataSourceGetParameters | Query parameter options for GET /api/v1/data-source |
| DataSourceGetResponse | The GET response from /api/v1/data-sources |
| DataSourcePutParameters | The PUT request body for /api/v1/data-source |
| DataSourcesGetParameters | Query parameter options for GET /api/v1/data-sources |
| DataSourcesGetResponse | The GET response from /api/v1/data-sources |
| DataType | |
| DataTypeDeleteParameters | Shape of the DELETE request body for /api/v1/data-types |
| DataTypeGetParameters | Query parameter options for GET /api/v1/data-types |
| DataTypeGetResponse | The GET response from /api/v1/data-types |
| DataTypePutParameters | The PUT request body for /api/v1/data-types |
| DataVariableDefinition | |
| DeleteContentTypeOptions | |
| DeleteEntryOptions | |
| DismissPlaceholderMessage | |
| DynamicInputIssue | An issue that occurred while binding dynamic inputs to composition data resources, specifically when an expected dynamic input did not have a value. |
| EdgehancersDiagnostics | Diagnostics about edge request processing |
| EditorStateUpdatedMessage | |
| EnhancerContext | |
| EnhancerError | |
| EntriesGetParameters | The GET response from /api/v1/entries |
| EntriesGetResponse | |
| EntriesResolvedListResponse | |
| Entry | |
| EventNames | |
| GetContentTypesOptions | |
| GetContentTypesResponse | |
| GetEntriesOptions | |
| GetEntriesResponse | |
| GetParameterAttributesProps | |
| InvalidationPayload | |
| LimitPolicy | |
| LinkComponentParameterValue | |
| LinkParamConfiguration | |
| LinkParameterType | |
| LinkParamValue | |
| LinkTypeConfiguration | |
| MessageHandler | |
| MoveComponentMessage | |
| NonProjectMapLinkParamValue | |
| OverrideOptions | Defines the shape of a component override |
| PatternIssue | An error that occured resolving a pattern that is referenced on the composition |
| PreviewEventBus | |
| PreviewPanelSettings | |
| ProjectMapLinkComponentParameterValue | |
| ProjectMapLinkParamValue | |
| PutContentTypeBody | |
| PutEntryBody | |
| ReadyMessage | |
| ReportRenderedCompositionsMessage | |
| ResolvedRouteGetResponse | A route API response with edgehancer composition result |
| RichTextBuiltInElement | |
| RichTextBuiltInFormat | |
| RichTextParamConfiguration | |
| RichTextParamValue | |
| RootComponentInstance | Defines the shape of the root component in a composition |
| RouteDynamicInputs | |
| RouteGetParameters | The GET response from /api/v1/route |
| RouteGetResponse | |
| RouteGetResponseComposition | |
| RouteGetResponseEdgehancedComposition | GET response from uniform.global/api/v1/route when result is a composition |
| RouteGetResponseNotFound | |
| RouteGetResponseRedirect | |
| SelectComponentMessage | |
| SelectParameterMessage | |
| SpecificProjectMap | |
| SubscribeToCompositionOptions | |
| TriggerCompositionActionMessage | |
| UnsubscribeCallback | |
| UpdateComponentParameterMessage | |
| UpdateCompositionInternalMessage | |
| UpdateCompositionMessage | |
| UpdateContextualEditingStateInternalMessage | |
| UpdatePreviewSettingsMessage | |
| UsageTrackingApi | |
| UsageTrackingGetParameters | |
| UsageTrackingGetResponse | |
| UsageTrackingPostParameters | |
| UsageTrackingPostResponse | |
| WalkComponentTreeActions | |