@sitecore/sc-contenthub-webclient-sdk 0.9.7

package/dist/constants/api.d.ts

@@ -0,0 +1,130 @@
+export declare const API_ROOT = "/api";
+export declare const HEADERS: Readonly<{
+    apiVersion: string;
+    minimalSchema: string;
+    location: string;
+}>;
+export declare const EXTENSION_DATA_KEYS: Readonly<{
+    minimalSchema: string;
+}>;
+export declare const QUERY: Readonly<{
+    templateName: string;
+}>;
+export declare const SCROLL: Readonly<{
+    templateName: string;
+}>;
+export declare const DATA_SOURCES: Readonly<{
+    templateName: string;
+}>;
+export declare const DATA_SOURCE_BY_NAME: Readonly<{
+    templateName: string;
+    name: string;
+}>;
+export declare const ENTITIES: Readonly<{
+    templateName: string;
+}>;
+export declare const ENTITY_BY_ID: Readonly<{
+    templateName: string;
+    id: string;
+    culture: string;
+}>;
+export declare const ENTITY_BY_IDENTIFIER: Readonly<{
+    templateName: string;
+    identifier: string;
+}>;
+export declare const ENTITY_RELATION_BY_NAME: Readonly<{
+    templateName: string;
+    id: string;
+    name: string;
+}>;
+export declare const POLICY_BY_ID: Readonly<{
+    templateName: string;
+    id: string;
+}>;
+export declare const ENTITY_DEFINITIONS: Readonly<{
+    templateName: string;
+    definitionsToLoadByName: string;
+    definitionsToLoadById: string;
+    skip: string;
+    take: string;
+    includeConditionalMembers: string;
+    viewMode: string;
+}>;
+export declare const ENTITY_DEFINITION_BY_NAME: Readonly<{
+    templateName: string;
+    name: string;
+    includeConditionalMembers: string;
+}>;
+export declare const ENTITY_DEFINITION_BY_NAME_V2: Readonly<{
+    templateName: string;
+    name: string;
+    includeConditionalMembers: string;
+}>;
+export declare const ENTITY_DEFINITION_BY_ID: Readonly<{
+    templateName: string;
+    id: string;
+    includeConditionalMembers: string;
+}>;
+export declare const FETCH_JOBS: Readonly<{
+    templateName: string;
+}>;
+export declare const FETCH_JOB_BY_ID: Readonly<{
+    templateName: string;
+    id: string;
+}>;
+export declare const PERMISSIONS_FOR_ENTITY: Readonly<{
+    templateName: string;
+    id: string;
+}>;
+export declare const COMMANDS: Readonly<{
+    templateName: string;
+    folder: string;
+    command: string;
+}>;
+export declare const SEND_CONFIRMATION_MAIL: Readonly<{
+    templateName: string;
+    userId: string;
+}>;
+export declare const SEND_NOTIFICATION: Readonly<{
+    templateName: string;
+    type: string;
+}>;
+export declare const DOWNLOAD_ORDER_BY_ID: Readonly<{
+    templateName: string;
+    id: string;
+}>;
+export declare const PACKAGE: Readonly<{
+    templateName: string;
+}>;
+export declare const EXECUTE_SCRIPT: Readonly<{
+    templateName: string;
+    identifier: string;
+}>;
+export declare const SET_USER_PASSWORD: Readonly<{
+    templateName: string;
+    userId: string;
+}>;
+export declare const RESET_PASSWORD: Readonly<{
+    templateName: string;
+    userId: string;
+}>;
+export declare const AGGREGATES: Readonly<{
+    templateName: string;
+    name: string;
+    id: string;
+    culture: string;
+    loadPermissions: string;
+}>;
+export declare const PAGE_BY_IDENTIFIER: Readonly<{
+    templateName: string;
+    identifier: string;
+    culture: string;
+}>;
+export declare const PAGE_BY_ID: Readonly<{
+    templateName: string;
+    id: string;
+    culture: string;
+}>;
+export declare const SEARCH: Readonly<{
+    templateName: string;
+}>;

package/dist/constants/api.js

