@progress/sitefinity-webservices-sdk 1.1.16 → 2.0.0

package/sitefinity-webservices-sdk.mjs

@@ -0,0 +1,124 @@
+import {
+  FetchTransport
+} from "./esm/chunks/chunk-QPSEKUOI.mjs";
+import "./esm/chunks/chunk-L3IMDFA5.mjs";
+import {
+  Sitefinity
+} from "./esm/chunks/chunk-VWT2RJET.mjs";
+import {
+  RequestFactory
+} from "./esm/chunks/chunk-AHDZ2CWQ.mjs";
+import {
+  BatchRequest,
+  Transaction
+} from "./esm/chunks/chunk-PXPK2IV6.mjs";
+import {
+  CommitChunksRequest,
+  CreateRelatedRequest,
+  CreateRequest,
+  DeleteRelatedByIdRequest,
+  DeleteRelatedRequest,
+  DeleteRequest,
+  GetByIdRequest,
+  GetRelatedByIdRequest,
+  GetRelatedRequest,
+  GetRequest,
+  UpdateRequest,
+  UploadChunkRequest,
+  UploadRequest
+} from "./esm/chunks/chunk-PI55MBSL.mjs";
+import {
+  ExecutableRequest
+} from "./esm/chunks/chunk-FUFBYOIF.mjs";
+import {
+  XhrTransport
+} from "./esm/chunks/chunk-WX5J7F5D.mjs";
+import {
+  RequestBase
+} from "./esm/chunks/chunk-TTVNTTW5.mjs";
+import {
+  BlobBuilder
+} from "./esm/chunks/chunk-W2OWM3L7.mjs";
+import {
+  Data
+} from "./esm/chunks/chunk-NNYY2VBC.mjs";
+import {
+  ChunkUploadSdk
+} from "./esm/chunks/chunk-VLDX2FH2.mjs";
+import {
+  ChunkedFileUploadUtilities
+} from "./esm/chunks/chunk-EH4CERVO.mjs";
+import {
+  Query
+} from "./esm/chunks/chunk-J2B7UDVZ.mjs";
+import {
+  QueryBase
+} from "./esm/chunks/chunk-CMGV26CS.mjs";
+import {
+  QueryBuilder
+} from "./esm/chunks/chunk-DHWDJAGV.mjs";
+import {
+  WhereQuery
+} from "./esm/chunks/chunk-BFLQBM7R.mjs";
+import {
+  CONTENT_TYPES,
+  EXPRESSION_TYPE,
+  HEADER_NAMES,
+  HTTP_METHODS,
+  ODATA_PARAMS,
+  SF_PARAMS
+} from "./esm/chunks/chunk-RQAAYOY6.mjs";
+import {
+  BinaryExpression,
+  ComplexExpression,
+  ExpressionBase
+} from "./esm/chunks/chunk-F4CWOE7M.mjs";
+import {
+  OrderProperty
+} from "./esm/chunks/chunk-YB2LMPUX.mjs";
+import {
+  utils
+} from "./esm/chunks/chunk-2ID24RPE.mjs";
+export {
+  BatchRequest,
+  BinaryExpression,
+  BlobBuilder,
+  CONTENT_TYPES,
+  ChunkUploadSdk,
+  ChunkedFileUploadUtilities,
+  CommitChunksRequest,
+  ComplexExpression,
+  CreateRelatedRequest,
+  CreateRequest,
+  Data,
+  DeleteRelatedByIdRequest,
+  DeleteRelatedRequest,
+  DeleteRequest,
+  EXPRESSION_TYPE,
+  ExecutableRequest,
+  ExpressionBase,
+  FetchTransport,
+  GetByIdRequest,
+  GetRelatedByIdRequest,
+  GetRelatedRequest,
+  GetRequest,
+  HEADER_NAMES,
+  HTTP_METHODS,
+  ODATA_PARAMS,
+  OrderProperty,
+  Query,
+  QueryBase,
+  QueryBuilder,
+  RequestBase,
+  RequestFactory,
+  SF_PARAMS,
+  Sitefinity,
+  Transaction,
+  UpdateRequest,
+  UploadChunkRequest,
+  UploadRequest,
+  WhereQuery,
+  XhrTransport,
+  utils
+};
+//# sourceMappingURL=sitefinity-webservices-sdk.mjs.map

package/sitefinity-webservices-sdk.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/src/BlobBuilder.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Incrementally builds a `Blob`, primarily for multipart batch MIME bodies.
+ *
+ * This is a low-level helper for advanced request construction.
+ */
+export declare class BlobBuilder {
+    private blob;
+    /** Appends a value to the blob being built. */
+    append(value: any): void;
+    /** Returns the accumulated blob content. */
+    build(): Blob;
+}

