Rolling changes (#122) (#135)

## Fix
* fix: added the expected type key to `isObjectLiteral`  method
* fix: added type argument to `Arrayable` interface
* fix(model-collection): added missing toArray call
  * Issue stemming from not adding the call in the refactor commit
    bb8817c
* fix(internal): fix `_relationType` type
* fix: fixed typing issue from MaybeArray update
    * commit: 8369c5e

## Refactor
* refactor: updated `_allAreObjects` method to use existing helper
* refactor(deps-dev): use jest timers
  * removed jest-date-mock and use the jest built in fake timers
* refactor(deps-dev): use jest timers
  * committing missing logic from previous commit
* refactor(deps-dev): use jest timers
  * committing missing logic from previous commit
* refactor(model-collection)!: made internal methods more predictable
  * These methods are protected so should not be breaking but marking it as such just in case
* refactor(model): simplify replicate method

## Feature
* feat(services): made API accept a promise from initRequest method
* feat(model): improved return typing of `replicate` and `find`
* feat(api-calls): added requestMiddleware
    * This allows for transforming the requests before being passed to the ApiCaller
* feat(relations): `for` method now accepts model constructors
* feat: added utility types
* feat: exported utility types
* feat: added ExtractArguments and DeepPartial type utility types
* feat(events): added event emitter
    * Resolves #23
* feat(collection): added overrides for more exact type inference
* feat(relations): updated argument option of `addRelation` method
    * Added model array as possible argument
* feat(relations): add argument type to `addRelation` method
  * Added Collection of models as a possible argument type

## Documentation
* docs: correct some inaccuracies
* docs: fixed toc
* docs: removed duplication
* docs: fixed small documentation issues
* docs: added teaser code example
* docs: added link to releases page as change-log

## Test
* test(internal): simplified test helper
* test(model-collection): use types for testing `isModelCollection`
* test: added more test types to the helper array
## Style
* style: small inconsequential changes
  * spacing
  * property description
  * removed debugging log
* style: fixed eslint issues
* style: ignored eslint issues

## Chore
* chore(deps-dev): updated dependencies
  * @commitlint/config-conventional
  * @commitlint/prompt-cli
  * @commitlint/types
  * @semantic-release/git
  * @types/lodash
  * @types/semantic-release
  * @typescript-eslint/eslint-plugin
  * @typescript-eslint/parser
  * commitlint
  * eslint-plugin-jest
  * rollup
  * semantic-release
  * typedoc
* chore: incremented version
* chore(deps-dev): updated dependencies
  * @commitlint/prompt-cli
  * @rollup/plugin-typescript
  * @types/lodash
  * @typescript-eslint/eslint-plugin
  * @typescript-eslint/parser
  * commitlint
  * eslint-plugin-import
  * eslint-plugin-jest
  * husky
  * lint-staged
  * typedoc
  * typescript
* chore: updated bug issue template
* chore(deps-dev): updated dependencies
  * lint-staged
  * rollup
  * typedoc
  
## Refactor
* refactor: updated arguments to use MaybeArray utility type

Author: nandi95

.commitlintrc.js

@@ -12,6 +12,7 @@ module.exports = {
                 'attributes', // guarding and casting can also go under attributes
                 'global-config',
                 'exception',
+                'events',
                 'services',
                 'helpers',
                 'collection',

.eslintrc.js

@@ -39,6 +39,7 @@ module.exports = {
         "comma-dangle": ["warn", "never"],
         "max-len": ["warn", 120],
         "eqeqeq": "error",
+        "no-restricted-imports": "off",
 
         // https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#supported-rules
         '@typescript-eslint/object-curly-spacing': ['warn', 'always'],
@@ -85,6 +86,7 @@ module.exports = {
         "@typescript-eslint/no-loop-func": "off",
         "@typescript-eslint/no-confusing-void-expression": "off",
         "@typescript-eslint/array-type": "warn",
-        "@typescript-eslint/prefer-for-of": "off"
+        "@typescript-eslint/prefer-for-of": "off",
+        "@typescript-eslint/no-restricted-imports": "off"
     }
 }

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,66 @@
+name: 🐞 Bug Report
+description: File a bug/issue
+labels: [ bug ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please read the contribution docs before creating a bug report
+        👉 https://upfrontjs.com/prologue/contributing.html#issues-and-prs
+  - type: checkboxes
+    id: has-searched-issues
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: textarea
+    id: current-behaviour
+    attributes:
+      label: Current Behavior
+      description: A concise description of what you're experiencing.
+    validations:
+      required: false
+  - type: textarea
+    id: expected behaviour
+    attributes:
+      label: Expected Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: false
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: |
+        examples:
+          - **OS**: Ubuntu 20.04
+          - **Node**: 13.14.0
+          - **npm**: 7.6.3
+      value: |
+        - OS:
+        - Node:
+        - npm:
+      render: markdown
+    validations:
+      required: false
+  - type: textarea
+    id: context
+    attributes:
+      label: Anything else?
+      description: |
+        Links? References? Anything that will give more context about the issue you are encountering!
+
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false
+  required: false
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction
+      description: Please provide a link to a repo that can reproduce the problem you ran into, unless the issue is obvious and easy to understand without more context. This will make sure your problem can be addressed faster. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided it might get closed.
+      placeholder: Reproduction
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,47 +1,47 @@
-# Model Collection
-
-ModelCollection is a sub class of the [Collection](../helpers/collection.md), therefore all methods are inherited. The following methods have been updated to use either the model's [is](./readme.md#is) method, or the [primary key](./readme.md#getkey) of the model for comparison between models. `unique`, `hasDuplicates`, `duplicates`, `diff`, `only`, `except`, `intersect`, `delete`, `union`, `includes`. The signature of the before mentioned methods has not changed. In addition, the ModelCollection ensures that only [Models](./readme.md) are included in the collection. On top of the collection's methods couple of others has been added that are only relevant to model values.
-
-## Methods
-
-#### modelKeys
-
-The `modelKeys` method returns the [primary key](./readme.md#getkey) of the models on a Collection.
-```js
-import User from '@Models/User';
-
-const modelCollection = await User.get();
-modelCollection.modelKeys(); // Collection[1, 2, 3, ...ids]
-```
-
-#### findByKey
-
-The `findByKey` method returns the Model or ModelCollection depending on the argument. The method can take the ids as a single argument or as an array or collection. Optionally you may give it a second argument which will be returned is the id is not found in the model collection.
-```js
-import User from '@Models/User';
-import { Model } from '@upfrontjs/framework';
-
-const defaultModel = new Model;
-const modelCollection = await User.get();
-modelCollection.findByKey(1); // User1
-modelCollection.findByKey([1, 2]); // ModelCollection[User1, User2]
-modelCollection.findByKey(43, defaultModel); // Model
-```
-
-#### isModelCollection
-
-The `isModelCollection` static method same as the [isCollection](../helpers/collection.md#iscollection) method on the collection, is used to evaluate that the given value is a ModelCollection.
-```js
-import { ModelCollection, Collection } from '@upfrontjs/framework';
-
-const modelCollection = await User.get();
-ModelCollection.isModelCollection(modelCollection); // true
-ModelCollection.isModelCollection([Model1, Model2]); // false
-Collection.isCollection(modelCollection); // true
-```
-
----
-
-::: tip
-The `map` method returns a ModelCollection if the return of the given callback is a [Model](./readme.md), otherwise it returns a [Collection](../helpers/collection.md).
-:::
+# Model Collection
+
+ModelCollection is a sub class of the [Collection](../helpers/collection.md), therefore all methods are inherited. The following methods have been updated to use either the model's [is](./readme.md#is) method, or the [primary key](./readme.md#getkey) of the model for comparison between models. `unique`, `hasDuplicates`, `duplicates`, `diff`, `only`, `except`, `intersect`, `delete`, `union`, `includes`. The signature of the before mentioned methods has not changed. In addition, the ModelCollection ensures that only [Models](./readme.md) are included in the collection. On top of the collection's methods couple of others has been added that are only relevant to model values.
+
+## Methods
+
+#### modelKeys
+
+The `modelKeys` method returns the [primary key](./readme.md#getkey) of the models on a Collection.
+```js
+import User from '@Models/User';
+
+const modelCollection = await User.get();
+modelCollection.modelKeys(); // Collection[1, 2, 3, ...ids]
+```
+
+#### findByKey
+
+The `findByKey` method returns the Model or ModelCollection depending on the argument. The method can take the ids as a single argument or as an array or collection. Optionally you may give it a second argument which will be returned if the id is not found in the model collection.
+```js
+import User from '@Models/User';
+import { Model } from '@upfrontjs/framework';
+
+const defaultModel = new Model;
+const modelCollection = await User.get();
+modelCollection.findByKey(1); // User1
+modelCollection.findByKey([1, 2]); // ModelCollection[User1, User2]
+modelCollection.findByKey(43, defaultModel); // Model
+```
+
+#### isModelCollection
+
+The `isModelCollection` static method same as the [isCollection](../helpers/collection.md#iscollection) method on the collection, is used to evaluate that the given value is a ModelCollection.
+```js
+import { ModelCollection, Collection } from '@upfrontjs/framework';
+
+const modelCollection = await User.get();
+ModelCollection.isModelCollection(modelCollection); // true
+ModelCollection.isModelCollection([Model1, Model2]); // false
+Collection.isCollection(modelCollection); // true
+```
+
+---
+
+::: tip
+The `map` method returns a ModelCollection if the return of the given callback is a [Model](./readme.md), otherwise it returns a [Collection](../helpers/collection.md).
+:::

docs/calliope/model-collection.md

@@ -14,7 +14,7 @@ const morningWorkers = await User
 
 Which will generate request url similar to the described [Shape of the request](../services/api.md#shape-of-the-request) the [API](../services/api.md) service class generates.
 
-### Customising the generated query string
+## Customising the generated query string
 
 Given the above may not follow the desired namings for the parameters, you could customise the result by implementing the provided `FormatsQueryParameters` interface.
 

docs/calliope/query-building.md

@@ -50,10 +50,6 @@ export default class User extends Model {
 
 The `exists` property is a getter on the model that returns a boolean which can be used to assert that the model has been persisted. It takes the [primary key](#getkey), [timestamps](./timestamps.md#timestamps) and [soft deletes](./timestamps.md#soft-deletes) into account.
 
-#### primaryKey
-
-The `primaryKey` is property is a getter that defines what is the primary identifier's key from the model attributes. The default value is `'id'`.
-
 ## Additional methods
 
 #### is

docs/calliope/readme.md

@@ -33,7 +33,7 @@ Then you may query as:
 import User from '@Models/User';
 
 const user = new User({ id: 1 });
-const shiftsWithColleagues = user.$shifts().with('colleagues').get(); // ModelCollection
+const shiftsWithColleagues = await user.$shifts().with('colleagues').get(); // ModelCollection
 
 await user.load('contract');
 user.contract; // Contract
@@ -304,6 +304,7 @@ import User from '@Models/User';
 user.for(new Team({ id: 1 })); // 'teams/1/users'
 user.for([new Team({ id: 1 }), new Contract({ id: 1 })]); // 'teams/1/contracts/1/users'
 user.for([new Team, new Contract({ id: 1 })]); // 'teams/contracts/1/users'
+user.for([Team, Contract]); // teams/contracts/users
 ```
 
 ### Overwrites

docs/calliope/relationships.md

@@ -115,11 +115,11 @@ const experiencedSafeDrivers = await User
 With the default [ApiCaller](./services#apicaller) and [HandlesApiRequest](./services#handlesapiresponse) implementations, you can interact with your api without the need for the models or any of their methods.
 
 ```js
-import { GlobalConfig } from '@upfrontjs/framework';
+import { GlobalConfig, API, ApiResponseHandler } from '@upfrontjs/framework';
 
 const config = new GlobalConfig;
-const handler = config.get('apiResponseHandler');
-const api = config.get('api');
+const handler = new ApiResponseHandler;
+const api = new API;
 
 const form = new FormData;
 // ... collect the form entries
@@ -137,7 +137,7 @@ const response = await handler.handle(
 
 #### Alias methods
 
-There may be some logic you frequently use, but it might not be apparent at the first glance what's happening or can be simpler to comprehend.
+There may be some logic you frequently use, but it might not be apparent at the first glance what's happening or can be made simpler to comprehend.
 
 For example, you may express that you want the first model like so:
 

docs/cookbook.md

@@ -3,6 +3,16 @@
 ## What is it?
 It's a model centric data handling solution. With it, you can write expressive, readable, concise syntax that you already know and love from back-end MVC frameworks. It provides an elegant structure to complex data with a plethora of features to manage the data, and additional helpers for common tasks like handling lists, pagination, string manipulation etc.
 
+```ts
+import User from '@models/User';
+
+const students = await User.where('is_student', true).with('grades').get();
+
+const excellentStudentNames = students
+    .filter(student => student.grades.average('value') > 4)
+    .pluck('name');
+```
+
 ## What does it solve?
 There are number of solutions out there for fetching data and working with the response. However not all of these might be as scalable as one would hope. With state management, you might have a getter for users, but those users include all users, meaning for a custom collection you would need a new getter method. An on-demand ajax request written specifically to solve a single issue, while it is simple to do, it quickly gets repetitive and hard to maintain. [Upfront](./installation.md) solves the above by creating abstraction over the data in a unified api. Just like the above examples it can be used to fetch data on demand or be complimentary to state management libraries.