@sitecore/sc-contenthub-webclient-sdk 0.9.7

package/dist/contracts/querying/minimal-schema.js

@@ -0,0 +1,48 @@
+"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);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MinimalSchema = void 0;
+const ta_json_1 = require("ta-json");
+const guard_1 = __importDefault(require("../../guard"));
+const property_data_1 = require("./property-data");
+const relation_data_1 = require("./relation-data");
+let MinimalSchema = class MinimalSchema {
+    constructor(name) {
+        if (name != null) {
+            guard_1.default.stringNotNullOrEmpty(name);
+            this.definitionName = name;
+        }
+        this.properties = [];
+        this.relations = [];
+    }
+};
+__decorate([
+    ta_json_1.JsonProperty("definition_name"),
+    __metadata("design:type", String)
+], MinimalSchema.prototype, "definitionName", void 0);
+__decorate([
+    ta_json_1.JsonProperty("properties"),
+    ta_json_1.JsonElementType(property_data_1.PropertyData),
+    __metadata("design:type", Array)
+], MinimalSchema.prototype, "properties", void 0);
+__decorate([
+    ta_json_1.JsonProperty("relations"),
+    ta_json_1.JsonElementType(relation_data_1.RelationData),
+    __metadata("design:type", Array)
+], MinimalSchema.prototype, "relations", void 0);
+MinimalSchema = __decorate([
+    ta_json_1.JsonObject(),
+    __metadata("design:paramtypes", [String])
+], MinimalSchema);
+exports.MinimalSchema = MinimalSchema;

package/dist/contracts/querying/property-data.d.ts

@@ -0,0 +1,8 @@
+export declare class PropertyData {
+    name: string;
+    isMultilingual: boolean;
+    isMultiValue: boolean;
+    hasDataSource: boolean;
+    dataType: string;
+    constructor(init?: Partial<PropertyData>);
+}

package/dist/contracts/querying/property-data.js

@@ -0,0 +1,43 @@
+"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.PropertyData = void 0;
+const ta_json_1 = require("ta-json");
+let PropertyData = class PropertyData {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+};
+__decorate([
+    ta_json_1.JsonProperty("name"),
+    __metadata("design:type", String)
+], PropertyData.prototype, "name", void 0);
+__decorate([
+    ta_json_1.JsonProperty("multilingual"),
+    __metadata("design:type", Boolean)
+], PropertyData.prototype, "isMultilingual", void 0);
+__decorate([
+    ta_json_1.JsonProperty("multivalue"),
+    __metadata("design:type", Boolean)
+], PropertyData.prototype, "isMultiValue", void 0);
+__decorate([
+    ta_json_1.JsonProperty("datasource"),
+    __metadata("design:type", Boolean)
+], PropertyData.prototype, "hasDataSource", void 0);
+__decorate([
+    ta_json_1.JsonProperty("type"),
+    __metadata("design:type", String)
+], PropertyData.prototype, "dataType", void 0);
+PropertyData = __decorate([
+    ta_json_1.JsonObject(),
+    __metadata("design:paramtypes", [Object])
+], PropertyData);
+exports.PropertyData = PropertyData;

package/dist/contracts/querying/property-load-option.d.ts

@@ -0,0 +1,30 @@
+import { ILoadOption } from "./load-option";
+import { LoadOption } from "./load-options";
+/**
+ * Specifies which properties to load.
+ */
+export interface IPropertyLoadOption extends ILoadOption {
+    /**
+     * Gets a list of properties that need to be loaded.
+     * This is only useful when {@link LoadOption} is {@link LoadOption.Custom}.
+     */
+    properties: Array<string>;
+    /**
+     * Creates a deep clone of this instance.
+     */
+    deepClone(): IPropertyLoadOption;
+}
+export declare class PropertyLoadOption implements IPropertyLoadOption {
+    /**
+     * Load no properties.
+     */
+    static readonly None: Readonly<IPropertyLoadOption>;
+    /**
+     * Load all properties.
+     */
+    static readonly All: Readonly<IPropertyLoadOption>;
+    loadOption: LoadOption;
+    properties: Array<string>;
+    constructor(param?: LoadOption | Array<string> | string | PropertyLoadOption);
+    deepClone(): IPropertyLoadOption;
+}

package/dist/contracts/querying/property-load-option.js

