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

package/esm/base-types.d.ts

@@ -0,0 +1,59 @@
+import CultureInfo from "./culture-info";
+export interface MapStringTo<T> {
+    [key: string]: T;
+}
+export declare class CaseInsensitiveStringMap<T> implements MapStringTo<T> {
+    [key: string]: T;
+    constructor(map?: MapStringTo<T>);
+}
+export interface MapNumberTo<T> {
+    [key: number]: T;
+}
+/**
+ * Generic type to map cultures to values of a specified type.
+ */
+export declare type MapCultureTo<T> = {
+    [key in CultureInfo]?: T;
+};
+export declare type NullableResultPromise<T> = Promise<T | null>;
+export declare type OptionalResultPromise<T> = Promise<T | undefined>;
+export declare type Nullable<T> = T | null;
+export declare type Optional<T> = T | undefined;
+export declare type UnionKeyToValue<U extends string> = {
+    [K in U]: K;
+};
+export declare type FromStringIndexTo<K extends string, V> = {
+    [key in K]?: V;
+};
+export declare type OptionalPropertyOf<T> = Exclude<{
+    [K in keyof T]: T extends Record<K, T[K]> ? never : K;
+}[keyof T], undefined>;
+declare type KeysWithoutType<T, K> = {
+    [P in keyof T]: Exclude<T[P], undefined> extends K ? never : P;
+}[keyof T];
+/**
+ * A type based on type T without properties of type K.
+ */
+export declare type OmitType<T, K> = Pick<T, KeysWithoutType<T, K>>;
+export interface KeyValuePair<T, K> {
+    key: T;
+    value: K;
+}
+export declare type Equals<X, Y, A, B> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? A : B;
+export declare type WritableKeysOf<T> = {
+    [P in keyof T]: Equals<{
+        [Q in P]: T[P];
+    }, {
+        -readonly [Q in P]: T[P];
+    }, P, never>;
+}[keyof T];
+export declare type WritablePart<T> = Pick<T, WritableKeysOf<T>>;
+export declare type JsonArray = Array<JsonValue>;
+export declare type JsonObject = {
+    [key: string]: JsonValue;
+};
+export declare type JsonValue = string | number | boolean | JsonObject | JsonArray | null;
+export declare type Object_Unknown = Record<string, unknown>;
+export declare type EmptyObject = Omit<Record<any, never>, keyof any>;
+export declare type ReadableUploadSource = ArrayBuffer;
+export {};

package/esm/base-types.js

@@ -0,0 +1,38 @@
+export class CaseInsensitiveStringMap {
+    constructor(map) {
+        if (map && typeof map === "object") {
+            Object.assign(this, Object.keys(map).reduce((obj, key) => {
+                obj[key.toLowerCase()] = map[key];
+                return obj;
+            }, {}));
+        }
+        return new Proxy(this, {
+            set: (obj, prop, value) => {
+                if (typeof prop === "string") {
+                    return Reflect.set(obj, prop.toLowerCase(), value);
+                }
+                else {
+                    return Reflect.set(obj, prop, value);
+                }
+            },
+            get: (obj, prop) => {
+                if (typeof prop === "string") {
+                    return Reflect.get(obj, prop.toLowerCase());
+                }
+                else {
+                    return Reflect.get(obj, prop);
+                }
+            },
+            has: (obj, prop) => {
+                if (typeof prop === "string") {
+                    return Reflect.has(obj, prop.toLowerCase());
+                }
+                return Reflect.has(obj, prop);
+            },
+            ownKeys(obj) {
+                return Reflect.ownKeys(obj);
+            }
+        });
+    }
+}
+//# sourceMappingURL=base-types.js.map

