Implement search-alias view

Author: Alan Plum

CHANGELOG.md

@@ -73,6 +73,13 @@ This driver uses semantic versioning:
 
   This attribute has been replaced with `response.arangojsHostUrl`.
 
+- Removed `CollectionStatus` and `CollectionType` enum re-exports
+
+  Previously these would be re-exported by the arangojs module for backwards
+  compatibility. If you still need to access these enums, you can import them
+  from the `collection` sub-module instead. Note that the `ViewType` enum
+  has been removed completely.
+
 ### Changed
 
 - Changed default URL to `http://127.0.0.1:8529` to match ArangoDB default
@@ -164,16 +171,21 @@ This driver uses semantic versioning:
 
 - Renamed type `PrimarySortCompression` to `Compression`
 
-- Changed generic type `View` to take additional `CreateOptions` type argument
-
-- Replaced `AnalyzerInfo` type and all its constituent types
+- Replaced type `AnalyzerInfo` and all its constituent types
 
   Previously each type of Analyzer was represented by an `AnalyzerInfo` type
   and (where relevant) an `AnalyzerProperties` type, which were used for both
   creating and fetching Analyzers. The new types more closely follow the
   pattern already used for index types, providing pairs of
   `CreateAnalyzerOptions` and `AnalyzerDescription` types.
 
+- Removed enum `ViewType`, type `ArangoSearchView` and changed `View` class to
+  be non-generic
+
+  The `View` class now behaves analogous to the `Analyzer` class. The various
+  types related to different view types have been restructured to more closely
+  follow the pattern used for indexes and analyzers.
+
 ### Deprecated
 
 - Deprecated `EnsureFulltextIndexOptions` and `FulltextIndex` types

src/analyzer.ts

