@sitecore/sc-contenthub-webclient-sdk 0.9.7 → 1.0.6

package/dist/clients/upload-client.js

@@ -0,0 +1,98 @@
+"use strict";
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UploadClient = void 0;
+const form_data_1 = __importDefault(require("form-data"));
+const ta_json_1 = require("ta-json");
+const api_1 = require("../constants/api");
+const defaults_1 = require("../constants/defaults");
+const error_messages_1 = __importDefault(require("../error-messages"));
+const web_api_error_1 = require("../errors/web-api-error");
+const fileversion_1 = require("../fileversion");
+const guard_1 = __importDefault(require("../guard"));
+const create_upload_response_1 = require("../models/upload/create-upload-response");
+const upload_action_1 = require("../models/upload/upload-action");
+const upload_configuration_1 = require("../models/upload/upload-configuration");
+const upload_request_wrapper_1 = require("../models/upload/upload-request-wrapper");
+const response_handler_1 = require("./response-handler");
+class UploadClient {
+    constructor(client) {
+        this.client = client;
+        guard_1.default.notNull(client);
+    }
+    uploadAsync(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            guard_1.default.notNull(request);
+            yield this.client.versionChecker.compatibilityCheckAsync(new fileversion_1.FileVersion(4, 0, 0, 0));
+            const buffer = yield request.source.getReadableSourceAsync();
+            const uploadRequest = new upload_request_wrapper_1.UploadRequestWrapper();
+            uploadRequest.fileName = request.source.name;
+            uploadRequest.fileSize = buffer.byteLength;
+            uploadRequest.uploadConfiguration = new upload_configuration_1.UploadConfiguration(request.configurationName, request.configurationParameters);
+            uploadRequest.action = new upload_action_1.UploadAction(request.actionName, request.actionParameters);
+            return yield this.uploadFileAsync(uploadRequest, buffer);
+        });
+    }
+    uploadFileAsync(uploadRequest, uploadSource) {
+        return __awaiter(this, void 0, void 0, function* () {
+            guard_1.default.notNull(uploadRequest);
+            guard_1.default.notNull(uploadSource);
+            // 1. Request new file to be created.
+            const uploadLink = yield this.client.linkHelper.createUploadToLinkAsync();
+            const uploadResponse = yield this.client.raw.postAsync(uploadLink.href, ta_json_1.TaJson.serialize(uploadRequest));
+            response_handler_1.ResponseHandler.handleErrors(uploadResponse);
+            const uploadResponseLocation = uploadResponse.responseHeaders[api_1.HEADERS.location];
+            if (!uploadResponseLocation) {
+                throw new web_api_error_1.WebApiError(error_messages_1.default.EntitiesClient.UnableToExtractLocationHeaderFromResponse, uploadResponse.statusCode, uploadResponse);
+            }
+            const createUploadResponse = ta_json_1.TaJson.deserialize(uploadResponse.content, create_upload_response_1.CreateUploadResponse);
+            // 2. Upload file
+            if (uploadRequest.fileSize >= defaults_1.FILE_UPLOAD.chunkSize) {
+                let chunkCurrent = 0;
+                const chunkTotal = Math.ceil(uploadRequest.fileSize / defaults_1.FILE_UPLOAD.chunkSize);
+                const chunkUploadUri = `${uploadResponseLocation}&chunks=${chunkTotal}`;
+                let index = 0;
+                while (index < uploadSource.byteLength) {
+                    const chunk = uploadSource.slice(index, defaults_1.FILE_UPLOAD.chunkSize + index);
+                    yield this.uploadChunkAsync(uploadRequest.fileName, chunk, `${chunkUploadUri}&chunk=${chunkCurrent}`);
+                    index += defaults_1.FILE_UPLOAD.chunkSize;
+                    chunkCurrent++;
+                }
+                // Finalize chunked upload
+                const finalizeChunkUploadResponse = yield this.client.raw.postAsync(chunkUploadUri, "");
+                response_handler_1.ResponseHandler.handleErrors(finalizeChunkUploadResponse);
+            }
+            else {
+                yield this.uploadChunkAsync(uploadRequest.fileName, uploadSource, uploadResponseLocation);
+            }
+            // 3. Finalize upload
+            const finalizeUploadLink = yield this.client.linkHelper.finalizeUploadToLinkAsync();
+            const finalizeUploadResponse = yield this.client.raw.postAsync(finalizeUploadLink.href, createUploadResponse);
+            response_handler_1.ResponseHandler.handleErrors(finalizeUploadResponse);
+            return finalizeUploadResponse;
+        });
+    }
+    uploadChunkAsync(fileName, buffer, uri) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const form = new form_data_1.default({ autoDestroy: true });
+            const headers = {
+                "Content-Type": `multipart/form-data;boundary=${form.getBoundary()}`,
+            };
+            form.append("file", buffer, fileName);
+            const uploadResponse = yield this.client.raw.postAsync(uri, form, headers);
+            response_handler_1.ResponseHandler.handleErrors(uploadResponse);
+        });
+    }
+}
+exports.UploadClient = UploadClient;