package/esm/base-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-types.js","sourceRoot":"","sources":["../src/base-types.ts"],"names":[],"mappings":"AAMA,MAAM,OAAO,wBAAwB;IAGjC,YAAY,GAAoB;QAC5B,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAChC,MAAM,CAAC,MAAM,CACT,IAAI,EACJ,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,GAAmB,EAAE,GAAW,EAAE,EAAE;gBACzD,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;gBAClC,OAAO,GAAG,CAAC;YACf,CAAC,EAAE,EAAE,CAAC,CACT,CAAC;SACL;QAED,OAAO,IAAI,KAAK,CAAC,IAAI,EAAE;YACnB,GAAG,EAAE,CAAC,GAAgC,EAAE,IAAY,EAAE,KAAc,EAAE,EAAE;gBACpE,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;oBAC1B,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,KAAK,CAAC,CAAC;iBACtD;qBAAM;oBACH,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;iBACxC;YACL,CAAC;YACD,GAAG,EAAE,CAAC,GAAgC,EAAE,IAAY,EAAE,EAAE;gBACpD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;oBAC1B,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;iBAC/C;qBAAM;oBACH,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;iBACjC;YACL,CAAC;YACD,GAAG,EAAE,CAAC,GAAgC,EAAE,IAAY,EAAW,EAAE;gBAC7D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;oBAC1B,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;iBAC/C;gBAED,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAClC,CAAC;YACD,OAAO,CAAC,GAAG;gBACP,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAChC,CAAC;SACJ,CAAC,CAAC;IACP,CAAC;CACJ"}

package/esm/caches/culture-cache.d.ts

@@ -0,0 +1,8 @@
+import { Nullable } from "../base-types";
+import CultureInfo from "../culture-info";
+export declare class CultureCache {
+    private _map;
+    private _cacheKey;
+    loadCache(cultures: Array<CultureInfo>): void;
+    getCachedCultures(): Nullable<Array<CultureInfo>>;
+}

package/esm/caches/culture-cache.js

@@ -0,0 +1,15 @@
+import Guard from "../guard";
+export class CultureCache {
+    constructor() {
+        this._map = new Map();
+        this._cacheKey = "cultures";
+    }
+    loadCache(cultures) {
+        Guard.notNullOrUndefined(cultures);
+        this._map.set(this._cacheKey, cultures);
+    }
+    getCachedCultures() {
+        return this._map.get(this._cacheKey) || null;
+    }
+}
+//# sourceMappingURL=culture-cache.js.map

package/esm/caches/culture-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"culture-cache.js","sourceRoot":"","sources":["../../src/caches/culture-cache.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,MAAM,UAAU,CAAC;AAE7B,MAAM,OAAO,YAAY;IAAzB;QACY,SAAI,GAAoC,IAAI,GAAG,EAAE,CAAC;QAClD,cAAS,GAAG,UAAU,CAAC;IAWnC,CAAC;IATG,SAAS,CAAC,QAA4B;QAClC,KAAK,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAEnC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED,iBAAiB;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC;IACjD,CAAC;CACJ"}

package/esm/caches/entity-definition-cache.d.ts

@@ -0,0 +1,72 @@
+import { Nullable, NullableResultPromise } from "../base-types";
+import { IEntityDefinition } from "../contracts/base";
+import { ViewMode } from "../contracts/base/view-mode";
+/**
+ * Caches definition in memory.
+ */
+export declare class EntityDefinitionCache {
+    private readonly _allCacheKey;
+    private readonly _promiseKeyPrefix;
+    private readonly _map;
+    constructor();
+    /**
+     * Load the specified definition into the cache.
+     * @param definition - The entity definition
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definition
+     */
+    load(definition: IEntityDefinition, includeConditionalMembers?: boolean, loadPermissions?: boolean): void;
+    /**
+     * Load the specified definition into the cache asynchronously.
+     * @param key - The definition name or definition id
+     * @param promise - A promise resolving to the definition
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definition
+     */
+    loadAsync(key: string | number, promise: NullableResultPromise<IEntityDefinition>, includeConditionalMembers?: boolean, loadPermissions?: boolean): Promise<void>;
+    /**
+     * Retrieve the definition with specified name or id from the cache.
+     * @param key - The definition name or definition id
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definition
+     * @returns The cached definition or null
+     */
+    get(key: string | number, includeConditionalMembers?: boolean, loadPermissions?: boolean): Nullable<IEntityDefinition>;
+    /**
+     * Retrieve the definition with specified name or id from the cache asynchronously.
+     * @param key - The definition name or definition id
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definition
+     * @returns A promise resolving to the cached definition or null
+     */
+    getAsync(key: string | number, includeConditionalMembers?: boolean, loadPermissions?: boolean): Nullable<NullableResultPromise<IEntityDefinition>>;
+    /**
+     * Loads all definitions into the cache.
+     * @param definitions - An array of entity definitions
+     * @param loadAllIndividually - Flag indicating whether to load the definitions individually or not
+     * @param loadAsGroup - Key to be used to store the array of definitions, or false to not load the array
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definitions
+     */
+    loadAll(definitions: Array<IEntityDefinition>, loadAllIndividually?: boolean, loadAsGroup?: false | string, includeConditionalMembers?: boolean, loadPermissions?: boolean, viewMode?: ViewMode, excludeTaxonomyDefinitions?: boolean, excludeSystemOwnedDefinitions?: boolean, filter?: string, definitionsToLoadByName?: string, definitionsToLoadById?: string): void;
+    /**
+     * Retrieves an array of definitions that was cached with the specified group key.
+     *
+     * @remarks
+     * Can not be used to retrieve a single cached definition. Use {@link EntityDefinitionCache.get} instead.
+     *
+     * @param group - The key with which the group of definitions was stored
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definitions
+     */
+    getAll(group?: string, includeConditionalMembers?: boolean, loadPermissions?: boolean, viewMode?: ViewMode, excludeTaxonomyDefinitions?: boolean, excludeSystemOwnedDefinitions?: boolean, filter?: string, definitionsToLoadByName?: string, definitionsToLoadById?: string): Nullable<Array<IEntityDefinition>>;
+    /**
+     * Invalidates/removes the definition with specified name or id from the cache.
+     * @param key - The definition name or definition id
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definition
+     */
+    invalidate(key?: string | number, includeConditionalMembers?: boolean, loadPermissions?: boolean): void;
+    private validateKey;
+    private getCacheKey;
+}

