dataflux 1.2.4 → 1.4.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Massimo Candela
+Copyright (c) 2022-present Massimo Candela
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -30,23 +30,34 @@ Create your global store by creating a file (e.g., named `store.js`) containing
 Consider the following hypothetical store/model declaration common to all the examples below:
 
 ```js
+// Content of your store.js
 import {Store, Model} from "dataflux";
 
+// We create a new Store
 const store = new Store();
-const author = new Model("author", `https://rest.example.net/api/v1/authors`);
-const book = new Model("book", `https://rest.example.net/api/v1/books`);
 
-store.addModel(author);
+// We now create two models, "author" and "book". 
+// Both of them are auto generated based on the output of a REST API.
+// The REST API does NOT need to provide a specific format.
+// E.g., /books returns [{"title": "Hamlet", "year": 1600}, ...].
+// See "REST API format" below for more info.
+const book = new Model("book", `https://api.example.net/books`);
+const author = new Model("author", `https://api.example.net/authors`);
+
+// We add the models to the store
 store.addModel(book);
+store.addModel(author);
 
-// An object relation between author.id and book.authorId as follows
+// Optionally, we can declare relations among models.
+// E.g., we can declare that an author has one or more books.
 author.addRelation(book, "id", "authorId");
+// The relation will provide all the books where author.id = book.authorId
 
 export default store;
 ```
 
 
-The store can be initialized with [various options](#configuration). You need only one store for the entire application, that's why you should declare it in its own file and import it in multiple places.
+The store can be initialized with [various options](#configuration). You need only one store for the entire application, that's why you should declare it in its own file (store.js in this case) and import it in multiple places.
 
 The creation of a model requires at least a name and a url. GET, POST, PUT, and DELETE operations are going to be performed against the same url. [Models can be created with considerably more advanced options.](#models-creation)
 
@@ -55,28 +66,31 @@ A JS object is automatically created for each item returned by the API, for each
 
 ### Example 1
 
-Retrieve and edit an author not knowing the ID:
+Retrieve and edit an author by name and surname:
 
 ```js
-import store from "./store";
+import store from "./store"; // Import our store.js
 
 // Find the author Dante Alighieri
 store.find("author", ({name, surname}) => name == "Dante" && surname == "Alighieri")
         .then(([author]) => {
+
+          // We got the author, let's now edit it
           author.set("country", "Italy");
           author.set("type", "poet");
-          // Nothing else to do, the store does a single PUT request to the model's API about the edited object
         });
 ```
 
-> You don't necessarily need to use `object.set` to edit an object attribute. You could do `author.country = "Italy"`. However, this approach relies on a periodic detection of changes (while `.set` triggers an update immediately). Check the `autoSave` option for more information
+Nothing else to do! After your edit, the store will do a single PUT request to the model's API to save the edited object. This behavior can be disabled, see next example.
+
+> You don't necessarily need to use `object.set` to edit an object attribute. You could do `author.country = "Italy"`. However, this approach has disadvantages, read [editing objects](#editing-objects) for more information
 
 ### Example 2
 
-Operations without autoSave:
+DataFlux automatically sends the edited objects back to the API to be saved. However, you can disable this behavior and manually instruct the store when to save. 
 
 ```js
-// To disable autoSave you must declare the store as follows
+// To disable autoSave you must declare the store (in store.js) as follows
 const store = new Store({autoSave: false});
 ```
 
@@ -86,11 +100,13 @@ The same example above now becomes:
 // Find the author Dante Alighieri
 store.find("author", ({name, surname}) => name == "Dante" && surname == "Alighieri")
         .then(([author]) => {
-          // When autoSave = false, you can still use author.set, but there is no actual benefit
+            
+          // When autoSave is false, author.set("country", "Italy") and 
+          // author.country = "Italy" are equivalent
           author.country = "Italy"
           author.type = "poet"
 
-          store.save(); // Even if we changed only one author, prefer always store.save() to author.save()
+          store.save(); // Instruct the store to save
         });
 ```
 
@@ -129,6 +145,7 @@ author.getRelation("book");
 
 If you use `subscribe` instead of `find`, you can provide a callback to be invoked when data is ready or there is a change in the data.
 
+_**DataFlux remembers your query and calls your callback every time any change is affecting the result of your query!**_
 
 ```js
 const drawBooksCallback = (books) => {
@@ -139,7 +156,7 @@ const drawBooksCallback = (books) => {
 store.subscribe("book", drawBooks, ({price}) => price < 20);
 ```
 