package/dist/clients/version-checker.d.ts

@@ -0,0 +1,32 @@
+import { FileVersion } from "../fileversion";
+import { Compatibility } from "../models/versionining/compatibility";
+import { IApiClient } from "./api-client";
+export interface IVersionChecker {
+    /**
+     * Gets the compatibility between a Content Hub instance and SDK.
+     * @param serverVersion - File version of a Content Hub instance.
+     * @param sdkVersion - File version of the SDK.
+     * @param minimumSdkVersion - File version of the minimum SDK version as dictated by the Content Hub instance.
+     * @returns The compatibility.
+     */
+    getCompatibility(serverVersion: FileVersion, sdkVersion: FileVersion, minimumSdkVersion: FileVersion): Compatibility;
+    /**
+     * Check compatibility of a Content Hub instance with minimum required SDK version.
+     * @param requiredVersion - File version required.
+     */
+    compatibilityCheckAsync(requiredVersion: FileVersion): Promise<void>;
+    /**
+     * Return compatibility of the Content Hub instance.
+     * @param requiredVersion - File version required.
+     * @returns True is it's compatible, false otherwise.
+     */
+    isCompatibleAsync(requiredVersion: FileVersion): Promise<boolean>;
+}
+export declare class VersionChecker implements IVersionChecker {
+    private client;
+    constructor(client: IApiClient);
+    getCompatibility(serverVersion: FileVersion, sdkVersion: FileVersion, minimumSdkVersion: FileVersion): Compatibility;
+    compatibilityCheckAsync(requiredVersion: FileVersion): Promise<void>;
+    isCompatibleAsync(requiredVersion: FileVersion): Promise<boolean>;
+    private isDebugVersion;
+}

package/dist/clients/version-checker.js

@@ -0,0 +1,60 @@
+"use strict";
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VersionChecker = void 0;
+const string_format_1 = __importDefault(require("string-format"));
+const error_messages_1 = __importDefault(require("../error-messages"));
+const not_supported_error_1 = require("../errors/not-supported-error");
+const guard_1 = __importDefault(require("../guard"));
+const compatibility_1 = require("../models/versionining/compatibility");
+class VersionChecker {
+    constructor(client) {
+        this.client = client;
+        guard_1.default.notNull(client);
+    }
+    getCompatibility(serverVersion, sdkVersion, minimumSdkVersion) {
+        if (this.isDebugVersion(serverVersion) || this.isDebugVersion(sdkVersion)) {
+            return compatibility_1.Compatibility.Ok;
+        }
+        if (sdkVersion.smallerThan(minimumSdkVersion)) {
+            return compatibility_1.Compatibility.SdkOld;
+        }
+        if (sdkVersion.major > serverVersion.major ||
+            (sdkVersion.major === serverVersion.major && sdkVersion.minor > serverVersion.minor)) {
+            return compatibility_1.Compatibility.SdkNew;
+        }
+        return compatibility_1.Compatibility.Ok;
+    }
+    compatibilityCheckAsync(requiredVersion) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiInfo = yield this.client.getApiInfoAsync();
+            if (apiInfo.fileVersion.smallerThan(requiredVersion) && !this.isDebugVersion(apiInfo.fileVersion)) {
+                throw new not_supported_error_1.NotSupportedError(string_format_1.default(error_messages_1.default.ContentHubClient.NotSupportedFeature, apiInfo.fileVersion, requiredVersion));
+            }
+        });
+    }
+    isCompatibleAsync(requiredVersion) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiInfo = yield this.client.getApiInfoAsync();
+            if (apiInfo.fileVersion > requiredVersion || this.isDebugVersion(apiInfo.fileVersion)) {
+                return true;
+            }
+            return false;
+        });
+    }
+    isDebugVersion(version) {
+        return version.major <= 1;
+    }
+}
+exports.VersionChecker = VersionChecker;