package/esm/caches/entity-definition-cache.js

@@ -0,0 +1,174 @@
+import Guard from "../guard";
+/**
+ * Caches definition in memory.
+ */
+export class EntityDefinitionCache {
+    constructor() {
+        this._allCacheKey = "__ALL__";
+        this._promiseKeyPrefix = "PROMISE__";
+        this._map = new Map();
+        this._map = new Map();
+    }
+    /**
+     * Load the specified definition into the cache.
+     * @param definition - The entity definition
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definition
+     */
+    load(definition, includeConditionalMembers, loadPermissions) {
+        Guard.notNullOrUndefined(definition, "definition");
+        Guard.notNullOrUndefined(definition.id, "definition id");
+        this._map.set(this.getCacheKey(definition.name, { includeConditionalMembers, loadPermissions }), definition);
+        this._map.set(this.getCacheKey(definition.id.toString(), { includeConditionalMembers, loadPermissions }), definition);
+    }
+    /**
+     * Load the specified definition into the cache asynchronously.
+     * @param key - The definition name or definition id
+     * @param promise - A promise resolving to the definition
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definition
+     */
+    loadAsync(key, promise, includeConditionalMembers, loadPermissions) {
+        this.validateKey(key);
+        Guard.notNullOrUndefined(promise);
+        this._map.set(`${this._promiseKeyPrefix}${this.getCacheKey(key.toString(), {
+            includeConditionalMembers,
+            loadPermissions,
+        })}`, promise);
+        const loadPromise = promise.then(definition => {
+            if (definition) {
+                this.load(definition);
+            }
+        });
+        return loadPromise;
+    }
+    /**
+     * Retrieve the definition with specified name or id from the cache.
+     * @param key - The definition name or definition id
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definition
+     * @returns The cached definition or null
+     */
+    get(key, includeConditionalMembers, loadPermissions) {
+        this.validateKey(key);
+        const res = this._map.get(this.getCacheKey(key.toString(), { includeConditionalMembers, loadPermissions })) || null;
+        return res;
+    }
+    /**
+     * Retrieve the definition with specified name or id from the cache asynchronously.
+     * @param key - The definition name or definition id
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definition
+     * @returns A promise resolving to the cached definition or null
+     */
+    getAsync(key, includeConditionalMembers, loadPermissions) {
+        this.validateKey(key);
+        const promise = (this._map.get(`${this._promiseKeyPrefix}${this.getCacheKey(key.toString(), {
+            includeConditionalMembers,
+            loadPermissions,
+        })}`) || null);
+        if (promise != null) {
+            return promise;
+        }
+        const definition = (this.get(this.getCacheKey(key.toString(), { includeConditionalMembers, loadPermissions })) || null);
+        if (definition != null) {
+            return Promise.resolve(definition);
+        }
+        return null;
+    }
+    /**
+     * Loads all definitions into the cache.
+     * @param definitions - An array of entity definitions
+     * @param loadAllIndividually - Flag indicating whether to load the definitions individually or not
+     * @param loadAsGroup - Key to be used to store the array of definitions, or false to not load the array
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definitions
+     */
+    loadAll(definitions, loadAllIndividually = true, loadAsGroup = this._allCacheKey, includeConditionalMembers, loadPermissions, viewMode, excludeTaxonomyDefinitions, excludeSystemOwnedDefinitions, filter, definitionsToLoadByName, definitionsToLoadById) {
+        Guard.notNullOrUndefined(definitions);
+        if (definitions.length === 0) {
+            return;
+        }
+        if (loadAsGroup) {
+            Guard.stringNotNullOrEmpty(loadAsGroup);
+            this._map.set(this.getCacheKey(loadAsGroup, {
+                filter,
+                definitionsToLoadByName,
+                definitionsToLoadById,
+                viewMode,
+                loadPermissions,
+                includeConditionalMembers,
+                excludeTaxonomyDefinitions,
+                excludeSystemOwnedDefinitions,
+            }), definitions);
+        }
+        if (loadAllIndividually) {
+            definitions.forEach(definition => this.load(definition, includeConditionalMembers, loadPermissions), this);
+        }
+    }
+    /**
+     * Retrieves an array of definitions that was cached with the specified group key.
+     *
+     * @remarks
+     * Can not be used to retrieve a single cached definition. Use {@link EntityDefinitionCache.get} instead.
+     *
+     * @param group - The key with which the group of definitions was stored
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definitions
+     */
+    getAll(group = this._allCacheKey, includeConditionalMembers, loadPermissions, viewMode, excludeTaxonomyDefinitions, excludeSystemOwnedDefinitions, filter, definitionsToLoadByName, definitionsToLoadById) {
+        const res = this._map.get(this.getCacheKey(group, {
+            filter,
+            definitionsToLoadByName,
+            definitionsToLoadById,
+            viewMode,
+            loadPermissions,
+            includeConditionalMembers,
+            excludeTaxonomyDefinitions,
+            excludeSystemOwnedDefinitions,
+        })) || null;
+        return res instanceof Array ? res : null;
+    }
+    /**
+     * Invalidates/removes the definition with specified name or id from the cache.
+     * @param key - The definition name or definition id
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definition
+     */
+    invalidate(key, includeConditionalMembers, loadPermissions) {
+        if (!key) {
+            this._map.clear();
+            return;
+        }
+        this.validateKey(key);
+        const definition = this.get(key);
+        if (!definition)
+            return;
+        this._map.delete(this.getCacheKey(definition.name, { includeConditionalMembers, loadPermissions }));
+        this._map.delete(this.getCacheKey(definition.id.toString(), { includeConditionalMembers, loadPermissions }));
+    }
+    validateKey(key) {
+        if (typeof key === "string") {
+            Guard.stringNotNullOrEmpty(key);
+        }
+        else {
+            Guard.validId(key);
+        }
+    }
+    getCacheKey(key, { filter, definitionsToLoadByName, definitionsToLoadById, viewMode, loadPermissions, includeConditionalMembers, excludeTaxonomyDefinitions, excludeSystemOwnedDefinitions, }) {
+        return [
+            key.trim().toLowerCase(),
+            includeConditionalMembers && "conditionals",
+            loadPermissions && "permissions",
+            viewMode,
+            excludeTaxonomyDefinitions && "excludeTaxonomyDefinitions",
+            excludeSystemOwnedDefinitions && "excludeSystemOwnedDefinitions",
+            filter,
+            definitionsToLoadByName,
+            definitionsToLoadById,
+        ]
+            .filter(Boolean)
+            .join("-");
+    }
+}
+//# sourceMappingURL=entity-definition-cache.js.map

