@sitecore/sc-contenthub-webclient-sdk 0.9.7

package/dist/contracts/base/relations/child-to-one-parent-relation.js

@@ -0,0 +1,74 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChildToOneParentRelation = void 0;
+const dirty_value_calculator_1 = __importDefault(require("../../../dirty-value-calculator"));
+const guard_1 = __importDefault(require("../../../guard"));
+const relation_1 = require("../relation");
+const relation_role_1 = require("../relation-role");
+class ChildToOneParentRelation extends relation_1.ChildRelationBase {
+    constructor(name) {
+        super(name);
+        this._parent = null;
+        this.role = relation_role_1.RelationRole.Child;
+        this.isMultiValue = false;
+    }
+    get isDirty() {
+        if (!this.isTracking) {
+            return false;
+        }
+        else {
+            return this._dirtyValueCalculator.isDirty(this._parent);
+        }
+    }
+    get parent() {
+        return this._parent;
+    }
+    set parent(id) {
+        guard_1.default.validIdOrNull(id);
+        this._parent = id;
+    }
+    getIds() {
+        if (this._parent !== 0 && this._parent !== null) {
+            return [this._parent];
+        }
+        else {
+            return [];
+        }
+    }
+    setIds(ids) {
+        guard_1.default.arrayMaxOne(ids);
+        if (ids.length > 0) {
+            guard_1.default.validId(ids[0]);
+            this._parent = ids[0];
+        }
+        else {
+            this._parent = null;
+        }
+    }
+    clear() {
+        this._parent = null;
+    }
+    getId() {
+        return this._parent;
+    }
+    setId(id) {
+        guard_1.default.validIdOrNull(id);
+        this._parent = id;
+    }
+    startTracking() {
+        if (this.isTracking)
+            return;
+        this.isTracking = true;
+        this._dirtyValueCalculator = new dirty_value_calculator_1.default();
+        this._dirtyValueCalculator.setOriginalValue(this._parent);
+    }
+    markClean() {
+        if (this.isTracking) {
+            this._dirtyValueCalculator.setOriginalValue(this._parent);
+        }
+    }
+}
+exports.ChildToOneParentRelation = ChildToOneParentRelation;

package/dist/contracts/base/relations/parent-to-many-children-relation.d.ts

@@ -0,0 +1,27 @@
+import { IParentRelation, RelationBase } from "../relation";
+import { RelationRole } from "../relation-role";
+import { IToManyRelation } from "./to-many-relation";
+/**
+ * A relation where the parent has many children.
+ */
+export interface IParentToManyChildrenRelation extends IParentRelation, IToManyRelation {
+    /**
+     * The list of children ids.
+     */
+    readonly children: Array<number>;
+}
+export declare class ParentToManyChildrenRelation extends RelationBase implements IParentToManyChildrenRelation {
+    private _children;
+    readonly role: RelationRole;
+    readonly isMultiValue: boolean;
+    get isDirty(): boolean;
+    get children(): Array<number>;
+    constructor(name: string);
+    getIds(): Array<number>;
+    setIds(ids: Array<number>): void;
+    clear(): void;
+    add(id: number): void;
+    addRange(ids: Array<number>): void;
+    startTracking(): void;
+    markClean(): void;
+}

package/dist/contracts/base/relations/parent-to-many-children-relation.js