@@ -0,0 +1,70 @@
+"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);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var PropertyLoadOption_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyLoadOption = void 0;
+const ta_json_1 = require("ta-json");
+const guard_1 = __importDefault(require("../../guard"));
+const load_options_1 = require("./load-options");
+let PropertyLoadOption = PropertyLoadOption_1 = class PropertyLoadOption {
+    constructor(param) {
+        this.loadOption = load_options_1.LoadOption.None;
+        this.properties = [];
+        if (param == null) {
+            return;
+        }
+        else if (param instanceof PropertyLoadOption_1) {
+            this.loadOption = param.loadOption;
+            this.properties = [...param.properties];
+        }
+        else if (typeof param === "string") {
+            guard_1.default.stringNotNullOrEmpty(param);
+            this.loadOption = load_options_1.LoadOption.Custom;
+            this.properties = [param];
+        }
+        else if (param instanceof Array) {
+            guard_1.default.arrayNotEmpty(param);
+            this.loadOption = load_options_1.LoadOption.Custom;
+            this.properties = [...param];
+        }
+        else {
+            this.loadOption = param;
+        }
+    }
+    deepClone() {
+        return ta_json_1.JSON.deserialize(ta_json_1.JSON.serialize(this), PropertyLoadOption_1);
+    }
+};
+/**
+ * Load no properties.
+ */
+PropertyLoadOption.None = new PropertyLoadOption_1(load_options_1.LoadOption.None);
+/**
+ * Load all properties.
+ */
+PropertyLoadOption.All = new PropertyLoadOption_1(load_options_1.LoadOption.All);
+__decorate([
+    ta_json_1.JsonProperty("load_option"),
+    __metadata("design:type", Number)
+], PropertyLoadOption.prototype, "loadOption", void 0);
+__decorate([
+    ta_json_1.JsonProperty("properties"),
+    ta_json_1.JsonElementType(String),
+    __metadata("design:type", Array)
+], PropertyLoadOption.prototype, "properties", void 0);
+PropertyLoadOption = PropertyLoadOption_1 = __decorate([
+    ta_json_1.JsonObject(),
+    __metadata("design:paramtypes", [Object])
+], PropertyLoadOption);
+exports.PropertyLoadOption = PropertyLoadOption;

package/dist/contracts/querying/query-iterator.d.ts

@@ -0,0 +1,18 @@
+import { Nullable } from "../../base-types";
+import { IIterator } from "./iterator";
+import { Query } from "./query";
+import { IQueryResult } from "./query-result";
+export interface IQueryIterator<T extends IQueryResult> extends IIterator<T> {
+    readonly current: Nullable<T>;
+}
+export declare abstract class QueryIteratorBase<T extends IQueryResult> implements IQueryIterator<T> {
+    private readonly _query;
+    current: Nullable<T>;
+    constructor(query: Query, result?: T);
+    canMoveNext(): boolean;
+    canMovePrevious(): boolean;
+    moveNextAsync(): Promise<boolean>;
+    movePreviousAsync(): Promise<boolean>;
+    reset(): void;
+    abstract getResultAsync(query: Query): Promise<T>;
+}

package/dist/contracts/querying/query-iterator.js

@@ -0,0 +1,54 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryIteratorBase = void 0;
+const guard_1 = __importDefault(require("../../guard"));
+const query_result_paging_manager_1 = require("./query-result-paging-manager");
+class QueryIteratorBase {
+    constructor(query, result) {
+        guard_1.default.notNullOrUndefined(query);
+        this._query = query; //TODO deep copy
+        if (result != null) {
+            this.current = result;
+        }
+    }
+    canMoveNext() {
+        return query_result_paging_manager_1.QueryResultPagingManager.canMoveNext(this.current);
+    }
+    canMovePrevious() {
+        return query_result_paging_manager_1.QueryResultPagingManager.canMovePrevious(this.current);
+    }
+    moveNextAsync() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.canMoveNext())
+                return false;
+            this._query.skip = query_result_paging_manager_1.QueryResultPagingManager.getOffsetNextPage(this.current);
+            this.current = yield this.getResultAsync(this._query);
+            return true;
+        });
+    }
+    movePreviousAsync() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.canMovePrevious())
+                return false;
+            this._query.skip = query_result_paging_manager_1.QueryResultPagingManager.getOffsetPreviousPage(this.current);
+            this.current = yield this.getResultAsync(this._query);
+            return true;
+        });
+    }
+    reset() {
+        this.current = null;
+    }
+}
+exports.QueryIteratorBase = QueryIteratorBase;

package/dist/contracts/querying/query-load-configuration.d.ts

