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

package/declarations/serializer/-private/transforms/string.d.ts

@@ -1,5 +1,8 @@
 import type { TransformName } from "@warp-drive/core/types/symbols";
 export interface StringTransform {
+	/**
+	* see {@link TransformName}
+	*/
 	[TransformName]: "string";
 }
 /**
@@ -11,7 +14,7 @@ used when `string` is passed as the type parameter to the
 Usage
 
 ```js [app/models/user.js]
-import Model, { attr, belongsTo } from '@ember-data/model';
+import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
 
 export default class UserModel extends Model {
 @attr('boolean') isAdmin;
@@ -23,7 +26,17 @@ export default class UserModel extends Model {
 @public
 */
 export declare class StringTransform {
+	/**
+	* Converts a serialized (raw payload) value into a `string`, or `null`
+	* if the value is falsy (and not an empty string).
+	*/
 	deserialize(serialized: unknown, _options?: Record<string, unknown>): string | null;
+	/**
+	* Converts a `string` attribute value into its serialized (raw payload) form.
+	*/
 	serialize(deserialized: unknown, _options?: Record<string, unknown>): string | null;
+	/**
+	* Creates a new instance of this transform.
+	*/
 	static create(): StringTransform;
 }

package/declarations/serializer/-private/utils.d.ts

@@ -1,3 +1,27 @@
+import type { Store } from "@warp-drive/core";
+import type { LegacyBelongsToField, LegacyHasManyField, LegacyRelationshipField } from "@warp-drive/core/types/schema/fields";
 type Coercable = string | number | boolean | null | undefined | symbol;
 export declare function coerceId(id: Coercable): string | null;
+/**
+Given the name of a relationship on a resource `type`, determines the
+inverse relationship field (if any) using only the schema service.
+
+Unlike `Model.inverseFor`, this does not require `type` to be backed by
+a `Model` class, so it works for both `Model`-based and schema-only
+(e.g. `withDefaults` migration-support) resources.
+
+@private
+*/
+export declare function inverseForRelationship(store: Store, type: string, name: string): LegacyRelationshipField | null;
+/**
+Given a relationship field on a resource `type`, determines the
+cardinality of the relationship using only the schema service.
+
+Unlike `Model.determineRelationshipType`, this does not require `type`
+to be backed by a `Model` class, so it works for both `Model`-based and
+schema-only (e.g. `withDefaults` migration-support) resources.
+
+@private
+*/
+export declare function determineRelationshipType(store: Store, type: string, knownSide: LegacyBelongsToField | LegacyHasManyField): "oneToOne" | "oneToMany" | "manyToOne" | "manyToMany" | "oneToNone" | "manyToNone";
 export {};

package/declarations/serializer/json-api.d.ts

@@ -93,7 +93,7 @@ below shows how this could be done using `normalizeArrayResponse` and
 `extractRelationship`.
 
 ```js [app/serializers/application.js]
-import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
+import { JSONAPISerializer } from '@warp-drive/legacy/serializer/json-api';
 
 export default class ApplicationSerializer extends JSONAPISerializer {
 normalizeArrayResponse(store, primaryModelClass, payload, id, requestType) {

package/declarations/serializer.d.ts

@@ -128,7 +128,6 @@ For an example implementation, see the included {@link JSONSerializer}.
 @public
 */
 export declare class Serializer extends EmberObject {
-	store: Store;
 	/**
 	The `store` property is the application's `store` that contains
 	all records. It can be used to look up serializers for other model
@@ -146,10 +145,9 @@ export declare class Serializer extends EmberObject {
 	});
 	```
 	
-	@property store
-	@type {Store}
 	@public
 	*/
+	store: Store;
 	/**
 	The `normalizeResponse` method is used to normalize a payload from the
 	server to a JSON-API Document.
@@ -246,9 +244,9 @@ export declare class Serializer extends EmberObject {
 	```
 	
 	@public
-	@param {Model} typeClass
-	@param {Object} hash
-	@return {Object}
+	@param _typeClass - the model class the hash is being normalized for
+	@param hash - the raw payload hash to normalize
+	@return the normalized resource document
 	*/
 	normalize(_typeClass: ModelSchema, hash: Record<string, unknown>): SingleResourceDocument | EmptyResourceDocument;
 }

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

@@ -124,7 +124,7 @@ export declare class RecordReference {
 	normalized hash of data and the object represented by the reference
 	will update.
 	
-	If you pass a promise to `push`, Ember Data will not ask the adapter
+	If you pass a promise to `push`, WarpDrive will not ask the adapter
 	for the data if another attempt to fetch it is made in the
 	interim. When the promise resolves, the underlying object is updated
 	with the new data, and the promise returned by *this function* is resolved
@@ -171,7 +171,7 @@ export declare class RecordReference {
 	```
 	
 	@public
-	@return {Model} the record for this RecordReference
+	@return the record for this RecordReference
 	*/
 	value(): OpaqueRecordInstance | null;
 	/**

package/declarations/store.d.ts

@@ -1,3 +1,10 @@
 import type { Store } from "@warp-drive/core";
+/**
+* Restores the deprecated `findRecord`/`findAll`/`query`/`queryRecord`/
+* `findBelongsTo`/`findHasMany`/`createRecord`/`deleteRecord`/`saveRecord`
+* legacy-network-layer implementations of these methods onto the given
+* `Store` subclass, for apps that have not yet migrated to the
+* `RequestManager`-based equivalents.
+*/
 export declare function restoreDeprecatedStoreBehaviors(StoreKlass: typeof Store): void;
 export { Store };