@sitecore/sc-contenthub-webclient-sdk 1.2.30 → 1.2.36

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

@@ -0,0 +1,405 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+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 { JsonElementType, JsonObject, JsonProperty } from "ta-json";
+import ErrorMessages from "../../error-messages";
+import { ArgumentError } from "../../errors/argument-error";
+import { NotLoadedError } from "../../errors/not-loaded-error";
+import { SchemaError } from "../../errors/schema-error";
+import Guard from "../../guard";
+import { CultureLoadOption } from "../querying/culture-load-option";
+import { EntityLoadConfiguration } from "../querying/entity-load-configuration";
+import { MemberLoadOption } from "../querying/member-load-option";
+import { EntityConstructionArgs } from "./entity-construction-args";
+import { MemberDefinitionType } from "./member-definition-type";
+import { PropertyBase } from "./property";
+import { PropertyManager } from "./property-manager";
+import { RelationBase } from "./relation";
+import { RelationManager } from "./relation-manager";
+let EntityBase = class EntityBase {
+    constructor(client, args) {
+        this._members = {};
+        Guard.notNullOrUndefined(client);
+        Guard.notNullOrUndefined(args);
+        Guard.arrayNoneNullOrInvariantCulture(args.cultures);
+        Guard.arrayNoneNullOrUndefined(args.properties);
+        Guard.arrayNoneNullOrUndefined(args.relations);
+        this._client = client;
+        this.definitionName = args.definitionName;
+        this.id = args.id || undefined;
+        this.identifier = args.identifier;
+        this.cultures = args.cultures;
+        this._propertyManager = new PropertyManager(client, args.properties, this);
+        this._relationManager = new RelationManager(client, args.relations, this);
+    }
+    get properties() {
+        return this._propertyManager.getProperties();
+    }
+    get relations() {
+        return this._relationManager.getRelations();
+    }
+    get canDoLazyLoading() {
+        return !this.isNew && !!this.id;
+    }
+    get isDirty() {
+        if (!this.isTracking) {
+            return false;
+        }
+        for (const dirtyTracker of this.getDirtyTrackingMembers()) {
+            if (dirtyTracker.isDirty) {
+                return true;
+            }
+        }
+        return false;
+    }
+    get isNew() {
+        return !this.id || this.id <= 0;
+    }
+    isProperty(member) {
+        return member && member.definitionType === MemberDefinitionType.Property;
+    }
+    getProperty(name) {
+        Guard.stringNotNullOrEmpty(name);
+        const property = this._propertyManager.getProperty(name);
+        if (property == null) {
+            const errorMessage = format(ErrorMessages.Entity.PropertyNotFound, name, this.id, this.definitionName);
+            throw new NotLoadedError(errorMessage);
+        }
+        return property;
+    }
+    getPropertyAsync(name, loadOption = MemberLoadOption.LazyLoading) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.stringNotNullOrEmpty(name);
+            Guard.notNullOrUndefined(loadOption);
+            let property = this._propertyManager.getProperty(name);
+            if (property == null && loadOption == MemberLoadOption.LazyLoading) {
+                property = yield this._propertyManager.loadPropertyAsync(name);
+                if (property == null) {
+                    const errorMessage = format(ErrorMessages.Entity.PropertyDoesNotExist, name, this.definitionName);
+                    throw new SchemaError(errorMessage);
+                }
+            }
+            if (property == null) {
+                const errorMessage = format(ErrorMessages.Entity.PropertyNotFound, name, this.id, this.definitionName);
+                throw new SchemaError(errorMessage);
+            }
+            return property;
+        });
+    }
+    getPropertyValue(name, culture) {
+        Guard.stringNotNullOrEmpty(name);
+        const property = this.getProperty(name);
+        if (property == null) {
+            const errorMessage = format(ErrorMessages.Entity.PropertyNotFound, name, this.id, this.definitionName);
+            throw new NotLoadedError(errorMessage);
+        }
+        else if (property.isMultiLanguage && culture == null) {
+            throw new ArgumentError(ErrorMessages.Entity.CultureRequired);
+        }
+        else if (culture != null && !property.isMultiLanguage) {
+            throw new ArgumentError(ErrorMessages.Entity.CultureNotSupported);
+        }
+        if (property.isMultiLanguage) {
+            const cultureSensitiveProp = property;
+            return cultureSensitiveProp.getValue(culture);
+        }
+        else {
+            const cultureInsensitiveProp = property;
+            return cultureInsensitiveProp.getValue();
+        }
+    }
+    getPropertyValueAsync(name, loadOption = MemberLoadOption.LazyLoading, culture) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.stringNotNullOrEmpty(name);
+            Guard.notNullOrUndefined(loadOption);
+            const property = yield this.getPropertyAsync(name, loadOption);
+            if (property == null) {
+                const errorMessage = format(ErrorMessages.Entity.PropertyDoesNotExist, name, this.definitionName);
+                throw new SchemaError(errorMessage);
+            }
+            else if (property.isMultiLanguage && culture == null) {
+                throw new ArgumentError(ErrorMessages.Entity.CultureRequired);
+            }
+            else if (culture != null && !property.isMultiLanguage) {
+                throw new ArgumentError(ErrorMessages.Entity.CultureNotSupported);
+            }
+            if (property.isMultiLanguage) {
+                const cultureSensitiveProp = property;
+                return cultureSensitiveProp.getValue(culture);
+            }
+            else {
+                const cultureInsensitiveProp = property;
+                return cultureInsensitiveProp.getValue();
+            }
+        });
+    }
+    setPropertyValue(name, value, culture) {
+        Guard.stringNotNullOrEmpty(name);
+        const property = this._propertyManager.getProperty(name);
+        if (property == null) {
+            const errorMessage = format(ErrorMessages.Entity.PropertyNotFound, name, this.id, this.definitionName);
+            throw new NotLoadedError(errorMessage);
+        }
+        else if (property.isMultiLanguage && culture == null) {
+            throw new ArgumentError(ErrorMessages.Entity.CultureRequired);
+        }
+        else if (culture != null && !property.isMultiLanguage) {
+            throw new ArgumentError(ErrorMessages.Entity.CultureRequired);
+        }
+        if (property.isMultiLanguage) {
+            property.setValue(culture, value);
+        }
+        else {
+            property.setValue(value);
+        }
+    }
+    getRelation(name, role, _returnNull = false) {
+        Guard.stringNotNullOrEmpty(name);
+        const relation = this._relationManager.getRelation(name, role);
+        if (relation == null) {
+            if (_returnNull) {
+                return null;
+            }
+            const errorMessage = format(ErrorMessages.Entity.RelationNotFound, name, this.id, this.definitionName);
+            throw new NotLoadedError(errorMessage);
+        }
+        else if (RelationBase.isChildToManyParentsRelation(relation)) {
+            return relation;
+        }
+        else if (RelationBase.isChildToOneParentRelation(relation)) {
+            return relation;
+        }
+        else if (RelationBase.isParentToManyChildrenRelation(relation)) {
+            return relation;
+        }
+        else if (RelationBase.isParentToOneChildRelation(relation)) {
+            return relation;
+        }
+        return null;
+    }
+    getRelationAsync(name, role, loadOption) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Guard.stringNotNullOrEmpty(name);
+            const relation = this.getRelation(name, role, true);
+            if (relation) {
+                if ((RelationBase.isChildToManyParentsRelation(relation) ||
+                    RelationBase.isParentToManyChildrenRelation(relation)) &&
+                    !relation.isFullyLoaded) {
+                    return (yield this._relationManager.loadRelationAsync(name, role, true));
+                }
+            }
+            else {
+                if (loadOption == MemberLoadOption.LazyLoading) {
+                    // Scoped to be able to redefine relation as type RelationType does not match IRelation. //TODO generics?
+                    const relation = yield this._relationManager.loadRelationAsync(name, role);
+                    if (relation == null) {
+                        const errorMessage = format(ErrorMessages.Entity.RelationDoesNotExist, name, this.definitionName);
+                        throw new SchemaError(errorMessage);
+                    }
+                    if (RelationBase.isChildToManyParentsRelation(relation)) {
+                        return relation;
+                    }
+                    else if (RelationBase.isChildToOneParentRelation(relation)) {
+                        return relation;
+                    }
+                    else if (RelationBase.isParentToManyChildrenRelation(relation)) {
+                        return relation;
+                    }
+                    else if (RelationBase.isParentToOneChildRelation(relation)) {
+                        return relation;
+                    }
+                }
+            }
+            return relation;
+        });
+    }
+    loadPropertiesAsync(propertyLoadOption) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.canDoLazyLoading || propertyLoadOption == null) {
+                return false;
+            }
+            return this._propertyManager.loadPropertiesAsync(propertyLoadOption);
+        });
+    }
+    loadRelationsAsync(relationLoadOption) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.canDoLazyLoading || relationLoadOption == null) {
+                return false;
+            }
+            return this._relationManager.loadRelationsAsync(relationLoadOption);
+        });
+    }
+    loadMembersAsync(propertyLoadOption, relationLoadOption) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.canDoLazyLoading) {
+                return false;
+            }
+            const hasMissingProperties = this._propertyManager.hasMissingProperties(propertyLoadOption);
+            const hasMissingRelations = this._relationManager.hasMissingRelations(relationLoadOption);
+            if (!hasMissingProperties && !hasMissingRelations) {
+                return false;
+            }
+            const cultureLoadOption = new CultureLoadOption([...this.cultures]);
+            const loadConfiguration = new EntityLoadConfiguration(cultureLoadOption, propertyLoadOption, relationLoadOption);
+            const tempEntity = yield this._client.entities.getAsync(this.id, loadConfiguration);
+            // Import missing members
+            this._propertyManager.importMissingProperties(tempEntity);
+            this._relationManager.importMissingRelations(tempEntity);
+            return true;
+        });
+    }
+    getEntityDefinitionAsync() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this._client.entityDefinitions.getCachedAsync(this.definitionName));
+        });
+    }
+    startTracking() {
+        if (this.isTracking)
+            return;
+        this.isTracking = true;
+        for (const member of this.getDirtyTrackingMembers()) {
+            member.startTracking();
+        }
+    }
+    markClean() {
+        for (const member of this.getDirtyTrackingMembers()) {
+            member.markClean();
+        }
+    }
+    getDirtyTrackingMembers() {
+        const properties = this._propertyManager.getProperties();
+        const relations = this._relationManager.getRelations();
+        const list = [...properties, ...relations];
+        return list;
+    }
+};
+__decorate([
+    JsonProperty("id"),
+    __metadata("design:type", Number)
+], EntityBase.prototype, "id", void 0);
+__decorate([
+    JsonProperty("identifier"),
+    __metadata("design:type", Object)
+], EntityBase.prototype, "identifier", void 0);
+__decorate([
+    JsonProperty("hasPublicLink"),
+    __metadata("design:type", Boolean)
+], EntityBase.prototype, "hasPublicLink", void 0);
+__decorate([
+    JsonProperty("masterFileModifiedOn"),
+    __metadata("design:type", Date)
+], EntityBase.prototype, "masterFileModifiedOn", void 0);
+__decorate([
+    JsonProperty("gatewayLinks"),
+    __metadata("design:type", Object)
+], EntityBase.prototype, "gatewayLinks", void 0);
+__decorate([
+    JsonProperty("publicLink"),
+    __metadata("design:type", String)
+], EntityBase.prototype, "publicLink", void 0);
+__decorate([
+    JsonProperty("publicCollectionLink"),
+    __metadata("design:type", String)
+], EntityBase.prototype, "publicCollectionLink", void 0);
+__decorate([
+    JsonProperty("locked_by"),
+    __metadata("design:type", Object)
+], EntityBase.prototype, "lockedBy", void 0);
+__decorate([
+    JsonProperty("locked_on"),
+    __metadata("design:type", Object)
+], EntityBase.prototype, "lockedOn", void 0);
+__decorate([
+    JsonProperty("is_root_taxonomy_item"),
+    __metadata("design:type", Boolean)
+], EntityBase.prototype, "isRootTaxonomyItem", void 0);
+__decorate([
+    JsonProperty("is_path_root"),
+    __metadata("design:type", Boolean)
+], EntityBase.prototype, "isPathRoot", void 0);
+__decorate([
+    JsonProperty("inherits_security"),
+    __metadata("design:type", Boolean)
+], EntityBase.prototype, "inheritsSecurity", void 0);
+__decorate([
+    JsonProperty("is_system_owned"),
+    __metadata("design:type", Boolean)
+], EntityBase.prototype, "isSystemOwned", void 0);
+__decorate([
+    JsonProperty("version"),
+    __metadata("design:type", Number)
+], EntityBase.prototype, "version", void 0);
+__decorate([
+    JsonProperty("cultures"),
+    JsonElementType(String),
+    __metadata("design:type", Array)
+], EntityBase.prototype, "cultures", void 0);
+__decorate([
+    JsonProperty("is_current_user_default"),
+    __metadata("design:type", Boolean)
+], EntityBase.prototype, "isCurrentUserDefault", void 0);
+__decorate([
+    JsonProperty("is_enabled"),
+    __metadata("design:type", Boolean)
+], EntityBase.prototype, "isEnabled", void 0);
+__decorate([
+    JsonProperty("modules"),
+    JsonElementType(String),
+    __metadata("design:type", Array)
+], EntityBase.prototype, "modules", void 0);
+__decorate([
+    JsonProperty("combinedPublishStatus"),
+    __metadata("design:type", String)
+], EntityBase.prototype, "combinedPublishStatus", void 0);
+__decorate([
+    JsonProperty("combinedPublishStatusDetails"),
+    __metadata("design:type", String)
+], EntityBase.prototype, "combinedPublishStatusDetails", void 0);
+__decorate([
+    JsonProperty("properties"),
+    JsonElementType(PropertyBase),
+    __metadata("design:type", Array)
+], EntityBase.prototype, "_properties", void 0);
+__decorate([
+    JsonProperty("relations"),
+    JsonElementType(RelationBase),
+    __metadata("design:type", Array)
+], EntityBase.prototype, "_relations", void 0);
+__decorate([
+    JsonProperty("created_on"),
+    __metadata("design:type", Date)
+], EntityBase.prototype, "createdOn", void 0);
+__decorate([
+    JsonProperty("created_by"),
+    __metadata("design:type", Number)
+], EntityBase.prototype, "createdBy", void 0);
+__decorate([
+    JsonProperty("modified_on"),
+    __metadata("design:type", Date)
+], EntityBase.prototype, "modifiedOn", void 0);
+__decorate([
+    JsonProperty("modified_by"),
+    __metadata("design:type", Number)
+], EntityBase.prototype, "modifiedBy", void 0);
+EntityBase = __decorate([
+    JsonObject(),
+    __metadata("design:paramtypes", [Object, EntityConstructionArgs])
+], EntityBase);
+export { EntityBase };
+//# sourceMappingURL=entity-base.js.map