@@ -0,0 +1,133 @@
+"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.API_ROOT = "/api";
+exports.HEADERS = Object.freeze({
+    apiVersion: "X-ApiVersion",
+    minimalSchema: "minimalSchema",
+    location: "Location",
+});
+exports.EXTENSION_DATA_KEYS = Object.freeze({
+    minimalSchema: "minimal_schema_list",
+});
+exports.QUERY = Object.freeze({
+    templateName: "entities_by_query",
+});
+exports.SCROLL = Object.freeze({
+    templateName: "entities_by_scroll",
+});
+exports.DATA_SOURCES = Object.freeze({
+    templateName: "datasources",
+});
+exports.DATA_SOURCE_BY_NAME = Object.freeze({
+    templateName: "datasource_by_name",
+    name: "name",
+});
+exports.ENTITIES = Object.freeze({
+    templateName: "entities",
+});
+exports.ENTITY_BY_ID = Object.freeze({
+    templateName: "entity_by_id",
+    id: "id",
+    culture: "culture",
+});
+exports.ENTITY_BY_IDENTIFIER = Object.freeze({
+    templateName: "entity_by_identifier",
+    identifier: "identifier",
+});
+exports.ENTITY_RELATION_BY_NAME = Object.freeze({
+    templateName: "entity_relation_by_name",
+    id: "id",
+    name: "name",
+});
+exports.POLICY_BY_ID = Object.freeze({
+    templateName: "policy_by_id",
+    id: "id",
+});
+exports.ENTITY_DEFINITIONS = Object.freeze({
+    templateName: "entitydefinitions",
+    definitionsToLoadByName: "definitionsToLoadByName",
+    definitionsToLoadById: "definitionsToLoadById",
+    skip: "skip",
+    take: "take",
+    includeConditionalMembers: "includeConditionalMembers",
+    viewMode: "viewMode",
+});
+exports.ENTITY_DEFINITION_BY_NAME = Object.freeze({
+    templateName: "entitydefinition_by_name",
+    name: "name",
+    includeConditionalMembers: "includeConditionalMembers",
+});
+exports.ENTITY_DEFINITION_BY_NAME_V2 = Object.freeze({
+    templateName: "entitydefinition_by_name_v2",
+    name: "name",
+    includeConditionalMembers: "includeConditionalMembers",
+});
+exports.ENTITY_DEFINITION_BY_ID = Object.freeze({
+    templateName: "entitydefinition_by_id",
+    id: "id",
+    includeConditionalMembers: "includeConditionalMembers",
+});
+exports.FETCH_JOBS = Object.freeze({
+    templateName: "fetchjobs",
+});
+exports.FETCH_JOB_BY_ID = Object.freeze({
+    templateName: "fetchjobs_by_id",
+    id: "id",
+});
+exports.PERMISSIONS_FOR_ENTITY = Object.freeze({
+    templateName: "permissions_for_entity",
+    id: "id",
+});
+exports.COMMANDS = Object.freeze({
+    templateName: "commands",
+    folder: "folder",
+    command: "command",
+});
+exports.SEND_CONFIRMATION_MAIL = Object.freeze({
+    templateName: "send_confirmation_email",
+    userId: "userId",
+});
+exports.SEND_NOTIFICATION = Object.freeze({
+    templateName: "send_notification",
+    type: "type",
+});
+exports.DOWNLOAD_ORDER_BY_ID = Object.freeze({
+    templateName: "download_orders_by_id",
+    id: "id",
+});
+exports.PACKAGE = Object.freeze({
+    templateName: "package",
+});
+exports.EXECUTE_SCRIPT = Object.freeze({
+    templateName: "execute_script",
+    identifier: "identifier",
+});
+exports.SET_USER_PASSWORD = Object.freeze({
+    templateName: "set_user_password",
+    userId: "userId",
+});
+exports.RESET_PASSWORD = Object.freeze({
+    templateName: "reset_password",
+    userId: "userId",
+});
+exports.AGGREGATES = Object.freeze({
+    templateName: "aggregates",
+    name: "name",
+    id: "id",
+    culture: "culture",
+    loadPermissions: "loadPermissions",
+});
+exports.PAGE_BY_IDENTIFIER = Object.freeze({
+    templateName: "page_by_identifier",
+    identifier: "identifier",
+    culture: "culture",
+});
+exports.PAGE_BY_ID = Object.freeze({
+    templateName: "page_by_id",
+    id: "id",
+    culture: "culture",
+});
+exports.SEARCH = Object.freeze({
+    templateName: "search",
+});