@@ -0,0 +1,39 @@
+import { Nullable } from "../../base-types";
+import { ICultureLoadOption } from "./culture-load-option";
+import { IPropertyLoadOption } from "./property-load-option";
+import { IRelationLoadOption } from "./relation-load-option";
+/**
+ * Represents a loading configuration for querying ids or entities.
+ */
+export interface IQueryLoadConfiguration {
+    /**
+     * Gets a value specifying whether entities or ids need to be returned.
+     * When false, no entities will be loaded and the load options will be ignored.
+     */
+    loadEntities: boolean;
+    /**
+     * Gets the culture load option.
+     */
+    cultureLoadOption: Nullable<ICultureLoadOption>;
+    /**
+     * Gets the property load option.
+     */
+    propertyLoadOption: Nullable<IPropertyLoadOption>;
+    /**
+     * Gets the relation load option.
+     */
+    relationLoadOption: Nullable<IRelationLoadOption>;
+}
+export declare class QueryLoadConfiguration {
+    loadEntities: boolean;
+    cultureLoadOption: Nullable<ICultureLoadOption>;
+    propertyLoadOption: Nullable<IPropertyLoadOption>;
+    relationLoadOption: Nullable<IRelationLoadOption>;
+    static Ids: Readonly<IQueryLoadConfiguration>;
+    static Minimal: Readonly<IQueryLoadConfiguration>;
+    static Default: Readonly<IQueryLoadConfiguration>;
+    static DefaultCultureFull: Readonly<IQueryLoadConfiguration>;
+    static Full: Readonly<IQueryLoadConfiguration>;
+    constructor(init?: Partial<IQueryLoadConfiguration>);
+    deepClone(): IQueryLoadConfiguration;
+}

package/dist/contracts/querying/query-load-configuration.js

@@ -0,0 +1,86 @@
+"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);
+};
+var QueryLoadConfiguration_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryLoadConfiguration = void 0;
+const ta_json_1 = require("ta-json");
+const culture_load_option_1 = require("./culture-load-option");
+const property_load_option_1 = require("./property-load-option");
+const relation_load_option_1 = require("./relation-load-option");
+let QueryLoadConfiguration = QueryLoadConfiguration_1 = class QueryLoadConfiguration {
+    //#endregion
+    constructor(init) {
+        this.loadEntities = false;
+        Object.assign(this, init);
+        if (init != null && init.loadEntities == null) {
+            this.loadEntities = true;
+        }
+    }
+    deepClone() {
+        const result = new QueryLoadConfiguration_1();
+        result.loadEntities = this.loadEntities;
+        result.cultureLoadOption = this.cultureLoadOption && this.cultureLoadOption.deepClone();
+        result.propertyLoadOption = this.propertyLoadOption && this.propertyLoadOption.deepClone();
+        result.relationLoadOption = this.relationLoadOption && this.relationLoadOption.deepClone();
+        return result;
+    }
+};
+//#region Configurations
+QueryLoadConfiguration.Ids = new QueryLoadConfiguration_1({
+    cultureLoadOption: culture_load_option_1.CultureLoadOption.None,
+    propertyLoadOption: property_load_option_1.PropertyLoadOption.None,
+    relationLoadOption: relation_load_option_1.RelationLoadOption.None,
+    loadEntities: false,
+});
+QueryLoadConfiguration.Minimal = new QueryLoadConfiguration_1({
+    cultureLoadOption: culture_load_option_1.CultureLoadOption.None,
+    propertyLoadOption: property_load_option_1.PropertyLoadOption.None,
+    relationLoadOption: relation_load_option_1.RelationLoadOption.None,
+});
+QueryLoadConfiguration.Default = new QueryLoadConfiguration_1({
+    cultureLoadOption: culture_load_option_1.CultureLoadOption.Default,
+    propertyLoadOption: property_load_option_1.PropertyLoadOption.All,
+    relationLoadOption: relation_load_option_1.RelationLoadOption.None,
+});
+QueryLoadConfiguration.DefaultCultureFull = new QueryLoadConfiguration_1({
+    cultureLoadOption: culture_load_option_1.CultureLoadOption.Default,
+    propertyLoadOption: property_load_option_1.PropertyLoadOption.All,
+    relationLoadOption: relation_load_option_1.RelationLoadOption.All,
+});
+QueryLoadConfiguration.Full = new QueryLoadConfiguration_1({
+    cultureLoadOption: culture_load_option_1.CultureLoadOption.All,
+    propertyLoadOption: property_load_option_1.PropertyLoadOption.All,
+    relationLoadOption: relation_load_option_1.RelationLoadOption.All,
+});
+__decorate([
+    ta_json_1.JsonProperty("load_entities"),
+    __metadata("design:type", Boolean)
+], QueryLoadConfiguration.prototype, "loadEntities", void 0);
+__decorate([
+    ta_json_1.JsonProperty("culture_option"),
+    ta_json_1.JsonType(culture_load_option_1.CultureLoadOption),
+    __metadata("design:type", Object)
+], QueryLoadConfiguration.prototype, "cultureLoadOption", void 0);
+__decorate([
+    ta_json_1.JsonProperty("property_option"),
+    ta_json_1.JsonType(property_load_option_1.PropertyLoadOption),
+    __metadata("design:type", Object)
+], QueryLoadConfiguration.prototype, "propertyLoadOption", void 0);
+__decorate([
+    ta_json_1.JsonProperty("relation_option"),
+    ta_json_1.JsonType(relation_load_option_1.RelationLoadOption),
+    __metadata("design:type", Object)
+], QueryLoadConfiguration.prototype, "relationLoadOption", void 0);
+QueryLoadConfiguration = QueryLoadConfiguration_1 = __decorate([
+    ta_json_1.JsonObject(),
+    __metadata("design:paramtypes", [Object])
+], QueryLoadConfiguration);
+exports.QueryLoadConfiguration = QueryLoadConfiguration;

