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

package/addon/-private/ts-interfaces/minimum-serializer-interface.ts

@@ -1,257 +0,0 @@
-import type { Object as JSONObject } from 'json-typescript';
-
-import type Store from '../system/core-store';
-import type Snapshot from '../system/snapshot';
-import type { ModelSchema } from './ds-model';
-import type { JsonApiDocument, SingleResourceDocument } from './ember-data-json-api';
-import type { AdapterPayload } from './minimum-adapter-interface';
-import type { Dict } from './utils';
-
-export type OptionsHash = Dict<unknown>;
-export type RequestType =
-  | 'findRecord'
-  | 'queryRecord'
-  | 'findAll'
-  | 'findBelongsTo'
-  | 'findHasMany'
-  | 'findMany'
-  | 'query'
-  | 'createRecord'
-  | 'deleteRecord'
-  | 'updateRecord';
-/**
-  @module @ember-data/serializer
- */
-
-/**
-  The following documentation describes the methods an application
-  serializer should implement with descriptions around when an
-  application might expect these methods to be called.
-
-  Methods that are not required are marked as **optional**.
-
-  @class MinimumSerializerInterface
-  @public
-*/
-export interface MinimumSerializerInterface {
-  /**
-   * This method is responsible for normalizing the value resolved from the promise returned
-   * by an Adapter request into the format expected by the `Store`.
-   *
-   * The output should be a [JSON:API Document](https://jsonapi.org/format/#document-structure)
-   * with the following additional restrictions:
-   *
-   * - `type` should be formatted in the `singular` `dasherized` `lowercase` form
-   * - `members` (the property names of attributes and relationships) should be formatted
-   *    to match their definition in the corresponding `Model` definition. Typically this
-   *    will be `camelCase`.
-   * - [`lid`](https://github.com/emberjs/rfcs/blob/master/text/0403-ember-data-identifiers.md) is
-   *    a valid optional sibling to `id` and `type` in both [Resources](https://jsonapi.org/format/#document-resource-objects)
-   *    and [Resource Identifier Objects](https://jsonapi.org/format/#document-resource-identifier-objects)
-   *
-   * @method normalizeResponse
-   * @public
-   * @param {Store} store The store service that initiated the request being normalized
-   * @param {ModelSchema} schema An object with methods for accessing information about
-   *  the type, attributes and relationships of the primary type associated with the request.
-   * @param {JSONObject} rawPayload The raw JSON response data returned from an API request.
-   *  This correlates to the value the promise returned by the adapter method that performed
-   *  the request resolved to.
-   * @param {string|null} id For a findRecord request, this is the id initially provided
-   *  in the call to store.findRecord. Else this value is null.
-   * @param {'findRecord' | 'queryRecord' | 'findAll' | 'findBelongsTo' | 'findHasMany' | 'findMany' | 'query' | 'createRecord' | 'deleteRecord' | 'updateRecord'} requestType The
-   *  type of request the Adapter had been asked to perform.
-   *
-   * @returns {JsonApiDocument} a document following the structure of a JSON:API Document.
-   */
-  normalizeResponse(
-    store: Store,
-    schema: ModelSchema,
-    rawPayload: AdapterPayload,
-    id: string | null,
-    requestType:
-      | 'findRecord'
-      | 'queryRecord'
-      | 'findAll'
-      | 'findBelongsTo'
-      | 'findHasMany'
-      | 'findMany'
-      | 'query'
-      | 'createRecord'
-      | 'deleteRecord'
-      | 'updateRecord'
-  ): JsonApiDocument;
-
-  /**
-   * This method is responsible for serializing an individual record
-   * via a [Snapshot](Snapshot) into the format expected by the API.
-   *
-   * This method is called by `snapshot.serialize()`.
-   *
-   * When using `Model`, this method is called by `record.serialize()`.
-   *
-   * When using `JSONAPIAdapter` or `RESTAdapter` this method is called
-   * by `updateRecord` and `createRecord` if `Serializer.serializeIntoHash`
-   * is not implemented.
-   *
-   * @method serialize
-   * @public
-   * @param {Snapshot} snapshot A Snapshot for the record to serialize
-   * @param {object} [options]
-   */
-  serialize(snapshot: Snapshot, options?: OptionsHash): JSONObject;
-
-  /**
-   * This method is intended to normalize data into a [JSON:API Document](https://jsonapi.org/format/#document-structure)
-   * with a data member containing a single [Resource](https://jsonapi.org/format/#document-resource-objects).
-   *
-   * - `type` should be formatted in the singular, dasherized and lowercase form
-   * - `members` (the property names of attributes and relationships) should be formatted
-   *    to match their definition in the corresponding `Model` definition. Typically this
-   *    will be `camelCase`.
-   * - [`lid`](https://github.com/emberjs/rfcs/blob/master/text/0403-ember-data-identifiers.md) is
-   *    a valid optional sibling to `id` and `type` in both [Resources](https://jsonapi.org/format/#document-resource-objects)
-   *    and [Resource Identifier Objects](https://jsonapi.org/format/#document-resource-identifier-objects)
-   *
-   * This method is called by the `Store` when `store.normalize(modelName, payload)` is
-   * called. It is recommended to use `store.serializerFor(modelName).normalizeResponse`
-   * over `store.normalize`.
-   *
-   * This method may be called when also using the `RESTSerializer`
-   * when `serializer.pushPayload` is called by `store.pushPayload`.
-   * However, it is recommended to use `store.push` over `store.pushPayload` after normalizing
-   * the payload directly.
-   *
-   * Example:
-   * ```js
-   * function pushPayload(store, modelName, rawPayload) {
-   *   const ModelClass = store.modelFor(modelName);
-   *   const serializer = store.serializerFor(modelName);
-   *   const jsonApiPayload = serializer.normalizeResponse(store, ModelClass, rawPayload, null, 'query');
-   *
-   *   return store.push(jsonApiPayload);
-   * }
-   * ```
-   *
-   * This method may be called when also using the `JSONAPISerializer`
-   * when normalizing included records. If mixing serializer usage in this way
-   * we recommend implementing this method, but caution that it may lead
-   * to unexpected mixing of formats.
-   *
-   * This method may also be called when normalizing embedded relationships when
-   * using the `EmbeddedRecordsMixin`. If using this mixin in a serializer in
-   * your application we recommend implementing this method, but caution that
-   * it may lead to unexpected mixing of formats.
-   *
-   * @method normalize [OPTIONAL]
-   * @public
-   * @optional
-   * @param {ModelSchema} schema An object with methods for accessing information about
-   *  the type, attributes and relationships of the primary type associated with the request.
-   * @param {JSONObject} rawPayload Some raw JSON data to be normalized into a JSON:API Resource.
-   * @param {string} [prop] When called by the EmbeddedRecordsMixin this param will be the
-   *  property at which the object provided as rawPayload was found.
-   * @returns {SingleResourceDocument} A JSON:API Document
-   *  containing a single JSON:API Resource
-   *  as its primary data.
-   */
-  normalize?(schema: ModelSchema, rawPayload: JSONObject, prop?: string): SingleResourceDocument;
-
-  /**
-   * When using `JSONAPIAdapter` or `RESTAdapter` this method is called
-   * by `adapter.updateRecord` and `adapter.createRecord` if `serializer.serializeIntoHash`
-   * is implemented. If this method is not implemented, `serializer.serialize`
-   * will be called in this case.
-   *
-   * You can use this method to customize the root keys serialized into the payload.
-   * The hash property should be modified by reference.
-   *
-   * For instance, your API may expect resources to be keyed by underscored type in the payload:
-   *
-   * ```js
-   * {
-   *   _user: {
-   *     type: 'user',
-   *     id: '1'
-   *   }
-   * }
-   * ```
-   *
-   * Which when using these adapters can be achieved by implementing this method similar
-   * to the following:
-   *
-   * ```js
-   * serializeIntoHash(hash, ModelClass, snapshot, options) {
-   *   hash[`_${snapshot.modelName}`] = this.serialize(snapshot, options).data;
-   * }
-   * ```
-   *
-   * @method serializeIntoHash [OPTIONAL]
-   * @public
-   * @optional
-   * @param hash A top most object of the request payload onto
-   *  which to append the serialized record
-   * @param {ModelSchema} schema An object with methods for accessing information about
-   *  the type, attributes and relationships of the primary type associated with the request.
-   * @param {Snapshot} snapshot A Snapshot for the record to serialize
-   * @param [options]
-   * @returns {void}
-   */
-  serializeIntoHash?(hash: object, schema: ModelSchema, snapshot: Snapshot, options?: OptionsHash): void;
-
-  /**
-   * This method allows for normalization of data when `store.pushPayload` is called
-   * and should be implemented if you want to use that method.
-   *
-   * The method is responsible for pushing new data to the store using `store.push`
-   * once any necessary normalization has occurred, and no data in the store will be
-   * updated unless it does so.
-   *
-   * The normalized form pushed to the store should be a [JSON:API Document](https://jsonapi.org/format/#document-structure)
-   * with the following additional restrictions:
-   *
-   * - `type` should be formatted in the singular, dasherized and lowercase form
-   * - `members` (the property names of attributes and relationships) should be formatted
-   *    to match their definition in the corresponding `Model` definition. Typically this
-   *    will be `camelCase`.
-   * - [`lid`](https://github.com/emberjs/rfcs/blob/master/text/0403-ember-data-identifiers.md) is
-   *    a valid optional sibling to `id` and `type` in both [Resources](https://jsonapi.org/format/#document-resource-objects)
-   *    and [Resource Identifier Objects](https://jsonapi.org/format/#document-resource-identifier-objects)
-   *
-   * If you need better control over normalization or want access to the records being added or updated
-   * in the store, we recommended using `store.push` over `store.pushPayload` after normalizing
-   * the payload directly. This can even take advantage of an existing serializer for the format
-   * the data is in, for example:
-   *
-   * ```js
-   * function pushPayload(store, modelName, rawPayload) {
-   *   const ModelClass = store.modelFor(modelName);
-   *   const serializer = store.serializerFor(modelName);
-   *   const jsonApiPayload = serializer.normalizeResponse(store, ModelClass, rawPayload, null, 'query');
-   *
-   *   return store.push(jsonApiPayload);
-   * }
-   * ```
-   *
-   * @method pushPayload [OPTIONAL]
-   * @public
-   * @optional
-   * @param {Store} store The store service that initiated the request being normalized
-   * @param {JSONObject} rawPayload The raw JSON response data returned from an API request.
-   *  This JSON should be in the API format expected by the serializer.
-   * @returns {void}
-   */
-  pushPayload?(store: Store, rawPayload: JSONObject): void;
-
-  /**
-   * In some situations the serializer may need to perform cleanup when destroyed,
-   * that cleanup can be done in `destroy`.
-   *
-   * If not implemented, the store does not inform the serializer of destruction.
-   *
-   * @method destroy [OPTIONAL]
-   * @public
-   * @optional
-   */
-  destroy?(): void;
-}

