@ember-data/store 4.5.0-beta.0 → 4.5.0

package/addon/-private/system/store/finders.js

@@ -1,412 +0,0 @@
-import { assert, deprecate } from '@ember/debug';
-import { DEBUG } from '@glimmer/env';
-
-import { Promise } from 'rsvp';
-
-import { DEPRECATE_RSVP_PROMISE } from '@ember-data/private-build-infra/deprecations';
-
-import { _bind, _guard, _objectIsAlive, guardDestroyedStore } from './common';
-import { normalizeResponseHelper } from './serializer-response';
-
-/**
-  @module @ember-data/store
-*/
-
-function payloadIsNotBlank(adapterPayload) {
-  if (Array.isArray(adapterPayload)) {
-    return true;
-  } else {
-    return Object.keys(adapterPayload || {}).length;
-  }
-}
-
-function iterateData(data, fn) {
-  if (Array.isArray(data)) {
-    return data.map(fn);
-  } else {
-    return fn(data);
-  }
-}
-
-// sync
-// iterate over records in payload.data
-// for each record
-//   assert that record.relationships[inverse] is either undefined (so we can fix it)
-//     or provide a data: {id, type} that matches the record that requested it
-//   return the relationship data for the parent
-function syncRelationshipDataFromLink(store, payload, parentInternalModel, relationship) {
-  // ensure the right hand side (incoming payload) points to the parent record that
-  // requested this relationship
-  let relationshipData = payload.data
-    ? iterateData(payload.data, (data, index) => {
-        const { id, type } = data;
-        ensureRelationshipIsSetToParent(data, parentInternalModel, store, relationship, index);
-        return { id, type };
-      })
-    : null;
-
-  const relatedDataHash = {};
-
-  if ('meta' in payload) {
-    relatedDataHash.meta = payload.meta;
-  }
-  if ('links' in payload) {
-    relatedDataHash.links = payload.links;
-  }
-  if ('data' in payload) {
-    relatedDataHash.data = relationshipData;
-  }
-
-  // now, push the left hand side (the parent record) to ensure things are in sync, since
-  // the payload will be pushed with store._push
-  const parentPayload = {
-    id: parentInternalModel.id,
-    type: parentInternalModel.modelName,
-    relationships: {
-      [relationship.key]: relatedDataHash,
-    },
-  };
-
-  if (!Array.isArray(payload.included)) {
-    payload.included = [];
-  }
-  payload.included.push(parentPayload);
-
-  return payload;
-}
-
-function ensureRelationshipIsSetToParent(payload, parentInternalModel, store, parentRelationship, index) {
-  let { id, type } = payload;
-
-  if (!payload.relationships) {
-    payload.relationships = {};
-  }
-  let { relationships } = payload;
-
-  let inverse = getInverse(store, parentInternalModel, parentRelationship, type);
-  if (inverse) {
-    let { inverseKey, kind } = inverse;
-
-    let relationshipData = relationships[inverseKey] && relationships[inverseKey].data;
-
-    if (
-      DEBUG &&
-      typeof relationshipData !== 'undefined' &&
-      !relationshipDataPointsToParent(relationshipData, parentInternalModel)
-    ) {
-      let inspect = function inspect(thing) {
-        return `'${JSON.stringify(thing)}'`;
-      };
-      let quotedType = inspect(type);
-      let quotedInverse = inspect(inverseKey);
-      let expected = inspect({
-        id: parentInternalModel.id,
-        type: parentInternalModel.modelName,
-      });
-      let expectedModel = `${parentInternalModel.modelName}:${parentInternalModel.id}`;
-      let got = inspect(relationshipData);
-      let prefix = typeof index === 'number' ? `data[${index}]` : `data`;
-      let path = `${prefix}.relationships.${inverseKey}.data`;
-      let other = relationshipData ? `<${relationshipData.type}:${relationshipData.id}>` : null;
-      let relationshipFetched = `${expectedModel}.${parentRelationship.kind}("${parentRelationship.name}")`;
-      let includedRecord = `<${type}:${id}>`;
-      let message = [
-        `Encountered mismatched relationship: Ember Data expected ${path} in the payload from ${relationshipFetched} to include ${expected} but got ${got} instead.\n`,
-        `The ${includedRecord} record loaded at ${prefix} in the payload specified ${other} as its ${quotedInverse}, but should have specified ${expectedModel} (the record the relationship is being loaded from) as its ${quotedInverse} instead.`,
-        `This could mean that the response for ${relationshipFetched} may have accidentally returned ${quotedType} records that aren't related to ${expectedModel} and could be related to a different ${parentInternalModel.modelName} record instead.`,
-        `Ember Data has corrected the ${includedRecord} record's ${quotedInverse} relationship to ${expectedModel} so that ${relationshipFetched} will include ${includedRecord}.`,
-        `Please update the response from the server or change your serializer to either ensure that the response for only includes ${quotedType} records that specify ${expectedModel} as their ${quotedInverse}, or omit the ${quotedInverse} relationship from the response.`,
-      ].join('\n');
-
-      assert(message);
-    }
-
-    if (kind !== 'hasMany' || typeof relationshipData !== 'undefined') {
-      relationships[inverseKey] = relationships[inverseKey] || {};
-      relationships[inverseKey].data = fixRelationshipData(relationshipData, kind, parentInternalModel);
-    }
-  }
-}
-
-function getInverse(store, parentInternalModel, parentRelationship, type) {
-  return recordDataFindInverseRelationshipInfo(store, parentInternalModel, parentRelationship, type);
-}
-
-function recordDataFindInverseRelationshipInfo({ _storeWrapper }, parentInternalModel, parentRelationship, type) {
-  let { name: lhs_relationshipName } = parentRelationship;
-  let { modelName } = parentInternalModel;
-  let inverseKey = _storeWrapper.inverseForRelationship(modelName, lhs_relationshipName);
-
-  if (inverseKey) {
-    let {
-      meta: { kind },
-    } = _storeWrapper.relationshipsDefinitionFor(type)[inverseKey];
-    return {
-      inverseKey,
-      kind,
-    };
-  }
-}
-
-function relationshipDataPointsToParent(relationshipData, internalModel) {
-  if (relationshipData === null) {
-    return false;
-  }
-
-  if (Array.isArray(relationshipData)) {
-    if (relationshipData.length === 0) {
-      return false;
-    }
-    for (let i = 0; i < relationshipData.length; i++) {
-      let entry = relationshipData[i];
-      if (validateRelationshipEntry(entry, internalModel)) {
-        return true;
-      }
-    }
-  } else {
-    return validateRelationshipEntry(relationshipData, internalModel);
-  }
-
-  return false;
-}
-
-function fixRelationshipData(relationshipData, relationshipKind, { id, modelName }) {
-  let parentRelationshipData = {
-    id,
-    type: modelName,
-  };
-
-  let payload;
-
-  if (relationshipKind === 'hasMany') {
-    payload = relationshipData || [];
-    if (relationshipData) {
-      // these arrays could be massive so this is better than filter
-      // Note: this is potentially problematic if type/id are not in the
-      // same state of normalization.
-      let found = relationshipData.find((v) => {
-        return v.type === parentRelationshipData.type && v.id === parentRelationshipData.id;
-      });
-      if (!found) {
-        payload.push(parentRelationshipData);
-      }
-    } else {
-      payload.push(parentRelationshipData);
-    }
-  } else {
-    payload = relationshipData || {};
-    Object.assign(payload, parentRelationshipData);
-  }
-
-  return payload;
-}
-
-function validateRelationshipEntry({ id }, { id: parentModelID }) {
-  return id && id.toString() === parentModelID;
-}
-
-export function _findHasMany(adapter, store, internalModel, link, relationship, options) {
-  let snapshot = internalModel.createSnapshot(options);
-  let modelClass = store.modelFor(relationship.type);
-  let useLink = !link || typeof link === 'string';
-  let relatedLink = useLink ? link : link.href;
-  let promise = adapter.findHasMany(store, snapshot, relatedLink, relationship);
-  let label = `DS: Handle Adapter#findHasMany of '${internalModel.modelName}' : '${relationship.type}'`;
-
-  promise = guardDestroyedStore(promise, store, label);
-  promise = promise.then(
-    (adapterPayload) => {
-      if (!_objectIsAlive(internalModel)) {
-        if (DEPRECATE_RSVP_PROMISE) {
-          deprecate(
-            `A Promise for fetching ${relationship.type} did not resolve by the time your model was destroyed. This will error in a future release.`,
-            false,
-            {
-              id: 'ember-data:rsvp-unresolved-async',
-              until: '5.0',
-              for: '@ember-data/store',
-              since: {
-                available: '4.5',
-                enabled: '4.5',
-              },
-            }
-          );
-        }
-      }
-
-      assert(
-        `You made a 'findHasMany' request for a ${internalModel.modelName}'s '${relationship.key}' relationship, using link '${link}' , but the adapter's response did not have any data`,
-        payloadIsNotBlank(adapterPayload)
-      );
-      let serializer = store.serializerFor(relationship.type);
-      let payload = normalizeResponseHelper(serializer, store, modelClass, adapterPayload, null, 'findHasMany');
-
-      assert(
-        `fetched the hasMany relationship '${relationship.name}' for ${internalModel.modelName}:${internalModel.id} with link '${link}', but no data member is present in the response. If no data exists, the response should set { data: [] }`,
-        'data' in payload && Array.isArray(payload.data)
-      );
-
-      payload = syncRelationshipDataFromLink(store, payload, internalModel, relationship);
-
-      let internalModelArray = store._push(payload);
-      return internalModelArray;
-    },
-    null,
-    `DS: Extract payload of '${internalModel.modelName}' : hasMany '${relationship.type}'`
-  );
-
-  if (DEPRECATE_RSVP_PROMISE) {
-    promise = _guard(promise, _bind(_objectIsAlive, internalModel));
-  }
-
-  return promise;
-}
-
-export function _findBelongsTo(adapter, store, internalModel, link, relationship, options) {
-  let snapshot = internalModel.createSnapshot(options);
-  let modelClass = store.modelFor(relationship.type);
-  let useLink = !link || typeof link === 'string';
-  let relatedLink = useLink ? link : link.href;
-  let promise = adapter.findBelongsTo(store, snapshot, relatedLink, relationship);
-  let label = `DS: Handle Adapter#findBelongsTo of ${internalModel.modelName} : ${relationship.type}`;
-
-  promise = guardDestroyedStore(promise, store, label);
-  promise = _guard(promise, _bind(_objectIsAlive, internalModel));
-
-  promise = promise.then(
-    (adapterPayload) => {
-      if (!_objectIsAlive(internalModel)) {
-        if (DEPRECATE_RSVP_PROMISE) {
-          deprecate(
-            `A Promise for fetching ${relationship.type} did not resolve by the time your model was destroyed. This will error in a future release.`,
-            false,
-            {
-              id: 'ember-data:rsvp-unresolved-async',
-              until: '5.0',
-              for: '@ember-data/store',
-              since: {
-                available: '4.5',
-                enabled: '4.5',
-              },
-            }
-          );
-        }
-      }
-
-      let serializer = store.serializerFor(relationship.type);
-      let payload = normalizeResponseHelper(serializer, store, modelClass, adapterPayload, null, 'findBelongsTo');
-
-      assert(
-        `fetched the belongsTo relationship '${relationship.name}' for ${internalModel.modelName}:${internalModel.id} with link '${link}', but no data member is present in the response. If no data exists, the response should set { data: null }`,
-        'data' in payload &&
-          (payload.data === null || (typeof payload.data === 'object' && !Array.isArray(payload.data)))
-      );
-
-      if (!payload.data && !payload.links && !payload.meta) {
-        return null;
-      }
-
-      payload = syncRelationshipDataFromLink(store, payload, internalModel, relationship);
-
-      return store._push(payload);
-    },
-    null,
-    `DS: Extract payload of ${internalModel.modelName} : ${relationship.type}`
-  );
-
-  if (DEPRECATE_RSVP_PROMISE) {
-    promise = _guard(promise, _bind(_objectIsAlive, internalModel));
-  }
-
-  return promise;
-}
-
-export function _findAll(adapter, store, modelName, options) {
-  let modelClass = store.modelFor(modelName); // adapter.findAll depends on the class
-  let recordArray = store.peekAll(modelName);
-  let snapshotArray = recordArray._createSnapshot(options);
-  let promise = Promise.resolve().then(() => adapter.findAll(store, modelClass, null, snapshotArray));
-  let label = 'DS: Handle Adapter#findAll of ' + modelClass;
-
-  promise = guardDestroyedStore(promise, store, label);
-
-  return promise.then(
-    (adapterPayload) => {
-      assert(
-        `You made a 'findAll' request for '${modelName}' records, but the adapter's response did not have any data`,
-        payloadIsNotBlank(adapterPayload)
-      );
-      let serializer = store.serializerFor(modelName);
-      let payload = normalizeResponseHelper(serializer, store, modelClass, adapterPayload, null, 'findAll');
-
-      store._push(payload);
-      store._didUpdateAll(modelName);
-
-      return recordArray;
-    },
-    null,
-    'DS: Extract payload of findAll ${modelName}'
-  );
-}
-
-export function _query(adapter, store, modelName, query, recordArray, options) {
-  let modelClass = store.modelFor(modelName); // adapter.query needs the class
-
-  recordArray = recordArray || store.recordArrayManager.createAdapterPopulatedRecordArray(modelName, query);
-  let promise = Promise.resolve().then(() => adapter.query(store, modelClass, query, recordArray, options));
-
-  let label = `DS: Handle Adapter#query of ${modelName}`;
-  promise = guardDestroyedStore(promise, store, label);
-
-  return promise.then(
-    (adapterPayload) => {
-      let serializer = store.serializerFor(modelName);
-      let payload = normalizeResponseHelper(serializer, store, modelClass, adapterPayload, null, 'query');
-      let internalModels = store._push(payload);
-
-      assert(
-        'The response to store.query is expected to be an array but it was a single record. Please wrap your response in an array or use `store.queryRecord` to query for a single record.',
-        Array.isArray(internalModels)
-      );
-      let identifiers = internalModels.map((im) => im.identifier);
-      if (recordArray) {
-        recordArray._setIdentifiers(identifiers, payload);
-      } else {
-        recordArray = store.recordArrayManager.createAdapterPopulatedRecordArray(
-          modelName,
-          query,
-          identifiers,
-          payload
-        );
-      }
-
-      return recordArray;
-    },
-    null,
-    `DS: Extract payload of query ${modelName}`
-  );
-}
-
-export function _queryRecord(adapter, store, modelName, query, options) {
-  let modelClass = store.modelFor(modelName); // adapter.queryRecord needs the class
-  let promise = Promise.resolve().then(() => adapter.queryRecord(store, modelClass, query, options));
-
-  let label = `DS: Handle Adapter#queryRecord of ${modelName}`;
-  promise = guardDestroyedStore(promise, store, label);
-
-  return promise.then(
-    (adapterPayload) => {
-      let serializer = store.serializerFor(modelName);
-      let payload = normalizeResponseHelper(serializer, store, modelClass, adapterPayload, null, 'queryRecord');
-
-      assert(
-        `Expected the primary data returned by the serializer for a 'queryRecord' response to be a single object or null but instead it was an array.`,
-        !Array.isArray(payload.data)
-      );
-
-      return store._push(payload);
-    },
-    null,
-    `DS: Extract payload of queryRecord ${modelName}`
-  );
-}

