@progress/sitefinity-webservices-sdk 1.1.16 → 2.0.0

package/dist/src/Requests/Request.d.ts

@@ -1,132 +0,0 @@
-import { SDKOptions, Token } from "../Sitefinity";
-import { ExecutableRequest } from "./ExecutableRequest";
-import { RequestOptionsBaseExtended } from "./RequestBase";
-export declare class GetRequest extends ExecutableRequest {
-    constructor(requestOptions: RequestOptionsBaseExtended, token: Token, sdkOptions: SDKOptions);
-    getMethod(): string;
-}
-export declare class GetByIdRequest extends ExecutableRequest {
-    constructor(requestOptions: RequestOptionsBaseExtended, token: Token, sdkOptions: SDKOptions);
-    getMethod(): string;
-}
-export declare class DeleteRequest extends ExecutableRequest {
-    constructor(requestOptions: RequestOptionsBaseExtended, token: Token, sdkOptions: SDKOptions);
-    getMethod(): string;
-}
-export declare class UpdateRequest extends ExecutableRequest {
-    private data;
-    private saveTemp;
-    constructor(requestOptions: PutRequestOptionsExtended, token: Token, sdkOptions: SDKOptions);
-    getMethod(): string;
-    getBody(): object;
-    getHeaders(): {
-        [key: string]: string;
-    };
-}
-export declare class CreateRequest extends ExecutableRequest {
-    protected data: object;
-    constructor(requestOptions: PostRequestOptionsExtended, token: Token, sdkOptions: SDKOptions);
-    getMethod(): string;
-    getBody(): object;
-}
-export declare class GetRelatedRequest extends GetByIdRequest {
-    private property;
-    constructor(requestOptions: RelatedRequestOptionsExtended, token: Token, sdkOptions: SDKOptions);
-    buildUrl(): string;
-}
-export declare class GetRelatedByIdRequest extends GetByIdRequest {
-    private property;
-    private relatedId;
-    constructor(requestOptions: RelatedByIdRequestOptionsExtended, token: Token, sdkOptions: SDKOptions);
-    buildUrl(): string;
-}
-export declare class DeleteRelatedRequest extends DeleteRequest {
-    private property;
-    constructor(requestOptions: RelatedRequestOptionsExtended, token: Token, sdkOptions: SDKOptions);
-    buildUrl(): string;
-}
-export declare class DeleteRelatedByIdRequest extends DeleteRequest {
-    private property;
-    private relatedId;
-    constructor(requestOptions: RelatedByIdRequestOptionsExtended, token: Token, sdkOptions: SDKOptions);
-    buildUrl(): string;
-}
-export declare class CreateRelatedRequest extends CreateRequest {
-    private property;
-    constructor(requestOptions: RelatedRequestOptionsExtended, token: Token, sdkOptions: SDKOptions);
-    buildUrl(): string;
-}
-export declare class UploadRequest extends CreateRequest {
-    private fileName;
-    private uploadProperties;
-    private contentType;
-    constructor(requestOptions: UploadRequestOptionsExtended, token: Token, sdkOptions: SDKOptions);
-    getHeaders(): {
-        [key: string]: string;
-    };
-    getBody(): object;
-    getMethod(): string;
-}
-export declare class UploadChunkRequest extends CreateRequest {
-    contentType: string;
-    chunkOrdinal: number;
-    chunkSize: number;
-    chunkedFileUploadSessionId: string;
-    numberOfChunks: number;
-    positionInQueue: number;
-    blobStorageProviderName: string;
-    fileName: string;
-    constructor(requestOptions: UploadChunkRequestOptionsExtended, token: Token, sdkOptions: SDKOptions);
-    getHeaders(): {
-        [key: string]: string;
-    };
-    getBody(): object;
-    getMethod(): string;
-    protected executeProgressEvent(): void;
-}
-export declare class CommitChunksRequest extends CreateRequest {
-    constructor(requestOptions: CommitChunksRequestOptionsExtended, token: Token, sdkOptions: SDKOptions);
-    getMethod(): string;
-}
-export interface PostRequestOptionsExtended extends RequestOptionsBaseExtended {
-    data?: object;
-}
-export interface PutRequestOptionsExtended extends PostRequestOptionsExtended {
-    saveTemp: boolean;
-}
-export interface RelatedRequestOptionsExtended extends PostRequestOptionsExtended {
-    property: string;
-}
-export interface RelatedByIdRequestOptionsExtended extends RelatedRequestOptionsExtended {
-    relatedId: string;
-}
-export interface UploadRequestOptionsExtended extends PostRequestOptionsExtended {
-    fileName: string;
-    contentType: string;
-    uploadProperties: {
-        [key: string]: string;
-    };
-}
-export interface UploadChunkRequestOptionsExtended extends PostRequestOptionsExtended {
-    fileMimeType: string;
-    fileName: string;
-    chunkedFileUploadSessionId: string;
-    chunkSize: number;
-    chunkOrdinal: number;
-    numberOfChunks: number;
-    chunkBlob: Blob;
-    blobStorageProviderName: string;
-    positionOfChunkInQueue?: number;
-}
-export interface CommitChunksRequestOptionsExtended extends PostRequestOptionsExtended {
-    chunkedFileUploadSessionId: string;
-    blobStorageProviderName: string;
-    contentType: string;
-    fileTotalSize: number;
-    numberOfChunks: number;
-    fileName: string;
-    uploadProperties: {
-        [key: string]: string;
-    };
-    itemId?: string;
-}