@@ -0,0 +1,67 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParentToManyChildrenRelation = void 0;
+const dirty_value_calculator_1 = __importDefault(require("../../../dirty-value-calculator"));
+const guard_1 = __importDefault(require("../../../guard"));
+const relation_1 = require("../relation");
+const relation_role_1 = require("../relation-role");
+class ParentToManyChildrenRelation extends relation_1.RelationBase {
+    constructor(name) {
+        super(name);
+        this._children = [];
+        this.role = relation_role_1.RelationRole.Parent;
+        this.isMultiValue = true;
+    }
+    get isDirty() {
+        if (!this.isTracking) {
+            return false;
+        }
+        else {
+            return this._dirtyValueCalculator.isDirty(this._children);
+        }
+    }
+    get children() {
+        return this._children.slice();
+    }
+    getIds() {
+        return this._children.slice();
+    }
+    setIds(ids) {
+        guard_1.default.validIds(ids);
+        this._children.splice(0, this._children.length);
+        this._children.push(...ids);
+    }
+    clear() {
+        this._children.splice(0, this._children.length);
+    }
+    add(id) {
+        guard_1.default.validId(id);
+        if (!this._children.includes(id)) {
+            this._children.push(id);
+        }
+    }
+    addRange(ids) {
+        guard_1.default.validIds(ids);
+        ids.forEach(id => {
+            if (!this._children.includes(id)) {
+                this._children.push(id);
+            }
+        });
+    }
+    startTracking() {
+        if (this.isTracking)
+            return;
+        this.isTracking = true;
+        this._dirtyValueCalculator = new dirty_value_calculator_1.default();
+        this._dirtyValueCalculator.setOriginalValue(this._children);
+    }
+    markClean() {
+        if (this.isTracking) {
+            this._dirtyValueCalculator.setOriginalValue(this._children);
+        }
+    }
+}
+exports.ParentToManyChildrenRelation = ParentToManyChildrenRelation;

package/dist/contracts/base/relations/parent-to-one-child-relation.d.ts

@@ -0,0 +1,29 @@
+import { Nullable } from "../../../base-types";
+import { IParentRelation, RelationBase } from "../relation";
+import { RelationRole } from "../relation-role";
+import { IToOneRelation } from "./to-one-relation";
+/**
+ * A relation where the parent has one child.
+ */
+export interface IParentToOneChildRelation extends IParentRelation, IToOneRelation {
+    /**
+     * The child id.
+     */
+    child: Nullable<number>;
+}
+export declare class ParentToOneChildRelation extends RelationBase implements IParentToOneChildRelation {
+    private _child;
+    readonly role: RelationRole;
+    readonly isMultiValue: boolean;
+    get child(): Nullable<number>;
+    set child(id: Nullable<number>);
+    get isDirty(): boolean;
+    constructor(name: string);
+    getIds(): Array<number>;
+    setIds(ids: Array<number>): void;
+    clear(): void;
+    getId(): Nullable<number>;
+    setId(id: Nullable<number>): void;
+    startTracking(): void;
+    markClean(): void;
+}

package/dist/contracts/base/relations/parent-to-one-child-relation.js

@@ -0,0 +1,74 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParentToOneChildRelation = void 0;
+const dirty_value_calculator_1 = __importDefault(require("../../../dirty-value-calculator"));
+const guard_1 = __importDefault(require("../../../guard"));
+const relation_1 = require("../relation");
+const relation_role_1 = require("../relation-role");
+class ParentToOneChildRelation extends relation_1.RelationBase {
+    constructor(name) {
+        super(name);
+        this._child = null;
+        this.role = relation_role_1.RelationRole.Parent;
+        this.isMultiValue = false;
+    }
+    get child() {
+        return this._child;
+    }
+    set child(id) {
+        guard_1.default.validIdOrNull(id);
+        this._child = id;
+    }
+    get isDirty() {
+        if (!this.isTracking) {
+            return false;
+        }
+        else {
+            return this._dirtyValueCalculator.isDirty(this._child);
+        }
+    }
+    getIds() {
+        if (this._child !== 0 && this._child !== null) {
+            return [this._child];
+        }
+        else {
+            return [];
+        }
+    }
+    setIds(ids) {
+        guard_1.default.arrayMaxOne(ids);
+        if (ids.length > 0) {
+            guard_1.default.validId(ids[0]);
+            this._child = ids[0];
+        }
+        else {
+            this._child = null;
+        }
+    }
+    clear() {
+        this._child = null;
+    }
+    getId() {
+        return this._child;
+    }
+    setId(id) {
+        guard_1.default.validIdOrNull(id);
+        this._child = id;
+    }
+    startTracking() {
+        if (this.isTracking)
+            return;
+        this.isTracking = true;
+        this._dirtyValueCalculator = new dirty_value_calculator_1.default();
+        this._dirtyValueCalculator.setOriginalValue(this._child);
+    }
+    markClean() {
+        if (this.isTracking) {
+            this._dirtyValueCalculator.setOriginalValue(this._child);
+        }
+    }
+}
+exports.ParentToOneChildRelation = ParentToOneChildRelation;