package/esm/caches/entity-definition-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-definition-cache.js","sourceRoot":"","sources":["../../src/caches/entity-definition-cache.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,MAAM,UAAU,CAAC;AAE7B;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAQ9B;QAPiB,iBAAY,GAAG,SAAS,CAAC;QACzB,sBAAiB,GAAG,WAAW,CAAC;QAChC,SAAI,GAGjB,IAAI,GAAG,EAAE,CAAC;QAGV,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,UAA6B,EAAE,yBAAmC,EAAE,eAAyB;QAC9F,KAAK,CAAC,kBAAkB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QACnD,KAAK,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,EAAE,eAAe,CAAC,CAAC;QAEzD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,yBAAyB,EAAE,eAAe,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;QAC7G,IAAI,CAAC,IAAI,CAAC,GAAG,CACT,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,yBAAyB,EAAE,eAAe,EAAE,CAAC,EAC3F,UAAU,CACb,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACH,SAAS,CACL,GAAoB,EACpB,OAAiD,EACjD,yBAAmC,EACnC,eAAyB;QAEzB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACtB,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAElC,IAAI,CAAC,IAAI,CAAC,GAAG,CACT,GAAG,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;YACzD,yBAAyB;YACzB,eAAe;SAClB,CAAC,EAAE,EACJ,OAAO,CACV,CAAC;QAEF,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YAC1C,IAAI,UAAU,EAAE;gBACZ,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aACzB;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CACC,GAAoB,EACpB,yBAAmC,EACnC,eAAyB;QAEzB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAEtB,MAAM,GAAG,GACL,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,yBAAyB,EAAE,eAAe,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC;QAC5G,OAAO,GAAkC,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CACJ,GAAoB,EACpB,yBAAmC,EACnC,eAAyB;QAEzB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAEtB,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAC1B,GAAG,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;YACzD,yBAAyB;YACzB,eAAe;SAClB,CAAC,EAAE,CACP,IAAI,IAAI,CAAuD,CAAC;QAEjE,IAAI,OAAO,IAAI,IAAI,EAAE;YACjB,OAAO,OAAO,CAAC;SAClB;QAED,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,GAAG,CACxB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,yBAAyB,EAAE,eAAe,EAAE,CAAC,CACnF,IAAI,IAAI,CAAgC,CAAC;QAE1C,IAAI,UAAU,IAAI,IAAI,EAAE;YACpB,OAAO,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;SACtC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CACH,WAAqC,EACrC,sBAA+B,IAAI,EACnC,cAA8B,IAAI,CAAC,YAAY,EAC/C,yBAAmC,EACnC,eAAyB,EACzB,QAAmB,EACnB,0BAAoC,EACpC,6BAAuC,EACvC,MAAe,EACf,uBAAgC,EAChC,qBAA8B;QAE9B,KAAK,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAEtC,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;YAC1B,OAAO;SACV;QAED,IAAI,WAAW,EAAE;YACb,KAAK,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;YACxC,IAAI,CAAC,IAAI,CAAC,GAAG,CACT,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;gBAC1B,MAAM;gBACN,uBAAuB;gBACvB,qBAAqB;gBACrB,QAAQ;gBACR,eAAe;gBACf,yBAAyB;gBACzB,0BAA0B;gBAC1B,6BAA6B;aAChC,CAAC,EACF,WAAW,CACd,CAAC;SACL;QAED,IAAI,mBAAmB,EAAE;YACrB,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,yBAAyB,EAAE,eAAe,CAAC,EAAE,IAAI,CAAC,CAAC;SAC9G;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACF,QAAgB,IAAI,CAAC,YAAY,EACjC,yBAAmC,EACnC,eAAyB,EACzB,QAAmB,EACnB,0BAAoC,EACpC,6BAAuC,EACvC,MAAe,EACf,uBAAgC,EAChC,qBAA8B;QAE9B,MAAM,GAAG,GACL,IAAI,CAAC,IAAI,CAAC,GAAG,CACT,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE;YACpB,MAAM;YACN,uBAAuB;YACvB,qBAAqB;YACrB,QAAQ;YACR,eAAe;YACf,yBAAyB;YACzB,0BAA0B;YAC1B,6BAA6B;SAChC,CAAC,CACL,IAAI,IAAI,CAAC;QAEd,OAAO,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,GAAqB,EAAE,yBAAmC,EAAE,eAAyB;QAC5F,IAAI,CAAC,GAAG,EAAE;YACN,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAClB,OAAO;SACV;QAED,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAEtB,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,CAAC,UAAU;YAAE,OAAO;QAExB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,yBAAyB,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC;QACpG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,yBAAyB,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC;IAClH,CAAC;IAEO,WAAW,CAAC,GAAoB;QACpC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YACzB,KAAK,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;SACnC;aAAM;YACH,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;SACtB;IACL,CAAC;IAEO,WAAW,CACf,GAAW,EACX,EACI,MAAM,EACN,uBAAuB,EACvB,qBAAqB,EACrB,QAAQ,EACR,eAAe,EACf,yBAAyB,EACzB,0BAA0B,EAC1B,6BAA6B,GAUhC;QAED,OAAO;YACH,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE;YACxB,yBAAyB,IAAI,cAAc;YAC3C,eAAe,IAAI,aAAa;YAChC,QAAQ;YACR,0BAA0B,IAAI,4BAA4B;YAC1D,6BAA6B,IAAI,+BAA+B;YAChE,MAAM;YACN,uBAAuB;YACvB,qBAAqB;SACxB;aACI,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC;CACJ"}

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

