@warp-drive/legacy 5.8.0-alpha.9 → 5.8.0-beta.1

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

@@ -21,7 +21,6 @@ application might expect these methods to be called.
 
 Methods that are not required are marked as **optional**.
 
-@class (Interface) Serializer
 @public
 */
 export interface MinimumSerializerInterface {
@@ -41,23 +40,22 @@ export interface MinimumSerializerInterface {
 	*    and [Resource Identifier Objects](https://jsonapi.org/format/#document-resource-identifier-objects)
 	*
 	* @public
-	* @param {Store} store The store service that initiated the request being normalized
-	* @param {ModelSchema} schema An object with methods for accessing information about
+	* @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 {JSONObject} rawPayload The raw JSON response data returned from an API 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 {string|null} id For a findRecord request, this is the id initially provided
+	* @param 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.
+	* @param requestType The type of request the Adapter had been asked to perform.
 	*
-	* @return {JsonApiDocument} a document following the structure of a JSON:API Document.
+	* @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 [Snapshot](Snapshot) into the format expected by the API.
+	* via a {@link Snapshot} into the format expected by the API.
 	*
 	* This method is called by `snapshot.serialize()`.
 	*
@@ -68,8 +66,7 @@ export interface MinimumSerializerInterface {
 	* is not implemented.
 	*
 	* @public
-	* @param {Snapshot} snapshot A Snapshot for the record to serialize
-	* @param {Object} [options]
+	* @param snapshot A Snapshot for the record to serialize
 	*/
 	serialize(snapshot: Snapshot, options?: SerializerOptions): ObjectValue;
 	/**
@@ -116,14 +113,12 @@ export interface MinimumSerializerInterface {
 	*
 	* @public
 	* @optional
-	* @param {ModelSchema} schema An object with methods for accessing information about
+	* @param 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
+	* @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 {SingleResourceDocument} A JSON:API Document
-	*  containing a single JSON:API Resource
-	*  as its primary data.
+	* @return A JSON:API Document containing a single JSON:API Resource as its primary data.
 	*/
 	normalize?(schema: ModelSchema, rawPayload: ObjectValue, prop?: string): SingleResourceDocument;
 	/**
@@ -159,11 +154,9 @@ export interface MinimumSerializerInterface {
 	* @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
+	* @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} snapshot A Snapshot for the record to serialize
-	* @param [options]
-	* @return {void}
+	* @param snapshot A Snapshot for the record to serialize
 	*/
 	serializeIntoHash?(hash: object, schema: ModelSchema, snapshot: Snapshot, options?: SerializerOptions): void;
 	/**
@@ -202,10 +195,9 @@ export interface MinimumSerializerInterface {
 	*
 	* @public
 	* @optional
-	* @param {Store} store The store service that initiated the request being normalized
-	* @param {Object} rawPayload The raw JSON response data returned from an API request.
+	* @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.
-	* @return {void}
 	*/
 	pushPayload?(store: Store, rawPayload: ObjectValue): void;
 	/**

package/declarations/compat/utils.d.ts

@@ -4,7 +4,7 @@ type Reporter = (type: "formatted-id" | "formatted-type", actual: unknown, expec
 * changes during normalization. This is useful for instrumenting
 * to discover places where usage in the app is not consistent.
 *
-* @param method a function which takes a mismatch-type ('formatted-id' | 'formatted-type'), actual, and expected value
+* @param fn - a function which takes a mismatch-type ('formatted-id' | 'formatted-type'), actual, and expected value
 * @public
 */
 export declare function configureMismatchReporter(fn: Reporter): void;
@@ -13,7 +13,7 @@ export declare function configureMismatchReporter(fn: Reporter): void;
 * fails validation. This is useful for instrumenting
 * to discover places where usage in the app is not consistent.
 *
-* @param method a function which takes a message and a condition
+* @param fn - a function which takes a message and a condition
 * @public
 */
 export declare function configureAssertFn(fn: (message: string, condition: unknown) => void): void;
@@ -27,7 +27,7 @@ export declare function configureAssertFn(fn: (message: string, condition: unkno
 * the configured mismatch reporter and assert functions will
 * be called.
 *
-* @param method a function which takes a string and returns a string
+* @param fn - a function which takes a string and returns a string
 * @public
 */
 export declare function configureTypeNormalization(fn: (type: string) => string): void;
@@ -56,8 +56,8 @@ export declare function configureTypeNormalization(fn: (type: string) => string)
 * formattedType('PostComment'); // => 'post-comment'
 * ```
 *
-* @param {String} type the potentially un-normalized type
-* @return {String} the normalized type
+* @param type the potentially un-normalized type
+* @return the normalized type
 * @public
 */
 export declare function formattedType<T extends string>(type: T | string): T;
@@ -77,8 +77,8 @@ export declare function formattedType<T extends string>(type: T | string): T;
 * formattedId(null); // => null
 *	```
 *
-* @param {String | Number | null} id the potentially un-normalized id
-* @return {String | null} the normalized id
+* @param id the potentially un-normalized id
+* @return the normalized id
 * @public
 */
 export declare function formattedId(id: string | number): string;
@@ -106,9 +106,9 @@ export declare function expectId(id: null): never;
 * isEquivType('posts', null); // false
 * ```
 *
-* @param {String} expected a potentially unnormalized type to match against
-* @param {String} actual a potentially unnormalized type to match against
-* @return {Boolean} true if the types are equivalent
+* @param expected a potentially unnormalized type to match against
+* @param actual a potentially unnormalized type to match against
+* @return true if the types are equivalent
 * @public
 */
 export declare function isEquivType(expected: string, actual: string): boolean;
@@ -128,9 +128,9 @@ export declare function isEquivType(expected: string, actual: string): boolean;
 * isEquivId(1, null); // false
 * ```
 *
-* @param {string | number} expected a potentially un-normalized id to match against
-* @param {string | number} actual a potentially un-normalized id to match against
-* @return {Boolean} true if the ids are equivalent
+* @param expected a potentially un-normalized id to match against
+* @param actual a potentially un-normalized id to match against
+* @return true if the ids are equivalent
 * @public
 */
 export declare function isEquivId(expected: string | number, actual: string | number | null): boolean;

package/declarations/compat.d.ts

@@ -6,7 +6,18 @@ import type { AdapterPayload, MinimumAdapterInterface } from "./compat/legacy-ne
 import type { MinimumSerializerInterface, SerializerOptions } from "./compat/legacy-network-handler/minimum-serializer-interface.js";
 export { LegacyNetworkHandler } from "./compat/legacy-network-handler/legacy-network-handler.js";
 export type { MinimumAdapterInterface, MinimumSerializerInterface, SerializerOptions, AdapterPayload };
+/**
+* Extends the signature of {@link Store} with additional
+* methods available when using the legacy network layer.
+*
+* @public
+* @noInheritDoc
+* @legacy
+*/
 export interface LegacyStoreCompat extends Store {
+	/**
+	* @private
+	*/
 	_fetchManager: FetchManager;
 	adapterFor(this: Store, modelName: string): MinimumAdapterInterface;
 	adapterFor(this: Store, modelName: string, _allowMissing: true): MinimumAdapterInterface | undefined;
@@ -14,13 +25,22 @@ export interface LegacyStoreCompat extends Store {
 	normalize(modelName: string, payload: ObjectValue): ObjectValue;
 	pushPayload(modelName: string, payload: ObjectValue): void;
 	serializeRecord(record: unknown, options?: SerializerOptions): unknown;
+	/**
+	* @private
+	*/
 	_adapterCache: Record<string, MinimumAdapterInterface & {
 		store: Store;
 	}>;
+	/**
+	* @private
+	*/
 	_serializerCache: Record<string, MinimumSerializerInterface & {
 		store: Store;
 	}>;
 }
+/**
+* @deprecated - use {@link LegacyStoreCompat} instead
+*/
 export type CompatStore = LegacyStoreCompat;
 /**
 Returns an instance of the adapter for a given type. For
@@ -53,8 +73,13 @@ to an instance of `JSONSerializer`.
 */
 export declare function serializerFor(this: Store, modelName: string): MinimumSerializerInterface | null;
 /**
-`normalize` converts a json payload into the normalized form that
-[push](../methods/push?anchor=push) expects.
+`normalize` converts a json payload into the normalized form expected by
+{@link Store.push | push} using the serializer specified by `modelName`
+
+:::warning
+Generally it would be better to invoke the serializer yourself directly,
+or write a more specialized normalization utility.
+:::
 
 Example
 
@@ -66,6 +91,7 @@ store.push(store.normalize(modelName, data));
 });
 ```
 
+@legacy
 @public
 @param modelName The name of the model type for this payload
 @return The normalized payload
@@ -81,7 +107,7 @@ All objects should be in the format expected by the
 serializer.
 
 ```js [app/serializers/application.js]
-import RESTSerializer from '@ember-data/serializer/rest';
+import RESTSerializer from '@warp-drive/legacy/serializer/rest';
 
 export default class ApplicationSerializer extends RESTSerializer;
 ```
@@ -106,13 +132,13 @@ Alternatively, `pushPayload` will accept a model type which
 will determine which serializer will process the payload.
 
 ```js [app/serializers/application.js]
-import RESTSerializer from '@ember-data/serializer/rest';
+import RESTSerializer from '@warp-drive/legacy/serializer/rest';
 
 export default class ApplicationSerializer extends RESTSerializer;
 ```
 
 ```js [app/serializers/post.js]
-import JSONSerializer from '@ember-data/serializer/json';
+import JSONSerializer from '@warp-drive/legacy/serializer/json';
 
 export default JSONSerializer;
 ```

package/declarations/index.d.ts

@@ -3,11 +3,17 @@
 * @mergeModuleWith <project>
 */
 import { Store, type StoreSetupOptions } from "@warp-drive/core";
+import type { CacheCapabilitiesManager } from "@warp-drive/core/types";
+import type { Cache } from "@warp-drive/core/types/cache";
 import type { ObjectSchema, ResourceSchema } from "@warp-drive/core/types/schema/fields";
-interface _LegacyStoreSetupOptions extends Omit<StoreSetupOptions, "schemas"> {
+interface _LegacyStoreSetupOptions<T extends Cache> extends Omit<StoreSetupOptions<T>, "schemas"> {
 	schemas?: Array<ResourceSchema | ObjectSchema>;
+	/**
+	* Whether to include support for ModelFragments migrations.
+	*/
+	modelFragments?: boolean;
 }
-interface LegacyModelStoreSetupOptions extends _LegacyStoreSetupOptions {
+export interface LegacyModelStoreSetupOptions<T extends Cache> extends _LegacyStoreSetupOptions<T> {
 	/**
 	* If true, it is presumed that no requests require use of the LegacyNetworkHandler
 	* and associated adapters/serializer methods.
@@ -19,7 +25,7 @@ interface LegacyModelStoreSetupOptions extends _LegacyStoreSetupOptions {
 	*/
 	legacyRequests?: false;
 }
-interface LegacyModelAndNetworkStoreSetupOptions extends _LegacyStoreSetupOptions {
+export interface LegacyModelAndNetworkStoreSetupOptions<T extends Cache> extends _LegacyStoreSetupOptions<T> {
 	/**
 	* If true, it is presumed that no requests require use of the LegacyNetworkHandler
 	* and associated adapters/serializer methods.
@@ -31,7 +37,7 @@ interface LegacyModelAndNetworkStoreSetupOptions extends _LegacyStoreSetupOption
 	*/
 	legacyRequests?: false;
 }
-interface LegacyModelAndNetworkAndRequestStoreSetupOptions extends _LegacyStoreSetupOptions {
+export interface LegacyModelAndNetworkAndRequestStoreSetupOptions<T extends Cache> extends _LegacyStoreSetupOptions<T> {
 	/**
 	* If true, it is presumed that no requests require use of the LegacyNetworkHandler
 	* and associated adapters/serializer methods.
@@ -43,11 +49,22 @@ interface LegacyModelAndNetworkAndRequestStoreSetupOptions extends _LegacyStoreS
 	*/
 	legacyRequests: true;
 }
-export type LegacyStoreSetupOptions = LegacyModelStoreSetupOptions | LegacyModelAndNetworkStoreSetupOptions | LegacyModelAndNetworkAndRequestStoreSetupOptions;
+export type LegacyStoreSetupOptions<T extends Cache = Cache> = LegacyModelStoreSetupOptions<T> | LegacyModelAndNetworkStoreSetupOptions<T> | LegacyModelAndNetworkAndRequestStoreSetupOptions<T>;
+export declare class ConfiguredStore<T extends {
+	cache: Cache;
+}> extends Store {
+	createCache(capabilities: CacheCapabilitiesManager): T["cache"];
+}
 /**
 * Use the legacy store with the given options.
 */
-export declare function useLegacyStore(options: LegacyModelStoreSetupOptions, StoreKlass?: typeof Store): typeof Store;
-export declare function useLegacyStore(options: LegacyModelAndNetworkStoreSetupOptions, StoreKlass?: typeof Store): typeof Store;
-export declare function useLegacyStore(options: LegacyModelAndNetworkAndRequestStoreSetupOptions, StoreKlass?: typeof Store): typeof Store;
+export declare function useLegacyStore<T extends Cache>(options: LegacyModelStoreSetupOptions<T>, StoreKlass?: typeof Store): typeof ConfiguredStore<{
+	cache: T;
+}>;
+export declare function useLegacyStore<T extends Cache>(options: LegacyModelAndNetworkStoreSetupOptions<T>, StoreKlass?: typeof Store): typeof ConfiguredStore<{
+	cache: T;
+}>;
+export declare function useLegacyStore<T extends Cache>(options: LegacyModelAndNetworkAndRequestStoreSetupOptions<T>, StoreKlass?: typeof Store): typeof ConfiguredStore<{
+	cache: T;
+}>;
 export {};

package/declarations/model/-private/legacy-relationships-support.d.ts

@@ -38,8 +38,8 @@ export declare class LegacySupport {
 	_updatePromiseProxyFor(kind: "belongsTo", key: string, args: {
 		promise: Promise<OpaqueRecordInstance | null>;
 	}): PromiseBelongsTo;
-	referenceFor(kind: "belongsTo", name: string): BelongsToReference;
-	referenceFor(kind: "hasMany", name: string): HasManyReference;
+	referenceFor(kind: "belongsTo", key: string): BelongsToReference;
+	referenceFor(kind: "hasMany", key: string): HasManyReference;
 	_findHasManyByJsonApiResource(resource: CollectionResourceRelationship, parentIdentifier: ResourceKey, relationship: CollectionEdge, options?: BaseFinderOptions): Promise<void | unknown[]> | void;
 	_findBelongsToByJsonApiResource(resource: SingleResourceRelationship, parentIdentifier: ResourceKey, relationship: ResourceEdge, options?: BaseFinderOptions): Promise<ResourceKey | null>;
 	destroy(): void;

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

@@ -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;
@@ -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;