@paralect/hive 0.1.49 → 0.1.50-alpha.2

package/.hive/src/lib/node-mongo/CHANGELOG.md

@@ -0,0 +1,98 @@
+## v2.1.0 (2020-10-15)
+
+### Features
+
+#### Manager
+
+[createService](API.md#createservice)
+
+- Add [emitter](API.md#createservice) option.
+
+## v2.0.0 (2020-09-29)
+
+- Update dependencies.
+
+### Breaking Changes
+
+#### [Manager](API.md#manager)
+
+[createQueryService](API.md#createqueryservice)
+
+- Rename `validateSchema` option to `validate`.
+- Change `addCreatedOnField` default to `true`.
+- Change `addUpdatedOnField` default to `true`.
+
+[createService](API.md#createservice)
+
+- Rename `validateSchema` option to `validate`.
+- Change `addCreatedOnField` default to `true`.
+- Change `addUpdatedOnField` default to `true`.
+
+#### [Query Service](API.md#query-service)
+
+- Remove `generateId` method.
+- Remove `expectDocument` method.
+
+#### [Service](API.md#service)
+
+- Remove `update` method. Use [updateOne](API.md#updateone) or [updateMany](API.md#updatemany).
+- Remove `ensureIndex`. Use [atomic.createIndex](API.md#atomiccreateindex).
+- Remove `createOrUpdate`. Use [create](API.md#create) or [updateOne](API.md#updateone) or [updateMany](API.md#updatemany).
+- Remove `findOneAndUpdate`. Use [findOne](API.md#findone) and [updateOne](API.md#updateone).
+
+### Features
+
+#### Manager
+
+[createQueryService](API.md#createqueryservice)
+
+- Add `useStringId` option.
+
+[createService](API.md#createservice)
+
+- Add `useStringId` option.
+
+#### [Query Service](API.md#query-service)
+
+- Add more monk's methods. [See full list](API.md#query-service)
+
+#### [Service](API.md#service)
+
+- Add [generateId](API.md#generateid) method.
+- Add [updateOne](API.md#updateone) method.
+- Add [updateMany](API.md#updatemany) method.
+- Add [performTransaction](API.md#performtransaction) method.
+- Add more monk's methods in `atomic` namespace. [See full list](API.md#service)
+
+## v1.1.0 (2019-06-25)
+
+- Update dependencies.
+- Fix required version of the Node.js.
+
+### Breaking Changes
+
+- Now `update` function will work via [set](https://docs.mongodb.com/manual/reference/operator/update/set/) operator. It means the new doc will be the result of merge of the old doc and the provided one.
+
+## v1.0.0 (2018-05-23)
+
+- Update dependencies.
+- Add tests.
+- Fix required version of the Node.js.
+
+### Breaking Changes
+
+- Now, by default, we do not add the fields `createdOn` and` updatedOn` automatically to the model. If you want to save the current behavior, add the appropriate `addCreatedOnField` and` addUpdatedOnField` options to the service definitions.
+
+## v0.3.1 (2017-12-16)
+
+- Stop using deprecated method `ensureIndex` of the `monk`.
+
+## v0.3.0 (2017-10-24)
+
+- Add ability to create custom methods for service and query service.
+- Add tests.
+
+## v0.2.0 (2017-10-12)
+
+- Add support of the [joi](https://github.com/hapijs/joi) for validating data schema.
+- Add tests for validating of the schema.

package/.hive/src/lib/node-mongo/README.md

@@ -0,0 +1,97 @@
+# Node Mongo
+
+[![npm version](https://badge.fury.io/js/%40paralect%2Fnode-mongo.svg)](https://badge.fury.io/js/%40paralect%2Fnode-mongo)
+
+Node Mongo is reactive extension to MongoDB API. It provides few usability improvements to the [monk](https://github.com/Automattic/monk) API.
+
+## Features
+
+- ️️**Reactive**. Fires events as document stored, updated or deleted from database
+- **Paging**. Implements high level paging API
+- **Schema validation**. Validates your data before save
+
+## Installation
+
+```
+npm i @paralect/node-mongo
+```
+
+## Documentation
+
+[API Reference](API.md).
+
+## Usage
+
+### Connect to MongoDB
+
+```javascript
+const connectionString = "mongodb://localhost:27017/home-db";
+const db = require("@paralect/node-mongo").connect(connectionString);
+```
+
+### CRUD Operations
+
+```javascript
+// create a service to work with specific database collection
+const userService = db.createService("users");
+
+// create documents
+const users = await userService.create([{ name: "Alex" }, { name: "Bob" }]);
+
+// find one document
+const user = await userService.findOne({ name: "Bob" });
+
+// find many documents with pagination
+const { results, pagesCount, count } = await userService.find(
+  { name: "Bob" },
+  { page: 1, perPage: 30 }
+);
+
+// update document
+const updatedUser = await userService.updateOne({ _id: "1" }, (doc) => ({
+  ...doc,
+  name: "Alex",
+}));
+
+// remove document
+const removedUser = await userService.remove({ _id: "1" });
+```
+
+### Event handlers
+
+```js
+const userService = db.createService("users");
+
+userService.on("created", ({ doc }) => {});
+
+userService.on("updated", ({ doc, prevDoc }) => {});
+
+userService.onPropertiesUpdated(["email"], ({ doc, prevDoc }) => {});
+
+userService.on("removed", ({ doc }) => {});
+```
+
+### Schema validation
+
+```javascript
+const Joi = require("Joi");
+
+const userSchema = Joi.object({
+  _id: Joi.string(),
+  createdOn: Joi.date(),
+  name: Joi.string(),
+  status: Joi.string().valid("active", "inactive"),
+});
+
+function validate(obj) {
+  return userSchema.validate(obj);
+}
+
+const userService = db.createService("users", { validate });
+```
+
+## Change Log
+
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+Every release is documented on the Github [Releases](https://github.com/paralect/node-mongo/releases) page.