@sitecore/sc-contenthub-webclient-sdk 0.9.7

package/dist/guard.js

@@ -0,0 +1,142 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ow_1 = __importDefault(require("ow"));
+const culture_info_1 = require("./culture-info");
+class Guard {
+    static notNull(value, valueName) {
+        if (value === null)
+            throw `${valueName ? valueName : "Value"} should not be null.`;
+    }
+    static notUndefined(value, valueName) {
+        if (value === undefined)
+            throw `${valueName ? valueName : "Value"} should not be undefined.`;
+    }
+    static notNullOrUndefined(value, valueName) {
+        if (value === null || value === undefined)
+            throw Error(`${valueName ? valueName : "Value"} should not be null or undefined. Value is ${value === null ? "null" : "undefined"}.`);
+    }
+    static parsableInteger(value, valueName) {
+        const parsedValue = parseInt(value);
+        if (isNaN(parsedValue) || parsedValue.toString() !== value.toString()) {
+            throw Error(`${valueName ? valueName : `Value '${value}'`} can not be parsed to an integer.`);
+        }
+    }
+    static parsableFloat(value, valueName) {
+        const parsedValue = parseFloat(value);
+        if (isNaN(parsedValue) || parsedValue.toString() !== value.toString()) {
+            throw Error(`${valueName ? valueName : `Value '${value}'`} can not be parsed to a float/decimal.`);
+        }
+    }
+    static arrayNoneNullOrUndefined(value, valueName, isOptional = false) {
+        if (!isOptional) {
+            Guard.notNullOrUndefined(value);
+        }
+        else if (value == null) {
+            return;
+        }
+        if (!Array.isArray(value)) {
+            throw Error(`Value ${valueName ? ` '${valueName}' ` : ""}is not an array.`);
+        }
+        else if (value.some(item => item == null)) {
+            throw Error(`Array ${valueName ? ` '${valueName}' ` : ""}should not contain null or undefined.`);
+        }
+    }
+    static arrayNoneNullOrEmptyString(value, valueName, isOptional = false) {
+        if (!isOptional) {
+            Guard.notNullOrUndefined(value);
+        }
+        else if (value == null) {
+            return;
+        }
+        if (!Array.isArray(value)) {
+            throw Error(`Value ${valueName ? ` '${valueName}' ` : ""}is not an array.`);
+        }
+        else if (value.some(item => item == null || (typeof item === "string" && (item.length === 0 || item.trim().length === 0)))) {
+            throw Error(`Array ${valueName ? ` '${valueName}' ` : ""}should not contain null, undefined or empty string.`);
+        }
+    }
+    static arrayNoneNullOrInvariantCulture(value, valueName, isOptional = false) {
+        if (!isOptional) {
+            Guard.notNullOrUndefined(value);
+        }
+        else if (value == null) {
+            return;
+        }
+        if (!Array.isArray(value)) {
+            throw Error(`Value ${valueName ? ` '${valueName}' ` : ""}is not an array.`);
+        }
+        else if (value.some(culture => culture == null || culture === culture_info_1.InvariantCulture)) {
+            throw Error(`Array ${valueName ? ` '${valueName}' ` : ""}should not contain null, undefined or '${culture_info_1.InvariantCulture}'.`);
+        }
+    }
+    static isStringArray(value, valueName, isOptional = false) {
+        if (!isOptional) {
+            Guard.notNullOrUndefined(value);
+        }
+        else if (value == null) {
+            return;
+        }
+        if (!Array.isArray(value)) {
+            throw Error(`Value ${valueName ? ` '${valueName}' ` : ""}is not an array.`);
+        }
+        else if (value.some(value => typeof value !== "string")) {
+            throw Error(`Array ${valueName ? ` '${valueName}' ` : ""}should only contain values of type string.`);
+        }
+    }
+    static isIntegerArray(value, valueName, isOptional = false) {
+        if (!isOptional) {
+            Guard.notNullOrUndefined(value);
+        }
+        else if (value == null) {
+            return;
+        }
+        if (!Array.isArray(value)) {
+            throw Error(`Value ${valueName ? ` '${valueName}' ` : ""}is not an array.`);
+        }
+        else if (value.some(value => typeof value !== "number" || !Number.isInteger(value))) {
+            throw Error(`Array ${valueName ? ` '${valueName}' ` : ""}should only contain values of type number.`);
+        }
+    }
+    static isNumberArray(value, valueName, isOptional = false) {
+        if (!isOptional) {
+            Guard.notNullOrUndefined(value);
+        }
+        else if (value == null) {
+            return;
+        }
+        if (!Array.isArray(value)) {
+            throw Error(`Value ${valueName ? ` '${valueName}' ` : ""}is not an array.`);
+        }
+        else if (value.some(value => typeof value !== "number")) {
+            throw Error(`Array ${valueName ? ` '${valueName}' ` : ""}should only contain values of type number.`);
+        }
+    }
+}
+exports.default = Guard;
+// Values
+Guard.isString = ow_1.default.create(ow_1.default.string);
+Guard.isInteger = ow_1.default.create(ow_1.default.number.integer);
+// Arrays
+Guard.arrayNotEmpty = ow_1.default.create(ow_1.default.array.nonEmpty);
+Guard.arrayMaxOne = ow_1.default.create(ow_1.default.array.maxLength(1));
+// Strings
+Guard.stringNotNullOrEmpty = ow_1.default.create(ow_1.default.string.nonEmpty.validate(value => ({
+    validator: value.trim().length > 0,
+    message: label => `Expected ${label} not to be an empty or all whitespace string ('${value}').`,
+})));
+// Ids
+Guard.validId = ow_1.default.create(ow_1.default.number.integer.not.infinite.greaterThan(0));
+Guard.validIdOrNull = ow_1.default.create(ow_1.default.any(ow_1.default.null, ow_1.default.number.integer.not.infinite.greaterThan(0)));
+Guard.validIds = ow_1.default.create(ow_1.default.any(ow_1.default.array.empty, ow_1.default.array.ofType(ow_1.default.number.integer.not.infinite.greaterThan(0))));
+// Cultures
+Guard.notInvariantCulture = ow_1.default.create(ow_1.default.string.nonEmpty.not.equals(culture_info_1.InvariantCulture));
+// Numbers
+Guard.notNegative = ow_1.default.create(ow_1.default.number.not.negative);
+Guard.greaterThan = (number, minValue) => ow_1.default.create(ow_1.default.number.greaterThan(minValue))(number);
+Guard.greaterThanOrEqual = (number, minValue) => ow_1.default.create(ow_1.default.number.greaterThanOrEqual(minValue))(number);
+Guard.lessThan = (number, maxValue) => ow_1.default.create(ow_1.default.number.lessThan(maxValue))(number);
+Guard.lessThanOrEqual = (number, maxValue) => ow_1.default.create(ow_1.default.number.lessThanOrEqual(maxValue))(number);
+Guard.isNumber = ow_1.default.create(ow_1.default.number);