package/src/Data.d.ts

@@ -0,0 +1,259 @@
+import { ChunkUploadSdk } from "./chunk-upload/chunk-upload.sdk";
+import { Query } from "./Query";
+import { RequestFactory } from "./Requests/RequestFactory";
+import { TypeOptions } from "./Sitefinity";
+/**
+ * Client for issuing requests against one Sitefinity entity set.
+ */
+export declare class Data {
+    private urlOptions;
+    private factory;
+    /**
+     * Creates an entity-set data client.
+     *
+     * @param urlOptions Entity-set and request URL options.
+     * @param factory Internal request factory used to create SDK requests.
+     */
+    constructor(urlOptions: TypeOptions, factory: RequestFactory);
+    /**
+     * Returns the chunk-upload service for this entity set.
+     *
+     * Use it for uploads that must be sent in chunks and committed after all chunks
+     * complete. A new service instance is returned for each access.
+     *
+     * @returns The chunk-upload service.
+     */
+    get chunkUpload(): ChunkUploadSdk;
+    /**
+     * Executes a GET request to retrieve a collection of items.
+     *
+     * @param parameters Query, action, fallback-property, and callback options.
+     * @returns Nothing. The result is delivered to `successCb` or `failureCb`.
+     * @throws If request creation fails.
+     */
+    get(parameters: RequestOptionsBase): void;
+    /**
+     * Executes a GET request to retrieve operations for an item or its parent collection.
+     *
+     * When `key` is omitted, `parentId` is added to the operations URL.
+     *
+     * @param parameters Operation and callback options.
+     * @returns Nothing. The result is delivered to `successCb` or `failureCb`.
+     * @throws If the underlying request cannot be created.
+     */
+    getOperations(parameters: OperationsRequestOptions): void;
+    /**
+     * Executes a GET request for a single item.
+     *
+     * @param parameters Item key, query, action, and callback options.
+     * @returns Nothing. The item is delivered to `successCb` or `failureCb`.
+     * @throws If `key` is missing.
+     */
+    getSingle(parameters: RequestOptionsBase): void;
+    /**
+     * Executes a POST request for a single item.
+     *
+     * @param parameters Item data, optional key/action, and callbacks.
+     * @returns Nothing. The created item or error is delivered to a callback.
+     * @throws If `data` is missing.
+     */
+    create(parameters: CreateRequestOptions): void;
+    /**
+     * Executes a PATCH request to update a single item.
+     *
+     * @param parameters Item key, update data, optional temporary-save flag, and callbacks.
+     * @returns Nothing. The updated item or error is delivered to a callback.
+     * @throws If `key` or `data` is missing.
+     *
+     * @example
+     * const data = sf.data({
+     *     entitySet: "newsitems",
+     *     provider: "OpenAccessDataProvider",
+     *     culture: "en"
+     * });
+     *
+     * data.update({
+     *     key: "00000000-0000-0000-0000-000000000000",
+     *     data: { Title: "Updated news title" },
+     *     saveTemp: true,
+     *     successCb,
+     *     failureCb
+     * });
+     */
+    update(parameters: UpdateRequestOptions): void;
+    /**
+     * Executes a DELETE request to delete a single item.
+     *
+     * @param parameters Item key, optional action, and callbacks.
+     * @returns Nothing. The result is delivered to `successCb` or `failureCb`.
+     * @throws If `key` is missing.
+     */
+    destroy(parameters: RequestOptionsBase): void;
+    /**
+     * Executes a POST request to execute a workflow operation for a single item.
+     *
+     * @param parameters Item key, operation data, and callbacks.
+     * @returns Nothing. The operation result is delivered to a callback.
+     * @throws If `key` or `data` is missing.
+     */
+    operation(parameters: CreateRequestOptions): void;
+    /**
+     * Executes a GET request to retrieve a property of a single item.
+     *
+     * @param parameters Item key, property name, and callbacks.
+     * @returns Nothing. The property value is delivered to a callback.
+     * @throws If `key` or `property` is missing.
+     */
+    getProperty(parameters: PropertyRequestOptions): void;
+    /**
+     * Executes a GET request to retrieve a related property value of a single item.
+     *
+     * @param parameters Item key, relation property name, and callbacks.
+     * @returns Nothing. The related value is delivered to a callback.
+     * @throws If `key` or `property` is missing.
+     */
+    getRelated(parameters: PropertyRequestOptions): void;
+    /**
+     * Executes a GET request to retrieve a related item by its ID.
+     *
+     * @param parameters Item key, relation property, related item ID, and callbacks.
+     * @returns Nothing. The related item is delivered to a callback.
+     * @throws If `key`, `property`, or `relatedId` is missing.
+     */
+    getRelatedById(parameters: SingleRelatedItemRequestOptions): void;
+    /**
+     * Executes a DELETE request for all members associated with a relation property.
+     *
+     * @param parameters Item key, relation property, and callbacks.
+     * @returns Nothing. The result is delivered to `successCb` or `failureCb`.
+     * @throws If `key` or `property` is missing.
+     */
+    destroyRelated(parameters: PropertyRequestOptions): void;
+    /**
+     * Executes a DELETE request for one member of a relation property.
+     *
+     * @param parameters Item key, relation property, related item ID, and callbacks.
+     * @returns Nothing. The result is delivered to `successCb` or `failureCb`.
+     * @throws If `key`, `property`, or `relatedId` is missing.
+     */
+    destroyRelatedById(parameters: SingleRelatedItemRequestOptions): void;
+    /**
+     * Executes a POST request to add a related item to a property collection.
+     *
+     * @param parameters Item key, relation property, related item link, and callbacks.
+     * @returns Nothing. The result is delivered to `successCb` or `failureCb`.
+     * @throws If `key`, `property`, or `link` is missing.
+     */
+    createRelated(parameters: CreateRelatedRequestOptions): void;
+    /**
+     * Executes a POST request to upload a media item and optionally update or publish it.
+     *
+     * The SDK orchestrates the upload in a transaction. `content`, `contentType`, `name`,
+     * and `uploadProperties` are required. When `payload` is supplied, it updates the
+     * uploaded item; when `publish` is `true`, it then executes the `Publish` operation.
+     *
+     * @param parameters Upload data, optional post-upload payload, publish flag, and callbacks.
+     * @returns Nothing. The result is delivered to `successCb` or `failureCb`.
+     * @throws If required upload data is missing.
+     *
+     * @example
+     * const data = sf.data({ entitySet: "images" });
+     * data.upload({
+     *     data: {
+     *         content: "base64 file content",
+     *         contentType: "image/jpeg",
+     *         name: "test.jpg",
+     *         payload: { Title: "Test" },
+     *         uploadProperties: {
+     *             ParentId: "4BA7AD46-F29B-4E65-BE17-9BF7CE5BA1FB"
+     *         }
+     *     },
+     *     successCb,
+     *     failureCb
+     * });
+     */
+    upload(parameters: UploadRequestOptions): void;
+}
+/**
+ * Common query, URL-action, callback, and item-key options for data requests.
+ */
+export interface RequestOptionsBase {
+    /** OData query to apply to the request. */
+    query?: Query;
+    /** Optional action appended to the request URL. */
+    action?: string;
+    /** Called with the successful response payload. */
+    successCb?: Function;
+    /** Called with the failure payload, including the HTTP status when available. */
+    failureCb?: Function;
+    /** Called with the upload or request progress event when available. */
+    progressCb?: Function;
+    /** Additional property names requested for culture fallback. */
+    fallbackProperties?: string[];
+    /** Item key used by single-item and relation requests. */
+    key?: string | number;
+}
+/**
+ * Options for retrieving the operations available to an item or parent collection.
+ */
+export interface OperationsRequestOptions extends RequestOptionsBase {
+    /** Parent item ID used when retrieving collection operations without a `key`. */
+    parentId?: string;
+}
+/**
+ * Options for creating an item or executing an item operation.
+ */
+export interface CreateRequestOptions extends RequestOptionsBase {
+    /** Entity data sent in the request body. Required by `create` and `operation`. */
+    data?: object;
+}
+/**
+ * Options for updating an existing item.
+ */
+export interface UpdateRequestOptions extends CreateRequestOptions {
+    /** Saves the update as temporary data when true. */
+    saveTemp?: boolean;
+}
+/**
+ * Options for addressing an item property or relation.
+ */
+export interface PropertyRequestOptions extends RequestOptionsBase {
+    /** Relation or property name addressed by the request. */
+    property: string;
+}
+/**
+ * Options for addressing one item within a relation.
+ */
+export interface SingleRelatedItemRequestOptions extends PropertyRequestOptions {
+    /** ID of the related item addressed by the request. */
+    relatedId: string;
+}
+/**
+ * Options for adding an item to a relation.
+ */
+export interface CreateRelatedRequestOptions extends PropertyRequestOptions {
+    /** OData link or ID of the related item to add. */
+    link: string | number;
+}
+/**
+ * Options for uploading a media item and optionally updating or publishing it.
+ */
+export interface UploadRequestOptions extends CreateRequestOptions {
+    /** Upload content and metadata. */
+    data: {
+        /** Base64 or other content representation accepted by the upload endpoint. */
+        content: string;
+        /** MIME type of the uploaded file. */
+        contentType: string;
+        /** Upload-specific properties such as a media-library parent ID. */
+        uploadProperties: {
+            [key: string]: string;
+        };
+        /** File name sent to Sitefinity. */
+        name: string;
+        /** Properties applied to the uploaded item after upload. */
+        payload?: object;
+    };
+    /** Publishes the uploaded item after any payload update when true. */
+    publish?: boolean;
+}

