@wix/data 1.0.89 → 1.0.91

package/build/es/src/data-v2-index.public.js

@@ -1,19 +0,0 @@
-import { createIndex as universalCreateIndex, dropIndex as universalDropIndex, listIndexes as universalListIndexes, } from './data-v2-index.universal';
-export const __metadata = { PACKAGE_NAME: '@wix/data' };
-export function createIndex(httpClient) {
-    return (dataCollectionId, index) => universalCreateIndex(dataCollectionId, index, 
-    // @ts-ignore
-    { httpClient });
-}
-export function dropIndex(httpClient) {
-    return (dataCollectionId, indexName) => universalDropIndex(dataCollectionId, indexName, 
-    // @ts-ignore
-    { httpClient });
-}
-export function listIndexes(httpClient) {
-    return (dataCollectionId, options) => universalListIndexes(dataCollectionId, options, 
-    // @ts-ignore
-    { httpClient });
-}
-export { Order, Status, Environment } from './data-v2-index.universal';
-//# sourceMappingURL=data-v2-index.public.js.map

package/build/es/src/data-v2-index.public.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"data-v2-index.public.js","sourceRoot":"","sources":["../../../src/data-v2-index.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,WAAW,IAAI,oBAAoB,EACnC,SAAS,IAAI,kBAAkB,EAC/B,WAAW,IAAI,oBAAoB,GAGpC,MAAM,2BAA2B,CAAC;AAEnC,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,MAAM,UAAU,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,gBAAwB,EAAE,KAAY,EAAE,EAAE,CAChD,oBAAoB,CAClB,gBAAgB,EAChB,KAAK;IACL,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,UAAsB;IAC9C,OAAO,CAAC,gBAAwB,EAAE,SAAiB,EAAE,EAAE,CACrD,kBAAkB,CAChB,gBAAgB,EAChB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,gBAAwB,EAAE,OAA4B,EAAE,EAAE,CAChE,oBAAoB,CAClB,gBAAgB,EAChB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC"}

package/build/es/src/data-v2-index.types.d.ts