package/dist/constants/defaults.d.ts

@@ -0,0 +1,7 @@
+export declare const ITERATING: Readonly<{
+    pageSize: number;
+}>;
+export declare const ENTITIES: Readonly<{
+    skip: number;
+    take: number;
+}>;

package/dist/constants/defaults.js

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

package/dist/constants/definitions.d.ts

@@ -0,0 +1,62 @@
+export declare const Asset: Readonly<{
+    definitionName: string;
+    title: string;
+    fileName: string;
+    description: string;
+    finalLifeCycleStatusToAsset: string;
+}>;
+export declare const File: Readonly<{
+    definitionName: string;
+}>;
+export declare const Setting: Readonly<{
+    definitionName: string;
+    name: string;
+    value: string;
+    schema: string;
+    label: string;
+    settingCategoryToSettings: string;
+    CultureSetting: Readonly<{
+        name: string;
+    }>;
+}>;
+export declare const MailTemplate: Readonly<{
+    definitionName: string;
+}>;
+export declare const User: Readonly<{
+    definitionName: string;
+    username: string;
+    lockoutEndDate: string;
+    accessFailedCount: string;
+    lastPasswordChangeDateTime: string;
+    emailConfirmationPending: string;
+    lastLoginDateTime: string;
+    userGroupConfiguration: string;
+    userGroupToUser: string;
+    userToUserProfile: string;
+}>;
+export declare const UserProfile: Readonly<{
+    definitionName: string;
+}>;
+export declare const UserGroup: Readonly<{
+    definitionName: string;
+    groupName: string;
+    Groups: Readonly<{
+        everyone: string;
+        superusers: string;
+    }>;
+}>;
+export declare const FinalLifeCycleStatus: Readonly<{
+    definitionName: string;
+    statusValue: string;
+    StatusValues: Readonly<{
+        created: string;
+        approved: string;
+        rejected: string;
+        archived: string;
+        underReview: string;
+    }>;
+}>;
+export declare const SettingsCategory: Readonly<{
+    definitionName: string;
+    name: string;
+}>;

package/dist/constants/definitions.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SettingsCategory = exports.FinalLifeCycleStatus = exports.UserGroup = exports.UserProfile = exports.User = exports.MailTemplate = exports.Setting = exports.File = exports.Asset = void 0;
+/**
+ * Class used to enforce definitionName property on definition constants.
+ */
+class DefinitionConstant extends Object {
+}
+/**
+ * Freezes the object.
+ * Note: Using generics to copy inferred typings to the target.
+ * @param obj - A plain object
+ */
+function createDefinitionConstant(obj) {
+    return Object.freeze(obj);
+}
+exports.Asset = createDefinitionConstant({
+    definitionName: "M.Asset",
+    // Properties
+    title: "Title",
+    fileName: "FileName",
+    description: "Description",
+    // Relations
+    finalLifeCycleStatusToAsset: "FinalLifeCycleStatusToAsset",
+});
+exports.File = createDefinitionConstant({
+    definitionName: "M.File",
+});
+exports.Setting = createDefinitionConstant({
+    definitionName: "M.Setting",
+    // Properties
+    name: "M.Setting.Name",
+    value: "M.Setting.Value",
+    schema: "M.Setting.Schema",
+    label: "M.Setting.Label",
+    // Relations
+    settingCategoryToSettings: "SettingCategoryToSettings",
+    // Instances
+    CultureSetting: Object.freeze({
+        name: "Cultures",
+    }),
+});
+exports.MailTemplate = createDefinitionConstant({
+    definitionName: "M.Mailing.Template",
+});
+exports.User = createDefinitionConstant({
+    definitionName: "User",
+    // Properties
+    username: "Username",
+    lockoutEndDate: "LockoutEndDate",
+    accessFailedCount: "AccessFailedCount",
+    lastPasswordChangeDateTime: "LastPasswordChangeDateTime",
+    emailConfirmationPending: "EmailConfirmationPending",
+    lastLoginDateTime: "LastLoginDateTime",
+    userGroupConfiguration: "UserGroupConfiguration",
+    // Relations
+    userGroupToUser: "UserGroupToUser",
+    userToUserProfile: "UserToUserProfile",
+});
+exports.UserProfile = createDefinitionConstant({
+    definitionName: "M.UserProfile",
+});
+exports.UserGroup = createDefinitionConstant({
+    definitionName: "UserGroup",
+    // Properties
+    groupName: "GroupName",
+    Groups: Object.freeze({
+        everyone: "Everyone",
+        superusers: "Superusers",
+    }),
+});
+exports.FinalLifeCycleStatus = createDefinitionConstant({
+    definitionName: "M.Final.LifeCycle.Status",
+    // Properties
+    statusValue: "StatusValue",
+    StatusValues: Object.freeze({
+        created: "Created",
+        approved: "Approved",
+        rejected: "Rejected",
+        archived: "Archived",
+        underReview: "UnderReview",
+    }),
+});
+exports.SettingsCategory = createDefinitionConstant({
+    definitionName: "M.SettingCategory",
+    // Properties
+    name: "M.SettingCategory.Name",
+});

