ember-data-resources 4.0.4 → 5.1.0

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

@@ -1,113 +0,0 @@
-import { tracked } from '@glimmer/tracking';
-import { assert } from '@ember/debug';
-import { isDestroyed, isDestroying } from '@ember/destroyable';
-import { action } from '@ember/object';
-import { inject as service } from '@ember/service';
-import { waitFor, waitForPromise } from '@ember/test-waiters';
-
-import { Resource } from 'ember-resources';
-
-import type Store from '@ember-data/store';
-import type { ExpandArgs } from 'ember-resources';
-
-export type FindRecordOptions = Parameters<Store['findRecord']>[2];
-
-export class Request<Args> extends Resource<Args> {
-  @service declare store: Store;
-
-  @tracked error: Error | undefined;
-  @tracked isLoading = false;
-  @tracked hasRan = false;
-
-  /**
-   * 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__(
-    _positional: ExpandArgs<Args>['Positional'],
-    _named: ExpandArgs<Args>['Named']
-  ) {
-    throw new Error('Not Implemented');
-  }
-
-  get isSuccess() {
-    return !this.error;
-  }
-
-  get isError() {
-    return Boolean(this.error);
-  }
-
-  get records(): unknown | undefined {
-    return assert(
-      `The resource for ${this.constructor.name} does not have a records property. ` +
-        `You might be looking for .record instead.`
-    );
-  }
-
-  get record(): unknown | undefined {
-    return assert(
-      `The resource for ${this.constructor.name} does not have a record property. ` +
-        `You might be looking for .records instead.`
-    );
-  }
-
-  @action async retry() {
-    return waitForPromise(this.__WRAPPED_FUNCTION__(this.positional, this.named));
-  }
-
-  @action
-  @waitFor
-  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;
-
-    this.error = undefined;
-    this.isLoading = true;
-
-    try {
-      await this.retry();
-    } catch (e) {
-      if (isDestroyed(this) || isDestroying(this)) return;
-
-      if (e instanceof Error) {
-        this.error = e;
-      } else {
-        // How likely is this to happen?
-        throw e;
-      }
-    }
-
-    if (isDestroyed(this) || isDestroying(this)) {
-      return;
-    }
-
-    this.isLoading = false;
-    this.hasRan = true;
-  }
-}

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

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

package/addon/index.ts

@@ -1,10 +0,0 @@
-// For direct use in templates' strict Mode
-// for loose mode, these don't need to be imported, and are resolveable via
-// the lower-kebab-case variant of each of these names
-export { FindAll } from './-private/resources/find-all';
-export { FindRecord } from './-private/resources/find-record';
-export { Query } from './-private/resources/query';
-export { QueryRecord } from './-private/resources/query-record';
-
-// Resource wrappers in JS/TS classes
-export { findAll, findRecord, query, queryRecord } from './js-helpers';

package/addon/js-helpers.ts

@@ -1,127 +0,0 @@
-/* eslint-disable @typescript-eslint/ban-types */
-import { FindAll } from './-private/resources/find-all';
-import { FindRecord } from './-private/resources/find-record';
-import { Query } from './-private/resources/query';
-import { QueryRecord } from './-private/resources/query-record';
-
-import type { FindAllOptions } from './-private/resources/find-all';
-import type { FindRecordOptions } from './-private/resources/find-record';
-import type { QueryOptions, QueryQuery } from './-private/resources/query';
-import type { QueryRecordOptions, QueryRecordQuery } from './-private/resources/query-record';
-import type { Id } from './-private/resources/types';
-
-type FindRecordThunkResult = Id | [Id] | [Id, FindRecordOptions];
-
-export function findRecord<Model = unknown>(
-  destroyable: object,
-  modelName: string,
-  thunk: () => FindRecordThunkResult
-) {
-  return FindRecord.from(destroyable, () => {
-    let reified = thunk();
-    let id: Id;
-    let options: FindRecordOptions;
-
-    if (Array.isArray(reified)) {
-      id = reified[0];
-      options = reified[1] ?? {};
-    } else {
-      id = reified as Id;
-      options = {};
-    }
-
-    return {
-      positional: [modelName, id],
-      named: {
-        options,
-      },
-    };
-    // Cast needed Until min-supported TS is 4.7
-  }) as FindRecord<Model>;
-}
-
-type FindAllThunkResult = { options: FindAllOptions } | FindAllOptions | void;
-
-export function findAll<Model = unknown>(
-  destroyable: object,
-  modelName: string,
-  thunk?: () => FindAllThunkResult
-) {
-  return FindAll.from(destroyable, () => {
-    let reified = thunk?.() || {};
-    let options = 'options' in reified ? reified.options : reified;
-
-    return {
-      positional: [modelName],
-      named: {
-        options,
-      },
-    };
-    // Cast needed Until min-supported TS is 4.7
-  }) as FindAll<Model>;
-}
-
-type QueryThunkResult = QueryQuery | [QueryQuery] | [QueryQuery, QueryOptions];
-
-export function query<Model = unknown>(
-  destroyable: object,
-  modelName: string,
-  thunk: () => QueryThunkResult
-) {
-  return Query.from(destroyable, () => {
-    let reified = thunk();
-
-    if (Array.isArray(reified)) {
-      let [query, options] = reified;
-
-      return {
-        positional: [modelName, query],
-        named: {
-          options: options || {},
-        },
-      };
-    }
-
-    return {
-      positional: [modelName, reified],
-      named: {
-        options: {},
-      },
-    };
-    // Cast needed Until min-supported TS is 4.7
-  }) as Query<Model>;
-}
-
-type QueryRecordThunkResult =
-  | QueryRecordQuery
-  | [QueryRecordQuery]
-  | [QueryRecordQuery, QueryRecordOptions];
-
-export function queryRecord<Model = unknown>(
-  destroyable: object,
-  modelName: string,
-  thunk: () => QueryRecordThunkResult
-) {
-  return QueryRecord.from(destroyable, () => {
-    let reified = thunk();
-
-    if (Array.isArray(reified)) {
-      let [query, options] = reified;
-
-      return {
-        positional: [modelName, query],
-        named: {
-          options: options || {},
-        },
-      };
-    }
-
-    return {
-      positional: [modelName, reified],
-      named: {
-        options: {},
-      },
-    };
-    // Cast needed Until min-supported TS is 4.7
-  }) as QueryRecord<Model>;
-}

package/app/helpers/find-all.js

@@ -1 +0,0 @@
-export { FindAll as default } from 'ember-data-resources/-private/resources/find-all';

package/app/helpers/find-record.js

@@ -1 +0,0 @@
-export { FindRecord as default } from 'ember-data-resources/-private/resources/find-record';

package/app/helpers/query-record.js

@@ -1 +0,0 @@
-export { QueryRecord as default } from 'ember-data-resources/-private/resources/query-record';

package/app/helpers/query.js

@@ -1 +0,0 @@
-export { Query as default } from 'ember-data-resources/-private/resources/query';

package/commitlint.config.js

@@ -1,18 +0,0 @@
-'use strict';
-
-module.exports = {
-  extends: ['@commitlint/config-conventional'],
-  // https://commitlint.js.org/#/reference-rules
-  // Level [0..2]: 0 disables the rule. For 1 it will be considered a warning for 2 an error.
-  // Applicable always|never: never inverts the rule.
-  // Value: value to use for this rule.
-  rules: {
-    // 72, the default, is a little short
-    'header-max-length': [1, 'always', 100],
-    // Let people use caps
-    'header-case': [0],
-    // Let people write  sentences
-    'header-full-stop': [0],
-    'subject-case': [0],
-  },
-};

package/config/environment.js

@@ -1,5 +0,0 @@
-'use strict';
-
-module.exports = function (/* environment, appConfig */) {
-  return {};
-};

package/index.d.ts

@@ -1,6 +0,0 @@
-export { FindAll } from './-private/resources/find-all';
-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/index.js

@@ -1,11 +0,0 @@
-'use strict';
-
-module.exports = {
-  name: require('./package').name,
-
-  options: {
-    'ember-cli-babel': {
-      enableTypeScriptTransform: true,
-    },
-  },
-};

package/js-helpers.d.ts

@@ -1,21 +0,0 @@
-import { FindAll } from './-private/resources/find-all';
-import { FindRecord } from './-private/resources/find-record';
-import { Query } from './-private/resources/query';
-import { QueryRecord } from './-private/resources/query-record';
-import type { FindAllOptions } from './-private/resources/find-all';
-import type { FindRecordOptions } from './-private/resources/find-record';
-import type { QueryOptions, QueryQuery } from './-private/resources/query';
-import type { QueryRecordOptions, QueryRecordQuery } from './-private/resources/query-record';
-import type { Id } from './-private/resources/types';
-declare type FindRecordThunkResult = Id | [Id] | [Id, FindRecordOptions];
-export declare function findRecord<Model = unknown>(destroyable: object, modelName: string, thunk: () => FindRecordThunkResult): FindRecord<Model, import("./-private/resources/find-record").Args>;
-declare type FindAllThunkResult = {
-    options: FindAllOptions;
-} | FindAllOptions | void;
-export declare function findAll<Model = unknown>(destroyable: object, modelName: string, thunk?: () => FindAllThunkResult): FindAll<Model, import("./-private/resources/find-all").Args>;
-declare type QueryThunkResult = QueryQuery | [QueryQuery] | [QueryQuery, QueryOptions];
-export declare function query<Model = unknown>(destroyable: object, modelName: string, thunk: () => QueryThunkResult): Query<Model, import("./-private/resources/query").Args>;
-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/tsconfig.json

@@ -1,101 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2021",
-    "module": "ES2020",
-    "moduleResolution": "node",
-
-    // 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": ".",
-    "paths": {
-      "dummy/tests/*": [
-        "tests/*"
-      ],
-      "dummy/*": [
-        "tests/dummy/app/*",
-        "app/*"
-      ],
-      "ember-data-resources": [
-        "addon"
-      ],
-      "ember-data-resources/*": [
-        "addon/*"
-      ],
-      "ember-data-resources/test-support": [
-        "addon-test-support"
-      ],
-      "ember-data-resources/test-support/*": [
-        "addon-test-support/*"
-      ],
-      "*": [
-        "types/*"
-      ]
-    }
-  },
-  "include": [
-    "app/**/*",
-    "addon/**/*",
-    "tests/**/*",
-    "types/**/*",
-    "test-support/**/*",
-    "addon-test-support/**/*"
-  ]
-}

package/types/dummy/index.d.ts

@@ -1 +0,0 @@
-

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

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

package/types/global.d.ts

@@ -1,6 +0,0 @@
-// Types for compiled templates
-declare module 'ember-data-resources/templates/*' {
-  import { TemplateFactory } from 'htmlbars-inline-precompile';
-  const tmpl: TemplateFactory;
-  export default tmpl;
-}