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

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

@@ -1,223 +0,0 @@
-import { type InstanceCache } from "@warp-drive/core/store/-private";
-import type { NewResourceKey, ResourceKey } from "@warp-drive/core/types/identifier";
-import type { Value } from "@warp-drive/core/types/json/raw";
-import type { OpaqueRecordInstance, TypedRecordInstance, TypeFromInstance } from "@warp-drive/core/types/record";
-import type { LegacyAttributeField, LegacyRelationshipField } from "@warp-drive/core/types/schema/fields";
-import type { SingleResourceDocument } from "@warp-drive/core/types/spec/json-api-raw";
-import type { Store } from "../store.js";
-export declare function preloadData(store: Store, identifier: NewResourceKey, preload: Record<string, Value>): void;
-export interface BaseFinderOptions {
-	reload?: boolean;
-	backgroundReload?: boolean;
-	include?: string | string[];
-	adapterOptions?: Record<string, unknown>;
-}
-export interface FindRecordOptions extends BaseFinderOptions {
-	/**
-	* Data to preload into the store before the request is made.
-	* This feature is *highly* discouraged and has no corresponding
-	* feature when using builders and handlers.
-	*
-	* Excepting relationships: the data should be in the form of a
-	* JSON object where the keys are fields on the record and the value
-	* is the raw value to be added to the cache.
-	*
-	* Relationships can either be provided as string IDs from which
-	* an identifier will be built base upon the relationship's expected
-	* resource type, or be record instances from which the identifier
-	* will be extracted.
-	*
-	*/
-	preload?: Record<string, Value>;
-}
-export type QueryOptions = { [K in string | "adapterOptions"]? : K extends "adapterOptions" ? Record<string, unknown> : unknown };
-export type FindAllOptions = BaseFinderOptions;
-export type LegacyResourceQuery = {
-	include?: string | string[];
-	[key: string]: Value | undefined;
-};
-export type KeyOrString<T> = keyof T & string extends never ? string : keyof T & string;
-/**
-* Minimum subset of static schema methods and properties on the
-* "model" class.
-*
-* Only used when using the legacy schema-service implementation
-* for @ember-data/model or when wrapping schema for legacy
-* Adapters/Serializers.
-*
-*/
-export interface ModelSchema<T = unknown> {
-	modelName: T extends TypedRecordInstance ? TypeFromInstance<T> : string;
-	fields: Map<KeyOrString<T>, "attribute" | "belongsTo" | "hasMany">;
-	attributes: Map<KeyOrString<T>, LegacyAttributeField>;
-	relationshipsByName: Map<KeyOrString<T>, LegacyRelationshipField>;
-	eachAttribute<K extends KeyOrString<T>>(callback: (this: ModelSchema<T>, key: K, attribute: LegacyAttributeField) => void, binding?: T): void;
-	eachRelationship<K extends KeyOrString<T>>(callback: (this: ModelSchema<T>, key: K, relationship: LegacyRelationshipField) => void, binding?: T): void;
-	eachTransformedAttribute<K extends KeyOrString<T>>(callback: (this: ModelSchema<T>, key: K, type: string | null) => void, binding?: T): void;
-}
-export declare function resourceIsFullyDeleted(instanceCache: InstanceCache, identifier: ResourceKey): boolean;
-/**
-A `RecordReference` is a low-level API that allows users and
-addon authors to perform meta-operations on a record.
-
-@hideconstructor
-@public
-*/
-export declare class RecordReference {
-	constructor(store: Store, identifier: ResourceKey);
-	get type(): string;
-	/**
-	The `id` of the record that this reference refers to.
-	
-	Together, the `type` and `id` properties form a composite key for
-	the identity map.
-	
-	Example
-	
-	```javascript
-	let userRef = store.getReference('user', 1);
-	
-	userRef.id(); // '1'
-	```
-	
-	@public
-	@return The id of the record.
-	*/
-	id(): string | null;
-	/**
-	The `identifier` of the record that this reference refers to.
-	
-	Together, the `type` and `id` properties form a composite key for
-	the identity map.
-	
-	Example
-	
-	```javascript
-	let userRef = store.getReference('user', 1);
-	
-	userRef.identifier(); // '1'
-	```
-	
-	@public
-	@return The identifier of the record.
-	*/
-	identifier(): ResourceKey;
-	/**
-	How the reference will be looked up when it is loaded. Currently
-	this always returns `identity` to signify that a record will be
-	loaded by its `type` and `id`.
-	
-	Example
-	
-	```javascript
-	const userRef = store.getReference('user', 1);
-	
-	userRef.remoteType(); // 'identity'
-	```
-	
-	@public
-	*/
-	remoteType(): "identity";
-	/**
-	This API allows you to provide a reference with new data. The
-	simplest usage of this API is similar to `store.push`: you provide a
-	normalized hash of data and the object represented by the reference
-	will update.
-	
-	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
-	with that object.
-	
-	For example, `recordReference.push(promise)` will be resolved with a
-	record.
-	
-	Example
-	
-	```javascript
-	let userRef = store.getReference('user', 1);
-	
-	// provide data for reference
-	userRef.push({
-	data: {
-	id: "1",
-	type: "user",
-	attributes: {
-	username: "@user"
-	}
-	}
-	}).then(function(user) {
-	userRef.value() === user;
-	});
-	```
-	
-	@public
-	@param objectOrPromise a JSON:API ResourceDocument or a promise resolving to one
-	@return a promise for the value (record or relationship)
-	*/
-	push(objectOrPromise: SingleResourceDocument | Promise<SingleResourceDocument>): Promise<OpaqueRecordInstance>;
-	/**
-	If the entity referred to by the reference is already loaded, it is
-	present as `reference.value`. Otherwise the value returned by this function
-	is `null`.
-	
-	Example
-	
-	```javascript
-	let userRef = store.getReference('user', 1);
-	
-	userRef.value(); // user
-	```
-	
-	@public
-	@return the record for this RecordReference
-	*/
-	value(): OpaqueRecordInstance | null;
-	/**
-	Triggers a fetch for the backing entity based on its `remoteType`
-	(see `remoteType` definitions per reference type).
-	
-	Example
-	
-	```javascript
-	let userRef = store.getReference('user', 1);
-	
-	// load user (via store.find)
-	userRef.load().then(...)
-	```
-	
-	@public
-	@return the record for this RecordReference
-	*/
-	load(): Promise<unknown>;
-	/**
-	Reloads the record if it is already loaded. If the record is not
-	loaded it will load the record via `store.findRecord`
-	
-	Example
-	
-	```javascript
-	let userRef = store.getReference('user', 1);
-	
-	// or trigger a reload
-	userRef.reload().then(...)
-	```
-	
-	@public
-	@return the record for this RecordReference
-	*/
-	reload(): Promise<unknown>;
-}
-export declare function getShimClass<T>(store: Store, modelName: T extends TypedRecordInstance ? TypeFromInstance<T> : string): ShimModelClass<T>;
-export declare class ShimModelClass<T = unknown> implements ModelSchema<T> {
-	__store: Store;
-	modelName: T extends TypedRecordInstance ? TypeFromInstance<T> : string;
-	constructor(store: Store, modelName: T extends TypedRecordInstance ? TypeFromInstance<T> : string);
-	get fields(): Map<KeyOrString<T>, "attribute" | "belongsTo" | "hasMany">;
-	get attributes(): Map<KeyOrString<T>, LegacyAttributeField>;
-	get relationshipsByName(): Map<KeyOrString<T>, LegacyRelationshipField>;
-	eachAttribute<K extends KeyOrString<T>>(callback: (key: K, attribute: LegacyAttributeField) => void, binding?: T): void;
-	eachRelationship<K extends KeyOrString<T>>(callback: (key: K, relationship: LegacyRelationshipField) => void, binding?: T): void;
-	eachTransformedAttribute<K extends KeyOrString<T>>(callback: (key: K, type: string | null) => void, binding?: T): void;
-}

package/declarations/store.d.ts

@@ -1,10 +0,0 @@
-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 };