arangojs 10.0.0-alpha.0 → 10.0.0-alpha.1

package/CHANGELOG.md

@@ -14,6 +14,73 @@ 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.
 
+## [10.0.0-alpha.1] - 2024-12-09
+
+This is a major release and breaks backwards compatibility.
+
+See [the migration guide](./MIGRATING.md#v9-to-v10) for detailed instructions
+for upgrading your code to arangojs v10.
+
+### Changed
+
+- Renamed `CollectionDropOptions` type to `DropCollectionOptions`
+
+- Renamed `CollectionTruncateOptions` type to `TruncateCollectionOptions`
+
+- Renamed `Config` type to `ConfigOptions`
+
+- Renamed `path` option to `pathname` in `RequestOptions` type
+
+  This affects the `db.waitForPropagation` and `route.request` methods.
+
+- Removed `basePath` option from `RequestOptions` type
+
+  This affects the `db.waitForPropagation` and `route.request` methods.
+
+- Renamed `route.path` property to `route.pathname`
+
+- Changed error type constructor signatures
+
+  The `request` property is now always positional and the `options` property
+  is always optional.
+
+- Moved configuration related types to new `config` module
+
+  The following types were moved: `Config`, `LoadBalancingStrategy`,
+  `BasicAuthCredentials` and `BearerAuthCredentials`.
+
+- Moved `ArangoErrorResponse` type to `connection` module
+
+  The type is now also no longer marked as internal.
+
+- Moved configuration related types to new `configuration` module
+
+  The following types were moved: `ConfigOptions`, `LoadBalancingStrategy`,
+  `BasicAuthCredentials` and `BearerAuthCredentials`.
+
+- Moved internal utility functions to new `lib/util` module
+
+  These methods are all still marked as internal and should not be used
+  directly.
+
+- Closing a connection now closes all open requests
+
+  Previously in certain situations only the most recent request would be
+  closed per server. Note that this still merely aborts the requests but
+  does not guarantee the underlying connections are closed as these are
+  handled by Node.js or the browser natively.
+
+### Added
+
+- Restored support for Unix domain sockets
+
+  Using Unix domain sockets requires the `undici` library to be installed.
+
+- Restored support for `config.agentOptions`
+
+  The `config.agentOptions` option can now be used to create a custom `undici`
+  agent if the `undici` library is installed.
+
 ## [10.0.0-alpha.0] - 2024-11-28
 
 This is a major release and breaks backwards compatibility.
@@ -2288,6 +2355,7 @@ 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.
 
+[10.0.0-alpha.1]: https://github.com/arangodb/arangojs/compare/v10.0.0-alpha.0...v10.0.0-alpha.1
 [10.0.0-alpha.0]: https://github.com/arangodb/arangojs/compare/v9.2.0...v10.0.0-alpha.0
 [9.2.0]: https://github.com/arangodb/arangojs/compare/v9.1.0...v9.2.0
 [9.1.0]: https://github.com/arangodb/arangojs/compare/v9.0.0...v9.1.0

package/README.md

@@ -255,7 +255,7 @@ allowing arangojs to provide more meaningful stack traces at the cost of an
 impact to performance even when no error occurs.
 
 ```diff
-  const { Database } = require("arangojs");
+  import { Database } from "arangojs";
 
   const db = new Database({
     url: ARANGODB_SERVER,
@@ -269,15 +269,47 @@ that do not support the `stack` property on error objects, this option will
 still impact performance but not result in any additional information becoming
 available.
 
+### Unix domain sockets
+
+If you want to use Unix domain sockets, you need to install the `undici` module,
+which is an optional dependency of arangojs.
+
+```sh
+npm install --save undici
+```
+
+If the `undici` module is not installed and arangojs attempts to make a request
+over a Unix domain socket, the request will fail with a plain `Error` with a
+message indicating that the `undici` module is unavailable.
+
 ### Node.js with self-signed HTTPS certificates
 
-If you need to support self-signed HTTPS certificates in Node.js, you may have
-to override the global fetch agent. At the time of this writing, there is no
-official way to do this for the native `fetch` implementation in Node.js.
+If you need to support self-signed HTTPS certificates in Node.js, you will need
+to install the `undici` module, which is an optional dependency of arangojs.
+
+```sh
+npm install --save undici
+```
+
+You can instruct arangojs to use the `undici` module by setting the
+`config.agentOptions` option:
+
+```diff
+  import { Database } from "arangojs";
+
+  const db = new Database({
+    url: ARANGODB_SERVER,
++   agentOptions: {
++     ca: [
++       fs.readFileSync(".ssl/sub.class1.server.ca.pem"),
++       fs.readFileSync(".ssl/ca.pem"),
++     ],
++   },
+  });
+```
 
-However as Node.js uses the `undici` module for its `fetch` implementation
-internally, you can override the global agent by adding `undici` as a
-dependency to your project and using its `setGlobalDispatcher` as follows:
+To override the global fetch agent instead, you can use the `undici` module's
+`setGlobalDispatcher` method as follows:
 
 ```js
 import { Agent, setGlobalDispatcher } from "undici";
@@ -293,20 +325,22 @@ setGlobalDispatcher(
 ```
 
 Although this is **strongly discouraged**, it's also possible to disable
-HTTPS certificate validation entirely, but note this has
+HTTPS certificate validation entirely this way, but note this has
 **extremely dangerous** security implications:
 
-```js
-import { Agent, setGlobalDispatcher } from "undici";
+```diff
+  import { Database } from "arangojs";
 
-setGlobalDispatcher(
-  new Agent({
-    rejectUnauthorized: false,
-  })
-);
+  const db = new Database({
+    url: ARANGODB_SERVER,
++   agentOptions: {
++     rejectUnauthorized: false,
++   },
+  });
 ```
 
-This is a [known limitation](https://github.com/orgs/nodejs/discussions/44038#discussioncomment-5701073)
+The requirement to use the `undici` module to override these settings is a
+[known limitation](https://github.com/orgs/nodejs/discussions/44038#discussioncomment-5701073)
 of Node.js at the time of this writing.
 
 When using arangojs in the browser, self-signed HTTPS certificates need to

package/cjs/administration.js.map

@@ -1 +1 @@
-{"version":3,"file":"administration.js","sourceRoot":"","sources":["../../src/administration.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;AAqVF,CAAC","sourcesContent":["/**\n * ```ts\n * import type { VersionInfo } from \"arangojs/administration\";\n * ```\n *\n * The \"administration\" module provides types for database administration.\n *\n * @packageDocumentation\n */\n\n/**\n * Result of retrieving database version information.\n */\nexport type VersionInfo = {\n  /**\n   * Value identifying the server type, i.e. `\"arango\"`.\n   */\n  server: string;\n  /**\n   * ArangoDB license type or \"edition\".\n   */\n  license: \"community\" | \"enterprise\";\n  /**\n   * ArangoDB server version.\n   */\n  version: string;\n  /**\n   * Additional information about the ArangoDB server.\n   */\n  details?: { [key: string]: string };\n};\n\n/**\n * Information about the storage engine.\n */\nexport type EngineInfo = {\n  /**\n   * Endianness of the storage engine.\n   */\n  endianness?: \"little\" | \"big\";\n  /**\n   * Name of the storage engine.\n   */\n  name: string;\n  /**\n   * Features supported by the storage engine.\n   */\n  supports?: {\n    /**\n     * Index types supported by the storage engine.\n     */\n    indexes?: string[];\n    /**\n     * Aliases supported by the storage engine.\n     */\n    aliases?: {\n      /**\n       * Index type aliases supported by the storage engine.\n       */\n      indexes?: Record<string, string>;\n    }\n  };\n};\n\n/**\n * Information about the server status.\n */\nexport type ServerStatusInformation = {\n  /**\n   * (Cluster Coordinators and DB-Servers only.) The address of the server.\n   */\n  address?: string;\n  /**\n   * (Cluster Coordinators and DB-Servers only.) Information about the Agency.\n   */\n  agency?: {\n    /**\n     * Information about the communication with the Agency.\n     */\n    agencyComm: {\n      /**\n       * A list of possible Agency endpoints.\n       */\n      endpoints: string[];\n    };\n  };\n  /**\n   * (Cluster Agents only.) Information about the Agents.\n   */\n  agent?: {\n    /**\n     * The endpoint of the queried Agent.\n     */\n    endpoint: string;\n    /**\n     * Server ID of the queried Agent.\n     */\n    id: string;\n    /**\n     * Server ID of the leading Agent.\n     */\n    leaderId: string;\n    /**\n     * Whether the queried Agent is the leader.\n     */\n    leading: boolean;\n    /**\n     * The current term number.\n     */\n    term: number;\n  };\n  /**\n   * (Cluster Coordinators only.) Information about the Coordinators.\n   */\n  coordinator?: {\n    /**\n     * The server ID of the Coordinator that is the Foxx master.\n     */\n    foxxmaster: string[];\n    /**\n     * Whether the queried Coordinator is the Foxx master.\n     */\n    isFoxxmaster: boolean[];\n  };\n  /**\n   * Whether the Foxx API is enabled.\n   */\n  foxxApi: boolean;\n  /**\n   * A host identifier defined by the HOST or NODE_NAME environment variable, \n   * or a fallback value using a machine identifier or the cluster/Agency address.\n   */\n  host: string;\n  /**\n   * A hostname defined by the HOSTNAME environment variable.\n   */\n  hostname?: string;\n  /**\n   * ArangoDB Edition.\n   */\n  license: \"community\" | \"enterprise\";\n  /**\n   * Server operation mode.\n   * \n   * @deprecated use `operationMode` instead\n   */\n  mode: \"server\" | \"console\";\n  /**\n   * Server operation mode.\n   */\n  operationMode: \"server\" | \"console\";\n  /**\n   * The process ID of arangod.\n   */\n  pid: number;\n  /**\n   * Server type.\n   */\n  server: \"arango\";\n  /**\n   * Information about the server status.\n   */\n  serverInfo: {\n    /**\n     * Whether the maintenance mode is enabled.\n     */\n    maintenance: boolean;\n    /**\n     * (Cluster only.) The persisted ID.\n     */\n    persistedId?: string;\n    /**\n     * Startup and recovery information.\n     */\n    progress: {\n      /**\n       * Internal name of the feature that is currently being prepared, started, stopped or unprepared.\n       */\n      feature: string;\n      /**\n       * Name of the lifecycle phase the instance is currently in.\n       */\n      phase: string;\n      /**\n       * Current recovery sequence number value.\n       */\n      recoveryTick: number;\n    };\n    /**\n     * Whether writes are disabled.\n     */\n    readOnly: boolean;\n    /**\n     * (Cluster only.) The reboot ID. Changes on every restart.\n     */\n    rebootId?: number;\n    /**\n     * Either \"SINGLE\", \"COORDINATOR\", \"PRIMARY\" (DB-Server), or \"AGENT\"\n     */\n    role: \"SINGLE\" | \"COORDINATOR\" | \"PRIMARY\" | \"AGENT\";\n    /**\n     * (Cluster Coordinators and DB-Servers only.) The server ID.\n     */\n    serverId?: string;\n    /**\n     * (Cluster Coordinators and DB-Servers only.) Either \"STARTUP\", \"SERVING\",\n     * or \"SHUTDOWN\".\n     */\n    state?: \"STARTUP\" | \"SERVING\" | \"SHUTDOWN\";\n    /**\n     * The server version string.\n     */\n    version: string;\n    /**\n     * Whether writes are enabled.\n     * \n     * @deprecated Use `readOnly` instead.\n     */\n    writeOpsEnabled: boolean;\n  };\n};\n\n/**\n * Server availability.\n *\n * - `\"default\"`: The server is operational.\n * \n * - `\"readonly\"`: The server is in read-only mode.\n * \n * - `false`: The server is not available.\n */\nexport type ServerAvailability = \"default\" | \"readonly\" | false;\n\n/**\n * Single server deployment information for support purposes.\n */\nexport type SingleServerSupportInfo = {\n  /**\n   * ISO 8601 datetime string of when the information was requested.\n   */\n  date: string;\n  /**\n   * Information about the deployment.\n   */\n  deployment: {\n    /**\n     * Deployment mode:\n     * \n     * - `\"single\"`: A single server deployment.\n     * \n     * - `\"cluster\"`: A cluster deployment.\n     */\n    type: \"single\";\n  };\n};\n\n/**\n * Cluster deployment information for support purposes.\n */\nexport type ClusterSupportInfo = {\n  /**\n   * ISO 8601 datetime string of when the information was requested.\n   */\n  date: string;\n  /**\n   * Information about the deployment.\n   */\n  deployment: {\n    /**\n     * Deployment mode:\n     * \n     * - `\"single\"`: A single server deployment.\n     * \n     * - `\"cluster\"`: A cluster deployment.\n     */\n    type: \"cluster\";\n    /**\n     * Information about the servers in the cluster.\n     */\n    servers: Record<string, Record<string, any>>;\n    /**\n     * Number of agents in the cluster.\n     */\n    agents: number;\n    /**\n     * Number of coordinators in the cluster.\n     */\n    coordinators: number;\n    /**\n     * Number of DB-Servers in the cluster.\n     */\n    dbServers: number;\n    /**\n     * Information about the shards in the cluster.\n     */\n    shards: {\n      /**\n       * Number of collections in the cluster.\n       */\n      collections: number;\n      /**\n       * Number of shards in the cluster.\n       */\n      shards: number;\n      /**\n       * Number of leaders in the cluster.\n       */\n      leaders: number;\n      /**\n       * Number of real leaders in the cluster.\n       */\n      realLeaders: number;\n      /**\n       * Number of followers in the cluster.\n       */\n      followers: number;\n      /**\n       * Number of servers in the cluster.\n       */\n      servers: number;\n    }\n  };\n  /**\n   * (Cluster only.) Information about the ArangoDB instance as well as the\n   * host machine.\n   */\n  host: Record<string, any>;\n};\n\n/**\n * An object providing methods for accessing queue time metrics of the most\n * recently received server responses if the server supports this feature.\n */\nexport interface QueueTimeMetrics {\n  /**\n   * Returns the queue time of the most recently received response in seconds.\n   */\n  getLatest(): number | undefined;\n  /**\n   * Returns a list of the most recently received queue time values as tuples\n   * of the timestamp of the response being processed in milliseconds and the\n   * queue time in seconds.\n   */\n  getValues(): [number, number][];\n  /**\n   * Returns the average queue time of the most recently received responses\n   * in seconds.\n   */\n  getAvg(): number;\n};\n"]}
+{"version":3,"file":"administration.js","sourceRoot":"","sources":["../../src/administration.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;AAqVF,CAAC","sourcesContent":["/**\n * ```ts\n * import type { VersionInfo } from \"arangojs/administration\";\n * ```\n *\n * The \"administration\" module provides types for database administration.\n *\n * @packageDocumentation\n */\n\n/**\n * Result of retrieving database version information.\n */\nexport type VersionInfo = {\n  /**\n   * Value identifying the server type, i.e. `\"arango\"`.\n   */\n  server: string;\n  /**\n   * ArangoDB license type or \"edition\".\n   */\n  license: \"community\" | \"enterprise\";\n  /**\n   * ArangoDB server version.\n   */\n  version: string;\n  /**\n   * Additional information about the ArangoDB server.\n   */\n  details?: { [key: string]: string };\n};\n\n/**\n * Information about the storage engine.\n */\nexport type EngineInfo = {\n  /**\n   * Endianness of the storage engine.\n   */\n  endianness?: \"little\" | \"big\";\n  /**\n   * Name of the storage engine.\n   */\n  name: string;\n  /**\n   * Features supported by the storage engine.\n   */\n  supports?: {\n    /**\n     * Index types supported by the storage engine.\n     */\n    indexes?: string[];\n    /**\n     * Aliases supported by the storage engine.\n     */\n    aliases?: {\n      /**\n       * Index type aliases supported by the storage engine.\n       */\n      indexes?: Record<string, string>;\n    }\n  };\n};\n\n/**\n * Information about the server status.\n */\nexport type ServerStatusInformation = {\n  /**\n   * (Cluster Coordinators and DB-Servers only.) The address of the server.\n   */\n  address?: string;\n  /**\n   * (Cluster Coordinators and DB-Servers only.) Information about the Agency.\n   */\n  agency?: {\n    /**\n     * Information about the communication with the Agency.\n     */\n    agencyComm: {\n      /**\n       * A list of possible Agency endpoints.\n       */\n      endpoints: string[];\n    };\n  };\n  /**\n   * (Cluster Agents only.) Information about the Agents.\n   */\n  agent?: {\n    /**\n     * The endpoint of the queried Agent.\n     */\n    endpoint: string;\n    /**\n     * Server ID of the queried Agent.\n     */\n    id: string;\n    /**\n     * Server ID of the leading Agent.\n     */\n    leaderId: string;\n    /**\n     * Whether the queried Agent is the leader.\n     */\n    leading: boolean;\n    /**\n     * The current term number.\n     */\n    term: number;\n  };\n  /**\n   * (Cluster Coordinators only.) Information about the Coordinators.\n   */\n  coordinator?: {\n    /**\n     * The server ID of the Coordinator that is the Foxx master.\n     */\n    foxxmaster: string[];\n    /**\n     * Whether the queried Coordinator is the Foxx master.\n     */\n    isFoxxmaster: boolean[];\n  };\n  /**\n   * Whether the Foxx API is enabled.\n   */\n  foxxApi: boolean;\n  /**\n   * A host identifier defined by the HOST or NODE_NAME environment variable, \n   * or a fallback value using a machine identifier or the cluster/Agency address.\n   */\n  host: string;\n  /**\n   * A hostname defined by the HOSTNAME environment variable.\n   */\n  hostname?: string;\n  /**\n   * ArangoDB Edition.\n   */\n  license: \"community\" | \"enterprise\";\n  /**\n   * Server operation mode.\n   *\n   * @deprecated use `operationMode` instead\n   */\n  mode: \"server\" | \"console\";\n  /**\n   * Server operation mode.\n   */\n  operationMode: \"server\" | \"console\";\n  /**\n   * The process ID of arangod.\n   */\n  pid: number;\n  /**\n   * Server type.\n   */\n  server: \"arango\";\n  /**\n   * Information about the server status.\n   */\n  serverInfo: {\n    /**\n     * Whether the maintenance mode is enabled.\n     */\n    maintenance: boolean;\n    /**\n     * (Cluster only.) The persisted ID.\n     */\n    persistedId?: string;\n    /**\n     * Startup and recovery information.\n     */\n    progress: {\n      /**\n       * Internal name of the feature that is currently being prepared, started, stopped or unprepared.\n       */\n      feature: string;\n      /**\n       * Name of the lifecycle phase the instance is currently in.\n       */\n      phase: string;\n      /**\n       * Current recovery sequence number value.\n       */\n      recoveryTick: number;\n    };\n    /**\n     * Whether writes are disabled.\n     */\n    readOnly: boolean;\n    /**\n     * (Cluster only.) The reboot ID. Changes on every restart.\n     */\n    rebootId?: number;\n    /**\n     * Either \"SINGLE\", \"COORDINATOR\", \"PRIMARY\" (DB-Server), or \"AGENT\"\n     */\n    role: \"SINGLE\" | \"COORDINATOR\" | \"PRIMARY\" | \"AGENT\";\n    /**\n     * (Cluster Coordinators and DB-Servers only.) The server ID.\n     */\n    serverId?: string;\n    /**\n     * (Cluster Coordinators and DB-Servers only.) Either \"STARTUP\", \"SERVING\",\n     * or \"SHUTDOWN\".\n     */\n    state?: \"STARTUP\" | \"SERVING\" | \"SHUTDOWN\";\n    /**\n     * The server version string.\n     */\n    version: string;\n    /**\n     * Whether writes are enabled.\n     *\n     * @deprecated Use `readOnly` instead.\n     */\n    writeOpsEnabled: boolean;\n  };\n};\n\n/**\n * Server availability.\n *\n * - `\"default\"`: The server is operational.\n *\n * - `\"readonly\"`: The server is in read-only mode.\n *\n * - `false`: The server is not available.\n */\nexport type ServerAvailability = \"default\" | \"readonly\" | false;\n\n/**\n * Single server deployment information for support purposes.\n */\nexport type SingleServerSupportInfo = {\n  /**\n   * ISO 8601 datetime string of when the information was requested.\n   */\n  date: string;\n  /**\n   * Information about the deployment.\n   */\n  deployment: {\n    /**\n     * Deployment mode:\n     *\n     * - `\"single\"`: A single server deployment.\n     *\n     * - `\"cluster\"`: A cluster deployment.\n     */\n    type: \"single\";\n  };\n};\n\n/**\n * Cluster deployment information for support purposes.\n */\nexport type ClusterSupportInfo = {\n  /**\n   * ISO 8601 datetime string of when the information was requested.\n   */\n  date: string;\n  /**\n   * Information about the deployment.\n   */\n  deployment: {\n    /**\n     * Deployment mode:\n     *\n     * - `\"single\"`: A single server deployment.\n     *\n     * - `\"cluster\"`: A cluster deployment.\n     */\n    type: \"cluster\";\n    /**\n     * Information about the servers in the cluster.\n     */\n    servers: Record<string, Record<string, any>>;\n    /**\n     * Number of agents in the cluster.\n     */\n    agents: number;\n    /**\n     * Number of coordinators in the cluster.\n     */\n    coordinators: number;\n    /**\n     * Number of DB-Servers in the cluster.\n     */\n    dbServers: number;\n    /**\n     * Information about the shards in the cluster.\n     */\n    shards: {\n      /**\n       * Number of collections in the cluster.\n       */\n      collections: number;\n      /**\n       * Number of shards in the cluster.\n       */\n      shards: number;\n      /**\n       * Number of leaders in the cluster.\n       */\n      leaders: number;\n      /**\n       * Number of real leaders in the cluster.\n       */\n      realLeaders: number;\n      /**\n       * Number of followers in the cluster.\n       */\n      followers: number;\n      /**\n       * Number of servers in the cluster.\n       */\n      servers: number;\n    }\n  };\n  /**\n   * (Cluster only.) Information about the ArangoDB instance as well as the\n   * host machine.\n   */\n  host: Record<string, any>;\n};\n\n/**\n * An object providing methods for accessing queue time metrics of the most\n * recently received server responses if the server supports this feature.\n */\nexport interface QueueTimeMetrics {\n  /**\n   * Returns the queue time of the most recently received response in seconds.\n   */\n  getLatest(): number | undefined;\n  /**\n   * Returns a list of the most recently received queue time values as tuples\n   * of the timestamp of the response being processed in milliseconds and the\n   * queue time in seconds.\n   */\n  getValues(): [number, number][];\n  /**\n   * Returns the average queue time of the most recently received responses\n   * in seconds.\n   */\n  getAvg(): number;\n};\n"]}

package/cjs/analyzers.js

@@ -108,7 +108,7 @@ class Analyzer {
      */
     get() {
         return this._db.request({
-            path: `/_api/analyzer/${encodeURIComponent(this._name)}`,
+            pathname: `/_api/analyzer/${encodeURIComponent(this._name)}`,
         });
     }
     /**
@@ -129,7 +129,7 @@ class Analyzer {
     create(options) {
         return this._db.request({
             method: "POST",
-            path: "/_api/analyzer",
+            pathname: "/_api/analyzer",
             body: { name: this._name, ...options },
         });
     }
@@ -150,7 +150,7 @@ class Analyzer {
     drop(force = false) {
         return this._db.request({
             method: "DELETE",
-            path: `/_api/analyzer/${encodeURIComponent(this._name)}`,
+            pathname: `/_api/analyzer/${encodeURIComponent(this._name)}`,
             search: { force },
         });
     }

package/cjs/analyzers.js.map

@@ -1 +1 @@
-{"version":3,"file":"analyzers.js","sourceRoot":"","sources":["../../src/analyzers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAYA,oDAAsC;AACtC,6CAAoD;AA6yBpD,YAAY;AAEZ,wBAAwB;AACxB;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,QAAa;IAC5C,OAAO,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC,gBAAgB,CAAC,CAAC;AACxD,CAAC;AAFD,4CAEC;AAED;;GAEG;AACH,MAAa,QAAQ;IACT,KAAK,CAAS;IACd,GAAG,CAAqB;IAElC;;OAEG;IACH,YAAY,EAAsB,EAAE,IAAY;QAC9C,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,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,CAAC;YACH,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,KAAK,6BAAkB,EAAE,CAAC;gBACrE,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;YACtB,IAAI,EAAE,kBAAkB,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;SACzD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,OAAgB;QAsChB,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;YACtB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,OAAO,EAAE;SACvC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,QAAiB,KAAK;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;YACtB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,kBAAkB,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YACxD,MAAM,EAAE,EAAE,KAAK,EAAE;SAClB,CAAC,CAAC;IACL,CAAC;CACF;AA/JD,4BA+JC;AACD,YAAY","sourcesContent":["/**\n * ```ts\n * import type { Analyzer } from \"arangojs/analyzers\";\n * ```\n *\n * The \"analyzers\" module provides Analyzer related types and interfaces\n * for TypeScript.\n *\n * @packageDocumentation\n */\nimport * as databases from \"./databases.js\";\nimport * as connection from \"./connection.js\";\nimport * as errors from \"./errors.js\";\nimport { ANALYZER_NOT_FOUND } from \"./lib/codes.js\";\n\n//#region Shared types\n/**\n * Name of a feature enabled for an Analyzer.\n */\nexport type AnalyzerFeature = \"frequency\" | \"norm\" | \"position\" | \"offset\";\n\n/**\n * Text case conversion type.\n */\nexport type CaseConversion = \"lower\" | \"upper\" | \"none\";\n\n/**\n * Token type for a Segmentation Analyzer.\n */\nexport type SegmentationTokenType = \"all\" | \"alpha\" | \"graphic\";\n\n/**\n * Token data type for an AQL Analyzer.\n */\nexport type AqlReturnTokenType = \"string\" | \"number\" | \"bool\";\n\n/**\n * GeoJSON type.\n */\nexport type GeoType = \"shape\" | \"centroid\" | \"point\";\n\n/**\n * Storage format of a Geo S2 Analyzer.\n */\nexport type GeoS2Format = \"latLngDouble\" | \"latLngInt\" | \"s2Point\";\n\n/**\n * Type of an Analyzer.\n */\nexport type AnalyzerType = AnalyzerDescription[\"type\"];\n//#endregion\n\n//#region CreateAnalyzerOptions\n/**\n * Analyzer type and its type-specific properties.\n */\nexport type CreateAnalyzerOptions =\n  | CreateIdentityAnalyzerOptions\n  | CreateDelimiterAnalyzerOptions\n  | CreateMultiDelimiterAnalyzerOptions\n  | CreateStemAnalyzerOptions\n  | CreateNormAnalyzerOptions\n  | CreateNgramAnalyzerOptions\n  | CreateTextAnalyzerOptions\n  | CreateSegmentationAnalyzerOptions\n  | CreateAqlAnalyzerOptions\n  | CreatePipelineAnalyzerOptions\n  | CreateStopwordsAnalyzerOptions\n  | CreateCollationAnalyzerOptions\n  | CreateMinHashAnalyzerOptions\n  | CreateClassificationAnalyzerOptions\n  | CreateNearestNeighborsAnalyzerOptions\n  | CreateWildcardAnalyzerOptions\n  | CreateGeoJsonAnalyzerOptions\n  | CreateGeoPointAnalyzerOptions\n  | CreateGeoS2AnalyzerOptions;\n\ntype CreateAnalyzerOptionsType<\n  Type extends AnalyzerType,\n  Properties = void\n> = Properties extends void\n  ? {\n    /**\n     * Type of the Analyzer.\n     */\n    type: Type;\n    /**\n     * Features to enable for this Analyzer.\n     */\n    features?: AnalyzerFeature[];\n    /**\n     * This Analyzer does not take additional properties.\n     */\n    properties?: Record<string, never>;\n  }\n  : {\n    /**\n     * Type of the Analyzer.\n     */\n    type: Type;\n    /**\n     * Features to enable for this Analyzer.\n     */\n    features?: AnalyzerFeature[];\n    /**\n     * Additional properties for the Analyzer.\n     */\n    properties: Properties;\n  };\n\n/**\n * Options for creating an Identity Analyzer.\n */\nexport type CreateIdentityAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"identity\"\n>;\n\n/**\n * Options for creating a Delimiter Analyzer.\n */\nexport type CreateDelimiterAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"delimiter\",\n  | string\n  | {\n    /**\n     * This value will be used as delimiter to split text into tokens as\n     * specified in RFC 4180, without starting new records on newlines.\n     */\n    delimiter: string;\n  }\n>;\n\n/**\n * Options for creating a Multi-Delimiter Analyzer.\n */\nexport type CreateMultiDelimiterAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"multi_delimiter\",\n  {\n    /**\n     * This value will be used as delimiter to split text into tokens as\n     * specified in RFC 4180, without starting new records on newlines.\n     */\n    delimiters: string[];\n  }\n>;\n\n/**\n * Options for creating a Stem Analyzer.\n */\nexport type CreateStemAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"stem\",\n  {\n    /**\n     * Text locale.\n     *\n     * Format: `language[_COUNTRY][.encoding][@variant]`\n     */\n    locale: string;\n  }\n>;\n\n/**\n * Options for creating a Norm Analyzer.\n */\nexport type CreateNormAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"norm\",\n  {\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?: CaseConversion;\n    /**\n     * Preserve accents in returned words.\n     *\n     * Default: `false`\n     */\n    accent?: boolean;\n  }\n>;\n\n/**\n * Options for creating an Ngram Analyzer.\n */\nexport type CreateNgramAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"ngram\",\n  {\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/**\n * Options for creating a Text Analyzer.\n */\nexport type CreateTextAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"text\",\n  {\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?: CaseConversion;\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?: {\n      min?: number;\n      max?: number;\n      preserveOriginal?: boolean;\n    };\n  }\n>;\n\n/**\n * Options for creating a Segmentation Analyzer\n */\nexport type CreateSegmentationAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"segmentation\",\n  {\n    /**\n     * Which tokens should be returned.\n     *\n     * Default: `\"alpha\"`\n     */\n    break?: SegmentationTokenType;\n    /**\n     * What case all returned tokens should be converted to if applicable.\n     *\n     * Default: `\"none\"`\n     */\n    case?: CaseConversion;\n  }\n>;\n\n/**\n * Options for creating an AQL Analyzer\n */\nexport type CreateAqlAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"aql\",\n  {\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?: AqlReturnTokenType;\n  }\n>;\n\n/**\n * Options for creating a Pipeline Analyzer\n */\nexport type CreatePipelineAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"pipeline\",\n  {\n    /**\n     * Definitions for Analyzers to chain in this Pipeline Analyzer.\n     */\n    pipeline: Omit<CreateAnalyzerOptions, \"features\">[];\n  }\n>;\n\n/**\n * Options for creating a Stopwords Analyzer\n */\nexport type CreateStopwordsAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"stopwords\",\n  {\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/**\n * Options for creating a Collation Analyzer\n */\nexport type CreateCollationAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"collation\",\n  {\n    /**\n     * Text locale.\n     *\n     * Format: `language[_COUNTRY][.encoding][@variant]`\n     */\n    locale: string;\n  }\n>;\n\n/**\n * (Enterprise Edition only.) Options for creating a MinHash Analyzer\n */\nexport type CreateMinHashAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"minhash\",\n  {\n    /**\n     * An Analyzer definition-like object with `type` and `properties` attributes.\n     */\n    analyzer: Omit<CreateAnalyzerOptions, \"features\">;\n    /**\n     * Size of the MinHash signature.\n     */\n    numHashes: number;\n  }\n>;\n\n/**\n * (Enterprise Edition only.) Options for creating a Classification Analyzer\n */\nexport type CreateClassificationAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"classification\",\n  {\n    /**\n     * On-disk path to the trained fastText supervised model.\n     */\n    model_location: string;\n    /**\n     * Number of class labels that will be produced per input.\n     *\n     * Default: `1`\n     */\n    top_k?: number;\n    /**\n     * Probability threshold for which a label will be assigned to an input.\n     *\n     * Default: `0.99`\n     */\n    threshold?: number;\n  }\n>;\n\n/**\n * (Enterprise Edition only.) Options for creating a NearestNeighbors Analyzer.\n */\nexport type CreateNearestNeighborsAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"nearest_neighbors\",\n  {\n    /**\n     * On-disk path to the trained fastText supervised model.\n     */\n    model_location: string;\n    /**\n     * Number of class labels that will be produced per input.\n     *\n     * Default: `1`\n     */\n    top_k?: number;\n  }\n>;\n\n/**\n * Options for creating a Wildcard Analyzer.\n */\nexport type CreateWildcardAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"wildcard\",\n  {\n    /**\n     * N-gram length. Must be a positive integer greater than or equal to 2.\n     */\n    ngramSize: string;\n    /**\n     * An Analyzer definition-like object with `type` and `properties` attributes.\n     */\n    analyzer?: Omit<CreateAnalyzerOptions, \"features\">;\n  }\n>;\n\n/**\n * Options for creating a GeoJSON Analyzer\n */\nexport type CreateGeoJsonAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"geojson\",\n  {\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?: GeoType;\n    /**\n     * Options for fine-tuning geo queries.\n     *\n     * Default: `{ maxCells: 20, minLevel: 4, maxLevel: 23 }`\n     */\n    options?: {\n      maxCells?: number;\n      minLevel?: number;\n      maxLevel?: number;\n    };\n  }\n>;\n\n/**\n * Options for creating a GeoPoint Analyzer\n */\nexport type CreateGeoPointAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"geopoint\",\n  {\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?: {\n      minCells?: number;\n      minLevel?: number;\n      maxLevel?: number;\n    };\n  }\n>;\n\n/**\n * (Enterprise Edition only.) Options for creating a Geo S2 Analyzer\n */\nexport type CreateGeoS2AnalyzerOptions = CreateAnalyzerOptionsType<\n  \"geo_s2\",\n  {\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?: GeoType;\n    /**\n     * Options for fine-tuning geo queries.\n     *\n     * Default: `{ maxCells: 20, minLevel: 4, maxLevel: 23 }`\n     */\n    options?: {\n      maxCells?: number;\n      minLevel?: number;\n      maxLevel?: number;\n    };\n    /**\n     * If set to `\"latLngDouble\"`, each latitude and longitude value is stored\n     * as an 8-byte floating-point value (16 bytes per coordinate pair).\n     *\n     * If set to `\"latLngInt\"`, each latitude and longitude value is stored as\n     * a 4-byte integer value (8 bytes per coordinate pair).\n     *\n     * If set to `\"s2Point\"`, each longitude-latitude pair is stored in the\n     * native format of Google S2 (24 bytes per coordinate pair).\n     *\n     * Default: `\"latLngDouble\"`\n     */\n    format?: GeoS2Format;\n  }\n>;\n//#endregion\n\n//#region AnalyzerDescription\n/**\n * An object describing an Analyzer.\n */\nexport type AnalyzerDescription =\n  | IdentityAnalyzerDescription\n  | DelimiterAnalyzerDescription\n  | MultiDelimiterAnalyzerDescription\n  | StemAnalyzerDescription\n  | NormAnalyzerDescription\n  | NgramAnalyzerDescription\n  | TextAnalyzerDescription\n  | SegmentationAnalyzerDescription\n  | AqlAnalyzerDescription\n  | PipelineAnalyzerDescription\n  | StopwordsAnalyzerDescription\n  | CollationAnalyzerDescription\n  | MinHashAnalyzerDescription\n  | ClassificationAnalyzerDescription\n  | NearestNeighborsAnalyzerDescription\n  | WildcardAnalyzerDescription\n  | GeoJsonAnalyzerDescription\n  | GeoPointAnalyzerDescription\n  | GeoS2AnalyzerDescription;\n\n/**\n * Shared attributes of all Analyzer descriptions.\n */\ntype AnalyzerDescriptionType<\n  Type extends string,\n  Properties = Record<string, never>\n> = {\n  /**\n   * A unique name for this Analyzer.\n   */\n  name: string;\n  /**\n   * Type of the Analyzer.\n   */\n  type: Type;\n  /**\n   * Features to enable for this Analyzer.\n   */\n  features?: AnalyzerFeature[];\n  /**\n   * Additional properties for the Analyzer.\n   */\n  properties: Properties;\n};\n\n/**\n * An object describing an Identity Analyzer.\n */\nexport type IdentityAnalyzerDescription = AnalyzerDescriptionType<\"identity\">;\n\n/**\n * An object describing a Delimiter Analyzer.\n */\nexport type DelimiterAnalyzerDescription = AnalyzerDescriptionType<\n  \"delimiter\",\n  { delimiter: string }\n>;\n\n/**\n * An object describing a Multi Delimiter Analyzer.\n */\nexport type MultiDelimiterAnalyzerDescription = AnalyzerDescriptionType<\n  \"multi_delimiter\",\n  { delimiters: string[] }\n>;\n\n/**\n * An object describing a Stem Analyzer.\n */\nexport type StemAnalyzerDescription = AnalyzerDescriptionType<\n  \"stem\",\n  { locale: string }\n>;\n\n/**\n * An object describing a Norm Analyzer.\n */\nexport type NormAnalyzerDescription = AnalyzerDescriptionType<\n  \"norm\",\n  {\n    locale: string;\n    case: CaseConversion;\n    accent: boolean;\n  }\n>;\n\n/**\n * An object describing an Ngram Analyzer.\n */\nexport type NgramAnalyzerDescription = AnalyzerDescriptionType<\n  \"ngram\",\n  {\n    min: number;\n    max: number;\n    preserveOriginal: boolean;\n  }\n>;\n\n/**\n * An object describing a Text Analyzer.\n */\nexport type TextAnalyzerDescription = AnalyzerDescriptionType<\n  \"text\",\n  {\n    locale: string;\n    case: CaseConversion;\n    stopwords: string[];\n    stopwordsPath: string;\n    accent: boolean;\n    stemming: boolean;\n    edgeNgram: {\n      min: number;\n      max: number;\n      preserveOriginal: boolean;\n    };\n  }\n>;\n\n/**\n * An object describing a Segmentation Analyzer\n */\nexport type SegmentationAnalyzerDescription = AnalyzerDescriptionType<\n  \"segmentation\",\n  {\n    break: SegmentationTokenType;\n    case: CaseConversion;\n  }\n>;\n\n/**\n * An object describing an AQL Analyzer\n */\nexport type AqlAnalyzerDescription = AnalyzerDescriptionType<\n  \"aql\",\n  {\n    queryString: string;\n    collapsePositions: boolean;\n    keepNull: boolean;\n    batchSize: number;\n    memoryLimit: number;\n    returnType: AqlReturnTokenType;\n  }\n>;\n\n/**\n * An object describing a Pipeline Analyzer\n */\nexport type PipelineAnalyzerDescription = AnalyzerDescriptionType<\n  \"pipeline\",\n  {\n    pipeline: Omit<AnalyzerDescription, \"name\" | \"features\">[];\n  }\n>;\n\n/**\n * An object describing a Stopwords Analyzer\n */\nexport type StopwordsAnalyzerDescription = AnalyzerDescriptionType<\n  \"stopwords\",\n  {\n    stopwords: string[];\n    hex: boolean;\n  }\n>;\n\n/**\n * An object describing a Collation Analyzer\n */\nexport type CollationAnalyzerDescription = AnalyzerDescriptionType<\n  \"collation\",\n  {\n    locale: string;\n  }\n>;\n\n/**\n * (Enterprise Edition only.) An object describing a MinHash Analyzer\n */\nexport type MinHashAnalyzerDescription = AnalyzerDescriptionType<\n  \"minhash\",\n  {\n    analyzer: Omit<AnalyzerDescription, \"name\" | \"features\">;\n    numHashes: number;\n  }\n>;\n\n/**\n * (Enterprise Edition only.) An object describing a Classification Analyzer\n */\nexport type ClassificationAnalyzerDescription = AnalyzerDescriptionType<\n  \"classification\",\n  {\n    model_location: string;\n    top_k: number;\n    threshold: number;\n  }\n>;\n\n/**\n * (Enterprise Edition only.) An object describing a NearestNeighbors Analyzer\n */\nexport type NearestNeighborsAnalyzerDescription = AnalyzerDescriptionType<\n  \"nearest_neighbors\",\n  {\n    model_location: string;\n    top_k: number;\n  }\n>;\n\n/**\n * An object describing a Wildcard Analyzer\n */\nexport type WildcardAnalyzerDescription = AnalyzerDescriptionType<\n  \"wildcard\",\n  {\n    ngramSize: number;\n    analyzer?: Omit<AnalyzerDescription, \"name\" | \"features\">;\n  }\n>;\n\n/**\n * An object describing a GeoJSON Analyzer\n */\nexport type GeoJsonAnalyzerDescription = AnalyzerDescriptionType<\n  \"geojson\",\n  {\n    type: GeoType;\n    description: {\n      maxCells: number;\n      minLevel: number;\n      maxLevel: number;\n    };\n  }\n>;\n\n/**\n * An object describing a GeoPoint Analyzer\n */\nexport type GeoPointAnalyzerDescription = AnalyzerDescriptionType<\n  \"geopoint\",\n  {\n    latitude: string[];\n    longitude: string[];\n    description: {\n      minCells: number;\n      minLevel: number;\n      maxLevel: number;\n    };\n  }\n>;\n\n/**\n * (Enterprise Edition only.) An object describing a GeoS2 Analyzer\n */\nexport type GeoS2AnalyzerDescription = AnalyzerDescriptionType<\n  \"geo_s2\",\n  {\n    type: GeoType;\n    description: {\n      maxCells: number;\n      minLevel: number;\n      maxLevel: number;\n    };\n    format: GeoS2Format;\n  }\n>;\n//#endregion\n\n//#region Analyzer class\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 * Represents an Analyzer in a {@link databases.Database}.\n */\nexport class Analyzer {\n  protected _name: string;\n  protected _db: databases.Database;\n\n  /**\n   * @internal\n   */\n  constructor(db: databases.Database, name: string) {\n    this._db = db;\n    this._name = name;\n  }\n\n  /**\n   * Database this analyzer belongs to.\n   */\n  get database() {\n    return this._db;\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 databases.Database}.\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: any) {\n      if (errors.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<connection.ArangoApiResponse<AnalyzerDescription>> {\n    return this._db.request({\n      path: `/_api/analyzer/${encodeURIComponent(this._name)}`,\n    });\n  }\n\n  /**\n   * Creates a new Analyzer with the given `options` and the instance's name.\n   *\n   * See also {@link databases.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 extends CreateAnalyzerOptions>(\n    options: Options\n  ): Promise<\n    Options extends CreateIdentityAnalyzerOptions\n    ? IdentityAnalyzerDescription\n    : Options extends CreateDelimiterAnalyzerOptions\n    ? DelimiterAnalyzerDescription\n    : Options extends CreateStemAnalyzerOptions\n    ? StemAnalyzerDescription\n    : Options extends CreateNormAnalyzerOptions\n    ? NormAnalyzerDescription\n    : Options extends CreateNgramAnalyzerOptions\n    ? NgramAnalyzerDescription\n    : Options extends CreateTextAnalyzerOptions\n    ? TextAnalyzerDescription\n    : Options extends CreateSegmentationAnalyzerOptions\n    ? SegmentationAnalyzerDescription\n    : Options extends CreateAqlAnalyzerOptions\n    ? AqlAnalyzerDescription\n    : Options extends CreatePipelineAnalyzerOptions\n    ? PipelineAnalyzerDescription\n    : Options extends CreateStopwordsAnalyzerOptions\n    ? StopwordsAnalyzerDescription\n    : Options extends CreateCollationAnalyzerOptions\n    ? CollationAnalyzerDescription\n    : Options extends CreateMinHashAnalyzerOptions\n    ? MinHashAnalyzerDescription\n    : Options extends CreateClassificationAnalyzerOptions\n    ? ClassificationAnalyzerDescription\n    : Options extends CreateNearestNeighborsAnalyzerOptions\n    ? NearestNeighborsAnalyzerDescription\n    : Options extends CreateGeoJsonAnalyzerOptions\n    ? GeoJsonAnalyzerDescription\n    : Options extends CreateGeoPointAnalyzerOptions\n    ? GeoPointAnalyzerDescription\n    : Options extends CreateGeoS2AnalyzerOptions\n    ? GeoS2AnalyzerDescription\n    : AnalyzerDescription\n  > {\n    return this._db.request({\n      method: \"POST\",\n      path: \"/_api/analyzer\",\n      body: { name: this._name, ...options },\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(force: boolean = false): Promise<connection.ArangoApiResponse<{ name: string }>> {\n    return this._db.request({\n      method: \"DELETE\",\n      path: `/_api/analyzer/${encodeURIComponent(this._name)}`,\n      search: { force },\n    });\n  }\n}\n//#endregion"]}
+{"version":3,"file":"analyzers.js","sourceRoot":"","sources":["../../src/analyzers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAYA,oDAAsC;AACtC,6CAAoD;AA6yBpD,YAAY;AAEZ,wBAAwB;AACxB;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,QAAa;IAC5C,OAAO,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC,gBAAgB,CAAC,CAAC;AACxD,CAAC;AAFD,4CAEC;AAED;;GAEG;AACH,MAAa,QAAQ;IACT,KAAK,CAAS;IACd,GAAG,CAAqB;IAElC;;OAEG;IACH,YAAY,EAAsB,EAAE,IAAY;QAC9C,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,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,CAAC;YACH,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,KAAK,6BAAkB,EAAE,CAAC;gBACrE,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;YACtB,QAAQ,EAAE,kBAAkB,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,OAAgB;QAsChB,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;YACtB,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,gBAAgB;YAC1B,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,OAAO,EAAE;SACvC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,QAAiB,KAAK;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;YACtB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,kBAAkB,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAC5D,MAAM,EAAE,EAAE,KAAK,EAAE;SAClB,CAAC,CAAC;IACL,CAAC;CACF;AA/JD,4BA+JC;AACD,YAAY","sourcesContent":["/**\n * ```ts\n * import type { Analyzer } from \"arangojs/analyzers\";\n * ```\n *\n * The \"analyzers\" module provides Analyzer related types and interfaces\n * for TypeScript.\n *\n * @packageDocumentation\n */\nimport * as databases from \"./databases.js\";\nimport * as connection from \"./connection.js\";\nimport * as errors from \"./errors.js\";\nimport { ANALYZER_NOT_FOUND } from \"./lib/codes.js\";\n\n//#region Shared types\n/**\n * Name of a feature enabled for an Analyzer.\n */\nexport type AnalyzerFeature = \"frequency\" | \"norm\" | \"position\" | \"offset\";\n\n/**\n * Text case conversion type.\n */\nexport type CaseConversion = \"lower\" | \"upper\" | \"none\";\n\n/**\n * Token type for a Segmentation Analyzer.\n */\nexport type SegmentationTokenType = \"all\" | \"alpha\" | \"graphic\";\n\n/**\n * Token data type for an AQL Analyzer.\n */\nexport type AqlReturnTokenType = \"string\" | \"number\" | \"bool\";\n\n/**\n * GeoJSON type.\n */\nexport type GeoType = \"shape\" | \"centroid\" | \"point\";\n\n/**\n * Storage format of a Geo S2 Analyzer.\n */\nexport type GeoS2Format = \"latLngDouble\" | \"latLngInt\" | \"s2Point\";\n\n/**\n * Type of an Analyzer.\n */\nexport type AnalyzerType = AnalyzerDescription[\"type\"];\n//#endregion\n\n//#region CreateAnalyzerOptions\n/**\n * Analyzer type and its type-specific properties.\n */\nexport type CreateAnalyzerOptions =\n  | CreateIdentityAnalyzerOptions\n  | CreateDelimiterAnalyzerOptions\n  | CreateMultiDelimiterAnalyzerOptions\n  | CreateStemAnalyzerOptions\n  | CreateNormAnalyzerOptions\n  | CreateNgramAnalyzerOptions\n  | CreateTextAnalyzerOptions\n  | CreateSegmentationAnalyzerOptions\n  | CreateAqlAnalyzerOptions\n  | CreatePipelineAnalyzerOptions\n  | CreateStopwordsAnalyzerOptions\n  | CreateCollationAnalyzerOptions\n  | CreateMinHashAnalyzerOptions\n  | CreateClassificationAnalyzerOptions\n  | CreateNearestNeighborsAnalyzerOptions\n  | CreateWildcardAnalyzerOptions\n  | CreateGeoJsonAnalyzerOptions\n  | CreateGeoPointAnalyzerOptions\n  | CreateGeoS2AnalyzerOptions;\n\ntype CreateAnalyzerOptionsType<\n  Type extends AnalyzerType,\n  Properties = void\n> = Properties extends void\n  ? {\n    /**\n     * Type of the Analyzer.\n     */\n    type: Type;\n    /**\n     * Features to enable for this Analyzer.\n     */\n    features?: AnalyzerFeature[];\n    /**\n     * This Analyzer does not take additional properties.\n     */\n    properties?: Record<string, never>;\n  }\n  : {\n    /**\n     * Type of the Analyzer.\n     */\n    type: Type;\n    /**\n     * Features to enable for this Analyzer.\n     */\n    features?: AnalyzerFeature[];\n    /**\n     * Additional properties for the Analyzer.\n     */\n    properties: Properties;\n  };\n\n/**\n * Options for creating an Identity Analyzer.\n */\nexport type CreateIdentityAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"identity\"\n>;\n\n/**\n * Options for creating a Delimiter Analyzer.\n */\nexport type CreateDelimiterAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"delimiter\",\n  | string\n  | {\n    /**\n     * This value will be used as delimiter to split text into tokens as\n     * specified in RFC 4180, without starting new records on newlines.\n     */\n    delimiter: string;\n  }\n>;\n\n/**\n * Options for creating a Multi-Delimiter Analyzer.\n */\nexport type CreateMultiDelimiterAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"multi_delimiter\",\n  {\n    /**\n     * This value will be used as delimiter to split text into tokens as\n     * specified in RFC 4180, without starting new records on newlines.\n     */\n    delimiters: string[];\n  }\n>;\n\n/**\n * Options for creating a Stem Analyzer.\n */\nexport type CreateStemAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"stem\",\n  {\n    /**\n     * Text locale.\n     *\n     * Format: `language[_COUNTRY][.encoding][@variant]`\n     */\n    locale: string;\n  }\n>;\n\n/**\n * Options for creating a Norm Analyzer.\n */\nexport type CreateNormAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"norm\",\n  {\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?: CaseConversion;\n    /**\n     * Preserve accents in returned words.\n     *\n     * Default: `false`\n     */\n    accent?: boolean;\n  }\n>;\n\n/**\n * Options for creating an Ngram Analyzer.\n */\nexport type CreateNgramAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"ngram\",\n  {\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/**\n * Options for creating a Text Analyzer.\n */\nexport type CreateTextAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"text\",\n  {\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?: CaseConversion;\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?: {\n      min?: number;\n      max?: number;\n      preserveOriginal?: boolean;\n    };\n  }\n>;\n\n/**\n * Options for creating a Segmentation Analyzer\n */\nexport type CreateSegmentationAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"segmentation\",\n  {\n    /**\n     * Which tokens should be returned.\n     *\n     * Default: `\"alpha\"`\n     */\n    break?: SegmentationTokenType;\n    /**\n     * What case all returned tokens should be converted to if applicable.\n     *\n     * Default: `\"none\"`\n     */\n    case?: CaseConversion;\n  }\n>;\n\n/**\n * Options for creating an AQL Analyzer\n */\nexport type CreateAqlAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"aql\",\n  {\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?: AqlReturnTokenType;\n  }\n>;\n\n/**\n * Options for creating a Pipeline Analyzer\n */\nexport type CreatePipelineAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"pipeline\",\n  {\n    /**\n     * Definitions for Analyzers to chain in this Pipeline Analyzer.\n     */\n    pipeline: Omit<CreateAnalyzerOptions, \"features\">[];\n  }\n>;\n\n/**\n * Options for creating a Stopwords Analyzer\n */\nexport type CreateStopwordsAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"stopwords\",\n  {\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/**\n * Options for creating a Collation Analyzer\n */\nexport type CreateCollationAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"collation\",\n  {\n    /**\n     * Text locale.\n     *\n     * Format: `language[_COUNTRY][.encoding][@variant]`\n     */\n    locale: string;\n  }\n>;\n\n/**\n * (Enterprise Edition only.) Options for creating a MinHash Analyzer\n */\nexport type CreateMinHashAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"minhash\",\n  {\n    /**\n     * An Analyzer definition-like object with `type` and `properties` attributes.\n     */\n    analyzer: Omit<CreateAnalyzerOptions, \"features\">;\n    /**\n     * Size of the MinHash signature.\n     */\n    numHashes: number;\n  }\n>;\n\n/**\n * (Enterprise Edition only.) Options for creating a Classification Analyzer\n */\nexport type CreateClassificationAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"classification\",\n  {\n    /**\n     * On-disk path to the trained fastText supervised model.\n     */\n    model_location: string;\n    /**\n     * Number of class labels that will be produced per input.\n     *\n     * Default: `1`\n     */\n    top_k?: number;\n    /**\n     * Probability threshold for which a label will be assigned to an input.\n     *\n     * Default: `0.99`\n     */\n    threshold?: number;\n  }\n>;\n\n/**\n * (Enterprise Edition only.) Options for creating a NearestNeighbors Analyzer.\n */\nexport type CreateNearestNeighborsAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"nearest_neighbors\",\n  {\n    /**\n     * On-disk path to the trained fastText supervised model.\n     */\n    model_location: string;\n    /**\n     * Number of class labels that will be produced per input.\n     *\n     * Default: `1`\n     */\n    top_k?: number;\n  }\n>;\n\n/**\n * Options for creating a Wildcard Analyzer.\n */\nexport type CreateWildcardAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"wildcard\",\n  {\n    /**\n     * N-gram length. Must be a positive integer greater than or equal to 2.\n     */\n    ngramSize: string;\n    /**\n     * An Analyzer definition-like object with `type` and `properties` attributes.\n     */\n    analyzer?: Omit<CreateAnalyzerOptions, \"features\">;\n  }\n>;\n\n/**\n * Options for creating a GeoJSON Analyzer\n */\nexport type CreateGeoJsonAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"geojson\",\n  {\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?: GeoType;\n    /**\n     * Options for fine-tuning geo queries.\n     *\n     * Default: `{ maxCells: 20, minLevel: 4, maxLevel: 23 }`\n     */\n    options?: {\n      maxCells?: number;\n      minLevel?: number;\n      maxLevel?: number;\n    };\n  }\n>;\n\n/**\n * Options for creating a GeoPoint Analyzer\n */\nexport type CreateGeoPointAnalyzerOptions = CreateAnalyzerOptionsType<\n  \"geopoint\",\n  {\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?: {\n      minCells?: number;\n      minLevel?: number;\n      maxLevel?: number;\n    };\n  }\n>;\n\n/**\n * (Enterprise Edition only.) Options for creating a Geo S2 Analyzer\n */\nexport type CreateGeoS2AnalyzerOptions = CreateAnalyzerOptionsType<\n  \"geo_s2\",\n  {\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?: GeoType;\n    /**\n     * Options for fine-tuning geo queries.\n     *\n     * Default: `{ maxCells: 20, minLevel: 4, maxLevel: 23 }`\n     */\n    options?: {\n      maxCells?: number;\n      minLevel?: number;\n      maxLevel?: number;\n    };\n    /**\n     * If set to `\"latLngDouble\"`, each latitude and longitude value is stored\n     * as an 8-byte floating-point value (16 bytes per coordinate pair).\n     *\n     * If set to `\"latLngInt\"`, each latitude and longitude value is stored as\n     * a 4-byte integer value (8 bytes per coordinate pair).\n     *\n     * If set to `\"s2Point\"`, each longitude-latitude pair is stored in the\n     * native format of Google S2 (24 bytes per coordinate pair).\n     *\n     * Default: `\"latLngDouble\"`\n     */\n    format?: GeoS2Format;\n  }\n>;\n//#endregion\n\n//#region AnalyzerDescription\n/**\n * An object describing an Analyzer.\n */\nexport type AnalyzerDescription =\n  | IdentityAnalyzerDescription\n  | DelimiterAnalyzerDescription\n  | MultiDelimiterAnalyzerDescription\n  | StemAnalyzerDescription\n  | NormAnalyzerDescription\n  | NgramAnalyzerDescription\n  | TextAnalyzerDescription\n  | SegmentationAnalyzerDescription\n  | AqlAnalyzerDescription\n  | PipelineAnalyzerDescription\n  | StopwordsAnalyzerDescription\n  | CollationAnalyzerDescription\n  | MinHashAnalyzerDescription\n  | ClassificationAnalyzerDescription\n  | NearestNeighborsAnalyzerDescription\n  | WildcardAnalyzerDescription\n  | GeoJsonAnalyzerDescription\n  | GeoPointAnalyzerDescription\n  | GeoS2AnalyzerDescription;\n\n/**\n * Shared attributes of all Analyzer descriptions.\n */\ntype AnalyzerDescriptionType<\n  Type extends string,\n  Properties = Record<string, never>\n> = {\n  /**\n   * A unique name for this Analyzer.\n   */\n  name: string;\n  /**\n   * Type of the Analyzer.\n   */\n  type: Type;\n  /**\n   * Features to enable for this Analyzer.\n   */\n  features?: AnalyzerFeature[];\n  /**\n   * Additional properties for the Analyzer.\n   */\n  properties: Properties;\n};\n\n/**\n * An object describing an Identity Analyzer.\n */\nexport type IdentityAnalyzerDescription = AnalyzerDescriptionType<\"identity\">;\n\n/**\n * An object describing a Delimiter Analyzer.\n */\nexport type DelimiterAnalyzerDescription = AnalyzerDescriptionType<\n  \"delimiter\",\n  { delimiter: string }\n>;\n\n/**\n * An object describing a Multi Delimiter Analyzer.\n */\nexport type MultiDelimiterAnalyzerDescription = AnalyzerDescriptionType<\n  \"multi_delimiter\",\n  { delimiters: string[] }\n>;\n\n/**\n * An object describing a Stem Analyzer.\n */\nexport type StemAnalyzerDescription = AnalyzerDescriptionType<\n  \"stem\",\n  { locale: string }\n>;\n\n/**\n * An object describing a Norm Analyzer.\n */\nexport type NormAnalyzerDescription = AnalyzerDescriptionType<\n  \"norm\",\n  {\n    locale: string;\n    case: CaseConversion;\n    accent: boolean;\n  }\n>;\n\n/**\n * An object describing an Ngram Analyzer.\n */\nexport type NgramAnalyzerDescription = AnalyzerDescriptionType<\n  \"ngram\",\n  {\n    min: number;\n    max: number;\n    preserveOriginal: boolean;\n  }\n>;\n\n/**\n * An object describing a Text Analyzer.\n */\nexport type TextAnalyzerDescription = AnalyzerDescriptionType<\n  \"text\",\n  {\n    locale: string;\n    case: CaseConversion;\n    stopwords: string[];\n    stopwordsPath: string;\n    accent: boolean;\n    stemming: boolean;\n    edgeNgram: {\n      min: number;\n      max: number;\n      preserveOriginal: boolean;\n    };\n  }\n>;\n\n/**\n * An object describing a Segmentation Analyzer\n */\nexport type SegmentationAnalyzerDescription = AnalyzerDescriptionType<\n  \"segmentation\",\n  {\n    break: SegmentationTokenType;\n    case: CaseConversion;\n  }\n>;\n\n/**\n * An object describing an AQL Analyzer\n */\nexport type AqlAnalyzerDescription = AnalyzerDescriptionType<\n  \"aql\",\n  {\n    queryString: string;\n    collapsePositions: boolean;\n    keepNull: boolean;\n    batchSize: number;\n    memoryLimit: number;\n    returnType: AqlReturnTokenType;\n  }\n>;\n\n/**\n * An object describing a Pipeline Analyzer\n */\nexport type PipelineAnalyzerDescription = AnalyzerDescriptionType<\n  \"pipeline\",\n  {\n    pipeline: Omit<AnalyzerDescription, \"name\" | \"features\">[];\n  }\n>;\n\n/**\n * An object describing a Stopwords Analyzer\n */\nexport type StopwordsAnalyzerDescription = AnalyzerDescriptionType<\n  \"stopwords\",\n  {\n    stopwords: string[];\n    hex: boolean;\n  }\n>;\n\n/**\n * An object describing a Collation Analyzer\n */\nexport type CollationAnalyzerDescription = AnalyzerDescriptionType<\n  \"collation\",\n  {\n    locale: string;\n  }\n>;\n\n/**\n * (Enterprise Edition only.) An object describing a MinHash Analyzer\n */\nexport type MinHashAnalyzerDescription = AnalyzerDescriptionType<\n  \"minhash\",\n  {\n    analyzer: Omit<AnalyzerDescription, \"name\" | \"features\">;\n    numHashes: number;\n  }\n>;\n\n/**\n * (Enterprise Edition only.) An object describing a Classification Analyzer\n */\nexport type ClassificationAnalyzerDescription = AnalyzerDescriptionType<\n  \"classification\",\n  {\n    model_location: string;\n    top_k: number;\n    threshold: number;\n  }\n>;\n\n/**\n * (Enterprise Edition only.) An object describing a NearestNeighbors Analyzer\n */\nexport type NearestNeighborsAnalyzerDescription = AnalyzerDescriptionType<\n  \"nearest_neighbors\",\n  {\n    model_location: string;\n    top_k: number;\n  }\n>;\n\n/**\n * An object describing a Wildcard Analyzer\n */\nexport type WildcardAnalyzerDescription = AnalyzerDescriptionType<\n  \"wildcard\",\n  {\n    ngramSize: number;\n    analyzer?: Omit<AnalyzerDescription, \"name\" | \"features\">;\n  }\n>;\n\n/**\n * An object describing a GeoJSON Analyzer\n */\nexport type GeoJsonAnalyzerDescription = AnalyzerDescriptionType<\n  \"geojson\",\n  {\n    type: GeoType;\n    description: {\n      maxCells: number;\n      minLevel: number;\n      maxLevel: number;\n    };\n  }\n>;\n\n/**\n * An object describing a GeoPoint Analyzer\n */\nexport type GeoPointAnalyzerDescription = AnalyzerDescriptionType<\n  \"geopoint\",\n  {\n    latitude: string[];\n    longitude: string[];\n    description: {\n      minCells: number;\n      minLevel: number;\n      maxLevel: number;\n    };\n  }\n>;\n\n/**\n * (Enterprise Edition only.) An object describing a GeoS2 Analyzer\n */\nexport type GeoS2AnalyzerDescription = AnalyzerDescriptionType<\n  \"geo_s2\",\n  {\n    type: GeoType;\n    description: {\n      maxCells: number;\n      minLevel: number;\n      maxLevel: number;\n    };\n    format: GeoS2Format;\n  }\n>;\n//#endregion\n\n//#region Analyzer class\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 * Represents an Analyzer in a {@link databases.Database}.\n */\nexport class Analyzer {\n  protected _name: string;\n  protected _db: databases.Database;\n\n  /**\n   * @internal\n   */\n  constructor(db: databases.Database, name: string) {\n    this._db = db;\n    this._name = name;\n  }\n\n  /**\n   * Database this analyzer belongs to.\n   */\n  get database() {\n    return this._db;\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 databases.Database}.\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: any) {\n      if (errors.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<connection.ArangoApiResponse<AnalyzerDescription>> {\n    return this._db.request({\n      pathname: `/_api/analyzer/${encodeURIComponent(this._name)}`,\n    });\n  }\n\n  /**\n   * Creates a new Analyzer with the given `options` and the instance's name.\n   *\n   * See also {@link databases.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 extends CreateAnalyzerOptions>(\n    options: Options\n  ): Promise<\n    Options extends CreateIdentityAnalyzerOptions\n    ? IdentityAnalyzerDescription\n    : Options extends CreateDelimiterAnalyzerOptions\n    ? DelimiterAnalyzerDescription\n    : Options extends CreateStemAnalyzerOptions\n    ? StemAnalyzerDescription\n    : Options extends CreateNormAnalyzerOptions\n    ? NormAnalyzerDescription\n    : Options extends CreateNgramAnalyzerOptions\n    ? NgramAnalyzerDescription\n    : Options extends CreateTextAnalyzerOptions\n    ? TextAnalyzerDescription\n    : Options extends CreateSegmentationAnalyzerOptions\n    ? SegmentationAnalyzerDescription\n    : Options extends CreateAqlAnalyzerOptions\n    ? AqlAnalyzerDescription\n    : Options extends CreatePipelineAnalyzerOptions\n    ? PipelineAnalyzerDescription\n    : Options extends CreateStopwordsAnalyzerOptions\n    ? StopwordsAnalyzerDescription\n    : Options extends CreateCollationAnalyzerOptions\n    ? CollationAnalyzerDescription\n    : Options extends CreateMinHashAnalyzerOptions\n    ? MinHashAnalyzerDescription\n    : Options extends CreateClassificationAnalyzerOptions\n    ? ClassificationAnalyzerDescription\n    : Options extends CreateNearestNeighborsAnalyzerOptions\n    ? NearestNeighborsAnalyzerDescription\n    : Options extends CreateGeoJsonAnalyzerOptions\n    ? GeoJsonAnalyzerDescription\n    : Options extends CreateGeoPointAnalyzerOptions\n    ? GeoPointAnalyzerDescription\n    : Options extends CreateGeoS2AnalyzerOptions\n    ? GeoS2AnalyzerDescription\n    : AnalyzerDescription\n  > {\n    return this._db.request({\n      method: \"POST\",\n      pathname: \"/_api/analyzer\",\n      body: { name: this._name, ...options },\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(force: boolean = false): Promise<connection.ArangoApiResponse<{ name: string }>> {\n    return this._db.request({\n      method: \"DELETE\",\n      pathname: `/_api/analyzer/${encodeURIComponent(this._name)}`,\n      search: { force },\n    });\n  }\n}\n//#endregion"]}

package/cjs/collections.d.ts

@@ -302,7 +302,7 @@ export type CollectionChecksumOptions = {
 /**
  * Options for truncating collections.
  */
-export type CollectionTruncateOptions = {
+export type TruncateCollectionOptions = {
     /**
      * Whether the collection should be compacted after truncation.
      */
@@ -316,7 +316,7 @@ export type CollectionTruncateOptions = {
 /**
  * Options for dropping collections.
  */
-export type CollectionDropOptions = {
+export type DropCollectionOptions = {
     /**
      * Whether the collection is a system collection. If the collection is a
      * system collection, this option must be set to `true` or ArangoDB will
@@ -748,7 +748,7 @@ export interface DocumentCollection<EntryResultType extends Record<string, any>
      * // the collection "some-collection" is now empty
      * ```
      */
-    truncate(options?: CollectionTruncateOptions): Promise<connection.ArangoApiResponse<CollectionDescription>>;
+    truncate(options?: TruncateCollectionOptions): Promise<connection.ArangoApiResponse<CollectionDescription>>;
     /**
      * Deletes the collection from the database.
      *
@@ -762,7 +762,7 @@ export interface DocumentCollection<EntryResultType extends Record<string, any>
      * // The collection "some-collection" is now an ex-collection
      * ```
      */
-    drop(options?: CollectionDropOptions): Promise<connection.ArangoApiResponse<{
+    drop(options?: DropCollectionOptions): Promise<connection.ArangoApiResponse<{
         id: string;
     }>>;
     /**
@@ -2042,8 +2042,8 @@ export declare class Collection<EntryResultType extends Record<string, any> = an
         checksum: string;
     }>>;
     rename(newName: string): Promise<connection.ArangoApiResponse<CollectionDescription>>;
-    truncate(options?: CollectionTruncateOptions): Promise<connection.ArangoApiResponse<CollectionDescription>>;
-    drop(options?: CollectionDropOptions): Promise<any>;
+    truncate(options?: TruncateCollectionOptions): Promise<connection.ArangoApiResponse<CollectionDescription>>;
+    drop(options?: DropCollectionOptions): Promise<any>;
     compact(): Promise<any>;
     getResponsibleShard(document: Partial<documents.Document<EntryResultType>>): Promise<string>;
     documentId(selector: documents.DocumentSelector): string;