@sitecore/sc-contenthub-webclient-sdk 1.2.28 → 1.2.34

package/esm/clients/pages-client.js

@@ -0,0 +1,46 @@
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { TaJson } from "ta-json";
+import Guard from "../guard";
+import { PageResource } from "../models/pages/page-resource";
+import { ResponseHandler } from "./response-handler";
+export class PagesClient {
+    constructor(client) {
+        this._client = client;
+    }
+    getPageByNameAsync(name, culture, entityId, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.stringNotNullOrEmpty(name);
+            Guard.notNullOrUndefined(culture);
+            return this.getPageByIdentifierAsync(name, culture, entityId, cancelCallback);
+        });
+    }
+    getPageByIdentifierAsync(identifier, culture, entityId, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.stringNotNullOrEmpty(identifier);
+            Guard.notNullOrUndefined(culture);
+            const link = yield this._client.linkHelper.pageResourceToLinkAsync(identifier, culture, entityId);
+            const response = yield this._client.raw.getAsync(link.href, undefined, cancelCallback);
+            ResponseHandler.handleErrors(response);
+            return TaJson.deserialize(response.content, PageResource);
+        });
+    }
+    getPageByIdAsync(id, culture, entityId, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.validId(id);
+            Guard.notNullOrUndefined(culture);
+            const link = yield this._client.linkHelper.pageResourceToLinkAsync(id, culture, entityId);
+            const response = yield this._client.raw.getAsync(link.href, undefined, cancelCallback);
+            ResponseHandler.handleErrors(response);
+            return TaJson.deserialize(response.content, PageResource);
+        });
+    }
+}
+//# sourceMappingURL=pages-client.js.map

package/esm/clients/pages-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pages-client.js","sourceRoot":"","sources":["../../src/clients/pages-client.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAGjC,OAAO,KAAK,MAAM,UAAU,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAG7D,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAoDrD,MAAM,OAAO,WAAW;IAGpB,YAAY,MAAiC;QACzC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAEK,kBAAkB,CACpB,IAAY,EACZ,OAAoB,EACpB,QAAiB,EACjB,cAA+B;;YAE/B,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;YACjC,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAElC,OAAO,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC;QAClF,CAAC;KAAA;IAEK,wBAAwB,CAC1B,UAAkB,EAClB,OAAoB,EACpB,QAAiB,EACjB,cAA+B;;YAE/B,KAAK,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;YACvC,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAElC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;YAClG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;YAEvF,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAEvC,OAAO,MAAM,CAAC,WAAW,CAAe,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAC5E,CAAC;KAAA;IAEK,gBAAgB,CAClB,EAAU,EACV,OAAoB,EACpB,QAAiB,EACjB,cAA+B;;YAE/B,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAClB,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAElC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC1F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;YAEvF,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAEvC,OAAO,MAAM,CAAC,WAAW,CAAe,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAC5E,CAAC;KAAA;CACJ"}

package/esm/clients/permissions-client.d.ts

@@ -0,0 +1,16 @@
+import { Nullable, NullableResultPromise } from "../base-types";
+import { IExtendedContentHubClient } from "./extended-client";
+export interface IPermissionsClient {
+    /**
+     * Gets the specified entity permissions.
+     *
+     * @param id - The id of the entity
+     * @param userId - The id of the user
+     */
+    getPermissionsAsync(id: number, userId?: Nullable<number>): NullableResultPromise<Array<string>>;
+}
+export declare class PermissionsClient implements IPermissionsClient {
+    protected readonly _client: IExtendedContentHubClient;
+    constructor(client: IExtendedContentHubClient);
+    getPermissionsAsync(id: number, userId?: number): NullableResultPromise<Array<string>>;
+}

package/esm/clients/permissions-client.js