package/src/Expression.d.ts

@@ -0,0 +1,37 @@
+/** Base node for a query filter expression. */
+export declare class ExpressionBase {
+    type: string;
+    /** Creates an expression node with the specified operator or logical type. */
+    constructor(type: string);
+    /** Returns this expression's operator or logical type. */
+    getType(): string;
+}
+/** A filter expression comparing one property with one constant value. */
+export declare class BinaryExpression extends ExpressionBase {
+    parameter: string;
+    constant: any;
+    caseSensitive: boolean;
+    /**
+     * Creates a comparison expression.
+     *
+     * @param type Supported comparison operator, such as `eq`, `ne`, or `contains`.
+     * @param parameter Property being tested.
+     * @param constant Value compared with the property.
+     * @param caseSensitive Whether string functions should preserve case.
+     */
+    constructor(type: string, parameter: string, constant: any, caseSensitive?: boolean);
+    /** Returns the property being compared. */
+    getParameter(): string;
+    /** Returns the comparison value. */
+    getConstant(): any;
+    /** Returns whether string matching preserves case. */
+    isCaseSensitive(): boolean;
+}
+/** A filter expression containing one or more child expression nodes. */
+export declare class ComplexExpression extends ExpressionBase {
+    private expressions;
+    /** Creates a logical expression containing the supplied child nodes. */
+    constructor(type: string, expressions: ExpressionBase[]);
+    /** Returns the child expressions in their current order. */
+    getExpressions(): ExpressionBase[];
+}

