@ember-data/model 4.10.0-alpha.2 → 4.10.0-alpha.21

package/addon/-private/relationship-meta.ts

@@ -1,98 +0,0 @@
-import { dasherize } from '@ember/string';
-import { DEBUG } from '@glimmer/env';
-
-import { singularize } from 'ember-inflector';
-
-import type Store from '@ember-data/store';
-import type { RelationshipSchema } from '@ember-data/types/q/record-data-schemas';
-
-function typeForRelationshipMeta(meta) {
-  let modelName = dasherize(meta.type || meta.key);
-
-  if (meta.kind === 'hasMany') {
-    modelName = singularize(modelName);
-  }
-
-  return modelName;
-}
-
-function shouldFindInverse(relationshipMeta) {
-  let options = relationshipMeta.options;
-  return !(options && options.inverse === null);
-}
-
-class RelationshipDefinition implements RelationshipSchema {
-  declare _type: string;
-  declare __inverseKey: string;
-  declare __hasCalculatedInverse: boolean;
-  declare parentModelName: string;
-  declare inverseIsAsync: string | null;
-  declare meta: any;
-
-  constructor(meta: any) {
-    this._type = '';
-    this.__inverseKey = '';
-    this.__hasCalculatedInverse = false;
-    this.parentModelName = meta.parentModelName;
-    this.meta = meta;
-  }
-
-  /**
-   * @internal
-   * @deprecated
-   */
-  get key(): string {
-    return this.meta.key;
-  }
-  get kind(): 'belongsTo' | 'hasMany' {
-    return this.meta.kind;
-  }
-  get type(): string {
-    if (this._type) {
-      return this._type;
-    }
-    this._type = typeForRelationshipMeta(this.meta);
-    return this._type;
-  }
-  get options(): { [key: string]: any } {
-    return this.meta.options;
-  }
-  get name(): string {
-    return this.meta.name;
-  }
-
-  _inverseKey(store: Store, modelClass): string {
-    if (this.__hasCalculatedInverse === false) {
-      this._calculateInverse(store, modelClass);
-    }
-    return this.__inverseKey;
-  }
-
-  _calculateInverse(store: Store, modelClass): void {
-    this.__hasCalculatedInverse = true;
-    let inverseKey;
-    let inverse: any = null;
-
-    if (shouldFindInverse(this.meta)) {
-      inverse = modelClass.inverseFor(this.key, store);
-    }
-    // TODO make this error again for the non-polymorphic case
-    if (DEBUG) {
-      if (!this.options.polymorphic) {
-        modelClass.typeForRelationship(this.key, store);
-      }
-    }
-
-    if (inverse) {
-      inverseKey = inverse.name;
-    } else {
-      inverseKey = null;
-    }
-    this.__inverseKey = inverseKey;
-  }
-}
-export type { RelationshipDefinition };
-
-export function relationshipFromMeta(meta: RelationshipSchema): RelationshipDefinition {
-  return new RelationshipDefinition(meta);
-}

package/addon/-private/util.ts

@@ -1,31 +0,0 @@
-import { gte } from 'ember-compatibility-helpers';
-
-export type DecoratorPropertyDescriptor = (PropertyDescriptor & { initializer?: any }) | undefined;
-
-export function isElementDescriptor(args: any[]): args is [object, string, DecoratorPropertyDescriptor] {
-  let [maybeTarget, maybeKey, maybeDesc] = args;
-
-  return (
-    // Ensure we have the right number of args
-    args.length === 3 &&
-    // Make sure the target is a class or object (prototype)
-    (typeof maybeTarget === 'function' || (typeof maybeTarget === 'object' && maybeTarget !== null)) &&
-    // Make sure the key is a string
-    typeof maybeKey === 'string' &&
-    // Make sure the descriptor is the right shape
-    ((typeof maybeDesc === 'object' &&
-      maybeDesc !== null &&
-      'enumerable' in maybeDesc &&
-      'configurable' in maybeDesc) ||
-      // TS compatibility
-      maybeDesc === undefined)
-  );
-}
-
-export function computedMacroWithOptionalParams(fn) {
-  if (gte('3.10.0')) {
-    return (...maybeDesc: any[]) => (isElementDescriptor(maybeDesc) ? fn()(...maybeDesc) : fn(...maybeDesc));
-  } else {
-    return fn;
-  }
-}

