@progress/sitefinity-webservices-sdk 0.3.1 → 1.0.3

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

@@ -0,0 +1,146 @@
+import { RequestFactory } from "./RequestFactory";
+import { ExecutableRequest } from "./ExecutableRequest";
+import { SDKOptions, Token, TypeOptions } from "../Sitefinity";
+import { RequestBase, RequestOptionsBaseExtended } from "./RequestBase";
+import { CreateRelatedRequestOptions, RequestOptionsBase, PropertyRequestOptions, SingleRelatedItemRequestOptions, CreateRequestOptions, UpdateRequestOptions } from "../Data";
+/**
+ * The transaction class is used to group operations that involve data manipulation together and execute them as a single atomic operation.
+ */
+export declare class Transaction {
+    id: number;
+    counter: number;
+    requests: TransactionRequest[];
+    private urlOptions;
+    private factory;
+    constructor(urlOptions: TypeOptions, factory: RequestFactory);
+    upload(parameters: any): number;
+    /**
+    * Adds a POST request to create a single item.
+    */
+    create(parameters: BatchCreateRequestOptions): number;
+    /**
+    * Adds a POST request to execute an operation on single item.
+    */
+    operation(parameters: BatchCreateRequestOptions): void;
+    /**
+    * Adds a PATCH request to update a single item.
+    */
+    update(parameters: BatchUpdateRequestOptions): void;
+    /**
+    * Adds a DELETE request to delete a single item.
+    */
+    destroy(parameters: BatchSingleItemRequestOptions): void;
+    /**
+    * Adds a DELETE request to delete all of the associated members in the relation property.
+    */
+    destroyRelated(parameters: BatchPropertyRequestOptions): void;
+    /**
+    * Adds a DELETE request to retrieve the a single entry of the associated members in the relation property.
+    */
+    destroyRelatedById(parameters: BatchSingleRelatedItemRequestOptions): void;
+    /**
+    * Adds a POST request to add a related item to the property collection.
+    */
+    createRelated(parameters: BatchCreateRelatedRequestOptions): number;
+    private overrideUrlGeneration;
+    private addRequest;
+    private urlParametersClone;
+}
+/**
+ * The batch request class is used for grouping requests into a single batch request to execute on the server.
+ */
+export declare class BatchRequest extends ExecutableRequest {
+    counter: number;
+    requests: BatchInnerRequest[];
+    private factory;
+    private boundary;
+    private responseHeaderRegex;
+    private responseStatusRegex;
+    static constants: {
+        newLine: string;
+    };
+    constructor(requestOptions: BatchRequestOptionsExtended, token: Token, sdkOptions: SDKOptions);
+    /**
+    * Adds a GET request to retrieve a collection of items.
+    */
+    get(parameters: BatchRequestOptionsBase): void;
+    /**
+    * Adds a GET request for the retrieval of a single item.
+    */
+    getSingle(parameters: BatchSingleItemRequestOptions): void;
+    /**
+    * Adds a GET request to get the property of a single item.
+    */
+    getProperty(parameters: BatchPropertyRequestOptions): void;
+    /**
+    * Adds a GET request to get the related property value of a single item.
+    */
+    getRelated(parameters: BatchPropertyRequestOptions): void;
+    /**
+    * Adds a GET request to retrieve the related property value of a single item by the id of the related item.
+    */
+    getRelatedById(parameters: BatchSingleRelatedItemRequestOptions): void;
+    /**
+    * Begins a transaction.
+    */
+    beginTransaction(): Transaction;
+    /**
+    * Ends a transaction.
+    */
+    endTransaction(transaction: Transaction): void;
+    getBody(): object;
+    getMethod(): string;
+    getHeaders(): {
+        [key: string]: string;
+    };
+    buildUrl(): string;
+    protected parseResponse(http: XMLHttpRequest): any;
+    private parseBatchResponse;
+    private getResponseResult;
+    private currentBoundary;
+    private contentType;
+    private readTo;
+    private readLine;
+    private readHeaders;
+    private readResponse;
+    private buildRequestBody;
+    private buildRequest;
+    private buildTransaction;
+    private createDelimeter;
+    private createBoundary;
+    private addRequest;
+    private urlParametersClone;
+}
+interface TransactionRequest {
+    id: number;
+    request: RequestBase;
+}
+interface BatchInnerRequest {
+    id: number;
+    request: RequestBase | Transaction;
+}
+export interface BatchRequestOptionsExtended extends RequestOptionsBaseExtended {
+    factory: RequestFactory;
+}
+export interface BatchRequestOptionsBase extends RequestOptionsBase {
+    entitySet: string;
+}
+export interface BatchCreateRequestOptions extends CreateRequestOptions {
+    entitySet: string;
+}
+export interface BatchUpdateRequestOptions extends UpdateRequestOptions {
+    entitySet: string;
+}
+export interface BatchSingleItemRequestOptions extends RequestOptionsBase {
+    entitySet: string;
+}
+export interface BatchPropertyRequestOptions extends PropertyRequestOptions {
+    entitySet: string;
+}
+export interface BatchSingleRelatedItemRequestOptions extends SingleRelatedItemRequestOptions {
+    entitySet: string;
+}
+export interface BatchCreateRelatedRequestOptions extends CreateRelatedRequestOptions {
+    entitySet: string;
+}
+export {};

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

