npm - arangojs - Versions diffs - 7.3.0 → 7.6.0 - Mend

arangojs 7.3.0 → 7.6.0

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.

Files changed (56) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -14,6 +14,78 @@ This driver uses semantic versioning:
 - A change in the major version (e.g. 1.Y.Z -> 2.0.0) indicates _breaking_
   changes that require changes in your code to upgrade.
+## [7.6.0] - 2021-10-20
+### Added
+- Added `collection.documents` for fetching multiple documents
+- Added support for `fillBlockCache` query option
+- Added support for passing `Graph` objects in AQL queries [#740](https://github.com/arangodb/arangojs/issues/740)
+  This also adds the `isArangoGraph` helper function for type checking.
+- Added User Management API [#664](https://github.com/arangodb/arangojs/issues/664)
+  This implements the endpoints of the
+  [HTTP Interface for User Management](https://www.arangodb.com/docs/stable/http/user-management.html)
+### Fixed
+- Added missing `hex` flag to `StopwordsAnalyzer` type [#732](https://github.com/arangodb/arangojs/issues/732)
+- Added missing `details` flag to `collection.figures` [#728](https://github.com/arangodb/arangojs/issues/728)
+- Added missing `inBackground` flag to index options [#734](https://github.com/arangodb/arangojs/issues/734)
+## [7.5.0] - 2021-04-22
+### 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
+### Added
+- Implemented `toJSON` methods for `ArangoError` and `HttpError` ([#632](https://github.com/arangodb/arangojs/issues/632))
+  This prevents an error where `JSON.stringify` would reliably throw if passed
+  an instance of either of these error types generated by arangojs. Note that
+  you may still want to implement your own JSON representation logic as system
+  errors (e.g. `ECONNREFUSED`) are not wrapped by arangojs and thrown as-is.
+### Fixed
+- Stack traces are now improved for most errors when using `precaptureStackTraces` ([#722](https://github.com/arangodb/arangojs/issues/722))
+  Previously this option would only affect network errors, making it far less
+  useful than intended. Now parsing errors, `ArangoError` instances and HTTP
+  errors also receive improved error stack traces when this option is enabled.
+- Improved performance for `precaptureStackTraces` when no errors occur
+  The generated stack is now only accessed on demand, allowing the runtime to
+  delay generation of the stack trace string. Previously the stack would always
+  be accessed prior to the request being sent, causing a noticeable delay even
+  when no error occurs.
+- Fixed document selector validation in `collection.edges` and its variants ([#704](https://github.com/arangodb/arangojs/issues/704))
+  These methods previously only permitted start vertices that are documents
+  within the edge collection itself. This behavior has now been corrected to
+  permit start vertices outside the collection, as expected.
 ## [7.3.0] - 2021-03-08
 ### Changed
@@ -1153,6 +1225,9 @@ For a detailed list of changes between pre-release versions of v7 see the
   Graph methods now only return the relevant part of the response body.
+[7.6.0]: https://github.com/arangodb/arangojs/compare/v7.5.0...v7.6.0
+[7.5.0]: https://github.com/arangodb/arangojs/compare/v7.4.0...v7.5.0
+[7.4.0]: https://github.com/arangodb/arangojs/compare/v7.3.0...v7.4.0
 [7.3.0]: https://github.com/arangodb/arangojs/compare/v7.2.0...v7.3.0
 [7.2.0]: https://github.com/arangodb/arangojs/compare/v7.1.1...v7.2.0
 [7.1.1]: https://github.com/arangodb/arangojs/compare/v7.1.0...v7.1.1

package/README.md CHANGED Viewed

@@ -69,12 +69,12 @@ Modern JavaScript/TypeScript with async/await:
 const { Database, aql } = require("arangojs");
 const db = new Database();
-const pokemons = db.collection("my-pokemons");
+const Pokemons = db.collection("my-pokemons");
 async function main() {
   try {
     const pokemons = await db.query(aql`
-      FOR pokemon IN ${pokemons}
+      FOR pokemon IN ${Pokemons}
       FILTER pokemon.type == "fire"
       RETURN pokemon
     `);
@@ -345,6 +345,8 @@ Please refer to the documentation of this method for additional examples.
 ### Streaming transactions timeout in cluster
+Example messages: `transaction not found`, `transaction already expired`.
 Transactions have
 [different guarantees](https://www.arangodb.com/docs/stable/transactions-limitations.html#in-clusters)
 in a cluster.

package/analyzer.d.ts CHANGED Viewed

@@ -39,7 +39,7 @@ export declare type CreateAnalyzerOptions = AnalyzerInfo & {
 /**
  * Analyzer type and its type-specific properties.
  */
-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;
 /**
  * Analyzer type and type-specific properties for an Identity Analyzer.
  */
@@ -200,6 +200,14 @@ export declare type TextAnalyzerProperties = {
      * Default: `true`
      */
     stemming?: boolean;
+    /**
+     * If present, then edge n-grams are generated for each token (word).
+     */
+    edgeNgram?: {
+        min?: number;
+        max?: number;
+        preserveOriginal?: boolean;
+    };
 };
 /**
  * Analyzer type and type-specific properties for a Text Analyzer.
@@ -214,6 +222,185 @@ export declare type TextAnalyzerInfo = {
      */
     properties: TextAnalyzerProperties;
 };
+/**
+ * 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 = {
+    /**
+     * Array of strings that describe the tokens to be discarded.
+     */
+    stopwords: string[];
+    /**
+     * Whether stopword values should be interpreted as hex-encoded strings.
+     *
+     * Default: `false`
+     */
+    hex?: boolean;
+};
+/**
+ * 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}.
  */

package/analyzer.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"analyzer.d.ts","sourceRoot":"","sources":["../src/analyzer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,GAAG,GAAG,QAAQ,IAAI,QAAQ,CAEpE;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,CAAC;AAEhE;;GAEG;AACH,oBAAY,mBAAmB,GAAG,YAAY,GAAG;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB,GAAG,YAAY,GAAG;IACjD;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,oBAAY,YAAY,GACpB,oBAAoB,GACpB,qBAAqB,GACrB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,GACjB,gBAAgB,CAAC;~~AAErB~~;;GAEG;AACH,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IACjB;;;;OAIG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAClB;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;OAMG;IACH,UAAU,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,oBAAY,sBAAsB,GAAG;IACnC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;IAClC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,oBAAY,uBAAuB,GAAG;IACpC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,UAAU,EAAE,uBAAuB,CAAC;CACrC,CAAC;AAEF;;GAEG;AACH,oBAAY,sBAAsB,GAAG;IACnC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;IAClC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;~~CACpB~~,CAAC;AAEF;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,qBAAa,QAAQ;IACnB,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC;IAExB;;;OAGG;gBACS,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM;IAKtC;;;;OAIG;IACH,IAAI,gBAAgB,IAAI,IAAI,CAE3B;IAED;;;;OAIG;IACH,IAAI,IAAI,WAEP;IAED;;;;;;;;;;OAUG;IACG,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAYhC;;;;;;;;;;OAUG;IACH,GAAG,IAAI,OAAO,CAAC,sBAAsB,GAAG,mBAAmB,CAAC;IAO5D;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAWpE;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAK,GAAE,OAAe,GACrB,OAAO,CAAC,sBAAsB,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAUtD"}
1	+ {"version":3,"file":"analyzer.d.ts","sourceRoot":"","sources":["../src/analyzer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,GAAG,GAAG,QAAQ,IAAI,QAAQ,CAEpE;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,CAAC;AAEhE;;GAEG;AACH,oBAAY,mBAAmB,GAAG,YAAY,GAAG;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB,GAAG,YAAY,GAAG;IACjD;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,oBAAY,YAAY,GACpB,oBAAoB,GACpB,qBAAqB,GACrB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,WAAW,GACX,eAAe,GACf,gBAAgB,GAChB,iBAAiB,CAAC;AAEtB;;GAEG;AACH,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IACjB;;;;OAIG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAClB;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;OAMG;IACH,UAAU,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,oBAAY,sBAAsB,GAAG;IACnC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;IAClC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,oBAAY,uBAAuB,GAAG;IACpC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,UAAU,EAAE,uBAAuB,CAAC;CACrC,CAAC;AAEF;;GAEG;AACH,oBAAY,sBAAsB,GAAG;IACnC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;IAClC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CACxE,CAAC;AAEF;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,oBAAY,0BAA0B,GAAG;IACvC;;OAEG;IACH,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IACjB;;OAEG;IACH,UAAU,EAAE,0BAA0B,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,oBAAY,WAAW,GAAG;IACxB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IACZ;;OAEG;IACH,UAAU,EAAE,qBAAqB,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,oBAAY,yBAAyB,GAAG;IACtC;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC;IACtC;;;;OAIG;IACH,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACvE,CAAC;AAEF;;GAEG;AACH,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,yBAAyB,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,oBAAY,0BAA0B,GAAG;IACvC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB;;;;OAIG;IACH,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACvE,CAAC;AAEF;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IACjB;;OAEG;IACH,UAAU,EAAE,0BAA0B,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,oBAAY,2BAA2B,GAAG;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB;;;;OAIG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAClB;;OAEG;IACH,UAAU,EAAE,2BAA2B,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,qBAAa,QAAQ;IACnB,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC;IAExB;;;OAGG;gBACS,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM;IAKtC;;;;OAIG;IACH,IAAI,gBAAgB,IAAI,IAAI,CAE3B;IAED;;;;OAIG;IACH,IAAI,IAAI,WAEP;IAED;;;;;;;;;;OAUG;IACG,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAYhC;;;;;;;;;;OAUG;IACH,GAAG,IAAI,OAAO,CAAC,sBAAsB,GAAG,mBAAmB,CAAC;IAO5D;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAWpE;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAK,GAAE,OAAe,GACrB,OAAO,CAAC,sBAAsB,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAUtD"}

package/analyzer.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"analyzer.js","sourceRoot":"","sources":["../src/analyzer.ts"],"names":[],"mappings":";;;AAYA,mCAAwC;AACxC,uCAAiD;AAEjD;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,QAAa;IAC5C,OAAO,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC,gBAAgB,CAAC,CAAC;AACxD,CAAC;AAFD,4CAEC;AAuND;;GAEG;AACH,MAAa,QAAQ;IAInB;;;OAGG;IACH,YAAY,EAAY,EAAE,IAAY;QACpC,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM;QACV,IAAI;YACF,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;SACb;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,qBAAa,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,KAAK,0BAAkB,EAAE;gBAC7D,OAAO,KAAK,CAAC;aACd;YACD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CACrB,EAAE,IAAI,EAAE,kBAAkB,IAAI,CAAC,IAAI,EAAE,EAAE,EACvC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAClB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,OAA8B;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CACrB;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,OAAO,EAAE;SACtC,EACD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAClB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,QAAiB,KAAK;QAEtB,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CACrB;YACE,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,kBAAkB,IAAI,CAAC,IAAI,EAAE;YACnC,EAAE,EAAE,EAAE,KAAK,EAAE;SACd,EACD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAClB,CAAC;IACJ,CAAC;CACF;AA5HD,4BA4HC","sourcesContent":["/*\n ```ts\n * import type { Analyzer } from \"arangojs/analyzer\";\n * ```\n \n The \"analyzer\" module provides analyzer related types and interfaces\n * for TypeScript.\n \n @packageDocumentation\n /\nimport { ArangoResponseMetadata } from \"./connection\";\nimport { Database } from \"./database\";\nimport { isArangoError } from \"./error\";\nimport { ANALYZER_NOT_FOUND } from \"./lib/codes\";\n\n/\n Indicates whether the given value represents an {@link Analyzer}.\n \n @param analyzer - A value that might be an Analyzer.\n /\nexport function isArangoAnalyzer(analyzer: any): analyzer is Analyzer {\n return Boolean(analyzer && analyzer.isArangoAnalyzer);\n}\n\n/\n Name of a feature enabled for an Analyzer.\n /\nexport type AnalyzerFeature = \"frequency\" \| \"norm\" \| \"position\";\n\n/\n An object describing an Analyzer.\n /\nexport type AnalyzerDescription = AnalyzerInfo & {\n name: string;\n features: AnalyzerFeature[];\n};\n\n/\n Options for creating an Analyzer.\n /\nexport type CreateAnalyzerOptions = AnalyzerInfo & {\n /\n Features to enable for this Analyzer.\n /\n features?: AnalyzerFeature[];\n};\n\n/\n Analyzer type and its type-specific properties.\n /\nexport type AnalyzerInfo =\n \| IdentityAnalyzerInfo\n \| DelimiterAnalyzerInfo\n \| StemAnalyzerInfo\n \| NormAnalyzerInfo\n \| NgramAnalyzerInfo\n \| TextAnalyzerInfo;\n\n/\n Analyzer type and type-specific properties for an Identity Analyzer.\n /\nexport type IdentityAnalyzerInfo = {\n /\n Type of the Analyzer.\n /\n type: \"identity\";\n /\n Additional properties for the Analyzer.\n \n The `identity` Analyzer does not take additional properties.\n /\n properties?: null;\n};\n\n/\n Analyzer type and type-specific properties for a Delimiter Analyzer.\n /\nexport type DelimiterAnalyzerInfo = {\n /\n Type of the Analyzer.\n /\n type: \"delimiter\";\n /\n Additional properties for the Analyzer.\n \n The value will be used as delimiter to split text into tokens as specified\n * in RFC 4180, without starting new records on newlines.\n /\n properties: string \| { delimiter: string };\n};\n\n/\n Analyzer type and type-specific properties for a Stem Analyzer.\n /\nexport type StemAnalyzerInfo = {\n /\n Type of the Analyzer.\n /\n type: \"stem\";\n /\n Additional properties for the Analyzer.\n \n The value defines the text locale.\n \n Format: `language[_COUNTRY][.encoding][@variant]`\n /\n properties: { locale: string };\n};\n\n/\n Properties of a Norm Analyzer.\n /\nexport type NormAnalyzerProperties = {\n /\n Text locale.\n \n Format: `language[_COUNTRY][.encoding][@variant]`\n /\n locale: string;\n /\n Case conversion.\n \n Default: `\"lower\"`\n /\n case?: \"lower\" \| \"none\" \| \"upper\";\n /\n Preserve accents in returned words.\n \n Default: `false`\n /\n accent?: boolean;\n};\n\n/\n Analyzer type and type-specific properties for a Norm Analyzer.\n /\nexport type NormAnalyzerInfo = {\n /\n Type of the Analyzer.\n /\n type: \"norm\";\n /\n Additional properties for the Analyzer.\n /\n properties: NormAnalyzerProperties;\n};\n\n/\n Properties of an Ngram Analyzer.\n /\nexport type NgramAnalyzerProperties = {\n /\n Maximum n-gram length.\n /\n max: number;\n /\n Minimum n-gram length.\n /\n min: number;\n /\n Output the original value as well.\n /\n preserveOriginal: boolean;\n};\n\n/\n Analyzer type and type-specific properties for an Ngram Analyzer.\n /\nexport type NgramAnalyzerInfo = {\n /\n Type of the Analyzer.\n /\n type: \"ngram\";\n /\n Additional properties for the Analyzer.\n /\n properties: NgramAnalyzerProperties;\n};\n\n/\n Properties of a Text Analyzer.\n /\nexport type TextAnalyzerProperties = {\n /\n Text locale.\n \n Format: `language[_COUNTRY][.encoding][@variant]`\n /\n locale: string;\n /\n Case conversion.\n \n Default: `\"lower\"`\n /\n case?: \"lower\" \| \"none\" \| \"upper\";\n /\n Words to omit from result.\n \n Defaults to the words loaded from the file at `stopwordsPath`.\n /\n stopwords?: string[];\n /\n Path with a `language` sub-directory containing files with words to omit.\n \n Defaults to the path specified in the server-side environment variable\n * `IRESEARCH_TEXT_STOPWORD_PATH` or the current working directory of the\n * ArangoDB process.\n /\n stopwordsPath?: string;\n /\n Preserve accents in returned words.\n \n Default: `false`\n /\n accent?: boolean;\n /\n Apply stemming on returned words.\n \n Default: `true`\n /\n stemming?: boolean;\n};\n\n/\n Analyzer type and type-specific properties for a Text Analyzer.\n /\nexport type TextAnalyzerInfo = {\n /\n Type of the Analyzer.\n /\n type: \"text\";\n /\n Additional properties for the Analyzer.\n /\n properties: TextAnalyzerProperties;\n};\n\n/\n Represents an Analyzer in a {@link Database}.\n /\nexport class Analyzer {\n protected _name: string;\n protected _db: Database;\n\n /\n @internal\n * @hidden\n /\n constructor(db: Database, name: string) {\n this._db = db;\n this._name = name;\n }\n\n /\n @internal\n \n Indicates that this object represents an ArangoDB Analyzer.\n /\n get isArangoAnalyzer(): true {\n return true;\n }\n\n /\n Name of this Analyzer.\n \n See also {@link Database.analyzer}.\n /\n get name() {\n return this._name;\n }\n\n /\n Checks whether the Analyzer exists.\n \n @example\n * ```js\n * const db = new Database();\n * const analyzer = db.analyzer(\"some-analyzer\");\n * const result = await analyzer.exists();\n * // result indicates whether the Analyzer exists\n * ```\n /\n async exists(): Promise<boolean> {\n try {\n await this.get();\n return true;\n } catch (err) {\n if (isArangoError(err) && err.errorNum === ANALYZER_NOT_FOUND) {\n return false;\n }\n throw err;\n }\n }\n\n /\n Retrieves the Analyzer definition for the Analyzer.\n \n @example\n * ```js\n * const db = new Database();\n * const analyzer = db.analyzer(\"some-analyzer\");\n * const definition = await analyzer.get();\n * // definition contains the Analyzer definition\n * ```\n /\n get(): Promise<ArangoResponseMetadata & AnalyzerDescription> {\n return this._db.request(\n { path: `/_api/analyzer/${this.name}` },\n (res) => res.body\n );\n }\n\n /\n Creates a new Analyzer with the given `options` and the instance's name.\n \n See also {@link Database.createAnalyzer}.\n \n @param options - Options for creating the Analyzer.\n \n @example\n * ```js\n * const db = new Database();\n * const analyzer = db.analyzer(\"potatoes\");\n * await analyzer.create({ type: \"identity\" });\n * // the identity Analyzer \"potatoes\" now exists\n * ```\n /\n create(options: CreateAnalyzerOptions): Promise<AnalyzerDescription> {\n return this._db.request(\n {\n method: \"POST\",\n path: \"/_api/analyzer\",\n body: { name: this.name, ...options },\n },\n (res) => res.body\n );\n }\n\n /\n Deletes the Analyzer from the database.\n \n @param force - Whether the Analyzer should still be deleted even if it\n * is currently in use.\n \n @example\n * ```js\n * const db = new Database();\n * const analyzer = db.analyzer(\"some-analyzer\");\n * await analyzer.drop();\n * // the Analyzer \"some-analyzer\" no longer exists\n * ```\n */\n drop(\n force: boolean = false\n ): Promise<ArangoResponseMetadata & { name: string }> {\n return this._db.request(\n {\n method: \"DELETE\",\n path: `/_api/analyzer/${this.name}`,\n qs: { force },\n },\n (res) => res.body\n );\n }\n}\n"]}
1	+ {"version":3,"file":"analyzer.js","sourceRoot":"","sources":["../src/analyzer.ts"],"names":[],"mappings":";;;AAYA,mCAAwC;AACxC,uCAAiD;AAEjD;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,QAAa;IAC5C,OAAO,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC,gBAAgB,CAAC,CAAC;AACxD,CAAC;AAFD,4CAEC;AAqZD;;GAEG;AACH,MAAa,QAAQ;IAInB;;;OAGG;IACH,YAAY,EAAY,EAAE,IAAY;QACpC,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM;QACV,IAAI;YACF,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;SACb;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,qBAAa,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,KAAK,0BAAkB,EAAE;gBAC7D,OAAO,KAAK,CAAC;aACd;YACD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CACrB,EAAE,IAAI,EAAE,kBAAkB,IAAI,CAAC,IAAI,EAAE,EAAE,EACvC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAClB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,OAA8B;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CACrB;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,OAAO,EAAE;SACtC,EACD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAClB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,QAAiB,KAAK;QAEtB,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CACrB;YACE,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,kBAAkB,IAAI,CAAC,IAAI,EAAE;YACnC,EAAE,EAAE,EAAE,KAAK,EAAE;SACd,EACD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAClB,CAAC;IACJ,CAAC;CACF;AA5HD,4BA4HC","sourcesContent":["/*\n ```ts\n * import type { Analyzer } from \"arangojs/analyzer\";\n * ```\n \n The \"analyzer\" module provides analyzer related types and interfaces\n * for TypeScript.\n \n @packageDocumentation\n /\nimport { ArangoResponseMetadata } from \"./connection\";\nimport { Database } from \"./database\";\nimport { isArangoError } from \"./error\";\nimport { ANALYZER_NOT_FOUND } from \"./lib/codes\";\n\n/\n Indicates whether the given value represents an {@link Analyzer}.\n \n @param analyzer - A value that might be an Analyzer.\n /\nexport function isArangoAnalyzer(analyzer: any): analyzer is Analyzer {\n return Boolean(analyzer && analyzer.isArangoAnalyzer);\n}\n\n/\n Name of a feature enabled for an Analyzer.\n /\nexport type AnalyzerFeature = \"frequency\" \| \"norm\" \| \"position\";\n\n/\n An object describing an Analyzer.\n /\nexport type AnalyzerDescription = AnalyzerInfo & {\n name: string;\n features: AnalyzerFeature[];\n};\n\n/\n Options for creating an Analyzer.\n /\nexport type CreateAnalyzerOptions = AnalyzerInfo & {\n /\n Features to enable for this Analyzer.\n /\n features?: AnalyzerFeature[];\n};\n\n/\n Analyzer type and its type-specific properties.\n /\nexport type AnalyzerInfo =\n \| IdentityAnalyzerInfo\n \| DelimiterAnalyzerInfo\n \| StemAnalyzerInfo\n \| NormAnalyzerInfo\n \| NgramAnalyzerInfo\n \| TextAnalyzerInfo\n \| PipelineAnalyzer\n \| AqlAnalyzer\n \| GeoJsonAnalyzer\n \| GeoPointAnalyzer\n \| StopwordsAnalyzer;\n\n/\n Analyzer type and type-specific properties for an Identity Analyzer.\n /\nexport type IdentityAnalyzerInfo = {\n /\n Type of the Analyzer.\n /\n type: \"identity\";\n /\n Additional properties for the Analyzer.\n \n The `identity` Analyzer does not take additional properties.\n /\n properties?: null;\n};\n\n/\n Analyzer type and type-specific properties for a Delimiter Analyzer.\n /\nexport type DelimiterAnalyzerInfo = {\n /\n Type of the Analyzer.\n /\n type: \"delimiter\";\n /\n Additional properties for the Analyzer.\n \n The value will be used as delimiter to split text into tokens as specified\n * in RFC 4180, without starting new records on newlines.\n /\n properties: string \| { delimiter: string };\n};\n\n/\n Analyzer type and type-specific properties for a Stem Analyzer.\n /\nexport type StemAnalyzerInfo = {\n /\n Type of the Analyzer.\n /\n type: \"stem\";\n /\n Additional properties for the Analyzer.\n \n The value defines the text locale.\n \n Format: `language[_COUNTRY][.encoding][@variant]`\n /\n properties: { locale: string };\n};\n\n/\n Properties of a Norm Analyzer.\n /\nexport type NormAnalyzerProperties = {\n /\n Text locale.\n \n Format: `language[_COUNTRY][.encoding][@variant]`\n /\n locale: string;\n /\n Case conversion.\n \n Default: `\"lower\"`\n /\n case?: \"lower\" \| \"none\" \| \"upper\";\n /\n Preserve accents in returned words.\n \n Default: `false`\n /\n accent?: boolean;\n};\n\n/\n Analyzer type and type-specific properties for a Norm Analyzer.\n /\nexport type NormAnalyzerInfo = {\n /\n Type of the Analyzer.\n /\n type: \"norm\";\n /\n Additional properties for the Analyzer.\n /\n properties: NormAnalyzerProperties;\n};\n\n/\n Properties of an Ngram Analyzer.\n /\nexport type NgramAnalyzerProperties = {\n /\n Maximum n-gram length.\n /\n max: number;\n /\n Minimum n-gram length.\n /\n min: number;\n /\n Output the original value as well.\n /\n preserveOriginal: boolean;\n};\n\n/\n Analyzer type and type-specific properties for an Ngram Analyzer.\n /\nexport type NgramAnalyzerInfo = {\n /\n Type of the Analyzer.\n /\n type: \"ngram\";\n /\n Additional properties for the Analyzer.\n /\n properties: NgramAnalyzerProperties;\n};\n\n/\n Properties of a Text Analyzer.\n /\nexport type TextAnalyzerProperties = {\n /\n Text locale.\n \n Format: `language[_COUNTRY][.encoding][@variant]`\n /\n locale: string;\n /\n Case conversion.\n \n Default: `\"lower\"`\n /\n case?: \"lower\" \| \"none\" \| \"upper\";\n /\n Words to omit from result.\n \n Defaults to the words loaded from the file at `stopwordsPath`.\n /\n stopwords?: string[];\n /\n Path with a `language` sub-directory containing files with words to omit.\n \n Defaults to the path specified in the server-side environment variable\n * `IRESEARCH_TEXT_STOPWORD_PATH` or the current working directory of the\n * ArangoDB process.\n /\n stopwordsPath?: string;\n /\n Preserve accents in returned words.\n \n Default: `false`\n /\n accent?: boolean;\n /\n Apply stemming on returned words.\n \n Default: `true`\n /\n stemming?: boolean;\n /\n If present, then edge n-grams are generated for each token (word).\n /\n edgeNgram?: { min?: number; max?: number; preserveOriginal?: boolean };\n};\n\n/\n Analyzer type and type-specific properties for a Text Analyzer.\n /\nexport type TextAnalyzerInfo = {\n /\n Type of the Analyzer.\n /\n type: \"text\";\n /\n Additional properties for the Analyzer.\n /\n properties: TextAnalyzerProperties;\n};\n\n/\n Properties of a Pipeline Analyzer.\n /\nexport type PipelineAnalyzerProperties = {\n /\n Definitions for Analyzers to chain in this Pipeline Analyzer.\n /\n pipeline: AnalyzerInfo[];\n};\n\n/\n Analyzer type and type-specific properties for a Pipeline Analyzer\n /\nexport type PipelineAnalyzer = {\n /\n Type of the Analyzer.\n /\n type: \"pipeline\";\n /\n Additional properties for the Analyzer.\n /\n properties: PipelineAnalyzerProperties;\n};\n\n/\n Properties of an AQL Analyzer.\n /\nexport type AqlAnalyzerProperties = {\n /\n AQL query to be executed.\n /\n queryString: string;\n /\n If set to `true`, the position is set to `0` for all members of the query result array.\n \n Default: `false`\n /\n collapsePositions?: boolean;\n /\n If set to `false`, `null` values will be discarded from the View index.\n \n Default: `true`\n /\n keepNull?: boolean;\n /\n Number between `1` and `1000` that determines the batch size for reading\n * data from the query.\n \n Default: `1`\n /\n batchSize?: number;\n /\n Memory limit for query execution in bytes.\n \n Default: `1048576` (1 MiB)\n /\n memoryLimit?: number;\n /\n Data type of the returned tokens.\n \n Default: `\"string\"`\n /\n returnType?: \"string\" \| \"number\" \| \"bool\";\n};\n\n/\n Analyzer type and type-specific properties for an AQL Analyzer\n /\nexport type AqlAnalyzer = {\n /\n Type of the Analyzer.\n /\n type: \"aql\";\n /\n Additional properties for the Analyzer.\n /\n properties: AqlAnalyzerProperties;\n};\n\n/\n Properties of a GeoJSON Analyzer.\n /\nexport type GeoJsonAnalyzerProperties = {\n /\n If set to `\"centroid\"`, only the centroid of the input geometry will be\n * computed and indexed.\n \n If set to `\"point\"` only GeoJSON objects of type Point will be indexed and\n * all other geometry types will be ignored.\n \n Default: `\"shape\"`\n /\n type?: \"shape\" \| \"centroid\" \| \"point\";\n /\n Options for fine-tuning geo queries.\n \n Default: `{ maxCells: 20, minLevel: 4, maxLevel: 23 }`\n /\n options?: { maxCells?: number; minLevel?: number; maxLevel?: number };\n};\n\n/\n Analyzer type and type-specific properties for a GeoJSON Analyzer\n /\nexport type GeoJsonAnalyzer = {\n /\n Type of the Analyzer.\n /\n type: \"geojson\";\n /\n Additional properties for the Analyzer.\n /\n properties: GeoJsonAnalyzerProperties;\n};\n\n/\n Properties of a GeoPoint Analyzer.\n /\nexport type GeoPointAnalyzerProperties = {\n /\n Attribute paths of the latitude value relative to the field for which the\n * Analyzer is defined in the View.\n /\n latitude?: string[];\n /\n Attribute paths of the longitude value relative to the field for which the\n * Analyzer is defined in the View.\n /\n longitude?: string[];\n /\n Options for fine-tuning geo queries.\n \n Default: `{ maxCells: 20, minLevel: 4, maxLevel: 23 }`\n /\n options?: { minCells?: number; minLevel?: number; maxLevel?: number };\n};\n\n/\n Analyzer type and type-specific properties for a GeoPoint Analyzer\n /\nexport type GeoPointAnalyzer = {\n /\n Type of the Analyzer.\n /\n type: \"geopoint\";\n /\n Additional properties for the Analyzer.\n /\n properties: GeoPointAnalyzerProperties;\n};\n\n/\n Properties of a Stopwords Analyzer.\n /\nexport type StopwordsAnalyzerProperties = {\n /\n Array of strings that describe the tokens to be discarded.\n /\n stopwords: string[];\n /\n Whether stopword values should be interpreted as hex-encoded strings.\n \n Default: `false`\n /\n hex?: boolean;\n};\n\n/\n Analyzer type and type-specific properties for a Stopwords Analyzer\n /\nexport type StopwordsAnalyzer = {\n /\n Type of the Analyzer.\n /\n type: \"stopwords\";\n /\n Additional properties for the Analyzer.\n /\n properties: StopwordsAnalyzerProperties;\n};\n\n/\n Represents an Analyzer in a {@link Database}.\n /\nexport class Analyzer {\n protected _name: string;\n protected _db: Database;\n\n /\n @internal\n * @hidden\n /\n constructor(db: Database, name: string) {\n this._db = db;\n this._name = name;\n }\n\n /\n @internal\n \n Indicates that this object represents an ArangoDB Analyzer.\n /\n get isArangoAnalyzer(): true {\n return true;\n }\n\n /\n Name of this Analyzer.\n \n See also {@link Database.analyzer}.\n /\n get name() {\n return this._name;\n }\n\n /\n Checks whether the Analyzer exists.\n \n @example\n * ```js\n * const db = new Database();\n * const analyzer = db.analyzer(\"some-analyzer\");\n * const result = await analyzer.exists();\n * // result indicates whether the Analyzer exists\n * ```\n /\n async exists(): Promise<boolean> {\n try {\n await this.get();\n return true;\n } catch (err) {\n if (isArangoError(err) && err.errorNum === ANALYZER_NOT_FOUND) {\n return false;\n }\n throw err;\n }\n }\n\n /\n Retrieves the Analyzer definition for the Analyzer.\n \n @example\n * ```js\n * const db = new Database();\n * const analyzer = db.analyzer(\"some-analyzer\");\n * const definition = await analyzer.get();\n * // definition contains the Analyzer definition\n * ```\n /\n get(): Promise<ArangoResponseMetadata & AnalyzerDescription> {\n return this._db.request(\n { path: `/_api/analyzer/${this.name}` },\n (res) => res.body\n );\n }\n\n /\n Creates a new Analyzer with the given `options` and the instance's name.\n \n See also {@link Database.createAnalyzer}.\n \n @param options - Options for creating the Analyzer.\n \n @example\n * ```js\n * const db = new Database();\n * const analyzer = db.analyzer(\"potatoes\");\n * await analyzer.create({ type: \"identity\" });\n * // the identity Analyzer \"potatoes\" now exists\n * ```\n /\n create(options: CreateAnalyzerOptions): Promise<AnalyzerDescription> {\n return this._db.request(\n {\n method: \"POST\",\n path: \"/_api/analyzer\",\n body: { name: this.name, ...options },\n },\n (res) => res.body\n );\n }\n\n /\n Deletes the Analyzer from the database.\n \n @param force - Whether the Analyzer should still be deleted even if it\n * is currently in use.\n \n @example\n * ```js\n * const db = new Database();\n * const analyzer = db.analyzer(\"some-analyzer\");\n * await analyzer.drop();\n * // the Analyzer \"some-analyzer\" no longer exists\n * ```\n */\n drop(\n force: boolean = false\n ): Promise<ArangoResponseMetadata & { name: string }> {\n return this._db.request(\n {\n method: \"DELETE\",\n path: `/_api/analyzer/${this.name}`,\n qs: { force },\n },\n (res) => res.body\n );\n }\n}\n"]}

package/aql.d.ts CHANGED Viewed

@@ -12,6 +12,7 @@
  */
 import { ArangoCollection } from "./collection";
 import { Dict } from "./connection";
+import { Graph } from "./graph";
 import { View } from "./view";
 /**
  * Generic AQL query object consisting of an AQL query string and its bind
@@ -67,7 +68,7 @@ export interface AqlLiteral {
  * A value that can be used in an AQL template string or passed to an AQL
  * helper function.
  */
-export declare type AqlValue = ArangoCollection | View | GeneratedAqlQuery | AqlLiteral | string | number | boolean | null | undefined | object | any[];
+export declare type AqlValue = ArangoCollection | View | Graph | GeneratedAqlQuery | AqlLiteral | string | number | boolean | null | undefined | Record<string, unknown> | any[];
 /**
  * Indicates whether the given value is an {@link AqlQuery}.
  *

package/aql.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"aql.d.ts","sourceRoot":"","sources":["../src/aql.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,EAAE,gBAAgB,EAAsB,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACpC,OAAO,EAAgB,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE5C;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iBAAkB,SAAQ,QAAQ;IACjD;;;OAGG;IACH,OAAO,EAAE,MAAM;QAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,IAAI,EAAE,QAAQ,EAAE,CAAA;KAAE,CAAC;CACxD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACzB;;;;;OAKG;IACH,KAAK,EAAE,MAAM,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,oBAAY,QAAQ,GAChB,gBAAgB,GAChB,IAAI,GACJ,iBAAiB,GACjB,UAAU,GACV,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,MAAM,~~GACN~~,GAAG,EAAE,CAAC;AAEV;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,QAAQ,CAExD;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,iBAAiB,CAE1E;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,IAAI,UAAU,CAEhE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwFG;AACH,wBAAgB,GAAG,CACjB,eAAe,EAAE,oBAAoB,EACrC,GAAG,IAAI,EAAE,QAAQ,EAAE,GAClB,iBAAiB,~~CAsDnB~~;~~AAED~~,yBAAiB,GAAG,CAAC;IACnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,SAAgB,OAAO,CACrB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,IAAI,GAAG,SAAS,GAC/D,UAAU,CAYZ;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,SAAgB,IAAI,CAClB,MAAM,EAAE,QAAQ,EAAE,EAClB,GAAG,GAAE,MAAY,GAChB,iBAAiB,CAWnB;CACF"}
1	+ {"version":3,"file":"aql.d.ts","sourceRoot":"","sources":["../src/aql.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,EAAE,gBAAgB,EAAsB,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,KAAK,EAAiB,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAgB,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE5C;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iBAAkB,SAAQ,QAAQ;IACjD;;;OAGG;IACH,OAAO,EAAE,MAAM;QAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,IAAI,EAAE,QAAQ,EAAE,CAAA;KAAE,CAAC;CACxD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACzB;;;;;OAKG;IACH,KAAK,EAAE,MAAM,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,oBAAY,QAAQ,GAChB,gBAAgB,GAChB,IAAI,GACJ,KAAK,GACL,iBAAiB,GACjB,UAAU,GACV,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,GAAG,EAAE,CAAC;AAEV;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,QAAQ,CAExD;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,iBAAiB,CAE1E;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,IAAI,UAAU,CAEhE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwFG;AACH,wBAAgB,GAAG,CACjB,eAAe,EAAE,oBAAoB,EACrC,GAAG,IAAI,EAAE,QAAQ,EAAE,GAClB,iBAAiB,CA0DnB;AAGD,yBAAiB,GAAG,CAAC;IACnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,SAAgB,OAAO,CACrB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,IAAI,GAAG,SAAS,GAC/D,UAAU,CAYZ;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,SAAgB,IAAI,CAClB,MAAM,EAAE,QAAQ,EAAE,EAClB,GAAG,GAAE,MAAY,GAChB,iBAAiB,CAWnB;CACF"}

package/aql.js CHANGED Viewed

@@ -14,6 +14,7 @@ exports.aql = exports.isAqlLiteral = exports.isGeneratedAqlQuery = exports.isAql
  * @packageDocumentation
  */
 const collection_1 = require("./collection");
+const graph_1 = require("./graph");
 const view_1 = require("./view");
 /**
  * Indicates whether the given value is an {@link AqlQuery}.
@@ -168,7 +169,9 @@ function aql(templateStrings, ...args) {
         const index = bindValues.indexOf(rawValue);
         const isKnown = index !== -1;
         let name = `value${isKnown ? index : bindValues.length}`;
-        if (collection_1.isArangoCollection(rawValue) || view_1.isArangoView(rawValue)) {
+        if (collection_1.isArangoCollection(rawValue) ||
+            graph_1.isArangoGraph(rawValue) ||
+            view_1.isArangoView(rawValue)) {
             name = `@${name}`;
             value = rawValue.name;
         }
@@ -185,6 +188,7 @@ function aql(templateStrings, ...args) {
     };
 }
 exports.aql = aql;
+// eslint-disable-next-line @typescript-eslint/no-namespace
 (function (aql) {
     /**
      * Marks an arbitrary scalar value (i.e. a string, number or boolean) as

package/aql.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"aql.js","sourceRoot":"","sources":["../src/aql.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;GAWG;AACH,6CAAoE;AAEpE,iCAA4C;AAqE5C;;;;GAIG;AACH,SAAgB,UAAU,CAAC,KAAU;IACnC,OAAO,OAAO,CAAC,KAAK,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;AAC7E,CAAC;AAFD,gCAEC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAAC,KAAU;IAC5C,OAAO,UAAU,CAAC,KAAK,CAAC,IAAI,OAAQ,KAAa,CAAC,OAAO,KAAK,UAAU,CAAC;AAC3E,CAAC;AAFD,kDAEC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAAC,OAAY;IACvC,OAAO,OAAO,CAAC,OAAO,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC;AACjE,CAAC;AAFD,oCAEC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwFG;AACH,SAAgB,GAAG,CACjB,eAAqC,EACrC,GAAG,IAAgB;IAEnB,MAAM,OAAO,GAAG,CAAC,GAAG,eAAe,CAAC,CAAC;IACrC,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,UAAU,GAAG,EAAE,CAAC;IACtB,IAAI,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,IAAI,KAAK,GAAG,QAAQ,CAAC;QACrB,IAAI,mBAAmB,CAAC,QAAQ,CAAC,EAAE;YACjC,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;YAC/B,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE;gBACnB,KAAK,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBACxB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC/B,OAAO,CAAC,MAAM,CACZ,CAAC,EACD,CAAC,EACD,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAC3B,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EACxC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAC9C,CAAC;aACH;iBAAM;gBACL,KAAK,IAAI,QAAQ,CAAC,KAAK,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBACzC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAClB,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aACpE;YACD,CAAC,IAAI,CAAC,CAAC;YACP,SAAS;SACV;QACD,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,KAAK,IAAI,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACxB,SAAS;SACV;QACD,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE;YAC1B,KAAK,IAAI,GAAG,QAAQ,CAAC,KAAK,EAAE,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAChD,SAAS;SACV;QACD,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,OAAO,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC;QAC7B,IAAI,IAAI,GAAG,QAAQ,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QACzD,IAAI,+BAAkB,CAAC,QAAQ,CAAC,IAAI,mBAAY,CAAC,QAAQ,CAAC,EAAE;YAC1D,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;YAClB,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC;SACvB;QACD,IAAI,CAAC,OAAO,EAAE;YACZ,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;SACxB;QACD,KAAK,IAAI,IAAI,IAAI,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;KACtC;IACD,OAAO;QACL,KAAK;QACL,QAAQ;QACR,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;KACnC,CAAC;AACJ,CAAC;AAzDD,kBAyDC;AAED,WAAiB,GAAG;IAClB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,SAAgB,OAAO,CACrB,KAAgE;QAEhE,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE;YACvB,OAAO,KAAK,CAAC;SACd;QACD,OAAO;YACL,KAAK;gBACH,IAAI,KAAK,KAAK,SAAS,EAAE;oBACvB,OAAO,EAAE,CAAC;iBACX;gBACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;SACF,CAAC;IACJ,CAAC;IAde,WAAO,UActB,CAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,SAAgB,IAAI,CAClB,MAAkB,EAClB,MAAc,GAAG;QAEjB,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAClB,OAAO,GAAG,CAAA,EAAE,CAAC;SACd;QACD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;YACvB,OAAO,GAAG,CAAA,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;SAC1B;QACD,OAAO,GAAG,CACR,CAAC,EAAE,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAQ,EACtD,GAAG,MAAM,CACV,CAAC;IACJ,CAAC;IAde,QAAI,OAcnB,CAAA;AACH,CAAC,EApJgB,GAAG,GAAH,WAAG,KAAH,WAAG,QAoJnB","sourcesContent":["/*\n ```js\n * import { aql } from \"arangojs/aql\";\n * ```\n \n The \"aql\" module provides the {@link aql} template string handler and\n * helper functions, as well as associated types and interfaces for TypeScript.\n \n The aql function and namespace is also re-exported by the \"index\" module.\n \n @packageDocumentation\n /\nimport { ArangoCollection, isArangoCollection } from \"./collection\";\nimport { Dict } from \"./connection\";\nimport { isArangoView, View } from \"./view\";\n\n/\n Generic AQL query object consisting of an AQL query string and its bind\n * parameters.\n /\nexport interface AqlQuery {\n /\n An AQL query string.\n /\n query: string;\n /\n An object mapping AQL bind parameter names to their respective values.\n \n Names of parameters representing collections are prefixed with an\n * at-symbol.\n /\n bindVars: Dict<any>;\n}\n\n/\n Derived type representing AQL query objects generated by the AQL helper\n * functions and the AQL template string handler. These objects can be fed\n * back into these helper functions to be inlined or merged in complex queries.\n \n @internal\n /\nexport interface GeneratedAqlQuery extends AqlQuery {\n /\n @internal\n * @hidden\n /\n _source: () => { strings: string[]; args: AqlValue[] };\n}\n\n/\n An object representing a trusted AQL literal that will be inlined directly\n * when used in an AQL template or passed to AQL helper functions.\n \n Arbitrary values can be converted to trusted AQL literals by passing them\n * to the {@link aql.literal} helper function.\n /\nexport interface AqlLiteral {\n /\n @internal\n \n Returns a string representation of this AQL literal that can be inlined\n * in an AQL template.\n /\n toAQL: () => string;\n}\n\n/\n A value that can be used in an AQL template string or passed to an AQL\n * helper function.\n /\nexport type AqlValue =\n \| ArangoCollection\n \| View\n \| GeneratedAqlQuery\n \| AqlLiteral\n \| string\n \| number\n \| boolean\n \| null\n \| undefined\n \| object\n \| any[];\n\n/\n Indicates whether the given value is an {@link AqlQuery}.\n \n @param query - A value that might be an `AqlQuery`.\n /\nexport function isAqlQuery(query: any): query is AqlQuery {\n return Boolean(query && typeof query.query === \"string\" && query.bindVars);\n}\n\n/\n Indicates whether the given value is a {@link GeneratedAqlQuery}.\n \n @param query - A value that might be a `GeneratedAqlQuery`.\n \n @internal\n * @hidden\n /\nexport function isGeneratedAqlQuery(query: any): query is GeneratedAqlQuery {\n return isAqlQuery(query) && typeof (query as any)._source === \"function\";\n}\n\n/\n Indicates whether the given value is an {@link AqlLiteral}.\n \n @param literal - A value that might be an `AqlLiteral`.\n /\nexport function isAqlLiteral(literal: any): literal is AqlLiteral {\n return Boolean(literal && typeof literal.toAQL === \"function\");\n}\n\n/\n Template string handler (template tag) for AQL queries.\n \n The `aql` tag can be used to write complex AQL queries as multi-line strings\n * without having to worry about `bindVars` and the distinction between\n * collections and regular parameters.\n \n Tagged template strings will return an {@link AqlQuery} object with\n * `query` and `bindVars` attributes reflecting any interpolated values.\n \n Any {@link ArangoCollection} instance used in a query string will be\n * recognized as a collection reference and generate an AQL collection bind\n * parameter instead of a regular AQL value bind parameter.\n \n Note: you should always use the `aql` template tag when writing\n * dynamic AQL queries instead of using untagged (normal) template strings.\n * Untagged template strings will inline any interpolated values and return\n * a plain string as result. The `aql` template tag will only inline references\n * to the interpolated values and produce an AQL query object containing both\n * the query and the values. This prevents most injection attacks when using\n * untrusted values in dynamic queries.\n \n @example\n * ```js\n * // Some user-supplied string that may be malicious\n * const untrustedValue = req.body.email;\n \n // Without aql tag: BAD! DO NOT DO THIS!\n * const badQuery = `\n * FOR user IN users\n * FILTER user.email == \"${untrustedValue}\"\n * RETURN user\n * `;\n * // e.g. if untrustedValue is '\" \|\| user.admin == true \|\| \"':\n * // Query:\n * // FOR user IN users\n * // FILTER user.email == \"\" \|\| user.admin == true \|\| \"\"\n * // RETURN user\n \n // With the aql tag: GOOD! MUCH SAFER!\n * const betterQuery = aql`\n * FOR user IN users\n * FILTER user.email == ${untrustedValue}\n * RETURN user\n * `;\n * // Query:\n * // FOR user IN users\n * // FILTER user.email == @value0\n * // RETURN user\n * // Bind parameters:\n * // value0 -> untrustedValue\n * ```\n \n @example\n * ```js\n * const collection = db.collection(\"some-collection\");\n * const minValue = 23;\n * const result = await db.query(aql`\n * FOR d IN ${collection}\n * FILTER d.num > ${minValue}\n * RETURN d\n * `);\n \n // Equivalent raw query object\n * const result2 = await db.query({\n * query: `\n * FOR d IN @@collection\n * FILTER d.num > @minValue\n * RETURN d\n * `,\n * bindVars: {\n * \"@collection\": collection.name,\n * minValue: minValue\n * }\n * });\n * ```\n \n @example\n * ```js\n * const collection = db.collection(\"some-collection\");\n * const color = \"green\";\n * const filter = aql`FILTER d.color == ${color}'`;\n * const result = await db.query(aql`\n * FOR d IN ${collection}\n * ${filter}\n * RETURN d\n * `);\n * ```\n /\nexport function aql(\n templateStrings: TemplateStringsArray,\n ...args: AqlValue[]\n): GeneratedAqlQuery {\n const strings = [...templateStrings];\n const bindVars: Dict<any> = {};\n const bindValues = [];\n let query = strings[0];\n for (let i = 0; i < args.length; i++) {\n const rawValue = args[i];\n let value = rawValue;\n if (isGeneratedAqlQuery(rawValue)) {\n const src = rawValue._source();\n if (src.args.length) {\n query += src.strings[0];\n args.splice(i, 1, ...src.args);\n strings.splice(\n i,\n 2,\n strings[i] + src.strings[0],\n ...src.strings.slice(1, src.args.length),\n src.strings[src.args.length] + strings[i + 1]\n );\n } else {\n query += rawValue.query + strings[i + 1];\n args.splice(i, 1);\n strings.splice(i, 2, strings[i] + rawValue.query + strings[i + 1]);\n }\n i -= 1;\n continue;\n }\n if (rawValue === undefined) {\n query += strings[i + 1];\n continue;\n }\n if (isAqlLiteral(rawValue)) {\n query += `${rawValue.toAQL()}${strings[i + 1]}`;\n continue;\n }\n const index = bindValues.indexOf(rawValue);\n const isKnown = index !== -1;\n let name = `value${isKnown ? index : bindValues.length}`;\n if (isArangoCollection(rawValue) \|\| isArangoView(rawValue)) {\n name = `@${name}`;\n value = rawValue.name;\n }\n if (!isKnown) {\n bindValues.push(rawValue);\n bindVars[name] = value;\n }\n query += `@${name}${strings[i + 1]}`;\n }\n return {\n query,\n bindVars,\n _source: () => ({ strings, args }),\n };\n}\n\nexport namespace aql {\n /\n Marks an arbitrary scalar value (i.e. a string, number or boolean) as\n * safe for being inlined directly into AQL queries when used in an `aql`\n * template string, rather than being converted into a bind parameter.\n \n Note: Nesting `aql` template strings is a much safer alternative for\n * most use cases. This low-level helper function only exists to help with\n * rare edge cases where a trusted AQL query fragment must be read from a\n * string (e.g. when reading query fragments from JSON) and should only be\n * used as a last resort.\n \n @example\n * ```js\n * // BAD! DO NOT DO THIS!\n * const sortDirection = aql.literal('ASC');\n \n // GOOD! DO THIS INSTEAD!\n * const sortDirection = aql`ASC`;\n * ```\n \n @example\n * ```js\n * // BAD! DO NOT DO THIS!\n * const filterColor = aql.literal('FILTER d.color == \"green\"');\n * const result = await db.query(aql`\n * FOR d IN some-collection\n * ${filterColor}\n * RETURN d\n * `);\n \n // GOOD! DO THIS INSTEAD!\n * const color = \"green\";\n * const filterColor = aql`FILTER d.color === ${color}`;\n * const result = await db.query(aql`\n * FOR d IN some-collection\n * ${filterColor}\n * RETURN d\n * `);\n * ```\n \n @example\n * ```js\n * // WARNING: We explicitly trust the environment variable to be safe!\n * const filter = aql.literal(process.env.FILTER_STATEMENT);\n * const users = await db.query(aql`\n * FOR user IN users\n * ${filter}\n * RETURN user\n * `);\n * ```\n /\n export function literal(\n value: string \| number \| boolean \| AqlLiteral \| null \| undefined\n ): AqlLiteral {\n if (isAqlLiteral(value)) {\n return value;\n }\n return {\n toAQL() {\n if (value === undefined) {\n return \"\";\n }\n return String(value);\n },\n };\n }\n\n /\n Constructs {@link AqlQuery} objects from an array of arbitrary values.\n \n Note: Nesting `aql` template strings is a much safer alternative\n * for most use cases. This low-level helper function only exists to\n * complement the `aql` tag when constructing complex queries from dynamic\n * arrays of query fragments.\n \n @param values - Array of values to join. These values will behave exactly\n * like values interpolated in an `aql` template string.\n * @param sep - Seperator to insert between values. This value will behave\n * exactly like a value passed to {@link aql.literal}, i.e. it will be\n * inlined as-is, rather than being converted into a bind parameter.\n \n @example\n * ```js\n * const users = db.collection(\"users\");\n * const filters = [];\n * if (adminsOnly) filters.push(aql`FILTER user.admin`);\n * if (activeOnly) filters.push(aql`FILTER user.active`);\n * const result = await db.query(aql`\n * FOR user IN ${users}\n * ${aql.join(filters)}\n * RETURN user\n * `);\n * ```\n \n @example\n * ```js\n * const users = db.collection(\"users\");\n * const keys = [\"jreyes\", \"ghermann\"];\n \n // BAD! NEEDLESSLY COMPLEX!\n * const docs = keys.map(key => aql`DOCUMENT(${users}, ${key}`));\n * const result = await db.query(aql`\n * FOR user IN [\n * ${aql.join(docs, \", \")}\n * ]\n * RETURN user\n * `);\n * // Query:\n * // FOR user IN [\n * // DOCUMENT(@@value0, @value1), DOCUMENT(@@value0, @value2)\n * // ]\n * // RETURN user\n * // Bind parameters:\n * // @value0 -> \"users\"\n * // value1 -> \"jreyes\"\n * // value2 -> \"ghermann\"\n \n // GOOD! MUCH SIMPLER!\n * const result = await db.query(aql`\n * FOR key IN ${keys}\n * LET user = DOCUMENT(${users}, key)\n * RETURN user\n * `);\n * // Query:\n * // FOR user IN @value0\n * // LET user = DOCUMENT(@@value1, key)\n * // RETURN user\n * // Bind parameters:\n * // value0 -> [\"jreyes\", \"ghermann\"]\n * // @value1 -> \"users\"\n * ```\n */\n export function join(\n values: AqlValue[],\n sep: string = \" \"\n ): GeneratedAqlQuery {\n if (!values.length) {\n return aql``;\n }\n if (values.length === 1) {\n return aql`${values[0]}`;\n }\n return aql(\n [\"\", ...Array(values.length - 1).fill(sep), \"\"] as any,\n ...values\n );\n }\n}\n"]}
1	+ {"version":3,"file":"aql.js","sourceRoot":"","sources":["../src/aql.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;GAWG;AACH,6CAAoE;AAEpE,mCAA+C;AAC/C,iCAA4C;AAsE5C;;;;GAIG;AACH,SAAgB,UAAU,CAAC,KAAU;IACnC,OAAO,OAAO,CAAC,KAAK,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;AAC7E,CAAC;AAFD,gCAEC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAAC,KAAU;IAC5C,OAAO,UAAU,CAAC,KAAK,CAAC,IAAI,OAAQ,KAAa,CAAC,OAAO,KAAK,UAAU,CAAC;AAC3E,CAAC;AAFD,kDAEC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAAC,OAAY;IACvC,OAAO,OAAO,CAAC,OAAO,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC;AACjE,CAAC;AAFD,oCAEC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwFG;AACH,SAAgB,GAAG,CACjB,eAAqC,EACrC,GAAG,IAAgB;IAEnB,MAAM,OAAO,GAAG,CAAC,GAAG,eAAe,CAAC,CAAC;IACrC,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,UAAU,GAAG,EAAE,CAAC;IACtB,IAAI,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,IAAI,KAAK,GAAG,QAAQ,CAAC;QACrB,IAAI,mBAAmB,CAAC,QAAQ,CAAC,EAAE;YACjC,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;YAC/B,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE;gBACnB,KAAK,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBACxB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC/B,OAAO,CAAC,MAAM,CACZ,CAAC,EACD,CAAC,EACD,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAC3B,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EACxC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAC9C,CAAC;aACH;iBAAM;gBACL,KAAK,IAAI,QAAQ,CAAC,KAAK,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBACzC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAClB,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aACpE;YACD,CAAC,IAAI,CAAC,CAAC;YACP,SAAS;SACV;QACD,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,KAAK,IAAI,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACxB,SAAS;SACV;QACD,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE;YAC1B,KAAK,IAAI,GAAG,QAAQ,CAAC,KAAK,EAAE,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAChD,SAAS;SACV;QACD,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,OAAO,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC;QAC7B,IAAI,IAAI,GAAG,QAAQ,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QACzD,IACE,+BAAkB,CAAC,QAAQ,CAAC;YAC5B,qBAAa,CAAC,QAAQ,CAAC;YACvB,mBAAY,CAAC,QAAQ,CAAC,EACtB;YACA,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;YAClB,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC;SACvB;QACD,IAAI,CAAC,OAAO,EAAE;YACZ,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;SACxB;QACD,KAAK,IAAI,IAAI,IAAI,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;KACtC;IACD,OAAO;QACL,KAAK;QACL,QAAQ;QACR,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;KACnC,CAAC;AACJ,CAAC;AA7DD,kBA6DC;AAED,2DAA2D;AAC3D,WAAiB,GAAG;IAClB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,SAAgB,OAAO,CACrB,KAAgE;QAEhE,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE;YACvB,OAAO,KAAK,CAAC;SACd;QACD,OAAO;YACL,KAAK;gBACH,IAAI,KAAK,KAAK,SAAS,EAAE;oBACvB,OAAO,EAAE,CAAC;iBACX;gBACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;SACF,CAAC;IACJ,CAAC;IAde,WAAO,UActB,CAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,SAAgB,IAAI,CAClB,MAAkB,EAClB,MAAc,GAAG;QAEjB,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAClB,OAAO,GAAG,CAAA,EAAE,CAAC;SACd;QACD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;YACvB,OAAO,GAAG,CAAA,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;SAC1B;QACD,OAAO,GAAG,CACR,CAAC,EAAE,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAQ,EACtD,GAAG,MAAM,CACV,CAAC;IACJ,CAAC;IAde,QAAI,OAcnB,CAAA;AACH,CAAC,EApJgB,GAAG,GAAH,WAAG,KAAH,WAAG,QAoJnB","sourcesContent":["/*\n ```js\n * import { aql } from \"arangojs/aql\";\n * ```\n \n The \"aql\" module provides the {@link aql} template string handler and\n * helper functions, as well as associated types and interfaces for TypeScript.\n \n The aql function and namespace is also re-exported by the \"index\" module.\n \n @packageDocumentation\n /\nimport { ArangoCollection, isArangoCollection } from \"./collection\";\nimport { Dict } from \"./connection\";\nimport { Graph, isArangoGraph } from \"./graph\";\nimport { isArangoView, View } from \"./view\";\n\n/\n Generic AQL query object consisting of an AQL query string and its bind\n * parameters.\n /\nexport interface AqlQuery {\n /\n An AQL query string.\n /\n query: string;\n /\n An object mapping AQL bind parameter names to their respective values.\n \n Names of parameters representing collections are prefixed with an\n * at-symbol.\n /\n bindVars: Dict<any>;\n}\n\n/\n Derived type representing AQL query objects generated by the AQL helper\n * functions and the AQL template string handler. These objects can be fed\n * back into these helper functions to be inlined or merged in complex queries.\n \n @internal\n /\nexport interface GeneratedAqlQuery extends AqlQuery {\n /\n @internal\n * @hidden\n /\n _source: () => { strings: string[]; args: AqlValue[] };\n}\n\n/\n An object representing a trusted AQL literal that will be inlined directly\n * when used in an AQL template or passed to AQL helper functions.\n \n Arbitrary values can be converted to trusted AQL literals by passing them\n * to the {@link aql.literal} helper function.\n /\nexport interface AqlLiteral {\n /\n @internal\n \n Returns a string representation of this AQL literal that can be inlined\n * in an AQL template.\n /\n toAQL: () => string;\n}\n\n/\n A value that can be used in an AQL template string or passed to an AQL\n * helper function.\n /\nexport type AqlValue =\n \| ArangoCollection\n \| View\n \| Graph\n \| GeneratedAqlQuery\n \| AqlLiteral\n \| string\n \| number\n \| boolean\n \| null\n \| undefined\n \| Record<string, unknown>\n \| any[];\n\n/\n Indicates whether the given value is an {@link AqlQuery}.\n \n @param query - A value that might be an `AqlQuery`.\n /\nexport function isAqlQuery(query: any): query is AqlQuery {\n return Boolean(query && typeof query.query === \"string\" && query.bindVars);\n}\n\n/\n Indicates whether the given value is a {@link GeneratedAqlQuery}.\n \n @param query - A value that might be a `GeneratedAqlQuery`.\n \n @internal\n * @hidden\n /\nexport function isGeneratedAqlQuery(query: any): query is GeneratedAqlQuery {\n return isAqlQuery(query) && typeof (query as any)._source === \"function\";\n}\n\n/\n Indicates whether the given value is an {@link AqlLiteral}.\n \n @param literal - A value that might be an `AqlLiteral`.\n /\nexport function isAqlLiteral(literal: any): literal is AqlLiteral {\n return Boolean(literal && typeof literal.toAQL === \"function\");\n}\n\n/\n Template string handler (template tag) for AQL queries.\n \n The `aql` tag can be used to write complex AQL queries as multi-line strings\n * without having to worry about `bindVars` and the distinction between\n * collections and regular parameters.\n \n Tagged template strings will return an {@link AqlQuery} object with\n * `query` and `bindVars` attributes reflecting any interpolated values.\n \n Any {@link ArangoCollection} instance used in a query string will be\n * recognized as a collection reference and generate an AQL collection bind\n * parameter instead of a regular AQL value bind parameter.\n \n Note: you should always use the `aql` template tag when writing\n * dynamic AQL queries instead of using untagged (normal) template strings.\n * Untagged template strings will inline any interpolated values and return\n * a plain string as result. The `aql` template tag will only inline references\n * to the interpolated values and produce an AQL query object containing both\n * the query and the values. This prevents most injection attacks when using\n * untrusted values in dynamic queries.\n \n @example\n * ```js\n * // Some user-supplied string that may be malicious\n * const untrustedValue = req.body.email;\n \n // Without aql tag: BAD! DO NOT DO THIS!\n * const badQuery = `\n * FOR user IN users\n * FILTER user.email == \"${untrustedValue}\"\n * RETURN user\n * `;\n * // e.g. if untrustedValue is '\" \|\| user.admin == true \|\| \"':\n * // Query:\n * // FOR user IN users\n * // FILTER user.email == \"\" \|\| user.admin == true \|\| \"\"\n * // RETURN user\n \n // With the aql tag: GOOD! MUCH SAFER!\n * const betterQuery = aql`\n * FOR user IN users\n * FILTER user.email == ${untrustedValue}\n * RETURN user\n * `;\n * // Query:\n * // FOR user IN users\n * // FILTER user.email == @value0\n * // RETURN user\n * // Bind parameters:\n * // value0 -> untrustedValue\n * ```\n \n @example\n * ```js\n * const collection = db.collection(\"some-collection\");\n * const minValue = 23;\n * const result = await db.query(aql`\n * FOR d IN ${collection}\n * FILTER d.num > ${minValue}\n * RETURN d\n * `);\n \n // Equivalent raw query object\n * const result2 = await db.query({\n * query: `\n * FOR d IN @@collection\n * FILTER d.num > @minValue\n * RETURN d\n * `,\n * bindVars: {\n * \"@collection\": collection.name,\n * minValue: minValue\n * }\n * });\n * ```\n \n @example\n * ```js\n * const collection = db.collection(\"some-collection\");\n * const color = \"green\";\n * const filter = aql`FILTER d.color == ${color}'`;\n * const result = await db.query(aql`\n * FOR d IN ${collection}\n * ${filter}\n * RETURN d\n * `);\n * ```\n /\nexport function aql(\n templateStrings: TemplateStringsArray,\n ...args: AqlValue[]\n): GeneratedAqlQuery {\n const strings = [...templateStrings];\n const bindVars: Dict<any> = {};\n const bindValues = [];\n let query = strings[0];\n for (let i = 0; i < args.length; i++) {\n const rawValue = args[i];\n let value = rawValue;\n if (isGeneratedAqlQuery(rawValue)) {\n const src = rawValue._source();\n if (src.args.length) {\n query += src.strings[0];\n args.splice(i, 1, ...src.args);\n strings.splice(\n i,\n 2,\n strings[i] + src.strings[0],\n ...src.strings.slice(1, src.args.length),\n src.strings[src.args.length] + strings[i + 1]\n );\n } else {\n query += rawValue.query + strings[i + 1];\n args.splice(i, 1);\n strings.splice(i, 2, strings[i] + rawValue.query + strings[i + 1]);\n }\n i -= 1;\n continue;\n }\n if (rawValue === undefined) {\n query += strings[i + 1];\n continue;\n }\n if (isAqlLiteral(rawValue)) {\n query += `${rawValue.toAQL()}${strings[i + 1]}`;\n continue;\n }\n const index = bindValues.indexOf(rawValue);\n const isKnown = index !== -1;\n let name = `value${isKnown ? index : bindValues.length}`;\n if (\n isArangoCollection(rawValue) \|\|\n isArangoGraph(rawValue) \|\|\n isArangoView(rawValue)\n ) {\n name = `@${name}`;\n value = rawValue.name;\n }\n if (!isKnown) {\n bindValues.push(rawValue);\n bindVars[name] = value;\n }\n query += `@${name}${strings[i + 1]}`;\n }\n return {\n query,\n bindVars,\n _source: () => ({ strings, args }),\n };\n}\n\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace aql {\n /\n Marks an arbitrary scalar value (i.e. a string, number or boolean) as\n * safe for being inlined directly into AQL queries when used in an `aql`\n * template string, rather than being converted into a bind parameter.\n \n Note: Nesting `aql` template strings is a much safer alternative for\n * most use cases. This low-level helper function only exists to help with\n * rare edge cases where a trusted AQL query fragment must be read from a\n * string (e.g. when reading query fragments from JSON) and should only be\n * used as a last resort.\n \n @example\n * ```js\n * // BAD! DO NOT DO THIS!\n * const sortDirection = aql.literal('ASC');\n \n // GOOD! DO THIS INSTEAD!\n * const sortDirection = aql`ASC`;\n * ```\n \n @example\n * ```js\n * // BAD! DO NOT DO THIS!\n * const filterColor = aql.literal('FILTER d.color == \"green\"');\n * const result = await db.query(aql`\n * FOR d IN some-collection\n * ${filterColor}\n * RETURN d\n * `);\n \n // GOOD! DO THIS INSTEAD!\n * const color = \"green\";\n * const filterColor = aql`FILTER d.color === ${color}`;\n * const result = await db.query(aql`\n * FOR d IN some-collection\n * ${filterColor}\n * RETURN d\n * `);\n * ```\n \n @example\n * ```js\n * // WARNING: We explicitly trust the environment variable to be safe!\n * const filter = aql.literal(process.env.FILTER_STATEMENT);\n * const users = await db.query(aql`\n * FOR user IN users\n * ${filter}\n * RETURN user\n * `);\n * ```\n /\n export function literal(\n value: string \| number \| boolean \| AqlLiteral \| null \| undefined\n ): AqlLiteral {\n if (isAqlLiteral(value)) {\n return value;\n }\n return {\n toAQL() {\n if (value === undefined) {\n return \"\";\n }\n return String(value);\n },\n };\n }\n\n /\n Constructs {@link AqlQuery} objects from an array of arbitrary values.\n \n Note: Nesting `aql` template strings is a much safer alternative\n * for most use cases. This low-level helper function only exists to\n * complement the `aql` tag when constructing complex queries from dynamic\n * arrays of query fragments.\n \n @param values - Array of values to join. These values will behave exactly\n * like values interpolated in an `aql` template string.\n * @param sep - Seperator to insert between values. This value will behave\n * exactly like a value passed to {@link aql.literal}, i.e. it will be\n * inlined as-is, rather than being converted into a bind parameter.\n \n @example\n * ```js\n * const users = db.collection(\"users\");\n * const filters = [];\n * if (adminsOnly) filters.push(aql`FILTER user.admin`);\n * if (activeOnly) filters.push(aql`FILTER user.active`);\n * const result = await db.query(aql`\n * FOR user IN ${users}\n * ${aql.join(filters)}\n * RETURN user\n * `);\n * ```\n \n @example\n * ```js\n * const users = db.collection(\"users\");\n * const keys = [\"jreyes\", \"ghermann\"];\n \n // BAD! NEEDLESSLY COMPLEX!\n * const docs = keys.map(key => aql`DOCUMENT(${users}, ${key}`));\n * const result = await db.query(aql`\n * FOR user IN [\n * ${aql.join(docs, \", \")}\n * ]\n * RETURN user\n * `);\n * // Query:\n * // FOR user IN [\n * // DOCUMENT(@@value0, @value1), DOCUMENT(@@value0, @value2)\n * // ]\n * // RETURN user\n * // Bind parameters:\n * // @value0 -> \"users\"\n * // value1 -> \"jreyes\"\n * // value2 -> \"ghermann\"\n \n // GOOD! MUCH SIMPLER!\n * const result = await db.query(aql`\n * FOR key IN ${keys}\n * LET user = DOCUMENT(${users}, key)\n * RETURN user\n * `);\n * // Query:\n * // FOR user IN @value0\n * // LET user = DOCUMENT(@@value1, key)\n * // RETURN user\n * // Bind parameters:\n * // value0 -> [\"jreyes\", \"ghermann\"]\n * // @value1 -> \"users\"\n * ```\n */\n export function join(\n values: AqlValue[],\n sep: string = \" \"\n ): GeneratedAqlQuery {\n if (!values.length) {\n return aql``;\n }\n if (values.length === 1) {\n return aql`${values[0]}`;\n }\n return aql(\n [\"\", ...Array(values.length - 1).fill(sep), \"\"] as any,\n ...values\n );\n }\n}\n"]}