@warp-drive/legacy 5.9.0-alpha.21 → 5.9.0-alpha.22

package/declarations/compat/legacy-network-handler/minimum-serializer-interface.d.ts

@@ -1,220 +0,0 @@
-import type { Store } from "@warp-drive/core";
-import type { ModelSchema } from "@warp-drive/core/types";
-import type { ObjectValue } from "@warp-drive/core/types/json/raw";
-import type { JsonApiDocument, SingleResourceDocument } from "@warp-drive/core/types/spec/json-api-raw";
-import type { AdapterPayload } from "./minimum-adapter-interface.js";
-import type { Snapshot } from "./snapshot.js";
-/**
-* Options accepted by {@link MinimumSerializerInterface.serialize | serialize}
-* and related legacy serializer methods.
-*/
-export type SerializerOptions = {
-	/**
-	* whether the resource's id should be included in the serialized output
-	*/
-	includeId?: boolean;
-};
-export type RequestType = "findRecord" | "queryRecord" | "findAll" | "findBelongsTo" | "findHasMany" | "findMany" | "query" | "createRecord" | "deleteRecord" | "updateRecord";
-/**
-* :::danger
-⚠️ **This is LEGACY documentation** for a feature that is no longer encouraged to be used.
-If starting a new app or thinking of implementing a new adapter, consider writing a
-{@link Handler} instead to be used with the {@link RequestManager}
-:::
-
-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**.
-
-@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/main/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)
-	*
-	* @public
-	* @param store The store service that initiated the request being normalized
-	* @param schema An object with methods for accessing information about
-	*  the type, attributes and relationships of the primary type associated with the request.
-	* @param 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 id For a findRecord request, this is the id initially provided
-	*  in the call to store.findRecord. Else this value is null.
-	* @param requestType The type of request the Adapter had been asked to perform.
-	*
-	* @return a document following the structure of a [{json:api} Document](https://jsonapi.org/format/#document-structure).
-	*/
-	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 {@link 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.
-	*
-	* @public
-	* @param snapshot A Snapshot for the record to serialize
-	*/
-	serialize(snapshot: Snapshot, options?: SerializerOptions): ObjectValue;
-	/**
-	* 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/main/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.
-	*
-	* @public
-	* @optional
-	* @param schema An object with methods for accessing information about
-	*  the type, attributes and relationships of the primary type associated with the request.
-	* @param rawPayload Some raw JSON data to be normalized into a JSON:API Resource.
-	* @param prop When called by the EmbeddedRecordsMixin this param will be the
-	*  property at which the object provided as rawPayload was found.
-	* @return A JSON:API Document containing a single JSON:API Resource as its primary data.
-	*/
-	normalize?(schema: ModelSchema, rawPayload: ObjectValue, 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;
-	* }
-	* ```
-	*
-	* @public
-	* @optional
-	* @param hash A top most object of the request payload onto
-	*  which to append the serialized record
-	* @param schema An object with methods for accessing information about
-	*  the type, attributes and relationships of the primary type associated with the request.
-	* @param snapshot A Snapshot for the record to serialize
-	*/
-	serializeIntoHash?(hash: object, schema: ModelSchema, snapshot: Snapshot, options?: SerializerOptions): 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/main/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);
-	* }
-	* ```
-	*
-	* @public
-	* @optional
-	* @param store The store service that initiated the request being normalized
-	* @param rawPayload The raw JSON response data returned from an API request.
-	*  This JSON should be in the API format expected by the serializer.
-	*/
-	pushPayload?(store: Store, rawPayload: ObjectValue): 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.
-	*
-	* @public
-	* @optional
-	*/
-	destroy?(): void;
-}

package/declarations/compat/legacy-network-handler/serializer-response.d.ts

