@sitecore/sc-contenthub-webclient-sdk 1.2.0 → 1.2.2

package/dist/clients/entity-definitions-client.d.ts

@@ -11,17 +11,19 @@ export interface IEntityDefinitionsClient {
      * @param name - The name of the definition
      * @param includeConditionalMembers - Include conditional members
      * @param loadPermissions - Load permissions for the definition
+     * @param cacheSignature - Signature of the cached resources for controlling browser caching
      * @returns Promise which resolves to an {@link IEntityDefinition} or null.
      */
-    getAsync(name: string, includeConditionalMembers?: boolean, loadPermissions?: boolean): NullableResultPromise<IEntityDefinition>;
+    getAsync(name: string, includeConditionalMembers?: boolean, loadPermissions?: boolean, cacheSignature?: string): NullableResultPromise<IEntityDefinition>;
     /**
      * Get the {@link IEntityDefinition} instance by the specified id.
      * @param id - The id of the definition
      * @param includeConditionalMembers - Include conditional members
      * @param loadPermissions - Load permissions for the definition
+     * @param cacheSignature - Signature of the cached resources for controlling browser caching
      * @returns Promise which resolves to an {@link IEntityDefinition} or null.
      */
-    getAsync(id: number, includeConditionalMembers?: boolean, loadPermissions?: boolean): NullableResultPromise<IEntityDefinition>;
+    getAsync(id: number, includeConditionalMembers?: boolean, loadPermissions?: boolean, cacheSignature?: string): NullableResultPromise<IEntityDefinition>;
     /**
      * Get all the {@link IEntityDefinition}s.
      * @param includeConditionalMembers - Include conditional members
@@ -41,14 +43,15 @@ export interface IEntityDefinitionsClient {
      * @param name - The name of the definition
      * @param includeConditionalMembers - Include conditional members
      * @param loadPermissions - Load permissions for the definition
+     * @param cacheSignature - Signature of the cached resources for controlling browser caching
      * @returns Promise which resolves to an {@link IEntityDefinition} or null.
      */
-    getCachedAsync(name: string, includeConditionalMembers?: boolean, loadPermissions?: boolean): NullableResultPromise<IEntityDefinition>;
-    getCachedAsync(id: number, includeConditionalMembers?: boolean, loadPermissions?: boolean): NullableResultPromise<IEntityDefinition>;
-    getNameAsync(id: number): NullableResultPromise<string>;
-    getNameCachedAsync(id: number): NullableResultPromise<string>;
-    getIdAsync(name: string): NullableResultPromise<number>;
-    getIdCachedAsync(name: string): NullableResultPromise<number>;
+    getCachedAsync(name: string, includeConditionalMembers?: boolean, loadPermissions?: boolean, cacheSignature?: string): NullableResultPromise<IEntityDefinition>;
+    getCachedAsync(id: number, includeConditionalMembers?: boolean, loadPermissions?: boolean, cacheSignature?: string): NullableResultPromise<IEntityDefinition>;
+    getNameAsync(id: number, cacheSignature?: string): NullableResultPromise<string>;
+    getNameCachedAsync(id: number, cacheSignature?: string): NullableResultPromise<string>;
+    getIdAsync(name: string, cacheSignature?: string): NullableResultPromise<number>;
+    getIdCachedAsync(name: string, cacheSignature?: string): NullableResultPromise<number>;
     /**
      * Get multiple entity definitions.
      * @param names - Names of the definitions to fetch
@@ -100,12 +103,12 @@ export declare class EntityDefinitionsClient implements IEntityDefinitionsClient
     constructor(client: IExtendedContentHubClient);
     getAllCachedAsync(includeConditionalMembers?: boolean, loadPermissions?: boolean): Promise<Array<IEntityDefinition>>;
     getAllAsync(includeConditionalMembers?: boolean, loadPermissions?: boolean): Promise<Array<IEntityDefinition>>;
-    getAsync(param: string | number, includeConditionalMembers?: boolean, loadPermissions?: boolean): NullableResultPromise<IEntityDefinition>;
-    getCachedAsync(param: string | number, includeConditionalMembers?: boolean, loadPermissions?: boolean): NullableResultPromise<IEntityDefinition>;
-    getNameAsync(id: number): NullableResultPromise<string>;
-    getNameCachedAsync(id: number): NullableResultPromise<string>;
-    getIdAsync(name: string): NullableResultPromise<number>;
-    getIdCachedAsync(name: string): NullableResultPromise<number>;
+    getAsync(param: string | number, includeConditionalMembers?: boolean, loadPermissions?: boolean, cacheSignature?: string): NullableResultPromise<IEntityDefinition>;
+    getCachedAsync(param: string | number, includeConditionalMembers?: boolean, loadPermissions?: boolean, cacheSignature?: string): NullableResultPromise<IEntityDefinition>;
+    getNameAsync(id: number, cacheSignature?: string): NullableResultPromise<string>;
+    getNameCachedAsync(id: number, cacheSignature?: string): NullableResultPromise<string>;
+    getIdAsync(name: string, cacheSignature?: string): NullableResultPromise<number>;
+    getIdCachedAsync(name: string, cacheSignature?: string): NullableResultPromise<number>;
     getManyAsync(param: Array<string> | Array<number>, includeConditionalMembers?: boolean, loadPermissions?: boolean): Promise<Array<IEntityDefinition>>;
     getManyCachedAsync(param: Array<string> | Array<number>, includeConditionalMembers?: boolean, loadPermissions?: boolean): Promise<Array<IEntityDefinition>>;
     getNamesAsync(ids: Array<number>): Promise<MapNumberTo<string>>;

package/dist/clients/entity-definitions-client.js

@@ -15,6 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EntityDefinitionsClient = void 0;
 const http_status_codes_1 = require("http-status-codes");
 const ta_json_1 = require("ta-json");
+const urijs_1 = __importDefault(require("urijs"));
 const entity_definition_cache_1 = require("../caches/entity-definition-cache");
 const entity_definition_id_iterator_1 = require("../contracts/querying/entity-definition-id-iterator");
 const entity_definition_id_query_result_1 = require("../contracts/querying/entity-definition-id-query-result");
@@ -27,7 +28,6 @@ const entity_definition_resource_1 = require("../models/entity-definition-resour
 const type_guards_1 = require("../type-guards");
 const array_utilities_1 = require("../utilities/array-utilities");
 const response_handler_1 = require("./response-handler");
-const urijs_1 = __importDefault(require("urijs"));
 const api_1 = require("../constants/api");
 class EntityDefinitionsClient {
     constructor(client) {
@@ -50,54 +50,59 @@ class EntityDefinitionsClient {
             return allEntityDefinitions;
         });
     }
-    getAsync(param, includeConditionalMembers = true, loadPermissions) {
+    getAsync(param, includeConditionalMembers = true, loadPermissions, cacheSignature) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.notNullOrUndefined(param);
             const link = yield this._client.linkHelper.definitionToLinkAsync(param, includeConditionalMembers, loadPermissions);
+            const uri = new urijs_1.default(link.href);
+            if (cacheSignature && !uri.hasQuery("after")) {
+                uri.addQuery("after", cacheSignature);
+                link.href = uri.toString();
+            }
             return this.getDefinitionAsync(link);
         });
     }
-    getCachedAsync(param, includeConditionalMembers = true, loadPermissions) {
+    getCachedAsync(param, includeConditionalMembers = true, loadPermissions, cacheSignature) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.notNullOrUndefined(param);
             let definitionPromise = this._cache.getAsync(param, includeConditionalMembers, loadPermissions);
             if (!definitionPromise) {
-                definitionPromise = this.getAsync(param, includeConditionalMembers, loadPermissions);
+                definitionPromise = this.getAsync(param, includeConditionalMembers, loadPermissions, cacheSignature);
                 this._cache.loadAsync(param, definitionPromise, includeConditionalMembers, loadPermissions);
             }
             return definitionPromise;
         });
     }
-    getNameAsync(id) {
+    getNameAsync(id, cacheSignature) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.validId(id);
-            const definition = yield this.getAsync(id);
+            const definition = yield this.getAsync(id, undefined, undefined, cacheSignature);
             return definition && definition.name;
         });
     }
-    getNameCachedAsync(id) {
+    getNameCachedAsync(id, cacheSignature) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.validId(id);
             let definition = this._cache.get(id);
             if (!definition) {
-                definition = yield this.getAsync(id);
+                definition = yield this.getAsync(id, undefined, undefined, cacheSignature);
             }
             return definition && definition.name;
         });
     }
-    getIdAsync(name) {
+    getIdAsync(name, cacheSignature) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.stringNotNullOrEmpty(name);
-            const definition = yield this.getAsync(name);
+            const definition = yield this.getAsync(name, undefined, undefined, cacheSignature);
             return definition && definition.id;
         });
     }
-    getIdCachedAsync(name) {
+    getIdCachedAsync(name, cacheSignature) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.stringNotNullOrEmpty(name);
             let definition = this._cache.get(name);
             if (!definition) {
-                definition = yield this.getAsync(name);
+                definition = yield this.getAsync(name, undefined, undefined, cacheSignature);
             }
             return definition && definition.id;
         });

package/dist/clients/option-list-client.d.ts

@@ -19,8 +19,9 @@ export interface IOptionListClient {
      *
      * @param name - the option list name
      * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
+     * @param cacheSignature - Signature of the cached resources for controlling browser caching
      */
-    getAsync(name: string, cancelCallback?: CancelCallback): NullableResultPromise<IOptionList>;
+    getAsync(name: string, cancelCallback?: CancelCallback, cacheSignature?: string): NullableResultPromise<IOptionList>;
     /**
      * Creates a new option list
      *
@@ -49,7 +50,7 @@ export declare class OptionListClient implements IOptionListClient {
     constructor(client: IExtendedContentHubClient);
     getAllNamesAsync(cancelCallback?: CancelCallback): Promise<Array<string>>;
     getAllDescriptionsAsync(cancelCallback?: CancelCallback): Promise<Array<OptionListDescriptionResource>>;
-    getAsync(name: string, cancelCallback?: CancelCallback): NullableResultPromise<IOptionList>;
+    getAsync(name: string, cancelCallback?: CancelCallback, cacheSignature?: string): NullableResultPromise<IOptionList>;
     createAsync(optionList: IOptionList, cancelCallback?: CancelCallback): Promise<void>;
     updateAsync(optionList: IOptionList, cancelCallback?: CancelCallback): Promise<void>;
     deleteAsync(name: string, cancelCallback?: CancelCallback): Promise<void>;

package/dist/clients/option-list-client.js

@@ -14,6 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OptionListClient = void 0;
 const ta_json_1 = require("ta-json");
+const urijs_1 = __importDefault(require("urijs"));
 const guard_1 = __importDefault(require("../guard"));
 const option_list_mapper_1 = require("../mappers/option-list-mapper");
 const option_list_collection_resource_1 = __importDefault(require("../models/option-lists/option-list-collection-resource"));
@@ -41,18 +42,22 @@ class OptionListClient {
             return resource.items;
         });
     }
-    getAsync(name, cancelCallback) {
+    getAsync(name, cancelCallback, cacheSignature) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.stringNotNullOrEmpty(name);
             const link = yield this._client.linkHelper.dataSourceToLinkAsync(name);
+            const uri = new urijs_1.default(link.href);
+            if (!uri.hasQuery("after") && cacheSignature) {
+                uri.addQuery("after", cacheSignature);
+                link.href = uri.toString();
+            }
             const response = yield this._client.raw.getAsync(link.href, undefined, cancelCallback);
             if (response.statusCode === 404) {
                 return null;
             }
             response_handler_1.ResponseHandler.handleErrors(response);
             const resource = ta_json_1.TaJson.deserialize(response.content, option_list_resource_1.default);
-            const optionList = this._mapper.mapOptionListAsync(resource);
-            return optionList;
+            return this._mapper.mapOptionListAsync(resource);
         });
     }
     createAsync(optionList, cancelCallback) {

package/dist/contracts/base/related-path.d.ts

@@ -2,7 +2,7 @@
 import { MapCultureTo, MapStringTo, Nullable } from "../../base-types";
 export interface IRelatedPath {
     readonly name: string;
-    readonly items: ReadonlyArray<IRelatedPathItem>;
+    readonly items: ReadonlyArray<ReadonlyArray<IRelatedPathItem>>;
 }
 export interface IRelatedPathItem {
     readonly values: MapCultureTo<string>;

package/dist/mappers/related-path-mapper.js

@@ -15,12 +15,12 @@ class RelatedPathMapper {
             }
             const relatedPath = {
                 name: relatedPathName,
-                items: values.flat().map(item => ({
+                items: values.map(items => items.map(item => ({
                     values: item.values,
                     definition: item.definition,
                     entity: item.entity,
                     properties: item.properties || null,
-                })),
+                }))),
             };
             list.push(relatedPath);
         }

package/package.json

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