@@ -0,0 +1,47 @@
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { TaJson } from "ta-json";
+import { ResponseHandler } from "../clients/response-handler";
+import Guard from "../guard";
+import { PermissionsResource } from "../models/permissions-resource";
+import { UserEntityPermissionsResource } from "../models/user-entity-permissions-resource";
+export class PermissionsClient {
+    constructor(client) {
+        this._client = client;
+    }
+    getPermissionsAsync(id, userId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.validId(id);
+            let link;
+            if (userId != null) {
+                Guard.validId(userId);
+                link = yield this._client.linkHelper.explainUserPermissionsForEntityToLinkAsync(id, userId);
+            }
+            else {
+                link = yield this._client.linkHelper.permissionsForEntityToLinkAsync(id);
+            }
+            const response = yield this._client.raw.getAsync(link.href);
+            if (response.statusCode === 404) {
+                return [];
+            }
+            ResponseHandler.handleErrors(response);
+            if (userId != null) {
+                const resource = TaJson.deserialize(response.content, UserEntityPermissionsResource);
+                const permissions = resource.permissions.map(p => p.permission);
+                return permissions != null && permissions.length > 0 ? permissions : [];
+            }
+            else {
+                const resource = TaJson.deserialize(response.content, PermissionsResource);
+                return resource.permissions || [];
+            }
+        });
+    }
+}
+//# sourceMappingURL=permissions-client.js.map

package/esm/clients/permissions-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions-client.js","sourceRoot":"","sources":["../../src/clients/permissions-client.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAGjC,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,MAAM,UAAU,CAAC;AAC7B,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,6BAA6B,EAAE,MAAM,4CAA4C,CAAC;AAa3F,MAAM,OAAO,iBAAiB;IAG1B,YAAY,MAAiC;QACzC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAEK,mBAAmB,CAAC,EAAU,EAAE,MAAe;;YACjD,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAElB,IAAI,IAAI,CAAC;YACT,IAAI,MAAM,IAAI,IAAI,EAAE;gBAChB,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBAEtB,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,0CAA0C,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;aAC/F;iBAAM;gBACH,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,+BAA+B,CAAC,EAAE,CAAC,CAAC;aAC5E;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5D,IAAI,QAAQ,CAAC,UAAU,KAAK,GAAG,EAAE;gBAC7B,OAAO,EAAE,CAAC;aACb;YAED,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAEvC,IAAI,MAAM,IAAI,IAAI,EAAE;gBAChB,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAC/B,QAAQ,CAAC,OAAO,EAChB,6BAA6B,CAChC,CAAC;gBAEF,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;gBAChE,OAAO,WAAW,IAAI,IAAI,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;aAC3E;iBAAM;gBACH,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAsB,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;gBAEhG,OAAO,QAAQ,CAAC,WAAW,IAAI,EAAE,CAAC;aACrC;QACL,CAAC;KAAA;CACJ"}

package/esm/clients/policies-client.d.ts

@@ -0,0 +1,47 @@
+import { NullableResultPromise } from "../base-types";
+import { IPolicy } from "../contracts/policies/policy";
+import { IUserGroupPolicy } from "../contracts/policies/user-group-policy";
+import { IUserPolicy } from "../contracts/policies/user-policy";
+import { IExtendedContentHubClient } from "./extended-client";
+/**
+ * Contains functionality to get and update policies.
+ */
+export interface IPoliciesClient {
+    /**
+     * Gets the policy from specified user.
+     *
+     * @remarks
+     * The specified user group id must be a strictly positive number.
+     *
+     * @param userGroupId - Id of the user group to get the policy from
+     * @returns The policy or null when it was not found.
+     */
+    getUserGroupPolicyAsync(userGroupId: number): NullableResultPromise<IUserGroupPolicy>;
+    /**
+     * Gets the policy from specified user.
+     *
+     * @remarks
+     * The specified user id must be a strictly positive number.
+     *
+     * @param userId - Id of the user to get the policy from
+     * @returns The policy or null when it was not found.
+     */
+    getUserPolicyAsync(userId: number): NullableResultPromise<IUserPolicy>;
+    /**
+     * Updates the specified policy.
+     *
+     * @remarks
+     * Throws an error when the policy could not be saved because a validation error occurred.
+     *
+     * @param policy - The policy to update
+     */
+    updateAsync(policy: IPolicy): Promise<void>;
+}
+export declare class PoliciesClient implements IPoliciesClient {
+    private readonly _client;
+    constructor(client: IExtendedContentHubClient);
+    getUserGroupPolicyAsync(userGroupId: number): NullableResultPromise<IUserGroupPolicy>;
+    getUserPolicyAsync(userId: number): NullableResultPromise<IUserPolicy>;
+    updateAsync(policy: IPolicy): Promise<void>;
+    private getPolicyResourceAsync;
+}