package/dist/src/Requests/RequestBase.d.ts

@@ -1,27 +0,0 @@
-import { RequestOptionsBase } from "../Data";
-import { Query } from "../Query";
-import { TypeOptions } from "../Sitefinity";
-export declare class RequestBase {
-    successCb: Function;
-    failureCb: Function;
-    progressCb: Function;
-    key: string | number;
-    urlOptions: TypeOptions;
-    protected query: Query;
-    protected action: string;
-    private fallbackProperties;
-    constructor(options: RequestOptionsBaseExtended);
-    getQueryString(urlOptions: TypeOptions, query: Query): string;
-    getBody(): object;
-    getMethod(): string;
-    getHeaders(): {
-        [key: string]: string;
-    };
-    buildUrl(): string;
-    protected parseResponse(http: XMLHttpRequest): string | any;
-    protected addQueryParameters(url: string): string;
-    private getQueryParameters;
-}
-export interface RequestOptionsBaseExtended extends RequestOptionsBase {
-    urlOptions: TypeOptions;
-}

package/dist/src/Requests/request.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/Sitefinity.d.ts

@@ -1,75 +0,0 @@
-import { Data } from "./Data";
-import { Query } from "./Query";
-import { ResponseHandlers } from "./Requests/ExecutableRequest";
-import { BatchRequest } from "./Requests/BatchRequest";
-export declare class Sitefinity {
-    static Query: typeof Query;
-    private factory;
-    private baseUrl;
-    private siteId;
-    /**
-    * The constructor of the Sitefinity JavaScript SDK. This is the entry point for the SDK.
-    */
-    constructor(options: SDKOptions);
-    data(options: TypeOptions): Data;
-    batch(success?: Function, failure?: Function, progress?: Function, options?: TypeOptions): BatchRequest;
-    /**
-    * Sets the authentication token.
-    */
-    setToken(token: Token): void;
-}
-interface OptionsBase {
-    /**
-    * Your service url that points to the configured instance of Sitefinity service.
-    */
-    baseUrl?: string;
-    /**
-    * The ID of the site, for which the queries will be executed.
-    */
-    siteId?: string;
-}
-/**
-* Defines an object containing configuration options for the SDK object.
-*/
-export interface SDKOptions extends OptionsBase {
-    /**
-    * The global handlers for request execution
-    */
-    handlers?: ResponseHandlers;
-    enableUnlimitedChoices?: boolean;
-    integrationMode?: boolean;
-}
-/**
-* Defines an object containing configuration options related to a specific type.
-*/
-export interface TypeOptions extends OptionsBase {
-    /**
-    * The URL name of the type.
-    */
-    entitySet?: string;
-    /**
-    * The name of the provider. If empty the default provider for the site will be used.
-    */
-    provider?: string;
-    /**
-    * The name of the culture. If empty the default culture for the site will be used.
-    */
-    culture?: string;
-    /**
-    * Query params to be added to the request url.
-    */
-    additionalQueryParams?: {
-        [key: string]: string;
-    };
-    /**
-    * Headers to be added to the request.
-    */
-    additionalHeaders?: {
-        [key: string]: string;
-    };
-}
-export interface Token {
-    type: string;
-    value: string;
-}
-export {};