@@ -1,6 +0,0 @@
-import type { Store } from "@warp-drive/core";
-import type { ModelSchema } from "@warp-drive/core/types";
-import type { JsonApiDocument } from "@warp-drive/core/types/spec/json-api-raw";
-import type { AdapterPayload } from "./minimum-adapter-interface.js";
-import type { MinimumSerializerInterface, RequestType } from "./minimum-serializer-interface.js";
-export declare function normalizeResponseHelper(serializer: MinimumSerializerInterface | null, store: Store, modelClass: ModelSchema, payload: AdapterPayload, id: string | null, requestType: RequestType): JsonApiDocument;

package/declarations/compat/legacy-network-handler/snapshot-record-array.d.ts

@@ -1,110 +0,0 @@
-import type { Store } from "@warp-drive/core";
-import type { FindAllOptions } from "@warp-drive/core/types";
-import type { Snapshot } from "./snapshot.js";
-/**
-SnapshotRecordArray is not directly instantiable.
-Instances are provided to consuming application's
-adapters for certain `findAll` requests.
-
-@hideconstructor
-@public
-*/
-export declare class SnapshotRecordArray {
-	/**
-	* The ResourceType of the underlying records for the {@link Snapshot | Snapshots} in the array
-	*/
-	modelName: string;
-	/**
-	*  A hash of adapter options passed into the store method for this request.
-	
-	Example
-	
-	```js [app/adapters/post.js]
-	import MyCustomAdapter from './custom-adapter';
-	
-	export default class PostAdapter extends MyCustomAdapter {
-	findAll(store, type, sinceToken, snapshotRecordArray) {
-	if (snapshotRecordArray.adapterOptions.subscribe) {
-	// ...
-	}
-	// ...
-	}
-	}
-	```
-	*/
-	adapterOptions?: Record<string, unknown>;
-	/**
-	* The relationships to include for this request.
-	
-	Example
-	
-	```js [app/adapters/application.js]
-	import Adapter from '@ember-data/adapter';
-	
-	export default class ApplicationAdapter extends Adapter {
-	findAll(store, type, snapshotRecordArray) {
-	let url = `/${type.modelName}?include=${encodeURIComponent(snapshotRecordArray.include)}`;
-	
-	return fetch(url).then((response) => response.json())
-	}
-	}
-	```
-	*/
-	include?: string | string[];
-	/**
-	SnapshotRecordArray is not directly instantiable.
-	Instances are provided to consuming application's
-	adapters and serializers for certain requests.
-	
-	@private
-	@constructor
-	@param {Store} store
-	@param {String} type
-	@param options
-	*/
-	constructor(store: Store, type: string, options?: FindAllOptions);
-	/**
-	Number of records in the array
-	
-	Example
-	
-	```js [app/adapters/post.js]
-	import JSONAPIAdapter from '@ember-data/adapter/json-api';
-	
-	export default class PostAdapter extends JSONAPIAdapter {
-	shouldReloadAll(store, snapshotRecordArray) {
-	return !snapshotRecordArray.length;
-	}
-	});
-	```
-	*/
-	get length(): number;
-	/**
-	Get snapshots of the underlying record array
-	
-	Example
-	
-	```js [app/adapters/post.js]
-	import JSONAPIAdapter from '@ember-data/adapter/json-api';
-	
-	export default class PostAdapter extends JSONAPIAdapter {
-	shouldReloadAll(store, snapshotArray) {
-	let snapshots = snapshotArray.snapshots();
-	
-	return snapshots.any(function(ticketSnapshot) {
-	let timeDiff = moment().diff(ticketSnapshot.attr('lastAccessedAt'), 'minutes');
-	if (timeDiff > 20) {
-	return true;
-	} else {
-	return false;
-	}
-	});
-	}
-	}
-	```
-	
-	@public
-	@return Array of snapshots
-	*/
-	snapshots(): Snapshot[];
-}

package/declarations/compat/legacy-network-handler/snapshot.d.ts