package/dist/http-method.d.ts

@@ -0,0 +1,9 @@
+export declare enum HttpMethod {
+    DELETE = 0,
+    GET = 1,
+    HEAD = 2,
+    OPTIONS = 3,
+    PATCH = 4,
+    POST = 5,
+    PUT = 6
+}

package/dist/http-method.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpMethod = void 0;
+var HttpMethod;
+(function (HttpMethod) {
+    HttpMethod[HttpMethod["DELETE"] = 0] = "DELETE";
+    HttpMethod[HttpMethod["GET"] = 1] = "GET";
+    HttpMethod[HttpMethod["HEAD"] = 2] = "HEAD";
+    HttpMethod[HttpMethod["OPTIONS"] = 3] = "OPTIONS";
+    HttpMethod[HttpMethod["PATCH"] = 4] = "PATCH";
+    HttpMethod[HttpMethod["POST"] = 5] = "POST";
+    HttpMethod[HttpMethod["PUT"] = 6] = "PUT";
+})(HttpMethod = exports.HttpMethod || (exports.HttpMethod = {}));

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./api/api-routes-dictionary";
+export * from "./base-types";
+export * from "./culture-info";
+export * from "./dirty-value-calculator";
+export * from "./entity-link";
+export * from "./error-messages";
+export * from "./fileversion";
+export * from "./guard";
+export * from "./link-helper";
+export * from "./link";