package/addon/-private/ts-interfaces/promise-proxies.ts

@@ -1,3 +0,0 @@
-// shim type until we can properly type
-// these proxies
-export type PromiseProxy<T> = Promise<T>;

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

@@ -1,29 +0,0 @@
-import type { CollectionResourceRelationship, SingleResourceRelationship } from './ember-data-json-api';
-import type { Dict } from './utils';
-
-/**
-  @module @ember-data/store
-*/
-
-export type AttributesHash = Dict<unknown>;
-
-export interface JsonApiResource {
-  id?: string | null;
-  type?: string;
-  attributes?: AttributesHash;
-  relationships?: {
-    [key: string]: SingleResourceRelationship | CollectionResourceRelationship;
-  };
-  meta?: any;
-  lid?: string;
-}
-
-export interface JsonApiValidationError {
-  title: string;
-  detail: string;
-  source: {
-    pointer: string;
-  };
-}
-
-export type JsonApiRelationship = SingleResourceRelationship | CollectionResourceRelationship;

package/addon/-private/ts-interfaces/record-data-record-wrapper.ts

@@ -1,46 +0,0 @@
-import type { CollectionResourceRelationship, SingleResourceRelationship } from './ember-data-json-api';
-import type { RecordIdentifier } from './identifier';
-import type { ChangedAttributesHash } from './record-data';
-import type { JsonApiValidationError } from './record-data-json-api';
-
-/**
-  @module @ember-data/store
-*/
-
-export interface RecordDataRecordWrapper {
-  rollbackAttributes(): string[];
-  changedAttributes(): ChangedAttributesHash;
-  hasChangedAttributes(): boolean;
-  setDirtyAttribute(key: string, value: any): void;
-
-  getAttr(key: string): any;
-  getHasMany(key: string): CollectionResourceRelationship;
-
-  addToHasMany(key: string, recordDatas: RecordDataRecordWrapper[], idx?: number): void;
-  removeFromHasMany(key: string, recordDatas: RecordDataRecordWrapper[]): void;
-  setDirtyHasMany(key: string, recordDatas: RecordDataRecordWrapper[]): void;
-
-  getBelongsTo(key: string): SingleResourceRelationship;
-
-  setDirtyBelongsTo(name: string, recordData: RecordDataRecordWrapper | null): void;
-
-  // ----- unspecced
-  isAttrDirty(key: string): boolean;
-  removeFromInverseRelationships(): void;
-  hasAttr(key: string): boolean;
-
-  // new
-  getErrors?(recordIdentifier: RecordIdentifier): JsonApiValidationError[];
-  /**
-   * @internal
-   * @deprecated
-   */
-  getErrors?({}): JsonApiValidationError[]; // eslint-disable-line no-empty-pattern
-
-  isNew?(): boolean;
-  isDeleted?(): boolean;
-
-  isDeletionCommitted?(): boolean;
-
-  setIsDeleted?(isDeleted: boolean): void;
-}

