arangojs 9.0.0-preview.1 → 9.0.0-preview.3

package/CHANGELOG.md

@@ -14,6 +14,38 @@ 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.
 
+## [9.0.0-preview.3]
+
+### Removed
+
+- Removed `Collection` methods for simple queries: `list`, `all`, `any`,
+  `byExample`, `firstExample`, `removeByExample`, `replaceByExample`,
+  `updateByExample`, `lookupByKeys`, `removeByKeys`, `fulltext`
+
+  Simple queries were deprecated in ArangoDB 3.4 and can be replicated with AQL.
+
+### Added
+
+- Added support for `withStats` option in `collection.indexes`
+
+  This method now takes an object with `withStats` and `withHidden` options
+  instead of a boolean flag.
+
+## [9.0.0-preview.2]
+
+### Changed
+
+- Inlined `x3-linkedlist` dependency
+
+  Inlining this dependency should help make arangojs more portable.
+
+### Added
+
+- Added support for `withHidden` option in `collection.indexes`
+
+  This option was introduced in ArangoDB 3.10.13 and 3.11.7 and allows
+  fetching the progress information of indexes that are in the building phase.
+
 ## [9.0.0-preview.1]
 
 This is a major release and breaks backwards compatibility.
@@ -1864,6 +1896,8 @@ 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.
 
+[9.0.0-preview.3]: https://github.com/arangodb/arangojs/compare/v9.0.0-preview.2...v9.0.0-preview.3
+[9.0.0-preview.2]: https://github.com/arangodb/arangojs/compare/v9.0.0-preview.1...v9.0.0-preview.2
 [9.0.0-preview.1]: https://github.com/arangodb/arangojs/compare/v8.8.1...v9.0.0-preview.1
 [8.8.1]: https://github.com/arangodb/arangojs/compare/v8.8.0...v8.8.1
 [8.8.0]: https://github.com/arangodb/arangojs/compare/v8.7.0...v8.8.0

package/MIGRATING.md

@@ -21,6 +21,13 @@ Note that ArangoDB may reject non-normalized unicode names and identifiers.
 This change is intended to make it easier to recognize normalization issues in
 code interacting with ArangoDB that were previously masked by arangojs.
 
+### Simple queries
+
+Simple queries like the `removeByExample` and `firstExample` methods have been
+removed from the collections API. These methods were deprecated in ArangoDB 3.4
+and can be replaced with AQL queries. For examples for replicating each
+method's behavior in AQL, see the documentation for these methods in ArangoJS 8.
+
 ### Request and Response changes
 
 Version 9 now uses native `fetch` in all environments. This means that the

package/README.md

@@ -9,7 +9,7 @@ The official ArangoDB JavaScript client for Node.js and the browser.
 
 ## Links
 
-- [API Documentation](https://arangodb.github.io/arangojs/latest/modules/_index_.html)
+- [API Documentation](https://arangodb.github.io/arangojs/latest/modules/index.html)
 
 - [Changelog](https://arangodb.github.io/arangojs/CHANGELOG)
 
@@ -30,38 +30,29 @@ yarn add arangojs
 When using modern JavaScript tooling with a bundler and compiler (e.g. Babel),
 arangojs can be installed using `npm` or `yarn` like any other dependency.
 
-For use without a compiler, the npm release comes with a precompiled browser
-build for evergreen browsers:
-
-```js
-var arangojs = require("arangojs/web");
-```
-
-You can also use [unpkg](https://unpkg.com) during development:
+You can also use [jsDelivr CDN](https://www.jsdelivr.com) during development:
 
 ```html
-< !-- note the path includes the version number (e.g. 8.0.0) -- >
-<script src="https://unpkg.com/arangojs@8.0.0/web.js"></script>
-<script>
-  var db = new arangojs.Database();
+<script type="importmap">
+  {
+    "imports": {
+      "arangojs": "https://cdn.jsdelivr.net/npm/arangojs@9.0.0-preview.1/esm/index.js?+esm"
+    }
+  }
+</script>
+<script type="module">
+  import { Database } from "arangojs";
+  const db = new Database();
   // ...
 </script>
 ```
 
-When loading the browser build with a script tag make sure to load the polyfill first:
-
-```html
-<script src="https://cdnjs.cloudflare.com/ajax/libs/babel-polyfill/6.26.0/polyfill.js"></script>
-<script src="https://unpkg.com/arangojs@8.0.0/web.js"></script>
-```
-
 ## Basic usage example
 
-Modern JavaScript/TypeScript with async/await:
+Modern JavaScript/TypeScript with async/await and ES Modules:
 
 ```js
-// TS: import { Database, aql } from "arangojs";
-const { Database, aql } = require("arangojs");
+import { Database, aql } from "arangojs";
 
 const db = new Database();
 const Pokemons = db.collection("my-pokemons");
@@ -73,7 +64,7 @@ async function main() {
       FILTER pokemon.type == "fire"
       RETURN pokemon
     `);
-    console.log("My pokemons, let me show you them:");
+    console.log("My pokemans, let me show you them:");
     for await (const pokemon of pokemons) {
       console.log(pokemon.name);
     }
@@ -98,7 +89,7 @@ const db = new Database({
 db.useBasicAuth("admin", "maplesyrup");
 ```
 
-Old-school JavaScript with promises:
+Old-school JavaScript with promises and CommonJS:
 
 ```js
 var arangojs = require("arangojs");
@@ -291,7 +282,7 @@ internally, you can override the global agent by adding `undici` as a
 dependency to your project and using its `setGlobalDispatcher` as follows:
 
 ```js
-const { Agent, setGlobalDispatcher } = require("undici");
+import { Agent, setGlobalDispatcher } from "undici";
 
 setGlobalDispatcher(
   new Agent({
@@ -308,7 +299,7 @@ HTTPS certificate validation entirely, but note this has
 **extremely dangerous** security implications:
 
 ```js
-const { Agent, setGlobalDispatcher } = require("undici");
+import { Agent, setGlobalDispatcher } from "undici";
 
 setGlobalDispatcher(
   new Agent({
@@ -364,3 +355,6 @@ to support larger numbers of concurrent transactions on the server side.
 
 The Apache License, Version 2.0. For more information, see the accompanying
 LICENSE file.
+
+Includes code from [x3-linkedlist](https://github.com/x3cion/x3-linkedlist)
+used under the MIT license.