package/addon/index.ts

@@ -1,39 +0,0 @@
-/**
- In EmberData a `Model` is a class defining the attributes and relationships
-  of a specific resource `type` (model name). In this sense it represents a static "schema".
-
-  Data for individual resources fetched from your API is presented
-  to the UI via instances of the `Model`s you define.
-
-  An instantiated `Model` is referred to as a `record`.
-
-  When we refer to the `ModelClass` we are referring to the class definition
-  and the static schema methods present on it.
-
-  When we refer to a `record` we refer to a specific class instance presenting
-  the resource data for a given `type` and `id`.
-
-  ### Defining a Model
-
-  ```app/models/person.js
-  import Model, { attr, belongsTo, hasMany } from '@ember-data/model';
-
-  export default class PersonModel extends Model {
-    @attr name;
-
-    @belongsTo('pet', { inverse: 'owners', async: false }) dog;
-
-    @hasMany('person', { inverse: 'friends', async: true }) friends;
-  }
-  ```
-
-  ### modelName convention
-
-  By convention, the name of a given model (its `type`) matches the name
-  of the file in the `app/models` folder and should be lowercase, singular
-  and dasherized.
-
-  @module @ember-data/model
-  @main @ember-data/model
- */
-export { Model as default, attr, belongsTo, hasMany } from './-private';

package/blueprints/model/HELP.md

