arangojs - npm Package Compare versions

Comparing version 7.4.0 to 7.5.0-preview-arangodb.3.8

analyzer.d.ts

@@ -42,3 +42,3 @@ /**
  */
-export declare type AnalyzerInfo = IdentityAnalyzerInfo | DelimiterAnalyzerInfo | StemAnalyzerInfo | NormAnalyzerInfo | NgramAnalyzerInfo | TextAnalyzerInfo;
+export declare type AnalyzerInfo = IdentityAnalyzerInfo | DelimiterAnalyzerInfo | StemAnalyzerInfo | NormAnalyzerInfo | NgramAnalyzerInfo | TextAnalyzerInfo | PipelineAnalyzer | AqlAnalyzer | GeoJsonAnalyzer | GeoPointAnalyzer | StopwordsAnalyzer;
 /**
@@ -204,2 +204,10 @@ * Analyzer type and type-specific properties for an Identity Analyzer.
     stemming?: boolean;
+    /**
+     * If present, then edge n-grams are generated for each token (word).
+     */
+    edgeNgram?: {
+        min?: number;
+        max?: number;
+        preserveOriginal?: boolean;
+    };
 };
@@ -220,2 +228,175 @@ /**
 /**
+ * Properties of a Pipeline Analyzer.
+ */
+export declare type PipelineAnalyzerProperties = {
+    /**
+     * Definitions for Analyzers to chain in this Pipeline Analyzer.
+     */
+    pipeline: AnalyzerInfo[];
+};
+/**
+ * Analyzer type and type-specific properties for a Pipeline Analyzer
+ */
+export declare type PipelineAnalyzer = {
+    /**
+     * Type of the Analyzer.
+     */
+    type: "pipeline";
+    /**
+     * Additional properties for the Analyzer.
+     */
+    properties: PipelineAnalyzerProperties;
+};
+/**
+ * Properties of an AQL Analyzer.
+ */
+export declare type AqlAnalyzerProperties = {
+    /**
+     * AQL query to be executed.
+     */
+    queryString: string;
+    /**
+     * If set to `true`, the position is set to `0` for all members of the query result array.
+     *
+     * Default: `false`
+     */
+    collapsePositions?: boolean;
+    /**
+     * If set to `false`, `null` values will be discarded from the View index.
+     *
+     * Default: `true`
+     */
+    keepNull?: boolean;
+    /**
+     * Number between `1` and `1000` that determines the batch size for reading
+     * data from the query.
+     *
+     * Default: `1`
+     */
+    batchSize?: number;
+    /**
+     * Memory limit for query execution in bytes.
+     *
+     * Default: `1048576` (1 MiB)
+     */
+    memoryLimit?: number;
+    /**
+     * Data type of the returned tokens.
+     *
+     * Default: `"string"`
+     */
+    returnType?: "string" | "number" | "bool";
+};
+/**
+ * Analyzer type and type-specific properties for an AQL Analyzer
+ */
+export declare type AqlAnalyzer = {
+    /**
+     * Type of the Analyzer.
+     */
+    type: "aql";
+    /**
+     * Additional properties for the Analyzer.
+     */
+    properties: AqlAnalyzerProperties;
+};
+/**
+ * Properties of a GeoJSON Analyzer.
+ */
+export declare type GeoJsonAnalyzerProperties = {
+    /**
+     * If set to `"centroid"`, only the centroid of the input geometry will be
+     * computed and indexed.
+     *
+     * If set to `"point"` only GeoJSON objects of type Point will be indexed and
+     * all other geometry types will be ignored.
+     *
+     * Default: `"shape"`
+     */
+    type?: "shape" | "centroid" | "point";
+    /**
+     * Options for fine-tuning geo queries.
+     *
+     * Default: `{ maxCells: 20, minLevel: 4, maxLevel: 23 }`
+     */
+    options?: {
+        maxCells?: number;
+        minLevel?: number;
+        maxLevel?: number;
+    };
+};
+/**
+ * Analyzer type and type-specific properties for a GeoJSON Analyzer
+ */
+export declare type GeoJsonAnalyzer = {
+    /**
+     * Type of the Analyzer.
+     */
+    type: "geojson";
+    /**
+     * Additional properties for the Analyzer.
+     */
+    properties: GeoJsonAnalyzerProperties;
+};
+/**
+ * Properties of a GeoPoint Analyzer.
+ */
+export declare type GeoPointAnalyzerProperties = {
+    /**
+     * Attribute paths of the latitude value relative to the field for which the
+     * Analyzer is defined in the View.
+     */
+    latitude?: string[];
+    /**
+     * Attribute paths of the longitude value relative to the field for which the
+     * Analyzer is defined in the View.
+     */
+    longitude?: string[];
+    /**
+     * Options for fine-tuning geo queries.
+     *
+     * Default: `{ maxCells: 20, minLevel: 4, maxLevel: 23 }`
+     */
+    options?: {
+        minCells?: number;
+        minLevel?: number;
+        maxLevel?: number;
+    };
+};
+/**
+ * Analyzer type and type-specific properties for a GeoPoint Analyzer
+ */
+export declare type GeoPointAnalyzer = {
+    /**
+     * Type of the Analyzer.
+     */
+    type: "geopoint";
+    /**
+     * Additional properties for the Analyzer.
+     */
+    properties: GeoPointAnalyzerProperties;
+};
+/**
+ * Properties of a Stopwords Analyzer.
+ */
+export declare type StopwordsAnalyzerProperties = {
+    /**
+     * Hex-encoded strings that describe the tokens to be discarded.
+     */
+    stopwords: string[];
+};
+/**
+ * Analyzer type and type-specific properties for a Stopwords Analyzer
+ */
+export declare type StopwordsAnalyzer = {
+    /**
+     * Type of the Analyzer.
+     */
+    type: "stopwords";
+    /**
+     * Additional properties for the Analyzer.
+     */
+    properties: StopwordsAnalyzerProperties;
+};
+/**
  * Represents an Analyzer in a {@link Database}.
@@ -222,0 +403,0 @@ */