package/addon/-private/ts-interfaces/record-data-schemas.ts

@@ -1,45 +0,0 @@
-/**
-  @module @ember-data/store
-*/
-
-import type { Dict } from './utils';
-
-export interface RelationshipSchema {
-  kind: 'belongsTo' | 'hasMany';
-  type: string; // related type
-  /**
-   * @internal
-   * @deprecated
-   */
-  key: string; // TODO @runspired remove our uses
-  // TODO @runspired should RFC be updated to make this optional?
-  // TODO @runspired sohuld RFC be update to enforce async and inverse are set? else internals need to know
-  // that meta came from DS.Model vs not from DS.Model as defaults should switch.
-  options: {
-    async?: boolean; // controls inverse unloading "client side delete semantics" so we should replace that with a real flag
-    polymorphic?: boolean;
-    inverse?: string | null; // property key on the related type (if any)
-    [key: string]: unknown;
-  };
-  // inverse?: string | null;
-  // inverseIsAsync?: boolean;
-  name: string; // property key for this relationship
-}
-
-export type RelationshipsSchema = Dict<RelationshipSchema>;
-
-export interface AttributeSchema {
-  /**
-   * @internal
-   */
-  kind: 'attribute'; // TODO @runspired remove usage or guard internally
-  name: string;
-
-  // TODO @runspired update RFC to make options optional
-  options: {
-    [key: string]: unknown;
-  };
-  type: string; // TODO @runspired update RFC to make type optional
-}
-
-export type AttributesSchema = Dict<AttributeSchema>;