package/dist/contracts/querying/query-request.d.ts

@@ -0,0 +1,6 @@
+import { QueryLoadingResource } from "../../models/query-loading-resource";
+import { Query } from "./query";
+export declare class QueryRequest extends QueryLoadingResource {
+    query: Query;
+    constructor(init?: Partial<QueryRequest>);
+}

package/dist/contracts/querying/query-request.js

@@ -0,0 +1,30 @@
+"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.QueryRequest = void 0;
+const ta_json_1 = require("ta-json");
+const query_loading_resource_1 = require("../../models/query-loading-resource");
+const query_1 = require("./query");
+let QueryRequest = class QueryRequest extends query_loading_resource_1.QueryLoadingResource {
+    constructor(init) {
+        super();
+        Object.assign(this, init);
+    }
+};
+__decorate([
+    ta_json_1.JsonProperty("Query"),
+    __metadata("design:type", query_1.Query)
+], QueryRequest.prototype, "query", void 0);
+QueryRequest = __decorate([
+    ta_json_1.JsonObject(),
+    __metadata("design:paramtypes", [Object])
+], QueryRequest);
+exports.QueryRequest = QueryRequest;

package/dist/contracts/querying/query-result-paging-manager.d.ts

@@ -0,0 +1,9 @@
+import { Nullable } from "../../base-types";
+import { IQueryResult } from "./query-result";
+export declare class QueryResultPagingManager {
+    static canMovePrevious(queryResult: Nullable<IQueryResult>): boolean;
+    static canMoveNext(queryResult: Nullable<IQueryResult>): boolean;
+    static getOffsetPreviousPage(queryResult: Nullable<IQueryResult>): number;
+    static getOffsetNextPage(queryResult: Nullable<IQueryResult>): number;
+    static getIterationPageSize(queryResult: Nullable<IQueryResult>): number;
+}

package/dist/contracts/querying/query-result-paging-manager.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryResultPagingManager = void 0;
+const defaults_1 = require("../../constants/defaults");
+class QueryResultPagingManager {
+    static canMovePrevious(queryResult) {
+        return !!queryResult && queryResult.offset > 0;
+    }
+    static canMoveNext(queryResult) {
+        return (!queryResult || QueryResultPagingManager.getOffsetNextPage(queryResult) < queryResult.totalNumberOfResults);
+    }
+    static getOffsetPreviousPage(queryResult) {
+        return Math.max(queryResult != null ? queryResult.offset - queryResult.items.length : 0, 0);
+    }
+    static getOffsetNextPage(queryResult) {
+        return Math.max(queryResult != null ? queryResult.offset + queryResult.items.length : 0, 0);
+    }
+    static getIterationPageSize(queryResult) {
+        return !queryResult || queryResult.items.length === 0 ? defaults_1.ITERATING.pageSize : queryResult.items.length;
+    }
+}
+exports.QueryResultPagingManager = QueryResultPagingManager;

package/dist/contracts/querying/query-result.d.ts

@@ -0,0 +1,5 @@
+export interface IQueryResult<T = unknown> {
+    items: Array<T>;
+    totalNumberOfResults: number;
+    offset: number;
+}

package/dist/contracts/querying/query-result.js

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

package/dist/contracts/querying/query-sort-order.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Sorting order.
+ */
+export declare enum QuerySortOrder {
+    /**
+     * Descending.
+     */
+    Desc = 0,
+    /**
+     * Ascending.
+     */
+    Asc = 1
+}

