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

package/esm/clients/internal-client.js

@@ -0,0 +1,258 @@
+/* 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 axios from "axios";
+import { cacheAdapterEnhancer, throttleAdapterEnhancer } from "axios-extensions";
+import https from "https";
+import { TaJson } from "ta-json";
+import OAuthPasswordGrant from "../authentication/oauth-password-grant";
+import OAuthRefreshTokenGrant from "../authentication/oauth-refreshtoken-grant";
+import { TokenInfo } from "../authentication/token-info";
+import { AuthenticationError } from "../errors/authentication-error";
+import { InvalidOperationError } from "../errors/invalid-operation-error";
+import Guard from "../guard";
+import { HttpMethod } from "../http-method";
+import { ResponseMessage } from "./response-message";
+export class InternalClient {
+    constructor(baseUri, oauthGrant) {
+        this._passwordGrant = null;
+        this._refreshTokenGrant = null;
+        this._requestHeaders = {};
+        Guard.notNullOrUndefined(baseUri);
+        Guard.notNull(oauthGrant);
+        const baseUrl = typeof baseUri === "string" ? baseUri : baseUri.href();
+        Guard.stringNotNullOrEmpty(baseUrl);
+        const createClientParameters = {
+            baseURL: baseUrl,
+            adapter: throttleAdapterEnhancer(cacheAdapterEnhancer(axios.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) {
+            if (process.env.IGNORE_HTTPS_ERRORS === "true") {
+                createClientParameters.httpsAgent = new https.Agent({
+                    rejectUnauthorized: false,
+                });
+            }
+        }
+        this._client = axios.create(createClientParameters);
+        if (oauthGrant instanceof OAuthPasswordGrant) {
+            this._passwordGrant = oauthGrant;
+        }
+        else if (oauthGrant instanceof OAuthRefreshTokenGrant) {
+            this._refreshTokenGrant = oauthGrant;
+        }
+        if (this.shouldAuthenticateWithOAuth) {
+            const createRefreshTokenResponseInterceptor = () => {
+                const responseInterceptor = this._client.interceptors.response.use((response) => response, (error) => {
+                    // Reject promise if usual error
+                    if (error.status !== 401) {
+                        return Promise.reject(error);
+                    }
+                    // When response code is 401, try to refresh the token.
+                    // Eject the interceptor so it doesn't loop in case the token refresh causes the 401 response.
+                    this._client.interceptors.response.eject(responseInterceptor);
+                    return this._client
+                        .request({
+                        url: "/oauth/token",
+                        method: "POST",
+                        transformRequest: [
+                            function (data, headers) {
+                                headers["Content-Type"] = "application/x-www-form-urlencoded; charset=UTF-8";
+                                return Object.keys(data)
+                                    .reduce((d, k) => {
+                                    d.push(`${k}=${encodeURIComponent(data[k])}`);
+                                    return d;
+                                }, [])
+                                    .join("&");
+                            },
+                        ],
+                        data: TaJson.serialize(this._refreshTokenGrant),
+                    })
+                        .then(response => {
+                        const tokenInfo = TaJson.deserialize(response.data, TokenInfo);
+                        this._accessToken = tokenInfo.accessToken;
+                        this._refreshTokenGrant.refreshToken = tokenInfo.refreshToken;
+                        error.response.config.headers["Authorization"] = "Bearer " + tokenInfo.accessToken;
+                        return axios(error.response.config);
+                    })
+                        .catch(error => {
+                        this._isAuthenticated = false;
+                        throw error;
+                    })
+                        .finally(createRefreshTokenResponseInterceptor);
+                });
+            };
+            createRefreshTokenResponseInterceptor.bind(this);
+            createRefreshTokenResponseInterceptor();
+        }
+        else {
+            // No OAuthGrant specified, so we must be in the browser.
+            this._client.defaults.withCredentials = true; // Send the cookies with the requests.
+            this._isAuthenticated = true; // Let's assume we're already authenticated
+        }
+    }
+    /**
+     * Indicates if we should authenticate with OAuth.
+     */
+    get shouldAuthenticateWithOAuth() {
+        return !!(this._passwordGrant || this._refreshTokenGrant);
+    }
+    authenticateAsync() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._isAuthenticated || !this.shouldAuthenticateWithOAuth) {
+                return true;
+            }
+            if (this._accessToken) {
+                return true;
+            }
+            if (!this._passwordGrant) {
+                throw new InvalidOperationError("Can not authenticate - Missing OAuth password grant.");
+            }
+            return yield this._client
+                .request({
+                url: "/oauth/token",
+                method: "POST",
+                transformRequest: [
+                    function (data, headers) {
+                        headers["Content-Type"] = "application/x-www-form-urlencoded; charset=UTF-8";
+                        return Object.keys(data)
+                            .reduce((d, k) => {
+                            d.push(`${k}=${encodeURIComponent(data[k])}`);
+                            return d;
+                        }, [])
+                            .join("&");
+                    },
+                ],
+                data: TaJson.serialize(this._passwordGrant),
+            })
+                .then(response => {
+                const tokenInfo = TaJson.deserialize(response.data, TokenInfo);
+                this._accessToken = tokenInfo.accessToken;
+                this._refreshTokenGrant = new OAuthRefreshTokenGrant(this._passwordGrant.clientId, this._passwordGrant.clientSecret, tokenInfo.refreshToken);
+                this._client.interceptors.request.use(config => {
+                    config.headers["Authorization"] = `Bearer ${this._accessToken}`;
+                    return config;
+                }, error => {
+                    return Promise.reject(error);
+                });
+                this._isAuthenticated = true;
+                return true;
+            })
+                .catch(error => {
+                this._isAuthenticated = false;
+                throw new AuthenticationError("Authentication failed.", error);
+            });
+        });
+    }
+    setRequestHeaders(headers) {
+        Guard.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 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 ResponseMessage.build(response.status, response.headers, {
+                requestMessage: Object.freeze(requestMsg),
+                content: response.data,
+                statusText: response.statusText,
+            });
+        };
+    }
+    send_onRejected(error) {
+        if (error.response) {
+            return ResponseMessage.build(error.response.status, error.response.headers, {
+                statusText: error.response.statusText,
+                content: error.response.data,
+            });
+        }
+        else if (error.request) {
+            return ResponseMessage.build(error.request.status, {}, { statusText: error.request.statusText, content: error.request.data });
+        }
+        else {
+            throw error;
+        }
+    }
+    sendAsync(requestGenerator, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._isAuthenticated) {
+                throw new InvalidOperationError("Client is not authenticated. Authenticate first.");
+            }
+            Guard.notNullOrUndefined(requestGenerator);
+            const requestMsg = requestGenerator();
+            Guard.notNullOrUndefined(requestMsg.requestUri);
+            const requestUrl = typeof requestMsg.requestUri === "string" ? requestMsg.requestUri : requestMsg.requestUri.href();
+            Guard.stringNotNullOrEmpty(requestUrl);
+            const requestConfig = {};
+            requestConfig.headers = Object.assign(Object.assign({}, this._requestHeaders), requestMsg.requestHeaders);
+            if (cancelCallback) {
+                requestConfig.cancelToken = new axios.CancelToken(cancelCallback);
+            }
+            let result = ResponseMessage.build(0); // Not a valid status code, but we'll know it failed.
+            switch (requestMsg.method) {
+                case HttpMethod.DELETE:
+                    result = yield this._client
+                        .delete(requestUrl, requestConfig)
+                        .then(this.send_onFulfilled(requestMsg), error => this.send_onRejected(error));
+                    break;
+                case HttpMethod.GET:
+                    result = yield this._client
+                        .get(requestUrl, requestConfig)
+                        .then(this.send_onFulfilled(requestMsg), error => this.send_onRejected(error));
+                    break;
+                case HttpMethod.HEAD:
+                    result = yield this._client
+                        .head(requestUrl, requestConfig)
+                        .then(this.send_onFulfilled(requestMsg), error => this.send_onRejected(error));
+                    break;
+                case HttpMethod.OPTIONS:
+                    requestConfig.method = "OPTIONS";
+                    requestConfig.url = requestUrl;
+                    result = yield this._client
+                        .request(requestConfig)
+                        .then(this.send_onFulfilled(requestMsg), error => this.send_onRejected(error));
+                    break;
+                case HttpMethod.PATCH:
+                    result = yield this._client
+                        .patch(requestUrl, typeof requestMsg.content === "string"
+                        ? requestMsg.content
+                        : TaJson.serialize(requestMsg.content), requestConfig)
+                        .then(this.send_onFulfilled(requestMsg), error => this.send_onRejected(error));
+                    break;
+                case HttpMethod.POST:
+                    result = yield this._client
+                        .post(requestUrl, typeof requestMsg.content === "string"
+                        ? requestMsg.content
+                        : TaJson.serialize(requestMsg.content), requestConfig)
+                        .then(this.send_onFulfilled(requestMsg), error => this.send_onRejected(error));
+                    break;
+                case HttpMethod.PUT:
+                    result = yield this._client
+                        .put(requestUrl, typeof requestMsg.content === "string"
+                        ? requestMsg.content
+                        : TaJson.serialize(requestMsg.content), requestConfig)
+                        .then(this.send_onFulfilled(requestMsg), error => this.send_onRejected(error));
+                    break;
+                default:
+                    throw "Method not supported.";
+            }
+            return result;
+        });
+    }
+}
+//# sourceMappingURL=internal-client.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"internal-client.js","sourceRoot":"","sources":["../../src/clients/internal-client.ts"],"names":[],"mappings":"AAAA,0BAA0B;;;;;;;;;;AAE1B,OAAO,KAAuE,MAAM,OAAO,CAAC;AAC5F,OAAO,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AACjF,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,OAAO,kBAAkB,MAAM,wCAAwC,CAAC;AACxE,OAAO,sBAAsB,MAAM,4CAA4C,CAAC;AAChF,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAEzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,KAAK,MAAM,UAAU,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AA0CrD,MAAM,OAAO,cAAc;IAevB,YAAY,OAAqB,EAAE,UAAwD;QAbnF,mBAAc,GAAiC,IAAI,CAAC;QACpD,uBAAkB,GAAqC,IAAI,CAAC;QAE5D,oBAAe,GAAwB,EAAE,CAAC;QAW9C,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAClC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAE1B,MAAM,OAAO,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QACvE,KAAK,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAEpC,MAAM,sBAAsB,GAAuB;YAC/C,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,uBAAuB,CAC5B,oBAAoB,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAQ,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,CAC7E;SACJ,CAAC;QAEF,2GAA2G;QAC3G,IAAI,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,IAAI,IAAI,EAAE;YACnD,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,KAAK,MAAM,EAAE;gBAC5C,sBAAsB,CAAC,UAAU,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC;oBAChD,kBAAkB,EAAE,KAAK;iBAC5B,CAAC,CAAC;aACN;SACJ;QAED,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;QAEpD,IAAI,UAAU,YAAY,kBAAkB,EAAE;YAC1C,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC;SACpC;aAAM,IAAI,UAAU,YAAY,sBAAsB,EAAE;YACrD,IAAI,CAAC,kBAAkB,GAAG,UAAU,CAAC;SACxC;QAED,IAAI,IAAI,CAAC,2BAA2B,EAAE;YAClC,MAAM,qCAAqC,GAAG,GAAS,EAAE;gBACrD,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAC9D,CAAC,QAAa,EAAE,EAAE,CAAC,QAAQ,EAC3B,CAAC,KAAU,EAAE,EAAE;oBACX,gCAAgC;oBAChC,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,EAAE;wBACtB,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;qBAChC;oBAED,uDAAuD;oBACvD,8FAA8F;oBAC9F,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;oBAE9D,OAAO,IAAI,CAAC,OAAO;yBACd,OAAO,CAAC;wBACL,GAAG,EAAE,cAAc;wBACnB,MAAM,EAAE,MAAM;wBACd,gBAAgB,EAAE;4BACd,UAAU,IAAI,EAAE,OAAO;gCACnB,OAAQ,CAAC,cAAc,CAAC,GAAG,kDAAkD,CAAC;gCAC9E,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;qCACnB,MAAM,CAAC,CAAC,CAAgB,EAAE,CAAC,EAAE,EAAE;oCAC5B,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;oCAC9C,OAAO,CAAC,CAAC;gCACb,CAAC,EAAE,EAAE,CAAC;qCACL,IAAI,CAAC,GAAG,CAAC,CAAC;4BACnB,CAAC;yBACJ;wBACD,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC;qBAClD,CAAC;yBACD,IAAI,CAAC,QAAQ,CAAC,EAAE;wBACb,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAY,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;wBAC1E,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,WAAW,CAAC;wBAC1C,IAAI,CAAC,kBAAmB,CAAC,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC;wBAE/D,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC;wBACnF,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;oBACxC,CAAC,CAAC;yBACD,KAAK,CAAC,KAAK,CAAC,EAAE;wBACX,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;wBAC9B,MAAM,KAAK,CAAC;oBAChB,CAAC,CAAC;yBACD,OAAO,CAAC,qCAAqC,CAAC,CAAC;gBACxD,CAAC,CACJ,CAAC;YACN,CAAC,CAAC;YACF,qCAAqC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjD,qCAAqC,EAAE,CAAC;SAC3C;aAAM;YACH,yDAAyD;YACzD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,eAAe,GAAG,IAAI,CAAC,CAAC,sCAAsC;YACpF,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC,2CAA2C;SAC5E;IACL,CAAC;IA5FD;;OAEG;IACH,IAAY,2BAA2B;QACnC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC9D,CAAC;IAyFK,iBAAiB;;YACnB,IAAI,IAAI,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC,2BAA2B,EAAE;gBAC5D,OAAO,IAAI,CAAC;aACf;YACD,IAAI,IAAI,CAAC,YAAY,EAAE;gBACnB,OAAO,IAAI,CAAC;aACf;YACD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;gBACtB,MAAM,IAAI,qBAAqB,CAAC,sDAAsD,CAAC,CAAC;aAC3F;YAED,OAAO,MAAM,IAAI,CAAC,OAAO;iBACpB,OAAO,CAAC;gBACL,GAAG,EAAE,cAAc;gBACnB,MAAM,EAAE,MAAM;gBACd,gBAAgB,EAAE;oBACd,UAAU,IAAI,EAAE,OAAO;wBACnB,OAAQ,CAAC,cAAc,CAAC,GAAG,kDAAkD,CAAC;wBAC9E,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;6BACnB,MAAM,CAAC,CAAC,CAAgB,EAAE,CAAC,EAAE,EAAE;4BAC5B,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;4BAC9C,OAAO,CAAC,CAAC;wBACb,CAAC,EAAE,EAAE,CAAC;6BACL,IAAI,CAAC,GAAG,CAAC,CAAC;oBACnB,CAAC;iBACJ;gBACD,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC;aAC9C,CAAC;iBACD,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACb,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAY,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBAC1E,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,WAAW,CAAC;gBAC1C,IAAI,CAAC,kBAAkB,GAAG,IAAI,sBAAsB,CAChD,IAAI,CAAC,cAAe,CAAC,QAAQ,EAC7B,IAAI,CAAC,cAAe,CAAC,YAAY,EACjC,SAAS,CAAC,YAAY,CACzB,CAAC;gBAEF,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CACjC,MAAM,CAAC,EAAE;oBACL,MAAM,CAAC,OAAQ,CAAC,eAAe,CAAC,GAAG,UAAU,IAAI,CAAC,YAAY,EAAE,CAAC;oBACjE,OAAO,MAAM,CAAC;gBAClB,CAAC,EACD,KAAK,CAAC,EAAE;oBACJ,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACjC,CAAC,CACJ,CAAC;gBAEF,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;gBAC7B,OAAO,IAAI,CAAC;YAChB,CAAC,CAAC;iBACD,KAAK,CAAC,KAAK,CAAC,EAAE;gBACX,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;gBAC9B,MAAM,IAAI,mBAAmB,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC;YACnE,CAAC,CAAC,CAAC;QACX,CAAC;KAAA;IAED,iBAAiB,CAAC,OAA4B;QAC1C,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAElC,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,uBAAuB,CAAC,OAAqC;QACzD,IAAI,IAAI,CAAC,2BAA2B,EAAE;YAClC,MAAM,IAAI,qBAAqB,CAAC,qEAAqE,CAAC,CAAC;SAC1G;QAED,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAClC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EACpB,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAC1B,CAAC;IACN,CAAC;IAEO,gBAAgB,CACpB,UAA6B;QAE7B,OAAO,CAAC,QAA4B,EAAE,EAAE;YACpC,OAAO,eAAe,CAAC,KAAK,CAAI,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,OAA8B,EAAE;gBACtF,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;gBACzC,OAAO,EAAE,QAAQ,CAAC,IAAI;gBACtB,UAAU,EAAE,QAAQ,CAAC,UAAU;aAClC,CAAC,CAAC;QACP,CAAC,CAAC;IACN,CAAC;IAEO,eAAe,CAAI,KAAsB;QAC7C,IAAI,KAAK,CAAC,QAAQ,EAAE;YAChB,OAAO,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE;gBACxE,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,UAAU;gBACrC,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI;aAC/B,CAAC,CAAC;SACN;aAAM,IAAI,KAAK,CAAC,OAAO,EAAE;YACtB,OAAO,eAAe,CAAC,KAAK,CACxB,KAAK,CAAC,OAAO,CAAC,MAAM,EACpB,EAAE,EACF,EAAE,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,CACxE,CAAC;SACL;aAAM;YACH,MAAM,KAAK,CAAC;SACf;IACL,CAAC;IAEK,SAAS,CACX,gBAAyC,EACzC,cAA+B;;YAE/B,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBACxB,MAAM,IAAI,qBAAqB,CAAC,kDAAkD,CAAC,CAAC;aACvF;YAED,KAAK,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;YAC3C,MAAM,UAAU,GAAG,gBAAgB,EAAE,CAAC;YAEtC,KAAK,CAAC,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAChD,MAAM,UAAU,GACZ,OAAO,UAAU,CAAC,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;YACrG,KAAK,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;YAEvC,MAAM,aAAa,GAAuB,EAAE,CAAC;YAC7C,aAAa,CAAC,OAAO,mCAAQ,IAAI,CAAC,eAAe,GAAK,UAAU,CAAC,cAAc,CAAE,CAAC;YAElF,IAAI,cAAc,EAAE;gBAChB,aAAa,CAAC,WAAW,GAAG,IAAI,KAAK,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;aACrE;YAED,IAAI,MAAM,GAAuB,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,qDAAqD;YAChH,QAAQ,UAAU,CAAC,MAAM,EAAE;gBACvB,KAAK,UAAU,CAAC,MAAM;oBAClB,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO;yBACtB,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC;yBACjC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAO,UAAU,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,CAAC;oBAC5F,MAAM;gBACV,KAAK,UAAU,CAAC,GAAG;oBACf,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO;yBACtB,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC;yBAC9B,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAO,UAAU,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,CAAC;oBAC5F,MAAM;gBACV,KAAK,UAAU,CAAC,IAAI;oBAChB,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO;yBACtB,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC;yBAC/B,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAO,UAAU,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,CAAC;oBAC5F,MAAM;gBACV,KAAK,UAAU,CAAC,OAAO;oBACnB,aAAa,CAAC,MAAM,GAAG,SAAS,CAAC;oBACjC,aAAa,CAAC,GAAG,GAAG,UAAU,CAAC;oBAC/B,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO;yBACtB,OAAO,CAAC,aAAa,CAAC;yBACtB,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAO,UAAU,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,CAAC;oBAC5F,MAAM;gBACV,KAAK,UAAU,CAAC,KAAK;oBACjB,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO;yBACtB,KAAK,CACF,UAAU,EACV,OAAO,UAAU,CAAC,OAAO,KAAK,QAAQ;wBAClC,CAAC,CAAC,UAAU,CAAC,OAAO;wBACpB,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,EAC1C,aAAa,CAChB;yBACA,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAO,UAAU,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,CAAC;oBAC5F,MAAM;gBACV,KAAK,UAAU,CAAC,IAAI;oBAChB,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO;yBACtB,IAAI,CACD,UAAU,EACV,OAAO,UAAU,CAAC,OAAO,KAAK,QAAQ;wBAClC,CAAC,CAAC,UAAU,CAAC,OAAO;wBACpB,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,EAC1C,aAAa,CAChB;yBACA,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAO,UAAU,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,CAAC;oBAC5F,MAAM;gBACV,KAAK,UAAU,CAAC,GAAG;oBACf,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO;yBACtB,GAAG,CACA,UAAU,EACV,OAAO,UAAU,CAAC,OAAO,KAAK,QAAQ;wBAClC,CAAC,CAAC,UAAU,CAAC,OAAO;wBACpB,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,EAC1C,aAAa,CAChB;yBACA,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAO,UAAU,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,CAAC;oBAC5F,MAAM;gBACV;oBACI,MAAM,uBAAuB,CAAC;aACrC;YAED,OAAO,MAAM,CAAC;QAClB,CAAC;KAAA;CACJ"}

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