@@ -0,0 +1,43 @@
+import CultureInfo from "../culture-info";
+import { AggregateResource } from "../models/aggregate-resources/aggregate-resource";
+import { IExtendedContentHubClient } from "./extended-client";
+import { CancelCallback } from "./internal-client";
+export interface AggregateLoadOption {
+    /**
+     *  Flag for loading option lists. Defaults to true.
+     */
+    loadOptionLists?: boolean;
+    /**
+     * Flag for loading settings. Defaults to true.
+     */
+    loadSettings?: boolean;
+    /**
+     * Flag for loading definitions. Defaults to true.
+     */
+    loadDefinitions?: boolean;
+    /**
+     * Flag for loading entities. Defaults to true.
+     */
+    loadEntities?: boolean;
+    /**
+     * Flag for loading permissions. If not defined, will not be added to the query.
+     */
+    loadPermissions?: boolean;
+}
+export interface IAggregateClient {
+    /**
+     * Method for getting the specified aggregate for the specified entity.
+     * @param name - The name of the aggregate
+     * @param id - The entity id to get the aggregate for
+     * @param culture - The user culture
+     * @param loadOptions - Can optionally configure what needs to be loaded from the aggregates (everything will be loaded by default except for permissions)
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
+     * @returns An aggregate resource
+     */
+    getAsync(name: string, id: number, culture?: CultureInfo, loadOptions?: AggregateLoadOption, cancelCallback?: CancelCallback): Promise<AggregateResource>;
+}
+export declare class AggregateClient implements IAggregateClient {
+    private readonly _client;
+    constructor(client: IExtendedContentHubClient);
+    getAsync(name: string, id: number, culture?: CultureInfo, loadOptions?: AggregateLoadOption, cancelCallback?: CancelCallback): Promise<AggregateResource>;
+}