package/dist/index.js

@@ -0,0 +1,22 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api/api-routes-dictionary"), exports);
+__exportStar(require("./base-types"), exports);
+__exportStar(require("./culture-info"), exports);
+__exportStar(require("./dirty-value-calculator"), exports);
+__exportStar(require("./entity-link"), exports);
+__exportStar(require("./error-messages"), exports);
+__exportStar(require("./fileversion"), exports);
+__exportStar(require("./guard"), exports);
+__exportStar(require("./link-helper"), exports);
+__exportStar(require("./link"), exports);

package/dist/link-helper.d.ts

@@ -0,0 +1,209 @@
+import { Nullable, NullableResultPromise } from "./base-types";
+import { IExtendedContentHubClient } from "./clients/extended-client";
+import { ViewMode } from "./contracts/base/view-mode";
+import CultureInfo from "./culture-info";
+import Link from "./link";
+export interface ILinkHelper {
+    /**
+     * Extracts the name of a datasource from the specified link.
+     * @param link - The link to extract the name from
+     * @returns The name as extracted from the link. If the link doesn't contain a name, null is returned.
+     */
+    nameFromDataSourceAsync(link: Link): NullableResultPromise<string>;
+    /**
+     * Creates a link to the datasource with the specified name.
+     * @param name - The name of the datasource to link to
+     * @returns A link to the datasource with the specified name.
+     */
+    dataSourceToLinkAsync(name: string): Promise<Link>;
+    /**
+     * Creates a link to the datasources endpoint.
+     * @returns A link to the datasources endpoint.
+     */
+    dataSourcesLinkAsync(): Promise<Readonly<Link>>;
+    /**
+     * Extracts the name of an entity definition from the specified link.
+     * @param link - The link to extract the name from
+     * @returns The name as extracted from the link. If the link doesn't contain a name, null is returned.
+     */
+    nameFromDefinitionAsync(link: Link): NullableResultPromise<string>;
+    /**
+     * Extracts the names of the specified entity definition links.
+     * @param links - The links to extract the names from
+     * @returns The names as extracted from the links. If the link doesn't contain a name, null is returned.
+     */
+    namesFromDefinitionsAsync(links: Array<Link>): Promise<Array<Nullable<string>>>;
+    /**
+     * Creates a link to the entity definition with the specified name.
+     * @param name - The name of the entity definition to link to
+     * @param includeConditionalMembers - [Optional] Include conditional members
+     * @returns A link to the entity definition with the specified name.
+     */
+    definitionToLinkAsync(name: string, includeConditionalMembers?: boolean): Promise<Link>;
+    /**
+     * Creates a link to the entity definition with the specified id.
+     * @param id - The id of the entity definition to link to
+     * @param includeConditionalMembers - [Optional] Include conditional members
+     * @returns A link to the entity definition with the specified id.
+     */
+    definitionToLinkAsync(id: number, includeConditionalMembers?: boolean): Promise<Link>;
+    definitionToLinkAsync(param: string | number, includeConditionalMembers?: boolean): Promise<Link>;
+    /**
+     * Creates a link to the entity definition with the specified name.
+     * @param name - The name of the entity definition to link to
+     * @param includeConditionalMembers - [Optional] Include conditional members
+     * @returns A link to the entity definition with the specified name.
+     */
+    definitionToLinkV2Async(name: string, includeConditionalMembers?: boolean): Promise<Link>;
+    /**
+     *Creates links to the specified entity definitions by name.
+     * @param names - The names of the entity definitions to include in the result
+     * @param skip - [Optional] Number of results to skip
+     * @param take - [Optional] Number of results to fetch
+     * @param includeConditionalMembers - [Optional] Include conditional members
+     * @param viewMode - [Optional] Select appropriate ViewMode
+     * @returns Link to the entity definitions with the specified names.
+     */
+    definitionsToLinkAsync(names: Nullable<Array<string>>, skip?: number, take?: number, includeConditionalMembers?: boolean, viewMode?: ViewMode): Promise<Link>;
+    /**
+     * Creates links to the specified entity definitions by id.
+     * @param ids - The ids of the entity definitions to include in the result
+     * @param skip - [Optional] Number of results to skip
+     * @param take - [Optional] Number of results to fetch
+     * @param includeConditionalMembers - [Optional] Include conditional members
+     * @param viewMode - [Optional] Select appropriate ViewMode
+     * @returns Link to the entity definitions with the specified ids.
+     */
+    definitionsToLinkAsync(ids: Nullable<Array<number>>, skip?: number, take?: number, includeConditionalMembers?: boolean, viewMode?: ViewMode): Promise<Link>;
+    /**
+     * Creates a link to the entity definitions endpoint.
+     * @param skip - [Optional] Number of results to skip
+     * @param take - [Optional] Number of results to fetch
+     * @param includeConditionalMembers - [Optional] Include conditional members
+     * @returns Link to the entity definitions included in this batch.
+     */
+    definitionsLinkAsync(skip?: number, take?: number, includeConditionalMembers?: boolean): Promise<Link>;
+    /**
+     * Extracts the id of an entity from the specified link.
+     * @param link - The link to extract the name from
+     * @returns The id as extracted from the link. If the link doesn't contain an id, null is returned.
+     */
+    idFromEntityAsync(link: Link): NullableResultPromise<number>;
+    /**
+     * Extracts the id of entities from the specified links.
+     * @param links - The links to extract the names from
+     * @returns The ids as extracted from the links.
+     */
+    idsFromEntitiesAsync(links: Array<Link>): Promise<Array<number>>;
+    /**
+     * Creates a link to the entity with the specified id.
+     * @param id - The id of the entity to link to
+     * @param culture - [Optional] Culture for the entity
+     * @returns A link to the entity with the specified id.
+     */
+    entityToLinkAsync(id: number, culture?: Nullable<CultureInfo>): Promise<Link>;
+    /**
+     * Creates a link to the entity with the specified identifier.
+     * @param identifier - The identifier of the entity to link to
+     * @returns A link to the entity with the specified identifier.
+     */
+    entityToLinkAsync(identifier: string): Promise<Link>;
+    /**
+     * Creates links to the entities with the specified ids.
+     * @param ids - The ids of the entities to link to
+     * @returns Link to the entities with the specified ids.
+     */
+    entitiesToLinksAsync(ids: Array<number>): Promise<Array<Link>>;
+    /**
+     * Extracts the identifier of an entity from the specified
+     * @param link - The link to extract the identifier from
+     * @returns The identifier as extracted from the link. If the link doesn't contain an identifier, null is returned.
+     */
+    identifierFromEntityAsync(link: Link): NullableResultPromise<string>;
+    /**
+     * Creates a link to the entities endpoint.
+     * @returns Link to entities endpoint.
+     */
+    entitiesLinkAsync(): Promise<Readonly<Link>>;
+    /**
+     * Creates a link to the permissions for entity endpoint.
+     * @param id - The entity id
+     * @returns Link to the permissions for entity.
+     */
+    permissionsForEntityToLinkAsync(id: number): Promise<Link>;
+    /**
+     * Gets the link to set the password of the specified user.
+     *
+     * @param userId - The id of the user
+     * @returns Link to set user password.
+     */
+    setUserPasswordToLinkAsync(userId: number): Promise<Link>;
+    /**
+     * Gets the link to reset the password of the specified user.
+     *
+     * @param userId - The id of the user
+     * @returns Link to reset user password.
+     */
+    resetPasswordToLinkAsync(userId: number): Promise<Link>;
+    policyToLinkAsync(id: number): Promise<Link>;
+    idFromPolicyAsync(link: Link): NullableResultPromise<number>;
+    /**
+     * Generates a link to a command.
+     *
+     * @param namespace - The name of the folder containing the command
+     * @param command - The name of the command
+     * @returns Link for the command.
+     */
+    commandToLinkAsync(namespace: string, command: string): Promise<Link>;
+    sendConfirmationMailToLinkAsync(userId: number): Promise<Link>;
+    sendNotificationToLinkAsync(notificationType: string): Promise<Link>;
+    /**
+     * Generate a link to an aggregate resource.
+     * @param aggregateName - The name of the aggregate
+     * @param entityId - The entity id for which to get the aggregate
+     * @param culture - Culture for the entity
+     * @param loadPermissions - Include permissions
+     * @returns Link to the aggregate resource.
+     */
+    aggregateToLinkAsync(aggregateName: string, entityId: number, culture?: CultureInfo, loadPermissions?: boolean): Promise<Link>;
+    /**
+     * Generate a link to a page name.
+     * @param pageName - The name or id of the page
+     * @param culture - Culture of the page
+     */
+    pageResourceToLinkAsync(page: string | number, culture: CultureInfo): Promise<Link>;
+    searchLinkAsync(): Promise<Readonly<Link>>;
+}
+export declare class LinkHelper implements ILinkHelper {
+    private readonly _client;
+    constructor(client: IExtendedContentHubClient);
+    nameFromDataSourceAsync(link: Link): NullableResultPromise<string>;
+    dataSourceToLinkAsync(name: string): Promise<Link>;
+    dataSourcesLinkAsync(): Promise<Readonly<Link>>;
+    nameFromDefinitionAsync(link: Link): NullableResultPromise<string>;
+    namesFromDefinitionsAsync(links: Array<Link>): Promise<Array<Nullable<string>>>;
+    definitionToLinkAsync(param: string | number, includeConditionalMembers?: boolean): Promise<Link>;
+    definitionToLinkV2Async(name: string, includeConditionalMembers?: boolean): Promise<Link>;
+    definitionsToLinkAsync(values: Nullable<Array<string>> | Nullable<Array<number>>, skip?: number, take?: number, includeConditionalMembers?: boolean, viewMode?: ViewMode): Promise<Link>;
+    definitionsLinkAsync(skip?: number, take?: number, includeConditionalMembers?: boolean): Promise<Link>;
+    idFromEntityAsync(link: Link): Promise<number | null>;
+    idsFromEntitiesAsync(links: Array<Link>): Promise<Array<number>>;
+    entityToLinkAsync(param: number | string, culture?: Nullable<CultureInfo>): Promise<Link>;
+    entitiesToLinksAsync(ids: Array<number>): Promise<Array<Link>>;
+    identifierFromEntityAsync(link: Link): NullableResultPromise<string>;
+    entitiesLinkAsync(): Promise<Readonly<Link>>;
+    permissionsForEntityToLinkAsync(id: number): Promise<Link>;
+    setUserPasswordToLinkAsync(userId: number): Promise<Link>;
+    resetPasswordToLinkAsync(userId: number): Promise<Link>;
+    policyToLinkAsync(id: number): Promise<Link>;
+    idFromPolicyAsync(link: Link): NullableResultPromise<number>;
+    commandToLinkAsync(namespace: string, command: string): Promise<Link>;
+    sendConfirmationMailToLinkAsync(userId: number): Promise<Link>;
+    sendNotificationToLinkAsync(notificationType: string): Promise<Link>;
+    aggregateToLinkAsync(aggregateName: string, entityId: number, culture?: CultureInfo, loadPermissions?: boolean): Promise<Link>;
+    pageResourceToLinkAsync(page: string | number, culture: CultureInfo): Promise<Link>;
+    searchLinkAsync(): Promise<Readonly<Link>>;
+    private getVariableValueAsync;
+    private bindAsync;
+    private static applyEntityDefinitionVariables;
+}