@@ -0,0 +1,35 @@
+import { MailRequestBroadcast } from "../models/notifications/mail-request-broadcast";
+import { MailRequestById } from "../models/notifications/mail-request-by-id";
+import { MailRequestByUsername } from "../models/notifications/mail-request-by-username";
+import { RealtimeRequestBroadcast } from "../models/notifications/realtime-request-broadcast";
+import { RealtimeRequestById } from "../models/notifications/realtime-request-by-id";
+import { RealtimeRequestByUsername } from "../models/notifications/realtime-request-by-username";
+import { IExtendedContentHubClient } from "./extended-client";
+export interface INotificationsClient {
+    /**
+     * Sends a registration confirmation e-mail to the specified users by id.
+     * This action requires the 'SendConfirmationEmail' privilege.
+     * @param usernames - Usernames or ids that will receive the registration confirmation e-mail
+     */
+    sendConfirmationEmailAsync(usernames: Array<string> | Array<number>): Promise<void>;
+    /**
+     * Sends an e-mail to users by user id, username or to all users.
+     * @param mailRequest - must have type MailRequestById | MailRequestByUsername | MailRequestBroadcast
+     */
+    sendEmailNotificationAsync(mailRequest: MailRequestById | MailRequestByUsername | MailRequestBroadcast): Promise<void>;
+    /**
+     * Sends a real-time notification (browser notification) to users by user id, username or to all users.
+     * @param realtimeRequest - must have type RealtimeRequestById | RealtimeRequestByUsername | RealtimeRequestBroadcast
+     */
+    sendRealTimeNotificationAsync(realtimeRequest: RealtimeRequestById | RealtimeRequestByUsername | RealtimeRequestBroadcast): Promise<void>;
+}
+export declare class NotificationsClient implements INotificationsClient {
+    private readonly _client;
+    constructor(client: IExtendedContentHubClient);
+    sendConfirmationEmailAsync(users: Array<string> | Array<number>): Promise<void>;
+    sendEmailNotificationAsync(mailRequest: MailRequestById | MailRequestByUsername | MailRequestBroadcast): Promise<void>;
+    sendRealTimeNotificationAsync(realtimeRequest: RealtimeRequestById | RealtimeRequestByUsername | RealtimeRequestBroadcast): Promise<void>;
+    private sendPrivateEmailNotificationAsync;
+    private sendPrivateRealTimeNotificationAsync;
+    private sendNotificationAsync;
+}

