upfrontjs
diff --git a/‎.github/ISSUE_TEMPLATE/bug_report.yml
+7-1 b/‎.github/ISSUE_TEMPLATE/bug_report.yml
+7-1
diff --git a/‎.github/pull_request_template.md
+36 b/‎.github/pull_request_template.md
+36
diff --git a/‎.github/semantic.yml
+33 b/‎.github/semantic.yml
+33
diff --git a/‎.github/workflows/automerge.yml
-1 b/‎.github/workflows/automerge.yml
-1
diff --git a/‎.github/workflows/build.yml
+2-9 b/‎.github/workflows/build.yml
+2-9
diff --git a/‎.github/workflows/commitlint.yml
-18 b/‎.github/workflows/commitlint.yml
-18
diff --git a/‎.github/workflows/deploy-api-docs.yml
+26 b/‎.github/workflows/deploy-api-docs.yml
+26
diff --git a/‎.github/workflows/lint.yml
+3-10 b/‎.github/workflows/lint.yml
+3-10
diff --git a/‎.github/workflows/test.yml
+7-9 b/‎.github/workflows/test.yml
+7-9
diff --git a/‎.gitignore
+1-1 b/‎.gitignore
+1-1
diff --git a/‎TODO
+1-4 b/‎TODO
+1-4
diff --git a/‎docs/calliope/api-calls.md
+3-3 b/‎docs/calliope/api-calls.md
+3-3
diff --git a/‎docs/calliope/attributes.md
+2-2 b/‎docs/calliope/attributes.md
+2-2
diff --git a/‎docs/calliope/query-building.md
+1-1 b/‎docs/calliope/query-building.md
+1-1
@@ -15,6 +15,13 @@ body:
       options:
         - label: I have searched the existing issues
           required: true
+  - type: textarea
+    id: search-terms
+    attributes:
+      label: Search terms
+      description: The terms you searched for in the issues before opening a new issue.
+    validations:
+      required: true
   - type: textarea
     id: current-behaviour
     attributes:
@@ -55,7 +62,6 @@ body:
         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:
 
