@sitecore/sc-contenthub-webclient-sdk 1.1.1 → 1.2.1

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

@@ -1,23 +1,4 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -32,7 +13,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EntityDefinitionsClient = void 0;
-const HttpStatus = __importStar(require("http-status-codes"));
+const http_status_codes_1 = require("http-status-codes");
 const ta_json_1 = require("ta-json");
 const entity_definition_cache_1 = require("../caches/entity-definition-cache");
 const entity_definition_id_iterator_1 = require("../contracts/querying/entity-definition-id-iterator");
@@ -46,41 +27,43 @@ 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) {
         this._client = client;
         this._cache = new entity_definition_cache_1.EntityDefinitionCache();
     }
-    getAllCachedAsync() {
+    getAllCachedAsync(includeConditionalMembers = true, loadPermissions) {
         return __awaiter(this, void 0, void 0, function* () {
-            let definitions = this._cache.getAll();
+            let definitions = this._cache.getAll(undefined, includeConditionalMembers, loadPermissions);
             if (!definitions) {
-                definitions = yield this.getAllAsync();
+                definitions = yield this.getAllAsync(includeConditionalMembers, loadPermissions);
             }
             return definitions;
         });
     }
-    getAllAsync() {
+    getAllAsync(includeConditionalMembers = true, loadPermissions) {
         return __awaiter(this, void 0, void 0, function* () {
-            const allEntityDefinitions = yield this.getAllBatchedAsync();
-            this._cache.loadAll(allEntityDefinitions);
+            const allEntityDefinitions = yield this.getAllBatchedAsync(includeConditionalMembers, loadPermissions);
+            this._cache.loadAll(allEntityDefinitions, undefined, undefined, includeConditionalMembers, loadPermissions);
             return allEntityDefinitions;
         });
     }
-    getAsync(param) {
+    getAsync(param, includeConditionalMembers = true, loadPermissions) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.notNullOrUndefined(param);
-            const link = yield this._client.linkHelper.definitionToLinkAsync(param, true);
+            const link = yield this._client.linkHelper.definitionToLinkAsync(param, includeConditionalMembers, loadPermissions);
             return this.getDefinitionAsync(link);
         });
     }
-    getCachedAsync(param) {
+    getCachedAsync(param, includeConditionalMembers = true, loadPermissions) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.notNullOrUndefined(param);
-            let definitionPromise = this._cache.getAsync(param);
+            let definitionPromise = this._cache.getAsync(param, includeConditionalMembers, loadPermissions);
             if (!definitionPromise) {
-                definitionPromise = this.getAsync(param);
-                this._cache.loadAsync(param, definitionPromise);
+                definitionPromise = this.getAsync(param, includeConditionalMembers, loadPermissions);
+                this._cache.loadAsync(param, definitionPromise, includeConditionalMembers, loadPermissions);
             }
             return definitionPromise;
         });
@@ -119,7 +102,7 @@ class EntityDefinitionsClient {
             return definition && definition.id;
         });
     }
-    getManyAsync(param) {
+    getManyAsync(param, includeConditionalMembers = true, loadPermissions) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.notNullOrUndefined(param);
             if (param.length === 0) {
@@ -127,17 +110,17 @@ class EntityDefinitionsClient {
             }
             else if (type_guards_1.TypeGuards.isStringArray(param)) {
                 guard_1.default.arrayNoneNullOrEmptyString(param);
-                const linkFactory = (batch, batchSize, includeConditionalMembers) => this._client.linkHelper.definitionsToLinkAsync(batch, undefined, batchSize, includeConditionalMembers);
+                const linkFactory = (batch, batchSize) => this._client.linkHelper.definitionsToLinkAsync(batch, undefined, batchSize, includeConditionalMembers, undefined, loadPermissions);
                 return this.getDefinitionsBatchedAsync(param, linkFactory);
             }
             else {
                 guard_1.default.validIds(param);
-                const linkFactory = (batch, batchSize, includeConditionalMembers) => this._client.linkHelper.definitionsToLinkAsync(batch, undefined, batchSize, includeConditionalMembers);
+                const linkFactory = (batch, batchSize) => this._client.linkHelper.definitionsToLinkAsync(batch, undefined, batchSize, includeConditionalMembers);
                 return this.getDefinitionsBatchedAsync(param, linkFactory);
             }
         });
     }