@@ -1,255 +0,0 @@
-import type { Store } from "@warp-drive/core";
-import type { FindRecordOptions } from "@warp-drive/core/types";
-import type { ChangedAttributesHash } from "@warp-drive/core/types/cache";
-import type { ResourceKey } from "@warp-drive/core/types/identifier";
-import type { TypedRecordInstance, TypeFromInstance } from "@warp-drive/core/types/record";
-import type { LegacyAttributeField, LegacyRelationshipField } from "@warp-drive/core/types/schema/fields";
-import type { SerializerOptions } from "./minimum-serializer-interface.js";
-type RecordId = string | null;
-/**
-Snapshot is not directly instantiable.
-Instances are provided to a consuming application's
-adapters and serializers for certain requests.
-
-Snapshots are only available when using `@ember-data/legacy-compat`
-for legacy compatibility with adapters and serializers.
-
-For serialization of records in modern paradigms, request data from
-the cache or off the record directly.
-
-@hideconstructor
-@public
-*/
-export declare class Snapshot<R = unknown> {
-	/**
-	The unique ResourceKey associated with this Snapshot.
-	
-	@public
-	*/
-	identifier: ResourceKey<R extends TypedRecordInstance ? TypeFromInstance<R> : string>;
-	/**
-	The ResourceType of the underlying record for this Snapshot, as a string.
-	
-	@public
-	*/
-	modelName: R extends TypedRecordInstance ? TypeFromInstance<R> : string;
-	/**
-	The id of the snapshot's underlying record
-	
-	Example
-	
-	```js
-	// store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });
-	postSnapshot.id; // => '1'
-	```
-	
-	@public
-	*/
-	id: string | null;
-	/**
-	If `include` was passed to the options for the request, the value
-	would be available here.
-	
-	@public
-	*/
-	include?: string | string[];
-	/**
-	The adapterOptions passed to the request which generated this Snapshot, if any
-	
-	@public
-	*/
-	adapterOptions?: Record<string, unknown>;
-	constructor(options: FindRecordOptions, identifier: ResourceKey<R extends TypedRecordInstance ? TypeFromInstance<R> : string>, store: Store);
-	/**
-	The underlying record for this snapshot. Can be used to access methods and
-	properties defined on the record.
-	
-	```js
-	const someValue = snapshot.record.someProp;
-	```
-	
-	@property record
-	@public
-	*/
-	get record(): R | null;
-	get isNew(): boolean;
-	/**
-	Returns the value of an attribute.
-	
-	Example
-	
-	```javascript
-	// store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });
-	postSnapshot.attr('author'); // => 'Tomster'
-	postSnapshot.attr('title'); // => 'Ember.js rocks'
-	```
-	
-	Note: Values are loaded eagerly and cached when the snapshot is created.
-	
-	@return The attribute value or undefined
-	@public
-	*/
-	attr(keyName: keyof R & string): unknown;
-	/**
-	Returns all attributes and their corresponding values.
-	
-	::: warning ⚠️ WARNING
-	Attributes are SHALLOW copied from the cache.
-	Because they are NOT deep copied from the cache, mutating
-	any object or array fields will cause unintended side-effects
-	and bugs.
-	:::
-	
-	Example
-	
-	```js
-	// store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });
-	postSnapshot.attributes(); // => { author: 'Tomster', title: 'Ember.js rocks' }
-	```
-	
-	@return All attributes of the current snapshot
-	@public
-	*/
-	attributes(): Record<keyof R & string, unknown>;
-	/**
-	Returns all changed attributes and their old and new values.
-	
-	Example
-	
-	```js
-	// store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });
-	postModel.set('title', 'Ember.js rocks!');
-	postSnapshot.changedAttributes(); // => { title: ['Ember.js rocks', 'Ember.js rocks!'] }
-	```
-	
-	@return All changed attributes of the current snapshot
-	@public
-	*/
-	changedAttributes(): ChangedAttributesHash;
-	/**
-	Returns the current value of a belongsTo relationship.
-	
-	`belongsTo` takes an optional hash of options as a second parameter,
-	currently supported options are:
-	
-	- `id`: set to `true` if you only want the ID of the related record to be
-	returned.
-	
-	Example
-	
-	```js
-	// store.push('post', { id: 1, title: 'Hello World' });
-	// store.createRecord('comment', { body: 'Lorem ipsum', post: post });
-	commentSnapshot.belongsTo('post'); // => Snapshot
-	commentSnapshot.belongsTo('post', { id: true }); // => '1'
-	
-	// store.push('comment', { id: 1, body: 'Lorem ipsum' });
-	commentSnapshot.belongsTo('post'); // => undefined
-	```
-	
-	Calling `belongsTo` will return a new Snapshot as long as there's any known
-	data for the relationship available, such as an ID. If the relationship is
-	known but unset, `belongsTo` will return `null`. If the contents of the
-	relationship is unknown `belongsTo` will return `undefined`.
-	
-	Note: Relationships are loaded lazily and cached upon first access.
-	
-	@public
-	@return A snapshot or ID of a known relationship or null if the
-	relationship is known but unset. undefined will be returned if the
-	contents of the relationship are unknown.
-	*/
-	belongsTo(keyName: string, options?: {
-		id?: boolean;
-	}): Snapshot | RecordId | undefined;
-	/**
-	Returns the current value of a hasMany relationship.
-	
-	`hasMany` takes an optional hash of options as a second parameter,
-	currently supported options are:
-	
-	- `ids`: set to `true` if you only want the IDs of the related records to be
-	returned.
-	
-	Example
-	
-	```javascript
-	// store.push('post', { id: 1, title: 'Hello World', comments: [2, 3] });
-	postSnapshot.hasMany('comments'); // => [Snapshot, Snapshot]
-	postSnapshot.hasMany('comments', { ids: true }); // => ['2', '3']
-	
-	// store.push('post', { id: 1, title: 'Hello World' });
-	postSnapshot.hasMany('comments'); // => undefined
-	```
-	
-	Note: Relationships are loaded lazily and cached upon first access.
-	
-	@public
-	@return An array of snapshots or IDs of a known
-	relationship or an empty array if the relationship is known but unset.
-	undefined will be returned if the contents of the relationship is unknown.
-	*/
-	hasMany(keyName: string, options?: {
-		ids?: boolean;
-	}): RecordId[] | Snapshot[] | undefined;
-	/**
-	Iterates through all the attributes of the model, calling the passed
-	function on each attribute.
-	
-	Example
-	
-	```javascript
-	snapshot.eachAttribute(function(name, meta) {
-	// ...
-	});
-	```
-	
-	@param callback the callback to execute
-	@param binding the optional value to which the callback's `this` should be bound
-	@public
-	*/
-	eachAttribute(callback: (key: string, meta: LegacyAttributeField) => void, binding?: unknown): void;
-	/**
-	Iterates through all the relationships of the model, calling the passed
-	function on each relationship.
-	
-	Example
-	
-	```javascript
-	snapshot.eachRelationship(function(name, relationship) {
-	// ...
-	});
-	```
-	
-	@param callback the callback to execute
-	@param binding the optional value to which the callback's `this` should be bound
-	@public
-	*/
-	eachRelationship(callback: (key: string, meta: LegacyRelationshipField) => void, binding?: unknown): void;
-	/**
-	Serializes the snapshot using the serializer for the model.
-	
-	Example
-	
-	```js [app/adapters/application.js]
-	import Adapter from '@ember-data/adapter';
-	
-	export default Adapter.extend({
-	createRecord(store, type, snapshot) {
-	let data = snapshot.serialize({ includeId: true });
-	let url = `/${type.modelName}`;
-	
-	return fetch(url, {
-	method: 'POST',
-	body: data,
-	}).then((response) => response.json())
-	}
-	});
-	```
-	
-	@return an object whose values are primitive JSON values only
-	@public
-	*/
-	serialize(options?: SerializerOptions): unknown;
-}
-export {};