package/src/OrderProperty.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Represents one validated OData order-by property and direction.
+ */
+export declare class OrderProperty {
+    private propertyPath;
+    private isDesc;
+    /**
+     * Creates an order-by descriptor.
+     *
+     * The property path may include a trailing `asc` or `desc` direction.
+     * Without a direction, ascending order is used.
+     *
+     * @param propertyPath Property name, optionally followed by `asc` or `desc`.
+     * @param isDesc Explicit direction override when supplied.
+     * @throws Error If the property name is not a string or the direction is invalid.
+     */
+    constructor(propertyPath: string, isDesc?: boolean);
+    /** Returns the property name without its direction. */
+    getPropertyPath(): string;
+    /** Returns `true` for descending order and `false` for ascending order. */
+    getDirection(): boolean;
+    /** Returns the normalized `property direction` string used in `$orderby`. */
+    getValue(): string;
+}

package/src/Query.d.ts

@@ -0,0 +1,104 @@
+import { QueryBase } from "./QueryBase";
+import { WhereQuery } from "./WhereQuery";
+import { OrderProperty } from "./OrderProperty";
+/**
+ * Builds an immutable, fluent OData query.
+ *
+ * Each modifier returns a cloned query, so a base query can be reused to create
+ * independent variants. Call {@link build} after completing the chain to obtain
+ * the query parameter object passed to a Sitefinity data request.
+ *
+ * @example
+ * const query = new Query()
+ *     .select("Title", "Content")
+ *     .where()
+ *     .eq("Status", "Live")
+ *     .done()
+ *     .order("Title desc")
+ *     .skip(10)
+ *     .take(10);
+ *
+ * query.build();
+ * // { $select: "Title, Content", $filter: "(Status eq 'Live')",
+ * //   $orderby: "Title desc", $skip: 10, $top: 10 }
+ */
+export declare class Query extends QueryBase {
+    /** The order-by clauses, when an order has been configured. */
+    orderProperties: OrderProperty[];
+    /** The number of records to skip, when paging is configured. */
+    skipValue: number;
+    /** The maximum number of records to return, when paging is configured. */
+    takeValue: number;
+    /** The full-text search expression, when configured. */
+    searchValue: string;
+    /** Whether the service should include the total count in the response. */
+    inlineCount: boolean;
+    /** The root filter expression, when a where clause has been configured. */
+    filter: WhereQuery<Query>;
+    /** Creates an empty query with no selected fields, filters, ordering, or paging. */
+    constructor();
+    /**
+     * Starts a filter expression.
+     *
+     * The returned builder is generic over its parent query. Call `done()` to
+     * return to this query; nested logical groups require one `done()` per group.
+     *
+     * @returns A fluent filter builder.
+     */
+    where(): WhereQuery<Query>;
+    /**
+     * Specifies one or more order-by clauses.
+     *
+     * Each property may be followed by `asc` or `desc`; ascending order is the
+     * default. Property names must be simple paths without a dot.
+     *
+     * @param properties Property names and optional directions.
+     * @returns A cloned query containing the requested ordering.
+     * @throws Error If a property is not a string, contains a nested path, or
+     * has an invalid direction.
+     *
+     * @example
+     * new Query().order("Title desc", "PublicationDate asc");
+     */
+    order(...properties: string[]): Query;
+    /**
+     * Skips a number of records before returning results.
+     *
+     * @param value Number of records to skip.
+     * @returns A cloned query with `$skip` configured.
+     */
+    skip(value: number): Query;
+    /**
+     * Limits the number of records returned.
+     *
+     * @param value Maximum number of records to return.
+     * @returns A cloned query with `$top` configured.
+     */
+    take(value: number): Query;
+    /**
+     * Adds a full-text search expression.
+     *
+     * @param value Search text understood by the Sitefinity service.
+     * @returns A cloned query with `$search` configured.
+     */
+    search(value: string): Query;
+    /**
+     * Requests the total matching count with the result.
+     *
+     * @param inline Whether `$count` should be enabled. Defaults to `true`.
+     * @returns A cloned query with `$count` configured.
+     */
+    count(inline?: boolean): Query;
+    /**
+     * Converts this query into OData query parameters.
+     *
+     * The returned object may contain `$filter`, `$select`, `$expand`,
+     * `$orderby`, `$skip`, `$top`, `$count`, and `$search`. Empty clauses are
+     * omitted. Building does not mutate the query.
+     *
+     * @returns The query parameter object for a data request.
+     */
+    build(): {
+        [key: string]: string;
+    };
+}

