Changelog
All notable changes to this project will be documented in this file. Dates are displayed in UTC.
-”23.4.2”
+”23.4.3”
+-
+
- SPASDK-224 Fix running SSR apps on Heroku
#186
+ - SPASDK-224 Fix running SSR apps on Heroku
#SPASDK-224
+
spa-sdk-23.4.2
++22 August 2024
+
- SPASDK-224 Fix release command
#184
+ - SPASDK-224 Bumping versions to 23.4.2
#SPASDK-224
- SPASDK-224 Fix release command
#SPASDK-224
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface Handler
Hierarchy
Callable
Express middleware for seamless integration with the Relevance Module.
Parameters
request: HandlerRequest
Incoming HTTP request.
diff --git a/interfaces/express.Internals.HandlerRequest.html b/interfaces/express.Internals.HandlerRequest.html index 181cd416..b004ec34 100644 --- a/interfaces/express.Internals.HandlerRequest.html +++ b/interfaces/express.Internals.HandlerRequest.html @@ -1 +1 @@ -- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface HandlerRequest
Hierarchy
Index
Properties
Methods
Properties
Optional visitor
Methods
Optional once
Parameters
event: string | symbol
listener: ((...args: any[]) => void)
Parameters
Rest ...args: any[]
Returns void
Returns any
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface HandlerRequest
Hierarchy
Index
Properties
Methods
Properties
Optional visitor
Methods
Optional once
Parameters
event: string | symbol
listener: ((...args: any[]) => void)
Parameters
Rest ...args: any[]
Returns void
Returns any
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface HandlerWithOptions
Hierarchy
Callable
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface HandlerWithOptions
Hierarchy
Callable
Express middleware for seamless integration with the Relevance Module.
Parameters
request: HandlerRequest
Incoming HTTP request.
diff --git a/interfaces/express.Internals.Options.html b/interfaces/express.Internals.Options.html index e190971e..23c8d564 100644 --- a/interfaces/express.Internals.Options.html +++ b/interfaces/express.Internals.Options.html @@ -1 +1 @@ -- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface Options
Hierarchy
Index
Properties
Properties
Optional name
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface Options
Hierarchy
Index
Properties
Properties
Optional name
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface Visitor
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface Visitor
Meta-data of a visitor.
https://documentation.bloomreach.com/library/enterprise/enterprise-features/targeting/visitors-visits-and-cookies.html
Hierarchy
Index
Properties
Properties
header
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface Component
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface Component
A component in the current page.
Hierarchy
Index
Methods
Methods
get Children
Returns Component[]
The direct children of the component.
get Component
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface Container
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface Container
A component that holds an ordered list of container item components.
Hierarchy
Index
Methods
Methods
get Children
Returns ContainerItem[]
The children of a container.
get Component
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface ContainerItem
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface ContainerItem
A component that can be configured in the UI.
Hierarchy
Index
Methods
Methods
get Children
Returns Component[]
The direct children of the component.
get Component
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface Content
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface Content
Content used on the page.
Hierarchy
Index
Methods
Methods
get Data
Returns ContentModel
The content data as it is returned in the Page Model API.
Type Parameters
T extends Record<string, any>
Returns T & ContentModel
get Id
Returns string
The content id.
diff --git a/interfaces/index.Document.html b/interfaces/index.Document.html index fd2399fd..5065944e 100644 --- a/interfaces/index.Document.html +++ b/interfaces/index.Document.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface Document
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface Document
Document used on the page.
Hierarchy
Index
Methods
Methods
get Data
Returns DocumentDataModel
The document data.
Type Parameters
T extends Record<string, any>
Returns T & DocumentDataModel
get Id
Returns string
The document id.
diff --git a/interfaces/index.Image.html b/interfaces/index.Image.html index 748bcb8d..ed037d55 100644 --- a/interfaces/index.Image.html +++ b/interfaces/index.Image.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface Image
Hierarchy
Index
Methods
Methods
get Display Name
Returns string
The image display name.
+- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface Image
Hierarchy
Index
Methods
Methods
get Display Name
Returns string
The image display name.
get File Name
Returns undefined | string
The image file name.
get Height
Returns number
The image height.
get Mime Type
Returns string
The image mime-type.
diff --git a/interfaces/index.ImageSet.html b/interfaces/index.ImageSet.html index 68039e72..7d28d97a 100644 --- a/interfaces/index.ImageSet.html +++ b/interfaces/index.ImageSet.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface ImageSet
Hierarchy
Index
Methods
Methods
get Description
Returns undefined | string
The image set description.
+- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface ImageSet
Hierarchy
Index
Methods
Methods
get Description
Returns undefined | string
The image set description.
get Display Name
Returns string
The image set display name.
get File Name
Returns string
The image set file name.
get Id
Returns string
The image set id.
diff --git a/interfaces/index.Internals.ApiOptions.html b/interfaces/index.Internals.ApiOptions.html index b597c6d8..4f605343 100644 --- a/interfaces/index.Internals.ApiOptions.html +++ b/interfaces/index.Internals.ApiOptions.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface ApiOptions
Hierarchy
Index
Properties
Properties
Optional api Version
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface ApiOptions
Hierarchy
Index
Properties
Properties
Optional api Version
Current API version. By default, the compatible with the current setup version will be chosen.
Optional api Version Header
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface ChannelInfoModel
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface ChannelInfoModel
Current channel info.
Hierarchy
Index
Properties
Properties
props
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface ChannelModel
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface ChannelModel
Current channel of a page.
Hierarchy
Index
Properties
Properties
info
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface CmsOptions
Hierarchy
Index
Properties
Properties
Optional window
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface CmsOptions
Hierarchy
Index
Properties
Properties
Optional window
The window reference for the CMS integration. By default the global window object will be used.
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface ComponentMeta
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface ComponentMeta
Meta-data of a component.
Hierarchy
Index
Properties
Properties
Optional begin Node Span
Optional end Node Span
Optional params
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface ComponentModel
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface ComponentModel
Model of a component.
Hierarchy
Index
Properties
Properties
_links
_meta
Optional components
id
Optional models
Optional name
type
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface ComponentModel
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface ComponentModel
Model of a component.
Hierarchy
Index
Properties
Properties
Optional children
id
links
meta
Optional models
Optional name
type
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface ConfigurationWithJwt
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface ConfigurationWithJwt
Configuration of the SPA SDK using the JWT token-based setup.
Hierarchy
Index
Properties
Properties
Optional NBRMode
The NBRMode parameter used to indicate whether the children of the BrPage component should be rendered diff --git a/interfaces/index.Internals.ConfigurationWithJwt09.html b/interfaces/index.Internals.ConfigurationWithJwt09.html index fb8d20b4..42c85580 100644 --- a/interfaces/index.Internals.ConfigurationWithJwt09.html +++ b/interfaces/index.Internals.ConfigurationWithJwt09.html @@ -1,4 +1,4 @@ -
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface ConfigurationWithJwt09
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface ConfigurationWithJwt09
Configuration of the SPA SDK using the JWT token-based setup and the Page Model API v0.9.
Hierarchy
Index
Properties
Properties
Optional NBRMode
The NBRMode parameter used to indicate whether the children of the BrPage component should be rendered diff --git a/interfaces/index.Internals.ConfigurationWithJwt10.html b/interfaces/index.Internals.ConfigurationWithJwt10.html index 5d99d7fc..8acb2f74 100644 --- a/interfaces/index.Internals.ConfigurationWithJwt10.html +++ b/interfaces/index.Internals.ConfigurationWithJwt10.html @@ -1,4 +1,4 @@ -
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.2Interface ConfigurationWithJwt10
- Preparing search index...
- The search index is not available
@bloomreach/spa-sdk - v23.4.3Interface ConfigurationWithJwt10
Configuration of the SPA SDK using the JWT token-based setup and the Page Model API v1.0.
Hierarchy
Index
Properties