package/addon/-private/ts-interfaces/record-data-store-wrapper.ts

@@ -1,56 +0,0 @@
-import type { RecordData } from './record-data';
-import type { AttributesSchema, RelationshipsSchema } from './record-data-schemas';
-
-/**
-  @module @ember-data/store
-*/
-
-/**
- * Provides encapsulated API access to a minimal subset of store service's
- * functionality for RecordData implementations.
- *
- * @class RecordDataStoreWrapper
- * @public
- */
-export interface RecordDataStoreWrapper {
-  relationshipsDefinitionFor(modelName: string): RelationshipsSchema;
-  attributesDefinitionFor(modelName: string): AttributesSchema;
-
-  /**
-   * update the `id` for the record of type `modelName` with the corresponding `clientId`
-   * This operation can only be done for records whose `id` is `null`.
-   *
-   * @method setRecordId
-   * @public
-   */
-  setRecordId(modelName: string, id: string, clientId: string): void;
-
-  disconnectRecord(modelName: string, id: string | null, clientId: string): void;
-  disconnectRecord(modelName: string, id: string, clientId?: string | null): void;
-  disconnectRecord(modelName: string, id: string | null, clientId?: string | null): void;
-
-  isRecordInUse(modelName: string, id: string | null, clientId: string): boolean;
-  isRecordInUse(modelName: string, id: string, clientId?: string | null): boolean;
-  isRecordInUse(modelName: string, id: string | null, clientId?: string | null): boolean;
-
-  notifyPropertyChange(modelName: string, id: string | null, clientId: string | null, key: string): void;
-
-  notifyHasManyChange(modelName: string, id: string | null, clientId: string, key: string): void;
-  notifyHasManyChange(modelName: string, id: string, clientId: string | null | undefined, key: string): void;
-  notifyHasManyChange(modelName: string, id: string | null, clientId: string | null | undefined, key: string): void;
-
-  recordDataFor(type: string, id: string, lid?: string | null): RecordData;
-  recordDataFor(type: string, id: string | null, lid: string): RecordData;
-  recordDataFor(type: string): RecordData;
-  recordDataFor(type: string, id?: string | null, lid?: string | null): RecordData;
-
-  notifyBelongsToChange(modelName: string, id: string | null, clientId: string, key: string): void;
-  notifyBelongsToChange(modelName: string, id: string, clientId: string | null | undefined, key: string): void;
-  notifyBelongsToChange(modelName: string, id: string | null, clientId: string | null | undefined, key: string): void;
-
-  inverseForRelationship(modelName: string, key: string): string | null;
-
-  inverseIsAsyncForRelationship(modelName: string, key: string): boolean;
-  notifyErrorsChange(modelName: string, id: string | null, clientId: string | null): void;
-  notifyStateChange(modelName: string, id: string | null, clientId: string | null, key?: string): void;
-}

