feat 0.13.0 (#279)

## Refactor
* refactor(timestamps): moved existence check to HasTimestamps class
* refactor(events): simplified method signatures
* refactor(model)!: renamed `create` to `make`
  * This name hints the behaviour somewhat clearer than before. Previously it might have suggested that some persistence was involved.
* refactor(events): removed redundant union type
* refactor: move fetch mock file

## Chore
* chore: increment version
* chore: eslint changes
* chore(deps-dev): updated ts eslint

## Fix
* fix: allow any values within `handleError`
  * Some errors may be handled here and recovered from by returning something. Or perhaps an error is expected and no throwing is necessary.
* fix(events): added missing listener signature to `has` method
* fix(collection): fixed typing issue after typescript update

## Documentation
* docs: doc page linking, grammar and typo fixes
* docs(collection): fixed typo
* docs: add internal inline comments to testing

## Testing
* test: updated jest

## Feature
* feat(collection): improved `pluck` return type
* feat(helpers): add `dataGet` function

## Performance
* perf(collection): shortcut return when 0 given as argument

Author: nandi95

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img width="400" src="https://raw.githubusercontent.com/upfrontjs/design/main/upfrontjs.png">
+  <img alt="UpfrontJs logo" width="400" src="https://raw.githubusercontent.com/upfrontjs/design/main/upfrontjs.png">
 </p>
 
 ![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/upfrontjs/framework?color=%233ac200&include_prereleases&label=latest%20version&sort=semver&style=flat-square)

docs/calliope/api-calls.md

@@ -163,7 +163,7 @@ This method should only really be used when mocking the model to look like it ex
 ```js
 import User from '@Models/User';
 
-const user = User.create({ id: 1 });
+const user = User.make({ id: 1 });
 user.exists; // false
 user.setLastSyncedAt().exists; // true
 ```

docs/calliope/attributes.md

@@ -182,7 +182,7 @@ This in action will look like:
 ```js
 import User from '@Models/User';
 
-const user = User.create({ someAttribute: 1, name: 'name' });
+const user = User.make({ someAttribute: 1, name: 'name' });
 user.getAttributes(); // { name: 'name' }
 ```
 
@@ -318,7 +318,7 @@ After you have defined your accessors and mutators they'll be automatically call
 ```js
 import User from '@Models/User';
 
-const user = User.create({ title: 'Dr.', fullName: 'John Doe' });
+const user = User.make({ title: 'Dr.', fullName: 'John Doe' });
 user.fullName; // 'Dr. John Doe'
 ```
 
@@ -373,7 +373,7 @@ Just like object literals, models are also iterable using a for of loop. This lo
 import User from '@Models/User';
 import Shift from '@Models/Shift';
 
-const user = User.create({ title: 'Dr.', shifts: [new Shift] });
+const user = User.make({ title: 'Dr.', shifts: [new Shift] });
 
 for (const [item, key] of user) {
     // ...
@@ -407,7 +407,7 @@ The `getAttribute` method is what's used for getting attributes from the model.
 ```js
 import User from '@Models/User';
 
-const user = User.create({ name: 'John Doe' });
+const user = User.make({ name: 'John Doe' });
 user.name; // 'John Doe'
 user.getAttribute('name'); // 'John Doe'
 ```
@@ -429,13 +429,13 @@ The `getAttributes` method returns all the attributes that has been set in an ob
 ```js
 import User from '@Models/User';
 
-const user = User.create({ firstName: 'John', lastName: 'Doe' });
+const user = User.make({ firstName: 'John', lastName: 'Doe' });
 user.getAttributes(); // { firstName: 'John', lastName: 'Doe' }
 ```
 
 #### getRawAttributes
 
-The `getRawAttributes` method returns all the attributes similarly to [getAttributes](#getattributes) except is does not use the any value transformation.
+The `getRawAttributes` method returns all the attributes similarly to [getAttributes](#getattributes) except is does not use any value transformation.
 
 #### getAttributeKeys
 
@@ -444,7 +444,7 @@ The `getAttributeKeys` method returns all the attribute keys on the model curren
 ```js
 import User from '@Models/User';
 
-const user = User.create({ firstName: 'John', lastName: 'Doe' });
+const user = User.make({ firstName: 'John', lastName: 'Doe' });
 user.getAttributeKeys(); // ['firstName', 'lastName']
 ```
 
@@ -466,7 +466,7 @@ export default class User extends Model {
 import User from '@Models/User';
 import Shift from '@Models/Shift';
 
-const user = User.create({ firstName: 'John', lastName: 'Doe' });
+const user = User.make({ firstName: 'John', lastName: 'Doe' });
 user.property = 1;
 user.addRelation('shifts', [new Shift]);
 
@@ -483,7 +483,7 @@ The `fill` method merges in the given attributes onto the model that are conside
 ```js
 import User from '@Models/User';
 
-const user = User.create({ firstName: 'John', lastName: 'Doe' });
+const user = User.make({ firstName: 'John', lastName: 'Doe' });
 user.fill({ fistName: 'Jane', title: 'Dr.' }).getAttributes(); // { firstName: 'Jane', lastName: 'Doe', title: 'Dr. }
 ```
 
@@ -498,7 +498,7 @@ The `only` method returns only the attributes that match the given key(s).
 ```js
 import User from '@Models/User';
 
-const user = User.create({ firstName: 'John', lastName: 'Doe' });
+const user = User.make({ firstName: 'John', lastName: 'Doe' });
 user.only('fistName'); // { firstName: 'John' }
 ```
 #### except
@@ -508,7 +508,7 @@ The `except` method returns only the attributes that match does not the given ke
 ```js
 import User from '@Models/User';
 
-const user = User.create({ firstName: 'John', lastName: 'Doe', title: 'Dr.' });
+const user = User.make({ firstName: 'John', lastName: 'Doe', title: 'Dr.' });
 user.except(['fistName', 'title']); // { lastName: 'Doe' }
 ```
 
@@ -519,7 +519,7 @@ The `toJSON` method returns the json representation of the model's attributes an
 ```js
 import User from '@Models/User';
 
-const user = User.create({ name: 'John Doe' });
+const user = User.make({ name: 'John Doe' });
 user.addRelation('shifts', new Shift({ shiftAttr: 1 })).toJSON(); // {"name":"John Doe","shifts":[{"shiftAttr":1}]}
 ```
 
@@ -533,7 +533,7 @@ The `syncOriginal` method set's the original state of the data to the current st
 ```js
 import User from '@Models/User';
 
-const user = User.create({ name: 'John Doe' });
+const user = User.make({ name: 'John Doe' });
 user.name = 'Jane Doe';
 user.getOriginal('name'); // 'John Doe'
 user.syncOriginal().getOriginal('name'); // 'Jane Doe'
@@ -546,19 +546,19 @@ The `reset` method will set the attributes to the original values, discarding an
 ```js
 import User from '@Models/User';
 
-const user = User.create({ name: 'John Doe' });
+const user = User.make({ name: 'John Doe' });
 user.name = 'new name';
 user.getChanges(); // { name: 'new name' }
 user.reset().getChanges(); // {}
 ```
 
 #### getOriginal
 
-The `getOriginal` method returns the original value in a resolved format. Meaning it will use the [accessor](#mutatorsaccessors) if defined or it will [cast](#casting) the value if cast defined. The method optionally takes a second argument which the method will default to if the key is not found.
+The `getOriginal` method returns the original value in a resolved format. Meaning it will use the [accessor](#mutatorsaccessors) if defined, or it will [cast](#casting) the value if cast defined. The method optionally takes a second argument which the method will default to if the key is not found.
 ```js
 import User from '@Models/User';
 
-const user = User.create({ name: 'John Doe' });
+const user = User.make({ name: 'John Doe' });
 user.name = 'Jane Doe';
 user.getOriginal('name'); // 'John Doe'
 user.getOriginal('title', 'Mr.'); // 'Mr.'
@@ -574,7 +574,7 @@ The `getChanges` method returns only the changed data since the model was constr
 ```js
 import User from '@Models/User';
 
-const user = User.create({ name: 'John Doe', title: 'Mr.' });
+const user = User.make({ name: 'John Doe', title: 'Mr.' });
 user.getChanges(); // {}
 user.name = 'Jane Doe';
 user.getChanges(); // { name: 'Jane Doe' }
@@ -589,7 +589,7 @@ The `getDeletedAttributes` method returns only the deleted attributes since the
 ```js
 import User from '@Models/User';
 
-const user = User.create({ name: 'John Doe', title: 'Mr.' });
+const user = User.make({ name: 'John Doe', title: 'Mr.' });
 user.getDeletedAttributes(); // {}
 user.deleteAttribute('name').getDeletedAttributes(); // { name: 'John Doe' }
 user.deleteAttribute('title').getDeletedAttributes('name'); // { name: 'John Doe' }
@@ -602,7 +602,7 @@ The `getNewAttributes` method returns only the newly added attributes since the
 ```js
 import User from '@Models/User';
 
-const user = User.create({ name: 'John Doe', title: 'Mr.' });
+const user = User.make({ name: 'John Doe', title: 'Mr.' });
 user.getNewAttributes(); // {}
 user.setAttribute('attr', 1).getNewAttributes(); // { attr: 1 }
 user.setAttribute('attr2', 2).getNewAttributes('attr'); // { attr: 1 }
@@ -614,7 +614,7 @@ The `hasChanges` method determines whether any changes have occurred since const
 ```js
 import User from '@Models/User';
 
-const user = User.create({ name: 'John Doe', title: 'Mr.' });
+const user = User.make({ name: 'John Doe', title: 'Mr.' });
 user.hasChanges(); // false
 user.name = 'Jane Doe';
 user.hasChanges(); // true
@@ -631,11 +631,11 @@ The `isDirty` method is an alias of the [hasChanges](#haschanges) method.
 
 #### isClean
 
-The `isClean` method determines whether the attributes matches with the original attributes since the model constructing. Optionally it can take a key argument in which case it only inspect the given attribute's state.
+The `isClean` method determines whether the attributes match with the original attributes since the model constructing. Optionally it can take a key argument in which case it only inspect the given attribute's state.
 ```js
 import User from '@Models/User';
 
-const user = User.create({ name: 'John Doe', title: 'Mr.' });
+const user = User.make({ name: 'John Doe', title: 'Mr.' });
 user.isClean(); // true
 user.name = 'Jane Doe';
 user.isClean(); // false

docs/calliope/model-collection.md

@@ -1,6 +1,6 @@
 # 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.
+ModelCollection is a subclass 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
 

docs/calliope/query-building.md

@@ -338,7 +338,7 @@ User.orderBy('column', 'desc');
 
 #### orderByDesc
 
-The `orderByDesc` method indicates to the backend to order the returned records by the given column in a descending order.
+The `orderByDesc` method indicates to the backend to order the returned records by the given column in descending order.
 
 ```js
 import User from '@Models/User';

docs/calliope/readme.md

@@ -51,7 +51,7 @@ import User from '@Models/User';
 
 User.find(1);
 // or 
-User.create({ my: attributes });
+User.make({ my: attributes });
 // etc...
 ```
 
@@ -97,7 +97,7 @@ export default class User extends Model {
 #### keyType
 
 The `keyType` is a getter that identifies what the type is of your [primaryKey](#primarykey). Its value has to be either `'string'` or `'number'` with `'number'` being the default value.
-You should update this value to `'string'` if you're using a uuid or some custom string for the primary key as this is used when in the [Factory](../testing.md#factories) and [exists](#exists) logic.
+You should update this value to `'string'` if you're using a UUID or some custom string for the primary key as this is used when in the [Factory](../testing/readme.md#factories) and [exists](#exists) logic.
 
 ```js
 // User.ts
@@ -128,9 +128,9 @@ The `is` method compares the given model with the current model based on the [ge
 import User from '@Models/User';
 import Shift from '@Models/Shift';
 
-const user = User.create({ id: 1 });
-const user2 = User.create({ id: 2 });
-const shift = Shift.create({ id: 1 });
+const user = User.make({ id: 1 });
+const user2 = User.make({ id: 2 });
+const shift = Shift.make({ id: 1 });
 
 user.is(user); // true
 user.is(user2); // false
@@ -175,7 +175,7 @@ The `create` method instantiates your model while setting up attributes and rela
 ```ts
 import User from '@Models/User';
 
-const user = User.create({ name: 'User Name' }); // User
+const user = User.make({ name: 'User Name' }); // User
 ```
 ::: warning
 Constructing a new class like `new User({...})` is **not** acceptable. This will not overwrite your class fields with default values if the same key has been passed in due to how JavaScript first constructs the parent class and only then the subclasses. However, you can still use it to call instance methods. Furthermore, it will not cause unexpected results if using it with the [setAttribute](./attributes.md#setattribute) method or call methods that under the hood uses the [setAttribute](./attributes.md#setattribute).
@@ -187,8 +187,8 @@ When creating an instance and passing in another instance of the model:
 import User from '@Models/User';
 import Shift from '@Models/Shift';
 
-const user = User.create({ name: 'John Doe' });
-const newUser = User.create(user);
+const user = User.make({ name: 'John Doe' });
+const newUser = User.make(user);
 ```
 It will clone the [raw attributes](./attributes#getrawattributes) and the [relationships](./relationships.md#getrelations) of the model.
 :::
@@ -230,7 +230,7 @@ userClone.myKey === 1; // true
 #### factory
 <Badge text="static" type="warning"/>
 
-The `factory` is a method that returns a [Factory](../testing.md#factorybuilder) instance. Optionally it takes a number argument which is a shorthand for the [times](../testing.md#times) method.
+The `factory` is a method that returns a [Factory](../testing/readme.md#factorybuilder) instance. Optionally it takes a number argument which is a shorthand for the [times](../testing/readme.md#times)' method.
 
 ```js
 import User from '@Models/User';
@@ -253,7 +253,7 @@ const users = await User.all(); // ModelCollection[User, ...]
 #### save
 <Badge text="async" type="warning"/>
 
-The `save` method will update or save your model based on whether the model [exists](#exists) or not. If the model exists it will send a `PATCH` request containing the changes, and the optionally passed in attributes. If the model does not exists it will send a `POST` request. The method returns the same current user updated with the response data if any.
+The `save` method will update or save your model based on whether the model [exists](#exists) or not. If the model exists it will send a `PATCH` request containing the changes, and the optionally passed in attributes. If the model does not exist it will send a `POST` request. The method returns the same current user updated with the response data if any.
 
 #### update
 <Badge text="async" type="warning"/>

docs/calliope/relationships.md

@@ -32,7 +32,7 @@ Then you may query as:
 ```js
 import User from '@Models/User';
 
-const user = User.create({ id: 1 });
+const user = User.make({ id: 1 });
 const shiftsWithColleagues = await user.$shifts().with('colleagues').get(); // ModelCollection
 
 await user.load('contract');
@@ -233,11 +233,11 @@ The `addRelations` method adds the relation onto the current model. It accepts t
 import User from '@Models/User';
 import Contract from '@Models/Contract';
 
-const user = User.create({ id: 1 });
+const user = User.make({ id: 1 });
 user.addRelation('shifts', { id: 1 });
 user.shifts; // ModelCollection[Shift]
 
-user.addRelation('$contract', Contract.create({ id: 1, user_id: 1 }));
+user.addRelation('$contract', Contract.make({ id: 1, user_id: 1 }));
 user.contract; // Contract
 ```
 
@@ -256,7 +256,7 @@ The `removeRelation` method removes the given relation from the model.
 ```js
 import User from '@Models/User';
 
-const user = User.create({ contract: { id: 1 } });
+const user = User.make({ contract: { id: 1 } });
 user.relationLoaded('contract'); // true
 user.removeRelation('contract').relationLoaded('$contract'); // false
 ```
@@ -268,7 +268,7 @@ The `relationLoaded` method determines whether the given relation has been loade
 ```js
 import User from '@Models/User';
 
-const user = User.create({ contract: { id: 1 } });
+const user = User.make({ contract: { id: 1 } });
 user.relationLoaded('contract'); // true
 user.relationLoaded('$shifts'); // false
 ```
@@ -301,9 +301,9 @@ The `for` method is used for [setting](./api-calls.md#setendpoint) custom endpoi
 ```js
 import User from '@Models/User';
 
-user.for(Team.create({ id: 1 })); // 'teams/1/users'
-user.for([Team.create({ id: 1 }), Contract.create({ id: 1 })]); // 'teams/1/contracts/1/users'
-user.for([new Team, Contract.create({ id: 1 })]); // 'teams/contracts/1/users'
+user.for(Team.make({ id: 1 })); // 'teams/1/users'
+user.for([Team.make({ id: 1 }), Contract.make({ id: 1 })]); // 'teams/1/contracts/1/users'
+user.for([new Team, Contract.make({ id: 1 })]); // 'teams/contracts/1/users'
 user.for([Team, Contract]); // teams/contracts/users
 ```
 

docs/calliope/timestamps.md

@@ -8,12 +8,12 @@ Timestamps are a feature of the model used for tracking changes on your entities
 
 #### createdAt
 
-The `createdAt` is a static property on the model. The default value is `'createdAt'`. You may over ride this if the expected timestamp attribute is named differently.
+The `createdAt` is a static property on the model. The default value is `'createdAt'`. You may override this if the expected timestamp attribute is named differently.
 The letter casing is no concern here as [getCreatedAtName](#getcreatedatname) will update it to the correct casing.
 
 #### updatedAt
 
-The `updatedAt` is a static property on the model. The default value is `'updatedAt'`. You may over ride this if the expected timestamp attribute is named differently.
+The `updatedAt` is a static property on the model. The default value is `'updatedAt'`. You may override this if the expected timestamp attribute is named differently.
 The letter casing is no concern here as [getUpdatedAtName](#getupdatedatname) will update it to the correct casing.
 
 #### timestamps
@@ -54,7 +54,7 @@ The `freshTimestamps` method sends `GET` request [selecting](./query-building.md
 
 #### deletedAt
 
-The `deletedAt` is a static property on the model. The default value is `'deletedAt'`. You may over ride this if the expected timestamp attribute is named differently.
+The `deletedAt` is a static property on the model. The default value is `'deletedAt'`. You may override this if the expected timestamp attribute is named differently.
 The letter casing is no concern here as [getDeletedAtName](#getdeletedatname) will update it to the correct casing.
 
 #### softDeletes

docs/helpers/collection.md

@@ -412,7 +412,7 @@ collection.dump().take(2); // Collection[1, 2]
 When all items in the collections are objects, then you may order them using the `orderBy` method. The method takes one or more objects describing how the collection should be ordered. The object has two properties:
 
 - `property` - the name of the property you want to order by OR a method that accepts the collection item and returns the nested value.
-- `direction` - possible values are `asc`, `desc` respective to weather it should be in ascending or descending order.
+- `direction` - possible values are `asc`, `desc` respective to whether it should be in ascending or descending order.
 
 ```js
 const elements = [

docs/helpers/global-config.md

@@ -145,7 +145,7 @@ This is a `string` that the [model's endpoint](../calliope/api-calls.md#endpoint
 
 #### randomDataGenerator
 
-This value if set, it will be available for consuming in your [Factories](../testing.md#factories) under the member key [random](../testing.md#random).
+This value if set, it will be available for consuming in your [Factories](../testing/readme.md#factories) under the member key [random](../testing/readme.md#random).
 
 #### requestMiddleware