package/dist/constants/index.d.ts

@@ -0,0 +1,5 @@
+import * as API from "./api";
+import * as DEFAULTS from "./defaults";
+import * as DEFINITIONS from "./definitions";
+import * as NOTIFICATIONS from "./notifications";
+export { API, DEFAULTS, DEFINITIONS, NOTIFICATIONS };

package/dist/constants/index.js

@@ -0,0 +1,30 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NOTIFICATIONS = exports.DEFINITIONS = exports.DEFAULTS = exports.API = void 0;
+const API = __importStar(require("./api"));
+exports.API = API;
+const DEFAULTS = __importStar(require("./defaults"));
+exports.DEFAULTS = DEFAULTS;
+const DEFINITIONS = __importStar(require("./definitions"));
+exports.DEFINITIONS = DEFINITIONS;
+const NOTIFICATIONS = __importStar(require("./notifications"));
+exports.NOTIFICATIONS = NOTIFICATIONS;

package/dist/constants/notifications.d.ts

@@ -0,0 +1,7 @@
+export declare const REALTIME: Readonly<{
+    INFO: Readonly<{
+        body: string;
+        icon: string;
+    }>;
+    raw: string;
+}>;

package/dist/constants/notifications.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REALTIME = void 0;
+exports.REALTIME = Object.freeze({
+    INFO: Object.freeze({
+        body: "body",
+        icon: "icon",
+    }),
+    raw: "Raw",
+});

package/dist/contracts/base/culture-insensitive-property.d.ts

@@ -0,0 +1,28 @@
+import { Nullable } from "../../base-types";
+import { PropertyDataType, PropertyValue, Type, TypeInfo } from "./data-type";
+import { IProperty, PropertyBase } from "./property";
+export interface ICultureInsensitiveProperty<T extends PropertyDataType | unknown = PropertyDataType, B extends boolean = boolean> extends IProperty {
+    /**
+     * Gets the value of the property.
+     * @returns The value.
+     */
+    getValue(): PropertyValue<T, B>;
+    /**
+     * Sets the value of the property.
+     * @param value - The value to set
+     */
+    setValue(value: PropertyValue<T, B>): void;
+}
+export declare class CultureInsensitiveProperty<T extends PropertyDataType | unknown, B extends boolean> extends PropertyBase<T, B> implements ICultureInsensitiveProperty<T, B> {
+    private _value;
+    private _dirtyValueCalculator;
+    isTracking: boolean;
+    readonly isMultiLanguage: false;
+    get isDirty(): boolean;
+    constructor(name: string, typeInfo: TypeInfo<T, B>, value?: B extends true ? Nullable<Array<Type<T>>> : Nullable<Type<T>>);
+    getValue(): B extends true ? Nullable<Array<Type<T>>> : Nullable<Type<T>>;
+    setValue(value: B extends true ? Nullable<Array<Type<T>>> : Nullable<Type<T>>): void;
+    getTypeName(): string;
+    startTracking(): void;
+    markClean(): void;
+}