package/dist/contracts/base/relations/to-many-relation.d.ts

@@ -0,0 +1,16 @@
+import { IRelation } from "../relation";
+/**
+ * Base interface for relation that are associated with many entities.
+ */
+export interface IToManyRelation extends IRelation {
+    /**
+     * Adds an id to the relation's values.
+     * @param id - The id to add
+     */
+    add(id: number): void;
+    /**
+     * Adds multiple ids to the relation's values.
+     * @param ids - The ids to add
+     */
+    addRange(ids: Array<number>): void;
+}

package/dist/contracts/base/relations/to-many-relation.js

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

package/dist/contracts/base/relations/to-one-relation.d.ts

@@ -0,0 +1,18 @@
+import { Nullable } from "../../../base-types";
+import { IRelation } from "../relation";
+/**
+ * Base interface for relation that are associated with only one entity.
+ */
+export interface IToOneRelation extends IRelation {
+    /**
+     * Gets the value of the relation.
+     * @returns An id or null.
+     */
+    getId(): Nullable<number>;
+    /**
+     * Sets the value of the relation.
+     * @param id - The id to set (or null)
+     * @throws The id must be strictly positive.
+     */
+    setId(id: Nullable<number>): void;
+}

package/dist/contracts/base/relations/to-one-relation.js

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

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

@@ -0,0 +1,14 @@
+import URI = require("urijs");
+export interface IRendition {
+    readonly name: string;
+    readonly items: ReadonlyArray<IRenditionItem>;
+}
+export interface IRenditionItem {
+    readonly href: URI | string;
+}
+export declare class Rendition implements IRendition {
+    name: string;
+    readonly items: ReadonlyArray<IRenditionItem>;
+    private constructor();
+    static createRendition(name: string, items: Array<IRenditionItem>): Rendition;
+}

package/dist/contracts/base/rendition.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Rendition = void 0;
+class Rendition {
+    constructor(name, items) {
+        this.name = name;
+        this.items = items;
+    }
+    static createRendition(name, items) {
+        return new Rendition(name, items);
+    }
+}
+exports.Rendition = Rendition;

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

@@ -0,0 +1,21 @@
+/**
+ * Interface for a resource
+ */
+export default interface IResource {
+    /**
+     * The date on which this resource was created or null if it's not created.
+     */
+    createdOn?: Date;
+    /**
+     * The id of the user that created the resource or null if it's not created.
+     */
+    createdBy?: number;
+    /**
+     * The date on which this resource was edited or null if it's not created.
+     */
+    modifiedOn?: Date;
+    /**
+     * The id of the user that last edited the resource or null if it's not created.
+     */
+    modifiedBy?: number;
+}

package/dist/contracts/base/resource.js

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

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

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

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

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringContentType = void 0;
+/**
+ * Types of string content.
+ */
+var StringContentType;
+(function (StringContentType) {
+    /**
+     * Content represents a single line string.
+     */
+    StringContentType[StringContentType["SingleLine"] = 0] = "SingleLine";
+    /**
+     * Content represents multiple lines of string.
+     */
+    StringContentType[StringContentType["MultiLine"] = 1] = "MultiLine";
+    /**
+     * Content represents a HTML code.
+     */
+    StringContentType[StringContentType["Html"] = 2] = "Html";
+    /**
+     * Content represents programming syntax, scripts, data formats like JSON...
+     */
+    StringContentType[StringContentType["Code"] = 3] = "Code";
+})(StringContentType = exports.StringContentType || (exports.StringContentType = {}));

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

@@ -0,0 +1,11 @@
+import { IEntity } from "./entity";
+/**
+ * Interface for strongly typed entities.
+ */
+export interface ITypedEntity extends IEntity {
+    /**
+     * Ensures that the members provided by the strongly typed class are loaded.
+     * To be used in combination with {@link IEntity.canDoLazyLoading}.
+     */
+    loadTypedMembersAsync(): Promise<void>;
+}

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

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

package/dist/contracts/base/users.js

@@ -0,0 +1 @@
+"use strict";

package/dist/contracts/base/view-mode.d.ts

@@ -0,0 +1,4 @@
+export declare enum ViewMode {
+    Basic = "Basic",
+    Extended = "Extended"
+}