package/dist/src/Sitefinity.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/WhereQuery.d.ts

@@ -1,72 +0,0 @@
-import { ComplexExpression } from "./Expression";
-/**
- * A fluent API operation for creating a filter for a query by chaining different rules.
- */
-export declare class WhereQuery<QueryType> {
-    private parent;
-    private expression;
-    constructor(parent: QueryType, type?: string);
-    /**
-    * Adds an `and` clause to the current condition and returns it for further chaining.
-    */
-    and(): WhereQuery<WhereQuery<QueryType>>;
-    /**
-     * Adds an `or` clause to the current condition and returns it for further chaining.
-     */
-    or(): WhereQuery<WhereQuery<QueryType>>;
-    /**
-     * Adds an `any` clause to the current condition and returns it for further chaining.
-     */
-    any(): WhereQuery<WhereQuery<QueryType>>;
-    /**
-     * Adds a `not` clause to the current condition and returns it for further chaining.
-     */
-    not(): WhereQuery<WhereQuery<QueryType>>;
-    /**
-     * Adds a condition that a field must be equal to a specific value.
-     */
-    eq(parameter: string, constant: any): WhereQuery<QueryType>;
-    /**
-     * Adds a condition that a field must *not* be equal to a specific value.
-     */
-    ne(parameter: string, constant: any): WhereQuery<QueryType>;
-    /**
-     * Adds a condition that a field must be `greater than` a certain value. Applicable to Number, String, and Date fields.
-     */
-    gt(parameter: string, constant: any): WhereQuery<QueryType>;
-    /**
-     * Adds a condition that a field must be `greater than or equal` to a certain value. Applicable to Number, String, and Date fields.
-     */
-    gte(parameter: string, constant: any): WhereQuery<QueryType>;
-    /**
-     * Adds a condition that a field must be `less than` a certain value. Applicable to Number, String, and Date fields.
-     */
-    lt(parameter: string, constant: any): WhereQuery<QueryType>;
-    /**
-     * Adds a condition that a field must be `less than or equal` to a certain value. Applicable to Number, String, and Date fields.
-     */
-    lte(parameter: string, constant: any): WhereQuery<QueryType>;
-    /**
-     * Adds a condition that a field value must *start* with a specified string.
-     */
-    startsWith(parameter: string, constant: any, caseSensitive?: boolean): WhereQuery<QueryType>;
-    /**
-     * Adds a condition that a field value must *contain* a specified string.
-     */
-    contains(parameter: string, constant: any, caseSensitive?: boolean): WhereQuery<QueryType>;
-    /**
-     * Adds a condition that a field value must *end* with a specified string.
-     */
-    endsWith(parameter: string, constant: any, caseSensitive?: boolean): WhereQuery<QueryType>;
-    /**
-     * Adds a condition that specific values should be found in that field e.g. Id in (id1, id2, id3).
-     */
-    in(parameter: string, constant: any): WhereQuery<QueryType>;
-    /**
-     * Ends the definition of the current WhereQuery. You need to call this method in order to continue with the definition of the parent {@link Query}. All other `WhereQuery` methods return the current instance of `WhereQuery` to allow chaining.
-     */
-    done(): QueryType;
-    getExpression(): ComplexExpression;
-    private simple;
-    private addComplexExpression;
-}

package/dist/src/chunk-upload/chunk-upload.sdk.d.ts