package/dist/contracts/base/culture-insensitive-property.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CultureInsensitiveProperty = void 0;
+const dirty_value_calculator_1 = __importDefault(require("../../dirty-value-calculator"));
+const property_1 = require("./property");
+class CultureInsensitiveProperty extends property_1.PropertyBase {
+    constructor(name, typeInfo, value) {
+        super(name, typeInfo);
+        this.isMultiLanguage = false;
+        if (value !== undefined) {
+            this._value = value; //TODO clone?
+        }
+    }
+    get isDirty() {
+        if (!this.isTracking) {
+            return false;
+        }
+        return this._dirtyValueCalculator.isDirty(this._value);
+    }
+    getValue() {
+        return this._value;
+    }
+    setValue(value) {
+        this._value = value; //TODO clone value?
+    }
+    getTypeName() {
+        return this.constructor.name;
+    }
+    startTracking() {
+        if (this.isTracking) {
+            return;
+        }
+        this.isTracking = true;
+        this._dirtyValueCalculator = new dirty_value_calculator_1.default();
+        this._dirtyValueCalculator.setOriginalValue(this._value);
+    }
+    markClean() {
+        if (!this.isTracking) {
+            return;
+        }
+        this._dirtyValueCalculator.setOriginalValue(this._value);
+    }
+}
+exports.CultureInsensitiveProperty = CultureInsensitiveProperty;

package/dist/contracts/base/culture-sensitive-property.d.ts

@@ -0,0 +1,49 @@
+import CultureInfo from "../../culture-info";
+import { ICultureSensitiveDirtyTracking } from "../dirty-tracking/dirty-tracking";
+import { PropertyDataType, PropertyValue, PropertyValuePerCulture, TypeInfo } from "./data-type";
+import { IProperty, PropertyBase } from "./property";
+export interface ICultureSensitiveProperty<T extends PropertyDataType | unknown = PropertyDataType, B extends boolean = boolean> extends IProperty, ICultureSensitiveDirtyTracking {
+    /**
+     * Gets the value for a specific culture.
+     * @param culture - The culture for which to get the value
+     * @returns The value or null.
+     */
+    getValue(culture: CultureInfo): PropertyValue<T, B>;
+    /**
+     * Gets all values for the specified cultures
+     * @param cultures - The cultures to get the values for
+     * @returns The values per culture. A value can be null for a certain culture.
+     */
+    getValues(cultures?: Array<CultureInfo>): PropertyValuePerCulture<T, B>;
+    /**
+     * Gets all cultures that the property supports.
+     * These are always equal to the cultures the {@link IEntity} was loaded with.
+     * @returns List of cultures.
+     */
+    getCultures(): Array<CultureInfo>;
+    /**
+     * Sets a value for a specific culture.
+     * @param culture - The culture for which to set the value
+     * @param value - The value
+     */
+    setValue(culture: CultureInfo, value: PropertyValue<T, B>): void;
+}
+export declare class CultureSensitiveProperty<T extends PropertyDataType | unknown, B extends boolean> extends PropertyBase<T, B> implements ICultureSensitiveProperty<T, B> {
+    private readonly _loadedCultures;
+    private readonly _values;
+    private _dirtyValueCalculators;
+    readonly isMultiLanguage: true;
+    isTracking: boolean;
+    get isDirty(): boolean;
+    constructor(name: string, typeInfo: TypeInfo<T, B>, loadedCultures: Array<CultureInfo>, values?: PropertyValuePerCulture<T, B>);
+    getTypeName(): string;
+    getValue(culture: CultureInfo): PropertyValue<T, B>;
+    getValues(cultures?: Array<CultureInfo>): PropertyValuePerCulture<T, B>;
+    getCultures(): Array<CultureInfo>;
+    setValue(culture: CultureInfo, value: PropertyValue<T, B>): void;
+    startTracking(): void;
+    markClean(): void;
+    getDirtyCultures(): Array<CultureInfo>;
+    private cultureMustBeLoaded;
+    private culturesMustBeLoaded;
+}