package/addon/-private/ts-interfaces/record-data.ts

@@ -1,72 +0,0 @@
-import type { CollectionResourceRelationship, SingleResourceRelationship } from './ember-data-json-api';
-import type { RecordIdentifier } from './identifier';
-import type { JsonApiResource, JsonApiValidationError } from './record-data-json-api';
-
-/**
-  @module @ember-data/store
-*/
-
-export interface ChangedAttributesHash {
-  [key: string]: [string, string];
-}
-
-export interface RecordData {
-  getResourceIdentifier(): RecordIdentifier | undefined;
-
-  pushData(data: JsonApiResource, calculateChange: true): string[];
-  pushData(data: JsonApiResource, calculateChange?: false): void;
-  pushData(data: JsonApiResource, calculateChange?: boolean): string[] | void;
-  clientDidCreate(): void;
-  willCommit(): void;
-
-  commitWasRejected(recordIdentifier?: RecordIdentifier, errors?: JsonApiValidationError[]): void;
-  /**
-   * @deprecated
-   * @internal
-   */
-  commitWasRejected(recordIdentifier?: {}, errors?: JsonApiValidationError[]): void;
-
-  unloadRecord(): void;
-  rollbackAttributes(): string[];
-  changedAttributes(): ChangedAttributesHash;
-  hasChangedAttributes(): boolean;
-  setDirtyAttribute(key: string, value: any): void;
-
-  getAttr(key: string): any;
-  getHasMany(key: string): CollectionResourceRelationship;
-
-  addToHasMany(key: string, recordDatas: RecordData[], idx?: number): void;
-  removeFromHasMany(key: string, recordDatas: RecordData[]): void;
-  setDirtyHasMany(key: string, recordDatas: RecordData[]): void;
-
-  getBelongsTo(key: string): SingleResourceRelationship;
-
-  setDirtyBelongsTo(name: string, recordData: RecordData | null): void;
-  didCommit(data: JsonApiResource | null): void;
-
-  // ----- unspecced
-  isAttrDirty(key: string): boolean;
-  removeFromInverseRelationships(): void;
-  hasAttr(key: string): boolean;
-
-  isRecordInUse(): boolean;
-  _initRecordCreateOptions(options: any): { [key: string]: unknown };
-
-  // new
-  getErrors?(recordIdentifier: RecordIdentifier): JsonApiValidationError[];
-  /**
-   * @deprecated
-   * @internal
-   */
-  getErrors?({}): JsonApiValidationError[]; // eslint-disable-line no-empty-pattern
-
-  isNew?(): boolean;
-  isDeleted?(): boolean;
-
-  isDeletionCommitted?(): boolean;
-
-  setIsDeleted?(isDeleted: boolean): void;
-
-  // Private and experimental
-  __setId?(id: string): void;
-}

