@wix/data-backend-public-sdk-poc - npm Package Compare versions

Comparing version 1.0.13 to 1.0.14

build/cjs/src/data-v1-data-service.http.d.ts

 import { RequestOptionsFactory } from '@wix/sdk-types';
 import { QueryRequest, QueryResponse } from './data-v1-data-service.types';
-/** Query for items in a collection. */
+/**
+ * Retrieves a list of items, on the basis of the paging, filtering, and sorting preferences you provide.
+ *
+ * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ */
 export declare function query(payload: QueryRequest): RequestOptionsFactory<QueryResponse>;

build/cjs/src/data-v1-data-service.http.js

@@ -219,3 +219,7 @@ "use strict";
 }
-/** Query for items in a collection. */
+/**
+ * Retrieves a list of items, on the basis of the paging, filtering, and sorting preferences you provide.
+ *
+ * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ */
 function query(payload) {
@@ -222,0 +226,0 @@ const { toJSON: toReq, fromJSON: fromReq } = ambassador_1.serializer(_queryRequest, {});

build/cjs/src/data-v1-data-service.types.d.ts

@@ -94,7 +94,7 @@ export interface Item {
 export interface RemoveResponse {
-    /** Removed item */
+    /** Removed item. */
     item?: Record<string, any> | null;
 }
 export interface TruncateRequest {
-    /** ID of the collection */
+    /** ID of the collection to truncate. */
     dataCollectionId?: string;
@@ -105,7 +105,12 @@ }
 export interface QueryRequest {
-    /** Query details. */
+    /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
     dataQuery?: QueryV2;
     /**
      * Whether to omit the total count in the response.
-     * Default: `false`.
+     * If `false`, the `totalCount` and `totalResults` have a value of 0 in the response.
+     *
+     * **Note:** The `totalCount` and `totalResults` fields are deprecated.
+     * We recommend using `pagingMetadata` instead.
+     *
+     * Default: `false`
      */
@@ -115,3 +120,3 @@ omitTotalCount?: boolean;
     includeReferencedItems?: string[];
-    /** Data collection ID. */
+    /** ID of the data collection to query. */
     dataCollectionId?: string;
@@ -201,10 +206,11 @@ }
 export interface QueryResponse {
-    /** Retrieved items */
+    /** Retrieved items. */
     items?: Record<string, any>[] | null;
-    /** Deprecated, use 'paging_metadata' instead. Total number of items satisfying the query */
+    /** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */
     totalCount?: number;
+    /** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */
     totalResults?: number;
-    /** Indicates if referenced items have been trimmed from the results */
+    /** Whether referenced items are trimmed from the results. */
     partialIncludes?: boolean;
-    /** Paging information */
+    /** Paging information. */
     pagingMetadata?: PagingMetadataV2;
@@ -325,5 +331,5 @@ }
 export interface DistinctResponse {
-    /** Retrieved items */
+    /** Retrieved items. */
     items?: any[];
-    /** Paging information */
+    /** Paging information. */
     pagingMetadata?: PagingMetadataV2;
@@ -330,0 +336,0 @@ }

build/cjs/src/data-v1-data-service.universal.d.ts

@@ -100,7 +100,7 @@ export declare const __debug: {
 export interface RemoveResponse {
-    /** Removed item */
+    /** Removed item. */
     item?: Record<string, any> | null;
 }
 export interface TruncateRequest {
-    /** ID of the collection */
+    /** ID of the collection to truncate. */
     dataCollectionId?: string;
@@ -111,7 +111,12 @@ }
 export interface QueryRequest {
-    /** Query details. */
+    /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
     dataQuery?: QueryV2;
     /**
      * Whether to omit the total count in the response.
-     * Default: `false`.
+     * If `false`, the `totalCount` and `totalResults` have a value of 0 in the response.
+     *
+     * **Note:** The `totalCount` and `totalResults` fields are deprecated.
+     * We recommend using `pagingMetadata` instead.
+     *
+     * Default: `false`
      */
@@ -121,3 +126,3 @@ omitTotalCount?: boolean;
     includeReferencedItems?: string[];
-    /** Data collection ID. */
+    /** ID of the data collection to query. */
     dataCollectionId?: string;
@@ -207,10 +212,11 @@ }
 export interface QueryResponse {
-    /** Retrieved items */
+    /** Retrieved items. */
     items?: Record<string, any>[] | null;
-    /** Deprecated, use 'paging_metadata' instead. Total number of items satisfying the query */
+    /** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */
     totalCount?: number;
+    /** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */
     totalResults?: number;
-    /** Indicates if referenced items have been trimmed from the results */
+    /** Whether referenced items are trimmed from the results. */
     partialIncludes?: boolean;
-    /** Paging information */
+    /** Paging information. */
     pagingMetadata?: PagingMetadataV2;
@@ -331,5 +337,5 @@ }
 export interface DistinctResponse {
-    /** Retrieved items */
+    /** Retrieved items. */
     items?: any[];
-    /** Paging information */
+    /** Paging information. */
     pagingMetadata?: PagingMetadataV2;
@@ -537,11 +543,18 @@ }
 /**
- * Query for items in a collection.
+ * Retrieves a list of items, on the basis of the paging, filtering, and sorting preferences you provide.
+ *
+ * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
  * @public */
 export declare function query(options?: QueryOptions): Promise<QueryResponse>;
 export interface QueryOptions {
-    /** Query details. */
+    /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
     dataQuery?: QueryV2;
     /**
      * Whether to omit the total count in the response.
-     * Default: `false`.
+     * If `false`, the `totalCount` and `totalResults` have a value of 0 in the response.
+     *
+     * **Note:** The `totalCount` and `totalResults` fields are deprecated.
+     * We recommend using `pagingMetadata` instead.
+     *
+     * Default: `false`
      */
@@ -551,4 +564,4 @@ omitTotalCount?: boolean;
     includeReferencedItems?: string[];
-    /** Data collection ID. */
+    /** ID of the data collection to query. */
     dataCollectionId?: string;
 }

build/cjs/src/data-v1-data-service.universal.js

@@ -71,3 +71,5 @@ "use strict";
 /**
- * Query for items in a collection.
+ * Retrieves a list of items, on the basis of the paging, filtering, and sorting preferences you provide.
+ *
+ * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
  * @public */
@@ -74,0 +76,0 @@ function query(options) {

build/es/src/data-v1-data-service.http.d.ts

 import { RequestOptionsFactory } from '@wix/sdk-types';
 import { QueryRequest, QueryResponse } from './data-v1-data-service.types';
-/** Query for items in a collection. */
+/**
+ * Retrieves a list of items, on the basis of the paging, filtering, and sorting preferences you provide.
+ *
+ * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ */
 export declare function query(payload: QueryRequest): RequestOptionsFactory<QueryResponse>;

build/es/src/data-v1-data-service.http.js

@@ -216,3 +216,7 @@ import { serializer } from '@wix/metro-runtime/ambassador';
 }
-/** Query for items in a collection. */
+/**
+ * Retrieves a list of items, on the basis of the paging, filtering, and sorting preferences you provide.
+ *
+ * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ */
 export function query(payload) {
@@ -219,0 +223,0 @@ const { toJSON: toReq, fromJSON: fromReq } = serializer(_queryRequest, {});

build/es/src/data-v1-data-service.types.d.ts

@@ -94,7 +94,7 @@ export interface Item {
 export interface RemoveResponse {
-    /** Removed item */
+    /** Removed item. */
     item?: Record<string, any> | null;
 }
 export interface TruncateRequest {
-    /** ID of the collection */
+    /** ID of the collection to truncate. */
     dataCollectionId?: string;
@@ -105,7 +105,12 @@ }
 export interface QueryRequest {
-    /** Query details. */
+    /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
     dataQuery?: QueryV2;
     /**
      * Whether to omit the total count in the response.
-     * Default: `false`.
+     * If `false`, the `totalCount` and `totalResults` have a value of 0 in the response.
+     *
+     * **Note:** The `totalCount` and `totalResults` fields are deprecated.
+     * We recommend using `pagingMetadata` instead.
+     *
+     * Default: `false`
      */
@@ -115,3 +120,3 @@ omitTotalCount?: boolean;
     includeReferencedItems?: string[];
-    /** Data collection ID. */
+    /** ID of the data collection to query. */
     dataCollectionId?: string;
@@ -201,10 +206,11 @@ }
 export interface QueryResponse {
-    /** Retrieved items */
+    /** Retrieved items. */
     items?: Record<string, any>[] | null;
-    /** Deprecated, use 'paging_metadata' instead. Total number of items satisfying the query */
+    /** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */
     totalCount?: number;
+    /** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */
     totalResults?: number;
-    /** Indicates if referenced items have been trimmed from the results */
+    /** Whether referenced items are trimmed from the results. */
     partialIncludes?: boolean;
-    /** Paging information */
+    /** Paging information. */
     pagingMetadata?: PagingMetadataV2;
@@ -325,5 +331,5 @@ }
 export interface DistinctResponse {
-    /** Retrieved items */
+    /** Retrieved items. */
     items?: any[];
-    /** Paging information */
+    /** Paging information. */
     pagingMetadata?: PagingMetadataV2;
@@ -330,0 +336,0 @@ }

build/es/src/data-v1-data-service.universal.d.ts

@@ -100,7 +100,7 @@ export declare const __debug: {
 export interface RemoveResponse {
-    /** Removed item */
+    /** Removed item. */
     item?: Record<string, any> | null;
 }
 export interface TruncateRequest {
-    /** ID of the collection */
+    /** ID of the collection to truncate. */
     dataCollectionId?: string;
@@ -111,7 +111,12 @@ }
 export interface QueryRequest {
-    /** Query details. */
+    /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
     dataQuery?: QueryV2;
     /**
      * Whether to omit the total count in the response.
-     * Default: `false`.
+     * If `false`, the `totalCount` and `totalResults` have a value of 0 in the response.
+     *
+     * **Note:** The `totalCount` and `totalResults` fields are deprecated.
+     * We recommend using `pagingMetadata` instead.
+     *
+     * Default: `false`
      */
@@ -121,3 +126,3 @@ omitTotalCount?: boolean;
     includeReferencedItems?: string[];
-    /** Data collection ID. */
+    /** ID of the data collection to query. */
     dataCollectionId?: string;
@@ -207,10 +212,11 @@ }
 export interface QueryResponse {
-    /** Retrieved items */
+    /** Retrieved items. */
     items?: Record<string, any>[] | null;
-    /** Deprecated, use 'paging_metadata' instead. Total number of items satisfying the query */
+    /** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */
     totalCount?: number;
+    /** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */
     totalResults?: number;
-    /** Indicates if referenced items have been trimmed from the results */
+    /** Whether referenced items are trimmed from the results. */
     partialIncludes?: boolean;
-    /** Paging information */
+    /** Paging information. */
     pagingMetadata?: PagingMetadataV2;
@@ -331,5 +337,5 @@ }
 export interface DistinctResponse {
-    /** Retrieved items */
+    /** Retrieved items. */
     items?: any[];
-    /** Paging information */
+    /** Paging information. */
     pagingMetadata?: PagingMetadataV2;
@@ -537,11 +543,18 @@ }
 /**
- * Query for items in a collection.
+ * Retrieves a list of items, on the basis of the paging, filtering, and sorting preferences you provide.
+ *
+ * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
  * @public */
 export declare function query(options?: QueryOptions): Promise<QueryResponse>;
 export interface QueryOptions {
-    /** Query details. */
+    /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
     dataQuery?: QueryV2;
     /**
      * Whether to omit the total count in the response.
-     * Default: `false`.
+     * If `false`, the `totalCount` and `totalResults` have a value of 0 in the response.
+     *
+     * **Note:** The `totalCount` and `totalResults` fields are deprecated.
+     * We recommend using `pagingMetadata` instead.
+     *
+     * Default: `false`
      */
@@ -551,4 +564,4 @@ omitTotalCount?: boolean;
     includeReferencedItems?: string[];
-    /** Data collection ID. */
+    /** ID of the data collection to query. */
     dataCollectionId?: string;
 }

build/es/src/data-v1-data-service.universal.js

@@ -49,3 +49,5 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
 /**
- * Query for items in a collection.
+ * Retrieves a list of items, on the basis of the paging, filtering, and sorting preferences you provide.
+ *
+ * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
  * @public */
@@ -52,0 +54,0 @@ export function query(options) {

package.json

 {
   "name": "@wix/data-backend-public-sdk-poc",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "publishConfig": {
@@ -36,3 +36,3 @@ "registry": "https://registry.npmjs.org/",
   },
-  "falconPackageHash": "57db5f3e7e695fc1b2dcfddecccab3c778a9d15846a1bfa3aab5ac8e"
+  "falconPackageHash": "5990a47eb8acbf6cc4ca05ba79df74cafc7b70b6730e5ae1ab6bcfa8"
 }

No alert changes

Improved metrics

Total package byte prevSize

118974

increased by3.77%

Lines of code

3001

increased by1.97%

No dependency changes