@sitecore/sc-contenthub-webclient-sdk 1.2.3 → 1.2.5

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

@@ -1,3 +1,4 @@
+import { ConditionalValidationResource } from "../../models/conditional-validation-resource";
 import { PropertyDataType } from "./data-type";
 import { IMemberDefinition, MemberDefinition } from "./member-definition";
 import { MemberDefinitionType } from "./member-definition-type";
@@ -52,6 +53,10 @@ export interface IPropertyDefinition extends IMemberDefinition {
      * Indicates whether this member definition will be ignored during imports.
      */
     ignoreOnExport: boolean;
+    /**
+     * An optional set of conditions that dictate under what conditions the current property is required.
+     */
+    conditionalValidation?: ConditionalValidationResource;
 }
 export declare class PropertyDefinition extends MemberDefinition implements IPropertyDefinition {
     indexed: boolean;
@@ -64,6 +69,7 @@ export declare class PropertyDefinition extends MemberDefinition implements IPro
     includeInCompletion: boolean;
     ignoreOnExport: boolean;
     storedInGraph: boolean;
+    conditionalValidation?: ConditionalValidationResource;
     get dataType(): PropertyDataType;
     get definitionType(): MemberDefinitionType;
     constructor(name: string, type: PropertyDataType);

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

@@ -21,6 +21,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PropertyDefinition = void 0;
 const ta_json_1 = require("ta-json");
+const conditional_validation_resource_1 = require("../../models/conditional-validation-resource");
 const data_type_1 = require("./data-type");
 const member_definition_1 = require("./member-definition");
 const member_definition_type_1 = require("./member-definition-type");
@@ -75,6 +76,11 @@ __decorate([
     (0, ta_json_1.JsonProperty)("stored_in_graph"),
     __metadata("design:type", Boolean)
 ], PropertyDefinition.prototype, "storedInGraph", void 0);
+__decorate([
+    (0, ta_json_1.JsonProperty)("conditional_validation"),
+    (0, ta_json_1.JsonConverter)(conditional_validation_resource_1.ConditionalValidationResourceConverter),
+    __metadata("design:type", conditional_validation_resource_1.ConditionalValidationResource)
+], PropertyDefinition.prototype, "conditionalValidation", void 0);
 PropertyDefinition = __decorate([
     (0, ta_json_1.JsonObject)(),
     __metadata("design:paramtypes", [String, String])

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

@@ -1,4 +1,5 @@
 import { MapCultureTo } from "../../base-types";
+import { ConditionalValidationResource } from "../../models/conditional-validation-resource.js";
 import { IMemberDefinition, MemberDefinition } from "./member-definition";
 import { MemberDefinitionType } from "./member-definition-type";
 import { RelationCardinality } from "./relation-cardinality";
@@ -25,10 +26,18 @@ export interface IRelationDefinition extends IMemberDefinition {
      * Indicates whether relations of this definition must have at least one child.
      */
     childIsMandatory: boolean;
+    /**
+     * An optional set of conditions that dictate under what conditions the the child of this relation should be required.
+     */
+    childConditionalValidation?: ConditionalValidationResource;
     /**
      * Indicates whether relations of this definition must have at least one parent.
      */
     parentIsMandatory: boolean;
+    /**
+     * An optional set of conditions that dictate under what conditions the the parent of this relation should be required.
+     */
+    parentConditionalValidation?: ConditionalValidationResource;
     /**
      * Indicates if this relation is used to inherit any security related meta data (parents -\> children).
      */
@@ -107,7 +116,9 @@ export declare class RelationDefinition extends MemberDefinition implements IRel
     cardinality: RelationCardinality;
     associatedEntityDefinitionName: string;
     childIsMandatory: boolean;
+    childConditionalValidation?: ConditionalValidationResource;
     parentIsMandatory: boolean;
+    parentConditionalValidation?: ConditionalValidationResource;
     inheritsSecurity: boolean;
     allowNavigation: boolean;
     isNested: boolean;

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

@@ -14,6 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RelationDefinition = void 0;
 const ta_json_1 = require("ta-json");
+const conditional_validation_resource_js_1 = require("../../models/conditional-validation-resource.js");
 const data_type_1 = __importDefault(require("./data-type"));
 const member_definition_1 = require("./member-definition");
 const member_definition_type_1 = require("./member-definition-type");
@@ -51,10 +52,20 @@ __decorate([
     (0, ta_json_1.JsonProperty)("child_is_mandatory"),
     __metadata("design:type", Boolean)
 ], RelationDefinition.prototype, "childIsMandatory", void 0);
+__decorate([
+    (0, ta_json_1.JsonProperty)("child_conditional_validation"),
+    (0, ta_json_1.JsonConverter)(conditional_validation_resource_js_1.ConditionalValidationResourceConverter),
+    __metadata("design:type", conditional_validation_resource_js_1.ConditionalValidationResource)
+], RelationDefinition.prototype, "childConditionalValidation", void 0);
 __decorate([
     (0, ta_json_1.JsonProperty)("parent_is_mandatory"),
     __metadata("design:type", Boolean)
 ], RelationDefinition.prototype, "parentIsMandatory", void 0);
+__decorate([
+    (0, ta_json_1.JsonProperty)("parent_conditional_validation"),
+    (0, ta_json_1.JsonConverter)(conditional_validation_resource_js_1.ConditionalValidationResourceConverter),
+    __metadata("design:type", conditional_validation_resource_js_1.ConditionalValidationResource)
+], RelationDefinition.prototype, "parentConditionalValidation", void 0);
 __decorate([
     (0, ta_json_1.JsonProperty)("inherits_security"),
     __metadata("design:type", Boolean)

package/dist/mappers/member-definition-mapper.js

@@ -86,6 +86,7 @@ class MemberDefinitionMapper {
                 canWrite: (_k = resource.canWrite) !== null && _k !== void 0 ? _k : false,
                 ignoreOnExport: (_l = resource.ignoreOnExport) !== null && _l !== void 0 ? _l : false,
                 storedInGraph: (_m = resource.storedInGraph) !== null && _m !== void 0 ? _m : false,
+                conditionalValidation: resource.conditionalValidation,
             };
             switch (resource.type) {
                 case data_type_1.default.Boolean:
@@ -138,6 +139,8 @@ class MemberDefinitionMapper {
                 nestedPermissions: resource.nestedPermissions,
                 cardinality: relation_cardinality_mapper_1.RelationCardinalityMapper.mapToEnumValue(resource.cardinality),
                 role: relation_role_mapper_1.RelationRoleMapper.mapToEnumValue(resource.role),
+                childConditionalValidation: resource.childConditionalValidation,
+                parentConditionalValidation: resource.parentConditionalValidation,
             });
             if (resource.nestedProperties != null) {
                 relationDefinition.nestedProperties.push(...resource.nestedProperties);
@@ -272,6 +275,8 @@ class MemberDefinitionMapper {
                 parentIsMandatory: definition.parentIsMandatory,
                 cardinality: relation_cardinality_mapper_1.RelationCardinalityMapper.mapToType(definition.cardinality),
                 role: relation_role_mapper_1.RelationRoleMapper.mapToType(definition.role),
+                childConditionalValidation: definition.childConditionalValidation,
+                parentConditionalValidation: definition.parentConditionalValidation,
             });
         });
     }

package/dist/models/conditional-validation-operator.d.ts

@@ -0,0 +1 @@
+export declare type ConditionalValidationOperator = "All" | "Any" | "None";

package/dist/models/conditional-validation-operator.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=conditional-validation-operator.js.map

package/dist/models/conditional-validation-resource.d.ts

@@ -0,0 +1,31 @@
+import { IPropertyConverter, JsonValueObject } from "ta-json";
+import { RelationRoleType } from "../contracts/base/relation-role.js";
+import CultureInfo from "../culture-info.js";
+import { EntityLink } from "../entity-link.js";
+import { ConditionalValidationOperator } from "./conditional-validation-operator.js";
+import { LogicalOperator } from "./logical-operator.js";
+export declare class ConditionalValidationResourceConverter implements IPropertyConverter {
+    serialize(value: ConditionalValidationResource): JsonValueObject;
+    deserialize(value: JsonValueObject): ConditionalValidationResource;
+}
+export declare abstract class ConditionalValidationResource {
+}
+export declare class LogicalMemberConditionalValidationResource extends ConditionalValidationResource {
+    constructor(init?: Partial<LogicalMemberConditionalValidationResource>);
+    operator: LogicalOperator;
+    subFilters: Array<ConditionalValidationResource>;
+}
+export declare class PropertyMemberConditionalValidationResource extends ConditionalValidationResource {
+    constructor(init?: Partial<PropertyMemberConditionalValidationResource>);
+    operator: ConditionalValidationOperator;
+    propertyName?: string;
+    culture?: CultureInfo;
+    values: Array<unknown>;
+}
+export declare class RelationMemberConditionalValidationResource extends ConditionalValidationResource {
+    constructor(init?: Partial<RelationMemberConditionalValidationResource>);
+    operator: ConditionalValidationOperator;
+    relationName?: string;
+    relationRole?: RelationRoleType;
+    values: Array<EntityLink>;
+}

package/dist/models/conditional-validation-resource.js

@@ -0,0 +1,119 @@
+"use strict";
+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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RelationMemberConditionalValidationResource = exports.PropertyMemberConditionalValidationResource = exports.LogicalMemberConditionalValidationResource = exports.ConditionalValidationResource = exports.ConditionalValidationResourceConverter = void 0;
+//! This file includes multiple resource classes and a converter to prevent circular references.
+const ta_json_1 = require("ta-json");
+const entity_link_js_1 = require("../entity-link.js");
+class ConditionalValidationResourceConverter {
+    serialize(value) {
+        return ta_json_1.TaJson.serialize(value);
+    }
+    deserialize(value) {
+        if (value["relation_name"]) {
+            return ta_json_1.TaJson.deserialize(value, RelationMemberConditionalValidationResource);
+        }
+        else if (value["property_name"]) {
+            return ta_json_1.TaJson.deserialize(value, PropertyMemberConditionalValidationResource);
+        }
+        else if (Array.isArray(value.subFilters)) {
+            return new LogicalMemberConditionalValidationResource({
+                operator: value.operator,
+                subFilters: value.subFilters.map(filter => this.deserialize(filter)),
+            });
+        }
+        else {
+            throw Error(`Unable to deserialize to ConditionalValidationResource. Value has unknown format:\n${JSON.stringify(value, undefined, 2)}`);
+        }
+    }
+}
+exports.ConditionalValidationResourceConverter = ConditionalValidationResourceConverter;
+class ConditionalValidationResource {
+}
+exports.ConditionalValidationResource = ConditionalValidationResource;
+let LogicalMemberConditionalValidationResource = class LogicalMemberConditionalValidationResource extends ConditionalValidationResource {
+    constructor(init) {
+        super();
+        Object.assign(this, init);
+    }
+};
+__decorate([
+    (0, ta_json_1.JsonProperty)("operator"),
+    __metadata("design:type", String)
+], LogicalMemberConditionalValidationResource.prototype, "operator", void 0);
+__decorate([
+    (0, ta_json_1.JsonProperty)("subFilters"),
+    (0, ta_json_1.JsonConverter)(ConditionalValidationResourceConverter),
+    (0, ta_json_1.JsonType)(Array),
+    __metadata("design:type", Array)
+], LogicalMemberConditionalValidationResource.prototype, "subFilters", void 0);
+LogicalMemberConditionalValidationResource = __decorate([
+    (0, ta_json_1.JsonObject)(),
+    __metadata("design:paramtypes", [Object])
+], LogicalMemberConditionalValidationResource);
+exports.LogicalMemberConditionalValidationResource = LogicalMemberConditionalValidationResource;
+let PropertyMemberConditionalValidationResource = class PropertyMemberConditionalValidationResource extends ConditionalValidationResource {
+    constructor(init) {
+        super();
+        Object.assign(this, init !== null && init !== void 0 ? init : {});
+    }
+};
+__decorate([
+    (0, ta_json_1.JsonProperty)("operator"),
+    __metadata("design:type", String)
+], PropertyMemberConditionalValidationResource.prototype, "operator", void 0);
+__decorate([
+    (0, ta_json_1.JsonProperty)("property_name"),
+    __metadata("design:type", String)
+], PropertyMemberConditionalValidationResource.prototype, "propertyName", void 0);
+__decorate([
+    (0, ta_json_1.JsonProperty)("culture"),
+    __metadata("design:type", String)
+], PropertyMemberConditionalValidationResource.prototype, "culture", void 0);
+__decorate([
+    (0, ta_json_1.JsonProperty)("subFilters"),
+    (0, ta_json_1.JsonType)(Array),
+    __metadata("design:type", Array)
+], PropertyMemberConditionalValidationResource.prototype, "values", void 0);
+PropertyMemberConditionalValidationResource = __decorate([
+    (0, ta_json_1.JsonObject)(),
+    __metadata("design:paramtypes", [Object])
+], PropertyMemberConditionalValidationResource);
+exports.PropertyMemberConditionalValidationResource = PropertyMemberConditionalValidationResource;
+let RelationMemberConditionalValidationResource = class RelationMemberConditionalValidationResource extends ConditionalValidationResource {
+    constructor(init) {
+        super();
+        Object.assign(this, init !== null && init !== void 0 ? init : {});
+    }
+};
+__decorate([
+    (0, ta_json_1.JsonProperty)("operator"),
+    __metadata("design:type", String)
+], RelationMemberConditionalValidationResource.prototype, "operator", void 0);
+__decorate([
+    (0, ta_json_1.JsonProperty)("relation_name"),
+    __metadata("design:type", String)
+], RelationMemberConditionalValidationResource.prototype, "relationName", void 0);
+__decorate([
+    (0, ta_json_1.JsonProperty)("relation_role"),
+    __metadata("design:type", String)
+], RelationMemberConditionalValidationResource.prototype, "relationRole", void 0);
+__decorate([
+    (0, ta_json_1.JsonProperty)("subFilters"),
+    (0, ta_json_1.JsonElementType)(entity_link_js_1.EntityLink),
+    __metadata("design:type", Array)
+], RelationMemberConditionalValidationResource.prototype, "values", void 0);
+RelationMemberConditionalValidationResource = __decorate([
+    (0, ta_json_1.JsonObject)(),
+    __metadata("design:paramtypes", [Object])
+], RelationMemberConditionalValidationResource);
+exports.RelationMemberConditionalValidationResource = RelationMemberConditionalValidationResource;
+//# sourceMappingURL=conditional-validation-resource.js.map

package/dist/models/logical-operator.d.ts

@@ -0,0 +1 @@
+export declare type LogicalOperator = "And" | "Or" | "AndNot";

package/dist/models/logical-operator.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=logical-operator.js.map

package/dist/models/property-definition-resource.d.ts

@@ -3,6 +3,7 @@ import { JsonContentType } from "../contracts/base/json-content-type";
 import { MemberDefinitionType } from "../contracts/base/member-definition-type";
 import { StringContentType } from "../contracts/base/string-content-type";
 import Link from "../link";
+import { ConditionalValidationResource } from "./conditional-validation-resource.js";
 import { MemberDefinitionResource } from "./member-definition-resource";
 export declare class PropertyDefinitionResource extends MemberDefinitionResource {
     indexed: boolean;
@@ -15,6 +16,7 @@ export declare class PropertyDefinitionResource extends MemberDefinitionResource
     includeInCompletion: boolean;
     ignoreOnExport: boolean;
     storedInGraph: boolean;
+    conditionalValidation?: ConditionalValidationResource;
     validationExpression: Nullable<string>;
     get definitionType(): MemberDefinitionType;
 }

package/dist/models/property-definition-resource.js

@@ -37,6 +37,7 @@ const data_type_1 = __importStar(require("../contracts/base/data-type"));
 const member_definition_type_1 = require("../contracts/base/member-definition-type");
 const string_content_type_1 = require("../contracts/base/string-content-type");
 const link_1 = __importDefault(require("../link"));
+const conditional_validation_resource_js_1 = require("./conditional-validation-resource.js");
 const member_definition_resource_1 = require("./member-definition-resource");
 let PropertyDefinitionResource = class PropertyDefinitionResource extends member_definition_resource_1.MemberDefinitionResource {
     get definitionType() {
@@ -83,6 +84,11 @@ __decorate([
     (0, ta_json_1.JsonProperty)("stored_in_graph"),
     __metadata("design:type", Boolean)
 ], PropertyDefinitionResource.prototype, "storedInGraph", void 0);
+__decorate([
+    (0, ta_json_1.JsonProperty)("conditional_validation"),
+    (0, ta_json_1.JsonConverter)(conditional_validation_resource_js_1.ConditionalValidationResourceConverter),
+    __metadata("design:type", conditional_validation_resource_js_1.ConditionalValidationResource)
+], PropertyDefinitionResource.prototype, "conditionalValidation", void 0);
 __decorate([
     (0, ta_json_1.JsonProperty)("validation_expression"),
     __metadata("design:type", Object)

package/dist/models/relation-definition-resource.d.ts

@@ -3,12 +3,15 @@ import { MemberDefinitionType } from "../contracts/base/member-definition-type";
 import { RelationCardinalityType } from "../contracts/base/relation-cardinality";
 import { RelationRoleType } from "../contracts/base/relation-role";
 import Link from "../link";
+import { ConditionalValidationResource } from "./conditional-validation-resource.js";
 import { MemberDefinitionResource } from "./member-definition-resource";
 export declare class RelationDefinitionResource extends MemberDefinitionResource {
     role: RelationRoleType;
     cardinality: RelationCardinalityType;
     childIsMandatory: boolean;
+    childConditionalValidation?: ConditionalValidationResource;
     parentIsMandatory: boolean;
+    parentConditionalValidation?: ConditionalValidationResource;
     inheritsSecurity: boolean;
     allowNavigation: boolean;
     isNested: boolean;

package/dist/models/relation-definition-resource.js

@@ -17,6 +17,7 @@ const ta_json_1 = require("ta-json");
 const data_type_1 = __importDefault(require("../contracts/base/data-type"));
 const member_definition_type_1 = require("../contracts/base/member-definition-type");
 const link_1 = __importDefault(require("../link"));
+const conditional_validation_resource_js_1 = require("./conditional-validation-resource.js");
 const member_definition_resource_1 = require("./member-definition-resource");
 let RelationDefinitionResource = class RelationDefinitionResource extends member_definition_resource_1.MemberDefinitionResource {
     constructor(init) {
@@ -42,10 +43,20 @@ __decorate([
     (0, ta_json_1.JsonProperty)("child_is_mandatory"),
     __metadata("design:type", Boolean)
 ], RelationDefinitionResource.prototype, "childIsMandatory", void 0);
+__decorate([
+    (0, ta_json_1.JsonProperty)("child_conditional_validation"),
+    (0, ta_json_1.JsonConverter)(conditional_validation_resource_js_1.ConditionalValidationResourceConverter),
+    __metadata("design:type", conditional_validation_resource_js_1.ConditionalValidationResource)
+], RelationDefinitionResource.prototype, "childConditionalValidation", void 0);
 __decorate([
     (0, ta_json_1.JsonProperty)("parent_is_mandatory"),
     __metadata("design:type", Boolean)
 ], RelationDefinitionResource.prototype, "parentIsMandatory", void 0);
+__decorate([
+    (0, ta_json_1.JsonProperty)("parent_conditional_validation"),
+    (0, ta_json_1.JsonConverter)(conditional_validation_resource_js_1.ConditionalValidationResourceConverter),
+    __metadata("design:type", conditional_validation_resource_js_1.ConditionalValidationResource)
+], RelationDefinitionResource.prototype, "parentConditionalValidation", void 0);
 __decorate([
     (0, ta_json_1.JsonProperty)("inherits_security"),
     __metadata("design:type", Boolean)

package/dist/models/search/field-filter-request-resource.d.ts

@@ -3,6 +3,7 @@ import { FilterOperator } from "./filter-operator";
 import { RequestedFilterType } from "./requested-filter-type";
 export declare class FieldFilterRequestResource {
     fieldName: string;
+    definitionName?: string;
     groupIdentifier?: string;
     operator: FilterOperator;
     values: Array<unknown>;

package/dist/models/search/field-filter-request-resource.js

@@ -30,6 +30,10 @@ __decorate([
     (0, ta_json_1.JsonProperty)("name"),
     __metadata("design:type", String)
 ], FieldFilterRequestResource.prototype, "fieldName", void 0);
+__decorate([
+    (0, ta_json_1.JsonProperty)("definition"),
+    __metadata("design:type", String)
+], FieldFilterRequestResource.prototype, "definitionName", void 0);
 __decorate([
     (0, ta_json_1.JsonProperty)("group_identifier"),
     __metadata("design:type", String)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sitecore/sc-contenthub-webclient-sdk",
-    "version": "1.2.3",
+    "version": "1.2.5",
     "description": "Sitecore Content Hub WebClient SDK.",
     "scripts": {
         "build": "npm run clean && npm run test && tsc && npm run lint",