package/esm/clients/notifications-client.js

@@ -0,0 +1,122 @@
+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 { NOTIFICATIONS } from "../constants";
+import Guard from "../guard";
+import { NotificationMapper } from "../mappers/notification-mapper";
+import { DistributeNotificationResource } from "../models/notifications/distribute-notification-resource";
+import { TypeGuards } from "../type-guards";
+import { ResponseHandler } from "./response-handler";
+export class NotificationsClient {
+    constructor(client) {
+        Guard.notNullOrUndefined(client);
+        this._client = client;
+    }
+    //! Not necessary for now, can be added later (lots of boilerplate)
+    // // public async getMailTemplateAsync(name: string, loadConfiguration: Nullable<IEntityLoadConfiguration> = null)
+    sendConfirmationEmailAsync(users) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let userIds = [];
+            if (TypeGuards.isStringArray(users)) {
+                userIds = (yield this._client.users.getUserIdsAsync(users));
+            }
+            else {
+                userIds = users;
+            }
+            Guard.validIds(userIds);
+            for (const userId of userIds) {
+                const link = yield this._client.linkHelper.sendConfirmationMailToLinkAsync(userId);
+                const response = yield this._client.raw.postAsync(link.href, TaJson.serialize(userId));
+                ResponseHandler.handleErrors(response);
+            }
+        });
+    }
+    sendEmailNotificationAsync(mailRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.notNullOrUndefined(mailRequest);
+            mailRequest.validate();
+            if ("recipients" in mailRequest) {
+                if (TypeGuards.isStringArray(mailRequest.recipients)) {
+                    // Usernames
+                    const mailUsernames = mailRequest;
+                    const ids = yield this._client.users.getUserIdsAsync(mailUsernames.recipients);
+                    if (ids !== null) {
+                        yield this.sendPrivateEmailNotificationAsync(mailUsernames, ids);
+                    }
+                }
+                else {
+                    // Ids
+                    const mailIds = mailRequest;
+                    yield this.sendPrivateEmailNotificationAsync(mailIds, mailIds.recipients);
+                }
+            }
+            else {
+                // Broadcast
+                yield this.sendPrivateEmailNotificationAsync(mailRequest, null);
+            }
+        });
+    }
+    sendRealTimeNotificationAsync(realtimeRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.notNull(realtimeRequest);
+            realtimeRequest.validate();
+            if ("recipients" in realtimeRequest) {
+                if (TypeGuards.isStringArray(realtimeRequest.recipients)) {
+                    // Usernames
+                    const realtimeUsers = realtimeRequest;
+                    const ids = yield this._client.users.getUserIdsAsync(realtimeUsers.recipients);
+                    if (ids !== null) {
+                        yield this.sendPrivateRealTimeNotificationAsync(realtimeRequest, ids);
+                    }
+                }
+                else {
+                    // Ids
+                    const realtimeIds = realtimeRequest;
+                    yield this.sendPrivateRealTimeNotificationAsync(realtimeIds, realtimeIds.recipients);
+                }
+            }
+            else {
+                // Broadcast
+                yield this.sendPrivateRealTimeNotificationAsync(realtimeRequest, null);
+            }
+        });
+    }
+    //#region Private functions
+    sendPrivateEmailNotificationAsync(mailRequest, recipients) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.sendNotificationAsync(mailRequest.mailTemplateName, recipients, "EmailNotification", mailRequest.variables);
+        });
+    }
+    sendPrivateRealTimeNotificationAsync(realtimeRequest, recipients) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const parameters = NotificationMapper.mapParameters(realtimeRequest);
+            return this.sendNotificationAsync(NOTIFICATIONS.REALTIME.raw, recipients, "RealTimeNotification", parameters);
+        });
+    }
+    sendNotificationAsync(notificationName, recipients, channel, parameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const link = yield this._client.linkHelper.sendNotificationToLinkAsync(notificationName);
+            // Get user links.
+            let userLinks = null;
+            const linkPromises = recipients === null || recipients === void 0 ? void 0 : recipients.map(id => this._client.linkHelper.entityToLinkAsync(id));
+            if (linkPromises != null) {
+                userLinks = yield Promise.all(linkPromises);
+            }
+            // Create the resource.
+            const resource = new DistributeNotificationResource();
+            resource.recipients = userLinks;
+            resource.channels = [channel];
+            resource.parameters = parameters;
+            const response = yield this._client.raw.postAsync(link.href, TaJson.serialize(resource));
+            ResponseHandler.handleErrors(response);
+        });
+    }
+}
+//# sourceMappingURL=notifications-client.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"notifications-client.js","sourceRoot":"","sources":["../../src/clients/notifications-client.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAGjC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,KAAK,MAAM,UAAU,CAAC;AAE7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,8BAA8B,EAAE,MAAM,0DAA0D,CAAC;AAS1G,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AA2BrD,MAAM,OAAO,mBAAmB;IAG5B,YAAY,MAAiC;QACzC,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAED,mEAAmE;IACnE,mHAAmH;IAE7G,0BAA0B,CAAC,KAAoC;;YACjE,IAAI,OAAO,GAAkB,EAAE,CAAC;YAEhC,IAAI,UAAU,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE;gBACjC,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,CAAkB,CAAC;aAChF;iBAAM;gBACH,OAAO,GAAG,KAAK,CAAC;aACnB;YACD,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAExB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;gBAC1B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,+BAA+B,CAAC,MAAM,CAAC,CAAC;gBACnF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;gBAEvF,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aAC1C;QACL,CAAC;KAAA;IAEK,0BAA0B,CAC5B,WAA2E;;YAE3E,KAAK,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;YAEtC,WAAW,CAAC,QAAQ,EAAE,CAAC;YAEvB,IAAI,YAAY,IAAI,WAAW,EAAE;gBAC7B,IAAI,UAAU,CAAC,aAAa,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE;oBAClD,YAAY;oBACZ,MAAM,aAAa,GAAG,WAAoC,CAAC;oBAE3D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;oBAC/E,IAAI,GAAG,KAAK,IAAI,EAAE;wBACd,MAAM,IAAI,CAAC,iCAAiC,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;qBACpE;iBACJ;qBAAM;oBACH,MAAM;oBACN,MAAM,OAAO,GAAG,WAA8B,CAAC;oBAC/C,MAAM,IAAI,CAAC,iCAAiC,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;iBAC7E;aACJ;iBAAM;gBACH,YAAY;gBACZ,MAAM,IAAI,CAAC,iCAAiC,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;aACnE;QACL,CAAC;KAAA;IAEK,6BAA6B,CAC/B,eAA2F;;YAE3F,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;YAE/B,eAAe,CAAC,QAAQ,EAAE,CAAC;YAE3B,IAAI,YAAY,IAAI,eAAe,EAAE;gBACjC,IAAI,UAAU,CAAC,aAAa,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE;oBACtD,YAAY;oBACZ,MAAM,aAAa,GAAG,eAA4C,CAAC;oBACnE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;oBAC/E,IAAI,GAAG,KAAK,IAAI,EAAE;wBACd,MAAM,IAAI,CAAC,oCAAoC,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;qBACzE;iBACJ;qBAAM;oBACH,MAAM;oBACN,MAAM,WAAW,GAAG,eAAsC,CAAC;oBAC3D,MAAM,IAAI,CAAC,oCAAoC,CAAC,WAAW,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;iBACxF;aACJ;iBAAM;gBACH,YAAY;gBACZ,MAAM,IAAI,CAAC,oCAAoC,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;aAC1E;QACL,CAAC;KAAA;IAED,2BAA2B;IAEb,iCAAiC,CAC3C,WAAwB,EACxB,UAAmC;;YAEnC,OAAO,IAAI,CAAC,qBAAqB,CAC7B,WAAW,CAAC,gBAAgB,EAC5B,UAAU,EACV,mBAAmB,EACnB,WAAW,CAAC,SAAS,CACxB,CAAC;QACN,CAAC;KAAA;IAEa,oCAAoC,CAC9C,eAAgC,EAChC,UAAmC;;YAEnC,MAAM,UAAU,GAAG,kBAAkB,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;YAErE,OAAO,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,EAAE,UAAU,EAAE,sBAAsB,EAAE,UAAU,CAAC,CAAC;QAClH,CAAC;KAAA;IAEa,qBAAqB,CAC/B,gBAAwB,EACxB,UAAmC,EACnC,OAAe,EACf,UAA0B;;YAE1B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC,gBAAgB,CAAC,CAAC;YAEzF,kBAAkB;YAClB,IAAI,SAAS,GAA0B,IAAI,CAAC;YAC5C,MAAM,YAAY,GAAG,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;YAC1F,IAAI,YAAY,IAAI,IAAI,EAAE;gBACtB,SAAS,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;aAC/C;YAED,uBAAuB;YACvB,MAAM,QAAQ,GAAG,IAAI,8BAA8B,EAAE,CAAC;YACtD,QAAQ,CAAC,UAAU,GAAG,SAAS,CAAC;YAChC,QAAQ,CAAC,QAAQ,GAAG,CAAC,OAAO,CAAC,CAAC;YAC9B,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC;YAEjC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;YAEzF,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC;KAAA;CAGJ"}

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