@@ -1,295 +0,0 @@
-import { CreateRequestOptions } from "../Data";
-import { RequestFactory } from "../Requests/RequestFactory";
-import { TypeOptions } from "../Sitefinity";
-import { ChunkFileResult } from "./chunked-file-upload.utilities";
-/**
- * @description Entry point for all chunk upload related tasks
- * @export
- * @class ChunkUploadSdk
- */
-export declare class ChunkUploadSdk {
-    private urlOptions;
-    private factory;
-    constructor(urlOptions: TypeOptions, factory: RequestFactory);
-    /**
-     * @description Gets the needed information to start uploading chunks to the server
-     * @param {GetChunkUploadInfoRequestOptions} parameters
-     * @memberof ChunkUploadSdk
-     */
-    getChunkUploadInfo(parameters: GetChunkUploadInfoRequestOptions): void;
-    /**
-     * @description Sends a single chunk request to the server
-     * @param {UploadChunkRequestOptions} parameters
-     * @memberof ChunkUploadSdk
-     */
-    uploadChunk(parameters: UploadChunkRequestOptions): void;
-    /**
-     * @description Sends the commit chunks request to the server
-     * @param {CommitChunksRequestOptions} parameters
-     * @memberof ChunkUploadSdk
-     */
-    commitChunks(parameters: CommitChunksRequestOptions): void;
-    /**
-     * @description This request is intended to be used when something in the chunk upload process fails to delete the sent chunks
-     * @param {CleanUpChunksRequestOptions} parameters
-     * @memberof ChunkUploadSdk
-     */
-    cleanUpChunks(parameters: CleanUpChunksRequestOptions): void;
-    /**
-     * Chunks the provided file. If the file is a base64 string this method will convert it to a blob and then chunk it.
-     *
-     * @param {(Blob | string)} file
-     * @param {number} chunkSize
-     * @param {string} contentTypeMime
-     * @return {*} {ChunkFileResult}
-     * @memberof ChunkUploadService
-     */
-    chunkFile(file: Blob | string, chunkSize: number, contentTypeMime: string): ChunkFileResult;
-}
-/**
- * @description This interface shows the minimum data needed to create a single chunk upload request
- * @export
- * @interface UploadChunkRequestOptions
- * @extends {CreateRequestOptions}
- */
-export interface UploadChunkRequestOptions extends CreateRequestOptions {
-    /**
-     * @description the data needed to construct the request
-     * @type {{
-     *         fileMimeType: string;
-     *         chunkedFileUploadSessionId: string;
-     *         chunkSize: number;
-     *         chunkOrdinal: number;
-     *         numberOfChunks: number;
-     *         positionOfChunkInQueue?: number;
-     *         chunkBlob: Blob;
-     *         blobStorageProviderName: string;
-     *     }}
-     * @memberof UploadChunkRequestOptions
-     */
-    data: {
-        /**
-         * @description the file's mime type
-         * @type {string}
-         */
-        fileMimeType: string;
-        /**
-         * @description the file's name
-         * @type {string}
-         */
-        fileName: string;
-        /**
-         * @description the current chunk upload session Id
-         * @type {string}
-         */
-        chunkedFileUploadSessionId: string;
-        /**
-         * @description the chunk size in bytes
-         * @type {number}
-         */
-        chunkSize: number;
-        /**
-         * @description the chunk's ordinal
-         * @type {number}
-         */
-        chunkOrdinal: number;
-        /**
-         * @description the total number of chunks
-         * @type {number}
-         */
-        numberOfChunks: number;
-        /**
-         * @description Optional. The position of the chunk in the request queue, this property is used to calculate the progress of the upload
-         * @type {number}
-         */
-        positionOfChunkInQueue?: number;
-        /**
-         * @description The chunk data
-         * @type {Blob}
-         */
-        chunkBlob: Blob;
-        /**
-         * @description the target blob storage provider's name
-         * @type {string}
-         */
-        blobStorageProviderName: string;
-    };
-}
-/**
- * @description This interface shows the minimum data needed to create a commit chunks request
- * @export
- * @interface CommitChunksRequestOptions
- * @extends {CreateRequestOptions}
- */
-export interface CommitChunksRequestOptions extends CreateRequestOptions {
-    /**
-     * @description the data needed to construct the request
-     * @type {{
-     *         chunkedFileUploadSessionId: string;
-     *         contentType: string;
-     *         fileTotalSize: number;
-     *         numberOfChunks: number;
-     *         name: string;
-     *         blobStorageProviderName: string;
-     *         uploadProperties: { [key: string]: string };
-     *         itemId?: string;
-     *     }}
-     * @memberof CommitChunksRequestOptions
-     */
-    data: {
-        /**
-         * @description the current chunk upload session Id
-         * @type {string}
-         */
-        chunkedFileUploadSessionId: string;
-        /**
-         * @description the file's mime type
-         * @type {string}
-         */
-        contentType: string;
-        /**
-         * @description the total size of the file
-         * @type {number}
-         */
-        fileTotalSize: number;
-        /**
-         * @description the total number of chunks
-         * @type {number}
-         */
-        numberOfChunks: number;
-        /**
-         * @description the file's name
-         * @type {string}
-         */
-        name: string;
-        /**
-         * @description the target blob storage provider's name
-         * @type {string}
-         */
-        blobStorageProviderName: string;
-        /**
-         * @description the properties of the uploaded file like the Title, UrlName, etc
-         * @type {{ [key: string]: string }}
-         */
-        uploadProperties: {
-            [key: string]: string;
-        };
-        /**
-         * @description Optional. Used when updating a media item, can be null when used to create a new media file.
-         * @type {string}
-         */
-        itemId?: string;
-    };
-}
-/**
- * @description This interface shows the minimum data needed to create request to get the chunk upload information for the current library from the server
- * @export
- * @interface GetChunkUploadInfoRequestOptions
- * @extends {CreateRequestOptions}
- */
-export interface GetChunkUploadInfoRequestOptions extends CreateRequestOptions {
-    /**
-     * @description the data needed to construct the request
-     * @type {{
-     *         libraryId: string;
-     *     }}
-     * @memberof GetChunkUploadInfoRequestOptions
-     */
-    data: {
-        /**
-         * @description the parent library (not folder) in which the file will be uploaded to
-         * @type {string}
-         */
-        libraryId: string;
-    };
-}
-/**
- * @description This interface show the minimum data needed to create a request to delete all chunk from a chunk upload session
- * @export
- * @interface CleanUpChunksRequestOptions
- * @extends {CreateRequestOptions}
- */
-export interface CleanUpChunksRequestOptions extends CreateRequestOptions {
-    /**
-     * @description the data needed to construct the request
-     * @type {{
-     *         chunkedFileUploadSessionId: string;
-     *         blobStorageProviderName: string;
-     *     }}
-     * @memberof CleanUpChunksRequestOptions
-     */
-    data: {
-        /**
-         * @description the current chunk upload session Id
-         * @type {string}
-         */
-        chunkedFileUploadSessionId: string;
-        /**
-         * @description the target blob storage provider's name
-         * @type {string}
-         */
-        blobStorageProviderName: string;
-    };
-}
-/**
- * @description This is a data transfer object that shows the information provided by the getChunkUploadInfo request
- * @export
- * @interface ChunkUploadInfoDTO
- */
-export interface ChunkUploadInfoDTO {
-    /**
-     * @description shows wether the current blob storage provider supports uploading in chunks
-     * @type {boolean}
-     * @memberof ChunkUploadInfoDTO
-     */
-    ProviderSupportsChunkUpload: boolean;
-    /**
-     * @description the target blob storage provider's name
-     * @type {string}
-     * @memberof ChunkUploadInfoDTO
-     */
-    BlobStorageProviderName: string;
-    /**
-     * @description the current chunk upload session Id
-     * @type {string}
-     * @memberof ChunkUploadInfoDTO
-     */
-    ChunkedFileUploadSessionId: string;
-    /**
-     * @description the chunk size in bytes
-     * @type {number}
-     * @memberof ChunkUploadInfoDTO
-     */
-    ChunkSize: number;
-    /**
-     * @description the maximum amount of time a chunk should be retired
-     * @type {number}
-     * @memberof ChunkUploadInfoDTO
-     */
-    MaxRetryCountForChunk: number;
-    /**
-     * @description the maximum simultaneous requests that should be sent to the server
-     * @type {number}
-     * @memberof ChunkUploadInfoDTO
-     */
-    MaxSimultaneousChunkUploadRequestsPerSession: number;
-}
-/**
- * @description A DTO containing the data that the server responds with when a chunk is uploaded
- * @export
- * @interface ChunkUploadResult
- */
-export interface ChunkUploadResult {
-    /**
-     * @description indicates whether the chunk has been successfully uploaded
-     * @type {boolean}
-     * @memberof ChunkUploadResult
-     */
-    SuccessfullyUploaded: boolean;
-    /**
-     * @description the current chunk upload session Id
-     * @type {string}
-     * @memberof ChunkUploadResult
-     */
-    ChunkedFileUploadSessionId: string;
-}