package/esm/clients/aggregates-client.js

@@ -0,0 +1,29 @@
+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 { AggregateResource } from "../models/aggregate-resources/aggregate-resource";
+import { ResponseHandler } from "./response-handler";
+export class AggregateClient {
+    constructor(client) {
+        Guard.notNull(client);
+        this._client = client;
+    }
+    getAsync(name, id, culture, loadOptions = {}, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.stringNotNullOrEmpty(name);
+            const link = yield this._client.linkHelper.aggregateToLinkAsync(name, id, culture, loadOptions);
+            const response = yield this._client.raw.getAsync(link.href, undefined, cancelCallback);
+            ResponseHandler.handleErrors(response);
+            return TaJson.deserialize(response.content, AggregateResource);
+        });
+    }
+}
+//# sourceMappingURL=aggregates-client.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"aggregates-client.js","sourceRoot":"","sources":["../../src/clients/aggregates-client.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAGjC,OAAO,KAAK,MAAM,UAAU,CAAC;AAC7B,OAAO,EAAE,iBAAiB,EAAE,MAAM,kDAAkD,CAAC;AAGrF,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAgDrD,MAAM,OAAO,eAAe;IAGxB,YAAY,MAAiC;QACzC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEtB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAEK,QAAQ,CACV,IAAY,EACZ,EAAU,EACV,OAAqB,EACrB,cAAmC,EAAE,EACrC,cAA+B;;YAE/B,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;YAEjC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;YAEhG,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,CAAoB,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;QACtF,CAAC;KAAA;CACJ"}

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