@@ -1,174 +0,0 @@
-/** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
-export interface Index {
-    /** Name of the index. */
-    name?: string;
-    /**
-     * Fields for which the index is defined.
-     *
-     * Max: 3 fields (for a unique index: 1 field)
-     */
-    fields?: Field[];
-    /**
-     * Current status of the index.
-     * - `BUILDING`: Index creation is in progress.
-     * - `ACTIVE`: Index has been successfully created and can be used in queries.
-     * - `DROPPING`: Index is in the process of being dropped.
-     * - `DROPPED`: Index has been dropped successfully.
-     * - `FAILED`: Index creation has failed.
-     * - `INVALID`: Index contains incorrectly indexed data.
-     * @readonly
-     */
-    status?: Status;
-    /**
-     * Contains details about the reasons for failure when `status` is `FAILED`.
-     * @readonly
-     */
-    failure?: Failure;
-    /**
-     * Whether the index enforces uniqueness of values in the field for which it is defined.
-     * If `true`, the index can have only one field.
-     *
-     * Default: `false`
-     */
-    unique?: boolean;
-    /**
-     * Whether the index ignores case.
-     *
-     * Default: `false`
-     */
-    caseInsensitive?: boolean;
-}
-/**
- * Order determines how values are ordered in the index. This is important when
- * ordering and/or range querying by indexed fields.
- */
-export declare enum Order {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-export interface Field {
-    /** Path of the field to index. For example: `title` or `options.price`. */
-    path?: string;
-    /**
-     * Sort order for the index. Base on how the data is regularly queried.
-     *
-     * Default: `ASC`
-     */
-    order?: Order;
-}
-export declare enum Status {
-    /** Place holder. Never returned by the service. */
-    UNKNOWN = "UNKNOWN",
-    /** Index creation is in progress. */
-    BUILDING = "BUILDING",
-    /** Index has been successfully created and can be used in queries. */
-    ACTIVE = "ACTIVE",
-    /** Index is in the process of being dropped. */
-    DROPPING = "DROPPING",
-    /** Index has been dropped successfully. */
-    DROPPED = "DROPPED",
-    /** Index creation has failed. */
-    FAILED = "FAILED",
-    /** Index contains incorrectly indexed data. */
-    INVALID = "INVALID"
-}
-export interface Failure {
-    /**
-     * Error code.
-     * - `WDE0112`: Unknown error while building collection index.
-     * - `WDE0113`: Duplicate key error while building collection index.
-     * - `WDE0114`: Document too large while building collection index.
-     */
-    code?: string;
-    /** Description of the failure. */
-    description?: string;
-    /**
-     * ID of the data item that caused the failure.
-     * For example, if `unique` is `true`, the ID of an item containing a duplicate value.
-     */
-    itemId?: string | null;
-}
-export interface CreateIndexRequest {
-    /** Details of the index to be created. */
-    index: Index;
-    /** ID of the [data collection](https://dev.wix.com/api/rest/wix-data/wix-data/data-collections) for which to generate the index. */
-    dataCollectionId: string;
-}
-export declare enum Environment {
-    LIVE = "LIVE",
-    SANDBOX = "SANDBOX"
-}
-export interface CreateIndexResponse {
-    /** Details of the index being generated. */
-    index?: Index;
-}
-export interface DropIndexRequest {
-    /** Name of the index to drop. */
-    indexName: string;
-    /** ID of the [data collection](https://dev.wix.com/api/rest/wix-data/wix-data/data-collections) for which the index to be dropped is defined. */
-    dataCollectionId: string;
-}
-export interface DropIndexResponse {
-}
-export interface ListIndexesRequest {
-    /** ID of the [data collection](https://dev.wix.com/api/rest/wix-data/wix-data/data-collections) for which to list indexes. */
-    dataCollectionId: string;
-    /** paging */
-    paging?: Paging;
-}
-export interface Paging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-export interface ListIndexesResponse {
-    /** List of all indexes for the requested data collection. */
-    indexes?: Index[];
-    /** Paging metadata */
-    pagingMetadata?: PagingMetadata;
-}
-export interface PagingMetadata {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    offset?: number | null;
-    /** Total number of items that match the query. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-}
-export interface CreateIndexResponseNonNullableFields {
-    index?: {
-        name: string;
-        fields: {
-            path: string;
-            order: Order;
-        }[];
-        status: Status;
-        failure?: {
-            code: string;
-            broadCode: string;
-            description: string;
-        };
-        unique: boolean;
-        caseInsensitive: boolean;
-    };
-}
-export interface ListIndexesResponseNonNullableFields {
-    indexes: {
-        name: string;
-        fields: {
-            path: string;
-            order: Order;
-        }[];
-        status: Status;
-        failure?: {
-            code: string;
-            broadCode: string;
-            description: string;
-        };
-        unique: boolean;
-        caseInsensitive: boolean;
-    }[];
-}

package/build/es/src/data-v2-index.types.js

@@ -1,32 +0,0 @@
-/**
- * Order determines how values are ordered in the index. This is important when
- * ordering and/or range querying by indexed fields.
- */
-export var Order;
-(function (Order) {
-    Order["ASC"] = "ASC";
-    Order["DESC"] = "DESC";
-})(Order || (Order = {}));
-export var Status;
-(function (Status) {
-    /** Place holder. Never returned by the service. */
-    Status["UNKNOWN"] = "UNKNOWN";
-    /** Index creation is in progress. */
-    Status["BUILDING"] = "BUILDING";
-    /** Index has been successfully created and can be used in queries. */
-    Status["ACTIVE"] = "ACTIVE";
-    /** Index is in the process of being dropped. */
-    Status["DROPPING"] = "DROPPING";
-    /** Index has been dropped successfully. */
-    Status["DROPPED"] = "DROPPED";
-    /** Index creation has failed. */
-    Status["FAILED"] = "FAILED";
-    /** Index contains incorrectly indexed data. */
-    Status["INVALID"] = "INVALID";
-})(Status || (Status = {}));
-export var Environment;
-(function (Environment) {
-    Environment["LIVE"] = "LIVE";
-    Environment["SANDBOX"] = "SANDBOX";
-})(Environment || (Environment = {}));
-//# sourceMappingURL=data-v2-index.types.js.map

package/build/es/src/data-v2-index.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"data-v2-index.types.js","sourceRoot":"","sources":["../../../src/data-v2-index.types.ts"],"names":[],"mappings":"AAyCA;;;GAGG;AACH,MAAM,CAAN,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,oBAAW,CAAA;IACX,sBAAa,CAAA;AACf,CAAC,EAHW,KAAK,KAAL,KAAK,QAGhB;AAaD,MAAM,CAAN,IAAY,MAeX;AAfD,WAAY,MAAM;IAChB,mDAAmD;IACnD,6BAAmB,CAAA;IACnB,qCAAqC;IACrC,+BAAqB,CAAA;IACrB,sEAAsE;IACtE,2BAAiB,CAAA;IACjB,gDAAgD;IAChD,+BAAqB,CAAA;IACrB,2CAA2C;IAC3C,6BAAmB,CAAA;IACnB,iCAAiC;IACjC,2BAAiB,CAAA;IACjB,+CAA+C;IAC/C,6BAAmB,CAAA;AACrB,CAAC,EAfW,MAAM,KAAN,MAAM,QAejB;AA0BD,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,kCAAmB,CAAA;AACrB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB"}

package/build/es/src/data-v2-index.universal.d.ts

@@ -1,237 +0,0 @@
-/** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
-export interface Index {
-    /** Name of the index. */
-    name?: string;
-    /**
-     * Fields for which the index is defined.
-     *
-     * Max: 3 fields (for a unique index: 1 field)
-     */
-    fields?: Field[];
-    /**
-     * Current status of the index.
-     * - `BUILDING`: Index creation is in progress.
-     * - `ACTIVE`: Index has been successfully created and can be used in queries.
-     * - `DROPPING`: Index is in the process of being dropped.
-     * - `DROPPED`: Index has been dropped successfully.
-     * - `FAILED`: Index creation has failed.
-     * - `INVALID`: Index contains incorrectly indexed data.
-     * @readonly
-     */
-    status?: Status;
-    /**
-     * Contains details about the reasons for failure when `status` is `FAILED`.
-     * @readonly
-     */
-    failure?: Failure;
-    /**
-     * Whether the index enforces uniqueness of values in the field for which it is defined.
-     * If `true`, the index can have only one field.
-     *
-     * Default: `false`
-     */
-    unique?: boolean;
-    /**
-     * Whether the index ignores case.
-     *
-     * Default: `false`
-     */
-    caseInsensitive?: boolean;
-}
-/**
- * Order determines how values are ordered in the index. This is important when
- * ordering and/or range querying by indexed fields.
- */
-export declare enum Order {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-export interface Field {
-    /** Path of the field to index. For example: `title` or `options.price`. */
-    path?: string;
-    /**
-     * Sort order for the index. Base on how the data is regularly queried.
-     *
-     * Supported values: `ASC`, `DESC`.
-     *
-     * Default: `ASC`
-     */
-    order?: Order;
-}
-export declare enum Status {
-    /** Place holder. Never returned by the service. */
-    UNKNOWN = "UNKNOWN",
-    /** Index creation is in progress. */
-    BUILDING = "BUILDING",
-    /** Index has been successfully created and can be used in queries. */
-    ACTIVE = "ACTIVE",
-    /** Index is in the process of being dropped. */
-    DROPPING = "DROPPING",
-    /** Index has been dropped successfully. */
-    DROPPED = "DROPPED",
-    /** Index creation has failed. */
-    FAILED = "FAILED",
-    /** Index contains incorrectly indexed data. */
-    INVALID = "INVALID"
-}
-export interface Failure {
-    /**
-     * Error code.
-     * - `WDE0112`: Unknown error while building collection index.
-     * - `WDE0113`: Duplicate key error while building collection index.
-     * - `WDE0114`: Document too large while building collection index.
-     */
-    code?: string;
-    /** Description of the failure. */
-    description?: string;
-    /**
-     * ID of the data item that caused the failure.
-     * For example, if `unique` is `true`, the ID of an item containing a duplicate value.
-     */
-    itemId?: string | null;
-}
-export interface CreateIndexRequest {
-    /** Details of the index to be created. */
-    index: Index;
-    /** ID of the data collection for which to generate the index. */
-    dataCollectionId: string;
-}
-export declare enum Environment {
-    LIVE = "LIVE",
-    SANDBOX = "SANDBOX"
-}
-export interface CreateIndexResponse {
-    /** Details of the index being generated. */
-    index?: Index;
-}
-export interface DropIndexRequest {
-    /** Name of the index to drop. */
-    indexName: string;
-    /** ID of the data collection for which the index to be dropped is defined. */
-    dataCollectionId: string;
-}
-export interface DropIndexResponse {
-}
-export interface ListIndexesRequest {
-    /**
-     * ID of the data collection for which to list indexes.
-     *
-     */
-    dataCollectionId: string;
-    /** paging */
-    paging?: Paging;
-}
-export interface Paging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-export interface ListIndexesResponse {
-    /** List of all indexes for the requested data collection. */
-    indexes?: Index[];
-    /** Paging metadata */
-    pagingMetadata?: PagingMetadata;
-}
-export interface PagingMetadata {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    offset?: number | null;
-    /** Total number of items that match the query. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-}
-export interface CreateIndexResponseNonNullableFields {
-    index?: {
-        name: string;
-        fields: {
-            path: string;
-            order: Order;
-        }[];
-        status: Status;
-        failure?: {
-            code: string;
-            description: string;
-        };
-        unique: boolean;
-        caseInsensitive: boolean;
-    };
-}
-export interface ListIndexesResponseNonNullableFields {
-    indexes: {
-        name: string;
-        fields: {
-            path: string;
-            order: Order;
-        }[];
-        status: Status;
-        failure?: {
-            code: string;
-            description: string;
-        };
-        unique: boolean;
-        caseInsensitive: boolean;
-    }[];
-}
-/**
- * Creates an index for a data collection.
- *
- * The index can't be used immediately, as the process of generating the index takes time.
- * You can check whether your index is ready using `listIndexes()`.
- *
- * Note that when an index fails to create, the failed index still occupies a slot.
- * To remove the failed index and free up the slot for a new index, use `dropIndex()`.
- * @param dataCollectionId - ID of the data collection for which to generate the index.
- * @param index - Details of the index to be created.
- * @public
- * @requiredField dataCollectionId
- * @requiredField index
- * @requiredField index.fields
- * @requiredField index.fields.path
- * @requiredField index.name
- * @param options - Options for creating an index.
- * @permissionScope Managa Data Indexes
- * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
- * @applicableIdentity APP
- * @returns Details of the index being generated.
- */
-export declare function createIndex(dataCollectionId: string, index: Index): Promise<Index & NonNullable<CreateIndexResponseNonNullableFields>['index']>;
-/**
- * Removes an index from a data collection.
- *
- * The process of dropping an index from a collection takes time.
- * You can check whether your index has been dropped by calling `listIndexes()`.
- * @param dataCollectionId - ID of the data collection for which the index to be dropped is defined.
- * @param indexName - Name of the index to drop.
- * @public
- * @requiredField dataCollectionId
- * @requiredField indexName
- * @param options - Options for dropping an index.
- * @permissionScope Managa Data Indexes
- * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
- * @applicableIdentity APP
- */
-export declare function dropIndex(dataCollectionId: string, indexName: string): Promise<void>;
-/**
- * Lists all indexes defined for a data collection.
- *
- * When an index's status is `ACTIVE`, it is ready to use.
- * While it is still being created, its status is `BUILDING`.
- *
- * When an index's status is `DROPPED`, it has been dropped successfully.
- * While it is still in the process of being removed, its status is `DROPPING`.
- * @param dataCollectionId - ID of the data collection for which to list indexes.
- * @public
- * @requiredField dataCollectionId
- * @param options - Options for retrieving a list of indexes.
- * @permissionScope Managa Data Indexes
- * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
- * @applicableIdentity APP
- */
-export declare function listIndexes(dataCollectionId: string, options?: ListIndexesOptions): Promise<ListIndexesResponse & ListIndexesResponseNonNullableFields>;
-export interface ListIndexesOptions {
-    /** paging */
-    paging?: Paging;
-}