CHANGELOG.md

@@ -17,2 +17,17 @@ # Changelog
 
+## [7.5.0-preview-arangodb.3.8] - 2021-04-09
+
+### Added
+
+- Added support for new ArangoDB 3.8 Analyzer types
+
+  This adds the `PipelineAnalyzer`, `AqlAnalyzer`, `GeoJsonAnalyzer`,
+  `GeoPointAnalyzer` and `StopwordsAnalyzer` types in TypeScript, as well as
+  the Analyzer-specific properties types.
+
+- Added support for new ArangoDB 3.8 `estimates` option for indexes
+
+  This affects the `PersistentIndex`, `HashIndex` and `SkiplistIndex` types
+  in TypeScript.
+
 ## [7.4.0] - 2021-04-09
@@ -1189,2 +1204,3 @@
 
+[7.5.0-preview-arangodb.3.8]: https://github.com/arangodb/arangojs/compare/v7.4.0...v7.5.0-preview-arangodb.3.8
 [7.4.0]: https://github.com/arangodb/arangojs/compare/v7.3.0...v7.4.0
@@ -1191,0 +1207,0 @@ [7.3.0]: https://github.com/arangodb/arangojs/compare/v7.2.0...v7.3.0

indexes.d.ts

@@ -57,2 +57,9 @@ /**
     deduplicate?: boolean;
+    /**
+     * If set to `false`, index selectivity estimates will be disabled for this
+     * index.
+     *
+     * Default: `true`
+     */
+    estimates?: boolean;
 };
@@ -98,2 +105,9 @@ /**
     deduplicate?: boolean;
+    /**
+     * If set to `false`, index selectivity estimates will be disabled for this
+     * index.
+     *
+     * Default: `true`
+     */
+    estimates?: boolean;
 };
@@ -130,2 +144,9 @@ /**
     sparse?: boolean;
+    /**
+     * If set to `false`, index selectivity estimates will be disabled for this
+     * index.
+     *
+     * Default: `true`
+     */
+    estimates?: boolean;
 };
@@ -132,0 +153,0 @@ /**

package.json

 {
   "name": "arangojs",
-  "version": "7.4.0",
+  "version": "7.5.0-preview-arangodb.3.8",
   "engines": {
@@ -5,0 +5,0 @@ "node": ">=10"

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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

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

2107352

increased by0.81%

Lines of code

18456

increased by1.11%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

No dependency changes