package/esm/contracts/base/entity-base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-base.js","sourceRoot":"","sources":["../../../src/contracts/base/entity-base.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,OAAO,MAAM,MAAM,eAAe,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAKpE,OAAO,aAAa,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,KAAK,MAAM,aAAa,CAAC;AAGhC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAOlE,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAGpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAa,YAAY,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD,OAAO,EAAa,YAAY,EAAgB,MAAM,YAAY,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AASrD,IAAsB,UAAU,GAAhC,MAAsB,UAAU;IA8H5B,YAAY,MAAyB,EAAE,IAA4B;QA5HhD,aAAQ,GAAyB,EAAE,CAAC;QA6HnD,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACjC,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC/B,KAAK,CAAC,+BAA+B,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrD,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAChD,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAE/C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC1C,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,IAAI,SAAS,CAAC;QAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE9B,IAAI,CAAC,gBAAgB,GAAG,IAAI,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC3E,IAAI,CAAC,gBAAgB,GAAG,IAAI,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAC9E,CAAC;IAlED,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,CAAC;IACjD,CAAC;IAMD,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;IAChD,CAAC;IAgBD,IAAI,gBAAgB;QAChB,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;IACpC,CAAC;IAED,IAAI,OAAO;QACP,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,OAAO,KAAK,CAAC;SAChB;QAED,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,uBAAuB,EAAE,EAAE;YACvD,IAAI,YAAY,CAAC,OAAO,EAAE;gBACtB,OAAO,IAAI,CAAC;aACf;SACJ;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,KAAK;QACL,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;IACpC,CAAC;IAuBO,UAAU,CAAC,MAAe;QAC9B,OAAO,MAAM,IAAI,MAAM,CAAC,cAAc,KAAK,oBAAoB,CAAC,QAAQ,CAAC;IAC7E,CAAC;IAED,WAAW,CAAkC,IAAY;QACrD,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAEjC,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAI,IAAI,CAAC,CAAC;QAE5D,IAAI,QAAQ,IAAI,IAAI,EAAE;YAClB,MAAM,YAAY,GAAG,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,gBAAgB,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;YACvG,MAAM,IAAI,cAAc,CAAC,YAAY,CAAC,CAAC;SAC1C;QAED,OAAO,QAAQ,CAAC;IACpB,CAAC;IAEK,gBAAgB,CAClB,IAAY,EACZ,aAA+B,gBAAgB,CAAC,WAAW;;YAE3D,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;YACjC,KAAK,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;YAErC,IAAI,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAI,IAAI,CAAC,CAAC;YAE1D,IAAI,QAAQ,IAAI,IAAI,IAAI,UAAU,IAAI,gBAAgB,CAAC,WAAW,EAAE;gBAChE,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAI,IAAI,CAAC,CAAC;gBAElE,IAAI,QAAQ,IAAI,IAAI,EAAE;oBAClB,MAAM,YAAY,GAAG,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,oBAAoB,EAAE,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;oBAClG,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,CAAC;iBACvC;aACJ;YAED,IAAI,QAAQ,IAAI,IAAI,EAAE;gBAClB,MAAM,YAAY,GAAG,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,gBAAgB,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;gBACvG,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,CAAC;aACvC;YAED,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED,gBAAgB,CACZ,IAAY,EACZ,OAAqB;QAErB,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAEjC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAExC,IAAI,QAAQ,IAAI,IAAI,EAAE;YAClB,MAAM,YAAY,GAAG,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,gBAAgB,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;YACvG,MAAM,IAAI,cAAc,CAAC,YAAY,CAAC,CAAC;SAC1C;aAAM,IAAI,QAAQ,CAAC,eAAe,IAAI,OAAO,IAAI,IAAI,EAAE;YACpD,MAAM,IAAI,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;SACjE;aAAM,IAAI,OAAO,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE;YACrD,MAAM,IAAI,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;SACrE;QAED,IAAI,QAAQ,CAAC,eAAe,EAAE;YAC1B,MAAM,oBAAoB,GAAG,QAA0C,CAAC;YAExE,OAAO,oBAAoB,CAAC,QAAQ,CAAC,OAAQ,CAAC,CAAC;SAClD;aAAM;YACH,MAAM,sBAAsB,GAAG,QAA4C,CAAC;YAE5E,OAAO,sBAAsB,CAAC,QAAQ,EAAE,CAAC;SAC5C;IACL,CAAC;IAEK,qBAAqB,CACvB,IAAY,EACZ,aAA+B,gBAAgB,CAAC,WAAW,EAC3D,OAAqB;;YAErB,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;YACjC,KAAK,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;YAErC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAE/D,IAAI,QAAQ,IAAI,IAAI,EAAE;gBAClB,MAAM,YAAY,GAAG,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,oBAAoB,EAAE,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;gBAClG,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,CAAC;aACvC;iBAAM,IAAI,QAAQ,CAAC,eAAe,IAAI,OAAO,IAAI,IAAI,EAAE;gBACpD,MAAM,IAAI,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;aACjE;iBAAM,IAAI,OAAO,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE;gBACrD,MAAM,IAAI,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;aACrE;YAED,IAAI,QAAQ,CAAC,eAAe,EAAE;gBAC1B,MAAM,oBAAoB,GAAG,QAA0C,CAAC;gBAExE,OAAO,oBAAoB,CAAC,QAAQ,CAAC,OAAQ,CAAC,CAAC;aAClD;iBAAM;gBACH,MAAM,sBAAsB,GAAG,QAA4C,CAAC;gBAE5E,OAAO,sBAAsB,CAAC,QAAQ,EAAE,CAAC;aAC5C;QACL,CAAC;KAAA;IAED,gBAAgB,CACZ,IAAY,EACZ,KAA0B,EAC1B,OAAqB;QAErB,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAEjC,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAEzD,IAAI,QAAQ,IAAI,IAAI,EAAE;YAClB,MAAM,YAAY,GAAG,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,gBAAgB,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;YACvG,MAAM,IAAI,cAAc,CAAC,YAAY,CAAC,CAAC;SAC1C;aAAM,IAAI,QAAQ,CAAC,eAAe,IAAI,OAAO,IAAI,IAAI,EAAE;YACpD,MAAM,IAAI,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;SACjE;aAAM,IAAI,OAAO,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE;YACrD,MAAM,IAAI,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;SACjE;QAED,IAAI,QAAQ,CAAC,eAAe,EAAE;YACzB,QAA4C,CAAC,QAAQ,CAAC,OAAQ,EAAE,KAAK,CAAC,CAAC;SAC3E;aAAM;YACF,QAA8C,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SACnE;IACL,CAAC;IAED,WAAW,CAAC,IAAY,EAAE,IAAmB,EAAE,cAAuB,KAAK;QACvE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAEjC,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAE/D,IAAI,QAAQ,IAAI,IAAI,EAAE;YAClB,IAAI,WAAW,EAAE;gBACb,OAAO,IAAI,CAAC;aACf;YAED,MAAM,YAAY,GAAG,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,gBAAgB,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;YACvG,MAAM,IAAI,cAAc,CAAC,YAAY,CAAC,CAAC;SAC1C;aAAM,IAAI,YAAY,CAAC,4BAA4B,CAAC,QAAQ,CAAC,EAAE;YAC5D,OAAO,QAAsC,CAAC;SACjD;aAAM,IAAI,YAAY,CAAC,0BAA0B,CAAC,QAAQ,CAAC,EAAE;YAC1D,OAAO,QAAoC,CAAC;SAC/C;aAAM,IAAI,YAAY,CAAC,8BAA8B,CAAC,QAAQ,CAAC,EAAE;YAC9D,OAAO,QAAwC,CAAC;SACnD;aAAM,IAAI,YAAY,CAAC,0BAA0B,CAAC,QAAQ,CAAC,EAAE;YAC1D,OAAO,QAAoC,CAAC;SAC/C;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAEK,gBAAgB,CAClB,IAAY,EACZ,IAA+B,EAC/B,UAAyC;;YAEzC,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;YAEjC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YAEpD,IAAI,QAAQ,EAAE;gBACV,IACI,CAAC,YAAY,CAAC,4BAA4B,CAAC,QAAQ,CAAC;oBAChD,YAAY,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC;oBAC1D,CAAC,QAAQ,CAAC,aAAa,EACzB;oBACE,OAAO,CAAC,MAAM,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAiB,CAAC;iBAC5F;aACJ;iBAAM;gBACH,IAAI,UAAU,IAAI,gBAAgB,CAAC,WAAW,EAAE;oBAC5C,yGAAyG;oBACzG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;oBAE3E,IAAI,QAAQ,IAAI,IAAI,EAAE;wBAClB,MAAM,YAAY,GAAG,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,oBAAoB,EAAE,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;wBAClG,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,CAAC;qBACvC;oBAED,IAAI,YAAY,CAAC,4BAA4B,CAAC,QAAQ,CAAC,EAAE;wBACrD,OAAO,QAAsC,CAAC;qBACjD;yBAAM,IAAI,YAAY,CAAC,0BAA0B,CAAC,QAAQ,CAAC,EAAE;wBAC1D,OAAO,QAAoC,CAAC;qBAC/C;yBAAM,IAAI,YAAY,CAAC,8BAA8B,CAAC,QAAQ,CAAC,EAAE;wBAC9D,OAAO,QAAwC,CAAC;qBACnD;yBAAM,IAAI,YAAY,CAAC,0BAA0B,CAAC,QAAQ,CAAC,EAAE;wBAC1D,OAAO,QAAoC,CAAC;qBAC/C;iBACJ;aACJ;YAED,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEK,mBAAmB,CAAC,kBAAuC;;YAC7D,IAAI,CAAC,IAAI,CAAC,gBAAgB,IAAI,kBAAkB,IAAI,IAAI,EAAE;gBACtD,OAAO,KAAK,CAAC;aAChB;YAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;QACzE,CAAC;KAAA;IAEK,kBAAkB,CAAC,kBAAuC;;YAC5D,IAAI,CAAC,IAAI,CAAC,gBAAgB,IAAI,kBAAkB,IAAI,IAAI,EAAE;gBACtD,OAAO,KAAK,CAAC;aAChB;YAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,CAAC;QACxE,CAAC;KAAA;IAEK,gBAAgB,CAClB,kBAAuC,EACvC,kBAAuC;;YAEvC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBACxB,OAAO,KAAK,CAAC;aAChB;YAED,MAAM,oBAAoB,GAAG,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;YAC5F,MAAM,mBAAmB,GAAG,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;YAE1F,IAAI,CAAC,oBAAoB,IAAI,CAAC,mBAAmB,EAAE;gBAC/C,OAAO,KAAK,CAAC;aAChB;YAED,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;YACpE,MAAM,iBAAiB,GAAG,IAAI,uBAAuB,CACjD,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,CACrB,CAAC;YAEF,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAG,EAAE,iBAAiB,CAAC,CAAC;YAErF,yBAAyB;YACzB,IAAI,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;YAC1D,IAAI,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;YAEzD,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAEK,wBAAwB;;YAC1B,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAE,CAAC;QACvF,CAAC;KAAA;IAQD,aAAa;QACT,IAAI,IAAI,CAAC,UAAU;YAAE,OAAO;QAE5B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,uBAAuB,EAAE,EAAE;YACjD,MAAM,CAAC,aAAa,EAAE,CAAC;SAC1B;IACL,CAAC;IAED,SAAS;QACL,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,uBAAuB,EAAE,EAAE;YACjD,MAAM,CAAC,SAAS,EAAE,CAAC;SACtB;IACL,CAAC;IAEO,uBAAuB;QAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,CAAC;QACzD,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;QAEvD,MAAM,IAAI,GAA0B,CAAC,GAAG,UAAU,EAAE,GAAG,SAAS,CAAC,CAAC;QAElE,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ,CAAA;AAxZG;IADC,YAAY,CAAC,IAAI,CAAC;;sCACP;AAGZ;IADC,YAAY,CAAC,YAAY,CAAC;;8CACE;AAG7B;IADC,YAAY,CAAC,eAAe,CAAC;;iDACN;AAGxB;IADC,YAAY,CAAC,sBAAsB,CAAC;8BACd,IAAI;wDAAC;AAG5B;IADC,YAAY,CAAC,cAAc,CAAC;;gDACO;AAGpC;IADC,YAAY,CAAC,YAAY,CAAC;;8CACP;AAGpB;IADC,YAAY,CAAC,sBAAsB,CAAC;;wDACP;AAK9B;IADC,YAAY,CAAC,WAAW,CAAC;;4CACU;AAGpC;IADC,YAAY,CAAC,WAAW,CAAC;;4CACQ;AAGlC;IADC,YAAY,CAAC,uBAAuB,CAAC;;sDACV;AAG5B;IADC,YAAY,CAAC,cAAc,CAAC;;8CACT;AAGpB;IADC,YAAY,CAAC,mBAAmB,CAAC;;oDACR;AAG1B;IADC,YAAY,CAAC,iBAAiB,CAAC;;iDACT;AAGvB;IADC,YAAY,CAAC,SAAS,CAAC;;2CACR;AAIhB;IAFC,YAAY,CAAC,UAAU,CAAC;IACxB,eAAe,CAAC,MAAM,CAAC;8BACd,KAAK;4CAAc;AAG7B;IADC,YAAY,CAAC,yBAAyB,CAAC;;wDACT;AAG/B;IADC,YAAY,CAAC,YAAY,CAAC;;6CACP;AAIpB;IAFC,YAAY,CAAC,SAAS,CAAC;IACvB,eAAe,CAAC,MAAM,CAAC;8BACd,KAAK;2CAAS;AAGxB;IADC,YAAY,CAAC,uBAAuB,CAAC;;yDACP;AAG/B;IADC,YAAY,CAAC,8BAA8B,CAAC;;gEACP;AAItC;IAFC,YAAY,CAAC,YAAY,CAAC;IAC1B,eAAe,CAAC,YAAY,CAAC;8BACP,KAAK;+CAAY;AAQxC;IAFC,YAAY,CAAC,WAAW,CAAC;IACzB,eAAe,CAAC,YAAY,CAAC;8BACR,KAAK;8CAAY;AAOvC;IADC,YAAY,CAAC,YAAY,CAAC;8BACN,IAAI;6CAAC;AAG1B;IADC,YAAY,CAAC,YAAY,CAAC;;6CACC;AAG5B;IADC,YAAY,CAAC,aAAa,CAAC;8BACN,IAAI;8CAAC;AAG3B;IADC,YAAY,CAAC,aAAa,CAAC;;8CACC;AAjGX,UAAU;IAD/B,UAAU,EAAE;6CA+HoC,sBAAsB;GA9HjD,UAAU,CAga/B;SAhaqB,UAAU"}

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