package/esm/clients/policies-client.js

@@ -0,0 +1,67 @@
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { StatusCodes } from "http-status-codes";
+import { TaJson } from "ta-json";
+import ErrorMessages from "../error-messages";
+import { InvalidOperationError } from "../errors/invalid-operation-error";
+import Guard from "../guard";
+import { PolicyMapper } from "../mappers/policy-mapper";
+import { PolicyResource } from "../models/policies/policy-resource";
+import { ResponseHandler } from "./response-handler";
+export class PoliciesClient {
+    constructor(client) {
+        Guard.notNull(client);
+        this._client = client;
+    }
+    getUserGroupPolicyAsync(userGroupId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.validId(userGroupId);
+            const resource = yield this.getPolicyResourceAsync(userGroupId);
+            const result = yield PolicyMapper.mapToUserGroupPolicyAsync(this._client, resource);
+            return result;
+        });
+    }
+    getUserPolicyAsync(userId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.validId(userId);
+            const resource = yield this.getPolicyResourceAsync(userId);
+            const result = yield PolicyMapper.mapToUserPolicyAsync(this._client, resource);
+            return result;
+        });
+    }
+    updateAsync(policy) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.notNull(policy);
+            const resource = yield PolicyMapper.mapToResourceAsync(this._client, policy);
+            const id = policy.getRelatedId();
+            if (id == null) {
+                throw new InvalidOperationError(ErrorMessages.PoliciesClient.RelatedIdCannotBeNull);
+            }
+            const link = yield this._client.linkHelper.policyToLinkAsync(id);
+            const content = TaJson.serialize(resource);
+            const response = yield this._client.raw.postAsync(link.href, content);
+            ResponseHandler.handleErrors(response);
+        });
+    }
+    //#region Private methods
+    getPolicyResourceAsync(id) {
+        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 === StatusCodes.NOT_FOUND) {
+                return null;
+            }
+            ResponseHandler.handleErrors(response);
+            const resource = TaJson.deserialize(response.content, PolicyResource);
+            return resource;
+        });
+    }
+}
+//# sourceMappingURL=policies-client.js.map

package/esm/clients/policies-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"policies-client.js","sourceRoot":"","sources":["../../src/clients/policies-client.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAMjC,OAAO,aAAa,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,KAAK,MAAM,UAAU,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAEpE,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAuCrD,MAAM,OAAO,cAAc;IAGvB,YAAY,MAAiC;QACzC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAEK,uBAAuB,CAAC,WAAmB;;YAC7C,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAE3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;YAChE,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,yBAAyB,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAEpF,OAAO,MAAM,CAAC;QAClB,CAAC;KAAA;IAEK,kBAAkB,CAAC,MAAc;;YACnC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAEtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;YAC3D,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,oBAAoB,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAE/E,OAAO,MAAM,CAAC;QAClB,CAAC;KAAA;IAEK,WAAW,CAAC,MAAe;;YAC7B,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAEtB,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAE7E,MAAM,EAAE,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC;YACjC,IAAI,EAAE,IAAI,IAAI,EAAE;gBACZ,MAAM,IAAI,qBAAqB,CAAC,aAAa,CAAC,cAAc,CAAC,qBAAqB,CAAC,CAAC;aACvF;YAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;YACjE,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAEtE,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC;KAAA;IAED,yBAAyB;IAEX,sBAAsB,CAAC,EAAU;;YAC3C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;YAEjE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAE5D,IAAI,QAAQ,CAAC,UAAU,KAAK,WAAW,CAAC,SAAS,EAAE;gBAC/C,OAAO,IAAI,CAAC;aACf;YAED,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAEvC,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAiB,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;YAEtF,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CAGJ"}

package/esm/clients/querying-client.d.ts