@@ -0,0 +1,36 @@
+<!---
+☝️ PR title should follow conventional commits (https://conventionalcommits.org)
+
+Please carefully read the contribution docs before creating a pull request
+ 👉 https://upfrontjs.com/prologue/contributing.html
+-->
+
+### 🔗 Linked issue
+
+<!-- Please ensure there is an open issue and mention its number as #123 -->
+
+### ❓ Type of change
+
+<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->
+
+- [ ] 📖 Documentation (updates to the documentation or readme)
+- [ ] 🐞 Bug fix (a non-breaking change that fixes an issue)
+- [ ] 👌 Enhancement (improving an existing functionality like performance)
+- [ ] ✨ New feature (a non-breaking change that adds functionality)
+- [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)
+
+### 📚 Description
+
+<!-- Describe your changes in detail -->
+<!-- Why is this change required? What problem does it solve? -->
+<!-- If it resolves an open issue, please link to the issue here. For example "Resolves #1337" -->
+
+### 📝 Checklist
+
+<!-- Put an `x` in all the boxes that apply. -->
+<!-- If your change requires a documentation PR, please link it appropriately -->
+<!-- If you're unsure about any of these, don't hesitate to ask. -->
+
+- [ ] I have linked an issue or discussion.
+- [ ] I have updated the documentation accordingly.
+
@@ -0,0 +1,33 @@
+# https://github.com/zeke/semantic-pull-requests#configuration
+
+# Always validate the PR title AND all the commits
+titleAndCommits: true
+
+# Allow use of Merge commits (eg on github: "Merge branch 'master' into feature/ride-unicorns")
+# this is only relevant when using commitsOnly: true (or titleAndCommits: true)
+allowMergeCommits: true
+
+# Allow use of Revert commits (eg on github: "Revert "feat: ride unicorns"")
+# this is only relevant when using commitsOnly: true (or titleAndCommits: true)
+allowRevertCommits: true
+
+# Scopes matching the ones defined in .commitlintrc.js file
+scopes:
+  - 'attributes' # guarding and casting can also go under attributes
+  - 'global-config'
+  - 'exception'
+  - 'events'
+  - 'services'
+  - 'helpers'
+  - 'collection'
+  - 'model'
+  - 'model-collection'
+  - 'paginator'
+  - 'factory'
+  - 'query-builder'
+  - 'timestamps' # soft-deletes can also go under timestamps
+  - 'relations'
+  - 'api-calls'
+  - 'deps'
+  - 'deps-dev'
+  - 'internal' # things that are not meant to be used outside of the package
@@ -17,6 +17,5 @@ jobs:
     steps:
       - uses: tjenkinson/gh-action-auto-merge-dependency-updates@v1
         with:
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
           allowed-actors: dependabot-preview[bot], dependabot[bot]
           merge-method: squash
@@ -12,22 +12,15 @@ on:
       - 'release/*'
 
 jobs:
-  build:
+  rollup:
     timeout-minutes: 10
     if: github.event.pull_request.draft == false
-    name: Build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
-      - uses: actions/cache@v2
         with:
-          key: npm-${{ hashFiles('./package-lock.json') }}
-          path: ~/.npm
-          restore-keys: |
-            npm-
-          node-version: 15
-          check-latest: true
+          cache: 'npm'
       - run: npm ci
       - name: Rollup
         run: npm run build
@@ -0,0 +1,26 @@
+name: Deploy Api Docs
+
+on:
+  push:
+    paths:
+      - 'src/**/*.ts'
+    branches:
+      - main
+
+jobs:
+  deploy:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+      - name: Install dependencies
+        run: npm ci
+      - name: Build api docs
+        run: npm run docs:api
+      - name: Update gh-pages branch
+        run: |
+          git config --global user.name "${{ github.actor }}"
+          git add api-docs
+          git commit -m "Updates from ${{ github.ref }}"
+          git push -u origin gh-pages
@@ -1,4 +1,4 @@
-name: Lint
+name: Lint Code
 
 on:
   pull_request:
@@ -10,22 +10,15 @@ on:
       - 'release/*'
 
 jobs:
-  lint:
+  eslint:
     timeout-minutes: 10
     if: github.event.pull_request.draft == false
-    name: Lint
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
-      - uses: actions/cache@v2
         with:
-          key: npm-${{ hashFiles('./package-lock.json') }}
-          path: ~/.npm
-          restore-keys: |
-            npm-
-          node-version: 15
-          check-latest: true
+          cache: 'npm'
       - run: npm ci
       - name: ESLint
         run: node node_modules/.bin/eslint . --ext .ts
@@ -8,26 +8,24 @@ on:
       - 'tests/**/*.ts'
       - 'src/**/*.ts'
       - 'jest.config.js'
+      - 'package-lock.json'
     branches:
       - main
       - 'release/*'
 
 jobs:
-  test:
+  jest:
     timeout-minutes: 10
     if: github.event.pull_request.draft == false
-    name: Test
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [ 16, 17 ]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
-      - uses: actions/cache@v2
         with:
-          key: npm-${{ hashFiles('./package-lock.json') }}
-          path: ~/.npm
-          restore-keys: |
-            npm-
-          node-version: 15
-          check-latest: true
+          cache: 'npm'
+          node-version: ${{ matrix.node }}
       - run: npm ci
       - run: npm run test
@@ -4,7 +4,7 @@ index.*.js*
 array.*.js*
 string.*.js*
 types
-.tgz
+*.tgz
 
 # testing
 tests/cache/
 
@@ -1,6 +1,3 @@
 Todos which are not concerning a single unit of code:
 
-todo - tinker with node support (take callsApi out)
-todo - arrange api-docs to be live
-todo - qs should not be a dependency if the user not using the API service
-todo - https://github.com/microsoft/TypeScript/issues/33079 figure out the package entries so user doesn't have to specify .es.min.js for string and array helpers and when using helpers in js the typings will be found
+todo - qs should not be a dependency if the user not using the API service (maybe interfaces and services should be separate packages?)
@@ -18,12 +18,12 @@ The `serverAttributeCasing` is a getter which similarly to [attributeCasing](./a
 
 #### _lastSyncedAt
 
-The `_lastSyncedAt` or `_last_synced_at` (naming subject to [attributeCasing](./attributes.md#attributecasing)) attribute is a getter attribute that is set only when the model data has been fetched, [saved](./readme.md#save) or [refreshed](./readme.md#refresh). It is a javascript [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) object indicating when was the last time the data has been loaded from the backend. 
+The `_lastSyncedAt` or `_last_synced_at` (naming subject to [attributeCasing](./attributes.md#attributecasing)) attribute is a getter attribute that is set only when the model data has been fetched, [saved](./readme.md#save) or [refreshed](./readme.md#refresh). It is type subject to the [datetime](./attributes.md#datetime) setting, with the value of when was the last time the data has been loaded from the backend.
 
 ## Methods
 
 ::: tip
-All request methods on success will call the [resetEndpoint](#resetendpoint) and will reset the all the [query parameters](./query-building.md).
+All request methods on success will call the [resetEndpoint](#resetendpoint) and will reset  all the [query parameters](./query-building.md).
 :::
 
 #### get
@@ -118,7 +118,7 @@ import User from '@Models/User';
 
 const user = new User;
 user.setEndpoint('/something').getEndpoint(); // '/something'
-user.resetEndpoint('/something').getEndpoint(); // 'users'
+user.resetEndpoint().getEndpoint(); // 'users'
 ```
 
 #### appendToEndpoint
 
@@ -162,7 +162,7 @@ user.hasCast('test1'); // true
 
 ## Guarding
 
-With models there are option to mass assign attributes to the model though the constructor or the [fill](#fill) method. However, when you're constructing your attributes dynamically, you may come across scenarios where you may not want every attribute assigned to the model on mass assignment. For these, there is an option to white and black list attribute keys.
+With models there are option to mass assign attributes to the model though the constructor or the [fill](#fill) methods. However, when you're constructing your attributes dynamically, you may come across scenarios where you may not want every attribute assigned to the model on mass assignment. For these, there is an option to white and black list attribute keys.
 
 To define these rules, you create a `fillable` and/or `guarded` getter function which returns an array of strings.
 ```js
@@ -300,7 +300,7 @@ export default class User extends Model {
     }
 
     setFullNameAttribute(name) {
-        return name.startsWith(this.title + ' ')
+        this.attributes.fullName = name.startsWith(this.title + ' ')
             ? name.slice(this.title.length + 1)
             : name;
     }
 
@@ -390,7 +390,7 @@ User.skip(10);
 #### newQuery
 <Badge text="static only" type="warning"/>
 
-The `newQuery` is a static method that returns the builder. You're not expected to use it as all methods are already available statically as well.
+The `newQuery` is a static method that returns the builder. You're not expected to use this as builder all methods are already available statically as well. However, if you still find that there are methods not available statically (like your own methods) you can use this.
 
 ```js
 import User from '@Models/User';
Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,7 @@ user.hasCast('test1'); // true`
`162`	`162`
`163`	`163`	`## Guarding`
`164`	`164`
`165`		`-With models there are option to mass assign attributes to the model though the constructor or the [fill](#fill) method. However, when you're constructing your attributes dynamically, you may come across scenarios where you may not want every attribute assigned to the model on mass assignment. For these, there is an option to white and black list attribute keys.`
	`165`	`+With models there are option to mass assign attributes to the model though the constructor or the [fill](#fill) methods. However, when you're constructing your attributes dynamically, you may come across scenarios where you may not want every attribute assigned to the model on mass assignment. For these, there is an option to white and black list attribute keys.`
`166`	`166`
`167`	`167`	To define these rules, you create a `fillable` and/or `guarded` getter function which returns an array of strings.
`168`	`168`	```js
`@@ -300,7 +300,7 @@ export default class User extends Model {`
`300`	`300`	`}`
`301`	`301`
`302`	`302`	`setFullNameAttribute(name) {`
`303`		`- return name.startsWith(this.title + ' ')`
	`303`	`+ this.attributes.fullName = name.startsWith(this.title + ' ')`
`304`	`304`	`? name.slice(this.title.length + 1)`
`305`	`305`	`: name;`
`306`	`306`	`}`