@sitecore/sc-contenthub-webclient-sdk 1.2.12 → 1.2.24

package/README.md

@@ -1,49 +1,31 @@
 # Sitecore Content Hub WebClient JS SDK
 
-Sitecore Content Hub WebClient JS SDK, which is a lightweight JS client for Sitecore Content Hub.
+Lightweight JS client for [Sitecore Content Hub](https://doc.sitecore.com/ch/en/developers/cloud-dev/index-en.html).
 
-## Internal resources
+Environment
 
--   [Backlog](https://stylelabs.atlassian.net/secure/RapidBoard.jspa?rapidView=347&projectKey=ONSJSSDK&view=planning.nodetail&issueLimit=100)
--   Slack: #ch-devex-questions
+-   Node.js
 
-## Release process
+Language level
 
-There are currently three build configurations that are specified in `bitbucket-pipelines.yml`
+-   ES6
+-   ESNext
 
--   A basic build runs each time a pull request is created or updated. This is to ensure that all unit tests are passing before committing any code to `master`.
--   Once a pull request has been completed and the code is merged to `master`, an internal build is triggered automatically.
--   Public releases can be created by tagging a commit with the following: `release-<major>.<minor>.<patch>` (e.g `release-1.0.0`). Upon a successful build all artifacts are pushed to the public channels.
+Module system
 
-### To Release
+-   CommonJS
+-   ESNext
 
--   Add new release tag, `release-<major>.<minor>.<patch>`.
--   Trigger a release build to publish final artifacts to the partners feed.
--   Cut the release branch, `release\<major>.<minor>.x`.
--   Update the Changelog in Documentation repository.
--   Update Content Hub repository with new official released version.
--   Bump version for the next release.
+## Installing
 
-## Documentation
-
-[Stylelabs.M.Docs reporitory](https://bitbucket.org/stylelabsdev/stylelabs.m.docs/src/master/docfx-website/content/4.0.x/integrations/javascript-sdk/)
-
-_NOTE: There are multiple paths for various versions that need to be updated independently._
-
-## Dev test configuration
+```bash
+npm install @sitecore/sc-contenthub-webclient-sdk
+```
 
-Some tests require an instance of ContentHub and a configuration to run.
+## Documentation
 
-1. Create a .env file in project root.
-1. Configure an OAuth client in `<path-to-contenthub>/en-us/admin/oauthclients`.
+-   [Sitecore Content Hub](https://doc.sitecore.com/ch/en/developers/cloud-dev/index-en.html)
 
-Example .env config:
+-   [Sitecore Content Hub SDKs](https://doc.sitecore.com/ch/en/developers/cloud-dev/javascript-sdk.html)
 
-```
-ENDPOINT=https://localhost:5001
-OAUTH_CLIENT_ID=jssdk
-OAUTH_CLIENT_SECRET=testsecret
-USER_NAME=Administrator
-USER_PASSWORD=admin
-IGNORE_HTTPS_ERRORS=true
-```
+_NOTE: There are multiple paths for various versions._

package/dist/contracts/base/entity-base.js

@@ -203,8 +203,13 @@ let EntityBase = class EntityBase {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.stringNotNullOrEmpty(name);
             const relation = this.getRelation(name, role, true);
-            if (relation == null && loadOption == member_load_option_1.MemberLoadOption.LazyLoading) {
-                {
+            if (relation) {
+                if (!relation.isFullyLoaded) {
+                    return (yield this._relationManager.loadRelationAsync(name, role, true));
+                }
+            }
+            else {
+                if (loadOption == member_load_option_1.MemberLoadOption.LazyLoading) {
                     // Scoped to be able to redefine relation as type RelationType does not match IRelation. //TODO generics?
                     const relation = yield this._relationManager.loadRelationAsync(name, role);
                     if (relation == null) {

package/dist/contracts/base/relation-manager.d.ts

@@ -28,9 +28,10 @@ export declare class RelationManager {
      * If the relation does not exist, null will be returned.
      * @param relationName - The name of the relation
      * @param role - The role of the relation
+     * @param forceLoad - Forces the relation to be loaded even though it has already been loaded before
      * @returns A promise resolving to the relation or null.
      */
-    loadRelationAsync(relationName: string, role?: RelationRole): NullableResultPromise<IRelation>;
+    loadRelationAsync(relationName: string, role?: RelationRole, forceLoad?: boolean): NullableResultPromise<IRelation>;
     /**
      * Loads the specified relations.
      * It will only load if it is actually missing relations and does not overwrite existing relations.

package/dist/contracts/base/relation-manager.js

@@ -73,14 +73,15 @@ class RelationManager {
      * If the relation does not exist, null will be returned.
      * @param relationName - The name of the relation
      * @param role - The role of the relation
+     * @param forceLoad - Forces the relation to be loaded even though it has already been loaded before
      * @returns A promise resolving to the relation or null.
      */
-    loadRelationAsync(relationName, role) {
+    loadRelationAsync(relationName, role, forceLoad = false) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.stringNotNullOrEmpty(relationName);
             lazy_loading_manager_1.LazyLoadingManager.ensureLazyLoadingIsPossible(this._entity);
             let relation = this.getRelation(relationName, role);
-            if (relation != null) {
+            if (relation != null && !forceLoad) {
                 return relation;
             }
             relation = yield this.fetchRelationAsync(relationName, role);
@@ -187,6 +188,9 @@ class RelationManager {
             this._relations[relation.name] = container;
         }
         if (container.relationExists(relation.role)) {
+            if (container.getRelation(relation.role).isFullyLoaded === false) {
+                container.setRelation(relation);
+            }
             return;
         }
         container.setRelation(relation);

package/dist/contracts/base/relations/child-to-many-parents-relation.d.ts

@@ -11,6 +11,11 @@ export interface IChildToManyParentsRelation extends IChildRelation, IToManyRela
      * The list of parent ids.
      */
     readonly parents: Array<number>;
+    /**
+     * When related items are partially loaded, this value will be set
+     *  to indicate how many related items there are in total.
+     */
+    parentTotal?: number;
     /**
      * Gets the properties for a parent.
      *
@@ -22,10 +27,12 @@ export interface IChildToManyParentsRelation extends IChildRelation, IToManyRela
 export declare class ChildToManyParentsRelation extends ChildRelationBase implements IChildToManyParentsRelation {
     private _parents;
     readonly role: RelationRole;
+    readonly parentTotal?: number;
     readonly isMultiValue: boolean;
+    get isFullyLoaded(): boolean;
     get isDirty(): boolean;
     get parents(): Array<number>;
-    constructor(name: string, properties?: Nullable<MapNumberTo<MapStringTo<Object_Unknown>>>, client?: IContentHubClient);
+    constructor(name: string, properties?: Nullable<MapNumberTo<MapStringTo<Object_Unknown>>>, client?: IContentHubClient, parentTotal?: number);
     getIds(): Array<number>;
     setIds(ids: Array<number>): void;
     clear(): void;

package/dist/contracts/base/relations/child-to-many-parents-relation.js

@@ -19,11 +19,15 @@ const entity_load_configuration_1 = require("../../querying/entity-load-configur
 const relation_1 = require("../relation");
 const relation_role_1 = require("../relation-role");
 class ChildToManyParentsRelation extends relation_1.ChildRelationBase {
-    constructor(name, properties = null, client) {
+    constructor(name, properties = null, client, parentTotal) {
         super(name, properties, client);
         this._parents = [];
         this.role = relation_role_1.RelationRole.Child;
         this.isMultiValue = true;
+        this.parentTotal = parentTotal;
+    }
+    get isFullyLoaded() {
+        return this.parentTotal == null || this._parents.length === this.parentTotal;
     }
     get isDirty() {
         if (!this.isTracking) {

package/dist/contracts/base/relations/parent-to-many-children-relation.d.ts

@@ -11,6 +11,11 @@ export interface IParentToManyChildrenRelation extends IParentRelation, IToManyR
      * The list of children ids.
      */
     readonly children: Array<number>;
+    /**
+     * When related items are partially loaded, this value will be set
+     *  to indicate how many related items there are in total.
+     */
+    childTotal?: number;
     /**
      * Gets the properties for a child.
      *
@@ -22,10 +27,12 @@ export interface IParentToManyChildrenRelation extends IParentRelation, IToManyR
 export declare class ParentToManyChildrenRelation extends RelationBase implements IParentToManyChildrenRelation {
     private _children;
     readonly role: RelationRole;
+    readonly childTotal?: number;
     readonly isMultiValue: boolean;
+    get isFullyLoaded(): boolean;
     get isDirty(): boolean;
     get children(): Array<number>;
-    constructor(name: string, properties?: Nullable<MapNumberTo<MapStringTo<Object_Unknown>>>, client?: IContentHubClient);
+    constructor(name: string, properties?: Nullable<MapNumberTo<MapStringTo<Object_Unknown>>>, client?: IContentHubClient, childTotal?: number);
     getIds(): Array<number>;
     setIds(ids: Array<number>): void;
     clear(): void;

package/dist/contracts/base/relations/parent-to-many-children-relation.js

@@ -19,11 +19,15 @@ const entity_load_configuration_1 = require("../../querying/entity-load-configur
 const relation_1 = require("../relation");
 const relation_role_1 = require("../relation-role");
 class ParentToManyChildrenRelation extends relation_1.RelationBase {
-    constructor(name, properties = null, client) {
+    constructor(name, properties = null, client, childTotal) {
         super(name, properties, client);
         this._children = [];
         this.role = relation_role_1.RelationRole.Parent;
         this.isMultiValue = true;
+        this.childTotal = childTotal;
+    }
+    get isFullyLoaded() {
+        return this.childTotal == null || this._children.length === this.childTotal;
     }
     get isDirty() {
         if (!this.isTracking) {

package/dist/contracts/base/relations/to-many-relation.d.ts

@@ -3,6 +3,10 @@ import { IRelation } from "../relation";
  * Base interface for relation that are associated with many entities.
  */
 export interface IToManyRelation extends IRelation {
+    /**
+     * Indicates whether all the related items are loaded.
+     */
+    isFullyLoaded: boolean;
     /**
      * Adds an id to the relation's values.
      * @param id - The id to add

package/dist/contracts/querying/relation-load-option.d.ts

@@ -10,6 +10,10 @@ export interface IRelationLoadOption extends ILoadOption {
      * This is only useful when {@link LoadOption} is {@link LoadOption.Custom}.
      */
     relations: Array<IRelationSpecification>;
+    /**
+     * Can limit the number of related items that are returned.
+     */
+    maxRelatedItems?: number;
     /**
      * Creates a deep clone of this instance.
      */
@@ -26,6 +30,7 @@ export declare class RelationLoadOption implements IRelationLoadOption {
     static readonly All: Readonly<IRelationLoadOption>;
     loadOption: LoadOption;
     relations: Array<IRelationSpecification>;
+    maxRelatedItems?: number;
     constructor(param?: LoadOption | Array<string> | Array<IRelationSpecification> | RelationLoadOption);
     deepClone(): IRelationLoadOption;
 }

package/dist/contracts/querying/relation-load-option.js

@@ -67,6 +67,10 @@ __decorate([
     (0, ta_json_1.JsonElementType)(relation_specification_1.RelationSpecification),
     __metadata("design:type", Array)
 ], RelationLoadOption.prototype, "relations", void 0);
+__decorate([
+    (0, ta_json_1.JsonProperty)("max_related_items"),
+    __metadata("design:type", Number)
+], RelationLoadOption.prototype, "maxRelatedItems", void 0);
 RelationLoadOption = RelationLoadOption_1 = __decorate([
     (0, ta_json_1.JsonObject)(),
     __metadata("design:paramtypes", [Object])

package/dist/mappers/relation-mapper.js

@@ -90,11 +90,11 @@ class RelationMapper {
                                 ids.push(id);
                                 properties[id] = r.properties;
                             }
-                            subRelation = new parent_to_many_children_relation_1.ParentToManyChildrenRelation(name, properties, this._client);
+                            subRelation = new parent_to_many_children_relation_1.ParentToManyChildrenRelation(name, properties, this._client, relationResource.childTotal);
                             subRelation.setIds(ids);
                         }
                         else {
-                            subRelation = new parent_to_many_children_relation_1.ParentToManyChildrenRelation(name, null, this._client);
+                            subRelation = new parent_to_many_children_relation_1.ParentToManyChildrenRelation(name, null, this._client, relationResource.childTotal);
                         }
                         result = subRelation;
                     }
@@ -125,11 +125,11 @@ class RelationMapper {
                                 ids.push(id);
                                 properties[id] = r.properties;
                             }
-                            subRelation = new child_to_many_parents_relation_1.ChildToManyParentsRelation(name, properties, this._client);
+                            subRelation = new child_to_many_parents_relation_1.ChildToManyParentsRelation(name, properties, this._client, relationResource.parentTotal);
                             subRelation.setIds(ids);
                         }
                         else {
-                            subRelation = new child_to_many_parents_relation_1.ChildToManyParentsRelation(name, null, this._client);
+                            subRelation = new child_to_many_parents_relation_1.ChildToManyParentsRelation(name, null, this._client, relationResource.parentTotal);
                         }
                         result = subRelation;
                     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sitecore/sc-contenthub-webclient-sdk",
-    "version": "1.2.12",
+    "version": "1.2.24",
     "description": "Sitecore Content Hub WebClient SDK.",
     "scripts": {
         "build": "npm run clean && npm run test && tsc && npm run lint",