ember-data-resources 2.0.3 → 2.0.4

package/-private/resources/errors.d.ts

@@ -0,0 +1,3 @@
+export declare class IdRequiredError extends Error {
+    constructor(modelName: string);
+}

package/-private/resources/types.d.ts

@@ -1 +1 @@
-export declare type Id = string | number;
+export declare type Id = string | number | null | undefined;

package/.github/workflows/lint.yml

@@ -63,6 +63,28 @@ jobs:
   #       key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
   #   - run: yarn lint:docs-js
 
+  tooling:
+    if: "! contains(toJSON(github.event.commits.*.message), '[skip ci]')"
+    name: Tooling
+    runs-on: ubuntu-latest
+    needs: [install_dependencies]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: volta-cli/action@v1
+      - uses: actions/cache@v2
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
+
+      - name: Semantic Release
+        run: yarn semantic-release --dry-run
+        working-directory: ./ember-resources
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+
   commits:
     if: "! contains(toJSON(github.event.commits.*.message), '[skip ci]')"
     name: Commit Messages

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [2.0.4](https://github.com/NullVoxPopuli/ember-data-resources/compare/v2.0.3...v2.0.4) (2021-11-20)
+
+
+### Bug Fixes
+
+* **findRecord:** id falsey errors are now on the error property ([fc6e3f6](https://github.com/NullVoxPopuli/ember-data-resources/commit/fc6e3f67cc2978324056699f42d66cf67bd10fcf))
+
 ## [2.0.3](https://github.com/NullVoxPopuli/ember-data-resources/compare/v2.0.2...v2.0.3) (2021-11-15)
 
 

package/addon/-private/resources/errors.ts

@@ -0,0 +1,7 @@
+export class IdRequiredError extends Error {
+  constructor(modelName: string) {
+    super(
+      `While trying to request a resource from ${modelName}, the ID was either null or undefined, and the ID is required for fetching resources`
+    );
+  }
+}

package/addon/-private/resources/find-record.ts

@@ -2,6 +2,7 @@ import { tracked } from '@glimmer/tracking';
 import { isDestroyed, isDestroying } from '@ember/destroyable';
 import { action } from '@ember/object';
 
+import { IdRequiredError } from './errors';
 import { Request } from './request';
 
 import type { Id } from './types';
@@ -27,6 +28,17 @@ export class FindRecord<Model, LocalArgs extends Args = Args> extends Request<Lo
     let [modelName, id] = this.args.positional;
     let { options } = this.args.named;
 
+    /**
+     * ember-data forbids usage of invalid arguments
+     * in JS, this is typically fine as we can also try-catch, but
+     * since this *might* be used in a template as well as JS, we need to instead
+     * throw our own error that gives a bit more context to the user so
+     * they can pass in the correct arguments
+     */
+    if (id === null || id === undefined) {
+      throw new IdRequiredError(modelName);
+    }
+
     let record = await this.store.findRecord(modelName as never, id, options);
 
     if (isDestroyed(this) || isDestroying(this)) return;

package/addon/-private/resources/types.ts

@@ -1 +1 @@
-export type Id = string | number;
+export type Id = string | number | null | undefined;

package/addon/index.ts

@@ -1,6 +1,4 @@
 /* eslint-disable @typescript-eslint/ban-types */
-import { assert } from '@ember/debug';
-
 import { useResource } from 'ember-resources';
 
 import { FindAll } from './-private/resources/find-all';
@@ -34,8 +32,6 @@ export function findRecord<Model = unknown>(
       options = options[1] || {};
     }
 
-    assert(`Expected an ID to be specified from the thunk passed to findRecord`, id);
-
     return {
       positional: [modelName, id],
       named: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-data-resources",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "Resource helpers for reactively (re)fetching data with ember-data",
   "keywords": [
     "ember-addon"
@@ -37,13 +37,13 @@
     "ember-resources": "^4.0.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "^13.2.1",
-    "@commitlint/config-conventional": "^13.2.0",
+    "@commitlint/cli": "^14.1.0",
+    "@commitlint/config-conventional": "^14.1.0",
     "@ember/optional-features": "^2.0.0",
     "@ember/test-helpers": "^2.6.0",
     "@embroider/test-setup": "^0.47.2",
     "@glimmer/component": "^1.0.4",
-    "@nullvoxpopuli/eslint-configs": "^2.1.3",
+    "@nullvoxpopuli/eslint-configs": "^2.1.5",
     "@semantic-release/changelog": "^5.0.1",
     "@semantic-release/git": "^9.0.1",
     "@types/ember-data__model": "^3.16.2",
@@ -70,6 +70,8 @@
     "@types/htmlbars-inline-precompile": "^1.0.1",
     "@types/qunit": "^2.11.2",
     "@types/rsvp": "^4.0.4",
+    "@typescript-eslint/eslint-plugin": "^5.4.0",
+    "@typescript-eslint/parser": "^5.4.0",
     "babel-eslint": "^10.1.0",
     "broccoli-asset-rev": "^3.0.0",
     "ember-cli": "~3.28.4",
@@ -86,16 +88,19 @@
     "ember-page-title": "^7.0.0",
     "ember-qunit": "^5.1.5",
     "ember-resolver": "^8.0.3",
-    "ember-source": "~3.28.6",
+    "ember-source": "~4.0.0",
     "ember-source-channel-url": "^3.0.0",
     "ember-template-lint": "^3.13.0",
     "ember-try": "^2.0.0",
-    "eslint": "^7.32.0",
+    "eslint": "^7.0.0",
     "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-decorator-position": "^4.0.1",
     "eslint-plugin-ember": "^10.5.7",
+    "eslint-plugin-import": "^2.25.3",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-qunit": "^6.2.0",
+    "eslint-plugin-qunit": "^7.1.0",
+    "eslint-plugin-simple-import-sort": "^7.0.0",
     "loader.js": "^4.7.0",
     "msw": "^0.35.0",
     "npm-run-all": "^4.1.5",
@@ -104,7 +109,7 @@
     "qunit-dom": "^2.0.0",
     "semantic-release": "^17.4.7",
     "typescript": "^4.4.4",
-    "webpack": "^5.64.0"
+    "webpack": "^5.64.1"
   },
   "peerDependencies": {
     "ember-data": "^3.25.0"