@@ -0,0 +1,20 @@
+import { RequestBase, RequestOptionsBaseExtended } from './RequestBase';
+import { SDKOptions, Token } from "../Sitefinity";
+export declare class ExecutableRequest extends RequestBase {
+    private token;
+    private enableUnlimitedChoices;
+    private integrationMode;
+    constructor(requestOptions: RequestOptionsBaseExtended, token: Token, sdkOptions: SDKOptions);
+    execute(): void;
+    private setHeaders;
+}
+export interface ResponseHandlers {
+    /**
+    * The success handler.
+    */
+    successCb?: Function;
+    /**
+    * The failure handler.
+    */
+    failureCb?: Function;
+}

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

@@ -0,0 +1,88 @@
+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 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;
+    };
+}

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

@@ -0,0 +1,28 @@
+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;
+    private action;
+    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 {
+    progressCb?: Function;
+    urlOptions: TypeOptions;
+}

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

@@ -0,0 +1,22 @@
+import { GetRequest, GetByIdRequest, CreateRequest, UpdateRequest, DeleteRequest, GetRelatedRequest, GetRelatedByIdRequest, DeleteRelatedRequest, DeleteRelatedByIdRequest, CreateRelatedRequest, UploadRequest, PostRequestOptionsExtended, PutRequestOptionsExtended, RelatedRequestOptionsExtended, RelatedByIdRequestOptionsExtended, UploadRequestOptionsExtended } from "./Request";
+import { SDKOptions, Token } from "../Sitefinity";
+import { BatchRequest } from "./BatchRequest";
+import { RequestOptionsBaseExtended } from "./RequestBase";
+export declare class RequestFactory {
+    token: Token;
+    private options;
+    constructor(options: SDKOptions);
+    get(parameters: RequestOptionsBaseExtended): GetRequest;
+    getSingle(parameters: RequestOptionsBaseExtended): GetByIdRequest;
+    create(parameters: PostRequestOptionsExtended): CreateRequest;
+    update(parameters: PutRequestOptionsExtended): UpdateRequest;
+    destroy(parameters: RequestOptionsBaseExtended): DeleteRequest;
+    getProperty(parameters: RelatedRequestOptionsExtended): GetRelatedRequest;
+    getRelated(parameters: RelatedRequestOptionsExtended): GetRelatedRequest;
+    getRelatedById(parameters: RelatedByIdRequestOptionsExtended): GetRelatedByIdRequest;
+    destroyRelated(parameters: RelatedRequestOptionsExtended): DeleteRelatedRequest;
+    destroyRelatedById(parameters: RelatedByIdRequestOptionsExtended): DeleteRelatedByIdRequest;
+    createRelated(parameters: RelatedRequestOptionsExtended): CreateRelatedRequest;
+    upload(parameters: UploadRequestOptionsExtended): UploadRequest;
+    batch(parameters: RequestOptionsBaseExtended): BatchRequest;
+}

package/dist/src/Sitefinity.d.ts

@@ -0,0 +1,66 @@
+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;
+    additionalQueryParams?: {
+        [key: string]: string;
+    };
+}
+export interface Token {
+    type: string;
+    value: string;
+}
+export {};

package/dist/src/WhereQuery.d.ts

@@ -0,0 +1,68 @@
+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>;
+    /**
+     * Ends the definition of the current WhereQuery. You need to call this method in order to continue with the definition of the parent {@link QueryBase}. All other `WhereQuery` methods return the current instance of `WhereQuery` to allow chaining.
+     */
+    done(): QueryType;
+    getExpression(): ComplexExpression;
+    private simple;
+    private addComplexExpression;
+}

package/dist/src/constants.d.ts

@@ -0,0 +1,55 @@
+export declare const EXPRESSION_TYPE: {
+    query: number;
+    where: number;
+    and: string;
+    or: string;
+    not: string;
+    eq: string;
+    ne: string;
+    lt: string;
+    le: string;
+    gt: string;
+    ge: string;
+    any: string;
+    contains: string;
+    startsWith: string;
+    endsWith: string;
+};
+export declare const ODATA_PARAMS: {
+    $filter: string;
+    $select: string;
+    $expand: string;
+    $orderby: string;
+    $skip: string;
+    $top: string;
+    $count: string;
+    $search: string;
+};
+export declare const SF_PARAMS: {
+    provider: string;
+    culture: string;
+    siteId: string;
+    fallbackParams: string;
+    parentId: string;
+};
+export declare const HEADER_NAMES: {
+    contentType: string;
+    authorization: string;
+    contentEncoding: string;
+    operation: string;
+    properties: string;
+    fileName: string;
+    serviceRequest: string;
+    choicesBinaryRepresentation: string;
+    integrationMode: string;
+};
+export declare const HTTP_METHODS: {
+    get: string;
+    put: string;
+    post: string;
+    patch: string;
+    delete: string;
+};
+export declare const CONTENT_TYPES: {
+    json: string;
+};

package/dist/src/utils.d.ts

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,29 @@
+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
+  })
+}