@@ -0,0 +1,81 @@
+import { Nullable, NullableResultPromise } from "../base-types";
+import { IEntity } from "../contracts/base/entity";
+import { IEntityLoadConfiguration } from "../contracts/querying/entity-load-configuration";
+import { IEntityQueryResult } from "../contracts/querying/entity-query-result";
+import { IIdQueryResult } from "../contracts/querying/id-query-result";
+import { Query } from "../contracts/querying/query";
+import { IQueryLoadConfiguration } from "../contracts/querying/query-load-configuration";
+import { IContentHubClient } from "./content-hub-client";
+import { IExtendedContentHubClient } from "./extended-client";
+import { CancelCallback } from "./internal-client";
+export interface IQueryingClient {
+    singleAsync(query: Query, loadConfiguration?: IEntityLoadConfiguration, cancelCallback?: CancelCallback): NullableResultPromise<IEntity>;
+    singleIdAsync(query: Query, cancelCallback?: CancelCallback): NullableResultPromise<number>;
+    queryAsync(query: Query, loadConfiguration?: Nullable<IEntityLoadConfiguration>, cancelCallback?: CancelCallback): Promise<IEntityQueryResult>;
+    queryIdsAsync(query: Query, cancelCallback?: CancelCallback): Promise<IIdQueryResult>;
+}
+/**
+ *  Contains functionality to query and scroll for entities.
+ */
+declare abstract class QueryingClientBase implements IQueryingClient {
+    protected readonly _client: IContentHubClient;
+    constructor(client: IContentHubClient);
+    /**
+     * Gets a single entity that matches the query.
+     *
+     * @param query - The query to execute
+     * @param loadConfiguration - The load configuration. If it is null, then {@link EntityLoadConfiguration#Default} will be used.
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
+     * @returns The entity that matches the query or null if there are no results.
+     */
+    singleAsync(query: Query, loadConfiguration?: IEntityLoadConfiguration, cancelCallback?: CancelCallback): NullableResultPromise<IEntity>;
+    /**
+     * Gets a the id of the entity that matches the query.
+     *
+     * @param query - The query to execute
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
+     * @returns The id of the entity that matches the query or null if there are no results.
+     */
+    singleIdAsync(query: Query, cancelCallback?: CancelCallback): NullableResultPromise<number>;
+    /**
+     * Retrieves entities matching the query.
+     *
+     * @param query - The query to execute.
+     * @param loadConfiguration - The load configuration. If it is null, then {@link EntityLoadConfiguration#Default} will be used.
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
+     */
+    abstract queryAsync(query: Query, loadConfiguration?: Nullable<IEntityLoadConfiguration>, cancelCallback?: CancelCallback): Promise<IEntityQueryResult>;
+    /**
+     * Retrieves the ids of entities matching the query.
+     *
+     * @param query - The query to execute.
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
+     */
+    abstract queryIdsAsync(query: Query, cancelCallback?: CancelCallback): Promise<IIdQueryResult>;
+    protected resolveLoadConfiguration(query: Query, loadConfiguration?: IEntityLoadConfiguration): Nullable<IQueryLoadConfiguration>;
+}
+/**
+ *  Contains functionality to query and scroll for entities.
+ */
+export declare class QueryingClient extends QueryingClientBase {
+    private readonly _extendedClient;
+    private readonly _mapper;
+    private readonly _schemaQuerying;
+    constructor(client: IExtendedContentHubClient);
+    /**
+     * Retrieves entities matching the query.
+     *
+     * @param query - The query to execute.
+     * @param loadConfiguration - The load configuration. If it is null, then {@link EntityLoadConfiguration#Default} will be used.
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
+     */
+    queryAsync(query: Query, loadConfiguration?: Nullable<IEntityLoadConfiguration>, cancelCallback?: CancelCallback): Promise<IEntityQueryResult>;
+    /**
+     * Retrieves the ids of entities matching the query.
+     *
+     * @param query - The query to execute.
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
+     */
+    queryIdsAsync(query: Query, cancelCallback?: CancelCallback): Promise<IIdQueryResult>;
+}
+export {};

package/esm/clients/querying-client.js