package/dist/src/chunk-upload/chunk-upload.sdk.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/chunk-upload/chunked-file-upload.utilities.d.ts

@@ -1,13 +0,0 @@
-export declare class ChunkedFileUploadUtilities {
-    chunkFile(file: Blob | string, chunkSize: number, contentTypeMime: string): ChunkFileResult;
-    private base64ToBlob;
-}
-export interface FileUploadChunk {
-    ordinal: number;
-    content: Blob;
-}
-export interface ChunkFileResult {
-    chunks: Array<FileUploadChunk>;
-    totalChunksCount: number;
-    fileTotalSize: number;
-}

package/dist/src/utils.d.ts

@@ -1,16 +0,0 @@
-export declare class utils {
-    static isString(obj: any): boolean;
-    static isBoolean(obj: any): boolean;
-    static isBlob(obj: any): boolean;
-    static isNumber(value: any): boolean;
-    static isFunction(func: any): boolean;
-    static serializeToJSON(data: any): string;
-    static parseStringToJson(data: any): any;
-    static convertDateFieldToISOString(data: object): object;
-    static hex16(): string;
-    static addTrailingSlash(url: string): string;
-    static removeSlashes(url: string): string;
-    static clone(from: any, to?: {}, action?: Function): any;
-    private static _parseDateProperties;
-    private static _tryFormatFieldToDate;
-}