package/addon/-private/ts-interfaces/ds-model.ts

@@ -1,50 +0,0 @@
-import type EmberObject from '@ember/object';
-
-import type { Errors } from '@ember-data/model/-private';
-
-import type CoreStore from '../system/core-store';
-import type InternalModel from '../system/model/internal-model';
-import type { JsonApiValidationError } from './record-data-json-api';
-import type { AttributeSchema, RelationshipSchema, RelationshipsSchema } from './record-data-schemas';
-
-// Placeholder until model.js is typed
-export interface DSModel extends EmberObject {
-  constructor: DSModelSchema;
-  store: CoreStore;
-  errors: Errors;
-  _internalModel: InternalModel;
-  toString(): string;
-  save(): Promise<DSModel>;
-  eachRelationship<T>(callback: (this: T, key: string, meta: RelationshipSchema) => void, binding?: T): void;
-  eachAttribute<T>(callback: (this: T, key: string, meta: AttributeSchema) => void, binding?: T): void;
-  invalidErrorsChanged(errors: JsonApiValidationError[]): void;
-  [key: string]: unknown;
-  isDeleted: boolean;
-  deleteRecord(): void;
-  unloadRecord(): void;
-  _notifyProperties(keys: string[]): void;
-}
-
-// Implemented by both ShimModelClass and DSModel
-export interface ModelSchema {
-  modelName: string;
-  fields: Map<string, 'attribute' | 'belongsTo' | 'hasMany'>;
-  attributes: Map<string, AttributeSchema>;
-  relationshipsByName: Map<string, RelationshipSchema>;
-  eachAttribute<T>(callback: (this: T, key: string, attribute: AttributeSchema) => void, binding?: T): void;
-  eachRelationship<T>(callback: (this: T, key: string, relationship: RelationshipSchema) => void, binding?: T): void;
-  eachTransformedAttribute<T>(
-    callback: (this: T, key: string, relationship: RelationshipSchema) => void,
-    binding?: T
-  ): void;
-  toString(): string;
-}
-
-// This is the static side of DSModel should become DSModel
-//  once we can type it.
-export interface DSModelSchema extends ModelSchema {
-  isModel: true;
-  relationshipsObject: RelationshipsSchema;
-  extend(...mixins: unknown[]): DSModelSchema;
-  reopenClass(...mixins: unknown[]): void;
-}