package/dist/contracts/querying/query-sort-order.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuerySortOrder = void 0;
+/**
+ * Sorting order.
+ */
+var QuerySortOrder;
+(function (QuerySortOrder) {
+    /**
+     * Descending.
+     */
+    QuerySortOrder[QuerySortOrder["Desc"] = 0] = "Desc";
+    /**
+     * Ascending.
+     */
+    QuerySortOrder[QuerySortOrder["Asc"] = 1] = "Asc";
+})(QuerySortOrder = exports.QuerySortOrder || (exports.QuerySortOrder = {}));

package/dist/contracts/querying/query.d.ts

@@ -0,0 +1,23 @@
+import { QueryLoadingResource } from "../../models/query-loading-resource";
+import { QueryFilter } from "./filters/query-filter";
+import { Sorting } from "./sorting";
+export declare class Query extends QueryLoadingResource {
+    filter: QueryFilter;
+    /**
+     * The number of items to skip. If not specified, no items will be skipped.
+     */
+    skip: number;
+    /**
+     * The number of items to take. If not specified, the underlying implementation will use a default value.
+     */
+    take: number;
+    /**
+     * Indicates how the results should be sorted.
+     */
+    sorting: Array<Sorting>;
+    /**
+     * If specified, the query will return as {@link QueryResult#scrollId}, which can be used to walk through the set of results without having to use paging.
+     */
+    scrollTime?: Date;
+    constructor(init?: Partial<Query>);
+}

package/dist/contracts/querying/query.js

@@ -0,0 +1,56 @@
+"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.Query = void 0;
+const ta_json_1 = require("ta-json");
+const query_loading_resource_1 = require("../../models/query-loading-resource");
+const query_filter_1 = require("./filters/query-filter");
+const sorting_1 = require("./sorting");
+let Query = class Query extends query_loading_resource_1.QueryLoadingResource {
+    constructor(init) {
+        super();
+        /**
+         * The number of items to skip. If not specified, no items will be skipped.
+         */
+        this.skip = 0;
+        /**
+         * The number of items to take. If not specified, the underlying implementation will use a default value.
+         */
+        this.take = 50;
+        Object.assign(this, init);
+    }
+};
+__decorate([
+    ta_json_1.JsonProperty("filter"),
+    __metadata("design:type", query_filter_1.QueryFilter)
+], Query.prototype, "filter", void 0);
+__decorate([
+    ta_json_1.JsonProperty("skip"),
+    __metadata("design:type", Number)
+], Query.prototype, "skip", void 0);
+__decorate([
+    ta_json_1.JsonProperty("take"),
+    __metadata("design:type", Number)
+], Query.prototype, "take", void 0);
+__decorate([
+    ta_json_1.JsonProperty("sorting"),
+    ta_json_1.JsonElementType(sorting_1.Sorting),
+    __metadata("design:type", Array)
+], Query.prototype, "sorting", void 0);
+__decorate([
+    ta_json_1.JsonProperty("scroll_time"),
+    __metadata("design:type", Date)
+], Query.prototype, "scrollTime", void 0);
+Query = __decorate([
+    ta_json_1.JsonObject(),
+    __metadata("design:paramtypes", [Object])
+], Query);
+exports.Query = Query;

package/dist/contracts/querying/relation-data.d.ts

@@ -0,0 +1,7 @@
+import { RelationCardinality, RelationRole } from "../base";
+export declare class RelationData {
+    name: string;
+    cardinality: RelationCardinality;
+    role: RelationRole;
+    constructor(init?: Partial<RelationData>);
+}

package/dist/contracts/querying/relation-data.js

@@ -0,0 +1,38 @@
+"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.RelationData = void 0;
+const ta_json_1 = require("ta-json");
+const minimal_schema_relation_cardinality_converter_1 = require("../../converters/minimal-schema-relation-cardinality-converter");
+const base_1 = require("../base");
+let RelationData = class RelationData {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+};
+__decorate([
+    ta_json_1.JsonProperty("name"),
+    __metadata("design:type", String)
+], RelationData.prototype, "name", void 0);
+__decorate([
+    ta_json_1.JsonProperty("cardinality"),
+    ta_json_1.JsonConverter(minimal_schema_relation_cardinality_converter_1.MinimalSchemaRelationCardinalityConverter),
+    __metadata("design:type", Number)
+], RelationData.prototype, "cardinality", void 0);
+__decorate([
+    ta_json_1.JsonProperty("role"),
+    __metadata("design:type", Number)
+], RelationData.prototype, "role", void 0);
+RelationData = __decorate([
+    ta_json_1.JsonObject(),
+    __metadata("design:paramtypes", [Object])
+], RelationData);
+exports.RelationData = RelationData;