@warp-drive/core 5.7.0-alpha.14 → 5.7.0-alpha.16

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

@@ -1,11 +1,11 @@
-import type { StableNewRecordIdentifier, StableRecordIdentifier } from "../../types/identifier.js";
+import type { NewResourceKey, ResourceKey } from "../../types/identifier.js";
 import type { Value } from "../../types/json/raw.js";
 import type { OpaqueRecordInstance, TypedRecordInstance, TypeFromInstance } from "../../types/record.js";
 import type { LegacyAttributeField, LegacyRelationshipField } from "../../types/schema/fields.js";
 import type { SingleResourceDocument } from "../../types/spec/json-api-raw.js";
 import { type InstanceCache } from "../-private.js";
 import type { Store } from "./store.js";
-export declare function preloadData(store: Store, identifier: StableNewRecordIdentifier, preload: Record<string, Value>): void;
+export declare function preloadData(store: Store, identifier: NewResourceKey, preload: Record<string, Value>): void;
 export interface BaseFinderOptions {
 	reload?: boolean;
 	backgroundReload?: boolean;
@@ -55,7 +55,7 @@ export interface ModelSchema<T = unknown> {
 	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: StableRecordIdentifier): boolean;
+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.
@@ -73,7 +73,7 @@ export declare class RecordReference {
 	private ___identifier;
 	/** @internal */
 	private _ref;
-	constructor(store: Store, identifier: StableRecordIdentifier);
+	constructor(store: Store, identifier: ResourceKey);
 	/** @internal */
 	destroy(): void;
 	get type(): string;
@@ -112,7 +112,7 @@ export declare class RecordReference {
 	@public
 	@return The identifier of the record.
 	*/
-	identifier(): StableRecordIdentifier;
+	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

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

@@ -1,7 +1,7 @@
 type UniversalTransientKey = "REQ_ID";
 type UniversalKey = `(transient) ${UniversalTransientKey}` | "RequestMap" | "PromiseCache" | "RequestCache" | "SkipCache" | "EnableHydration" | "WarpDriveRuntimeConfig";
 type TransientKey = "transactionRef" | "configuredGenerationMethod" | "configuredUpdateMethod" | "configuredForgetMethod" | "configuredResetMethod" | "configuredKeyInfoMethod" | "signalHooks";
-type GlobalKey = `(transient) ${TransientKey}` | "AdapterError" | "InvalidError" | "TimeoutError" | "AbortError" | "UnauthorizedError" | "ForbiddenError" | "NotFoundError" | "ConflictError" | "ServerError" | "#{}" | "#[]" | "Signals" | "AvailableShims" | "FAKE_ARR" | "#source" | "#update" | "#notify" | "IS_COLLECTION" | "Touching" | "RequestPromise" | "SaveOp" | "LEGACY_SUPPORT" | "LegacySupport" | "Graphs" | "IS_FROZEN" | "IS_CACHE_HANDLER" | "CONFIG" | "DEBUG_MAP" | "IDENTIFIERS" | "DOCUMENTS" | "RecordCache" | "StoreMap" | "Store" | "$type" | "TransformName" | "RequestSignature" | "IS_FUTURE" | "DOC" | "ManagedArrayMap" | "ManagedObjectMap" | "Support" | "SOURCE" | "Destroy" | "Checkout" | "Context";
+type GlobalKey = `(transient) ${TransientKey}` | "AdapterError" | "InvalidError" | "TimeoutError" | "AbortError" | "UnauthorizedError" | "ForbiddenError" | "NotFoundError" | "ConflictError" | "ServerError" | "#{}" | "#[]" | "Signals" | "AvailableShims" | "FAKE_ARR" | "#source" | "#update" | "#notify" | "IS_COLLECTION" | "Touching" | "RequestPromise" | "SaveOp" | "LEGACY_SUPPORT" | "LegacySupport" | "Graphs" | "IS_FROZEN" | "IS_CACHE_HANDLER" | "CONFIG" | "DEBUG_MAP" | "IDENTIFIERS" | "DOCUMENTS" | "RecordCache" | "StoreMap" | "Store" | "$type" | "TransformName" | "RequestSignature" | "IS_FUTURE" | "DOC" | "ManagedArrayMap" | "ManagedObjectMap" | "Support" | "SOURCE" | "Destroy" | "Checkout" | "Commit" | "Context";
 type UniqueSymbol<T extends string> = `___(unique) Symbol(${T})`;
 type UniqueSymbolOr<
 	T,

package/declarations/types/cache/aliases.d.ts

@@ -1,7 +1,7 @@
 // The ResourceBlob is an opaque type that must
 // satisfy two constraints.
-// (1) it should be possible for the IdentifierCache
-// to be able to generate a RecordIdentifier for it
+// (1) it should be possible for the CacheKeyManager
+// to be able to generate a ResourceKey for it
 // whether by default or due to configuration.
 // (2) it should be in a format expected by the Cache.
 // This format is Cache declared.

package/declarations/types/cache/change.d.ts

@@ -1,6 +1,6 @@
-import type { StableDocumentIdentifier, StableRecordIdentifier } from "../identifier.js";
+import type { RequestKey, ResourceKey } from "../identifier.js";
 export interface Change {
-	identifier: StableRecordIdentifier | StableDocumentIdentifier;
+	identifier: ResourceKey | RequestKey;
 	op: "upsert" | "remove";
 	patch?: unknown;
 }

package/declarations/types/cache/mutations.d.ts

@@ -1,48 +1,48 @@
-import type { StableRecordIdentifier } from "../identifier.js";
+import type { ResourceKey } from "../identifier.js";
 export interface AddToResourceRelationshipMutation {
 	op: "add";
-	record: StableRecordIdentifier;
+	record: ResourceKey;
 	field: string;
-	value: StableRecordIdentifier | StableRecordIdentifier[];
+	value: ResourceKey | ResourceKey[];
 	index?: number;
 }
 export interface RemoveFromResourceRelationshipMutation {
 	op: "remove";
-	record: StableRecordIdentifier;
+	record: ResourceKey;
 	field: string;
-	value: StableRecordIdentifier | StableRecordIdentifier[];
+	value: ResourceKey | ResourceKey[];
 	index?: number;
 }
 export interface ReplaceRelatedRecordMutation {
 	op: "replaceRelatedRecord";
-	record: StableRecordIdentifier;
+	record: ResourceKey;
 	field: string;
 	// never null if field is a collection
-	value: StableRecordIdentifier | null;
+	value: ResourceKey | null;
 	// if field is a collection,
 	//  the value we are swapping with
-	prior?: StableRecordIdentifier;
+	prior?: ResourceKey;
 	index?: number;
 }
 export interface ReplaceRelatedRecordsMutation {
 	op: "replaceRelatedRecords";
-	record: StableRecordIdentifier;
+	record: ResourceKey;
 	field: string;
 	// the records to add. If no prior/index
 	//  specified all existing should be removed
-	value: StableRecordIdentifier[];
+	value: ResourceKey[];
 	// if this is a "splice" the
 	//  records we expect to be removed
-	prior?: StableRecordIdentifier[];
+	prior?: ResourceKey[];
 	// if this is a "splice" the
 	//   index to start from
 	index?: number;
 }
 export interface SortRelatedRecordsMutation {
 	op: "sortRelatedRecords";
-	record: StableRecordIdentifier;
+	record: ResourceKey;
 	field: string;
-	value: StableRecordIdentifier[];
+	value: ResourceKey[];
 }
 // A Mutation is an action that updates
 // the local state of the Cache in some

package/declarations/types/cache/operations.d.ts

@@ -1,4 +1,4 @@
-import type { StableDocumentIdentifier, StableExistingRecordIdentifier, StableRecordIdentifier } from "../identifier.js";
+import type { PersistedResourceKey, RequestKey, ResourceKey } from "../identifier.js";
 import type { Value } from "../json/raw.js";
 import type { ExistingResourceObject } from "../spec/json-api-raw.js";
 import type { Relationship } from "./relationship.js";
@@ -24,15 +24,15 @@ export interface Op {
 export interface MergeOperation extends Op {
 	op: "mergeIdentifiers";
 	/**
-	* The stale {@link StableRecordIdentifier | ResourceKey} that
+	* The stale {@link ResourceKey | ResourceKey} that
 	* the cache should eliminate in favor of {@link MergeOperation.value | value}
 	*/
-	record: StableRecordIdentifier;
+	record: ResourceKey;
 	/**
-	* The kept {@link StableRecordIdentifier | ResourceKey} that
+	* The kept {@link ResourceKey | ResourceKey} that
 	* the cache should also keep and merge {@link MergeOperation.record | record} into.
 	*/
-	value: StableRecordIdentifier;
+	value: ResourceKey;
 }
 /**
 * Removes a document and its associated request from
@@ -43,7 +43,7 @@ export interface RemoveDocumentOperation extends Op {
 	/**
 	* The cache key for the request
 	*/
-	record: StableDocumentIdentifier;
+	record: RequestKey;
 }
 /**
 * Removes a resource from the cache. This is treated
@@ -55,7 +55,7 @@ export interface RemoveResourceOperation extends Op {
 	/**
 	* The cache key for the resource
 	*/
-	record: StableExistingRecordIdentifier;
+	record: PersistedResourceKey;
 }
 /**
 * Adds a resource to the cache.
@@ -65,7 +65,7 @@ export interface AddResourceOperation extends Op {
 	/**
 	* The cache key for the resource
 	*/
-	record: StableExistingRecordIdentifier;
+	record: PersistedResourceKey;
 	/**
 	* The data for the resource
 	*/
@@ -76,7 +76,7 @@ export interface AddResourceOperation extends Op {
 */
 export interface UpdateResourceOperation extends Op {
 	op: "update";
-	record: StableExistingRecordIdentifier;
+	record: PersistedResourceKey;
 	value: ExistingResourceObject;
 }
 /**
@@ -84,7 +84,7 @@ export interface UpdateResourceOperation extends Op {
 */
 export interface UpdateResourceFieldOperation extends Op {
 	op: "update";
-	record: StableExistingRecordIdentifier;
+	record: PersistedResourceKey;
 	field: string;
 	value: Value;
 }
@@ -93,9 +93,9 @@ export interface UpdateResourceFieldOperation extends Op {
 */
 export interface UpdateResourceRelationshipOperation extends Op {
 	op: "update";
-	record: StableExistingRecordIdentifier;
+	record: PersistedResourceKey;
 	field: string;
-	value: Relationship<StableExistingRecordIdentifier>;
+	value: Relationship<PersistedResourceKey>;
 }
 /**
 * Adds a resource to a request document, optionally
@@ -104,9 +104,9 @@ export interface UpdateResourceRelationshipOperation extends Op {
 */
 export interface AddToDocumentOperation extends Op {
 	op: "add";
-	record: StableDocumentIdentifier;
+	record: RequestKey;
 	field: "data" | "included";
-	value: StableExistingRecordIdentifier | StableExistingRecordIdentifier[];
+	value: PersistedResourceKey | PersistedResourceKey[];
 	index?: number;
 }
 /**
@@ -114,9 +114,9 @@ export interface AddToDocumentOperation extends Op {
 */
 export interface AddToResourceRelationshipOperation extends Op {
 	op: "add";
-	record: StableExistingRecordIdentifier;
+	record: PersistedResourceKey;
 	field: string;
-	value: StableExistingRecordIdentifier | StableExistingRecordIdentifier[];
+	value: PersistedResourceKey | PersistedResourceKey[];
 	index?: number;
 }
 /**
@@ -124,9 +124,9 @@ export interface AddToResourceRelationshipOperation extends Op {
 */
 export interface RemoveFromResourceRelationshipOperation extends Op {
 	op: "remove";
-	record: StableExistingRecordIdentifier;
+	record: PersistedResourceKey;
 	field: string;
-	value: StableExistingRecordIdentifier | StableExistingRecordIdentifier[];
+	value: PersistedResourceKey | PersistedResourceKey[];
 	index?: number;
 }
 /**
@@ -136,9 +136,9 @@ export interface RemoveFromResourceRelationshipOperation extends Op {
 */
 export interface RemoveFromDocumentOperation extends Op {
 	op: "remove";
-	record: StableDocumentIdentifier;
+	record: RequestKey;
 	field: "data" | "included";
-	value: StableExistingRecordIdentifier | StableExistingRecordIdentifier[];
+	value: PersistedResourceKey | PersistedResourceKey[];
 	index?: number;
 }
 /**

package/declarations/types/cache/relationship.d.ts

@@ -1,16 +1,16 @@
-import type { StableRecordIdentifier } from "../identifier.js";
+import type { ResourceKey } from "../identifier.js";
 import type { Links, Meta, PaginationLinks } from "../spec/json-api-raw.js";
 // we request that it be in the stable form already.
-export interface ResourceRelationship<T = StableRecordIdentifier> {
+export interface ResourceRelationship<T = ResourceKey> {
 	data?: T | null;
 	meta?: Meta;
 	links?: Links;
 }
 // Note: in v1 data could be a ResourceIdentifier, now
 // we request that it be in the stable form already.
-export interface CollectionRelationship<T = StableRecordIdentifier> {
+export interface CollectionRelationship<T = ResourceKey> {
 	data?: T[];
 	meta?: Meta;
 	links?: PaginationLinks;
 }
-export type Relationship<T = StableRecordIdentifier> = ResourceRelationship<T> | CollectionRelationship<T>;
+export type Relationship<T = ResourceKey> = ResourceRelationship<T> | CollectionRelationship<T>;