@@ -0,0 +1,17 @@
+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 {
+    definitionName: string;
+    id?: Nullable<number>;
+    identifier: Nullable<string>;
+    properties: Array<IProperty>;
+    relations: Array<IRelation>;
+    cultures: Array<CultureInfo>;
+    renditions: Array<IRendition>;
+    relatedPaths: Array<IRelatedPath>;
+    constructor(definitionName: string, init?: Omit<Partial<EntityConstructionArgs>, "definitionName">);
+}

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

@@ -0,0 +1,14 @@
+export class EntityConstructionArgs {
+    constructor(definitionName, init) {
+        this.id = null;
+        this.identifier = null;
+        this.properties = [];
+        this.relations = [];
+        this.cultures = [];
+        this.renditions = [];
+        this.relatedPaths = [];
+        this.definitionName = definitionName;
+        Object.assign(this, init);
+    }
+}
+//# sourceMappingURL=entity-construction-args.js.map

package/esm/contracts/base/entity-construction-args.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-construction-args.js","sourceRoot":"","sources":["../../../src/contracts/base/entity-construction-args.ts"],"names":[],"mappings":"AAOA,MAAM,OAAO,sBAAsB;IAU/B,YAAY,cAAsB,EAAE,IAA8D;QARlG,OAAE,GAAsB,IAAI,CAAC;QAC7B,eAAU,GAAqB,IAAI,CAAC;QACpC,eAAU,GAAqB,EAAE,CAAC;QAClC,cAAS,GAAqB,EAAE,CAAC;QACjC,aAAQ,GAAuB,EAAE,CAAC;QAClC,eAAU,GAAsB,EAAE,CAAC;QACnC,iBAAY,GAAwB,EAAE,CAAC;QAGnC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QAErC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9B,CAAC;CACJ"}