@@ -0,0 +1,123 @@
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { QueryLoadConfiguration } from "../contracts/querying/query-load-configuration";
+import ErrorMessages from "../error-messages";
+import { InvalidOperationError } from "../errors/invalid-operation-error";
+import Guard from "../guard";
+import { LoadOptionsMapper } from "../mappers/load-options-mapper";
+import { QueryingMapper } from "../mappers/querying-mapper";
+import { SchemaQuerying } from "./schema-querying";
+/**
+ *  Contains functionality to query and scroll for entities.
+ */
+class QueryingClientBase {
+    constructor(client) {
+        Guard.notNullOrUndefined(client);
+        this._client = client;
+    }
+    /**
+     * Gets a single entity that matches the query.
+     *
+     * @param query - The query to execute
+     * @param loadConfiguration - The load configuration. If it is null, then {@link EntityLoadConfiguration#Default} will be used.
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
+     * @returns The entity that matches the query or null if there are no results.
+     */
+    singleAsync(query, loadConfiguration, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.notNullOrUndefined(query);
+            const result = yield this.queryAsync(query, loadConfiguration, cancelCallback);
+            if (result.items.length === 0) {
+                return null;
+            }
+            else if (result.items.length > 1) {
+                throw new InvalidOperationError(ErrorMessages.QueryingClient.MultipleResults);
+            }
+            return result.items[0];
+        });
+    }
+    /**
+     * Gets a the id of the entity that matches the query.
+     *
+     * @param query - The query to execute
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
+     * @returns The id of the entity that matches the query or null if there are no results.
+     */
+    singleIdAsync(query, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.notNullOrUndefined(query);
+            const result = yield this.queryIdsAsync(query, cancelCallback);
+            if (result.items.length === 0) {
+                return null;
+            }
+            else if (result.items.length > 1) {
+                throw new InvalidOperationError(ErrorMessages.QueryingClient.MultipleResults);
+            }
+            return result.items[0];
+        });
+    }
+    //? deprecated
+    resolveLoadConfiguration(query, loadConfiguration) {
+        let queryLoadConfiguration;
+        if (loadConfiguration != null) {
+            queryLoadConfiguration = LoadOptionsMapper.toQueryLoadConfiguration(loadConfiguration);
+        }
+        else {
+            queryLoadConfiguration = QueryLoadConfiguration.Default;
+        }
+        return queryLoadConfiguration;
+    }
+}
+/**
+ *  Contains functionality to query and scroll for entities.
+ */
+export class QueryingClient extends QueryingClientBase {
+    constructor(client) {
+        super(client);
+        Guard.notNullOrUndefined(client);
+        this._extendedClient = client;
+        this._schemaQuerying = new SchemaQuerying(client);
+        this._mapper = new QueryingMapper(client);
+    }
+    /**
+     * Retrieves entities matching the query.
+     *
+     * @param query - The query to execute.
+     * @param loadConfiguration - The load configuration. If it is null, then {@link EntityLoadConfiguration#Default} will be used.
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
+     */
+    queryAsync(query, loadConfiguration, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.notNullOrUndefined(query, "query");
+            //TODO query.validate();
+            const queryLoadConfiguration = this.resolveLoadConfiguration(query, loadConfiguration || undefined);
+            const resource = yield this._schemaQuerying.queryWithSchemaAsync(query, queryLoadConfiguration, cancelCallback);
+            loadConfiguration = LoadOptionsMapper.toEntityLoadConfiguration(queryLoadConfiguration || undefined);
+            const result = yield this._mapper.mapEntityQueryResultAsync(resource, query, loadConfiguration);
+            return result;
+        });
+    }
+    /**
+     * Retrieves the ids of entities matching the query.
+     *
+     * @param query - The query to execute.
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
+     */
+    queryIdsAsync(query, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.notNullOrUndefined(query, "query");
+            //TODO query.validate();
+            const resource = yield this._schemaQuerying.queryWithSchemaAsync(query, QueryLoadConfiguration.Ids, cancelCallback);
+            const result = yield this._mapper.mapEntityIdQueryResultAsync(resource, query);
+            return result;
+        });
+    }
+}
+//# sourceMappingURL=querying-client.js.map