@@ -0,0 +1,55 @@
+import { IApiInfo } from "../api/api-info";
+import { ApiRoutesDictionary } from "../api/api-routes-dictionary";
+import { MapStringTo } from "../base-types";
+import Link from "../link";
+import { IExtendedContentHubClient } from "./extended-client";
+/**
+ * Contains functionality to get REST API information.
+ * It will also check for compatibility with the server REST API.
+ */
+export interface IApiClient {
+    /**
+     * Gets or sets whether compatibility checks should be disabled.
+     *
+     * @remarks
+     * The value is shared across all {@link IExtendedContentHubClient} instances.
+     */
+    disableCompatibilityChecks: boolean;
+    /**
+     * Gets the REST API information. The result will be cached.
+     *
+     * @returns The API information.
+     */
+    getApiInfoAsync(): Promise<IApiInfo>;
+    /**
+     * Gets the REST API routes. The result will be cached.
+     *
+     * @returns The REST API routes.
+     */
+    getApiRoutesAsync(): Promise<ApiRoutesDictionary>;
+    /**
+     * Forces a refresh of the cached REST API information.
+     */
+    refreshAsync(): Promise<void>;
+}
+export declare class ApiClient implements IApiClient {
+    private readonly _client;
+    private _api;
+    private static _disableCompatibilityChecks;
+    get disableCompatibilityChecks(): boolean;
+    set disableCompatibilityChecks(value: boolean);
+    constructor(client: IExtendedContentHubClient);
+    getApiInfoAsync(): Promise<IApiInfo>;
+    getApiRoutesAsync(): Promise<MapStringTo<Link>>;
+    refreshAsync(): Promise<void>;
+    /**
+     * Load the REST API information if absent.
+     */
+    private loadAsync;
+    /**
+     * Fetches the API information and checks if the server is running a compatible Content Hub version.
+     *
+     * @returns The API information.
+     */
+    private fetchApiInfoAsync;
+}

package/esm/clients/api-client.js

