@wix/auto_sdk_data_indexes 1.0.2 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/data-v2-index-indexes.context.d.ts +1 -1
- package/build/cjs/src/data-v2-index-indexes.meta.d.ts +3 -3
- package/build/cjs/src/data-v2-index-indexes.meta.js.map +1 -1
- package/build/cjs/src/data-v2-index-indexes.public.d.ts +4 -4
- package/build/cjs/src/data-v2-index-indexes.public.js.map +1 -1
- package/build/cjs/src/data-v2-index-indexes.types.d.ts +9 -38
- package/build/cjs/src/data-v2-index-indexes.types.js +6 -2
- package/build/cjs/src/data-v2-index-indexes.types.js.map +1 -1
- package/build/cjs/src/data-v2-index-indexes.universal.d.ts +15 -39
- package/build/cjs/src/data-v2-index-indexes.universal.js +6 -2
- package/build/cjs/src/data-v2-index-indexes.universal.js.map +1 -1
- package/build/es/src/data-v2-index-indexes.context.d.ts +1 -1
- package/build/es/src/data-v2-index-indexes.meta.d.ts +3 -3
- package/build/es/src/data-v2-index-indexes.meta.js.map +1 -1
- package/build/es/src/data-v2-index-indexes.public.d.ts +4 -4
- package/build/es/src/data-v2-index-indexes.public.js.map +1 -1
- package/build/es/src/data-v2-index-indexes.types.d.ts +9 -38
- package/build/es/src/data-v2-index-indexes.types.js +6 -2
- package/build/es/src/data-v2-index-indexes.types.js.map +1 -1
- package/build/es/src/data-v2-index-indexes.universal.d.ts +15 -39
- package/build/es/src/data-v2-index-indexes.universal.js +6 -2
- package/build/es/src/data-v2-index-indexes.universal.js.map +1 -1
- package/build/internal/cjs/src/data-v2-index-indexes.context.d.ts +1 -1
- package/build/internal/cjs/src/data-v2-index-indexes.meta.d.ts +3 -3
- package/build/internal/cjs/src/data-v2-index-indexes.meta.js.map +1 -1
- package/build/internal/cjs/src/data-v2-index-indexes.public.d.ts +5 -5
- package/build/internal/cjs/src/data-v2-index-indexes.public.js.map +1 -1
- package/build/internal/cjs/src/data-v2-index-indexes.types.d.ts +9 -38
- package/build/internal/cjs/src/data-v2-index-indexes.types.js +6 -2
- package/build/internal/cjs/src/data-v2-index-indexes.types.js.map +1 -1
- package/build/internal/cjs/src/data-v2-index-indexes.universal.d.ts +16 -40
- package/build/internal/cjs/src/data-v2-index-indexes.universal.js +6 -2
- package/build/internal/cjs/src/data-v2-index-indexes.universal.js.map +1 -1
- package/build/internal/es/src/data-v2-index-indexes.context.d.ts +1 -1
- package/build/internal/es/src/data-v2-index-indexes.meta.d.ts +3 -3
- package/build/internal/es/src/data-v2-index-indexes.meta.js.map +1 -1
- package/build/internal/es/src/data-v2-index-indexes.public.d.ts +5 -5
- package/build/internal/es/src/data-v2-index-indexes.public.js.map +1 -1
- package/build/internal/es/src/data-v2-index-indexes.types.d.ts +9 -38
- package/build/internal/es/src/data-v2-index-indexes.types.js +6 -2
- package/build/internal/es/src/data-v2-index-indexes.types.js.map +1 -1
- package/build/internal/es/src/data-v2-index-indexes.universal.d.ts +16 -40
- package/build/internal/es/src/data-v2-index-indexes.universal.js +6 -2
- package/build/internal/es/src/data-v2-index-indexes.universal.js.map +1 -1
- package/package.json +4 -4
|
@@ -4,4 +4,4 @@ export declare const createIndex: MaybeContext<BuildRESTFunction<typeof publicCr
|
|
|
4
4
|
export declare const dropIndex: MaybeContext<BuildRESTFunction<typeof publicDropIndex> & typeof publicDropIndex>;
|
|
5
5
|
export declare const listIndexes: MaybeContext<BuildRESTFunction<typeof publicListIndexes> & typeof publicListIndexes>;
|
|
6
6
|
export { Order, Status, IndexSource, Environment, } from './data-v2-index-indexes.universal.js';
|
|
7
|
-
export { Index, Field, Failure, CreateIndexRequest, CreateIndexResponse, DropIndexRequest, DropIndexResponse, ListIndexesRequest, Paging, ListIndexesResponse, PagingMetadata, ListAvailableIndexesRequest, ListAvailableIndexesResponse,
|
|
7
|
+
export { Index, Field, Failure, CreateIndexRequest, CreateIndexResponse, DropIndexRequest, DropIndexResponse, ListIndexesRequest, Paging, ListIndexesResponse, PagingMetadata, ListAvailableIndexesRequest, ListAvailableIndexesResponse, ListIndexesOptions, } from './data-v2-index-indexes.universal.js';
|
|
@@ -10,7 +10,7 @@ export type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unk
|
|
|
10
10
|
__responseType: Q;
|
|
11
11
|
__originalResponseType: R;
|
|
12
12
|
};
|
|
13
|
-
export declare function createIndex(): __PublicMethodMetaInfo<'POST', {}, ambassadorWixDataV2IndexUniversalTypes.CreateIndexRequest, ambassadorWixDataV2IndexTypes.CreateIndexRequest, ambassadorWixDataV2IndexUniversalTypes.CreateIndexResponse
|
|
13
|
+
export declare function createIndex(): __PublicMethodMetaInfo<'POST', {}, ambassadorWixDataV2IndexUniversalTypes.CreateIndexRequest, ambassadorWixDataV2IndexTypes.CreateIndexRequest, ambassadorWixDataV2IndexUniversalTypes.CreateIndexResponse, ambassadorWixDataV2IndexTypes.CreateIndexResponse>;
|
|
14
14
|
export declare function dropIndex(): __PublicMethodMetaInfo<'DELETE', {}, ambassadorWixDataV2IndexUniversalTypes.DropIndexRequest, ambassadorWixDataV2IndexTypes.DropIndexRequest, ambassadorWixDataV2IndexUniversalTypes.DropIndexResponse, ambassadorWixDataV2IndexTypes.DropIndexResponse>;
|
|
15
|
-
export declare function listIndexes(): __PublicMethodMetaInfo<'GET', {}, ambassadorWixDataV2IndexUniversalTypes.ListIndexesRequest, ambassadorWixDataV2IndexTypes.ListIndexesRequest, ambassadorWixDataV2IndexUniversalTypes.ListIndexesResponse
|
|
16
|
-
export declare function listAvailableIndexes(): __PublicMethodMetaInfo<'GET', {}, ambassadorWixDataV2IndexUniversalTypes.ListAvailableIndexesRequest, ambassadorWixDataV2IndexTypes.ListAvailableIndexesRequest, ambassadorWixDataV2IndexUniversalTypes.ListAvailableIndexesResponse
|
|
15
|
+
export declare function listIndexes(): __PublicMethodMetaInfo<'GET', {}, ambassadorWixDataV2IndexUniversalTypes.ListIndexesRequest, ambassadorWixDataV2IndexTypes.ListIndexesRequest, ambassadorWixDataV2IndexUniversalTypes.ListIndexesResponse, ambassadorWixDataV2IndexTypes.ListIndexesResponse>;
|
|
16
|
+
export declare function listAvailableIndexes(): __PublicMethodMetaInfo<'GET', {}, ambassadorWixDataV2IndexUniversalTypes.ListAvailableIndexesRequest, ambassadorWixDataV2IndexTypes.ListAvailableIndexesRequest, ambassadorWixDataV2IndexUniversalTypes.ListAvailableIndexesResponse, ambassadorWixDataV2IndexTypes.ListAvailableIndexesResponse>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v2-index-indexes.meta.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.meta.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0FAA4E;AAsB5E,SAAgB,WAAW;
|
|
1
|
+
{"version":3,"file":"data-v2-index-indexes.meta.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.meta.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0FAA4E;AAsB5E,SAAgB,WAAW;IAQzB,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAExE,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,MAAM;QAClB,IAAI,EAAE,aAAa;QACnB,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AA3BD,kCA2BC;AAED,SAAgB,SAAS;IAQvB,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAEtE,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,QAAQ;QACpB,IAAI,EAAE,aAAa;QACnB,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AA3BD,8BA2BC;AAED,SAAgB,WAAW;IAQzB,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAExE,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,aAAa;QACnB,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AA3BD,kCA2BC;AAED,SAAgB,oBAAoB;IAQlC,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GACrB,wBAAwB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAEzD,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,uBAAuB;QAC7B,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AA5BD,oDA4BC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { HttpClient } from '@wix/sdk-types';
|
|
2
|
-
import { Index,
|
|
2
|
+
import { Index, ListIndexesOptions, ListIndexesResponse } from './data-v2-index-indexes.universal.js';
|
|
3
3
|
export declare const __metadata: {
|
|
4
4
|
PACKAGE_NAME: string;
|
|
5
5
|
};
|
|
@@ -18,7 +18,7 @@ interface CreateIndexSignature {
|
|
|
18
18
|
* @param - Options for creating an index.
|
|
19
19
|
* @returns Details of the index being generated.
|
|
20
20
|
*/
|
|
21
|
-
(dataCollectionId: string, index: Index): Promise<Index
|
|
21
|
+
(dataCollectionId: string, index: Index): Promise<Index>;
|
|
22
22
|
}
|
|
23
23
|
export declare function dropIndex(httpClient: HttpClient): DropIndexSignature;
|
|
24
24
|
interface DropIndexSignature {
|
|
@@ -46,6 +46,6 @@ interface ListIndexesSignature {
|
|
|
46
46
|
* @param - ID of the data collection for which to list indexes.
|
|
47
47
|
* @param - Options for retrieving a list of indexes.
|
|
48
48
|
*/
|
|
49
|
-
(dataCollectionId: string, options?: ListIndexesOptions | undefined): Promise<ListIndexesResponse
|
|
49
|
+
(dataCollectionId: string, options?: ListIndexesOptions | undefined): Promise<ListIndexesResponse>;
|
|
50
50
|
}
|
|
51
|
-
export { CreateIndexRequest, CreateIndexResponse,
|
|
51
|
+
export { CreateIndexRequest, CreateIndexResponse, DropIndexRequest, DropIndexResponse, Environment, Failure, Field, Index, IndexSource, ListAvailableIndexesRequest, ListAvailableIndexesResponse, ListIndexesOptions, ListIndexesRequest, ListIndexesResponse, Order, Paging, PagingMetadata, Status, } from './data-v2-index-indexes.universal.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v2-index-indexes.public.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.public.ts"],"names":[],"mappings":";;;AACA,
|
|
1
|
+
{"version":3,"file":"data-v2-index-indexes.public.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.public.ts"],"names":[],"mappings":";;;AACA,6FAS8C;AAEjC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CACL,gBAAwB,EACxB,KAA2E,EAC3E,EAAE,CACF,IAAA,gDAAoB,EAClB,gBAAgB,EAChB,KAAK;IACL,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAXD,kCAWC;AAmBD,SAAgB,SAAS,CAAC,UAAsB;IAC9C,OAAO,CAAC,gBAAwB,EAAE,SAAiB,EAAE,EAAE,CACrD,IAAA,8CAAkB,EAChB,gBAAgB,EAChB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,8BAQC;AAeD,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,gBAAwB,EAAE,OAA4B,EAAE,EAAE,CAChE,IAAA,gDAAoB,EAClB,gBAAgB,EAChB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,kCAQC;AAoBD,gBAAgB;AAChB,SAAgB,oBAAoB,CAClC,UAAsB;IAEtB,OAAO,CAAC,gBAAwB,EAAE,EAAE,CAClC,IAAA,yDAA6B,EAC3B,gBAAgB;IAChB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,oDASC;AAUD,2FAmB8C;AAd5C,iIAAA,WAAW,OAAA;AAIX,iIAAA,WAAW,OAAA;AAMX,2HAAA,KAAK,OAAA;AAGL,4HAAA,MAAM,OAAA"}
|
|
@@ -37,10 +37,7 @@ export interface Index {
|
|
|
37
37
|
* Default: `false`
|
|
38
38
|
*/
|
|
39
39
|
caseInsensitive?: boolean;
|
|
40
|
-
/**
|
|
41
|
-
* Specifies the origin of the index definition.
|
|
42
|
-
* @readonly
|
|
43
|
-
*/
|
|
40
|
+
/** Specifies the origin of the index definition. */
|
|
44
41
|
source?: IndexSource;
|
|
45
42
|
}
|
|
46
43
|
/**
|
|
@@ -108,7 +105,9 @@ export declare enum IndexSource {
|
|
|
108
105
|
/** Index is created by the system, present for all collections. */
|
|
109
106
|
SYSTEM = "SYSTEM",
|
|
110
107
|
/** Index was created by a user via API or UI. */
|
|
111
|
-
USER = "USER"
|
|
108
|
+
USER = "USER",
|
|
109
|
+
/** Index is created automatically by the system based on user queries. */
|
|
110
|
+
AUTO = "AUTO"
|
|
112
111
|
}
|
|
113
112
|
export interface CreateIndexRequest {
|
|
114
113
|
/** Details of the index to be created. */
|
|
@@ -120,12 +119,14 @@ export interface CreateIndexRequest {
|
|
|
120
119
|
dataCollectionId: string;
|
|
121
120
|
}
|
|
122
121
|
export declare enum Environment {
|
|
123
|
-
/**
|
|
124
|
-
|
|
122
|
+
/** Place holder. Never returned by the service. */
|
|
123
|
+
UNKNOWN_ENVIRONMENT = "UNKNOWN_ENVIRONMENT",
|
|
125
124
|
/** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
|
|
126
125
|
SANDBOX = "SANDBOX",
|
|
127
126
|
/** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment. */
|
|
128
|
-
SANDBOX_PREFERRED = "SANDBOX_PREFERRED"
|
|
127
|
+
SANDBOX_PREFERRED = "SANDBOX_PREFERRED",
|
|
128
|
+
/** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
|
|
129
|
+
LIVE = "LIVE"
|
|
129
130
|
}
|
|
130
131
|
export interface CreateIndexResponse {
|
|
131
132
|
/** Details of the index being generated. */
|
|
@@ -197,33 +198,3 @@ export interface ListAvailableIndexesResponse {
|
|
|
197
198
|
/** Overall index limit, missing value means there's no overall limit */
|
|
198
199
|
total?: number | null;
|
|
199
200
|
}
|
|
200
|
-
interface FieldNonNullableFields {
|
|
201
|
-
path: string;
|
|
202
|
-
order: Order;
|
|
203
|
-
}
|
|
204
|
-
interface FailureNonNullableFields {
|
|
205
|
-
code: string;
|
|
206
|
-
broadCode: string;
|
|
207
|
-
description: string;
|
|
208
|
-
}
|
|
209
|
-
interface IndexNonNullableFields {
|
|
210
|
-
name: string;
|
|
211
|
-
fields: FieldNonNullableFields[];
|
|
212
|
-
status: Status;
|
|
213
|
-
failure?: FailureNonNullableFields;
|
|
214
|
-
unique: boolean;
|
|
215
|
-
caseInsensitive: boolean;
|
|
216
|
-
source: IndexSource;
|
|
217
|
-
}
|
|
218
|
-
export interface CreateIndexResponseNonNullableFields {
|
|
219
|
-
index?: IndexNonNullableFields;
|
|
220
|
-
}
|
|
221
|
-
export interface ListIndexesResponseNonNullableFields {
|
|
222
|
-
indexes: IndexNonNullableFields[];
|
|
223
|
-
}
|
|
224
|
-
export interface ListAvailableIndexesResponseNonNullableFields {
|
|
225
|
-
regular1Field: number;
|
|
226
|
-
regular3Field: number;
|
|
227
|
-
unique1Field: number;
|
|
228
|
-
}
|
|
229
|
-
export {};
|
|
@@ -35,14 +35,18 @@ var IndexSource;
|
|
|
35
35
|
IndexSource["SYSTEM"] = "SYSTEM";
|
|
36
36
|
/** Index was created by a user via API or UI. */
|
|
37
37
|
IndexSource["USER"] = "USER";
|
|
38
|
+
/** Index is created automatically by the system based on user queries. */
|
|
39
|
+
IndexSource["AUTO"] = "AUTO";
|
|
38
40
|
})(IndexSource || (exports.IndexSource = IndexSource = {}));
|
|
39
41
|
var Environment;
|
|
40
42
|
(function (Environment) {
|
|
41
|
-
/**
|
|
42
|
-
Environment["
|
|
43
|
+
/** Place holder. Never returned by the service. */
|
|
44
|
+
Environment["UNKNOWN_ENVIRONMENT"] = "UNKNOWN_ENVIRONMENT";
|
|
43
45
|
/** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
|
|
44
46
|
Environment["SANDBOX"] = "SANDBOX";
|
|
45
47
|
/** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment. */
|
|
46
48
|
Environment["SANDBOX_PREFERRED"] = "SANDBOX_PREFERRED";
|
|
49
|
+
/** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
|
|
50
|
+
Environment["LIVE"] = "LIVE";
|
|
47
51
|
})(Environment || (exports.Environment = Environment = {}));
|
|
48
52
|
//# sourceMappingURL=data-v2-index-indexes.types.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v2-index-indexes.types.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"data-v2-index-indexes.types.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.types.ts"],"names":[],"mappings":";;;AA2CA;;;GAGG;AACH,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,oBAAW,CAAA;IACX,sBAAa,CAAA;AACf,CAAC,EAHW,KAAK,qBAAL,KAAK,QAGhB;AAiBD,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,sBAAN,MAAM,QAejB;AAwBD,IAAY,WASX;AATD,WAAY,WAAW;IACrB,mDAAmD;IACnD,4DAA6C,CAAA;IAC7C,mEAAmE;IACnE,gCAAiB,CAAA;IACjB,iDAAiD;IACjD,4BAAa,CAAA;IACb,0EAA0E;IAC1E,4BAAa,CAAA;AACf,CAAC,EATW,WAAW,2BAAX,WAAW,QAStB;AAYD,IAAY,WASX;AATD,WAAY,WAAW;IACrB,mDAAmD;IACnD,0DAA2C,CAAA;IAC3C,mJAAmJ;IACnJ,kCAAmB,CAAA;IACnB,0SAA0S;IAC1S,sDAAuC,CAAA;IACvC,6IAA6I;IAC7I,4BAAa,CAAA;AACf,CAAC,EATW,WAAW,2BAAX,WAAW,QAStB"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
1
2
|
/** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
|
|
2
3
|
export interface Index {
|
|
3
4
|
/**
|
|
@@ -37,10 +38,7 @@ export interface Index {
|
|
|
37
38
|
* Default: `false`
|
|
38
39
|
*/
|
|
39
40
|
caseInsensitive?: boolean;
|
|
40
|
-
/**
|
|
41
|
-
* Specifies the origin of the index definition.
|
|
42
|
-
* @readonly
|
|
43
|
-
*/
|
|
41
|
+
/** Specifies the origin of the index definition. */
|
|
44
42
|
source?: IndexSource;
|
|
45
43
|
}
|
|
46
44
|
/**
|
|
@@ -108,7 +106,9 @@ export declare enum IndexSource {
|
|
|
108
106
|
/** Index is created by the system, present for all collections. */
|
|
109
107
|
SYSTEM = "SYSTEM",
|
|
110
108
|
/** Index was created by a user via API or UI. */
|
|
111
|
-
USER = "USER"
|
|
109
|
+
USER = "USER",
|
|
110
|
+
/** Index is created automatically by the system based on user queries. */
|
|
111
|
+
AUTO = "AUTO"
|
|
112
112
|
}
|
|
113
113
|
export interface CreateIndexRequest {
|
|
114
114
|
/** Details of the index to be created. */
|
|
@@ -120,12 +120,14 @@ export interface CreateIndexRequest {
|
|
|
120
120
|
dataCollectionId: string;
|
|
121
121
|
}
|
|
122
122
|
export declare enum Environment {
|
|
123
|
-
/**
|
|
124
|
-
|
|
123
|
+
/** Place holder. Never returned by the service. */
|
|
124
|
+
UNKNOWN_ENVIRONMENT = "UNKNOWN_ENVIRONMENT",
|
|
125
125
|
/** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
|
|
126
126
|
SANDBOX = "SANDBOX",
|
|
127
127
|
/** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment. */
|
|
128
|
-
SANDBOX_PREFERRED = "SANDBOX_PREFERRED"
|
|
128
|
+
SANDBOX_PREFERRED = "SANDBOX_PREFERRED",
|
|
129
|
+
/** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
|
|
130
|
+
LIVE = "LIVE"
|
|
129
131
|
}
|
|
130
132
|
export interface CreateIndexResponse {
|
|
131
133
|
/** Details of the index being generated. */
|
|
@@ -197,35 +199,7 @@ export interface ListAvailableIndexesResponse {
|
|
|
197
199
|
/** Overall index limit, missing value means there's no overall limit */
|
|
198
200
|
total?: number | null;
|
|
199
201
|
}
|
|
200
|
-
|
|
201
|
-
path: string;
|
|
202
|
-
order: Order;
|
|
203
|
-
}
|
|
204
|
-
interface FailureNonNullableFields {
|
|
205
|
-
code: string;
|
|
206
|
-
broadCode: string;
|
|
207
|
-
description: string;
|
|
208
|
-
}
|
|
209
|
-
export interface IndexNonNullableFields {
|
|
210
|
-
name: string;
|
|
211
|
-
fields: FieldNonNullableFields[];
|
|
212
|
-
status: Status;
|
|
213
|
-
failure?: FailureNonNullableFields;
|
|
214
|
-
unique: boolean;
|
|
215
|
-
caseInsensitive: boolean;
|
|
216
|
-
source: IndexSource;
|
|
217
|
-
}
|
|
218
|
-
export interface CreateIndexResponseNonNullableFields {
|
|
219
|
-
index?: IndexNonNullableFields;
|
|
220
|
-
}
|
|
221
|
-
export interface ListIndexesResponseNonNullableFields {
|
|
222
|
-
indexes: IndexNonNullableFields[];
|
|
223
|
-
}
|
|
224
|
-
export interface ListAvailableIndexesResponseNonNullableFields {
|
|
225
|
-
regular1Field: number;
|
|
226
|
-
regular3Field: number;
|
|
227
|
-
unique1Field: number;
|
|
228
|
-
}
|
|
202
|
+
type IndexNonNullablePaths = `name` | `fields` | `fields.${number}.path` | `fields.${number}.order` | `status` | `failure.code` | `failure.description` | `unique` | `caseInsensitive` | `source`;
|
|
229
203
|
/**
|
|
230
204
|
* Creates an index for a data collection.
|
|
231
205
|
*
|
|
@@ -252,7 +226,7 @@ export interface ListAvailableIndexesResponseNonNullableFields {
|
|
|
252
226
|
* @returns Details of the index being generated.
|
|
253
227
|
* @fqn com.wixpress.cloud.data.api.index.IndexService.CreateIndex
|
|
254
228
|
*/
|
|
255
|
-
export declare function createIndex(dataCollectionId: string, index: Index): Promise<Index
|
|
229
|
+
export declare function createIndex(dataCollectionId: string, index: NonNullablePaths<Index, `fields` | `fields.${number}.path` | `name`>): Promise<NonNullablePaths<Index, IndexNonNullablePaths>>;
|
|
256
230
|
/**
|
|
257
231
|
* Removes an index from a data collection.
|
|
258
232
|
*
|
|
@@ -293,7 +267,9 @@ export declare function dropIndex(dataCollectionId: string, indexName: string):
|
|
|
293
267
|
* @applicableIdentity APP
|
|
294
268
|
* @fqn com.wixpress.cloud.data.api.index.IndexService.ListIndexes
|
|
295
269
|
*/
|
|
296
|
-
export declare function listIndexes(dataCollectionId: string, options?: ListIndexesOptions): Promise<ListIndexesResponse
|
|
270
|
+
export declare function listIndexes(dataCollectionId: string, options?: ListIndexesOptions): Promise<NonNullablePaths<ListIndexesResponse, {
|
|
271
|
+
[P in IndexNonNullablePaths]: `indexes.${number}.${P}`;
|
|
272
|
+
}[IndexNonNullablePaths]>>;
|
|
297
273
|
export interface ListIndexesOptions {
|
|
298
274
|
/** Paging options to limit and skip the number of items. */
|
|
299
275
|
paging?: Paging;
|
|
@@ -61,15 +61,19 @@ var IndexSource;
|
|
|
61
61
|
IndexSource["SYSTEM"] = "SYSTEM";
|
|
62
62
|
/** Index was created by a user via API or UI. */
|
|
63
63
|
IndexSource["USER"] = "USER";
|
|
64
|
+
/** Index is created automatically by the system based on user queries. */
|
|
65
|
+
IndexSource["AUTO"] = "AUTO";
|
|
64
66
|
})(IndexSource || (exports.IndexSource = IndexSource = {}));
|
|
65
67
|
var Environment;
|
|
66
68
|
(function (Environment) {
|
|
67
|
-
/**
|
|
68
|
-
Environment["
|
|
69
|
+
/** Place holder. Never returned by the service. */
|
|
70
|
+
Environment["UNKNOWN_ENVIRONMENT"] = "UNKNOWN_ENVIRONMENT";
|
|
69
71
|
/** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
|
|
70
72
|
Environment["SANDBOX"] = "SANDBOX";
|
|
71
73
|
/** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment. */
|
|
72
74
|
Environment["SANDBOX_PREFERRED"] = "SANDBOX_PREFERRED";
|
|
75
|
+
/** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
|
|
76
|
+
Environment["LIVE"] = "LIVE";
|
|
73
77
|
})(Environment || (exports.Environment = Environment = {}));
|
|
74
78
|
/**
|
|
75
79
|
* Creates an index for a data collection.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v2-index-indexes.universal.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,0FAA4E;
|
|
1
|
+
{"version":3,"file":"data-v2-index-indexes.universal.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,0FAA4E;AA6C5E;;;GAGG;AACH,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,oBAAW,CAAA;IACX,sBAAa,CAAA;AACf,CAAC,EAHW,KAAK,qBAAL,KAAK,QAGhB;AAiBD,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,sBAAN,MAAM,QAejB;AAwBD,IAAY,WASX;AATD,WAAY,WAAW;IACrB,mDAAmD;IACnD,4DAA6C,CAAA;IAC7C,mEAAmE;IACnE,gCAAiB,CAAA;IACjB,iDAAiD;IACjD,4BAAa,CAAA;IACb,0EAA0E;IAC1E,4BAAa,CAAA;AACf,CAAC,EATW,WAAW,2BAAX,WAAW,QAStB;AAYD,IAAY,WASX;AATD,WAAY,WAAW;IACrB,mDAAmD;IACnD,0DAA2C,CAAA;IAC3C,mJAAmJ;IACnJ,kCAAmB,CAAA;IACnB,0SAA0S;IAC1S,sDAAuC,CAAA;IACvC,6IAA6I;IAC7I,4BAAa,CAAA;AACf,CAAC,EATW,WAAW,2BAAX,WAAW,QAStB;AA4FD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACI,KAAK,UAAU,WAAW,CAC/B,gBAAwB,EACxB,KAA2E;IAE3E,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;QAClC,KAAK,EAAE,KAAK;KACb,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAE9D,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAM,CAAC;IACtE,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;YACrE,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAC9B,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AArCD,kCAqCC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,SAAS,CAC7B,gBAAwB,EACxB,SAAiB;IAEjB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;QAClC,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAE5D,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,gBAAgB,EAAE,MAAM;gBACxB,SAAS,EAAE,MAAM;aAClB;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAClC,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAtCD,8BAsCC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,WAAW,CAC/B,gBAAwB,EACxB,OAA4B;IAS5B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;QAClC,MAAM,EAAE,OAAO,EAAE,MAAM;KACxB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAE9D,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,gBAAgB,EAAE,MAAM;gBACxB,MAAM,EAAE,aAAa;aACtB;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAChC,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AA/CD,kCA+CC;AAOD;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,oBAAoB,CACxC,gBAAwB;IAOxB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;KACnC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAEvE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE;YACtD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,CAAC,CACrB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAxCD,oDAwCC"}
|
|
@@ -4,4 +4,4 @@ export declare const createIndex: MaybeContext<BuildRESTFunction<typeof publicCr
|
|
|
4
4
|
export declare const dropIndex: MaybeContext<BuildRESTFunction<typeof publicDropIndex> & typeof publicDropIndex>;
|
|
5
5
|
export declare const listIndexes: MaybeContext<BuildRESTFunction<typeof publicListIndexes> & typeof publicListIndexes>;
|
|
6
6
|
export { Order, Status, IndexSource, Environment, } from './data-v2-index-indexes.universal.js';
|
|
7
|
-
export { Index, Field, Failure, CreateIndexRequest, CreateIndexResponse, DropIndexRequest, DropIndexResponse, ListIndexesRequest, Paging, ListIndexesResponse, PagingMetadata, ListAvailableIndexesRequest, ListAvailableIndexesResponse,
|
|
7
|
+
export { Index, Field, Failure, CreateIndexRequest, CreateIndexResponse, DropIndexRequest, DropIndexResponse, ListIndexesRequest, Paging, ListIndexesResponse, PagingMetadata, ListAvailableIndexesRequest, ListAvailableIndexesResponse, ListIndexesOptions, } from './data-v2-index-indexes.universal.js';
|
|
@@ -10,7 +10,7 @@ export type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unk
|
|
|
10
10
|
__responseType: Q;
|
|
11
11
|
__originalResponseType: R;
|
|
12
12
|
};
|
|
13
|
-
export declare function createIndex(): __PublicMethodMetaInfo<'POST', {}, ambassadorWixDataV2IndexUniversalTypes.CreateIndexRequest, ambassadorWixDataV2IndexTypes.CreateIndexRequest, ambassadorWixDataV2IndexUniversalTypes.CreateIndexResponse
|
|
13
|
+
export declare function createIndex(): __PublicMethodMetaInfo<'POST', {}, ambassadorWixDataV2IndexUniversalTypes.CreateIndexRequest, ambassadorWixDataV2IndexTypes.CreateIndexRequest, ambassadorWixDataV2IndexUniversalTypes.CreateIndexResponse, ambassadorWixDataV2IndexTypes.CreateIndexResponse>;
|
|
14
14
|
export declare function dropIndex(): __PublicMethodMetaInfo<'DELETE', {}, ambassadorWixDataV2IndexUniversalTypes.DropIndexRequest, ambassadorWixDataV2IndexTypes.DropIndexRequest, ambassadorWixDataV2IndexUniversalTypes.DropIndexResponse, ambassadorWixDataV2IndexTypes.DropIndexResponse>;
|
|
15
|
-
export declare function listIndexes(): __PublicMethodMetaInfo<'GET', {}, ambassadorWixDataV2IndexUniversalTypes.ListIndexesRequest, ambassadorWixDataV2IndexTypes.ListIndexesRequest, ambassadorWixDataV2IndexUniversalTypes.ListIndexesResponse
|
|
16
|
-
export declare function listAvailableIndexes(): __PublicMethodMetaInfo<'GET', {}, ambassadorWixDataV2IndexUniversalTypes.ListAvailableIndexesRequest, ambassadorWixDataV2IndexTypes.ListAvailableIndexesRequest, ambassadorWixDataV2IndexUniversalTypes.ListAvailableIndexesResponse
|
|
15
|
+
export declare function listIndexes(): __PublicMethodMetaInfo<'GET', {}, ambassadorWixDataV2IndexUniversalTypes.ListIndexesRequest, ambassadorWixDataV2IndexTypes.ListIndexesRequest, ambassadorWixDataV2IndexUniversalTypes.ListIndexesResponse, ambassadorWixDataV2IndexTypes.ListIndexesResponse>;
|
|
16
|
+
export declare function listAvailableIndexes(): __PublicMethodMetaInfo<'GET', {}, ambassadorWixDataV2IndexUniversalTypes.ListAvailableIndexesRequest, ambassadorWixDataV2IndexTypes.ListAvailableIndexesRequest, ambassadorWixDataV2IndexUniversalTypes.ListAvailableIndexesResponse, ambassadorWixDataV2IndexTypes.ListAvailableIndexesResponse>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v2-index-indexes.meta.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,wBAAwB,MAAM,iCAAiC,CAAC;AAsB5E,MAAM,UAAU,WAAW;
|
|
1
|
+
{"version":3,"file":"data-v2-index-indexes.meta.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,wBAAwB,MAAM,iCAAiC,CAAC;AAsB5E,MAAM,UAAU,WAAW;IAQzB,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAExE,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,MAAM;QAClB,IAAI,EAAE,aAAa;QACnB,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,SAAS;IAQvB,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAEtE,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,QAAQ;QACpB,IAAI,EAAE,aAAa;QACnB,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,WAAW;IAQzB,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAExE,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,aAAa;QACnB,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB;IAQlC,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GACrB,wBAAwB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAEzD,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,uBAAuB;QAC7B,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { HttpClient } from '@wix/sdk-types';
|
|
2
|
-
import { Index,
|
|
2
|
+
import { Index, ListIndexesOptions, ListIndexesResponse } from './data-v2-index-indexes.universal.js';
|
|
3
3
|
export declare const __metadata: {
|
|
4
4
|
PACKAGE_NAME: string;
|
|
5
5
|
};
|
|
@@ -18,7 +18,7 @@ interface CreateIndexSignature {
|
|
|
18
18
|
* @param - Options for creating an index.
|
|
19
19
|
* @returns Details of the index being generated.
|
|
20
20
|
*/
|
|
21
|
-
(dataCollectionId: string, index: Index): Promise<Index
|
|
21
|
+
(dataCollectionId: string, index: Index): Promise<Index>;
|
|
22
22
|
}
|
|
23
23
|
export declare function dropIndex(httpClient: HttpClient): DropIndexSignature;
|
|
24
24
|
interface DropIndexSignature {
|
|
@@ -46,6 +46,6 @@ interface ListIndexesSignature {
|
|
|
46
46
|
* @param - ID of the data collection for which to list indexes.
|
|
47
47
|
* @param - Options for retrieving a list of indexes.
|
|
48
48
|
*/
|
|
49
|
-
(dataCollectionId: string, options?: ListIndexesOptions | undefined): Promise<ListIndexesResponse
|
|
49
|
+
(dataCollectionId: string, options?: ListIndexesOptions | undefined): Promise<ListIndexesResponse>;
|
|
50
50
|
}
|
|
51
|
-
export { CreateIndexRequest, CreateIndexResponse,
|
|
51
|
+
export { CreateIndexRequest, CreateIndexResponse, DropIndexRequest, DropIndexResponse, Environment, Failure, Field, Index, IndexSource, ListAvailableIndexesRequest, ListAvailableIndexesResponse, ListIndexesOptions, ListIndexesRequest, ListIndexesResponse, Order, Paging, PagingMetadata, Status, } from './data-v2-index-indexes.universal.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v2-index-indexes.public.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.public.ts"],"names":[],"mappings":"AACA,OAAO,
|
|
1
|
+
{"version":3,"file":"data-v2-index-indexes.public.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.public.ts"],"names":[],"mappings":"AACA,OAAO,EAKL,WAAW,IAAI,oBAAoB,EACnC,SAAS,IAAI,kBAAkB,EAC/B,oBAAoB,IAAI,6BAA6B,EACrD,WAAW,IAAI,oBAAoB,GACpC,MAAM,sCAAsC,CAAC;AAE9C,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,MAAM,UAAU,WAAW,CAAC,UAAsB;IAChD,OAAO,CACL,gBAAwB,EACxB,KAA2E,EAC3E,EAAE,CACF,oBAAoB,CAClB,gBAAgB,EAChB,KAAK;IACL,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAmBD,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;AAoBD,gBAAgB;AAChB,MAAM,UAAU,oBAAoB,CAClC,UAAsB;IAEtB,OAAO,CAAC,gBAAwB,EAAE,EAAE,CAClC,6BAA6B,CAC3B,gBAAgB;IAChB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAUD,OAAO,EAKL,WAAW,EAIX,WAAW,EAMX,KAAK,EAGL,MAAM,GACP,MAAM,sCAAsC,CAAC"}
|
|
@@ -37,10 +37,7 @@ export interface Index {
|
|
|
37
37
|
* Default: `false`
|
|
38
38
|
*/
|
|
39
39
|
caseInsensitive?: boolean;
|
|
40
|
-
/**
|
|
41
|
-
* Specifies the origin of the index definition.
|
|
42
|
-
* @readonly
|
|
43
|
-
*/
|
|
40
|
+
/** Specifies the origin of the index definition. */
|
|
44
41
|
source?: IndexSource;
|
|
45
42
|
}
|
|
46
43
|
/**
|
|
@@ -108,7 +105,9 @@ export declare enum IndexSource {
|
|
|
108
105
|
/** Index is created by the system, present for all collections. */
|
|
109
106
|
SYSTEM = "SYSTEM",
|
|
110
107
|
/** Index was created by a user via API or UI. */
|
|
111
|
-
USER = "USER"
|
|
108
|
+
USER = "USER",
|
|
109
|
+
/** Index is created automatically by the system based on user queries. */
|
|
110
|
+
AUTO = "AUTO"
|
|
112
111
|
}
|
|
113
112
|
export interface CreateIndexRequest {
|
|
114
113
|
/** Details of the index to be created. */
|
|
@@ -120,12 +119,14 @@ export interface CreateIndexRequest {
|
|
|
120
119
|
dataCollectionId: string;
|
|
121
120
|
}
|
|
122
121
|
export declare enum Environment {
|
|
123
|
-
/**
|
|
124
|
-
|
|
122
|
+
/** Place holder. Never returned by the service. */
|
|
123
|
+
UNKNOWN_ENVIRONMENT = "UNKNOWN_ENVIRONMENT",
|
|
125
124
|
/** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
|
|
126
125
|
SANDBOX = "SANDBOX",
|
|
127
126
|
/** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment. */
|
|
128
|
-
SANDBOX_PREFERRED = "SANDBOX_PREFERRED"
|
|
127
|
+
SANDBOX_PREFERRED = "SANDBOX_PREFERRED",
|
|
128
|
+
/** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
|
|
129
|
+
LIVE = "LIVE"
|
|
129
130
|
}
|
|
130
131
|
export interface CreateIndexResponse {
|
|
131
132
|
/** Details of the index being generated. */
|
|
@@ -197,33 +198,3 @@ export interface ListAvailableIndexesResponse {
|
|
|
197
198
|
/** Overall index limit, missing value means there's no overall limit */
|
|
198
199
|
total?: number | null;
|
|
199
200
|
}
|
|
200
|
-
interface FieldNonNullableFields {
|
|
201
|
-
path: string;
|
|
202
|
-
order: Order;
|
|
203
|
-
}
|
|
204
|
-
interface FailureNonNullableFields {
|
|
205
|
-
code: string;
|
|
206
|
-
broadCode: string;
|
|
207
|
-
description: string;
|
|
208
|
-
}
|
|
209
|
-
interface IndexNonNullableFields {
|
|
210
|
-
name: string;
|
|
211
|
-
fields: FieldNonNullableFields[];
|
|
212
|
-
status: Status;
|
|
213
|
-
failure?: FailureNonNullableFields;
|
|
214
|
-
unique: boolean;
|
|
215
|
-
caseInsensitive: boolean;
|
|
216
|
-
source: IndexSource;
|
|
217
|
-
}
|
|
218
|
-
export interface CreateIndexResponseNonNullableFields {
|
|
219
|
-
index?: IndexNonNullableFields;
|
|
220
|
-
}
|
|
221
|
-
export interface ListIndexesResponseNonNullableFields {
|
|
222
|
-
indexes: IndexNonNullableFields[];
|
|
223
|
-
}
|
|
224
|
-
export interface ListAvailableIndexesResponseNonNullableFields {
|
|
225
|
-
regular1Field: number;
|
|
226
|
-
regular3Field: number;
|
|
227
|
-
unique1Field: number;
|
|
228
|
-
}
|
|
229
|
-
export {};
|
|
@@ -32,14 +32,18 @@ export var IndexSource;
|
|
|
32
32
|
IndexSource["SYSTEM"] = "SYSTEM";
|
|
33
33
|
/** Index was created by a user via API or UI. */
|
|
34
34
|
IndexSource["USER"] = "USER";
|
|
35
|
+
/** Index is created automatically by the system based on user queries. */
|
|
36
|
+
IndexSource["AUTO"] = "AUTO";
|
|
35
37
|
})(IndexSource || (IndexSource = {}));
|
|
36
38
|
export var Environment;
|
|
37
39
|
(function (Environment) {
|
|
38
|
-
/**
|
|
39
|
-
Environment["
|
|
40
|
+
/** Place holder. Never returned by the service. */
|
|
41
|
+
Environment["UNKNOWN_ENVIRONMENT"] = "UNKNOWN_ENVIRONMENT";
|
|
40
42
|
/** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
|
|
41
43
|
Environment["SANDBOX"] = "SANDBOX";
|
|
42
44
|
/** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment. */
|
|
43
45
|
Environment["SANDBOX_PREFERRED"] = "SANDBOX_PREFERRED";
|
|
46
|
+
/** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
|
|
47
|
+
Environment["LIVE"] = "LIVE";
|
|
44
48
|
})(Environment || (Environment = {}));
|
|
45
49
|
//# sourceMappingURL=data-v2-index-indexes.types.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v2-index-indexes.types.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"data-v2-index-indexes.types.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.types.ts"],"names":[],"mappings":"AA2CA;;;GAGG;AACH,MAAM,CAAN,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,oBAAW,CAAA;IACX,sBAAa,CAAA;AACf,CAAC,EAHW,KAAK,KAAL,KAAK,QAGhB;AAiBD,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;AAwBD,MAAM,CAAN,IAAY,WASX;AATD,WAAY,WAAW;IACrB,mDAAmD;IACnD,4DAA6C,CAAA;IAC7C,mEAAmE;IACnE,gCAAiB,CAAA;IACjB,iDAAiD;IACjD,4BAAa,CAAA;IACb,0EAA0E;IAC1E,4BAAa,CAAA;AACf,CAAC,EATW,WAAW,KAAX,WAAW,QAStB;AAYD,MAAM,CAAN,IAAY,WASX;AATD,WAAY,WAAW;IACrB,mDAAmD;IACnD,0DAA2C,CAAA;IAC3C,mJAAmJ;IACnJ,kCAAmB,CAAA;IACnB,0SAA0S;IAC1S,sDAAuC,CAAA;IACvC,6IAA6I;IAC7I,4BAAa,CAAA;AACf,CAAC,EATW,WAAW,KAAX,WAAW,QAStB"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
1
2
|
/** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
|
|
2
3
|
export interface Index {
|
|
3
4
|
/**
|
|
@@ -37,10 +38,7 @@ export interface Index {
|
|
|
37
38
|
* Default: `false`
|
|
38
39
|
*/
|
|
39
40
|
caseInsensitive?: boolean;
|
|
40
|
-
/**
|
|
41
|
-
* Specifies the origin of the index definition.
|
|
42
|
-
* @readonly
|
|
43
|
-
*/
|
|
41
|
+
/** Specifies the origin of the index definition. */
|
|
44
42
|
source?: IndexSource;
|
|
45
43
|
}
|
|
46
44
|
/**
|
|
@@ -108,7 +106,9 @@ export declare enum IndexSource {
|
|
|
108
106
|
/** Index is created by the system, present for all collections. */
|
|
109
107
|
SYSTEM = "SYSTEM",
|
|
110
108
|
/** Index was created by a user via API or UI. */
|
|
111
|
-
USER = "USER"
|
|
109
|
+
USER = "USER",
|
|
110
|
+
/** Index is created automatically by the system based on user queries. */
|
|
111
|
+
AUTO = "AUTO"
|
|
112
112
|
}
|
|
113
113
|
export interface CreateIndexRequest {
|
|
114
114
|
/** Details of the index to be created. */
|
|
@@ -120,12 +120,14 @@ export interface CreateIndexRequest {
|
|
|
120
120
|
dataCollectionId: string;
|
|
121
121
|
}
|
|
122
122
|
export declare enum Environment {
|
|
123
|
-
/**
|
|
124
|
-
|
|
123
|
+
/** Place holder. Never returned by the service. */
|
|
124
|
+
UNKNOWN_ENVIRONMENT = "UNKNOWN_ENVIRONMENT",
|
|
125
125
|
/** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
|
|
126
126
|
SANDBOX = "SANDBOX",
|
|
127
127
|
/** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment. */
|
|
128
|
-
SANDBOX_PREFERRED = "SANDBOX_PREFERRED"
|
|
128
|
+
SANDBOX_PREFERRED = "SANDBOX_PREFERRED",
|
|
129
|
+
/** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
|
|
130
|
+
LIVE = "LIVE"
|
|
129
131
|
}
|
|
130
132
|
export interface CreateIndexResponse {
|
|
131
133
|
/** Details of the index being generated. */
|
|
@@ -197,35 +199,7 @@ export interface ListAvailableIndexesResponse {
|
|
|
197
199
|
/** Overall index limit, missing value means there's no overall limit */
|
|
198
200
|
total?: number | null;
|
|
199
201
|
}
|
|
200
|
-
|
|
201
|
-
path: string;
|
|
202
|
-
order: Order;
|
|
203
|
-
}
|
|
204
|
-
interface FailureNonNullableFields {
|
|
205
|
-
code: string;
|
|
206
|
-
broadCode: string;
|
|
207
|
-
description: string;
|
|
208
|
-
}
|
|
209
|
-
export interface IndexNonNullableFields {
|
|
210
|
-
name: string;
|
|
211
|
-
fields: FieldNonNullableFields[];
|
|
212
|
-
status: Status;
|
|
213
|
-
failure?: FailureNonNullableFields;
|
|
214
|
-
unique: boolean;
|
|
215
|
-
caseInsensitive: boolean;
|
|
216
|
-
source: IndexSource;
|
|
217
|
-
}
|
|
218
|
-
export interface CreateIndexResponseNonNullableFields {
|
|
219
|
-
index?: IndexNonNullableFields;
|
|
220
|
-
}
|
|
221
|
-
export interface ListIndexesResponseNonNullableFields {
|
|
222
|
-
indexes: IndexNonNullableFields[];
|
|
223
|
-
}
|
|
224
|
-
export interface ListAvailableIndexesResponseNonNullableFields {
|
|
225
|
-
regular1Field: number;
|
|
226
|
-
regular3Field: number;
|
|
227
|
-
unique1Field: number;
|
|
228
|
-
}
|
|
202
|
+
type IndexNonNullablePaths = `name` | `fields` | `fields.${number}.path` | `fields.${number}.order` | `status` | `failure.code` | `failure.description` | `unique` | `caseInsensitive` | `source`;
|
|
229
203
|
/**
|
|
230
204
|
* Creates an index for a data collection.
|
|
231
205
|
*
|
|
@@ -252,7 +226,7 @@ export interface ListAvailableIndexesResponseNonNullableFields {
|
|
|
252
226
|
* @returns Details of the index being generated.
|
|
253
227
|
* @fqn com.wixpress.cloud.data.api.index.IndexService.CreateIndex
|
|
254
228
|
*/
|
|
255
|
-
export declare function createIndex(dataCollectionId: string, index: Index): Promise<Index
|
|
229
|
+
export declare function createIndex(dataCollectionId: string, index: NonNullablePaths<Index, `fields` | `fields.${number}.path` | `name`>): Promise<NonNullablePaths<Index, IndexNonNullablePaths>>;
|
|
256
230
|
/**
|
|
257
231
|
* Removes an index from a data collection.
|
|
258
232
|
*
|
|
@@ -293,7 +267,9 @@ export declare function dropIndex(dataCollectionId: string, indexName: string):
|
|
|
293
267
|
* @applicableIdentity APP
|
|
294
268
|
* @fqn com.wixpress.cloud.data.api.index.IndexService.ListIndexes
|
|
295
269
|
*/
|
|
296
|
-
export declare function listIndexes(dataCollectionId: string, options?: ListIndexesOptions): Promise<ListIndexesResponse
|
|
270
|
+
export declare function listIndexes(dataCollectionId: string, options?: ListIndexesOptions): Promise<NonNullablePaths<ListIndexesResponse, {
|
|
271
|
+
[P in IndexNonNullablePaths]: `indexes.${number}.${P}`;
|
|
272
|
+
}[IndexNonNullablePaths]>>;
|
|
297
273
|
export interface ListIndexesOptions {
|
|
298
274
|
/** Paging options to limit and skip the number of items. */
|
|
299
275
|
paging?: Paging;
|