package/addon/-private/ts-interfaces/ember-data-json-api.ts

@@ -1,145 +0,0 @@
-import type { Value as JSONValue } from 'json-typescript';
-
-import type { Dict } from './utils';
-
-/**
-  @module @ember-data/store
-*/
-
-export type Meta = Dict<JSONValue>;
-export type LinkObject = { href: string; meta?: Dict<JSONValue> };
-export type Link = string | LinkObject;
-export interface Links {
-  related?: Link;
-  self?: Link;
-}
-export interface PaginationLinks extends Links {
-  first?: Link | null;
-  last?: Link | null;
-  prev?: Link | null;
-  next?: Link | null;
-}
-
-/**
- * Serves as a reference to a `Resource` but does not contain
- * any data itself.
- *
- * Used to establish relationship linkages between `Resources` and
- * to address data that may not be available synchronously.
- *
- * [JSON:API Spec](https://jsonapi.org/format/#document-resource-identifier-objects)
- * @internal
- */
-export interface ExistingResourceIdentifierObject {
-  id: string;
-  type: string;
-
-  /**
-   * While not officially part of the `JSON:API` spec,
-   * `ember-data` allows the use of `lid` as a local
-   * identifier for a `Resource`.
-   *
-   * @recommended It is best to include the lid used when creating
-   *   a new resource if this is the response to a new resource creation,
-   *   also recommended if this resource type uses secondary indexes.
-   *
-   * Once a `ResourceIdentifierObject` has been seen by the cache, `lid`
-   * should always be present. Only when inbound from the an `API` response
-   * is `lid` considered optional.
-   *
-   * [Identifiers RFC](https://github.com/emberjs/rfcs/blob/master/text/0403-ember-data-identifiers.md#ember-data--identifiers)
-   * @internal
-   */
-  lid?: string;
-
-  /**
-   * While valid in the `JSON:API` spec,
-   * `ember-data` ignores `meta` on `ResourceIdentifierObjects`
-   *
-   * @ignored this property goes un-utilized and will be lost
-   * @internal
-   */
-  meta?: Meta;
-}
-
-/**
- * Serves as a reference to a resource created on the client
- * but not yet persisted.
- *
- * @internal
- */
-export interface NewResourceIdentifierObject {
-  /**
-   * Resources newly created on the client _may_
-   * not have an `id` available to them prior
-   * to completion of their first successful `save`.
-   *
-   * `id` will be `null` in this case.
-   *
-   * @internal
-   */
-  id: string | null;
-  type: string;
-
-  /**
-   * Resources newly created on the client _will always_
-   * have an `lid` assigned immediately and available.
-   * @internal
-   */
-  lid: string;
-}
-
-export interface ResourceIdentifier {
-  lid: string;
-}
-
-export type ResourceIdentifierObject =
-  | ResourceIdentifier
-  | ExistingResourceIdentifierObject
-  | NewResourceIdentifierObject;
-
-// TODO disallow NewResource, make narrowable
-export interface SingleResourceRelationship {
-  data?: ResourceIdentifierObject | null;
-  meta?: Dict<JSONValue>;
-  links?: Links;
-}
-
-export interface CollectionResourceRelationship {
-  data?: ResourceIdentifierObject[];
-  meta?: Dict<JSONValue>;
-  links?: PaginationLinks;
-}
-
-/**
- * Contains the data for an existing resource in JSON:API format
- * @internal
- */
-export interface ExistingResourceObject extends ExistingResourceIdentifierObject {
-  meta?: Dict<JSONValue>;
-  attributes?: Dict<JSONValue>;
-  relationships?: Dict<SingleResourceRelationship | CollectionResourceRelationship>;
-  links?: Links;
-}
-
-interface Document {
-  meta?: Dict<JSONValue>;
-  included?: ExistingResourceObject[];
-  jsonapi?: Dict<JSONValue>;
-  links?: Dict<string | JSONValue>;
-  errors?: JSONValue[];
-}
-
-export interface EmptyResourceDocument extends Document {
-  data: null;
-}
-
-export interface SingleResourceDocument extends Document {
-  data: ExistingResourceObject;
-}
-
-export interface CollectionResourceDocument extends Document {
-  data: ExistingResourceObject[];
-}
-
-export type JsonApiDocument = EmptyResourceDocument | SingleResourceDocument | CollectionResourceDocument;

package/addon/-private/ts-interfaces/fetch-manager.ts

@@ -1,44 +0,0 @@
-import type { Dict } from '@ember-data/store/-private/ts-interfaces/utils';
-
-import type { RecordIdentifier } from './identifier';
-
-export interface Operation {
-  op: string;
-  options: Dict<unknown> | undefined;
-  recordIdentifier: RecordIdentifier;
-}
-
-export interface FindRecordQuery extends Operation {
-  op: 'findRecord';
-  recordIdentifier: RecordIdentifier;
-  options: any;
-}
-
-export interface SaveRecordMutation extends Operation {
-  op: 'saveRecord';
-  recordIdentifier: RecordIdentifier;
-  options: any;
-}
-
-export interface Request {
-  data: Operation[];
-  options?: any;
-}
-
-export enum RequestStateEnum {
-  pending = 'pending',
-  fulfilled = 'fulfilled',
-  rejected = 'rejected',
-}
-
-export interface RequestState {
-  state: RequestStateEnum;
-  type: 'query' | 'mutation';
-  request: Request;
-  response?: Response;
-}
-
-export interface Response {
-  // rawData: unknown;
-  data: unknown;
-}