@@ -0,0 +1,57 @@
+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(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(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
+     * @param cacheSignature - Signature of the cached resources for controlling browser caching
+     */
+    getAsync(name: string, cancelCallback?: CancelCallback, cacheSignature?: string): 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, 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, 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, cancelCallback?: CancelCallback): Promise<void>;
+}
+export declare class OptionListClient implements IOptionListClient {
+    private readonly _client;
+    private readonly _mapper;
+    constructor(client: IExtendedContentHubClient);
+    getAllNamesAsync(cancelCallback?: CancelCallback): Promise<Array<string>>;
+    getAllDescriptionsAsync(cancelCallback?: CancelCallback): Promise<Array<OptionListDescriptionResource>>;
+    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/esm/clients/option-list-client.js

@@ -0,0 +1,84 @@
+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 URI from "urijs";
+import Guard from "../guard";
+import { OptionListMapper } from "../mappers/option-list-mapper";
+import OptionListCollectionResource from "../models/option-lists/option-list-collection-resource";
+import OptionListResource from "../models/option-lists/option-list-resource";
+import { ResponseHandler } from "./response-handler";
+export class OptionListClient {
+    constructor(client) {
+        this._client = client;
+        this._mapper = new OptionListMapper(client);
+    }
+    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, undefined, cancelCallback);
+            const resource = TaJson.deserialize(response.content, OptionListCollectionResource);
+            const names = resource.items.map(item => item.name);
+            return names;
+        });
+    }
+    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, undefined, cancelCallback);
+            const resource = TaJson.deserialize(response.content, OptionListCollectionResource);
+            return resource.items;
+        });
+    }
+    getAsync(name, cancelCallback, cacheSignature) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.stringNotNullOrEmpty(name);
+            const link = yield this._client.linkHelper.dataSourceToLinkAsync(name);
+            const uri = new URI(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;
+            }
+            ResponseHandler.handleErrors(response);
+            const resource = TaJson.deserialize(response.content, OptionListResource);
+            return this._mapper.mapOptionListAsync(resource);
+        });
+    }
+    createAsync(optionList, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.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, TaJson.serialize(resource), undefined, cancelCallback);
+            ResponseHandler.handleErrors(response);
+        });
+    }
+    updateAsync(optionList, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.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, TaJson.serialize(resource), undefined, cancelCallback);
+            ResponseHandler.handleErrors(response);
+        });
+    }
+    deleteAsync(name, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.stringNotNullOrEmpty(name);
+            const link = yield this._client.linkHelper.dataSourceToLinkAsync(name);
+            const response = yield this._client.raw.deleteAsync(link.href, undefined, cancelCallback);
+            ResponseHandler.handleErrors(response);
+        });
+    }
+}
+//# sourceMappingURL=option-list-client.js.map

