ember-data-resources 3.0.3 → 4.0.0

package/-private/find.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=find.d.ts.map

package/-private/query.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=query.d.ts.map

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

@@ -4,3 +4,4 @@ export declare class IdRequiredError extends TypeError {
 export declare class IdTypeError extends TypeError {
     constructor(modelName: string, id: unknown);
 }
+//# sourceMappingURL=errors.d.ts.map

package/-private/resources/find-all.d.ts

@@ -12,7 +12,8 @@ export interface Args {
 }
 export declare class FindAll<Model, LocalArgs extends Args = Args> extends Request<LocalArgs> {
     private _records;
-    __WRAPPED_FUNCTION__(): Promise<void>;
+    __WRAPPED_FUNCTION__([modelName]: PositionalArgs, { options }: NamedArgs): Promise<void>;
     get records(): ArrayProxy<Model> | undefined;
 }
 export {};
+//# sourceMappingURL=find-all.d.ts.map

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

@@ -12,7 +12,8 @@ export interface Args {
 }
 export declare class FindRecord<Model, LocalArgs extends Args = Args> extends Request<LocalArgs> {
     private _record;
-    __WRAPPED_FUNCTION__(): Promise<void>;
+    __WRAPPED_FUNCTION__([modelName, id]: PositionalArgs, { options }: NamedArgs): Promise<void>;
     get record(): Model | undefined;
 }
 export {};
+//# sourceMappingURL=find-record.d.ts.map

package/-private/resources/query-record.d.ts

@@ -13,7 +13,8 @@ export interface Args {
 }
 export declare class QueryRecord<Model, LocalArgs extends Args = Args> extends Request<LocalArgs> {
     private _record;
-    __WRAPPED_FUNCTION__(): Promise<void>;
+    __WRAPPED_FUNCTION__([modelName, query]: PositionalArgs, { options }: NamedArgs): Promise<void>;
     get record(): Model | undefined;
 }
 export {};
+//# sourceMappingURL=query-record.d.ts.map

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

@@ -14,7 +14,8 @@ export interface Args {
 }
 export declare class Query<Model, LocalArgs extends Args = Args> extends Request<LocalArgs> {
     private _records;
-    __WRAPPED_FUNCTION__(): Promise<void>;
+    __WRAPPED_FUNCTION__([modelName, query]: PositionalArgs, { options }: NamedArgs): Promise<void>;
     get records(): ArrayProxy<Model> | undefined;
 }
 export {};
+//# sourceMappingURL=query.d.ts.map

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

@@ -1,18 +1,24 @@
 import { Resource } from 'ember-resources';
 import type Store from '@ember-data/store';
+import type { ExpandArgs } from 'ember-resources';
 export declare type FindRecordOptions = Parameters<Store['findRecord']>[2];
 export declare class Request<Args> extends Resource<Args> {
-    args: Args;
     store: Store;
     error: Error | undefined;
     isLoading: boolean;
     hasRan: boolean;
-    constructor(owner: unknown, args: Args, previous?: Request<Args>);
-    __WRAPPED_FUNCTION__(): Promise<void>;
+    /**
+     * Args saved, untracked, for retrying
+     */
+    positional: ExpandArgs<Args>['Positional'];
+    named: ExpandArgs<Args>['Named'];
+    modify(positional: ExpandArgs<Args>['Positional'], named: ExpandArgs<Args>['Named']): void;
+    __WRAPPED_FUNCTION__(_positional: ExpandArgs<Args>['Positional'], _named: ExpandArgs<Args>['Named']): Promise<void>;
     get isSuccess(): boolean;
     get isError(): boolean;
     get records(): unknown | undefined;
     get record(): unknown | undefined;
     retry(): Promise<void>;
-    __REQUEST_FUNCTION__(): Promise<void>;
+    __REQUEST_FUNCTION__(_positional: ExpandArgs<Args>['Positional'], _named: ExpandArgs<Args>['Named']): Promise<void>;
 }
+//# sourceMappingURL=request.d.ts.map

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

@@ -1 +1,2 @@
 export declare type Id = string | number | null | undefined;
+//# sourceMappingURL=types.d.ts.map

package/CHANGELOG.md

@@ -1,3 +1,39 @@
+# [4.0.0](https://github.com/NullVoxPopuli/ember-data-resources/compare/v3.0.6...v4.0.0) (2022-08-27)
+
+
+### chore
+
+* upgrade to ember-resources v5 ([0ffab7a](https://github.com/NullVoxPopuli/ember-data-resources/commit/0ffab7aa8b9d018942540c7d7d25138f89368dfa))
+
+
+### BREAKING CHANGES
+
+*  - minimum version of `@glimmer/component` is now `1.1.2`
+ - minimum version of `ember-source` is now `3.28`
+ - `@glint/template` is required for type-checking (if you use
+   typescript)
+
+## [3.0.6](https://github.com/NullVoxPopuli/ember-data-resources/compare/v3.0.5...v3.0.6) (2022-02-04)
+
+
+### Bug Fixes
+
+* **deps:** update dependency ember-cli-typescript to v5 ([58e4e91](https://github.com/NullVoxPopuli/ember-data-resources/commit/58e4e91bec621274658801435aaa1fc19b0e20f9))
+
+## [3.0.5](https://github.com/NullVoxPopuli/ember-data-resources/compare/v3.0.4...v3.0.5) (2022-02-03)
+
+
+### Bug Fixes
+
+* **deps:** update dependency ember-resources to ^4.3.0 ([7fda73e](https://github.com/NullVoxPopuli/ember-data-resources/commit/7fda73e4a94abefe225e0041846a662ce4ea9a5f))
+
+## [3.0.4](https://github.com/NullVoxPopuli/ember-data-resources/compare/v3.0.3...v3.0.4) (2022-01-31)
+
+
+### Bug Fixes
+
+* **deps:** update dependency ember-resources to ^4.2.0 ([7d202b8](https://github.com/NullVoxPopuli/ember-data-resources/commit/7d202b8ad378e47af8bfb08c21eb0909935ee80e))
+
 ## [3.0.3](https://github.com/NullVoxPopuli/ember-data-resources/compare/v3.0.2...v3.0.3) (2022-01-21)
 
 

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

@@ -23,10 +23,7 @@ export class FindAll<Model, LocalArgs extends Args = Args> extends Request<Local
   @tracked private _records: ArrayProxy<Model> | undefined;
 
   @action
-  async __WRAPPED_FUNCTION__() {
-    let [modelName] = this.args.positional;
-    let { options } = this.args.named;
-
+  async __WRAPPED_FUNCTION__([modelName]: PositionalArgs, { options }: NamedArgs) {
     let records = await this.store.findAll(modelName as never, options);
 
     if (isDestroyed(this) || isDestroying(this)) return;

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

@@ -1,6 +1,7 @@
 import { tracked } from '@glimmer/tracking';
 import { isDestroyed, isDestroying } from '@ember/destroyable';
 import { action } from '@ember/object';
+import { waitFor } from '@ember/test-waiters';
 
 import { IdRequiredError, IdTypeError } from './errors';
 import { Request } from './request';
@@ -24,10 +25,8 @@ export class FindRecord<Model, LocalArgs extends Args = Args> extends Request<Lo
   @tracked private _record: Model | undefined;
 
   @action
-  async __WRAPPED_FUNCTION__() {
-    let [modelName, id] = this.args.positional;
-    let { options } = this.args.named;
-
+  @waitFor
+  async __WRAPPED_FUNCTION__([modelName, id]: PositionalArgs, { options }: NamedArgs) {
     /**
      * ember-data forbids usage of invalid arguments
      * in JS, this is typically fine as we can also try-catch, but

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

@@ -24,10 +24,7 @@ export class QueryRecord<Model, LocalArgs extends Args = Args> extends Request<L
   @tracked private _record: Model | undefined;
 
   @action
-  async __WRAPPED_FUNCTION__() {
-    let [modelName, query] = this.args.positional;
-    let { options } = this.args.named;
-
+  async __WRAPPED_FUNCTION__([modelName, query]: PositionalArgs, { options }: NamedArgs) {
     let record = await this.store.queryRecord(modelName as never, query, options);
 
     if (isDestroyed(this) || isDestroying(this)) return;

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

@@ -25,10 +25,7 @@ export class Query<Model, LocalArgs extends Args = Args> extends Request<LocalAr
   @tracked private _records: ArrayProxy<Model> | undefined;
 
   @action
-  async __WRAPPED_FUNCTION__() {
-    let [modelName, query] = this.args.positional;
-    let { options } = this.args.named;
-
+  async __WRAPPED_FUNCTION__([modelName, query]: PositionalArgs, { options }: NamedArgs) {
     let records = await this.store.query(modelName as never, query, options);
 
     if (isDestroyed(this) || isDestroying(this)) return;

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

@@ -8,26 +8,42 @@ import { waitFor, waitForPromise } from '@ember/test-waiters';
 import { Resource } from 'ember-resources';
 
 import type Store from '@ember-data/store';
-import type { ArgsWrapper } from 'ember-resources';
+import type { ExpandArgs } from 'ember-resources';
 
 export type FindRecordOptions = Parameters<Store['findRecord']>[2];
 
 export class Request<Args> extends Resource<Args> {
-  declare args: Args;
-
   @service declare store: Store;
 
   @tracked error: Error | undefined;
   @tracked isLoading = false;
   @tracked hasRan = false;
 
-  constructor(owner: unknown, args: Args, previous?: Request<Args>) {
-    super(owner, args, previous);
-
-    this.__REQUEST_FUNCTION__();
+  /**
+   * Args saved, untracked, for retrying
+   */
+  declare positional: ExpandArgs<Args>['Positional'];
+  declare named: ExpandArgs<Args>['Named'];
+
+  modify(positional: ExpandArgs<Args>['Positional'], named: ExpandArgs<Args>['Named']) {
+    this.positional = positional;
+    this.named = named;
+
+    /**
+     * We need to consume all arguments here so that we correctly respond to updates to
+     * dirtied source data.
+     *
+     * e.g.: when an id changes that is passed to findRecord, we re-fetch.
+     */
+    this.__REQUEST_FUNCTION__([...(positional as unknown[])] as ExpandArgs<Args>['Positional'], {
+      ...named,
+    });
   }
 
-  async __WRAPPED_FUNCTION__() {
+  async __WRAPPED_FUNCTION__(
+    _positional: ExpandArgs<Args>['Positional'],
+    _named: ExpandArgs<Args>['Named']
+  ) {
     throw new Error('Not Implemented');
   }
 
@@ -54,14 +70,19 @@ export class Request<Args> extends Resource<Args> {
   }
 
   @action async retry() {
-    return waitForPromise(this.__WRAPPED_FUNCTION__());
+    return waitForPromise(this.__WRAPPED_FUNCTION__(this.positional, this.named));
   }
 
   @action
   @waitFor
-  async __REQUEST_FUNCTION__() {
-    consumeEverything(this.args);
-
+  async __REQUEST_FUNCTION__(
+    _positional: ExpandArgs<Args>['Positional'],
+    _named: ExpandArgs<Args>['Named']
+  ) {
+    /**
+     * Args are already consumed, but let's delay doing anything
+     * until we can get out of a tracking frame.
+     */
     await Promise.resolve();
 
     if (isDestroyed(this) || isDestroying(this)) return;
@@ -74,7 +95,12 @@ export class Request<Args> extends Resource<Args> {
     } catch (e) {
       if (isDestroyed(this) || isDestroying(this)) return;
 
-      this.error = e;
+      if (e instanceof Error) {
+        this.error = e;
+      } else {
+        // How likely is this to happen?
+        throw e;
+      }
     }
 
     if (isDestroyed(this) || isDestroying(this)) {
@@ -85,16 +111,3 @@ export class Request<Args> extends Resource<Args> {
     this.hasRan = true;
   }
 }
-
-/**
- * Helper function to bind all arguments to the lifecycle of the resource
- */
-function consumeEverything(args: ArgsWrapper) {
-  for (let i = 0; i < (args.positional?.length || 0); i++) {
-    args.positional?.[i];
-  }
-
-  for (let key in args.named || {}) {
-    args.named?.[key];
-  }
-}

package/addon/js-helpers.ts

@@ -1,6 +1,4 @@
 /* eslint-disable @typescript-eslint/ban-types */
-import { useResource } from 'ember-resources';
-
 import { FindAll } from './-private/resources/find-all';
 import { FindRecord } from './-private/resources/find-record';
 import { Query } from './-private/resources/query';
@@ -19,7 +17,7 @@ export function findRecord<Model = unknown>(
   modelName: string,
   thunk: () => FindRecordThunkResult
 ) {
-  return useResource<FindRecord<Model>>(destroyable, FindRecord, () => {
+  return FindRecord.from(destroyable, () => {
     let reified = thunk();
     let id: Id;
     let options: FindRecordOptions;
@@ -38,7 +36,8 @@ export function findRecord<Model = unknown>(
         options,
       },
     };
-  });
+    // Cast needed Until min-supported TS is 4.7
+  }) as FindRecord<Model>;
 }
 
 type FindAllThunkResult = { options: FindAllOptions } | FindAllOptions | void;
@@ -48,7 +47,7 @@ export function findAll<Model = unknown>(
   modelName: string,
   thunk?: () => FindAllThunkResult
 ) {
-  return useResource<FindAll<Model>>(destroyable, FindAll, () => {
+  return FindAll.from(destroyable, () => {
     let reified = thunk?.() || {};
     let options = 'options' in reified ? reified.options : reified;
 
@@ -58,7 +57,8 @@ export function findAll<Model = unknown>(
         options,
       },
     };
-  });
+    // Cast needed Until min-supported TS is 4.7
+  }) as FindAll<Model>;
 }
 
 type QueryThunkResult = QueryQuery | [QueryQuery] | [QueryQuery, QueryOptions];
@@ -68,7 +68,7 @@ export function query<Model = unknown>(
   modelName: string,
   thunk: () => QueryThunkResult
 ) {
-  return useResource<Query<Model>>(destroyable, Query, () => {
+  return Query.from(destroyable, () => {
     let reified = thunk();
 
     if (Array.isArray(reified)) {
@@ -88,7 +88,8 @@ export function query<Model = unknown>(
         options: {},
       },
     };
-  });
+    // Cast needed Until min-supported TS is 4.7
+  }) as Query<Model>;
 }
 
 type QueryRecordThunkResult =
@@ -101,7 +102,7 @@ export function queryRecord<Model = unknown>(
   modelName: string,
   thunk: () => QueryRecordThunkResult
 ) {
-  return useResource<QueryRecord<Model>>(destroyable, QueryRecord, () => {
+  return QueryRecord.from(destroyable, () => {
     let reified = thunk();
 
     if (Array.isArray(reified)) {
@@ -121,5 +122,6 @@ export function queryRecord<Model = unknown>(
         options: {},
       },
     };
-  });
+    // Cast needed Until min-supported TS is 4.7
+  }) as QueryRecord<Model>;
 }

package/index.d.ts

@@ -3,3 +3,4 @@ export { FindRecord } from './-private/resources/find-record';
 export { Query } from './-private/resources/query';
 export { QueryRecord } from './-private/resources/query-record';
 export { findAll, findRecord, query, queryRecord } from './js-helpers';
+//# sourceMappingURL=index.d.ts.map

package/js-helpers.d.ts

@@ -18,3 +18,4 @@ export declare function query<Model = unknown>(destroyable: object, modelName: s
 declare type QueryRecordThunkResult = QueryRecordQuery | [QueryRecordQuery] | [QueryRecordQuery, QueryRecordOptions];
 export declare function queryRecord<Model = unknown>(destroyable: object, modelName: string, thunk: () => QueryRecordThunkResult): QueryRecord<Model, import("./-private/resources/query-record").Args>;
 export {};
+//# sourceMappingURL=js-helpers.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-data-resources",
-  "version": "3.0.3",
+  "version": "4.0.0",
   "description": "Resource helpers for reactively (re)fetching data with ember-data",
   "keywords": [
     "ember-addon"
@@ -33,49 +33,56 @@
     "ember-auto-import": "^2.4.0",
     "ember-cli-babel": "^7.26.11",
     "ember-cli-htmlbars": "^6.0.1",
-    "ember-cli-typescript": "^4.2.1",
-    "ember-resources": "^4.1.3"
+    "ember-cli-typescript": "^5.1.0",
+    "ember-resources": "^5.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^16.0.2",
-    "@commitlint/config-conventional": "^16.0.0",
+    "@commitlint/cli": "^16.2.3",
+    "@commitlint/config-conventional": "^16.2.1",
     "@ember/optional-features": "^2.0.0",
-    "@ember/test-helpers": "^2.6.0",
+    "@ember/test-helpers": "^2.8.1",
     "@embroider/test-setup": "^1.0.0",
     "@glimmer/component": "^1.0.4",
-    "@nullvoxpopuli/eslint-configs": "^2.1.18",
+    "@glint/template": "^0.9.2",
+    "@nullvoxpopuli/eslint-configs": "^2.2.7",
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/git": "^10.0.1",
-    "@types/ember-data__model": "^3.16.2",
-    "@types/ember-data__store": "^3.16.1",
-    "@types/ember-qunit": "^3.4.15",
-    "@types/ember-resolver": "^5.0.10",
-    "@types/ember__application": "^3.16.3",
-    "@types/ember__array": "^3.16.4",
-    "@types/ember__component": "^3.16.6",
-    "@types/ember__controller": "^3.16.6",
-    "@types/ember__debug": "^3.16.5",
-    "@types/ember__engine": "^3.16.3",
-    "@types/ember__error": "^3.16.1",
-    "@types/ember__object": "^3.12.6",
-    "@types/ember__polyfills": "^3.12.1",
-    "@types/ember__routing": "^3.16.15",
-    "@types/ember__runloop": "^3.16.3",
-    "@types/ember__service": "^3.16.1",
-    "@types/ember__string": "^3.16.3",
-    "@types/ember__template": "^3.16.1",
-    "@types/ember__test": "^3.16.1",
-    "@types/ember__test-helpers": "^2.6.0",
-    "@types/ember__utils": "^3.16.2",
-    "@types/htmlbars-inline-precompile": "^1.0.1",
-    "@types/qunit": "^2.11.3",
+    "@types/ember": "^4.0.0",
+    "@types/ember-data": "^4.4.1",
+    "@types/ember-data__adapter": "^4.0.0",
+    "@types/ember-data__model": "^4.0.0",
+    "@types/ember-data__serializer": "^4.0.0",
+    "@types/ember-data__store": "^4.0.0",
+    "@types/ember-qunit": "^5.0.0",
+    "@types/ember-resolver": "^5.0.11",
+    "@types/ember__application": "^4.0.1",
+    "@types/ember__array": "^4.0.2",
+    "@types/ember__component": "^4.0.10",
+    "@types/ember__controller": "^4.0.1",
+    "@types/ember__debug": "^4.0.1",
+    "@types/ember__destroyable": "^4.0.0",
+    "@types/ember__engine": "^4.0.2",
+    "@types/ember__error": "^4.0.0",
+    "@types/ember__object": "^4.0.4",
+    "@types/ember__polyfills": "^4.0.0",
+    "@types/ember__routing": "^4.0.10",
+    "@types/ember__runloop": "^4.0.1",
+    "@types/ember__service": "^4.0.0",
+    "@types/ember__string": "^3.0.9",
+    "@types/ember__template": "^4.0.0",
+    "@types/ember__test": "^4.0.0",
+    "@types/ember__test-helpers": "^2.8.1",
+    "@types/ember__utils": "^4.0.0",
+    "@types/htmlbars-inline-precompile": "^3.0.0",
+    "@types/qunit": "^2.19.2",
     "@types/rsvp": "^4.0.4",
-    "@typescript-eslint/eslint-plugin": "^5.9.1",
-    "@typescript-eslint/parser": "^5.9.1",
+    "@typescript-eslint/eslint-plugin": "^5.15.0",
+    "@typescript-eslint/parser": "^5.15.0",
     "babel-eslint": "^10.1.0",
     "broccoli-asset-rev": "^3.0.0",
-    "ember-cli": "~4.1.0",
-    "ember-cli-dependency-checker": "^3.2.0",
+    "ember-cli": "~4.6.0",
+    "ember-cli-dependency-checker": "^3.3.1",
+    "ember-cli-deprecation-workflow": "^2.1.0",
     "ember-cli-inject-live-reload": "^2.1.0",
     "ember-cli-sri": "^2.1.1",
     "ember-cli-terser": "^4.0.2",
@@ -90,26 +97,26 @@
     "ember-resolver": "^8.0.3",
     "ember-source": "~4.1.0",
     "ember-source-channel-url": "^3.0.0",
-    "ember-template-lint": "^3.16.0",
+    "ember-template-lint": "^4.3.0",
     "ember-try": "^2.0.0",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.3.0",
+    "eslint": "^7.0.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-decorator-position": "^4.0.1",
-    "eslint-plugin-ember": "^10.5.8",
+    "eslint-plugin-ember": "^10.5.9",
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-qunit": "^7.2.0",
     "eslint-plugin-simple-import-sort": "^7.0.0",
     "loader.js": "^4.7.0",
-    "msw": "^0.36.5",
+    "msw": "^0.36.8",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.5.1",
-    "qunit": "^2.17.2",
+    "prettier": "^2.7.1",
+    "qunit": "^2.19.1",
     "qunit-dom": "^2.0.0",
     "semantic-release": "^19.0.2",
-    "typescript": "^4.5.5",
-    "webpack": "^5.66.0"
+    "typescript": "~4.7.0",
+    "webpack": "^5.74.0"
   },
   "peerDependencies": {
     "ember-data": "^3.25.0"
@@ -130,7 +137,7 @@
   },
   "volta": {
     "node": "16.13.2",
-    "yarn": "1.22.17"
+    "yarn": "1.22.18"
   },
   "engines": {
     "node": "14.* || >= 16"

package/tsconfig.json

@@ -1,25 +1,70 @@
 {
   "compilerOptions": {
-    "target": "es2020",
-    "allowJs": true,
+    "target": "ES2021",
+    "module": "ES2020",
     "moduleResolution": "node",
-    "allowSyntheticDefaultImports": true,
-    "noImplicitAny": true,
-    "noImplicitThis": true,
-    "alwaysStrict": true,
-    "strictNullChecks": true,
-    "strictPropertyInitialization": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noImplicitReturns": true,
+
+    // Trying to check Ember apps and addons with `allowJs: true` is a recipe
+    // for many unresolveable type errors, because with *considerable* extra
+    // configuration it ends up including many files which are *not* valid and
+    // cannot be: they *appear* to be resolve-able to TS, but are in fact not in
+    // valid Node-resolveable locations and may not have TS-ready types. This
+    // will likely improve over time
+    "allowJs": false,
+
+    // --- TS for SemVer Types compatibility
+    // Strictness settings -- you should *not* change these: Ember code is not
+    // guaranteed to type check with these set to looser values.
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+
+    // Interop: these are viral and will require anyone downstream of your
+    // package to *also* set them to true. If you *must* enable them to consume
+    // an upstream package, you should document that for downstream consumers to
+    // be aware of.
+    //
+    // These *are* safe for apps to enable, since they do not *have* downstream
+    // consumers; but leaving them off is still preferred when possible, since
+    // it makes it easier to switch between apps and addons and have the same
+    // rules for what can be imported and how.
+    "allowSyntheticDefaultImports": false,
+    "esModuleInterop": false,
+
+    // --- Lint-style rules
+
+    // TypeScript also supplies some lint-style checks; nearly all of them are
+    // better handled by ESLint with the `@typescript-eslint`. This one is more
+    // like a safety check, though, so we leave it on.
+    "noPropertyAccessFromIndexSignature": true,
+
+    // --- Compilation/integration settings
+    // Setting `noEmitOnError` here allows ember-cli-typescript to catch errors
+    // and inject them into Ember CLI's build error reporting, which provides
+    // nice feedback for when
     "noEmitOnError": false,
+
+    // We use Babel for emitting runtime code, because it's very important that
+    // we always and only use the same transpiler for non-stable features, in
+    // particular decorators. If you were to change this to `true`, it could
+    // lead to accidentally generating code with `tsc` instead of Babel, and
+    // could thereby result in broken code at runtime.
     "noEmit": true,
+
+    // Ember makes heavy use of decorators; TS does not support them at all
+    // without this flag.
+    "experimentalDecorators": true,
+
+    // Support generation of source maps. Note: you must *also* enable source
+    // maps in your `ember-cli-babel` config and/or `babel.config.js`.
+    "declaration": true,
+    "declarationMap": true,
     "inlineSourceMap": true,
     "inlineSources": true,
+
+    // The combination of `baseUrl` with `paths` allows Ember's classic package
+    // layout, which is not resolveable with the Node resolution algorithm, to
+    // work with TypeScript.
     "baseUrl": ".",
-    "module": "es6",
-    "experimentalDecorators": true,
     "paths": {
       "dummy/tests/*": [
         "tests/*"

package/types/ember-data/types/registries/model.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Catch-all for ember-data.
+ */
+export default interface ModelRegistry {
+  [key: string]: any;
+}