feat: upstream release/0.x to main (#157)

## Docs 
* docs: fix incorrect info 
* docs: added recipe 
  * Example on how to extend the model 
* docs(services): updated ApiResponseHandler signatures 
  Changes missed in: 
  1e0b58f 
* docs: added remote pagination to recipes 
* docs: clarified back-end compatibility 
* docs: extended recipe with static method 
* docs: simplified examples 
* docs: added supporter section 
* docs: added clarifications 
* docs: added typescript tip for ApiResponse 
  * Showed how to use module augmentation to extend the ApiResponse 
* docs: added reference to module augmentation docs 
* docs: added clarification 
* docs(attributes): added missing comma 
* docs: updated cookbook example to be more comprehensive 
 
 
## Chore 
* chore: converted todo into an issue 
* chore: fixed .gitignore targeting 
* chore(deps-dev): updated dependencies 
  * @semantic-release/git 
  * @types/semantic-release 
  * eslint-plugin-import 
  * rollup 
  * typedoc 
* chore: incremented version 
* chore: fixed incorrect bug report yml file 
* chore: added pull request template 
* chore: added search terms to the bug report template 
* chore: moved todo out into an issue 
  * linked @upfrontjs/framework#151 
* chore(deps-dev): updated non breaking dependencies 
  * typescript 
  * typedoc 
  * rollup 
  * semantic-release 
  * @types/lodash 
  * @types/uuid 
* chore(deps-dev): updated breaking dependencies 
  * @typescript-eslint/eslint-plugin 
  * @typescript-eslint/parser 
  * eslint 
  * eslint-plugin-jest 
  * @commitlint/config-conventional 
  * @commitlint/prompt-cli 
  * @commitlint/types 
  * lint-staged 
* chore(deps-dev): updated dependencies 
  * @typescript-eslint/eslint-plugin 
  * @typescript-eslint/parser 
  * eslint 
  * qs 
  * rollup 
  * commitlint 
* chore(deps-dev): lock typescript to 4.4.4 
  * Locking for the time being as 4.5.2 breaks the global config set typing. 
  * The type is meant to be widened by the passed in value but, 
  * on get it reckons it's an unknown value 
## Feature 
* feat(query-builder): widened `formatQueryParameters` argument's type  
  * added string indexing to allow arbitrary values to be assigned to `parameters` argument 
* feat(api-calls): added type argument to handle and call methods 
* feat(services)!: updated handling of non 200 responses 
  * Throw response/error on client and server errors 
  * Ignore informational, redirect and no content responses 
* feat(api-calls): added data unwrapping 
* feat(query-builder): added `page` method 
* feat(query-builder): hardened type handling of numeric query parameters 
* feat: added more utility types 
  * Added KeysMatching and KeysNotMatching types 
* feat(global-config): updated type argument to accept arbitrary values 
* feat(attributes): added type support for keys defined on the model 
* feat(attributes): added missing type arguments 
  * 7cf3ca6 
* feat(api-calls)!: set _lastSyncedAt to cast to the set datetime value 
* feat: wip - worked on type inference of attributes 
* feat: added type arguments where applicable 
* feat!: updated `Jsonable` to return a json as opposed to string 
  * The naming intended to return a json not a string. 
  * Stringified version is only meant for saving or transferring data 
* feat(internal): added type arguments to methods in ModelCollection 
* feat(model): added toString method to the model 
  * This will give a understandable format when juggling types 
* feat: added UnionToIntersection helper type 
* feat(query-builder): added type argument for static methods 
* feat(attributes): added `setServerStringCase` internal helper 
* feat(api-calls)!: moved data unwrapping into dedicated method 
  * This way the user gets the the raw response exposed while utilising the model's call method 
  * Furthermore as this is now public and all methods called them anyways, 
  * moved the resetEndpoint and resetQueryParameters methods into the call method 
* feat(model): added `new` method 
  * With this the user don't have to leave the model to construct a new instance. 
 
## Test 
* test(internal): simplified test response customisation 
* test: increased test coverage 
* test(events): increased test coverage of EventEmitter 
* test: fixed type-hinting in test 
* test: fixed failing query building tests 
* test: fixed failing type in test 
 
#Refactor 
* refactor(internal): simplified getting the response model 
* refactor(attributes)!: from casting method removed attributes argument 
  * Technically breaking change but it's is considered an internal method. 
* refactor(attributes): simplified date time casting 
  * casting to date time logic has been moved into a single method 
  * Furthermore, when using the built in Date, an error will be thrown on invalid values 
* refactor(helpers)!: renamed `isConstructableUserClass` function 
  * `isUserLandClass` seems shorter while keeping the meaning 
* refactor(events): updated to use built-in Parameters type 
 
## Fix 
* fix(services)!: removed data unwrapping from `ApiResponseHandler` 
  * Response may include other keys such as `links`, `meta` 
  and with the previous logic this would have been lost 
* fix(timestamps): access attribute name dynamically 
  * Updated accessing timestamp names from class reference to constructor reference 
* fix(attributes): `set` on AttributeCaster have to return a value 
  * This isn't a breaking change as `void` is assignable to `unknown`   
* fix(attributes)!: set index signature to `unknown` 
  * Harden the user's type safety by updating from any to unknown 
* fix(attributes): resolved remaining typing issues 
  * Fixed lingering issues missed in: 
  * 66f5631 
* fix!: fix `getName` returning wrong value after mangling for production 
  * This isn't a breaking change but marking as such so people who do keep up with the release notes 
    will not accidentally skim over it. 
* fix: removed unnecessary properties from ApiResponse type 
  * This might be breaking typing for people using non-null assertion on Response properties 
* fix!: remove redundant ExtractArguments type 
  * This is can be replaced by the built-in Parameters type 
* fix(query-builder)!: updated built-in column name casting 
  * Fixed the column names to be in the expected serverAttributeCasing 
 
## Continuous Integration 
* ci: adjust names and remove redundant cache actions 
* ci: ensure package is tested on the latest and LTS versions 
* ci: removed unnecessary argument 
* ci: run tests run on package updates too 
* ci: renamed action's name 
* ci: added api docs deployment action 
* ci: ensure both commit messages and PR titles are linted 
 
## Performance 
* perf(model): improved `replicate` logic 
  * with 1 warm up run, over 4 tries with 100,000 loops the average time: 
  * with arguments: decreased by 177ms 
  * without arguments: increased 20.75ms 
 
## Style 
* style(attributes): removed unused code

Author: nandi95

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -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:

.github/pull_request_template.md

@@ -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.
+

.github/semantic.yml

@@ -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

.github/workflows/automerge.yml

@@ -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

.github/workflows/build.yml

@@ -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

.github/workflows/commitlint.yml

@@ -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

.github/workflows/deploy-api-docs.yml

@@ -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

.github/workflows/lint.yml

@@ -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

.github/workflows/test.yml

@@ -4,7 +4,7 @@ index.*.js*
 array.*.js*
 string.*.js*
 types
-.tgz
+*.tgz
 
 # testing
 tests/cache/