package/addon/-private/ts-interfaces/record-instance.ts

@@ -1,18 +0,0 @@
-import type { DSModel } from './ds-model';
-import type { Dict } from './utils';
-/**
-  @module @ember-data/store
-*/
-
-/*
-  A `Record` is the result of the store instantiating a class to present data for a resource to the UI.
-
-  Historically in `ember-data` this meant that it was the result of calling `_modelFactoryFor.create()` to
-  gain instance to a class built upon `@ember-data/model`. However, as we go forward into a future in which
-  model instances (aka `Records`) are completely user supplied and opaque to the internals, we need a type
-  through which to communicate what is valid.
-
-  The type belows allows for anything extending object.
-*/
-
-export type RecordInstance = DSModel | Dict<unknown>;

package/addon/-private/ts-interfaces/schema-definition-service.ts

@@ -1,12 +0,0 @@
-/**
-  @module @ember-data/store
-*/
-
-import type { RecordIdentifier } from './identifier';
-import type { AttributesSchema, RelationshipsSchema } from './record-data-schemas';
-
-export interface SchemaDefinitionService {
-  doesTypeExist(modelName: string): boolean;
-  attributesDefinitionFor(identifier: RecordIdentifier | { type: string }): AttributesSchema;
-  relationshipsDefinitionFor(identifier: RecordIdentifier | { type: string }): RelationshipsSchema;
-}

package/addon/-private/ts-interfaces/store.ts

@@ -1,10 +0,0 @@
-import type { Dict } from './utils';
-
-export interface FindOptions {
-  reload?: boolean;
-  backgroundReload?: boolean;
-  include?: string;
-  adapterOptions?: Dict<unknown>;
-  preload?: Dict<unknown>;
-  isReloading?: boolean;
-}

package/addon/-private/ts-interfaces/utils.ts

@@ -1,6 +0,0 @@
-/**
-  @module @ember-data/store
-*/
-
-export type ConfidentDict<V> = { [key: string]: V };
-export type Dict<V> = { [key: string]: V | undefined };