@bloomreach/spa-sdk - npm Package Compare versions

Comparing version 0.3.0-saas to 0.3.1-saas

lib/index.d.ts

@@ -105,9 +105,9 @@ /**
 /**
+ * Container type.
+ */
+declare const TYPE_COMPONENT_CONTAINER = "container";
+/**
  * Container item type.
  */
 declare const TYPE_COMPONENT_CONTAINER_ITEM = "container-item";
-/**
- * Container type.
- */
-declare const TYPE_COMPONENT_CONTAINER = "container";
 declare type ComponentType = typeof TYPE_COMPONENT | typeof TYPE_COMPONENT_CONTAINER_ITEM | typeof TYPE_COMPONENT_CONTAINER;
@@ -659,2 +659,3 @@ /**
 interface ContainerItemModel extends ComponentModel {
+    content?: Reference;
     ctype?: string;
@@ -697,3 +698,15 @@ label?: string;
     isHidden(): boolean;
+    /**
+     * Returns a [RFC-6901](https://tools.ietf.org/html/rfc6901) JSON Pointer
+     * to the content of this container item.
+     */
+    getContentReference(): Reference | undefined;
 }
+/**
+ * Returns the content of this component.
+ *
+ * @param component The component that references the content
+ * @param page The page that contains the content
+ */
+declare function getContainerItemContent<T>(component: ContainerItem, page: Page): T | null;
 
@@ -1279,2 +1292,2 @@ /**
 
-export { Component, Configuration, Container, ContainerItem, Content, Document, Image, ImageSet, Link, META_POSITION_BEGIN, META_POSITION_END, ManageContentButton, Menu$2 as Menu, MenuItem, Meta, MetaCollection, MetaComment, Page, PageModel$2 as PageModel, Pagination, PaginationItem, Reference, TYPE_CONTAINER_BOX, TYPE_CONTAINER_INLINE, TYPE_CONTAINER_ITEM_UNDEFINED, TYPE_CONTAINER_NO_MARKUP, TYPE_CONTAINER_ORDERED_LIST, TYPE_CONTAINER_UNORDERED_LIST, TYPE_LINK_EXTERNAL, TYPE_LINK_INTERNAL, TYPE_LINK_RESOURCE, TYPE_MANAGE_CONTENT_BUTTON, TYPE_MANAGE_MENU_BUTTON, destroy, initialize, isComponent, isContainer, isContainerItem, isContent, isDocument, isImageSet, isLink, isMenu, isMeta, isMetaComment, isPage, isPagination, isReference };
+export { Component, Configuration, Container, ContainerItem, Content, Document, Image, ImageSet, Link, META_POSITION_BEGIN, META_POSITION_END, ManageContentButton, Menu$2 as Menu, MenuItem, Meta, MetaCollection, MetaComment, Page, PageModel$2 as PageModel, Pagination, PaginationItem, Reference, TYPE_CONTAINER_BOX, TYPE_CONTAINER_INLINE, TYPE_CONTAINER_ITEM_UNDEFINED, TYPE_CONTAINER_NO_MARKUP, TYPE_CONTAINER_ORDERED_LIST, TYPE_CONTAINER_UNORDERED_LIST, TYPE_LINK_EXTERNAL, TYPE_LINK_INTERNAL, TYPE_LINK_RESOURCE, TYPE_MANAGE_CONTENT_BUTTON, TYPE_MANAGE_MENU_BUTTON, destroy, getContainerItemContent, initialize, isComponent, isContainer, isContainerItem, isContent, isDocument, isImageSet, isLink, isMenu, isMeta, isMetaComment, isPage, isPagination, isReference };

package.json

 {
   "name": "@bloomreach/spa-sdk",
-  "version": "0.3.0-saas",
+  "version": "0.3.1-saas",
   "description": "Bloomreach SPA SDK",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -39,3 +39,3 @@ # Bloomreach SPA SDK
     path,
-    endpoint: 'http://localhost:8080/site/resourceapi',
+    endpoint: 'http://localhost:8080/delivery/site/v1/channels/brxsaas/pages',
     httpClient: axios,
@@ -57,3 +57,3 @@ });
 `apiVersionHeader` | `"Accept-Version"` | _none_ | API version header.
-`apiBaseUrl` | no | `cmsBaseUrl` + `"/resourceapi"` | Base URL of the Page Model API (e.g. `http://localhost:8080/site/resourceapi` or `http://localhost:8080/site/channel/resourceapi`). This option will be ignored if `options` is present.
+`apiBaseUrl` | no | `cmsBaseUrl` + `"/resourceapi"` | Base URL of the Page Model API (e.g. `http://localhost:8080/delivery/site/v1/channels/brxsaas/pages` or `http://localhost:8080/site/channel/resourceapi`). This option will be ignored if `options` is present.
 `authorizationHeader` | no | `"Authorization"` | Authorization header for the Page Model API.
@@ -64,3 +64,3 @@ `authorizationQueryParameter` | no | `"token"` | The query string parameter used to pass authorization header value.
 `debug` | no | `false` | The option enabling debug mode.
-`endpoint` | _exclusive_ | _none_ | Base URL of the Page Model API (e.g. `http://localhost:8080/site/resourceapi` or `http://localhost:8080/site/channel/resourceapi`). This option is exclusive and should not be used together with `options` or `cmsBaseUrl`.
+`endpoint` | _exclusive_ | _none_ | Base URL of the Page Model API (e.g. `http://localhost:8080/delivery/site/v1/channels/brxsaas/pages` or `http://localhost:8080/site/channel/resourceapi`). This option is exclusive and should not be used together with `options` or `cmsBaseUrl`.
 `endpointQueryParameter` | no | _none_ | The query string parameter used as the brXM endpoint (`cmsBaseUrl`). The option will be ignored if the `cmsBaseUrl` option is not empty. In case when this option is used, the `apiBaseUrl` will be prepended with the value from the query parameter. This option should be used only for testing or debugging. By default, the option is disabled.
@@ -71,3 +71,3 @@ `cmsBaseUrl` | _exclusive_ | _none_ | Base URL of the site (e.g. `http://localhost:8080/site` or `http://localhost:8080/site/channel`). This option is exclusive and should not be used together with `options` or `endpoint`.
 `options.live` | yes | _none_ | The CMS URL options for the live site.
-`options.live.apiBaseUrl` | no | `options.live.cmsBaseUrl` + `"/resourceapi"` | Base URL of the Page Model API for the live site (e.g. `http://localhost:8080/site/resourceapi` or `http://localhost:8080/site/channel/resourceapi`).
+`options.live.apiBaseUrl` | no | `options.live.cmsBaseUrl` + `"/resourceapi"` | Base URL of the Page Model API for the live site (e.g. `http://localhost:8080/delivery/site/v1/channels/brxsaas/pages` or `http://localhost:8080/site/channel/resourceapi`).
 `options.live.cmsBaseUrl` | yes | _none_ | Base URL of the live site (e.g. `http://localhost:8080/site` or `http://localhost:8080/site/channel`).
@@ -74,0 +74,0 @@ `options.live.spaBaseUrl` | no | `""` | Base URL of the live SPA (e.g. `/account` or `//www.example.com`).

No alert changes

Improved metrics

Total package byte prevSize

392804

increased by1.15%

Lines of code

7704

increased by1.37%

No dependency changes