package/esm/clients/querying-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"querying-client.js","sourceRoot":"","sources":["../../src/clients/querying-client.ts"],"names":[],"mappings":";;;;;;;;;AAMA,OAAO,EAA2B,sBAAsB,EAAE,MAAM,gDAAgD,CAAC;AACjH,OAAO,aAAa,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,KAAK,MAAM,UAAU,CAAC;AAC7B,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAI5D,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAoBnD;;GAEG;AACH,MAAe,kBAAkB;IAG7B,YAAY,MAAyB;QACjC,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAED;;;;;;;OAOG;IACG,WAAW,CACb,KAAY,EACZ,iBAA4C,EAC5C,cAA+B;;YAE/B,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAEhC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,iBAAiB,EAAE,cAAc,CAAC,CAAC;YAE/E,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC3B,OAAO,IAAI,CAAC;aACf;iBAAM,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;gBAChC,MAAM,IAAI,qBAAqB,CAAC,aAAa,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;aACjF;YAED,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;KAAA;IAED;;;;;;OAMG;IACG,aAAa,CAAC,KAAY,EAAE,cAA+B;;YAC7D,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAEhC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;YAE/D,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC3B,OAAO,IAAI,CAAC;aACf;iBAAM,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;gBAChC,MAAM,IAAI,qBAAqB,CAAC,aAAa,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;aACjF;YAED,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;KAAA;IAuBD,cAAc;IACJ,wBAAwB,CAC9B,KAAY,EACZ,iBAA4C;QAE5C,IAAI,sBAAyD,CAAC;QAE9D,IAAI,iBAAiB,IAAI,IAAI,EAAE;YAC3B,sBAAsB,GAAG,iBAAiB,CAAC,wBAAwB,CAAC,iBAAiB,CAAC,CAAC;SAC1F;aAAM;YACH,sBAAsB,GAAG,sBAAsB,CAAC,OAAO,CAAC;SAC3D;QAED,OAAO,sBAAsB,CAAC;IAClC,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,kBAAkB;IAKlD,YAAY,MAAiC;QACzC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC;QAC9B,IAAI,CAAC,eAAe,GAAG,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,OAAO,GAAG,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IACG,UAAU,CACZ,KAAY,EACZ,iBAAsD,EACtD,cAA+B;;YAE/B,KAAK,CAAC,kBAAkB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACzC,wBAAwB;YAExB,MAAM,sBAAsB,GAAG,IAAI,CAAC,wBAAwB,CAAC,KAAK,EAAE,iBAAiB,IAAI,SAAS,CAAC,CAAC;YACpG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAC5D,KAAK,EACL,sBAAuB,EACvB,cAAc,CACjB,CAAC;YAEF,iBAAiB,GAAG,iBAAiB,CAAC,yBAAyB,CAAC,sBAAsB,IAAI,SAAS,CAAC,CAAC;YACrG,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,QAAQ,EAAE,KAAK,EAAE,iBAAkB,CAAC,CAAC;YAEjG,OAAO,MAAO,CAAC;QACnB,CAAC;KAAA;IAED;;;;;OAKG;IACG,aAAa,CAAC,KAAY,EAAE,cAA+B;;YAC7D,KAAK,CAAC,kBAAkB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACzC,wBAAwB;YAExB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAC5D,KAAK,EACL,sBAAsB,CAAC,GAAG,EAC1B,cAAc,CACjB,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAE/E,OAAO,MAAO,CAAC;QACnB,CAAC;KAAA;CACJ"}

package/esm/clients/raw-client.d.ts