package/esm/contracts/base/entity-definition.d.ts

@@ -0,0 +1,113 @@
+import { MapCultureTo, Nullable } from "../../base-types";
+import { IMemberGroup } from "./member-group";
+import { IPropertyDefinition } from "./property-definition";
+import { IRelationDefinition } from "./relation-definition";
+import { RelationRole } from "./relation-role";
+import IResource from "./resource";
+/**
+ * Represents a data schema / domain model for an entity.
+ */
+export interface IEntityDefinition extends IResource {
+    /**
+     * Gets the id of this definition.
+     * This is an automatically assigned unique and strictly positive number identifying the entity definition.
+     * Value is 0, null or undefined when the definition has not been persisted.
+     */
+    readonly id?: number;
+    /**
+     * Gets a value indicating whether the entity definition is new.
+     */
+    readonly isNew: boolean;
+    /**
+     * Gets the unique and language agnostic name of the entity definition.
+     * It should be handled as case sensitive.
+     */
+    name: string;
+    /**
+     * Gets the language agnostic display format for entities of this definition.
+     */
+    displayTemplate: string;
+    /**
+     * Gets a value indicating whether entities of this entity definition are taxonomy items.
+     * They can then be used as a search facet.
+     */
+    isTaxonomyItemDefinition: boolean;
+    /**
+     * Gets a value indicating whether entities of this entity definition can be part of the so called paths, which are technically UI breadcrumbs.
+     * Example use cases are taxonomy entity definitions or M Project block entity definitions.
+     */
+    isPathEnabledDefinition: boolean;
+    /**
+     * Gets a value indicating whether the items of this definition can be sorted manually (UI related).
+     */
+    isManualSortingAllowed: boolean;
+    /**
+     * Gets a value indicating whether the entity definition is owned by the system and cannot be modified or deleted by the regular users.
+     */
+    isSystemOwned: boolean;
+    /**
+     * Gets the collection of {@link IMemberGroup}s.
+     */
+    memberGroups: Array<IMemberGroup>;
+    /**
+     * Gets a collection of the culture specific definition labels.
+     */
+    labels: MapCultureTo<string>;
+    /**
+     * The permissions the current user has for this entity definition.
+     */
+    permissions?: Array<string>;
+    /**
+     * Get the definition of the specified property.
+     * @param name - The name of the property
+     * @returns The property definition or null.
+     */
+    getPropertyDefinition(name: string): Nullable<IPropertyDefinition>;
+    /**
+     * Generic version to get the definition of the specified property.
+     * @param name - The name of the property
+     * @returns The property definition or null.
+     */
+    getPropertyDefinition<T extends IPropertyDefinition>(name: string): Nullable<T>;
+    /**
+     * Gets all property definitions.
+     * @returns A list of all property definitions.
+     */
+    getPropertyDefinitions(): Array<IPropertyDefinition>;
+    /**
+     * Get the definition of the specified relation.
+     * @param name - Name of the relation
+     * @param role - Relation role
+     * @returns The relation definition or null.
+     * @throws An {@link InvalidOperationError} when no role is given and the relation is a self-relation.
+     */
+    getRelationDefinition(name: string, role?: RelationRole): Nullable<IRelationDefinition>;
+    /**
+     * Get all relation definitions.
+     * @returns A list of all relations definitions.
+     */
+    getRelationDefinitions(): Array<IRelationDefinition>;
+}
+export declare class EntityDefinition implements IEntityDefinition {
+    readonly id?: number;
+    get isNew(): boolean;
+    name: string;
+    readonly createdBy?: number;
+    readonly createdOn?: Date;
+    readonly modifiedBy?: number;
+    readonly modifiedOn?: Date;
+    displayTemplate: string;
+    isTaxonomyItemDefinition: boolean;
+    isPathEnabledDefinition: boolean;
+    isManualSortingAllowed: boolean;
+    isSystemOwned: boolean;
+    memberGroups: Array<IMemberGroup>;
+    labels: MapCultureTo<string>;
+    permissions?: Array<string>;
+    constructor(init?: Partial<EntityDefinition>);
+    getPropertyDefinition<T extends IPropertyDefinition>(name: string): Nullable<T>;
+    getPropertyDefinitions(): Array<IPropertyDefinition>;
+    getRelationDefinition(name: string, role?: RelationRole): Nullable<IRelationDefinition>;
+    getRelationDefinitions(): Array<IRelationDefinition>;
+    private getMemberDefinitions;
+}