@extrahorizon/javascript-sdk 8.4.1-dev-64-3d65017 → 8.4.1-dev-65-8ee48f9

package/CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Changed
+- RQL `contains` and `excludes` now have their different variations better separated in the type definitions
+
 ## [8.4.1]
 
 ### Fixed

package/build/index.cjs.js

@@ -5368,7 +5368,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.4.1-dev-64-3d65017';
+const version = '8.4.1-dev-65-8ee48f9';
 
 /**
  * Create ExtraHorizon client.

package/build/index.mjs

@@ -5338,7 +5338,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.4.1-dev-64-3d65017';
+const version = '8.4.1-dev-65-8ee48f9';
 
 /**
  * Create ExtraHorizon client.

package/build/types/rql/types.d.ts

@@ -95,14 +95,15 @@ export interface RQLBuilder {
      */
     or: (...conditions: RQLString[]) => RQLBuilder;
     /**
-     * @description `contains(field)` only returns records having this field as property
+     * @description Only returns records having this field as property
      * @example
-     * await exh.data.documents.find(
-     *   schemaId,
-     *   { rql: rqlBuilder().contains('data.indicator').build()
+     * await exh.data.documents.find(schemaId, {
+     *   rql: rqlBuilder().contains('data.indicator').build()
      * });
      * @returns returns documents containing the `data.indicator` field
-     *
+     */
+    contains(field: string): RQLBuilder;
+    /**
      * @description Filters for objects where the specified property's value is an array and the array contains
      * any value that equals the provided value or satisfies the provided condition.
      * `contains(field, itemField > 30)` only returns records having a property `field` which have a prop `itemField` for which the condition is valid
@@ -113,34 +114,39 @@ export interface RQLBuilder {
      *         .contains(
      *              "data",
      *              rqlBuilder().gt("heartrate", "60").intermediate(),
-     *                rqlBuilder().lt("heartrate", "90").intermediate()
+     *              rqlBuilder().lt("heartrate", "90").intermediate()
      *          )
-     *          .build();
+     *          .build(),
      * });
      * @return Only returns documents with a data object containing `heartrate > 60` and `heartrate > 90`
      */
-    contains: (field: string, ...conditions: RQLString[]) => RQLBuilder;
+    contains(field: string, ...conditions: RQLString[]): RQLBuilder;
     /**
-     * @description `excludes(field)` only returns records not having this field as property
+     * @description Only returns records not having this field as property
      * @example
-     * await exh.data.documents.find(
-     *   schemaId,
-     *   { rql: rqlBuilder().excludes('data.indicator').build()
+     * await exh.data.documents.find(schemaId, {
+     *   rql: rqlBuilder().excludes('data.indicator').build()
      * });
      * @returns returns documents not containing the `data.indicator` field
-     *
+     */
+    excludes(field: string): RQLBuilder;
+    /**
      * @description Filters for objects where the specified property's value is an array and the array excludes
      * any value that equals the provided value or satisfies the provided condition.
      * `excludes(field, itemField > 30)` only returns records having a property `field` which have a prop `itemField` for which the condition is invalid
      * @example
      * await exh.data.documents.find(schemaId, {
      *   rql: rqlBuilder()
-     *     .excludes("data", rqlBuilder().gt("heartrate", "60").intermediate())
-     *     .build(),
+     *         .excludes(
+     *              "data",
+     *              rqlBuilder().gt("heartrate", "60").intermediate(),
+     *              rqlBuilder().lt("heartrate", "90").intermediate()
+     *          )
+     *          .build(),
      * });
-     * @return Only returns documents excluding documents where `data.heartrate > 60`
+     * @return Only returns documents excluding documents where `heartrate > 60` and `heartrate > 90`
      */
-    excludes: (field: string, ...conditions: RQLString[]) => RQLBuilder;
+    excludes(field: string, ...conditions: RQLString[]): RQLBuilder;
     /**
      * @description skipCount() Skips the record counting step of a request to increase performance.
      *

package/build/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.4.1-dev-64-3d65017";
+export declare const version = "8.4.1-dev-65-8ee48f9";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/javascript-sdk",
-  "version": "8.4.1-dev-64-3d65017",
+  "version": "8.4.1-dev-65-8ee48f9",
   "description": "This package serves as a JavaScript wrapper around all Extra Horizon cloud services.",
   "main": "build/index.cjs.js",
   "types": "build/types/index.d.ts",