@warp-drive/legacy 5.8.0-alpha.4 → 5.8.0-alpha.41

package/declarations/model/-private/model.d.ts

@@ -28,9 +28,6 @@ export type FactoryCache = Record<string, ModelFactory>;
 export type ModelStore = Store & {
 	_modelFactoryCache: FactoryCache;
 };
-/**
-* @noInheritDoc
-*/
 interface Model {
 	/**
 	* The store service instance which created this record instance
@@ -89,8 +86,8 @@ interface Model {
 	```
 	
 	@public
-	@param {Object} options
-	@return {Promise} a promise that will be resolved when the adapter returns
+	@param options
+	@return a promise that will be resolved when the adapter returns
 	successfully or rejected if the adapter returns with an error.
 	*/
 	destroyRecord<T extends MinimalLegacyRecord>(this: T, options?: Record<string, unknown>): Promise<this>;
@@ -204,9 +201,9 @@ interface Model {
 	}
 	```
 	
+	@deprecated use {@link Store.request} instead
 	@public
-	@param {Object} options
-	@return {Promise} a promise that will be resolved when the adapter returns
+	@return a promise that will be resolved when the adapter returns
 	successfully or rejected if the adapter returns with an error.
 	*/
 	save<T extends MinimalLegacyRecord>(this: T, options?: Record<string, unknown>): Promise<this>;
@@ -414,7 +411,10 @@ interface Model {
 * the class to use as the reactive object for data of resource
 * of that type.
 *
+* @public
 * @noInheritDoc
+* @hideconstructor
+* @legacy
 */
 declare class Model extends EmberObject implements MinimalLegacyRecord {
 	/** @private */
@@ -428,9 +428,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	client. A record can also enter the empty state if the adapter is
 	unable to locate the record.
 	
-	@property isEmpty
 	@public
-	@readonly
 	*/
 	get isEmpty(): boolean;
 	/**
@@ -439,9 +437,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	data. It remains in this state until the adapter provides the
 	requested data.
 	
-	@property isLoading
 	@public
-	@readonly
 	*/
 	get isLoading(): boolean;
 	/**
@@ -460,9 +456,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	model.isLoaded;
 	```
 	
-	@property isLoaded
 	@public
-	@readonly
 	*/
 	get isLoaded(): boolean;
 	/**
@@ -485,9 +479,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	```
 	
 	@since 1.13.0
-	@property hasDirtyAttributes
 	@public
-	@readonly
 	*/
 	get hasDirtyAttributes(): boolean;
 	/**
@@ -508,9 +500,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	});
 	```
 	
-	@property isSaving
 	@public
-	@readonly
 	*/
 	get isSaving(): boolean;
 	/**
@@ -546,9 +536,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	});
 	```
 	
-	@property isDeleted
 	@public
-	@readonly
 	*/
 	get isDeleted(): boolean;
 	/**
@@ -568,9 +556,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	});
 	```
 	
-	@property isNew
 	@public
-	@readonly
 	*/
 	get isNew(): boolean;
 	/**
@@ -579,9 +565,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	A record will be in the `valid` state when the adapter did not report any
 	server-side validation failures.
 	
-	@property isValid
 	@public
-	@readonly
 	*/
 	get isValid(): boolean;
 	/**
@@ -600,9 +584,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	record.dirtyType; // 'created'
 	```
 	
-	@property dirtyType
 	@public
-	@readonly
 	*/
 	get dirtyType(): "created" | "updated" | "deleted" | "";
 	/**
@@ -620,9 +602,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	});
 	```
 	
-	@property isError
 	@public
-	@readonly
 	*/
 	get isError(): boolean;
 	set isError(v: boolean);
@@ -637,9 +617,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	record.isReloading; // true
 	```
 	
-	@property isReloading
 	@public
-	@readonly
 	*/
 	isReloading: boolean;
 	/**
@@ -657,14 +635,12 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	model.id; // '1'
 	```
 	
-	@property id
 	@public
 	*/
 	get id(): string | null;
 	set id(id: string | null);
 	toString(): string;
 	/**
-	@property currentState
 	@private
 	*/
 	get currentState(): RecordState;
@@ -672,9 +648,9 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	/**
 	The store service instance which created this record instance
 	
-	@property store
 	@public
 	*/
+	store: Store;
 	/**
 	When the record is in the `invalid` state this object will contain
 	any errors returned by the adapter. When present the errors hash
@@ -723,7 +699,6 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	{{/each}}
 	```
 	
-	@property errors
 	@public
 	*/
 	get errors(): Errors;
@@ -731,7 +706,6 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	This property holds the `AdapterError` object with which
 	last adapter operation was rejected.
 	
-	@property adapterError
 	@public
 	*/
 	get adapterError(): unknown;
@@ -797,7 +771,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	Represents the model's class name as a string. This can be used to look up the model's class name through
 	`Store`'s modelFor method.
 	
-	`modelName` is generated for you by EmberData. It will be a lowercased, dasherized string.
+	`modelName` is generated for you by WarpDrive. It will be a lowercased, dasherized string.
 	For example:
 	
 	```javascript
@@ -818,9 +792,8 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	}
 	});
 	```
-	@property modelName
+	
 	@public
-	@readonly
 	*/
 	static modelName: string;
 	/**
@@ -912,9 +885,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	//=> [ { name: 'posts', kind: 'hasMany' } ]
 	```
 	
-	@property relationships
 	@public
-	@readonly
 	*/
 	static get relationships(): Map<string, LegacyRelationshipField[]>;
 	/**
@@ -945,9 +916,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	//=> ['owner']
 	```
 	
-	@property relationshipNames
 	@public
-	@readonly
 	*/
 	static get relationshipNames(): {
 		hasMany: string[];
@@ -980,9 +949,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	//=> ['user', 'post']
 	```
 	
-	@property relatedTypes
 	@public
-	@readonly
 	*/
 	static get relatedTypes(): string[];
 	/**
@@ -1015,9 +982,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	//=> { name: 'owner', kind: 'belongsTo', type: 'user', options: Object }
 	```
 	
-	@property relationshipsByName
 	@public
-	@readonly
 	*/
 	static get relationshipsByName(): Map<string, LegacyRelationshipField>;
 	static get relationshipsObject(): Record<string, LegacyRelationshipField>;
@@ -1056,9 +1021,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	// title, attribute
 	```
 	
-	@property fields
 	@public
-	@readonly
 	*/
 	static get fields(): Map<string, "attribute" | "belongsTo" | "hasMany">;
 	/**
@@ -1067,8 +1030,8 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	descriptor.
 	
 	@public
-	@param {Function} callback the callback to invoke
-	@param {any} binding the value to which the callback's `this` should be bound
+	@param callback the callback to invoke
+	@param binding the value to which the callback's `this` should be bound
 	*/
 	static eachRelationship<
 		T,
@@ -1081,8 +1044,8 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	with a model.
 	
 	@public
-	@param {Function} callback the callback to invoke
-	@param {any} binding the value to which the callback's `this` should be bound
+	@param callback the callback to invoke
+	@param binding the value to which the callback's `this` should be bound
 	*/
 	static eachRelatedType<T>(callback: (this: T | undefined, type: string) => void, binding?: T): void;
 	/**
@@ -1123,9 +1086,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	// birthday {type: "date", kind: 'attribute', options: Object, parentType: function, name: "birthday"}
 	```
 	
-	@property attributes
 	@public
-	@readonly
 	*/
 	static get attributes(): Map<string, LegacyAttributeField>;
 	/**
@@ -1160,9 +1121,7 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	// birthday date
 	```
 	
-	@property transformedAttributes
 	@public
-	@readonly
 	*/
 	static get transformedAttributes(): Map<string, string>;
 	/**
@@ -1204,8 +1163,8 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	```
 	
 	@public
-	@param {Function} callback The callback to execute
-	@param {Object} [binding] the value to which the callback's `this` should be bound
+	@param callback The callback to execute
+	@param binding [optional] the value to which the callback's `this` should be bound
 	*/
 	static eachAttribute<
 		T,
@@ -1251,8 +1210,8 @@ declare class Model extends EmberObject implements MinimalLegacyRecord {
 	```
 	
 	@public
-	@param {Function} callback The callback to execute
-	@param {Object} [binding] the value to which the callback's `this` should be bound
+	@param callback The callback to execute
+	@param binding [optional] the value to which the callback's `this` should be bound
 	*/
 	static eachTransformedAttribute<
 		T,

package/declarations/model/-private/promise-many-array.d.ts

@@ -22,7 +22,6 @@ In your JS code you should resolve the promise first.
 const comments = await post.comments;
 ```
 
-@class PromiseManyArray
 @public
 */
 export declare class PromiseManyArray<T = unknown> {
@@ -32,7 +31,6 @@ export declare class PromiseManyArray<T = unknown> {
 	constructor(promise: Promise<ManyArray<T>>, content?: ManyArray<T>);
 	/**
 	* Retrieve the length of the content
-	* @property length
 	* @public
 	*/
 	get length(): number;
@@ -50,39 +48,29 @@ export declare class PromiseManyArray<T = unknown> {
 	/**
 	* Reload the relationship
 	* @public
-	* @param options
-	* @return
 	*/
 	reload(options: Omit<BaseFinderOptions, "">): this;
 	/**
 	* Whether the loading promise is still pending
 	*
-	* @property isPending
-	* @type {Boolean}
 	* @public
 	*/
 	isPending: boolean;
 	/**
 	* Whether the loading promise rejected
 	*
-	* @property isRejected
-	* @type {Boolean}
 	* @public
 	*/
 	isRejected: boolean;
 	/**
 	* Whether the loading promise succeeded
 	*
-	* @property isFulfilled
-	* @type {Boolean}
 	* @public
 	*/
 	isFulfilled: boolean;
 	/**
 	* Whether the loading promise completed (resolved or rejected)
 	*
-	* @property isSettled
-	* @type {Boolean}
 	* @public
 	*/
 	isSettled: boolean;
@@ -95,28 +83,22 @@ export declare class PromiseManyArray<T = unknown> {
 	/**
 	* catch errors thrown by this promise
 	* @public
-	* @param callback
-	* @return {Promise}
 	*/
 	catch(cb: Parameters<Promise<ManyArray<T>>["catch"]>[0]): Promise<unknown>;
 	/**
 	* run cleanup after this promise completes
 	*
 	* @public
-	* @param callback
-	* @return {Promise}
 	*/
 	finally(cb: Parameters<Promise<ManyArray<T>>["finally"]>[0]): Promise<unknown>;
 	destroy(): void;
 	/**
 	* Retrieve the links for this relationship
-	* @property links
 	* @public
 	*/
 	get links(): Links | null | undefined;
 	/**
 	* Retrieve the meta for this relationship
-	* @property meta
 	* @public
 	*/
 	get meta(): Record<string, unknown> | null | undefined;

package/declarations/model/-private/record-state.d.ts

@@ -1,6 +1,6 @@
 import type { MinimalLegacyRecord } from "./model-methods.js";
 /**
-Historically EmberData managed a state machine
+Historically WarpDrive managed a state machine
 for each record, the localState for which
 was reflected onto Model.
 

package/declarations/model/-private/references/belongs-to.d.ts

@@ -10,11 +10,11 @@ A `BelongsToReference` is a low-level API that allows access
 and manipulation of a belongsTo relationship.
 
 It is especially useful when you're dealing with `async` relationships
-from `@ember-data/model` as it allows synchronous access to
+from `@warp-drive/legacy/model` as it allows synchronous access to
 the relationship data if loaded, as well as APIs for loading, reloading
 the data or accessing available information without triggering a load.
 
-It may also be useful when using `sync` relationships with `@ember-data/model`
+It may also be useful when using `sync` relationships with `@warp-drive/legacy/model`
 that need to be loaded/reloaded with more precise timing than marking the
 relationship as `async` and relying on autofetch would have allowed.
 
@@ -30,7 +30,6 @@ invalidate if the relationship state changes.
 References are "stable", meaning that multiple calls to retrieve the reference
 for a given relationship will always return the same HasManyReference.
 
-@class BelongsToReference
 @public
 */
 export default class BelongsToReference<
@@ -44,17 +43,11 @@ export default class BelongsToReference<
 	/**
 	* The field name on the parent record for this has-many relationship.
 	*
-	* @property key
-	* @type {String}
-	* @public
 	*/
 	key: K;
 	/**
 	* The type of resource this relationship will contain.
 	*
-	* @property type
-	* @type {String}
-	* @public
 	*/
 	type: TypeFromInstanceOrString<Related>;
 	___token: object;
@@ -67,9 +60,6 @@ export default class BelongsToReference<
 	* The identifier of the record that this reference refers to.
 	* `null` if no related record is known.
 	*
-	* @property identifier
-	* @type {ResourceKey | null}
-	* @public
 	*/
 	get identifier(): ResourceKey<TypeFromInstanceOrString<Related>> | null;
 	/**
@@ -109,11 +99,11 @@ export default class BelongsToReference<
 	```
 	
 	@public
-	@return {String} The id of the record in this belongsTo relationship.
+	@return The id of the record in this belongsTo relationship.
 	*/
 	id(): string | null;
 	/**
-	The link Ember Data will use to fetch or reload this belongs-to
+	The link WarpDrive will use to fetch or reload this belongs-to
 	relationship. By default it uses only the "related" resource linkage.
 	
 	Example
@@ -147,7 +137,7 @@ export default class BelongsToReference<
 	```
 	
 	@public
-	@return {String} The link Ember Data will use to fetch or reload this belongs-to relationship.
+	@return The link WarpDrive will use to fetch or reload this belongs-to relationship.
 	*/
 	link(): string | null;
 	/**
@@ -194,7 +184,7 @@ export default class BelongsToReference<
 	```
 	
 	@public
-	@return {Object} The meta information for the belongs-to relationship.
+	@return The meta information for the belongs-to relationship.
 	*/
 	meta(): Meta | null;
 	_resource(): SingleResourceRelationship<ResourceKey<TypeFromInstance<Related>>>;
@@ -206,7 +196,7 @@ export default class BelongsToReference<
 	Example
 	
 	```js [app/models/post.js]
-	import Model, { hasMany } from '@ember-data/model';
+	import Model, { hasMany } from '@warp-drive/legacy/model';
 	
 	export default class PostModel extends Model {
 	@hasMany('comment', { async: true, inverse: null }) comments;
@@ -237,11 +227,11 @@ export default class BelongsToReference<
 	```
 	
 	@public
-	@return {String} The name of the remote type. This should either be `link` or `id`
+	@return The name of the remote type. This should either be `link` or `id`
 	*/
 	remoteType(): "link" | "id";
 	/**
-	`push` can be used to update the data in the relationship and EmberData
+	`push` can be used to update the data in the relationship and WarpDrive
 	will treat the new data as the canonical value of this relationship on
 	the backend. A value of `null` (e.g. `{ data: null }`) can be passed to
 	clear the relationship.
@@ -328,9 +318,9 @@ export default class BelongsToReference<
 	forcing the load of all of the associated record.
 	
 	@public
-	@param {Object} doc a JSONAPI document object describing the new value of this relationship.
-	@param {Boolean} [skipFetch] if `true`, do not attempt to fetch unloaded records
-	@return {Promise<OpaqueRecordInstance | null | void>}
+	@param doc a JSONAPI document object describing the new value of this relationship.
+	@param skipFetch [optional] if `true`, do not attempt to fetch unloaded records
+	@return a promise that resolves with the record in this belongs-to relationship after the push has completed.
 	*/
 	push(doc: SingleResourceDocument, skipFetch?: boolean): Promise<Related | null | void>;
 	/**
@@ -380,7 +370,7 @@ export default class BelongsToReference<
 	```
 	
 	@public
-	@return {Model} the record in this relationship
+	@return the record in this relationship
 	*/
 	value(): Related | null;
 	/**
@@ -430,7 +420,7 @@ export default class BelongsToReference<
 	});
 	```
 	```js [app/adapters/user.js]
-	import Adapter from '@ember-data/adapter';
+	import Adapter from '@warp-drive/legacy/adapter';
 	
 	export default class UserAdapter extends Adapter {
 	findRecord(store, type, id, snapshot) {
@@ -441,13 +431,13 @@ export default class BelongsToReference<
 	```
 	
 	@public
-	@param {Object} options the options to pass in.
-	@return {Promise} a promise that resolves with the record in this belongs-to relationship.
+	@param options the options to pass in.
+	@return a promise that resolves with the record in this belongs-to relationship.
 	*/
 	load(options?: Record<string, unknown>): Promise<Related | null>;
 	/**
 	Triggers a reload of the value in this relationship. If the
-	remoteType is `"link"` Ember Data will use the relationship link to
+	remoteType is `"link"` WarpDrive will use the relationship link to
 	reload the relationship. Otherwise it will reload the record by its
 	id.
 	
@@ -491,8 +481,8 @@ export default class BelongsToReference<
 	```
 	
 	@public
-	@param {Object} options the options to pass in.
-	@return {Promise} a promise that resolves with the record in this belongs-to relationship after the reload has completed.
+	@param options the options to pass in.
+	@return a promise that resolves with the record in this belongs-to relationship after the reload has completed.
 	*/
 	reload(options?: Record<string, unknown>): Promise<Related | null>;
 }

package/declarations/model/-private/references/has-many.d.ts

@@ -19,11 +19,11 @@ A `HasManyReference` is a low-level API that allows access
 and manipulation of a hasMany relationship.
 
 It is especially useful when you're dealing with `async` relationships
-from `@ember-data/model` as it allows synchronous access to
+from `@warp-drive/legacy/model` as it allows synchronous access to
 the relationship data if loaded, as well as APIs for loading, reloading
 the data or accessing available information without triggering a load.
 
-It may also be useful when using `sync` relationships with `@ember-data/model`
+It may also be useful when using `sync` relationships with `@warp-drive/legacy/model`
 that need to be loaded/reloaded with more precise timing than marking the
 relationship as `async` and relying on autofetch would have allowed.
 
@@ -119,7 +119,7 @@ export default class HasManyReference<
 	```
 	
 	@public
-	@return {String} The name of the remote type. This should either be `link` or `ids`
+	@return The name of the remote type. This should either be `link` or `ids`
 	*/
 	remoteType(): "link" | "ids";
 	/**
@@ -154,11 +154,11 @@ export default class HasManyReference<
 	```
 	
 	@public
-	@return {Array} The ids in this has-many relationship
+	@return The ids in this has-many relationship
 	*/
 	ids(): Array<string | null>;
 	/**
-	The link Ember Data will use to fetch or reload this belongs-to
+	The link WarpDrive will use to fetch or reload this belongs-to
 	relationship. By default it uses only the "related" resource linkage.
 	
 	Example
@@ -192,7 +192,7 @@ export default class HasManyReference<
 	```
 	
 	@public
-	@return {String} The link Ember Data will use to fetch or reload this belongs-to relationship.
+	@return The link WarpDrive will use to fetch or reload this belongs-to relationship.
 	*/
 	link(): string | null;
 	/**
@@ -239,11 +239,11 @@ export default class HasManyReference<
 	```
 	
 	@public
-	@return {Object|null} The meta information for the belongs-to relationship.
+	@return The meta information for the belongs-to relationship.
 	*/
 	meta(): Meta | null;
 	/**
-	`push` can be used to update the data in the relationship and EmberData
+	`push` can be used to update the data in the relationship and WarpDrive
 	will treat the new data as the canonical value of this relationship on
 	the backend. An empty array will signify the canonical value should be
 	empty.
@@ -335,9 +335,8 @@ export default class HasManyReference<
 	forcing the load of all of the associated records.
 	
 	@public
-	@param {Array|Object} doc a JSONAPI document object describing the new value of this relationship.
-	@param {Boolean} [skipFetch] if `true`, do not attempt to fetch unloaded records
-	@return {Promise<ManyArray | void>}
+	@param doc a JSONAPI document object describing the new value of this relationship.
+	@param skipFetch [optional] if `true`, do not attempt to fetch unloaded records
 	*/
 	push(doc: ExistingResourceObject[] | CollectionResourceDocument, skipFetch?: boolean): Promise<ManyArray<Related> | void>;
 	_isLoaded(): boolean;
@@ -379,7 +378,6 @@ export default class HasManyReference<
 	```
 	
 	@public
-	@return {ManyArray}
 	*/
 	value(): ManyArray<Related> | null;
 	/**
@@ -441,8 +439,8 @@ export default class HasManyReference<
 	```
 	
 	@public
-	@param {Object} options the options to pass in.
-	@return {Promise} a promise that resolves with the ManyArray in
+	@param options the options to pass in.
+	@return a promise that resolves with the ManyArray in
 	this has-many relationship.
 	*/
 	load(options?: BaseFinderOptions): Promise<ManyArray<Related>>;
@@ -492,8 +490,8 @@ export default class HasManyReference<
 	```
 	
 	@public
-	@param {Object} options the options to pass in.
-	@return {Promise} a promise that resolves with the ManyArray in this has-many relationship.
+	@param options the options to pass in.
+	@return a promise that resolves with the ManyArray in this has-many relationship.
 	*/
 	reload(options?: BaseFinderOptions): Promise<ManyArray<Related>>;
 }