package/src/QueryBase.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Base class for query projections.
+ *
+ * `Query` extends this class with filtering, ordering, searching, and paging.
+ * Projection methods are immutable: each call returns a clone that preserves
+ * the concrete query prototype, so fluent chains continue to expose derived
+ * query methods.
+ */
+export declare class QueryBase {
+    /** Selected scalar properties, or `null` when no projection was configured. */
+    selectProperties: string[];
+    /** Selected navigation properties, or `null` when no expansion was configured. */
+    expandProperties: string[];
+    /** Creates an empty projection. */
+    constructor();
+    /**
+     * Selects the scalar fields returned by the service.
+     *
+     * Duplicate names are removed while preserving their first occurrence.
+     * Property names must be simple paths without a dot.
+     *
+     * @param properties Field names to include.
+     * @returns A cloned query with `$select` configured.
+     * @throws Error If a property is not a string or is a nested path.
+     */
+    select(...properties: string[]): this;
+    /**
+     * Selects the navigation properties expanded by the service.
+     *
+     * Duplicate names are removed while preserving their first occurrence.
+     * Property names must be simple paths without a dot.
+     *
+     * @param properties Navigation property names to expand.
+     * @returns A cloned query with `$expand` configured.
+     * @throws Error If a property is not a string or is a nested path.
+     */
+    expand(...properties: string[]): this;
+    protected validatePropertyPaths(propPaths: string[], allowNested?: boolean): void;
+    protected clone(setter?: ((newObj: this) => void)): this;
+}

package/src/QueryBuilder.d.ts

@@ -0,0 +1,29 @@
+import { Query } from "./Query";
+/**
+ * Serializes a {@link Query} and its expression tree to OData query parameters.
+ */
+export declare class QueryBuilder {
+    private query;
+    /** Creates a builder for the supplied query. */
+    constructor(query: Query);
+    /**
+     * Serializes the query into OData parameter names and values.
+     *
+     * Supported output keys are `$filter`, `$select`, `$expand`, `$orderby`,
+     * `$skip`, `$top`, `$count`, and `$search`. Missing or empty clauses are
+     * omitted. String constants are escaped and quoted; GUID constants remain
+     * unquoted, and `in` requires an array value.
+     *
+     * @returns An object suitable for the data request's query parameters.
+     * @throws Error If the expression tree is invalid, an operator is unsupported,
+     * or an `in` condition does not contain an array.
+     */
+    build(): {
+        [key: string]: string;
+    };
+    private buildComplexExpression;
+    private buildBinaryExpression;
+    private applyCaseSensitiveSettings;
+    private checkType;
+    private isGuid;
+}