@@ -1,26 +0,0 @@
-<grey>You may generate models with as many attrs as you would like to pass. The following attribute types are supported:</grey>
-<yellow><attr-name></yellow>
-<yellow><attr-name></yellow>:array
-<yellow><attr-name></yellow>:boolean
-<yellow><attr-name></yellow>:date
-<yellow><attr-name></yellow>:object
-<yellow><attr-name></yellow>:number
-<yellow><attr-name></yellow>:string
-<yellow><attr-name></yellow>:your-custom-transform
-<yellow><attr-name></yellow>:belongs-to:<yellow><model-name></yellow>
-<yellow><attr-name></yellow>:has-many:<yellow><model-name></yellow>
-
-For instance: <green>\`ember generate model taco filling:belongs-to:protein toppings:has-many:toppings name:string price:number misc\`</green>
-would result in the following model:
-
-```js
-import Model, { belongsTo, hasMany, attr } from '@ember-data/model';
-
-export default class TacoModel extends Model {
-  @belongsTo('protein') filling;
-  @hasMany('topping') toppings;
-  @attr('string') name;
-  @attr('number') price;
-  @attr misc;
-}
-```

package/blueprints/model/files/__root__/__path__/__name__.js

@@ -1,5 +0,0 @@
-import Model<%= importedModules.length ? `, { ${importedModules} }` : '' %> from '@ember-data/model';
-
-export default Model.extend({
-<%= attrs.length ? attrs : '' %>
-});

package/blueprints/model/index.js

@@ -1,158 +0,0 @@
-const EOL = require('os').EOL;
-
-const inflection = require('inflection');
-const stringUtils = require('ember-cli-string-utils');
-const useEditionDetector = require('@ember-data/private-build-infra/src/utilities/edition-detector');
-const { has } = require('@ember/edition-utils');
-
-module.exports = useEditionDetector({
-  description: 'Generates an ember-data model.',
-
-  anonymousOptions: ['name', 'attr:type'],
-
-  root: __dirname,
-
-  locals(options) {
-    let attrs = [];
-    let needs = [];
-    let entityOptions = options.entity.options;
-    let includeHasMany = false;
-    let includeBelongsTo = false;
-    let includeAttr = false;
-
-    for (let name in entityOptions) {
-      let type = entityOptions[name] || '';
-      let foreignModel = name;
-      if (type.indexOf(':') > -1) {
-        foreignModel = type.split(':')[1];
-        type = type.split(':')[0];
-      }
-      let dasherizedName = stringUtils.dasherize(name);
-      let camelizedName = stringUtils.camelize(name);
-      let dasherizedType = stringUtils.dasherize(type);
-      let dasherizedForeignModel = stringUtils.dasherize(foreignModel);
-      let dasherizedForeignModelSingular = inflection.singularize(dasherizedForeignModel);
-
-      let attr;
-      if (/has-many/.test(dasherizedType)) {
-        includeHasMany = true;
-        let camelizedNamePlural = inflection.pluralize(camelizedName);
-        attr = {
-          name: dasherizedForeignModelSingular,
-          type: dasherizedType,
-          propertyName: camelizedNamePlural,
-        };
-      } else if (/belongs-to/.test(dasherizedType)) {
-        includeBelongsTo = true;
-        attr = {
-          name: dasherizedForeignModel,
-          type: dasherizedType,
-          propertyName: camelizedName,
-        };
-      } else {
-        includeAttr = true;
-        attr = {
-          name: dasherizedName,
-          type: dasherizedType,
-          propertyName: camelizedName,
-        };
-      }
-      attrs.push(attr);
-
-      if (/has-many|belongs-to/.test(dasherizedType)) {
-        needs.push("'model:" + dasherizedForeignModelSingular + "'");
-      }
-    }
-
-    if (attrs.length) {
-      let attrTransformer, attrSeparator;
-
-      let hasOctane = has('octane');
-      if (hasOctane && process.env.EMBER_EDITION === 'classic') {
-        hasOctane = false; //forcible override
-      }
-      if (hasOctane) {
-        attrTransformer = nativeAttr;
-        attrSeparator = ';';
-      } else {
-        attrTransformer = classicAttr;
-        attrSeparator = ',';
-      }
-
-      attrs = attrs.map(attrTransformer);
-      attrs = '  ' + attrs.join(attrSeparator + EOL + '  ');
-      if (hasOctane) {
-        attrs = attrs + attrSeparator;
-      }
-    }
-
-    let needsDeduplicated = needs.filter(function (need, i) {
-      return needs.indexOf(need) === i;
-    });
-    needs = '  needs: [' + needsDeduplicated.join(', ') + ']';
-
-    let importedModules = [];
-    if (includeAttr) {
-      importedModules.push('attr');
-    }
-    if (includeBelongsTo) {
-      importedModules.push('belongsTo');
-    }
-    if (includeHasMany) {
-      importedModules.push('hasMany');
-    }
-    importedModules = importedModules.join(', ');
-
-    return {
-      importedModules,
-      attrs,
-      needs,
-    };
-  },
-});
-
-function nativeAttr(attr) {
-  let name = attr.name,
-    type = attr.type,
-    propertyName = attr.propertyName,
-    result;
-
-  if (type === 'belongs-to') {
-    if (name === propertyName) {
-      result = '@belongsTo';
-    } else {
-      result = "@belongsTo('" + name + "')";
-    }
-  } else if (type === 'has-many') {
-    if (inflection.pluralize(name) === propertyName) {
-      result = '@hasMany';
-    } else {
-      result = "@hasMany('" + name + "')";
-    }
-  } else if (type === '') {
-    result = '@attr()';
-  } else {
-    result = "@attr('" + type + "')";
-  }
-  return result + ' ' + propertyName;
-}
-
-function classicAttr(attr) {
-  let name = attr.name,
-    type = attr.type,
-    propertyName = attr.propertyName,
-    result;
-
-  if (type === 'belongs-to') {
-    result = "belongsTo('" + name + "')";
-  } else if (type === 'has-many') {
-    result = "hasMany('" + name + "')";
-  } else if (type === '') {
-    //"If you don't specify the type of the attribute, it will be whatever was provided by the server"
-    //https://emberjs.com/guides/models/defining-models/
-    result = 'attr()';
-  } else {
-    result = "attr('" + type + "')";
-  }
-  return propertyName + ': ' + result;
-}

package/blueprints/model/native-files/__root__/__path__/__name__.js

@@ -1,5 +0,0 @@
-import Model<%= importedModules.length ? `, { ${importedModules} }` : '' %> from '@ember-data/model';
-
-export default class <%= classifiedModuleName %>Model extends Model {
-<%= attrs.length ? attrs : '' %>
-}

package/blueprints/model-test/index.js

@@ -1,33 +0,0 @@
-const path = require('path');
-
-const testInfo = require('ember-cli-test-info');
-const useTestFrameworkDetector = require('@ember-data/private-build-infra/src/utilities/test-framework-detector');
-const modulePrefixForProject = require('@ember-data/private-build-infra/src/utilities/module-prefix-for-project');
-
-const ModelBlueprint = require('../model');
-
-module.exports = useTestFrameworkDetector({
-  description: 'Generates a model unit test.',
-
-  root: __dirname,
-
-  fileMapTokens(options) {
-    return {
-      __root__() {
-        return 'tests';
-      },
-      __path__() {
-        return path.join('unit', 'models');
-      },
-    };
-  },
-
-  locals(options) {
-    const result = ModelBlueprint.locals.apply(this, arguments);
-
-    result.friendlyTestDescription = testInfo.description(options.entity.name, 'Unit', 'Model');
-    result.modulePrefix = modulePrefixForProject(options.project);
-
-    return result;
-  },
-});

package/blueprints/model-test/mocha-files/__root__/__path__/__test__.js

@@ -1,18 +0,0 @@
-import { expect } from 'chai';
-import { describe, it } from 'mocha';
-
-import { setupModelTest } from 'ember-mocha';
-
-describe('<%= friendlyTestDescription %>', function () {
-  setupModelTest('<%= dasherizedModuleName %>', {
-    // Specify the other units that are required for this test.
-  <%= typeof needs !== 'undefined' ? needs : '' %>,
-  });
-
-  // Replace this with your real tests.
-  it('exists', function () {
-    let model = this.subject();
-    // var store = this.store();
-    expect(model).to.be.ok;
-  });
-});

package/blueprints/model-test/mocha-rfc-232-files/__root__/__path__/__test__.js

@@ -1,15 +0,0 @@
-import { expect } from 'chai';
-import { describe, it } from 'mocha';
-
-import { setupTest } from '<%= modulePrefix %>/tests/helpers';
-
-describe('<%= friendlyTestDescription %>', function () {
-  setupTest();
-
-  // Replace this with your real tests.
-  it('exists', function () {
-    let store = this.owner.lookup('service:store');
-    let model = store.createRecord('<%= dasherizedModuleName %>', {});
-    expect(model).to.be.ok;
-  });
-});

package/blueprints/model-test/qunit-files/__root__/__path__/__test__.js

@@ -1,14 +0,0 @@
-import { module, test } from 'qunit';
-
-import { setupTest } from '<%= modulePrefix %>/tests/helpers';
-
-module('<%= friendlyTestDescription %>', function (hooks) {
-  setupTest(hooks);
-
-  // Replace this with your real tests.
-  test('it exists', function (assert) {
-    let store = this.owner.lookup('service:store');
-    let model = store.createRecord('<%= dasherizedModuleName %>', {});
-    assert.ok(model);
-  });
-});

package/index.js

@@ -1,47 +0,0 @@
-'use strict';
-
-const addonBuildConfigForDataPackage = require('@ember-data/private-build-infra/src/addon-build-config-for-data-package');
-
-const name = require('./package').name;
-
-const addonBaseConfig = addonBuildConfigForDataPackage(name);
-
-module.exports = Object.assign({}, addonBaseConfig, {
-  shouldRollupPrivate: true,
-  externalDependenciesForPrivateModule() {
-    return [
-      'ember-cached-decorator-polyfill',
-
-      '@ember-data/canary-features',
-      '@ember-data/store',
-      '@ember-data/store/-private',
-      '@embroider/macros',
-      '@ember/string',
-      '@embroider/macros/es-compat',
-      '@ember-data/tracking/-private',
-
-      '@ember/object/proxy',
-      '@ember/object/promise-proxy-mixin',
-      '@ember/application',
-      '@ember/array',
-      '@ember/array/mutable',
-      '@ember/array/proxy',
-      '@ember/debug',
-      '@ember/error',
-      '@ember/object',
-      '@ember/object/compat',
-      '@ember/object/computed',
-      '@ember/object/internals',
-      '@ember/polyfills',
-      '@ember/runloop',
-      '@ember/utils',
-      '@ember/service',
-
-      '@glimmer/tracking/primitives/cache',
-      '@glimmer/tracking',
-      'ember-inflector',
-      'ember',
-      'rsvp',
-    ];
-  },
-});