-    getManyCachedAsync(param) {
+    getManyCachedAsync(param, includeConditionalMembers = true, loadPermissions) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.notNullOrUndefined(param);
             if (param.length === 0)
@@ -146,7 +129,7 @@ class EntityDefinitionsClient {
             const stillToFetch = [];
             const result = [];
             for (const nameOrId of param) {
-                const definition = this._cache.get(nameOrId);
+                const definition = this._cache.getAsync(nameOrId, includeConditionalMembers, loadPermissions);
                 if (definition != null) {
                     result.push(definition);
                 }
@@ -156,10 +139,11 @@ class EntityDefinitionsClient {
             }
             if (stillToFetch != null && stillToFetch.length > 0) {
                 const set = new Set(stillToFetch);
-                const fetchedDefinitions = yield this.getManyAsync(shouldGetByName ? [...set] : [...set]);
+                const fetchedDefinitions = yield this.getManyAsync(shouldGetByName ? [...set] : [...set], includeConditionalMembers, loadPermissions);
                 result.push(...fetchedDefinitions);
             }
-            return result;
+            const loadedResults = yield Promise.all(result);
+            return loadedResults.filter((definition) => definition != null);
         });
     }
     getNamesAsync(ids) {
@@ -285,9 +269,9 @@ class EntityDefinitionsClient {
     createEntityDefinitionIdIterator(pageSize) {
         return new entity_definition_id_iterator_1.EntityDefinitionIdIterator(this._client, pageSize);
     }
-    getDefinitionsSkipTake(skip, take) {
+    getDefinitionsSkipTake(skip, take, includeConditionalMembers = true, loadPermissions) {
         return __awaiter(this, void 0, void 0, function* () {
-            const link = yield this._client.linkHelper.definitionsToLinkAsync(null, skip, take, true);
+            const link = yield this._client.linkHelper.definitionsToLinkAsync(null, skip, take, includeConditionalMembers, undefined, loadPermissions);
             const response = yield this._client.raw.getAsync(link.href);
             const collectionResource = ta_json_1.TaJson.deserialize(response.content, entity_definition_collection_resource_1.EntityDefinitionCollectionResource);
             return collectionResource;
@@ -296,13 +280,14 @@ class EntityDefinitionsClient {
     getDefinitionAsync(link) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this._client.raw.getAsync(link.href);
-            if (response.statusCode === HttpStatus.NOT_FOUND) {
+            if (response.statusCode === http_status_codes_1.StatusCodes.NOT_FOUND) {
                 return null;
             }
             const resource = ta_json_1.TaJson.deserialize(response.content, entity_definition_resource_1.EntityDefinitionResource);
             const definition = yield this._client.entityDefinitionMapper.mapEntityDefinitionAsync(resource);
             if (definition) {
-                this._cache.load(definition);
+                const uri = new urijs_1.default(link.href);
+                this._cache.load(definition, uri.hasQuery(api_1.ENTITY_DEFINITIONS.includeConditionalMembers, true), uri.hasQuery(api_1.ENTITY_DEFINITIONS.loadPermissions, true));
             }
             return definition;
         });
@@ -312,31 +297,46 @@ class EntityDefinitionsClient {
             if (!definitionsToFetch || definitionsToFetch.length === 0) {
                 return [];
             }
-            const resources = [];
             // We need to batch this or the backend will refuse to respond.
-            const batches = array_utilities_1.chunk(definitionsToFetch, EntityDefinitionsClient._batchSize);
+            const batches = (0, array_utilities_1.chunk)(definitionsToFetch, EntityDefinitionsClient._batchSize);
+            const includeConditionalMembers = true;
+            const definitions = [];
             for (const definitionBatch of batches) {
-                const link = yield linkFactory(definitionBatch, EntityDefinitionsClient._batchSize, true);
-                const response = yield this._client.raw.getAsync(link.href);
-                response_handler_1.ResponseHandler.handleErrors(response);
-                const resource = ta_json_1.TaJson.deserialize(response.content, entity_definition_collection_resource_1.EntityDefinitionCollectionResource);
-                resources.push(...resource.items);
-            }
-            const definitions = yield this._client.entityDefinitionMapper.mapEntityDefinitionsAsync(resources);
-            for (const definition of definitions) {
-                this._cache.load(definition);
+                const batchResult = linkFactory(definitionBatch, EntityDefinitionsClient._batchSize, includeConditionalMembers)
+                    .then(link => {
+                    return this._client.raw.getAsync(link.href);
+                })
+                    .then(response => {
+                    response_handler_1.ResponseHandler.handleErrors(response);
+                    const resource = ta_json_1.TaJson.deserialize(response.content, entity_definition_collection_resource_1.EntityDefinitionCollectionResource);
+                    return resource.items;
+                });
+                // Map each definition key to its result and load into cache individually
+                for (const definitionKey of definitionBatch) {
+                    const definition = batchResult
+                        .then(result => {
+                        var _a;
+                        return (_a = result.find(definition => typeof definitionKey === "string"
+                            ? definition.name === definitionKey
+                            : definition.id === definitionKey)) !== null && _a !== void 0 ? _a : null;
+                    })
+                        .then(resource => resource ? this._client.entityDefinitionMapper.mapEntityDefinitionAsync(resource) : null);
+                    definitions.push(definition);
+                    // Important this caching is done before any promise is resolved, to cache the load ASAP.
+                    this._cache.loadAsync(definitionKey, definition, includeConditionalMembers);
+                }
             }
-            return definitions;
+            return Promise.all(definitions).then(results => results.filter((result) => result != null));
         });
     }
-    getAllBatchedAsync() {
+    getAllBatchedAsync(includeConditionalMembers = true, loadPermissions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const resources = [];
             let resource = null;
             let skip = 0;
             while (resource == null || resource.next) {
-                const link = (_a = resource === null || resource === void 0 ? void 0 : resource.next) !== null && _a !== void 0 ? _a : (yield this._client.linkHelper.definitionsLinkAsync(skip, EntityDefinitionsClient._batchSize, true));
+                const link = (_a = resource === null || resource === void 0 ? void 0 : resource.next) !== null && _a !== void 0 ? _a : (yield this._client.linkHelper.definitionsLinkAsync(skip, EntityDefinitionsClient._batchSize, includeConditionalMembers, undefined, loadPermissions));
                 const response = yield this._client.raw.getAsync(link.href);
                 response_handler_1.ResponseHandler.handleErrors(response);
                 resource = ta_json_1.TaJson.deserialize(response.content, entity_definition_collection_resource_1.EntityDefinitionCollectionResource);
@@ -353,3 +353,4 @@ class EntityDefinitionsClient {
 }
 exports.EntityDefinitionsClient = EntityDefinitionsClient;
 EntityDefinitionsClient._batchSize = 25;
+//# sourceMappingURL=entity-definitions-client.js.map

package/dist/clients/extended-client.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=extended-client.js.map

package/dist/clients/internal-client.d.ts

@@ -4,6 +4,7 @@ import OAuthRefreshTokenGrant from "../authentication/oauth-refreshtoken-grant";
 import { MapStringTo } from "../base-types";
 import { RequestMessage } from "./request-message";
 import { ResponseMessage } from "./response-message";
+export declare type CancelCallback = (cancel: (reason?: string) => void) => void;
 export interface IInternalClient {
     /**
      * Authenticate with the remote server.
@@ -18,13 +19,22 @@ export interface IInternalClient {
     /**
      * Sends a request to the remote server and returns the server's response.
      * @param requestGenerator - Function which returns a {@link RequestMessage}
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an axios {@link CancelToken} if provided
      */
-    sendAsync<T = unknown, K = unknown>(requestGenerator: () => RequestMessage<T>): Promise<ResponseMessage<K>>;
+    sendAsync<T = unknown, K = unknown>(requestGenerator: () => RequestMessage<T>, cancelCallback?: CancelCallback): Promise<ResponseMessage<K>>;
     /**
      * Set headers which will be send with every request.
      * @param headers - The headers to send with every request
      */
     setRequestHeaders(headers: MapStringTo<string>): void;
+    /**
+     * Sets the error response handler.
+     * @param onError - The callback function to handle the response error.
+     *
+     * @remarks
+     * Only expected to work when authentication to the endpoint has been established without the use of an OAuth grant.
+     */
+    setResponseErrorHandler(onError: (error: any) => Promise<any>): void;
 }
 export declare class InternalClient implements IInternalClient {
     private _accessToken;
@@ -40,7 +50,12 @@ export declare class InternalClient implements IInternalClient {
     constructor(baseUri: URI | string, oauthGrant?: OAuthPasswordGrant | OAuthRefreshTokenGrant);
     authenticateAsync(): Promise<boolean>;
     setRequestHeaders(headers: MapStringTo<string>): void;
+    /**
+     * Sets the provided error handler as an interceptor for the responses.
+     * @param onError - the callback that should be called on error.
+     */
+    setResponseErrorHandler(onError: (error: any) => Promise<any>): void;
     private send_onFulfilled;
     private send_onRejected;
-    sendAsync<T = any, K = any>(requestGenerator: () => RequestMessage<T>): Promise<ResponseMessage<K>>;
+    sendAsync<T = any, K = any>(requestGenerator: () => RequestMessage<T>, cancelCallback?: CancelCallback): Promise<ResponseMessage<K>>;
 }

package/dist/clients/internal-client.js

@@ -37,7 +37,7 @@ class InternalClient {
         guard_1.default.stringNotNullOrEmpty(baseUrl);
         const createClientParameters = {
             baseURL: baseUrl,
-            adapter: axios_extensions_1.throttleAdapterEnhancer(axios_extensions_1.cacheAdapterEnhancer(axios_1.default.defaults.adapter, { enabledByDefault: false })),
+            adapter: (0, axios_extensions_1.throttleAdapterEnhancer)((0, axios_extensions_1.cacheAdapterEnhancer)(axios_1.default.defaults.adapter, { enabledByDefault: false })),
         };
         // This setting should be added to the .env file for connecting to a server using a self signed certificate
         if (typeof process !== "undefined" && process != null) {
@@ -86,7 +86,7 @@ class InternalClient {
                         this._accessToken = tokenInfo.accessToken;
                         this._refreshTokenGrant.refreshToken = tokenInfo.refreshToken;
                         error.response.config.headers["Authorization"] = "Bearer " + tokenInfo.accessToken;
-                        return axios_1.default(error.response.config);
+                        return (0, axios_1.default)(error.response.config);
                     })
                         .catch(error => {
                         this._isAuthenticated = false;
@@ -161,6 +161,16 @@ class InternalClient {
         guard_1.default.notNullOrUndefined(headers);
         this._requestHeaders = headers;
     }
+    /**
+     * Sets the provided error handler as an interceptor for the responses.
+     * @param onError - the callback that should be called on error.
+     */
+    setResponseErrorHandler(onError) {
+        if (this.shouldAuthenticateWithOAuth) {
+            throw new invalid_operation_error_1.InvalidOperationError("Unable to set response error handler when authenticating via OAuth.");
+        }
+        this._client.interceptors.response.use(response => response, error => onError(error));
+    }
     send_onFulfilled(requestMsg) {
         return (response) => {
             return response_message_1.ResponseMessage.build(response.status, response.headers, {
@@ -184,7 +194,7 @@ class InternalClient {
             throw error;
         }
     }
-    sendAsync(requestGenerator) {
+    sendAsync(requestGenerator, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this._isAuthenticated) {
                 throw new invalid_operation_error_1.InvalidOperationError("Client is not authenticated. Authenticate first.");
@@ -196,6 +206,9 @@ class InternalClient {
             guard_1.default.stringNotNullOrEmpty(requestUrl);
             const requestConfig = {};
             requestConfig.headers = Object.assign(Object.assign({}, this._requestHeaders), requestMsg.requestHeaders);
+            if (cancelCallback) {
+                requestConfig.cancelToken = new axios_1.default.CancelToken(cancelCallback);
+            }
             let result = response_message_1.ResponseMessage.build(0); // Not a valid status code, but we'll know it failed.
             switch (requestMsg.method) {
                 case http_method_1.HttpMethod.DELETE:
@@ -249,3 +262,4 @@ class InternalClient {
     }
 }
 exports.InternalClient = InternalClient;
+//# sourceMappingURL=internal-client.js.map

package/dist/clients/notifications-client.js

@@ -126,3 +126,4 @@ class NotificationsClient {
     }
 }
 exports.NotificationsClient = NotificationsClient;
+//# sourceMappingURL=notifications-client.js.map

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

@@ -2,48 +2,55 @@ import { NullableResultPromise } from "../base-types";
 import { IOptionList } from "../contracts/base/option-lists/option-list";
 import OptionListDescriptionResource from "../models/option-lists/option-list-description-resource";
 import { IExtendedContentHubClient } from "./extended-client";
+import { CancelCallback } from "./internal-client";
 export interface IOptionListClient {
     /**
      * Gets the names of all option lists that exist.
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      */
-    getAllNamesAsync(): Promise<Array<string>>;
+    getAllNamesAsync(cancelCallback?: CancelCallback): Promise<Array<string>>;
     /**
      * Gets an array of all options list descriptions.
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      */
-    getAllDescriptionsAsync(): Promise<Array<OptionListDescriptionResource>>;
+    getAllDescriptionsAsync(cancelCallback?: CancelCallback): Promise<Array<OptionListDescriptionResource>>;
     /**
      * Gets the option list with the specified name.
      *
      * @param name - the option list name
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      */
-    getAsync(name: string): NullableResultPromise<IOptionList>;
+    getAsync(name: string, cancelCallback?: CancelCallback): NullableResultPromise<IOptionList>;
     /**
      * Creates a new option list
      *
      * @param optionList - {@link IOptionList} - the option list instance
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      */
-    createAsync(optionList: IOptionList): Promise<void>;
+    createAsync(optionList: IOptionList, cancelCallback?: CancelCallback): Promise<void>;
     /**
      * Update an existing option list
      *
      * @param optionList - {@link IOptionList} - the option list instance
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      */
-    updateAsync(optionList: IOptionList): Promise<void>;
+    updateAsync(optionList: IOptionList, cancelCallback?: CancelCallback): Promise<void>;
     /**
      * Delete an existing option list
      *
      * @param name - the name of the option list
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      */
-    deleteAsync(name: string): Promise<void>;
+    deleteAsync(name: string, cancelCallback?: CancelCallback): Promise<void>;
 }
 export declare class OptionListClient implements IOptionListClient {
     private readonly _client;
     private readonly _mapper;
     constructor(client: IExtendedContentHubClient);
-    getAllNamesAsync(): Promise<Array<string>>;
-    getAllDescriptionsAsync(): Promise<Array<OptionListDescriptionResource>>;
-    getAsync(name: string): NullableResultPromise<IOptionList>;
-    createAsync(optionList: IOptionList): Promise<void>;
-    updateAsync(optionList: IOptionList): Promise<void>;
-    deleteAsync(name: string): Promise<void>;
+    getAllNamesAsync(cancelCallback?: CancelCallback): Promise<Array<string>>;
+    getAllDescriptionsAsync(cancelCallback?: CancelCallback): Promise<Array<OptionListDescriptionResource>>;
+    getAsync(name: string, cancelCallback?: CancelCallback): 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

@@ -24,28 +24,28 @@ class OptionListClient {
         this._client = client;
         this._mapper = new option_list_mapper_1.OptionListMapper(client);
     }
-    getAllNamesAsync() {
+    getAllNamesAsync(cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             const link = yield this._client.linkHelper.dataSourcesLinkAsync();
-            const response = yield this._client.raw.getAsync(link.href);
+            const response = yield this._client.raw.getAsync(link.href, undefined, cancelCallback);
             const resource = ta_json_1.TaJson.deserialize(response.content, option_list_collection_resource_1.default);
             const names = resource.items.map(item => item.name);
             return names;
         });
     }
-    getAllDescriptionsAsync() {
+    getAllDescriptionsAsync(cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             const link = yield this._client.linkHelper.dataSourcesLinkAsync();
-            const response = yield this._client.raw.getAsync(link.href);
+            const response = yield this._client.raw.getAsync(link.href, undefined, cancelCallback);
             const resource = ta_json_1.TaJson.deserialize(response.content, option_list_collection_resource_1.default);
             return resource.items;
         });
     }
-    getAsync(name) {
+    getAsync(name, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.stringNotNullOrEmpty(name);
             const link = yield this._client.linkHelper.dataSourceToLinkAsync(name);
-            const response = yield this._client.raw.getAsync(link.href);
+            const response = yield this._client.raw.getAsync(link.href, undefined, cancelCallback);
             if (response.statusCode === 404) {
                 return null;
             }
@@ -55,31 +55,32 @@ class OptionListClient {
             return optionList;
         });
     }
-    createAsync(optionList) {
+    createAsync(optionList, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.notNull(optionList, "optionList");
             const resource = this._mapper.map(optionList);
             const link = yield this._client.linkHelper.dataSourcesLinkAsync();
-            const response = yield this._client.raw.postAsync(link.href, ta_json_1.TaJson.serialize(resource));
+            const response = yield this._client.raw.postAsync(link.href, ta_json_1.TaJson.serialize(resource), undefined, cancelCallback);
             response_handler_1.ResponseHandler.handleErrors(response);
         });
     }
-    updateAsync(optionList) {
+    updateAsync(optionList, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.notNull(optionList, "optionList");
             const resource = this._mapper.map(optionList);
             const link = yield this._client.linkHelper.dataSourceToLinkAsync(optionList.name);
-            const response = yield this._client.raw.putAsync(link.href, ta_json_1.TaJson.serialize(resource));
+            const response = yield this._client.raw.putAsync(link.href, ta_json_1.TaJson.serialize(resource), undefined, cancelCallback);
             response_handler_1.ResponseHandler.handleErrors(response);
         });
     }
-    deleteAsync(name) {
+    deleteAsync(name, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.stringNotNullOrEmpty(name);
             const link = yield this._client.linkHelper.dataSourceToLinkAsync(name);
-            const response = yield this._client.raw.deleteAsync(link.href);
+            const response = yield this._client.raw.deleteAsync(link.href, undefined, cancelCallback);
             response_handler_1.ResponseHandler.handleErrors(response);
         });
     }
 }
 exports.OptionListClient = OptionListClient;
+//# sourceMappingURL=option-list-client.js.map

package/dist/clients/pages-client.d.ts

@@ -1,36 +1,43 @@
 import CultureInfo from "../culture-info";
 import { PageResource } from "../models/pages/page-resource";
 import { IExtendedContentHubClient } from "./extended-client";
+import { CancelCallback } from "./internal-client";
 export interface IPagesClient {
     /**
      * Get a page resource by identifier.
      * @param identifier - The identifier of the page
      * @param culture - A culture to load the page in
+     * @param entityId - The current entity id (Optional)
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      * @returns A promise resolving to a {@link PageResource}.
      * @throws An error when the resource can't be found.
      */
-    getPageByIdentifierAsync(identifier: string, culture: CultureInfo): Promise<PageResource>;
+    getPageByIdentifierAsync(identifier: string, culture: CultureInfo, entityId?: number, cancelCallback?: CancelCallback): Promise<PageResource>;
     /**
      * Get a page resource by name.
      * @param name - The name of the page
      * @param culture - A culture to load the page in
+     * @param entityId - The current entity id (Optional)
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      * @returns A promise resolving to a {@link PageResource}.
      * @throws An error when the resource can't be found.
      */
-    getPageByNameAsync(name: string, culture: CultureInfo): Promise<PageResource>;
+    getPageByNameAsync(name: string, culture: CultureInfo, entityId?: number, cancelCallback?: CancelCallback): Promise<PageResource>;
     /**
      * Get a page resource by id.
      * @param id - The id of the page
      * @param culture - A culture to load the page in
+     * @param entityId - The current entity id (Optional)
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      * @returns A promise resolving to a {@link PageResource}.
      * @throws An error when the resource can't be found.
      */
-    getPageByIdAsync(id: number, culture: CultureInfo): Promise<PageResource>;
+    getPageByIdAsync(id: number, culture: CultureInfo, entityId?: number, cancelCallback?: CancelCallback): Promise<PageResource>;
 }
 export declare class PagesClient implements IPagesClient {
     private readonly _client;
     constructor(client: IExtendedContentHubClient);
-    getPageByNameAsync(name: string, culture: CultureInfo): Promise<PageResource>;
-    getPageByIdentifierAsync(identifier: string, culture: CultureInfo): Promise<PageResource>;
-    getPageByIdAsync(id: number, culture: CultureInfo): Promise<PageResource>;
+    getPageByNameAsync(name: string, culture: CultureInfo, entityId?: number, cancelCallback?: CancelCallback): Promise<PageResource>;
+    getPageByIdentifierAsync(identifier: string, culture: CultureInfo, entityId?: number, cancelCallback?: CancelCallback): Promise<PageResource>;
+    getPageByIdAsync(id: number, culture: CultureInfo, entityId?: number, cancelCallback?: CancelCallback): Promise<PageResource>;
 }

package/dist/clients/pages-client.js

@@ -21,32 +21,33 @@ class PagesClient {
     constructor(client) {
         this._client = client;
     }
-    getPageByNameAsync(name, culture) {
+    getPageByNameAsync(name, culture, entityId, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.stringNotNullOrEmpty(name);
             guard_1.default.notNullOrUndefined(culture);
-            return this.getPageByIdentifierAsync(name, culture);
+            return this.getPageByIdentifierAsync(name, culture, entityId, cancelCallback);
         });
     }
-    getPageByIdentifierAsync(identifier, culture) {
+    getPageByIdentifierAsync(identifier, culture, entityId, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.stringNotNullOrEmpty(identifier);
             guard_1.default.notNullOrUndefined(culture);
-            const link = yield this._client.linkHelper.pageResourceToLinkAsync(identifier, culture);
-            const response = yield this._client.raw.getAsync(link.href);
+            const link = yield this._client.linkHelper.pageResourceToLinkAsync(identifier, culture, entityId);
+            const response = yield this._client.raw.getAsync(link.href, undefined, cancelCallback);
             response_handler_1.ResponseHandler.handleErrors(response);
             return ta_json_1.TaJson.deserialize(response.content, page_resource_1.PageResource);
         });
     }
-    getPageByIdAsync(id, culture) {
+    getPageByIdAsync(id, culture, entityId, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.validId(id);
             guard_1.default.notNullOrUndefined(culture);
-            const link = yield this._client.linkHelper.pageResourceToLinkAsync(id, culture);
-            const response = yield this._client.raw.getAsync(link.href);
+            const link = yield this._client.linkHelper.pageResourceToLinkAsync(id, culture, entityId);
+            const response = yield this._client.raw.getAsync(link.href, undefined, cancelCallback);
             response_handler_1.ResponseHandler.handleErrors(response);
             return ta_json_1.TaJson.deserialize(response.content, page_resource_1.PageResource);
         });
     }
 }
 exports.PagesClient = PagesClient;
+//# sourceMappingURL=pages-client.js.map

package/dist/clients/permissions-client.js

@@ -51,3 +51,4 @@ class PermissionsClient {
     }
 }
 exports.PermissionsClient = PermissionsClient;
+//# sourceMappingURL=permissions-client.js.map

package/dist/clients/policies-client.js

@@ -1,23 +1,4 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -32,7 +13,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PoliciesClient = void 0;
-const HttpStatus = __importStar(require("http-status-codes"));
+const http_status_codes_1 = require("http-status-codes");
 const ta_json_1 = require("ta-json");
 const error_messages_1 = __importDefault(require("../error-messages"));
 const invalid_operation_error_1 = require("../errors/invalid-operation-error");
@@ -80,7 +61,7 @@ class PoliciesClient {
         return __awaiter(this, void 0, void 0, function* () {
             const link = yield this._client.linkHelper.policyToLinkAsync(id);
             const response = yield this._client.raw.getAsync(link.href);
-            if (response.statusCode === HttpStatus.NOT_FOUND) {
+            if (response.statusCode === http_status_codes_1.StatusCodes.NOT_FOUND) {
                 return null;
             }
             response_handler_1.ResponseHandler.handleErrors(response);
@@ -90,3 +71,4 @@ class PoliciesClient {
     }
 }
 exports.PoliciesClient = PoliciesClient;
+//# sourceMappingURL=policies-client.js.map