package/dist/contracts/base/view-mode.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewMode = void 0;
+var ViewMode;
+(function (ViewMode) {
+    ViewMode["Basic"] = "Basic";
+    ViewMode["Extended"] = "Extended";
+})(ViewMode = exports.ViewMode || (exports.ViewMode = {}));

package/dist/contracts/content/asset.d.ts

@@ -0,0 +1,22 @@
+import { Nullable, NullableResultPromise } from "../../base-types";
+import CultureInfo from "../../culture-info";
+import { Entity } from "../base/entity";
+import { ITypedEntity } from "../base/typed-entity";
+import { FinalLifeCycleStatus } from "./final-life-cycle-status";
+export interface IAsset extends ITypedEntity {
+    title: Nullable<string>;
+    fileName: Nullable<string>;
+    getDescription(culture: CultureInfo): Nullable<string>;
+    setDescription(culture: CultureInfo, description: Nullable<string>): void;
+    getFinalLifeCycleStatusAsync(): NullableResultPromise<FinalLifeCycleStatus>;
+}
+export declare class Asset extends Entity implements IAsset {
+    get title(): Nullable<string>;
+    set title(value: Nullable<string>);
+    get fileName(): Nullable<string>;
+    set fileName(value: Nullable<string>);
+    getDescription(culture: CultureInfo): Nullable<string>;
+    setDescription(culture: CultureInfo, description: Nullable<string>): void;
+    getFinalLifeCycleStatusAsync(): NullableResultPromise<FinalLifeCycleStatus>;
+    loadTypedMembersAsync(): Promise<void>;
+}

package/dist/contracts/content/asset.js

@@ -0,0 +1,67 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Asset = void 0;
+const constants_1 = require("../../constants");
+const final_life_cycle_status_mapper_1 = require("../../mappers/final-life-cycle-status-mapper");
+const entity_1 = require("../base/entity");
+const culture_load_option_1 = require("../querying/culture-load-option");
+const entity_load_configuration_1 = require("../querying/entity-load-configuration");
+const property_load_option_1 = require("../querying/property-load-option");
+const relation_load_option_1 = require("../querying/relation-load-option");
+class Asset extends entity_1.Entity {
+    get title() {
+        return this.getPropertyValue(constants_1.DEFINITIONS["Asset"].title);
+    }
+    set title(value) {
+        this.setPropertyValue(constants_1.DEFINITIONS["Asset"].title, value);
+    }
+    get fileName() {
+        return this.getPropertyValue(constants_1.DEFINITIONS["Asset"].fileName);
+    }
+    set fileName(value) {
+        this.setPropertyValue(constants_1.DEFINITIONS["Asset"].fileName, value);
+    }
+    getDescription(culture) {
+        return this.getPropertyValue(constants_1.DEFINITIONS["Asset"].description, culture);
+    }
+    setDescription(culture, description) {
+        return this.setPropertyValue(constants_1.DEFINITIONS["Asset"].description, description, culture);
+    }
+    getFinalLifeCycleStatusAsync() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const relation = this.getRelation(constants_1.DEFINITIONS["Asset"].finalLifeCycleStatusToAsset);
+            if (relation == null || relation.parent == null) {
+                return null;
+            }
+            const loadConfiguration = new entity_load_configuration_1.EntityLoadConfiguration(culture_load_option_1.CultureLoadOption.None, new property_load_option_1.PropertyLoadOption(constants_1.DEFINITIONS["FinalLifeCycleStatus"].statusValue), relation_load_option_1.RelationLoadOption.None);
+            const parent = yield this._client.entities.getAsync(relation.parent, loadConfiguration);
+            if (parent == null) {
+                return null;
+            }
+            const statusString = parent.getPropertyValue(constants_1.DEFINITIONS["FinalLifeCycleStatus"].statusValue);
+            const status = final_life_cycle_status_mapper_1.FinalLifeCycleStatusMapper.fromString(statusString);
+            return status;
+        });
+    }
+    loadTypedMembersAsync() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const propertyLoadOption = new property_load_option_1.PropertyLoadOption([
+                constants_1.DEFINITIONS["Asset"].title,
+                constants_1.DEFINITIONS["Asset"].fileName,
+                constants_1.DEFINITIONS["Asset"].description,
+            ]);
+            const relationLoadOption = new relation_load_option_1.RelationLoadOption([constants_1.DEFINITIONS["Asset"].finalLifeCycleStatusToAsset]);
+            yield this.loadMembersAsync(propertyLoadOption, relationLoadOption);
+        });
+    }
+}
+exports.Asset = Asset;