@@ -0,0 +1,99 @@
+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 format from "string-format";
+import { TaJson } from "ta-json";
+import { ApiInfoResource } from "../api/api-info-resource";
+import { API_ROOT, HEADERS } from "../constants/api";
+import ErrorMessages from "../error-messages";
+import { NotSupportedError } from "../errors/not-supported-error";
+import { FileVersion } from "../fileversion";
+import Guard from "../guard";
+import { ApiResourceMapper } from "../mappers/api-resource-mapper";
+import { Compatibility } from "../models/versionining/compatibility";
+import { ResponseHandler } from "./response-handler";
+export class ApiClient {
+    constructor(client) {
+        Guard.notNullOrUndefined(client);
+        this._client = client;
+    }
+    get disableCompatibilityChecks() {
+        return ApiClient._disableCompatibilityChecks;
+    }
+    set disableCompatibilityChecks(value) {
+        ApiClient._disableCompatibilityChecks = value;
+    }
+    getApiInfoAsync() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.loadAsync();
+            return this._api;
+        });
+    }
+    getApiRoutesAsync() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.loadAsync();
+            return this._api.routes;
+        });
+    }
+    refreshAsync() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this._api = yield this.fetchApiInfoAsync();
+        });
+    }
+    /**
+     * Load the REST API information if absent.
+     */
+    loadAsync() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._api) {
+                yield this.refreshAsync();
+            }
+        });
+    }
+    /**
+     * Fetches the API information and checks if the server is running a compatible Content Hub version.
+     *
+     * @returns The API information.
+     */
+    fetchApiInfoAsync() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const headers = {};
+            headers[HEADERS.apiVersion] = "2";
+            const response = yield this._client.raw.getAsync(API_ROOT, headers);
+            ResponseHandler.handleErrors(response);
+            let resource;
+            try {
+                resource = TaJson.deserialize(response && response.content, ApiInfoResource);
+                if (resource === null ||
+                    resource.fileVersion === null ||
+                    resource.minimumSdkVersion === null ||
+                    resource.routes === null) {
+                    throw 0;
+                }
+            }
+            catch (ex) {
+                throw new NotSupportedError(ErrorMessages.ContentHubClient.IncompatibleVersionsPre3_0);
+            }
+            const sdkVersion = new FileVersion(3, 0, 0); //TODO Load this from somewhere
+            const serverVersion = resource.fileVersion;
+            if (!this.disableCompatibilityChecks) {
+                const compatibilityResult = this._client.versionChecker.getCompatibility(serverVersion, sdkVersion, resource.minimumSdkVersion);
+                if (compatibilityResult == Compatibility.SdkOld) {
+                    throw new NotSupportedError(format(ErrorMessages.ContentHubClient.IncompatibleMinimumVersion, sdkVersion, serverVersion, resource.minimumSdkVersion));
+                }
+                if (compatibilityResult == Compatibility.SdkNew) {
+                    throw new NotSupportedError(format(ErrorMessages.ContentHubClient.IncompatibleVersion, sdkVersion, serverVersion));
+                }
+            }
+            const apiInfo = ApiResourceMapper.map(resource);
+            return apiInfo;
+        });
+    }
+}
+//# sourceMappingURL=api-client.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api-client.js","sourceRoot":"","sources":["../../src/clients/api-client.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,MAAM,MAAM,eAAe,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAGjC,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAG3D,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,aAAa,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,MAAM,UAAU,CAAC;AAE7B,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAErE,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAmCrD,MAAM,OAAO,SAAS;IAYlB,YAAY,MAAiC;QACzC,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAXD,IAAI,0BAA0B;QAC1B,OAAO,SAAS,CAAC,2BAA2B,CAAC;IACjD,CAAC;IACD,IAAI,0BAA0B,CAAC,KAAc;QACzC,SAAS,CAAC,2BAA2B,GAAG,KAAK,CAAC;IAClD,CAAC;IAQK,eAAe;;YACjB,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YAEvB,OAAO,IAAI,CAAC,IAAI,CAAC;QACrB,CAAC;KAAA;IAEK,iBAAiB;;YACnB,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YAEvB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;QAC5B,CAAC;KAAA;IAEK,YAAY;;YACd,IAAI,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC/C,CAAC;KAAA;IAED;;OAEG;IACW,SAAS;;YACnB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;gBACZ,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;aAC7B;QACL,CAAC;KAAA;IAED;;;;OAIG;IACW,iBAAiB;;YAC3B,MAAM,OAAO,GAAwB,EAAE,CAAC;YACxC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC;YAElC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAEpE,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAEvC,IAAI,QAAyB,CAAC;YAE9B,IAAI;gBACA,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAkB,QAAQ,IAAI,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;gBAE9F,IACI,QAAQ,KAAK,IAAI;oBACjB,QAAQ,CAAC,WAAW,KAAK,IAAI;oBAC7B,QAAQ,CAAC,iBAAiB,KAAK,IAAI;oBACnC,QAAQ,CAAC,MAAM,KAAK,IAAI,EAC1B;oBACE,MAAM,CAAC,CAAC;iBACX;aACJ;YAAC,OAAO,EAAE,EAAE;gBACT,MAAM,IAAI,iBAAiB,CAAC,aAAa,CAAC,gBAAgB,CAAC,0BAA0B,CAAC,CAAC;aAC1F;YAED,MAAM,UAAU,GAAG,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,+BAA+B;YAC5E,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,CAAC;YAE3C,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAAE;gBAClC,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,gBAAgB,CACpE,aAAa,EACb,UAAU,EACV,QAAQ,CAAC,iBAAiB,CAC7B,CAAC;gBAEF,IAAI,mBAAmB,IAAI,aAAa,CAAC,MAAM,EAAE;oBAC7C,MAAM,IAAI,iBAAiB,CACvB,MAAM,CACF,aAAa,CAAC,gBAAgB,CAAC,0BAA0B,EACzD,UAAU,EACV,aAAa,EACb,QAAQ,CAAC,iBAAiB,CAC7B,CACJ,CAAC;iBACL;gBAED,IAAI,mBAAmB,IAAI,aAAa,CAAC,MAAM,EAAE;oBAC7C,MAAM,IAAI,iBAAiB,CACvB,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,mBAAmB,EAAE,UAAU,EAAE,aAAa,CAAC,CACxF,CAAC;iBACL;aACJ;YAED,MAAM,OAAO,GAAG,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAEhD,OAAO,OAAO,CAAC;QACnB,CAAC;KAAA;CACJ"}

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

@@ -0,0 +1,16 @@
+import { IExtendedContentHubClient } from "./extended-client";
+/**
+ * Allows fetching culture information.
+ */
+export interface IAssetsClient {
+    /**
+     * Gets the default culture.
+     * @returns The default culture.
+     */
+    createPublicLinkAsync(assetId: number, rendition: string, expirationDate?: Date, relativeUrl?: string): Promise<number>;
+}
+export declare class AssetsClient implements IAssetsClient {
+    private readonly _client;
+    constructor(client: IExtendedContentHubClient);
+    createPublicLinkAsync(assetId: number, rendition: string, expirationDate?: Date, relativeUrl?: string): Promise<number>;
+}