@@ -864,7 +864,43 @@ export class Analyzer {
    * // the identity Analyzer "potatoes" now exists
    * ```
    */
-  create(options: CreateAnalyzerOptions): Promise<AnalyzerDescription> {
+  create<Options extends CreateAnalyzerOptions>(
+    options: Options
+  ): Promise<
+    Options extends CreateIdentityAnalyzerOptions
+      ? IdentityAnalyzerDescription
+      : Options extends CreateDelimiterAnalyzerOptions
+      ? DelimiterAnalyzerDescription
+      : Options extends CreateStemAnalyzerOptions
+      ? StemAnalyzerDescription
+      : Options extends CreateNormAnalyzerOptions
+      ? NormAnalyzerDescription
+      : Options extends CreateNgramAnalyzerOptions
+      ? NgramAnalyzerDescription
+      : Options extends CreateTextAnalyzerOptions
+      ? TextAnalyzerDescription
+      : Options extends CreateSegmentationAnalyzerOptions
+      ? SegmentationAnalyzerDescription
+      : Options extends CreateAqlAnalyzerOptions
+      ? AqlAnalyzerDescription
+      : Options extends CreatePipelineAnalyzerOptions
+      ? PipelineAnalyzerDescription
+      : Options extends CreateStopwordsAnalyzerOptions
+      ? StopwordsAnalyzerDescription
+      : Options extends CreateCollationAnalyzerOptions
+      ? CollationAnalyzerDescription
+      : Options extends CreateMinHashAnalyzerOptions
+      ? MinHashAnalyzerDescription
+      : Options extends CreateClassificationAnalyzerOptions
+      ? ClassificationAnalyzerDescription
+      : Options extends CreateNearestNeighborsAnalyzerOptions
+      ? NearestNeighborsAnalyzerDescription
+      : Options extends CreateGeoJsonAnalyzerOptions
+      ? GeoJsonAnalyzerDescription
+      : Options extends CreateGeoPointAnalyzerOptions
+      ? GeoPointAnalyzerDescription
+      : AnalyzerDescription
+  > {
     return this._db.request({
       method: "POST",
       path: "/_api/analyzer",

src/database.ts

@@ -50,13 +50,7 @@ import { toForm } from "./lib/multipart";
 import { ArangojsResponse } from "./lib/request";
 import { Route } from "./route";
 import { Transaction } from "./transaction";
-import {
-  ArangoSearchView,
-  ArangoSearchViewPropertiesOptions,
-  View,
-  ViewDescription,
-  ViewType,
-} from "./view";
+import { CreateViewOptions, View, ViewDescription } from "./view";
 
 /**
  * Indicates whether the given value represents a {@link Database}.
@@ -1428,7 +1422,7 @@ export class Database {
   protected _analyzers = new Map<string, Analyzer>();
   protected _collections = new Map<string, Collection>();
   protected _graphs = new Map<string, Graph>();
-  protected _views = new Map<string, ArangoSearchView>();
+  protected _views = new Map<string, View>();
 
   /**
    * Creates a new `Database` instance with its own connection pool.
@@ -2344,17 +2338,17 @@ export class Database {
 
   //#region views
   /**
-   * Returns an {@link view.ArangoSearchView} instance for the given `viewName`.
+   * Returns a {@link view.View} instance for the given `viewName`.
    *
-   * @param viewName - Name of the ArangoSearch View.
+   * @param viewName - Name of the ArangoSearch or SearchAlias View.
    *
    * @example
    * ```js
    * const db = new Database();
    * const view = db.view("potatoes");
    * ```
    */
-  view(viewName: string): ArangoSearchView {
+  view(viewName: string): View {
     viewName = viewName.normalize("NFC");
     if (!this._views.has(viewName)) {
       this._views.set(viewName, new View(this, viewName));
@@ -2363,25 +2357,25 @@ export class Database {
   }
 
   /**
-   * Creates a new ArangoSearch View with the given `viewName` and `options`
-   * and returns an {@link view.ArangoSearchView} instance for the created View.
+   * Creates a new View with the given `viewName` and `options`, then returns a
+   * {@link view.View} instance for the new View.
    *
-   * @param viewName - Name of the ArangoSearch View.
+   * @param viewName - Name of the View.
    * @param options - An object defining the properties of the View.
    *
    * @example
    * ```js
    * const db = new Database();
-   * const view = await db.createView("potatoes");
+   * const view = await db.createView("potatoes", { type: "arangosearch" });
    * // the ArangoSearch View "potatoes" now exists
    * ```
    */
   async createView(
     viewName: string,
-    options?: ArangoSearchViewPropertiesOptions
-  ): Promise<ArangoSearchView> {
+    options: CreateViewOptions
+  ): Promise<View> {
     const view = this.view(viewName.normalize("NFC"));
-    await view.create({ ...options, type: ViewType.ARANGOSEARCH_VIEW });
+    await view.create(options);
     return view;
   }
 
@@ -2431,7 +2425,8 @@ export class Database {
 
   /**
    * Fetches all Views from the database and returns an array of
-   * {@link view.ArangoSearchView} instances for the Views.
+   * {@link view.View} instances
+   * for the Views.
    *
    * See also {@link Database#listViews}.
    *
@@ -2442,7 +2437,7 @@ export class Database {
    * // views is an array of ArangoSearch View instances
    * ```
    */
-  async views(): Promise<ArangoSearchView[]> {
+  async views(): Promise<View[]> {
     const views = await this.listViews();
     return views.map((data) => this.view(data.name));
   }

src/index.ts

@@ -57,6 +57,4 @@ export function arangojs(config?: string | string[] | Config, name?: string) {
 }
 export default arangojs;
 export { aql } from "./aql";
-export { CollectionStatus, CollectionType } from "./collection";
 export { Database } from "./database";
-export { ViewType } from "./view";

src/test/24-accessing-views.ts

@@ -35,7 +35,7 @@ describe("Accessing views", function () {
       await Promise.all(
         viewNames.map(async (name) => {
           const view = db.view(name);
-          await view.create();
+          await view.create({ type: "arangosearch" });
           await db.waitForPropagation(
             { path: `/_api/view/${view.name}` },
             10000
@@ -58,7 +58,7 @@ describe("Accessing views", function () {
       await Promise.all(
         arangoSearchViewNames.map(async (name) => {
           const view = db.view(name);
-          await view.create();
+          await view.create({ type: "arangosearch" });
           await db.waitForPropagation(
             { path: `/_api/view/${view.name}` },
             10000

src/test/25-view-metadata.ts

@@ -1,21 +1,21 @@
 import { expect } from "chai";
 import { Database } from "../database";
-import { ArangoSearchView } from "../view";
+import { ArangoSearchViewProperties, View } from "../view";
 import { config } from "./_config";
 
 describe("View metadata", function () {
   const dbName = `testdb_${Date.now()}`;
   const viewName = `view-${Date.now()}`;
   let system: Database, db: Database;
-  let view: ArangoSearchView;
+  let view: View;
   before(async () => {
     system = new Database(config);
     if (Array.isArray(config.url) && config.loadBalancingStrategy !== "NONE")
       await system.acquireHostList();
     await system.createDatabase(dbName);
     db = system.database(dbName);
     view = db.view(viewName);
-    await view.create();
+    await view.create({ type: "arangosearch" });
     await db.waitForPropagation({ path: `/_api/view/${view.name}` }, 10000);
   });
   after(async () => {
@@ -40,7 +40,8 @@ describe("View metadata", function () {
   });
   describe("view.properties", () => {
     it("should return properties of a view", async () => {
-      const properties = await view.properties();
+      const properties =
+        (await view.properties()) as ArangoSearchViewProperties;
       expect(properties).to.have.property("name", viewName);
       expect(properties).to.have.property("id");
       expect(properties).to.have.property("type", "arangosearch");

src/test/26-manipulating-views.ts

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 import { Database } from "../database";
-import { ArangoSearchView } from "../view";
+import { ArangoSearchViewProperties, View } from "../view";
 import { config } from "./_config";
 
 // NOTE These tests will not reliably work in a cluster.
@@ -10,7 +10,7 @@ const describeNLB =
 describe("Manipulating views", function () {
   const name = `testdb_${Date.now()}`;
   let system: Database, db: Database;
-  let view: ArangoSearchView;
+  let view: View;
   before(async () => {
     system = new Database(config);
     if (Array.isArray(config.url) && config.loadBalancingStrategy !== "NONE")
@@ -26,7 +26,7 @@ describe("Manipulating views", function () {
   });
   beforeEach(async () => {
     view = db.view(`v-${Date.now()}`);
-    await view.create();
+    await view.create({ type: "arangosearch" });
     await db.waitForPropagation({ path: `/_api/view/${view.name}` }, 10000);
   });
   afterEach(async () => {
@@ -40,7 +40,7 @@ describe("Manipulating views", function () {
   describe("view.create", () => {
     it("creates a new arangosearch view", async () => {
       const view = db.view(`asv-${Date.now()}`);
-      await view.create();
+      await view.create({ type: "arangosearch" });
       await db.waitForPropagation({ path: `/_api/view/${view.name}` }, 10000);
       const info = await view.get();
       expect(info).to.have.property("name", view.name);
@@ -49,7 +49,7 @@ describe("Manipulating views", function () {
   });
   describe("view.updateProperties", () => {
     it("should not overwrite properties", async () => {
-      const initial = await view.properties();
+      const initial = (await view.properties()) as ArangoSearchViewProperties;
       expect(initial.consolidationIntervalMsec).not.to.equal(45000);
       const oldProps = await view.updateProperties({
         consolidationIntervalMsec: 45000,
@@ -65,7 +65,7 @@ describe("Manipulating views", function () {
   });
   describe("view.replaceProperties", () => {
     it("should overwrite properties", async () => {
-      const initial = await view.properties();
+      const initial = (await view.properties()) as ArangoSearchViewProperties;
       expect(initial.consolidationIntervalMsec).not.to.equal(45000);
       const oldProps = await view.replaceProperties({
         consolidationIntervalMsec: 45000,