package/dist/contracts/content/final-life-cycle-status.d.ts

@@ -0,0 +1,7 @@
+export declare enum FinalLifeCycleStatus {
+    Created = 0,
+    UnderReview = 1,
+    Approved = 2,
+    Rejected = 3,
+    Archived = 4
+}

package/dist/contracts/content/final-life-cycle-status.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FinalLifeCycleStatus = void 0;
+var FinalLifeCycleStatus;
+(function (FinalLifeCycleStatus) {
+    FinalLifeCycleStatus[FinalLifeCycleStatus["Created"] = 0] = "Created";
+    FinalLifeCycleStatus[FinalLifeCycleStatus["UnderReview"] = 1] = "UnderReview";
+    FinalLifeCycleStatus[FinalLifeCycleStatus["Approved"] = 2] = "Approved";
+    FinalLifeCycleStatus[FinalLifeCycleStatus["Rejected"] = 3] = "Rejected";
+    FinalLifeCycleStatus[FinalLifeCycleStatus["Archived"] = 4] = "Archived";
+})(FinalLifeCycleStatus = exports.FinalLifeCycleStatus || (exports.FinalLifeCycleStatus = {}));

package/dist/contracts/dirty-tracking/dirty-tracking.d.ts

@@ -0,0 +1,10 @@
+import CultureInfo from "../../culture-info";
+export interface IDirtyTracking {
+    isDirty: boolean;
+    isTracking: boolean;
+    startTracking(): void;
+    markClean(): void;
+}
+export interface ICultureSensitiveDirtyTracking extends IDirtyTracking {
+    getDirtyCultures(): Array<CultureInfo>;
+}

package/dist/contracts/dirty-tracking/dirty-tracking.js

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

package/dist/contracts/notifications/mail-template.d.ts

@@ -0,0 +1,44 @@
+import CultureInfo from "../../culture-info";
+import { ITypedEntity } from "../base/typed-entity";
+export interface IMailTemplate extends ITypedEntity {
+    /**
+     * Gets or sets the name.
+     */
+    name: string;
+    /**
+     * Gets the subject.
+     * @param culture - The culture
+     * @returns The subject.
+     */
+    getSubject(culture: CultureInfo): string;
+    /**
+     * Sets the subject.
+     * @param culture - The culture
+     * @param subject - The subject
+     */
+    setSubject(culture: CultureInfo, subject: string): void;
+    /**
+     * Gets the body.
+     * @param culture - The culture
+     * @returns The body.
+     */
+    getBody(culture: CultureInfo): string;
+    /**
+     * Sets the body.
+     * @param culture - The culture
+     * @param body - The body
+     */
+    setBody(culture: CultureInfo, body: string): void;
+    /**
+     * Gets the description.
+     * @param culture - The culture
+     * @returns The description.
+     */
+    getDescription(culture: CultureInfo): string;
+    /**
+     * Sets the description.
+     * @param culture - The culture
+     * @param description - The new description
+     */
+    setDescription(culture: CultureInfo, description: string): void;
+}

package/dist/contracts/notifications/mail-template.js

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

package/dist/contracts/policies/condition.d.ts

@@ -0,0 +1,16 @@
+export interface ICondition {
+    /**
+     * The condition is met for entities that are direct or indirect descendants of the entities with the specified ids.
+     * The entities are combined using the "OR" operator.
+     */
+    entityIds: Array<number>;
+    /**
+     * The condition is met for entities that are direct descendants of the entities with the specified ids.
+     * The entities are combined using the "OR" operator.
+     */
+    directEntityIds: Array<number>;
+}
+export declare class Condition implements ICondition {
+    entityIds: Array<number>;
+    directEntityIds: Array<number>;
+}

package/dist/contracts/policies/condition.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Condition = void 0;
+class Condition {
+    constructor() {
+        this.entityIds = [];
+        this.directEntityIds = [];
+    }
+}
+exports.Condition = Condition;