@ember-data/store 4.4.0-alpha.9 → 4.4.1

package/addon/-private/system/record-arrays/adapter-populated-record-array.ts

@@ -1,129 +0,0 @@
-import type NativeArray from '@ember/array/-private/native-array';
-import { assert } from '@ember/debug';
-
-import type { PromiseArray, RecordArrayManager } from 'ember-data/-private';
-
-import type { CollectionResourceDocument, Links, Meta, PaginationLinks } from '../../ts-interfaces/ember-data-json-api';
-import type { StableRecordIdentifier } from '../../ts-interfaces/identifier';
-import type { RecordInstance } from '../../ts-interfaces/record-instance';
-import type { FindOptions } from '../../ts-interfaces/store';
-import type { Dict } from '../../ts-interfaces/utils';
-import type CoreStore from '../core-store';
-import { promiseArray } from '../promise-proxies';
-import SnapshotRecordArray from '../snapshot-record-array';
-import RecordArray from './record-array';
-
-export interface AdapterPopulatedRecordArrayCreateArgs {
-  modelName: string;
-  store: CoreStore;
-  manager: RecordArrayManager;
-  content: NativeArray<StableRecordIdentifier>;
-  isLoaded: boolean;
-  query?: Dict<unknown>;
-  meta?: Meta;
-  links?: Links | PaginationLinks | null;
-}
-
-/**
-  @module @ember-data/store
-*/
-
-/**
-  Represents an ordered list of records whose order and membership is
-  determined by the adapter. For example, a query sent to the adapter
-  may trigger a search on the server, whose results would be loaded
-  into an instance of the `AdapterPopulatedRecordArray`.
-
-  This class should not be imported and instantiated by consuming applications.
-
-  ---
-
-  If you want to update the array and get the latest records from the
-  adapter, you can invoke [`update()`](AdapterPopulatedRecordArray/methods/update?anchor=update):
-
-  Example
-
-  ```javascript
-  // GET /users?isAdmin=true
-  store.query('user', { isAdmin: true }).then(function(admins) {
-
-    admins.then(function() {
-      console.log(admins.get("length")); // 42
-    });
-
-    // somewhere later in the app code, when new admins have been created
-    // in the meantime
-    //
-    // GET /users?isAdmin=true
-    admins.update().then(function() {
-      admins.get('isUpdating'); // false
-      console.log(admins.get("length")); // 123
-    });
-
-    admins.get('isUpdating'); // true
-  }
-  ```
-
-  @class AdapterPopulatedRecordArray
-  @public
-  @extends RecordArray
-*/
-export default class AdapterPopulatedRecordArray extends RecordArray {
-  declare links: Links | PaginationLinks | null;
-  declare meta: Dict<unknown> | null;
-  declare query: Dict<unknown> | null;
-
-  init(props?: AdapterPopulatedRecordArrayCreateArgs) {
-    assert(`Cannot initialize AdapterPopulatedRecordArray with isUpdating`, !props || !('isUpdating' in props));
-    super.init();
-    this.query = this.query || null;
-    this.links = this.links || null;
-    this.meta = this.meta || null;
-  }
-
-  replace() {
-    throw new Error(`The result of a server query (on ${this.modelName}) is immutable.`);
-  }
-
-  _update(): PromiseArray<RecordInstance, AdapterPopulatedRecordArray> {
-    const { store, query } = this;
-
-    // TODO save options from initial request?
-    return promiseArray(store._query(this.modelName, query, this, {}));
-  }
-
-  _setObjects(identifiers: StableRecordIdentifier[], payload: CollectionResourceDocument) {
-    // TODO: initial load should not cause change events at all, only
-    // subsequent. This requires changing the public api of adapter.query, but
-    // hopefully we can do that soon.
-    this.content.setObjects(identifiers);
-
-    this.setProperties({
-      isLoaded: true,
-      isUpdating: false,
-      // TODO this assign kills the root reference but a deep-copy would be required
-      // for both meta and links to actually not be by-ref. We whould likely change
-      // this to a dev-only deep-freeze.
-      meta: Object.assign({}, payload.meta),
-      links: Object.assign({}, payload.links),
-    });
-
-    this.manager._associateWithRecordArray(identifiers, this);
-  }
-
-  _createSnapshot(options: FindOptions) {
-    // this is private for users, but public for ember-data internals
-    // meta will only be present for an AdapterPopulatedRecordArray
-    return new SnapshotRecordArray(this, this.meta, options);
-  }
-
-  /**
-    @method _setIdentifiers
-    @param {StableRecordIdentifier[]} identifiers
-    @param {Object} payload normalized payload
-    @private
-  */
-  _setIdentifiers(identifiers: StableRecordIdentifier[], payload: CollectionResourceDocument): void {
-    this._setObjects(identifiers, payload);
-  }
-}