package/esm/clients/option-list-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"option-list-client.js","sourceRoot":"","sources":["../../src/clients/option-list-client.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,GAAG,MAAM,OAAO,CAAC;AAIxB,OAAO,KAAK,MAAM,UAAU,CAAC;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,4BAA4B,MAAM,wDAAwD,CAAC;AAElG,OAAO,kBAAkB,MAAM,6CAA6C,CAAC;AAG7E,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAqDrD,MAAM,OAAO,gBAAgB;IAIzB,YAAY,MAAiC;QACzC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAEK,gBAAgB,CAAC,cAA+B;;YAClD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC;YAClE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;YACvF,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAC/B,QAAQ,CAAC,OAAO,EAChB,4BAA4B,CAC/B,CAAC;YACF,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpD,OAAO,KAAK,CAAC;QACjB,CAAC;KAAA;IAEK,uBAAuB,CAAC,cAA+B;;YACzD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC;YAClE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;YACvF,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAC/B,QAAQ,CAAC,OAAO,EAChB,4BAA4B,CAC/B,CAAC;YAEF,OAAO,QAAQ,CAAC,KAAK,CAAC;QAC1B,CAAC;KAAA;IAEK,QAAQ,CACV,IAAY,EACZ,cAA+B,EAC/B,cAAuB;;YAEvB,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;YAEjC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;YACvE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAE/B,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,cAAc,EAAE;gBAC1C,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;gBAEtC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;aAC9B;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;YAEvF,IAAI,QAAQ,CAAC,UAAU,KAAK,GAAG,EAAE;gBAC7B,OAAO,IAAI,CAAC;aACf;YAED,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAEvC,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAqB,QAAQ,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;YAE9F,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACrD,CAAC;KAAA;IAEK,WAAW,CAAC,UAAuB,EAAE,cAA+B;;YACtE,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;YAExC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC;YAClE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAC7C,IAAI,CAAC,IAAI,EACT,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,EAC1B,SAAS,EACT,cAAc,CACjB,CAAC;YAEF,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC;KAAA;IAEK,WAAW,CAAC,UAAuB,EAAE,cAA+B;;YACtE,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;YAExC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YAClF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAC5C,IAAI,CAAC,IAAI,EACT,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,EAC1B,SAAS,EACT,cAAc,CACjB,CAAC;YAEF,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC;KAAA;IAEK,WAAW,CAAC,IAAY,EAAE,cAA+B;;YAC3D,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;YAEjC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;YACvE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;YAE1F,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC;KAAA;CACJ"}

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

@@ -0,0 +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, 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, 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, entityId?: number, cancelCallback?: CancelCallback): Promise<PageResource>;
+}
+export declare class PagesClient implements IPagesClient {
+    private readonly _client;
+    constructor(client: IExtendedContentHubClient);
+    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>;
+}