@@ -0,0 +1,22 @@
+import URI from "urijs";
+import { MapStringTo } from "../base-types";
+import { IExtendedContentHubClient } from "./extended-client";
+import { CancelCallback } from "./internal-client";
+import { RequestMessage } from "./request-message";
+import { ResponseMessage } from "./response-message";
+export interface IRawClient {
+    getAsync<T>(uri: string | URI, headers?: MapStringTo<string>, cancelCallback?: CancelCallback): Promise<ResponseMessage<T>>;
+    postAsync<T, K>(uri: string | URI, content?: T, headers?: MapStringTo<string>, cancelCallback?: CancelCallback): Promise<ResponseMessage<K>>;
+    putAsync<T, K>(uri: string | URI, content?: T, headers?: MapStringTo<string>, cancelCallback?: CancelCallback): Promise<ResponseMessage<K>>;
+    deleteAsync<T>(uri: string | URI, headers?: MapStringTo<string>, cancelCallback?: CancelCallback): Promise<ResponseMessage<T>>;
+    sendAsync<T, K>(messageFactory: () => RequestMessage, cancelCallback?: CancelCallback): Promise<ResponseMessage<K>>;
+}
+export declare class RawClient implements IRawClient {
+    private readonly _client;
+    constructor(client: IExtendedContentHubClient);
+    getAsync<T = any>(uri: string | URI, headers?: MapStringTo<string>, cancelCallback?: CancelCallback): Promise<ResponseMessage<T>>;
+    postAsync<T = any, K = any>(uri: string | URI, content: unknown, headers?: MapStringTo<string>, cancelCallback?: CancelCallback): Promise<ResponseMessage<K>>;
+    putAsync<T = any, K = any>(uri: string | URI, content: unknown, headers?: MapStringTo<string>, cancelCallback?: CancelCallback): Promise<ResponseMessage<K>>;
+    deleteAsync<T = any>(uri: string | URI, headers?: MapStringTo<string>, cancelCallback?: CancelCallback): Promise<ResponseMessage<T>>;
+    sendAsync<T = any, K = any>(messageFactory: () => RequestMessage<T>, cancelCallback?: CancelCallback): Promise<ResponseMessage<K>>;
+}

package/esm/clients/raw-client.js

@@ -0,0 +1,74 @@
+/* istanbul ignore file */
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import Guard from "../guard";
+import { HttpMethod } from "../http-method";
+import { RequestMessage } from "./request-message";
+export class RawClient {
+    constructor(client) {
+        Guard.notNullOrUndefined(client);
+        this._client = client;
+    }
+    getAsync(uri, headers, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._client.internalClient.sendAsync(() => new RequestMessage({
+                requestUri: uri,
+                method: HttpMethod.GET,
+                requestHeaders: headers,
+            }), cancelCallback);
+        });
+    }
+    postAsync(uri, content, headers, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!headers) {
+                headers = {
+                    "Content-Type": "application/json",
+                };
+            }
+            return yield this._client.internalClient.sendAsync(() => new RequestMessage({
+                requestUri: uri,
+                method: HttpMethod.POST,
+                requestHeaders: headers,
+                content: content,
+            }), cancelCallback);
+        });
+    }
+    putAsync(uri, content, headers, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!headers) {
+                headers = {
+                    "Content-Type": "application/json",
+                };
+            }
+            return yield this._client.internalClient.sendAsync(() => new RequestMessage({
+                requestUri: uri,
+                method: HttpMethod.PUT,
+                requestHeaders: headers,
+                content: content,
+            }), cancelCallback);
+        });
+    }
+    deleteAsync(uri, headers, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._client.internalClient.sendAsync(() => new RequestMessage({
+                requestUri: uri,
+                method: HttpMethod.DELETE,
+                requestHeaders: headers,
+            }), cancelCallback);
+        });
+    }
+    sendAsync(messageFactory, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.notNullOrUndefined(messageFactory);
+            return yield this._client.internalClient.sendAsync(messageFactory, cancelCallback);
+        });
+    }
+}
+//# sourceMappingURL=raw-client.js.map