package/addon/-private/system/store/serializer-response.ts

@@ -1,85 +0,0 @@
-import { assert } from '@ember/debug';
-import { DEBUG } from '@glimmer/env';
-
-import { JsonApiDocument } from '../../ts-interfaces/ember-data-json-api';
-import { AdapterPayload } from '../../ts-interfaces/minimum-adapter-interface';
-import { MinimumSerializerInterface, RequestType } from '../../ts-interfaces/minimum-serializer-interface';
-import CoreStore from '../core-store';
-import ShimModelClass from '../model/shim-model-class';
-
-/**
-  This is a helper method that validates a JSON API top-level document
-
-  The format of a document is described here:
-  http://jsonapi.org/format/#document-top-level
-
-  @internal
-*/
-function validateDocumentStructure(doc?: AdapterPayload | JsonApiDocument): asserts doc is JsonApiDocument {
-  if (DEBUG) {
-    let errors: string[] = [];
-    if (!doc || typeof doc !== 'object') {
-      errors.push('Top level of a JSON API document must be an object');
-    } else {
-      if (!('data' in doc) && !('errors' in doc) && !('meta' in doc)) {
-        errors.push('One or more of the following keys must be present: "data", "errors", "meta".');
-      } else {
-        if ('data' in doc && 'errors' in doc) {
-          errors.push('Top level keys "errors" and "data" cannot both be present in a JSON API document');
-        }
-      }
-      if ('data' in doc) {
-        if (!(doc.data === null || Array.isArray(doc.data) || typeof doc.data === 'object')) {
-          errors.push('data must be null, an object, or an array');
-        }
-      }
-      if ('meta' in doc) {
-        if (typeof doc.meta !== 'object') {
-          errors.push('meta must be an object');
-        }
-      }
-      if ('errors' in doc) {
-        if (!Array.isArray(doc.errors)) {
-          errors.push('errors must be an array');
-        }
-      }
-      if ('links' in doc) {
-        if (typeof doc.links !== 'object') {
-          errors.push('links must be an object');
-        }
-      }
-      if ('jsonapi' in doc) {
-        if (typeof doc.jsonapi !== 'object') {
-          errors.push('jsonapi must be an object');
-        }
-      }
-      if ('included' in doc) {
-        if (typeof doc.included !== 'object') {
-          errors.push('included must be an array');
-        }
-      }
-    }
-
-    assert(
-      `Response must be normalized to a valid JSON API document:\n\t* ${errors.join('\n\t* ')}`,
-      errors.length === 0
-    );
-  }
-}
-
-export function normalizeResponseHelper(
-  serializer: MinimumSerializerInterface | null,
-  store: CoreStore,
-  modelClass: ShimModelClass,
-  payload: AdapterPayload,
-  id: string | null,
-  requestType: RequestType
-): JsonApiDocument {
-  let normalizedResponse = serializer
-    ? serializer.normalizeResponse(store, modelClass, payload, id, requestType)
-    : payload;
-
-  validateDocumentStructure(normalizedResponse);
-
-  return normalizedResponse;
-}