package/dist/constants/api.d.ts

@@ -76,6 +76,11 @@ export declare const PERMISSIONS_FOR_ENTITY: Readonly<{
     templateName: string;
     id: string;
 }>;
+export declare const EXPLAIN_USER_PERMISSIONS_FOR_ENTITY: Readonly<{
+    templateName: string;
+    id: string;
+    userId: string;
+}>;
 export declare const COMMANDS: Readonly<{
     templateName: string;
     folder: string;
@@ -128,3 +133,12 @@ export declare const PAGE_BY_ID: Readonly<{
 export declare const SEARCH: Readonly<{
     templateName: string;
 }>;
+export declare const ALL_FACETS: Readonly<{
+    templateName: string;
+}>;
+export declare const UPLOAD: Readonly<{
+    templateName: string;
+}>;
+export declare const UPLOAD_FINALIZE: Readonly<{
+    templateName: string;
+}>;

package/dist/constants/api.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SEARCH = exports.PAGE_BY_ID = exports.PAGE_BY_IDENTIFIER = exports.AGGREGATES = exports.RESET_PASSWORD = exports.SET_USER_PASSWORD = exports.EXECUTE_SCRIPT = exports.PACKAGE = exports.DOWNLOAD_ORDER_BY_ID = exports.SEND_NOTIFICATION = exports.SEND_CONFIRMATION_MAIL = exports.COMMANDS = exports.PERMISSIONS_FOR_ENTITY = exports.FETCH_JOB_BY_ID = exports.FETCH_JOBS = exports.ENTITY_DEFINITION_BY_ID = exports.ENTITY_DEFINITION_BY_NAME_V2 = exports.ENTITY_DEFINITION_BY_NAME = exports.ENTITY_DEFINITIONS = exports.POLICY_BY_ID = exports.ENTITY_RELATION_BY_NAME = exports.ENTITY_BY_IDENTIFIER = exports.ENTITY_BY_ID = exports.ENTITIES = exports.DATA_SOURCE_BY_NAME = exports.DATA_SOURCES = exports.SCROLL = exports.QUERY = exports.EXTENSION_DATA_KEYS = exports.HEADERS = exports.API_ROOT = void 0;
+exports.UPLOAD_FINALIZE = exports.UPLOAD = exports.ALL_FACETS = exports.SEARCH = exports.PAGE_BY_ID = exports.PAGE_BY_IDENTIFIER = exports.AGGREGATES = exports.RESET_PASSWORD = exports.SET_USER_PASSWORD = exports.EXECUTE_SCRIPT = exports.PACKAGE = exports.DOWNLOAD_ORDER_BY_ID = exports.SEND_NOTIFICATION = exports.SEND_CONFIRMATION_MAIL = exports.COMMANDS = exports.EXPLAIN_USER_PERMISSIONS_FOR_ENTITY = exports.PERMISSIONS_FOR_ENTITY = exports.FETCH_JOB_BY_ID = exports.FETCH_JOBS = exports.ENTITY_DEFINITION_BY_ID = exports.ENTITY_DEFINITION_BY_NAME_V2 = exports.ENTITY_DEFINITION_BY_NAME = exports.ENTITY_DEFINITIONS = exports.POLICY_BY_ID = exports.ENTITY_RELATION_BY_NAME = exports.ENTITY_BY_IDENTIFIER = exports.ENTITY_BY_ID = exports.ENTITIES = exports.DATA_SOURCE_BY_NAME = exports.DATA_SOURCES = exports.SCROLL = exports.QUERY = exports.EXTENSION_DATA_KEYS = exports.HEADERS = exports.API_ROOT = void 0;
 exports.API_ROOT = "/api";
 exports.HEADERS = Object.freeze({
     apiVersion: "X-ApiVersion",
@@ -79,6 +79,11 @@ exports.PERMISSIONS_FOR_ENTITY = Object.freeze({
     templateName: "permissions_for_entity",
     id: "id",
 });
+exports.EXPLAIN_USER_PERMISSIONS_FOR_ENTITY = Object.freeze({
+    templateName: "explain_permissions",
+    id: "id",
+    userId: "userId",
+});
 exports.COMMANDS = Object.freeze({
     templateName: "commands",
     folder: "folder",
@@ -131,3 +136,12 @@ exports.PAGE_BY_ID = Object.freeze({
 exports.SEARCH = Object.freeze({
     templateName: "search",
 });
+exports.ALL_FACETS = Object.freeze({
+    templateName: "allfacets",
+});
+exports.UPLOAD = Object.freeze({
+    templateName: "upload",
+});
+exports.UPLOAD_FINALIZE = Object.freeze({
+    templateName: "upload_finalize",
+});

package/dist/constants/defaults.d.ts

@@ -5,3 +5,6 @@ export declare const ENTITIES: Readonly<{
     skip: number;
     take: number;
 }>;
+export declare const FILE_UPLOAD: Readonly<{
+    chunkSize: number;
+}>;

package/dist/constants/defaults.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ENTITIES = exports.ITERATING = void 0;
+exports.FILE_UPLOAD = exports.ENTITIES = exports.ITERATING = void 0;
 exports.ITERATING = Object.freeze({
     pageSize: 50,
 });
@@ -8,3 +8,6 @@ exports.ENTITIES = Object.freeze({
     skip: 0,
     take: 25,
 });
+exports.FILE_UPLOAD = Object.freeze({
+    chunkSize: 10000000,
+});

package/dist/contracts/base/data-type.d.ts

@@ -1,4 +1,3 @@
-import { Moment } from "moment";
 import { JsonValue, MapCultureTo, Nullable, UnionKeyToValue } from "../../base-types";
 declare type DataType = "Relation" | "String" | "Integer" | "Long" | "Decimal" | "Boolean" | "DateTime" | "DateTimeOffset" | "Json";
 declare type PropertyDataType = Exclude<DataType, "Relation">;
@@ -14,5 +13,5 @@ export declare class TypeInfo<T extends PropertyDataType | unknown = PropertyDat
 }
 export declare type PropertyValue<T extends PropertyDataType | unknown = unknown, B extends boolean = false> = B extends true ? Nullable<Array<Type<T>>> : Nullable<Type<T>>;
 export declare type PropertyValuePerCulture<T extends PropertyDataType | unknown = unknown, B extends boolean = false> = MapCultureTo<PropertyValue<T, B>>;
-export declare type Type<T extends PropertyDataType | unknown> = T extends "String" ? string : T extends "Integer" ? number : T extends "Long" ? number : T extends "Decimal" ? number : T extends "Boolean" ? boolean : T extends "DateTime" ? Date | Moment : T extends "DateTimeOffset" ? Date | Moment : T extends "Json" ? JsonValue : T extends unknown ? unknown : never;
+export declare type Type<T extends PropertyDataType | unknown> = T extends "String" ? string : T extends "Integer" ? number : T extends "Long" ? number : T extends "Decimal" ? number : T extends "Boolean" ? boolean : T extends "DateTime" ? string : T extends "DateTimeOffset" ? string : T extends "Json" ? JsonValue : T extends unknown ? unknown : never;
 export default DataType;

package/dist/contracts/base/entity-base.d.ts

@@ -11,6 +11,7 @@ import { IEntityDefinition } from "./entity-definition";
 import { IMember } from "./member";
 import { IProperty } from "./property";
 import { PropertyManager } from "./property-manager";
+import { IRelatedPath } from "./related-path";
 import { IRelation, RelationType } from "./relation";
 import { RelationManager } from "./relation-manager";
 import { RelationRole } from "./relation-role";
@@ -31,6 +32,9 @@ export declare abstract class EntityBase implements IEntity {
     isSystemOwned: boolean;
     version: number;
     cultures: Array<CultureInfo>;
+    isCurrentUserDefault?: boolean;
+    isEnabled?: boolean;
+    modules?: Array<string>;
     protected _properties: Array<IProperty>;
     get properties(): ReadonlyArray<IProperty>;
     protected _relations: Array<IRelation>;
@@ -44,6 +48,7 @@ export declare abstract class EntityBase implements IEntity {
     get isDirty(): boolean;
     get isNew(): boolean;
     abstract get renditions(): Array<IRendition>;
+    abstract get relatedPaths(): Array<IRelatedPath>;
     constructor(client: IContentHubClient, args: EntityConstructionArgs);
     private isProperty;
     getProperty<T extends IProperty = IProperty>(name: string): Nullable<T>;
@@ -58,6 +63,7 @@ export declare abstract class EntityBase implements IEntity {
     loadMembersAsync(propertyLoadOption: IPropertyLoadOption, relationLoadOption: IRelationLoadOption): Promise<boolean>;
     getEntityDefinitionAsync(): Promise<IEntityDefinition>;
     abstract getRendition(name: string): Nullable<IRendition>;
+    abstract getRelatedPath(name: string): Nullable<IRelatedPath>;
     abstract getPermissionsAsync(): Promise<Array<string>>;
     startTracking(): void;
     markClean(): void;

package/dist/contracts/base/entity-base.js

@@ -329,6 +329,19 @@ __decorate([
     ta_json_1.JsonElementType(String),
     __metadata("design:type", Array)
 ], EntityBase.prototype, "cultures", void 0);
+__decorate([
+    ta_json_1.JsonProperty("is_current_user_default"),
+    __metadata("design:type", Boolean)
+], EntityBase.prototype, "isCurrentUserDefault", void 0);
+__decorate([
+    ta_json_1.JsonProperty("is_enabled"),
+    __metadata("design:type", Boolean)
+], EntityBase.prototype, "isEnabled", void 0);
+__decorate([
+    ta_json_1.JsonProperty("modules"),
+    ta_json_1.JsonElementType(String),
+    __metadata("design:type", Array)
+], EntityBase.prototype, "modules", void 0);
 __decorate([
     ta_json_1.JsonProperty("properties"),
     ta_json_1.JsonElementType(property_1.PropertyBase),

package/dist/contracts/base/entity-construction-args.d.ts

@@ -1,6 +1,7 @@
 import { Nullable } from "../../base-types";
 import CultureInfo from "../../culture-info";
 import { IProperty } from "./property";
+import { IRelatedPath } from "./related-path";
 import { IRelation } from "./relation";
 import { IRendition } from "./rendition";
 export declare class EntityConstructionArgs {
@@ -11,5 +12,6 @@ export declare class EntityConstructionArgs {
     relations: Array<IRelation>;
     cultures: Array<CultureInfo>;
     renditions: Array<IRendition>;
+    relatedPaths: Array<IRelatedPath>;
     constructor(definitionName: string, init?: Omit<Partial<EntityConstructionArgs>, "definitionName">);
 }

package/dist/contracts/base/entity-construction-args.js

@@ -9,6 +9,7 @@ class EntityConstructionArgs {
         this.relations = [];
         this.cultures = [];
         this.renditions = [];
+        this.relatedPaths = [];
         this.definitionName = definitionName;
         Object.assign(this, init);
     }

package/dist/contracts/base/entity-definition.js

@@ -45,7 +45,7 @@ let EntityDefinition = class EntityDefinition {
         const relationDefinition = this.getRelationDefinitions().find(relationDefinition => {
             return relationDefinition.name === name && (role == null || relationDefinition.role === role);
         });
-        if ((relationDefinition === null || relationDefinition === void 0 ? void 0 : relationDefinition.associatedEntityDefinitionName) === this.name) {
+        if ((relationDefinition === null || relationDefinition === void 0 ? void 0 : relationDefinition.associatedEntityDefinitionName) === this.name && role == null) {
             const errorMessage = string_format_1.default(error_messages_1.default.NoRoleSpecifiedForSelfRelation, name);
             throw new invalid_operation_error_1.InvalidOperationError(errorMessage);
         }

package/dist/contracts/base/entity.d.ts

@@ -10,6 +10,7 @@ import { EntityBase } from "./entity-base";
 import { EntityConstructionArgs } from "./entity-construction-args";
 import { IEntityDefinition } from "./entity-definition";
 import { IProperty } from "./property";
+import { IRelatedPath } from "./related-path";
 import { IRelation } from "./relation";
 import { RelationRole } from "./relation-role";
 import { IRendition } from "./rendition";
@@ -75,6 +76,18 @@ export interface IEntity extends IResource, IDirtyTracking {
      * All {@link ICultureSensitiveProperty} properties can only contains values for these cultures.
      */
     cultures: ReadonlyArray<CultureInfo>;
+    /**
+     * Gets or sets a value indicating whether the entity is the default for the given entity definition for the current user.
+     */
+    isCurrentUserDefault?: boolean;
+    /**
+     * Gets or sets a value indicating whether the entity is enabled or not.
+     */
+    isEnabled?: boolean;
+    /**
+     * Gets a list of modules.
+     */
+    modules?: Array<string>;
     /**
      * Gets a list of all properties that are currently loaded on the entity. Never returns null.
      * New properties can still be added by lazy loading them.
@@ -89,6 +102,10 @@ export interface IEntity extends IResource, IDirtyTracking {
      * Gets a list of all renditions for this entity. Never returns null.
      */
     renditions: ReadonlyArray<IRendition>;
+    /**
+     * Gets the related paths for this entity.
+     */
+    relatedPaths?: ReadonlyArray<IRelatedPath>;
     /**
      * Checks if lazy loading is possible. Lazy loading is only possible on persisted entities.
      */
@@ -215,6 +232,12 @@ export interface IEntity extends IResource, IDirtyTracking {
      * @returns Rendition.
      */
     getRendition(name: string): Nullable<IRendition>;
+    /**
+     * Gets an {@link IRelatedPath} by name.
+     * @param name - The name of the related path
+     * @returns Related path.
+     */
+    getRelatedPath(name: string): Nullable<IRelatedPath>;
     /**
      * Gets the {@link IEntityDefinition} of the entity.
      * @returns Promise which resolves to the entity definition.
@@ -230,8 +253,11 @@ export interface IEntity extends IResource, IDirtyTracking {
 export declare class Entity extends EntityBase {
     _client: IExtendedContentHubClient;
     private readonly _renditions;
+    private readonly _relatedPaths;
     get renditions(): Array<IRendition>;
+    get relatedPaths(): Array<IRelatedPath>;
     constructor(client: IExtendedContentHubClient, args: EntityConstructionArgs);
     getRendition(name: string): Nullable<IRendition>;
+    getRelatedPath(name: string): Nullable<IRelatedPath>;
     getPermissionsAsync(): Promise<Array<string>>;
 }

package/dist/contracts/base/entity.js

@@ -40,17 +40,31 @@ let Entity = class Entity extends entity_base_1.EntityBase {
                 this._renditions[rendition.name] = rendition;
             }
         }
+        this._relatedPaths = new base_types_1.CaseInsensitiveStringMap();
+        if (args.relatedPaths != null) {
+            for (const relatedPath of args.relatedPaths) {
+                this._relatedPaths[relatedPath.name] = relatedPath;
+            }
+        }
     }
-    // extensionData: MapStringTo<object>;
     get renditions() {
         return Object.values(this._renditions);
     }
+    get relatedPaths() {
+        return Object.values(this._relatedPaths);
+    }
     getRendition(name) {
         var _a, _b;
         guard_1.default.stringNotNullOrEmpty(name);
         const rendition = (_b = (_a = this._renditions) === null || _a === void 0 ? void 0 : _a[name]) !== null && _b !== void 0 ? _b : null;
         return rendition;
     }
+    getRelatedPath(name) {
+        var _a, _b;
+        guard_1.default.stringNotNullOrEmpty(name);
+        const relatedPath = (_b = (_a = this._relatedPaths) === null || _a === void 0 ? void 0 : _a[name]) !== null && _b !== void 0 ? _b : null;
+        return relatedPath;
+    }
     getPermissionsAsync() {
         return __awaiter(this, void 0, void 0, function* () {
             //TODO HashSet?
@@ -69,6 +83,10 @@ __decorate([
     ta_json_1.JsonProperty("renditions"),
     __metadata("design:type", base_types_1.CaseInsensitiveStringMap)
 ], Entity.prototype, "_renditions", void 0);
+__decorate([
+    ta_json_1.JsonProperty("related_paths"),
+    __metadata("design:type", base_types_1.CaseInsensitiveStringMap)
+], Entity.prototype, "_relatedPaths", void 0);
 Entity = __decorate([
     ta_json_1.JsonObject(),
     __metadata("design:paramtypes", [Object, entity_construction_args_1.EntityConstructionArgs])

package/dist/contracts/base/member-group.js

@@ -16,6 +16,9 @@ const member_condition_1 = require("./member-condition");
 const member_definition_1 = require("./member-definition");
 let MemberGroup = class MemberGroup {
     constructor(init) {
+        this.conditions = [];
+        this.memberDefinitions = [];
+        this.labels = {};
         Object.assign(this, init);
     }
     // @JsonProperty("is_conditional")

package/dist/contracts/base/property-definitions/string-property-definition.js

@@ -41,7 +41,7 @@ let StringPropertyDefinition = class StringPropertyDefinition extends property_d
 };
 __decorate([
     ta_json_1.JsonProperty("content_type"),
-    __metadata("design:type", Number)
+    __metadata("design:type", String)
 ], StringPropertyDefinition.prototype, "contentType", void 0);
 __decorate([
     ta_json_1.JsonProperty("validation_expression"),

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

@@ -0,0 +1,12 @@
+/// <reference types="urijs" />
+import { MapCultureTo, MapStringTo, Nullable } from "../../base-types";
+export interface IRelatedPath {
+    readonly name: string;
+    readonly items: ReadonlyArray<IRelatedPathItem>;
+}
+export interface IRelatedPathItem {
+    readonly values: MapCultureTo<string>;
+    readonly entity: URI | string;
+    readonly definition: URI | string;
+    readonly properties: Nullable<MapStringTo<unknown>>;
+}

package/dist/contracts/base/related-path.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/contracts/base/relation-definition.d.ts

@@ -97,6 +97,10 @@ export interface IRelationDefinition extends IMemberDefinition {
      * Collection of the culture specific member labels of the associated relation definition.
      */
     associatedLabels: MapCultureTo<string>;
+    /**
+     * Indicates whether this relation is multi-value or not.
+     */
+    isMultiValue: boolean;
 }
 export declare class RelationDefinition extends MemberDefinition implements IRelationDefinition {
     role: RelationRole;
@@ -119,5 +123,6 @@ export declare class RelationDefinition extends MemberDefinition implements IRel
     isRenditionRelation: boolean;
     associatedLabels: MapCultureTo<string>;
     get definitionType(): MemberDefinitionType;
+    get isMultiValue(): boolean;
     constructor(name: string, init?: Omit<Partial<RelationDefinition>, "name">);
 }

package/dist/contracts/base/relation-definition.js

@@ -30,6 +30,10 @@ let RelationDefinition = class RelationDefinition extends member_definition_1.Me
     get definitionType() {
         return member_definition_type_1.MemberDefinitionType.Relation;
     }
+    get isMultiValue() {
+        return (this.cardinality === relation_cardinality_1.RelationCardinality.ManyToMany ||
+            (this.cardinality === relation_cardinality_1.RelationCardinality.OneToMany && this.role === relation_role_1.RelationRole.Parent));
+    }
 };
 __decorate([
     ta_json_1.JsonProperty("role"),

package/dist/contracts/base/rendition.d.ts

@@ -1,4 +1,4 @@
-import URI = require("urijs");
+/// <reference types="urijs" />
 export interface IRendition {
     readonly name: string;
     readonly items: ReadonlyArray<IRenditionItem>;

package/dist/contracts/base/string-content-type.d.ts

@@ -5,17 +5,17 @@ export declare enum StringContentType {
     /**
      * Content represents a single line string.
      */
-    SingleLine = 0,
+    SingleLine = "SingleLine",
     /**
      * Content represents multiple lines of string.
      */
-    MultiLine = 1,
+    MultiLine = "MultiLine",
     /**
      * Content represents a HTML code.
      */
-    Html = 2,
+    Html = "Html",
     /**
      * Content represents programming syntax, scripts, data formats like JSON...
      */
-    Code = 3
+    Code = "Code"
 }

package/dist/contracts/base/string-content-type.js

@@ -9,17 +9,17 @@ var StringContentType;
     /**
      * Content represents a single line string.
      */
-    StringContentType[StringContentType["SingleLine"] = 0] = "SingleLine";
+    StringContentType["SingleLine"] = "SingleLine";
     /**
      * Content represents multiple lines of string.
      */
-    StringContentType[StringContentType["MultiLine"] = 1] = "MultiLine";
+    StringContentType["MultiLine"] = "MultiLine";
     /**
      * Content represents a HTML code.
      */
-    StringContentType[StringContentType["Html"] = 2] = "Html";
+    StringContentType["Html"] = "Html";
     /**
      * Content represents programming syntax, scripts, data formats like JSON...
      */
-    StringContentType[StringContentType["Code"] = 3] = "Code";
+    StringContentType["Code"] = "Code";
 })(StringContentType = exports.StringContentType || (exports.StringContentType = {}));

package/dist/contracts/upload/upload-source.d.ts

@@ -0,0 +1,5 @@
+import { ReadableUploadSource } from "../../base-types";
+export interface IUploadSource {
+    name: string;
+    getReadableSourceAsync(): Promise<ReadableUploadSource>;
+}

package/dist/contracts/upload/upload-source.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/converters/all-facet-values-children-converter.d.ts

@@ -0,0 +1,21 @@
+import { IPropertyConverter } from "ta-json";
+import { JsonValue } from "../base-types";
+import { FacetResponseResource } from "../models/search/facet-response-resource";
+export declare class AllFacetValuesChildrenConverter implements IPropertyConverter {
+    /**
+     * Serializes a mapping of strings to array of FacetResponseResource into a JSON object.
+     *
+     * @param value - A mapping of strings to array of FacetResponseResource
+     *
+     * @returns The serialized value.
+     */
+    serialize(children: Record<string, Array<FacetResponseResource>>): JsonValue;
+    /**
+     * Deserializes a JSON object into a mapping of strings to array of FacetResponseResource.
+     *
+     * @param value - The serialized value
+     *
+     * @returns A mapping of strings to array of FacetResponseResource.
+     */
+    deserialize(value: Record<string, Array<JsonValue>>): Record<string, Array<FacetResponseResource>>;
+}