arangojs - npm Package Compare versions

Comparing version 8.7.0 to 8.8.0

analyzer.d.ts

@@ -26,3 +26,3 @@ /**
  */
-export declare type CreateAnalyzerOptions = CreateIdentityAnalyzerOptions | CreateDelimiterAnalyzerOptions | CreateStemAnalyzerOptions | CreateNormAnalyzerOptions | CreateNgramAnalyzerOptions | CreateTextAnalyzerOptions | CreateSegmentationAnalyzerOptions | CreateAqlAnalyzerOptions | CreatePipelineAnalyzerOptions | CreateStopwordsAnalyzerOptions | CreateCollationAnalyzerOptions | CreateMinHashAnalyzerOptions | CreateClassificationAnalyzerOptions | CreateNearestNeighborsAnalyzerOptions | CreateGeoJsonAnalyzerOptions | CreateGeoPointAnalyzerOptions | CreateGeoS2AnalyzerOptions;
+export declare type CreateAnalyzerOptions = CreateIdentityAnalyzerOptions | CreateDelimiterAnalyzerOptions | CreateMultiDelimiterAnalyzerOptions | CreateStemAnalyzerOptions | CreateNormAnalyzerOptions | CreateNgramAnalyzerOptions | CreateTextAnalyzerOptions | CreateSegmentationAnalyzerOptions | CreateAqlAnalyzerOptions | CreatePipelineAnalyzerOptions | CreateStopwordsAnalyzerOptions | CreateCollationAnalyzerOptions | CreateMinHashAnalyzerOptions | CreateClassificationAnalyzerOptions | CreateNearestNeighborsAnalyzerOptions | CreateWildcardAnalyzerOptions | CreateGeoJsonAnalyzerOptions | CreateGeoPointAnalyzerOptions | CreateGeoS2AnalyzerOptions;
 /**
@@ -70,2 +70,24 @@ * Options for creating an Identity Analyzer.
 /**
+ * Options for creating a Multi-Delimiter Analyzer.
+ */
+export declare type CreateMultiDelimiterAnalyzerOptions = {
+    /**
+     * Type of the Analyzer.
+     */
+    type: "multi_delimiter";
+    /**
+     * Features to enable for this Analyzer.
+     */
+    features?: AnalyzerFeature[];
+    /**
+     * Additional properties for the Analyzer.
+     *
+     * The value will be used as delimiter to split text into tokens as specified
+     * in RFC 4180, without starting new records on newlines.
+     */
+    properties: {
+        delimiters: string[];
+    };
+};
+/**
  * Options for creating a Stem Analyzer.
@@ -469,2 +491,28 @@ */
 /**
+ * Options for creating a Wildcard Analyzer.
+ */
+export declare type CreateWildcardAnalyzerOptions = {
+    /**
+     * Type of the Analyzer.
+     */
+    type: "wildcard";
+    /**
+     * Features to enable for this Analyzer.
+     */
+    features?: AnalyzerFeature[];
+    /**
+     * Additional properties for the Analyzer.
+     */
+    properties: {
+        /**
+         * N-gram length. Must be a positive integer greater than or equal to 2.
+         */
+        ngramSize: string;
+        /**
+         * An Analyzer definition-like object with `type` and `properties` attributes.
+         */
+        analyzer?: Omit<CreateAnalyzerOptions, "features">;
+    };
+};
+/**
  * Options for creating a GeoJSON Analyzer
@@ -612,3 +660,3 @@ */
  */
-export declare type AnalyzerDescription = IdentityAnalyzerDescription | DelimiterAnalyzerDescription | StemAnalyzerDescription | NormAnalyzerDescription | NgramAnalyzerDescription | TextAnalyzerDescription | SegmentationAnalyzerDescription | AqlAnalyzerDescription | PipelineAnalyzerDescription | StopwordsAnalyzerDescription | CollationAnalyzerDescription | MinHashAnalyzerDescription | ClassificationAnalyzerDescription | NearestNeighborsAnalyzerDescription | GeoJsonAnalyzerDescription | GeoPointAnalyzerDescription | GeoS2AnalyzerDescription;
+export declare type AnalyzerDescription = IdentityAnalyzerDescription | DelimiterAnalyzerDescription | MultiDelimiterAnalyzerDescription | StemAnalyzerDescription | NormAnalyzerDescription | NgramAnalyzerDescription | TextAnalyzerDescription | SegmentationAnalyzerDescription | AqlAnalyzerDescription | PipelineAnalyzerDescription | StopwordsAnalyzerDescription | CollationAnalyzerDescription | MinHashAnalyzerDescription | ClassificationAnalyzerDescription | NearestNeighborsAnalyzerDescription | WildcardAnalyzerDescription | GeoJsonAnalyzerDescription | GeoPointAnalyzerDescription | GeoS2AnalyzerDescription;
 /**
@@ -631,2 +679,11 @@ * An object describing an Identity Analyzer.
 /**
+ * An object describing a Multi Delimiter Analyzer.
+ */
+export declare type MultiDelimiterAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "multi_delimiter";
+    properties: {
+        delimiters: string[];
+    };
+};
+/**
  * An object describing a Stem Analyzer.
@@ -765,2 +822,12 @@ */
 /**
+ * An object describing a Wildcard Analyzer
+ */
+export declare type WildcardAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "wildcard";
+    properties: {
+        ngramSize: number;
+        analyzer?: Omit<AnalyzerDescription, "name" | "features">;
+    };
+};
+/**
  * An object describing a GeoJSON Analyzer
@@ -767,0 +834,0 @@ */

