feat: 0.16.0 (#343)

## Refactor:
* refactor(query-builder): move query attributes into its own object 
  * This slightly reduces size and looks better when logging a model out
* refactor(model)!: remove non-static `find` method
  * If the model is instantiated it is likely to have been hydrated with data.
    If it has then, nothing to find. If it hasn't then the static method is enough.
* refactor(internal): moved existence check up the class chain
* refactor(model)!: remove `findMany` non-static method
* refactor(model)!: removed `when` and `unless` non-static methods
* refactor(model): move 'when` and `unless` methods to the model
* refactor(internal): rename withouts query parameter to without

## Feature:
* feat(helpers): added `value` function
* feat(api-calls): add `setModelEndpoint` helper method 
* feat(model): added `tap` method
* feat(model): added function resolving to `when` and `unless` methods

## Fix:
* fix(relations): added existence check for `load` method
* fix(api-calls): improved `get` method's type argument/return
* fix(relations): fix `morphTo` relation
  * Endpoint was not set correctly for the next request
* fix(model): add missing lastSyncedAt copy in the `clone` method

## Chore:
* chore: increment version
* chore: add optional peer dependencies
* chore(deps-dev): updated dependencies

## Documentation
* docs(model): fix heading for `make` section
* docs(helpers): documented `value` function
* docs(timestamps): removed invalid todo comment

## Testing
* test(model): improved `tap`'s test
* test(relations): fix morphTo test

Author: nandi95

docs/calliope/api-calls.md

@@ -152,7 +152,7 @@ user.appendToEndpoint('/something').getEndpoint(); // 'users/something'
 #### setLastSyncedAt
 <Badge text="advanced" type="warning"/>
 
-The `setLastSyncedAt` method sets the [_lastSyncedAt](#_lastsyncedat) attribute to the current [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date). It optionally also accepts an argument for the value to be set as. The set value is subject to the [date-time casting](./attributes.md#datetime).
+The `setLastSyncedAt` method sets the [_lastSyncedAt](#_lastsyncedat) attribute to the current [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date). It optionally also accepts an argument for the value to be set as. The set value is subject to the [date-time casting](./attributes.md#datetime). Furthermore, it takes timestamps into consideration when enabled.
 
 ::: warning
 This method should only really be used when mocking the model to look like it exists. Some possible use-cases are:
@@ -167,3 +167,15 @@ const user = User.make({ id: 1 });
 user.exists; // false
 user.setLastSyncedAt().exists; // true
 ```
+
+#### setModelEndpoint
+
+The `setModelEndpoint` sets the endpoint on the model to the resource endpoint by appending the primary key.
+
+```js
+import User from '@Models/User';
+
+const user = User.make({ id: 1 });
+user.getEndpoint(); // '/users'
+user.setModelEndpoint().getEndpoint(); // '/users/1'
+```

docs/calliope/query-building.md

@@ -241,26 +241,6 @@ import User from '@Models/User';
 User.limit(5);
 ```
 
-#### when
-
-The `when` method calls the given closure when the first argument evaluates to a truthy value, allowing for adding constraints conditionally without breaking the method chaining.
-
-```js
-import User from '@Models/User';
-
-User.when(() => true, model => model.whereKey(1));
-```
-
-#### unless
-
-The `unless` method calls the given closure when the first argument evaluates to a falsy value, allowing for adding constraints conditionally without breaking the method chaining.
-
-```js
-import User from '@Models/User';
-
-User.unless(() => false, model => model.whereKey(1));
-```
-
 #### distinct
 
 The `distinct` method adds a distinct parameter for the request where the returned rows are expected to be distinct by the given columns.

docs/calliope/readme.md

@@ -167,10 +167,10 @@ Bundlers/minifier options examples:
 - [babel-minify: keepClassName](https://babeljs.io/docs/en/babel-minify#node-api)
   :::
 
-#### create
+#### make
 <Badge text="static" type="warning"/>
 
-The `create` method instantiates your model while setting up attributes and relations. This will mass assign attributes to the model while respecting the [guarding](./attributes#guarding) settings.
+The `make` method instantiates your model while setting up attributes and relations. This will mass assign attributes to the model while respecting the [guarding](./attributes#guarding) settings.
 
 ```ts
 import User from '@Models/User';
@@ -218,7 +218,7 @@ The `clone` method clones the instance in its current state. Meaning all changes
 ```js
 import User from '@Models/User';
 
-const user = User.factory().create({ myKey: 1 });
+const user = User.factory().createOne({ myKey: 1 });
 const userClone = user.clone();
 user.is(userClone); // true
 
@@ -227,6 +227,46 @@ userClone.myKey === 1; // true
 
 ```
 
+#### tap
+The `tap` method allows to use the model without affecting the model it is called on.
+
+```js
+import User from '@Models/User';
+
+const user = User.factory().createOne();
+user.with('relation')
+    .select(['attribute1', 'attribute2'])
+    .tap(console.log) // the model logged out to the console
+    .tap(model => model.with('another-relation')) // will NOT add `another-relation` to the next query
+    .get();
+```
+
+#### when
+
+The `when` method calls the given closure when the first argument evaluates to a truthy value, allowing for changing the model conditionally without breaking the method chaining.
+
+```js
+import User from '@Models/User';
+
+User.make()
+    .when(true, user => user.setAttribute('test', 1))
+    .when(() => false, user.setAttribute('test', 2))
+    .getAttribute('test'); // 1
+```
+
+#### unless
+
+The `unless` method calls the given closure when the first argument evaluates to a falsy value, allowing for changing the model conditionally without breaking the method chaining.
+
+```js
+import User from '@Models/User';
+
+User.make()
+    .unless(false, user => user.setAttribute('test', 1))
+    .unless(() => true, user => user.setAttribute('test', 2))
+    .getAttribute('test'); // 1
+```
+
 #### factory
 <Badge text="static" type="warning"/>
 

docs/calliope/relationships.md

@@ -232,7 +232,7 @@ import Contract from '@models/Contract'
 
 const contract = await Contract.find(1);
 // same contract as above fetched from the API, with the relation set
-const contractedEntity = await contract.$contractable().get().then(contract => contract.contractable);
+const contractedEntity = await contract.$contractable().get<Contract>().then(contract => contract.contractable);
 ```
 
 ## Manage Relations

docs/helpers/readme.md

@@ -418,3 +418,20 @@ const complexStructure = Team.factory().with(
 
 dataGet(complexStructure, '0.users.0.shifts.0.id') === 1; // true
 ```
+
+#### value
+
+The `value` is a function that simply resolves the given argument. If function given it will call the function with the passed in parameters. If not function given, it will return the value.
+
+```ts
+import { value } from '@upfrontjs/framework';
+
+value({}); // {};
+value(true); // true;
+value(() => []); // []
+value(
+    (firstNum: number, secondNum: number) => firstNum + secondNum,
+    1,
+    1
+); // 2
+```