package/esm/clients/raw-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"raw-client.js","sourceRoot":"","sources":["../../src/clients/raw-client.ts"],"names":[],"mappings":"AAAA,0BAA0B;;;;;;;;;;AAK1B,OAAO,KAAK,MAAM,UAAU,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAG5C,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAkCnD,MAAM,OAAO,SAAS;IAGlB,YAAY,MAAiC;QACzC,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAEK,QAAQ,CACV,GAAiB,EACjB,OAA6B,EAC7B,cAA+B;;YAE/B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,SAAS,CAC9C,GAAG,EAAE,CACD,IAAI,cAAc,CAAI;gBAClB,UAAU,EAAE,GAAG;gBACf,MAAM,EAAE,UAAU,CAAC,GAAG;gBACtB,cAAc,EAAE,OAAO;aAC1B,CAAC,EACN,cAAc,CACjB,CAAC;QACN,CAAC;KAAA;IAEK,SAAS,CACX,GAAiB,EACjB,OAAgB,EAChB,OAA6B,EAC7B,cAA+B;;YAE/B,IAAI,CAAC,OAAO,EAAE;gBACV,OAAO,GAAG;oBACN,cAAc,EAAE,kBAAkB;iBACrC,CAAC;aACL;YAED,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,SAAS,CAC9C,GAAG,EAAE,CACD,IAAI,cAAc,CAAI;gBAClB,UAAU,EAAE,GAAG;gBACf,MAAM,EAAE,UAAU,CAAC,IAAI;gBACvB,cAAc,EAAE,OAAO;gBACvB,OAAO,EAAE,OAAO;aACnB,CAAC,EACN,cAAc,CACjB,CAAC;QACN,CAAC;KAAA;IAEK,QAAQ,CACV,GAAiB,EACjB,OAAgB,EAChB,OAA6B,EAC7B,cAA+B;;YAE/B,IAAI,CAAC,OAAO,EAAE;gBACV,OAAO,GAAG;oBACN,cAAc,EAAE,kBAAkB;iBACrC,CAAC;aACL;YAED,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,SAAS,CAC9C,GAAG,EAAE,CACD,IAAI,cAAc,CAAI;gBAClB,UAAU,EAAE,GAAG;gBACf,MAAM,EAAE,UAAU,CAAC,GAAG;gBACtB,cAAc,EAAE,OAAO;gBACvB,OAAO,EAAE,OAAO;aACnB,CAAC,EACN,cAAc,CACjB,CAAC;QACN,CAAC;KAAA;IAEK,WAAW,CACb,GAAiB,EACjB,OAA6B,EAC7B,cAA+B;;YAE/B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,SAAS,CAC9C,GAAG,EAAE,CACD,IAAI,cAAc,CAAI;gBAClB,UAAU,EAAE,GAAG;gBACf,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,cAAc,EAAE,OAAO;aAC1B,CAAC,EACN,cAAc,CACjB,CAAC;QACN,CAAC;KAAA;IAEK,SAAS,CACX,cAAuC,EACvC,cAA+B;;YAE/B,KAAK,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;YAEzC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,SAAS,CAAO,cAAc,EAAE,cAAc,CAAC,CAAC;QAC7F,CAAC;KAAA;CACJ"}

package/esm/clients/request-message.d.ts

@@ -0,0 +1,25 @@
+import URI from "urijs";
+import { MapStringTo } from "../base-types";
+import { HttpMethod } from "../http-method";
+/**
+ * A request message to be used with {@link IInternalClient} implementations.
+ */
+export declare class RequestMessage<T = any> {
+    /**
+     * HTTP method that indicates the desired action to be performed.
+     */
+    method: HttpMethod;
+    /**
+     * A URI referring to a resource on the Web.
+     */
+    requestUri: URI | string;
+    /**
+     * Headers with additional information that will be sent to the server.
+     */
+    requestHeaders?: MapStringTo<string>;
+    /**
+     * The content (or body) of the message that will be sent to the server.
+     */
+    content?: T;
+    constructor(init?: RequestMessage);
+}

package/esm/clients/request-message.js

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/**
+ * A request message to be used with {@link IInternalClient} implementations.
+ */
+export class RequestMessage {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+}
+//# sourceMappingURL=request-message.js.map

package/esm/clients/request-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-message.js","sourceRoot":"","sources":["../../src/clients/request-message.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAO1B;;GAEG;AACH,MAAM,OAAO,cAAc;IAqBvB,YAAY,IAAqB;QAC7B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9B,CAAC;CACJ"}

package/esm/clients/response-handler.d.ts

@@ -0,0 +1,30 @@
+import { ResponseMessage } from "./response-message";
+export declare abstract class ResponseHandler {
+    /**
+     * Inspects the response message's success status.
+     *
+     * @remarks
+     * Throws errors when response message is not successful.
+     *
+     * @param responseMessage - The response message
+     */
+    static handleErrors(responseMessage: ResponseMessage): void;
+    /**
+     * Handle validation errors related to a malformed or in another way invalid request payload send to server.
+     *
+     * @remarks
+     * This method always throws an exception.
+     *
+     * @param responseMessage - The response message
+     */
+    private static handleBadRequest;
+    /**
+     * Handle generic errors.
+     *
+     * @remarks
+     * This method always throws an exception.
+     *
+     * @param responseMessage - The response message
+     */
+    private static handleGenericError;
+}