package/karma.conf.js

@@ -1,29 +0,0 @@
-module.exports = (config) => {
-  config.set({
-    frameworks: [ 'jasmine-ajax', 'jasmine', 'karma-typescript' ],
-    plugins: [
-      'karma-jasmine',
-      'karma-chrome-launcher',
-      'karma-jasmine-ajax',
-      'karma-typescript',
-      'karma-spec-reporter'
-    ],
-    karmaTypescriptConfig: {
-      tsconfig: "./tsconfig.json",
-    },
-    client: {
-      // leave Jasmine Spec Runner output visible in browser
-      clearContext: false
-    },
-    files: [ { pattern: 'src/**/*.ts' } ],
-    preprocessors: {
-      'src/**/*.ts': [ 'karma-typescript' ]
-    },
-    reporters: [ 'spec', 'karma-typescript' ],
-    colors: true,
-    logLevel: config.LOG_INFO,
-    autoWatch: true,
-    browsers: ["Chrome"],
-    singleRun: config.single_run
-  })
-}

package/sitefinity-webservices-sdk.ts

@@ -1,15 +0,0 @@
-export * from "./src/BlobBuilder";
-export * from "./src/constants";
-export * from "./src/utils";
-export * from "./src/WhereQuery";
-export * from "./src/Sitefinity";
-export * from "./src/QueryBuilder";
-export * from "./src/Query";
-export * from "./src/OrderProperty";
-export * from "./src/Expression";
-export * from "./src/Data";
-export * from "./src/Requests/BatchRequest";
-export * from "./src/Requests/ExecutableRequest";
-export * from "./src/Requests/Request";
-export * from "./src/Requests/RequestBase";
-export * from "./src/Requests/RequestFactory";