CHANGELOG.md

@@ -17,2 +17,30 @@ # Changelog
 
+## [8.8.0]
+
+### Changed
+
+- Renamed ZKD index type to MDI (DE-744)
+
+  The ZKD index type was previously marked as experimental and has now been
+  finalized and renamed to MDI in ArangoDB 3.12.
+
+- Added `DocumentOperationMetadata` and `DocumentOperationFailure` types (DE-693)
+
+  The return types of document and edge operations on collections have been
+  modified to correctly represent the return values of bulk operations and
+  single document/edge operations using the `overwriteMode` option.
+
+### Deprecated
+
+- Deprecated active failover support (DE-746)
+
+  Active failover is no longer be supported in ArangoDB 3.12 and later. This
+  functionality will be removed from the driver in a future release.
+
+### Added
+
+- Added support for `multi_delimiter` analyzer type (DE-753)
+
+- Added support for `wildcard` analyzer type (DE-750)
+
 ## [8.7.0] - 2024-02-14
@@ -79,3 +107,3 @@
 
-  The `POST` route was deprecated and the `PUT` route is supported in all
+  The `PUT` route was deprecated and the `POST` route is supported in all
   actively maintained versions of ArangoDB.
@@ -1765,2 +1793,3 @@
 
+[8.8.0]: https://github.com/arangodb/arangojs/compare/v8.7.0...v8.8.0
 [8.7.0]: https://github.com/arangodb/arangojs/compare/v8.6.0...v8.7.0
@@ -1767,0 +1796,0 @@ [8.6.0]: https://github.com/arangodb/arangojs/compare/v8.5.0...v8.6.0

connection.d.ts

@@ -277,5 +277,5 @@ /// <reference types="node" />
      *
-     * When working with a cluster or a single server with leader/follower
-     * failover, the method {@link database.Database#acquireHostList} can be used to
-     * automatically pick up additional coordinators/followers at any point.
+     * When working with a cluster, the method {@link database.Database#acquireHostList}
+     * can be used to automatically pick up additional coordinators/followers at
+     * any point.
      *
@@ -356,4 +356,4 @@ * When running ArangoDB on a unix socket, e.g. `/tmp/arangodb.sock`, the
      *
-     * When working with a single server without leader/follower failover, the
-     * retries (if any) will be made to the same server.
+     * When working with a single server, the retries (if any) will be made to
+     * the same server.
      *
@@ -360,0 +360,0 @@ * This setting currently has no effect when using arangojs in a browser.

connection.js

@@ -454,3 +454,3 @@ "use strict";
                 "x-arango-version": String(this._arangoVersion),
-                "x-arango-driver": `arangojs/8.7.0 (cloud)`,
+                "x-arango-driver": `arangojs/8.8.0 (cloud)`,
             };
@@ -457,0 +457,0 @@ if (this._transactionId) {

indexes.d.ts

@@ -6,6 +6,6 @@ /**
  *   GeoIndex,
+ *   MdiIndex,
  *   PersistentIndex,
  *   PrimaryIndex,
  *   TtlIndex,
- *   ZkdIndex,
  * } from "arangojs/indexes";
@@ -216,9 +216,9 @@ * ```
 /**
- * Options for creating a ZKD index.
+ * Options for creating a MDI index.
  */
-export declare type EnsureZkdIndexOptions = {
+export declare type EnsureMdiIndexOptions = {
     /**
      * Type of this index.
      */
-    type: "zkd";
+    type: "mdi";
     /**
@@ -615,6 +615,6 @@ * An array containing attribute paths for the dimensions.
 /**
- * An object representing a ZKD index.
+ * An object representing a MDI index.
  */
-export declare type ZkdIndex = GenericIndex & {
-    type: "zkd";
+export declare type MdiIndex = GenericIndex & {
+    type: "mdi";
     fields: string[];
@@ -682,3 +682,3 @@ fieldValueTypes: "double";
  */
-export declare type Index = GeoIndex | FulltextIndex | PersistentIndex | PrimaryIndex | TtlIndex | ZkdIndex | InvertedIndex;
+export declare type Index = GeoIndex | FulltextIndex | PersistentIndex | PrimaryIndex | TtlIndex | MdiIndex | InvertedIndex;
 export declare type ObjectWithId = {
@@ -685,0 +685,0 @@ [key: string]: any;

indexes.js

@@ -7,6 +7,6 @@ "use strict";
  *   GeoIndex,
+ *   MdiIndex,
  *   PersistentIndex,
  *   PrimaryIndex,
  *   TtlIndex,
- *   ZkdIndex,
  * } from "arangojs/indexes";
@@ -13,0 +13,0 @@ * ```

package.json

 {
   "name": "arangojs",
-  "version": "8.7.0",
+  "version": "8.8.0",
   "engines": {
@@ -5,0 +5,0 @@ "node": ">=14"

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2332938

increased by0.48%

Lines of code

21806

increased by0.45%

No dependency changes