-If now somewhere a book is inserted/deleted/edited:
+If now a book is inserted/deleted/edited:
 * if the book has `price < 20`,  `drawBooksCallback` will be called again with the new dataset;
 * if the book has `price > 20`,  `drawBooksCallback` will NOT be called again (because the new book doesn't impact our selection).
 
@@ -151,14 +168,31 @@ const subKey = store.subscribe("book", drawBooks, ({price}) => price < 20); // S
 store.unsubscribe(subKey); // Unsubscribe
 ```
 
+You can also do multiple subscriptions at once:
+
+```js
+const subscriptions = [
+    ["book", ({title}) => title === "The little prince"], // Model name and filter function
+    ["author"], // No filter function, all objects returned
+];
+
+const callback = ([books, authors]) => {
+    // Objects are ready
+};
+
+const subKey = store.multipleSubscribe(requests, callback); // Subscribe
+
+store.unsubscribe(subKey); // Unsubscribe
+```
+
 ### Example 6 - Observability + React
 
 The integration with React is offered transparently when using the store inside a `React.Component`.
-You can use two methods: `findOne`, and `findAll`.
+You can use two methods: `findOne`, and `findAll` (which are a react-specific syntactic sugar over `subscribe`).
 
-> Since the store is able to detect changes deep in a nested structure, you will not have to worry about the component not re-rendering. Also, the setState will only be triggered when the next change of the dataset is really impacting your selection.
+**_Since the store is able to detect changes deep in a nested structure, you will not have to worry about the component not re-rendering. Also, the setState will be triggered ONLY when the next change of the dataset is impacting your selection._**
 
-React Component example
+React Component example:
 ```jsx
 class MyComponent extends React.Component {
   constructor(props) {
@@ -168,9 +202,9 @@ class MyComponent extends React.Component {
   componentDidMount() {
     // Get all books with a price < 20
     store.findAll("book", "books", this, ({price}) => price < 20);
-    // Every time the dataset changes, a setState will be automatically 
-    // performed. An attribute "books" will be added/updated in the 
-    // state (the rest of the state remains unchanged).
+    // An attribute "books" will be added/updated in the 
+    // state (the rest of the state remains unchanged) every time
+    // a book in our selection is inserted/deleted/edited.
 
     // findAll is a syntactic sugar for:
     // const callback = (books) => {this.setState({...this.state, books})};
@@ -185,7 +219,7 @@ class MyComponent extends React.Component {
                     onTitleChange={(title) => book.set("title", title)}
                     // onTitleChange will alter the book and so the current 
                     // state of "books" (a setState will be performed).
-                    //
+                    
                     // Alternatively:
                     // onTitleChange={store.handleChange(book, "title")} 
                     // is a syntactic sugar of the function above
@@ -194,9 +228,9 @@ class MyComponent extends React.Component {
 }
 ```
 
-The method `findAll` returns always an array. The method `findOne` returns a single object (if multiple objects satisfy the search, the first is returned).
+The method `findAll` returns always an array. The method `findOne` returns a single object (if multiple objects satisfy the query, the first is returned).
 
-When the component will unmount, the `findAll` subscription will be automatically terminated without the need to unsubscribe. Be aware, `store.findAll` injects the unsubscribe call inside `componentWillUnmount`. If your component already implements `componentWillUnmount()`, then you will have to use `store.subscribe` and `store.unsubscribe` instead of `store.findAll`, to avoid side effects when the component is unmounted.
+When the component will unmount, the `findAll` subscription will be automatically terminated without the need to unsubscribe. Be aware, `store.findAll()` injects the unsubscribe call inside `componentWillUnmount()`. If your component already implements `componentWillUnmount()`, then you will have to use `store.subscribe()` and `store.unsubscribe()` instead of `store.findAll()`, to avoid side effects when the component is unmounted.
 
 ## Configuration
 
@@ -216,7 +250,7 @@ The store can be configured with the following options:
 A model can be simply created with:
 
 ```js
-const book = new Model("book", `https://rest.example.net/api/v1/books`);
+const book = new Model("book", `https://api.example.net/books`);
 ```
 
 However, sometimes you may want to define a more complex interaction with the API. In such cases you can pass options to perform more elaborated model's initializations.
@@ -227,17 +261,18 @@ const book = new Model("book", options);
 
 All the possible options for a model creation are (they are all optional):
 
-| Name     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Default              |
-|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|
-| retrieve | Describes the operation to retrieve the collection of objects from the REST API. It can be an operation object or a function. See [operations](#operations).                                                                                                                                                                                                                                                                                                                                                                                                                  | `{method: "get"}`    |
-| insert   | Describes the operation to insert a new object in the collection. It can be an operation object or a function. See [operations](#operations).                                                                                                                                                                                                                                                                                                                                                                                                                                 | `{method: "post"}`   |
-| update   | Describes the operation to update objects of the collection. It can be an operation object or a function. See [operations](#operations).                                                                                                                                                                                                                                                                                                                                                                                                                                      | `{method: "put"}`    |
-| delete   | Describes the operation to remove objects from the collection. It can be an operation object or a function. See [operations](#operations).                                                                                                                                                                                                                                                                                                                                                                                                                                    | `{method: "delete"}` |
-| fields   | An array of strings defining which attributes the retrieved objects should have. Essentially, it allows you to contemporarily specify the [X-Fields header](https://flask-restplus.readthedocs.io/en/stable/mask.html) and the [fields GET parameter](https://developers.google.com/slides/api/guides/performance#partial). This reduces transfer size and memory usage. E.g., if you have a collection of books, of which you are interested only in the name, you can define `fields: ["name"]`. In combination with `load` it allows for partial lazy load of the objects. | All the fields       |
-| headers  | A dictionary of headers for the HTTP request. E.g., `{"Authorization": "bearer XXXX"}`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | No headers           |
-| load     | A function that allows to enrich the objects on demand. E.g., you can use `fields` to download only the titles of a collection of books, and `load` to load completely the object. See [object enrichment](#object-enrichment).                                                                                                                                                                                                                                                                                                                                               |
-| axios    | It allows to specify an axios instance to be used for the queries. If not specified, a new one will be used.                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | A new axios instance |
-
+| Name         | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Default              |
+|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|
+| retrieve     | Describes the operation to retrieve the collection of objects from the REST API. It can be an operation object or a function. See [operations](#operations).                                                                                                                                                                                                                                                                                                                                                                                                                  | `{method: "get"}`    |
+| insert       | Describes the operation to insert a new object in the collection. It can be an operation object or a function. See [operations](#operations).                                                                                                                                                                                                                                                                                                                                                                                                                                 | `{method: "post"}`   |
+| update       | Describes the operation to update objects of the collection. It can be an operation object or a function. See [operations](#operations).                                                                                                                                                                                                                                                                                                                                                                                                                                      | `{method: "put"}`    |
+| delete       | Describes the operation to remove objects from the collection. It can be an operation object or a function. See [operations](#operations).                                                                                                                                                                                                                                                                                                                                                                                                                                    | `{method: "delete"}` |
+| fields       | An array of strings defining which attributes the retrieved objects should have. Essentially, it allows you to contemporarily specify the [X-Fields header](https://flask-restplus.readthedocs.io/en/stable/mask.html) and the [fields GET parameter](https://developers.google.com/slides/api/guides/performance#partial). This reduces transfer size and memory usage. E.g., if you have a collection of books, of which you are interested only in the name, you can define `fields: ["name"]`. In combination with `load` it allows for partial lazy load of the objects. | All the fields       |
+| headers      | A dictionary of headers for the HTTP request. E.g., `{"Authorization": "bearer XXXX"}`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | No headers           |
+| load         | A function that allows to enrich the objects on demand. E.g., you can use `fields` to download only the titles of a collection of books, and `load` to load completely the object. See [object enrichment](#object-enrichment).                                                                                                                                                                                                                                                                                                                                               |
+| axios        | It allows to specify an axios instance to be used for the queries. If not specified, a new one will be used.                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | A new axios instance |
+| parseMoment  | Automatically creates Moment.js objects out of ISO8601 strings. E.g., if an object has a property `createdAt: "2022-01-07T21:38:50.295Z"`, this will be transformed to a moment object.                                                                                                                                                                                                                                                                                                                                                                                       |                      | 
+| hiddenFields | An array of attribute names that will never be sent back to the API. E.g., if you set `hiddenFields: ["pages"]`, a book object can contain an attribute `pages` locally, but this will be stripped out in PUT/POST requests.                                                                                                                                                                                                                                                                                                                                                  |
 
 ### Operations
 As described in the table above, there are four possible operations: **retrieve, insert, update,** and **delete**. An operation can be defined as an operation object or a function.
@@ -418,31 +453,46 @@ author1.getRelation("book", (book) => book.price < 20)
 
 The store has the following method.
 
-| Method                       | Description                                                                                                                                                |
-|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| addModel(model)              | Introduce a new model to the store. If lazyLoad = false (default), the model is populated with the objects coming from the API.                            |
-| get(type, id)                | It allows to retrieve an object based on its type and store's ID (see `getId()` in [objects methods](#objects-methods). The type is the name of the model. |
-| find(type,filterFunction)    | The promise-oriented method to access objects given a type and a filter function. See [example 1](#example-1).                                             |
-| delete(objects)              | It deletes an array of objects. See [example 1](#example-3).                                                                                               |
-| delete(type, filterFunction) | It deleted objects given an array and a filter function. See [example 1](#example-3).                                                                      |
-| insert(type, object)         | It creates a new object of a given type and inserts it in the store.                                                                                       |
+| Method                                                 | Description                                                                                                                                                                                                                                                                                                                                                                                                        |
+|--------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| on(event, callback)                                    | Method to subscribe to the events emitted by the store. See [events](#store-events) below.                                                                                                                                                                                                                                                                                                                         |
+| addModel(model)                                        | Introduce a new model to the store. If lazyLoad = false (default), the model is populated with the objects coming from the API.                                                                                                                                                                                                                                                                                    |
+| get(type, id)                                          | It allows to retrieve an object based on its type and store's ID (see `getId()` in [objects methods](#objects-methods). The type is the name of the model.                                                                                                                                                                                                                                                         |
+| find(type, filterFunction)                             | The promise-oriented method to access objects given a type and a filter function. If the filter function is missing, all the objects are returned. See [example 1](#example-1).                                                                                                                                                                                                                                    |
+| delete(objects)                                        | It deletes an array of objects. See [example 1](#example-3).                                                                                                                                                                                                                                                                                                                                                       |
+| delete(type, filterFunction)                           | It deleted objects given an array and a filter function. See [example 1](#example-3).                                                                                                                                                                                                                                                                                                                              |
+| insert(type, object)                                   | It creates a new object of a given type and inserts it in the store.                                                                                                                                                                                                                                                                                                                                               |
+| subscribe(type, callback, filterFunction)              | The callback-oriented method to access objects given a type and a filter function. It returns the key of the subscription, needed to unsubscribe. If the filter function is missing, all the objects are returned. **DataFlux remembers your query and calls the callback every time any change is affecting the result of your query.** See [example 5](#example-5---observability).                              |
+| multipleSubscribe(subscriptions, callback)             | A method to subscribe to multiple models. The first parameter is an array of models' names and filterFunctions, the second parameter is the callback to be called when the cumulative dataset is ready. E.g., `multipleSubscribe([["book", filterFunction1], ["author", filterFunction2]], callback)`. It returns the key of the subscription. See [example 5](#example-5---observability).                        |
+| unsubscribe(key)                                       | Method to terminate a subscription given a subscription key. See [example 5](#example-5---observability).                                                                                                                                                                                                                                                                                                          |
+| findOne(type, stateAttribute, context, filterFunction) | This method automatically injects and updates the React state with the requested data. If multiple objects satisfy the query, only the first is selected. The `stateAttribute` is the name of the attribute that will be added/updated in the state, the `context` is the React.Component. It automatically unsubscribe when the React.Component will unmount. See [example 6](#example-6---observability--react). |
+| findAll(type, stateAttribute, context, filterFunction) | This method automatically injects and updates the React state with the requested data. The `stateAttribute` is the name of the attribute that will be added/updated in the state, the `context` is the React.Component. It automatically unsubscribe when the React.Component will unmount. If the filter function is missing, all the objects are returned. See [example 6](#example-6---observability--react).   |
+
+## Store events
+The store emits the following events:
+
+| Name    | Description                                                                                                                           |
+|---------|---------------------------------------------------------------------------------------------------------------------------------------|
+| error   | To listen the errors emitted by the store.                                                                                            |
+| save    | Possible emitted values are `start` and `end`. They are emitted when the store starts/finishes to persist the data (API interaction). |
+| loading | The event is emitted while a new model is loaded. The value contains something like `{status: "start", model: "book"}`                |
 
 ## Objects methods
 Each object created is enriched with the following methods.
 
 
-| Method                             | Description                                                                                                                                                                                                                                      |
-|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| getId()                            | It returns a unique ID used by the store to identify the object. The ID is unique inside a single model. Be aware, `object.id` and `objet.getId()` may return different values, since store's IDs can be different from the one of the REST API. |
-| set(attribute, value)              | A method to set an attribute to the object. It provides some advantages compared to doing `object.attribute = value`, these are discussed in [below](#editing-objects).                                                                          |
-| save()                             | Method to save the object. You can do `store.save()` instead.                                                                                                                                                                                    |
-| destroy()                          | Method to delete the object. You can do `store.delete()` instead.                                                                                                                                                                                |
-| get(attribute)                     | If you like symmetry and since you do `.set()` you would like to do also `.get()` of the attributes. It does not provide any advantage compared to accessing directly the attribute (e.g., `author.name`).                                       |
-| getRelation(model, filterFunction) | To get all the objects respecting a specific relation with this object (see [model relations](#model-relations)).                                                                                                                                |
-| toJSON()                           | It returns a pure JSON representation of the object.                                                                                                                                                                                             |
-| toString()                         | It returns a string representation of the object.                                                                                                                                                                                                |
-| getFingerprint()                   | It returns a hash of the object. The hash changes at every change of the object or of any nested object. Useful to detect object changes.                                                                                                        |
-| getModel()                         | It returns the model of this object. Mostly useful to do `object.getModel().getType()` and obtain a string defining the type of the object.                                                                                                      |
+| Method                             | Description                                                                                                                                                                                                                                                                                                                                           |
+|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| getId()                            | It returns a unique ID used by the store to identify the object. The ID is unique inside a single model. Be aware, `object.id` and `objet.getId()` may return different values, since store's IDs can be different from the one of the REST API.                                                                                                      |
+| set(attribute, value, hidden)      | A method to set an attribute to the object. It provides some advantages compared to doing `object.attribute = value`, these are discussed in [below](#editing-objects).                                                                                                                                                                               |
+| save()                             | Method to save the object. You can do `store.save()` instead.                                                                                                                                                                                                                                                                                         |
+| destroy()                          | Method to delete the object. You can do `store.delete()` instead.                                                                                                                                                                                                                                                                                     |
+| get(attribute, defaultValue)       | Method to retrieve the value of an attribute. It does not provide any advantage compared to accessing directly the attribute (e.g., `author.name`); except for hidden fields, which can be retrieved only with the `.get` method. Additionally, you can provide a default value as a second parameter in case the object doesn't have that attribute. |
+| getRelation(model, filterFunction) | To get all the objects respecting a specific relation with this object (see [model relations](#model-relations)).                                                                                                                                                                                                                                     |
+| toJSON()                           | It returns a pure JSON representation of the object.                                                                                                                                                                                                                                                                                                  |
+| toString()                         | It returns a string representation of the object.                                                                                                                                                                                                                                                                                                     |
+| getFingerprint()                   | It returns a hash of the object. The hash changes at every change of the object or of any nested object. Useful to detect object changes.                                                                                                                                                                                                             |
+| getModel()                         | It returns the model of this object. Mostly useful to do `object.getModel().getType()` and obtain a string defining the type of the object.                                                                                                                                                                                                           |
 
 ## Editing objects
 The option `autoSave` can be `true`, `false`, or a number (milliseconds).
@@ -468,7 +518,7 @@ The option `autoSave` can be `true`, `false`, or a number (milliseconds).
 
   The store will perform as if the `autoSave` was set to `true`; hence, changes performed with `.set(attribute, value)` are synced. However, it will periodically attempt also a `store.save()`. Since `store.save()` is always able to recognize edited objects, also changes directly operated on an attribute of the object (`object.name = "Dante"`) are synced.
 
-
+> The method set takes 3 parameters in input, "attribute, value, hidden". The "hidden" parameter allows you to set an attribute to the object that will not trigger autoSave. However, hidden attributes cannot be persisted (they act like "hiddenFields" specified during model creation).
 
 ## API interaction
 DataFlux is able to identify three sets of objects: inserted, updated, deleted.

package/dist/Model.js

@@ -19,14 +19,16 @@ function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArra
 
 function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
 
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
-
 function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
 
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e2) { throw _e2; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e3) { didErr = true; err = _e3; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
 function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
 
 function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
@@ -87,12 +89,16 @@ var _axios = /*#__PURE__*/new WeakMap();
 
 var _loadFunction = /*#__PURE__*/new WeakMap();
 
+var _hiddenFields = /*#__PURE__*/new WeakMap();
+
 var _error = /*#__PURE__*/new WeakSet();
 
 var _addRelationByField = /*#__PURE__*/new WeakMap();
 
 var _addRelationByFilter = /*#__PURE__*/new WeakMap();
 
+var _removeHiddenFields = /*#__PURE__*/new WeakMap();
+
 var _bulkOperation = /*#__PURE__*/new WeakMap();
 
 var _toArray = /*#__PURE__*/new WeakMap();
@@ -167,6 +173,11 @@ var Model = /*#__PURE__*/_createClass(function Model(name) {
     value: void 0
   });
 
+  _classPrivateFieldInitSpec(this, _hiddenFields, {
+    writable: true,
+    value: void 0
+  });
+
   _defineProperty(this, "getStore", function () {
     return _classPrivateFieldGet(_this, _store);
   });
@@ -293,16 +304,37 @@ var Model = /*#__PURE__*/_createClass(function Model(name) {
     }
   });
 
+  _classPrivateFieldInitSpec(this, _removeHiddenFields, {
+    writable: true,
+    value: function value(json) {
+      var _iterator = _createForOfIteratorHelper(_classPrivateFieldGet(_this, _hiddenFields)),
+          _step;
+
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var attribute = _step.value;
+          delete json[attribute];
+        }
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+
+      return json;
+    }
+  });
+
   _classPrivateFieldInitSpec(this, _bulkOperation, {
     writable: true,
     value: function value(objects, action) {
       if (_classPrivateFieldGet(_this, _singleItemQuery)) {
         return (0, _batchPromises["default"])(_classPrivateFieldGet(_this, _batchSize), objects.map(function (i) {
-          return i.toJSON();
+          return _classPrivateFieldGet(_this, _removeHiddenFields).call(_this, i.toJSON());
         }), action);
       } else {
         return action(objects.map(function (i) {
-          return i.toJSON();
+          return _classPrivateFieldGet(_this, _removeHiddenFields).call(_this, i.toJSON());
         }));
       }
     }
@@ -342,12 +374,18 @@ var Model = /*#__PURE__*/_createClass(function Model(name) {
 
   _classPrivateFieldSet(this, _type, name);
 
+  this.options = {
+    parseMoment: options.parseMoment
+  };
+
   _classPrivateFieldSet(this, _store, null);
 
   _classPrivateFieldSet(this, _includes, {});
 
   _classPrivateFieldSet(this, _axios, options.axios || _axios2["default"]);
 
+  _classPrivateFieldSet(this, _hiddenFields, options.hiddenFields || []);
+
   _classPrivateFieldSet(this, _loadFunction, options.load || null);
 
   if (!name || !options) {

package/dist/Obj.js

@@ -9,6 +9,8 @@ var _fingerprint = _interopRequireDefault(require("./fingerprint"));
 
 var _uuid = require("uuid");
 
+var _moment = _interopRequireDefault(require("moment/moment"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 
 function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
@@ -33,8 +35,12 @@ function _classExtractFieldDescriptor(receiver, privateMap, action) { if (!priva
 
 function _classApplyDescriptorGet(receiver, descriptor) { if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }
 
+var dateRegex = new RegExp("^[0-9][0-9][0-9][0-9]-[0-9].*T[0-9].*Z$");
+
 var _loaded = /*#__PURE__*/new WeakMap();
 
+var _setHidden = /*#__PURE__*/new WeakMap();
+
 var Obj = /*#__PURE__*/_createClass(function Obj(values, _model) {
   var _this = this;
 
@@ -45,6 +51,11 @@ var Obj = /*#__PURE__*/_createClass(function Obj(values, _model) {
     value: false
   });
 
+  _classPrivateFieldInitSpec(this, _setHidden, {
+    writable: true,
+    value: {}
+  });
+
   _defineProperty(this, "load", function () {
     if (_classPrivateFieldGet(_this, _loaded)) {
       return Promise.resolve(_this);
@@ -65,20 +76,27 @@ var Obj = /*#__PURE__*/_createClass(function Obj(values, _model) {
     return (0, _fingerprint["default"])(_this.toJSON());
   });
 
-  _defineProperty(this, "get", function (attribute) {
-    return _this[attribute];
+  _defineProperty(this, "get", function (attribute, defaultValue) {
+    var _ref, _classPrivateFieldGet2;
+
+    return (_ref = (_classPrivateFieldGet2 = _classPrivateFieldGet(_this, _setHidden)[attribute]) !== null && _classPrivateFieldGet2 !== void 0 ? _classPrivateFieldGet2 : _this[attribute]) !== null && _ref !== void 0 ? _ref : defaultValue;
   });
 
   _defineProperty(this, "getRelation", function (type, filterFunction) {
     return _this.getModel().getRelation(_this, type, filterFunction);
   });
 
-  _defineProperty(this, "set", function (attribute, value) {
-    if (attribute === "id") {
-      throw new Error("You cannot change the ID");
+  _defineProperty(this, "set", function (attribute, value, hidden) {
+    if (hidden) {
+      _classPrivateFieldGet(_this, _setHidden)[attribute] = value;
+    } else {
+      if (attribute === "id") {
+        throw new Error("You cannot change the ID");
+      }
+
+      _this[attribute] = value;
     }
 
-    _this[attribute] = value;
     return _this.getModel().getStore().update([_this]);
   });
 
@@ -97,7 +115,11 @@ var Obj = /*#__PURE__*/_createClass(function Obj(values, _model) {
     for (var _i = 0, _attrs = attrs; _i < _attrs.length; _i++) {
       var a = _attrs[_i];
 
-      if (typeof _this[a] !== "function") {
+      if (_this[a] instanceof _moment["default"]) {
+        out[a] = _this[a].toISOString();
+      } else if (_this[a] instanceof Date) {
+        out[a] = (0, _moment["default"])(_this[a]).toISOString();
+      } else if (typeof _this[a] !== "function") {
         out[a] = _this[a];
       }
     }
@@ -113,9 +135,17 @@ var Obj = /*#__PURE__*/_createClass(function Obj(values, _model) {
     return _model;
   };
 
-  Object.keys(values).forEach(function (key) {
-    _this[key] = values[key];
-  });
+  var frEach = _model.options.parseMoment ? function (key) {
+    if (dateRegex.test(values[key])) {
+      var mmnt = (0, _moment["default"])(values[key]);
+      _this[key] = mmnt.isValid() ? mmnt : values[key];
+    } else {
+      _this[key] = values[key];
+    }
+  } : function (key) {
+    return _this[key] = values[key];
+  };
+  Object.keys(values).forEach(frEach);
   var id;
 
   if (this.id && (typeof this.id === "string" || typeof this.id === "number")) {

package/dist/ObserverStore.js

@@ -17,8 +17,16 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
 
 function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
 
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
 
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
 
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
@@ -83,6 +91,22 @@ var ObserverStore = /*#__PURE__*/function (_PersistentStore) {
 
     _classPrivateMethodInitSpec(_assertThisInitialized(_this), _propagateInsertChange);
 
+    _defineProperty(_assertThisInitialized(_this), "multipleSubscribe", function (subscriptions, callback) {
+      return Promise.all(subscriptions.map(function (sub, index) {
+        var attrs = Array.from(Array(index + 1)).map(function () {
+          return null;
+        });
+        return _this.subscribe(sub[0], sub[1], function (data) {
+          attrs[index] = data;
+          return callback.apply(void 0, _toConsumableArray(attrs));
+        });
+      })).then(function (subKeys) {
+        var subKey = (0, _uuid.v4)();
+        _this._multipleSubscribed[subKey] = subKeys;
+        return subKey;
+      });
+    });
+
     _defineProperty(_assertThisInitialized(_this), "subscribe", function (type, callback, filterFunction) {
       var subKey = (0, _uuid.v4)();
 
@@ -104,14 +128,33 @@ var ObserverStore = /*#__PURE__*/function (_PersistentStore) {
     });
 
     _defineProperty(_assertThisInitialized(_this), "unsubscribe", function (key) {
-      for (var type in _this._subscribed) {
-        for (var id in _this._subscribed[type]) {
-          _this._subscribed[type][id] = _this._subscribed[type][id].filter(function (i) {
-            return i.subKey !== key;
-          });
+      if (_this._multipleSubscribed[key]) {
+        var _iterator = _createForOfIteratorHelper(_this._multipleSubscribed[key]),
+            _step;
+
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var sub = _step.value;
 
-          if (_this._subscribed[type][id].length === 0) {
-            delete _this._subscribed[type][id];
+            _this.unsubscribe(sub);
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.f();
+        }
+
+        delete _this._multipleSubscribed[key];
+      } else {
+        for (var type in _this._subscribed) {
+          for (var id in _this._subscribed[type]) {
+            _this._subscribed[type][id] = _this._subscribed[type][id].filter(function (i) {
+              return i.subKey !== key;
+            });
+
+            if (_this._subscribed[type][id].length === 0) {
+              delete _this._subscribed[type][id];
+            }
           }
         }
       }
@@ -122,34 +165,34 @@ var ObserverStore = /*#__PURE__*/function (_PersistentStore) {
       value: function value(objects, type) {
         var out = {};
 
-        var _iterator = _createForOfIteratorHelper(objects),
-            _step;
+        var _iterator2 = _createForOfIteratorHelper(objects),
+            _step2;
 
         try {
-          for (_iterator.s(); !(_step = _iterator.n()).done;) {
-            var object = _step.value;
+          for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+            var object = _step2.value;
             var objectId = object.getId();
             var typeChannel = _this._subscribed[type] || {};
             var subscribedToObject = typeChannel[objectId] || [];
 
-            var _iterator2 = _createForOfIteratorHelper(subscribedToObject),
-                _step2;
+            var _iterator3 = _createForOfIteratorHelper(subscribedToObject),
+                _step3;
 
             try {
-              for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
-                var sub = _step2.value;
+              for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+                var sub = _step3.value;
                 out[sub.subKey] = out[sub.subKey] || sub;
               }
             } catch (err) {
-              _iterator2.e(err);
+              _iterator3.e(err);
             } finally {
-              _iterator2.f();
+              _iterator3.f();
             }
           }
         } catch (err) {
-          _iterator.e(err);
+          _iterator2.e(err);
         } finally {
-          _iterator.f();
+          _iterator2.f();
         }
 
         return Object.values(out);
@@ -180,12 +223,12 @@ var ObserverStore = /*#__PURE__*/function (_PersistentStore) {
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _subscribeToObjects, {
       writable: true,
       value: function value(type, objectsToSubscribe, item) {
-        var _iterator3 = _createForOfIteratorHelper(objectsToSubscribe),
-            _step3;
+        var _iterator4 = _createForOfIteratorHelper(objectsToSubscribe),
+            _step4;
 
         try {
-          for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
-            var object = _step3.value;
+          for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
+            var object = _step4.value;
             var id = object.getId();
 
             if (!_this._subscribed[type][id]) {
@@ -195,14 +238,15 @@ var ObserverStore = /*#__PURE__*/function (_PersistentStore) {
             _this._subscribed[type][id].push(item);
           }
         } catch (err) {
-          _iterator3.e(err);
+          _iterator4.e(err);
         } finally {
-          _iterator3.f();
+          _iterator4.f();
         }
       }
     });
 
     _this._subscribed = {};
+    _this._multipleSubscribed = {};
     return _this;
   }
 
@@ -243,21 +287,21 @@ function _propagateInsertChange2(type, newObjects) {
     for (var _i = 0, _objects = objects; _i < _objects.length; _i++) {
       var object = _objects[_i];
 
-      var _iterator4 = _createForOfIteratorHelper(object),
-          _step4;
+      var _iterator5 = _createForOfIteratorHelper(object),
+          _step5;
 
       try {
-        for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
-          var sub = _step4.value;
+        for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
+          var sub = _step5.value;
 
           if (!uniqueSubs[sub.subKey]) {
             uniqueSubs[sub.subKey] = sub;
           }
         }
       } catch (err) {
-        _iterator4.e(err);
+        _iterator5.e(err);
       } finally {
-        _iterator4.f();
+        _iterator5.f();
       }
     }
 
@@ -272,12 +316,12 @@ function _propagateInsertChange2(type, newObjects) {
         return _this3.find(type, filterFunction).then(function (data) {
           var subKey;
 
-          var _iterator5 = _createForOfIteratorHelper(data),
-              _step5;
+          var _iterator6 = _createForOfIteratorHelper(data),
+              _step6;
 
           try {
-            for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
-              var d = _step5.value;
+            for (_iterator6.s(); !(_step6 = _iterator6.n()).done;) {
+              var d = _step6.value;
 
               var item = _this3._subscribed[d.getModel().getType()][d.getId()];
 
@@ -285,9 +329,9 @@ function _propagateInsertChange2(type, newObjects) {
               if (subKey) break;
             }
           } catch (err) {
-            _iterator5.e(err);
+            _iterator6.e(err);
           } finally {
-            _iterator5.f();
+            _iterator6.f();
           }
 
           _classPrivateFieldGet(_this3, _subscribeToObjects).call(_this3, type, objectsToSubscribe, {

package/dist/fingerprint.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = fingerprint;
 
+var _moment = _interopRequireDefault(require("moment"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
 function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
 
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
@@ -18,7 +22,15 @@ var CRC32 = require('crc-32');
 var _getFingerprint = function _getFingerprint(object) {
   switch (_typeof(object)) {
     case "object":
-      return "o:".concat(object !== null ? getObjectFingerprint(object) : "null");
+      if (object._isAMomentObject) {
+        return "m:".concat(object.toISOString());
+      } else if (object instanceof Date) {
+        return "m:".concat((0, _moment["default"])(object).toISOString());
+      } else if (object !== null) {
+        return "o:".concat(getObjectFingerprint(object));
+      } else {
+        return "o:null";
+      }
 
     case "boolean":
       return "b:".concat(object ? "t" : "f");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dataflux",
-  "version": "1.2.4",
+  "version": "1.4.1",
   "description": "DataFlux, automatically interfaces with your REST APIs to create a 2-way-synced local data store. Transparently manages data propagation in the React state.",
   "main": "dist/index.js",
   "bin": "dist/index.js",
@@ -89,14 +89,15 @@
     "chai": "^4.3.4",
     "chai-subset": "^1.6.0",
     "dotenv-cli": "^4.1.1",
-    "mocha": "^9.1.4",
-    "release-it": "^14.12.3"
+    "mocha": "^9.2.0",
+    "release-it": "^14.12.4"
   },
   "dependencies": {
     "axios": "^0.25.0",
     "batch-promises": "^0.0.3",
     "brembo": "^2.0.6",
     "crc-32": "^1.2.0",
+    "moment": "^2.29.1",
     "uuid": "^8.3.2"
   },
   "resolutions": {}

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,17 +0,0 @@
----
-name: Bug report
-about: Create a bug report
-title: ''
-labels: bug
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**Provide an example**
-Provide an example in terms of prefixes and BGP messages. Possibly provide a snippet of config.yml and prefixes.yml.
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,17 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: enhancement
-assignees: ''
-
----
-
-**Describe what you would like to achieve**
-A clear and concise description of what you want to happen.
-
-**Describe why the current solution (if any) is not satisfactory**
-A clear and concise description.
-
-**Provide an example**
-Provide an example in terms of prefixes and BGP messages. Possibly provide a snippet of config.yml and prefixes.yml.

package/.github/dependabot.yml

@@ -1,8 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: npm
-    directory: "/"
-    schedule:
-      interval: daily
-    open-pull-requests-limit: 10
-    target-branch: dev

package/.github/stale.yml

@@ -1,20 +0,0 @@
-# Number of days of inactivity before an issue becomes stale
-daysUntilStale: 90
-# Number of days of inactivity before a stale issue is closed
-daysUntilClose: 1
-# Issues with these labels will never be considered stale
-exemptLabels:
-  - pinned
-  - security
-  - no-stale
-
-# Label to use when marking an issue as stale
-staleLabel: wontfix
-
-markComment: false
-
-# Comment to post when marking an issue as stale. Set to `false` to disable
-closeComment: >
-  This issue has been automatically closed as stale.
-  This mechanism helps to prioritize feature requests which received more support from the community.
-  If you want to open again this issue you have to provide a Pull Request.

package/.github/workflows/main.yml

@@ -1,83 +0,0 @@
-name: Main
-
-on:
-  push:
-    branches: [ "*" ]
-  pull_request:
-    branches: [ "*" ]
-
-jobs:
-  build:
-    name: Build
-    runs-on: ubuntu-latest
-    steps:
-
-    - name: Set up Javascript/Node
-      uses: actions/setup-node@v2
-      with:
-        node-version: '14'
-
-    - name: Check out code
-      uses: actions/checkout@v2
-      with:
-        fetch-depth: '0'
-
-    - name: Cache multiple paths
-      uses: actions/cache@v2
-      with:
-        path: ~/.npm
-        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-        restore-keys: |
-          ${{ runner.os }}-node-
-
-    - name: Build
-      run: |
-        npm install
-        npm run compile
-
-    - name: Upload Artifact
-      uses: actions/upload-artifact@v2
-      if: ${{ always() }}
-      with:
-        name: logs
-        path: ~/.npm/_logs/*
-        retention-days: 14
-
-  test:
-    name: Test
-    runs-on: ubuntu-latest
-    steps:
-
-    - name: Set up Javascript/Node
-      uses: actions/setup-node@v2
-      with:
-        node-version: '14'
-
-    - name: Check out code
-      uses: actions/checkout@v2
-      with:
-        fetch-depth: '0'
-
-    - name: Cache multiple paths
-      uses: actions/cache@v2
-      with:
-        path: ~/.npm
-        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-        restore-keys: |
-          ${{ runner.os }}-node-
-
-    - name: Install
-      run: |
-        npm install
-
-    - name: Tests
-      run: |
-        npm run test
-
-    - name: Upload Artifact
-      uses: actions/upload-artifact@v2
-      if: ${{ always() }}
-      with:
-        name: logs
-        path: ~/.npm/_logs/*
-        retention-days: 14