@warp-drive/core 5.7.0-alpha.37 → 5.7.0-alpha.39

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

@@ -4,10 +4,6 @@ import type { LegacyLiveArray, LegacyQueryArray } from "../-private.js";
 import { Store } from "../-private/store-service.js";
 import type { FindAllOptions, FindRecordOptions, LegacyResourceQuery, ModelSchema, QueryOptions } from "./-private.js";
 import { RecordReference } from "./-private.js";
-/////////////// IMPORTANT ///////////////////
-///// Move Module Augmentation Into The /////
-///// Legacy Package Once Removed Here  /////
-/////////////////////////////////////////////
 declare module "../-private/store-service" {
 	interface Store {
 		/**

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

@@ -1,12 +1 @@
-// The ResourceBlob is an opaque type that must
-// satisfy two constraints.
-// (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.
-//
-// this Opaqueness allows arbitrary storage of any
-// serializable / transferable state including such things
-// as Buffers and Strings.
 export type ResourceBlob = unknown;

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

@@ -17,10 +17,7 @@ export interface ReplaceRelatedRecordMutation {
 	op: "replaceRelatedRecord";
 	record: ResourceKey;
 	field: string;
-	// never null if field is a collection
 	value: ResourceKey | null;
-	// if field is a collection,
-	//  the value we are swapping with
 	prior?: ResourceKey;
 	index?: number;
 }
@@ -28,14 +25,8 @@ export interface ReplaceRelatedRecordsMutation {
 	op: "replaceRelatedRecords";
 	record: ResourceKey;
 	field: string;
-	// the records to add. If no prior/index
-	//  specified all existing should be removed
 	value: ResourceKey[];
-	// if this is a "splice" the
-	//  records we expect to be removed
 	prior?: ResourceKey[];
-	// if this is a "splice" the
-	//   index to start from
 	index?: number;
 }
 export interface SortRelatedRecordsMutation {
@@ -44,19 +35,4 @@ export interface SortRelatedRecordsMutation {
 	field: string;
 	value: ResourceKey[];
 }
-// A Mutation is an action that updates
-// the local state of the Cache in some
-// manner.
-// Most Mutations are in theory also
-// Operations; with the difference being
-// that the change should be applied as
-// "local" or "dirty" state instead of
-// as "remote" or "clean" state.
-//
-// Note: this RFC does not publicly surface
-// any of the mutations listed here as
-// "operations", though the (private) Graph
-// already expects and utilizes these.
-// and we look forward to an RFC that makes
-// the Graph a fully public API.
 export type Mutation = ReplaceRelatedRecordsMutation | ReplaceRelatedRecordMutation | RemoveFromResourceRelationshipMutation | AddToResourceRelationshipMutation | SortRelatedRecordsMutation;

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

@@ -1,13 +1,10 @@
 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 = 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 = ResourceKey> {
 	data?: T[];
 	meta?: Meta;

package/declarations/types/cache.d.ts

@@ -42,8 +42,6 @@ export interface Cache {
 	* @public
 	*/
 	version: "2";
-	// Cache Management
-	// ================
 	/**
 	* Cache the response to a request
 	*
@@ -164,8 +162,6 @@ export interface Cache {
 	* @return if `hasRecord` is true then calculated key changes should be returned
 	*/
 	upsert(cacheKey: ResourceKey, data: ResourceBlob, hasRecord: boolean): void | string[];
-	// Cache Forking Support
-	// =====================
 	/**
 	* Create a fork of the cache from the current state.
 	*
@@ -218,8 +214,6 @@ export interface Cache {
 	* @public
 	*/
 	diff(): Promise<Change[]>;
-	// SSR Support
-	// ===========
 	/**
 	* Serialize the entire contents of the Cache into a Stream
 	* which may be fed back into a new instance of the same Cache
@@ -244,8 +238,6 @@ export interface Cache {
 	* @public
 	*/
 	hydrate(stream: ReadableStream<unknown>): Promise<void>;
-	// Resource Support
-	// ================
 	/**
 	* [LIFECYCLE] Signal to the cache that a new record has been instantiated on the client
 	*
@@ -287,8 +279,6 @@ export interface Cache {
 	* @public
 	*/
 	unloadRecord(cacheKey: ResourceKey): void;
-	// Granular Resource Data APIs
-	// ===========================
 	/**
 	* Retrieve the data for an attribute from the cache
 	*
@@ -392,8 +382,6 @@ export interface Cache {
 	* @return resource relationship object
 	*/
 	getRemoteRelationship(cacheKey: ResourceKey, field: string, isCollection?: boolean): ResourceRelationship | CollectionRelationship;
-	// Resource State
-	// ===============
 	/**
 	* Update the cache state for the given resource to be marked
 	* as locally deleted, or remove such a mark.

package/declarations/types/identifier.d.ts

@@ -1,8 +1,6 @@
-// provided for additional debuggability
 export declare const DEBUG_CLIENT_ORIGINATED: unique symbol;
 export declare const DEBUG_KEY_TYPE: unique symbol;
 export declare const DEBUG_STALE_CACHE_OWNER: unique symbol;
-// also present in production
 export declare const CACHE_OWNER: "__$co";
 export type CacheKeyType = "record" | "document";
 /**

package/declarations/types/request.d.ts

@@ -47,9 +47,6 @@ export type CacheOptions = {
 	* than to invalidate findRecord requests for one.
 	*
 	*/
-	// TODO: Ideally this would be T extends TypedRecordInstance ? ExtractSuggestedCacheTypes<T>[] : string[];
-	// but that leads to `Type instantiation is excessively deep and possibly infinite.`
-	// issues when `T` has many properties.
 	types?: string[];
 	/**
 	* If true, the request will never be handled by the cache-manager and thus

package/declarations/types/spec/document.d.ts

@@ -2,7 +2,6 @@ import type { PersistedResourceKey } from "../identifier.js";
 import type { ApiError } from "./error.js";
 import type { Links, Meta, PaginationLinks } from "./json-api-raw.js";
 export interface ResourceMetaDocument {
-	// the url or cache-key associated with the structured document
 	lid?: string;
 	meta: Meta;
 	links?: Links | PaginationLinks;
@@ -11,7 +10,6 @@ export interface SingleResourceDataDocument<
 	T = PersistedResourceKey,
 	R = PersistedResourceKey
 > {
-	// the url or cache-key associated with the structured document
 	lid?: string;
 	links?: Links | PaginationLinks;
 	meta?: Meta;
@@ -19,7 +17,6 @@ export interface SingleResourceDataDocument<
 	included?: R[];
 }
 export interface CollectionResourceDataDocument<T = PersistedResourceKey> {
-	// the url or cache-key associated with the structured document
 	lid?: string;
 	links?: Links | PaginationLinks;
 	meta?: Meta;
@@ -28,7 +25,6 @@ export interface CollectionResourceDataDocument<T = PersistedResourceKey> {
 }
 export type ResourceDataDocument<T = PersistedResourceKey> = SingleResourceDataDocument<T> | CollectionResourceDataDocument<T>;
 export interface ResourceErrorDocument {
-	// the url or cache-key associated with the structured document
 	lid?: string;
 	links?: Links | PaginationLinks;
 	meta?: Meta;

package/declarations/types/spec/json-api-raw.d.ts

@@ -82,7 +82,6 @@ export interface ResourceIdentifier {
 	lid: string;
 }
 export type ResourceIdentifierObject<T extends string = string> = ResourceIdentifier | ExistingResourceIdentifierObject<T> | NewResourceIdentifierObject<T>;
-// TODO disallow NewResource, make narrowable
 export interface SingleResourceRelationship<T = ExistingResourceIdentifierObject | NewResourceIdentifierObject> {
 	data?: T | null;
 	meta?: Meta;

package/declarations/types.d.ts

@@ -6,7 +6,6 @@
 */
 export type { StableRecordIdentifier, ResourceKey } from "./types/identifier.js";
 export type { CacheCapabilitiesManager } from "./store/-types/q/cache-capabilities-manager.js";
-// FIXME this should come from somewhere more intelligent
 export type { ModelSchema } from "./store/deprecated/-private.js";
 export type { SchemaService } from "./store/-types/q/schema-service.js";
 export type { BaseFinderOptions, FindRecordOptions, LegacyResourceQuery, QueryOptions, FindAllOptions } from "./store/-types/q/store.js";

package/declarations/utils/string.d.ts

@@ -25,7 +25,6 @@ export declare class LRUCache<
 	size: number;
 	state: Map<T, V>;
 	doWork: (k: T) => V;
-	// debug stats
 	_hits: number;
 	_misses: number;
 	_ejected: number;

package/dist/index.js

@@ -4,7 +4,7 @@ import { macroCondition, getGlobalConfig } from '@embroider/macros';
 import { w as waitFor } from "./configure-C3x8YXzL.js";
 import { peekUniversalTransient, setUniversalTransient } from './types/-private.js';
 import { EnableHydration } from './types/request.js';
-export { C as CacheHandler, S as Store, r as recordIdentifierFor, U as setIdentifierForgetMethod, Q as setIdentifierGenerationMethod, V as setIdentifierResetMethod, T as setIdentifierUpdateMethod, W as setKeyInfoForResource, s as storeFor } from "./request-subscription-CjHGziEX.js";
+export { C as CacheHandler, S as Store, r as recordIdentifierFor, U as setIdentifierForgetMethod, Q as setIdentifierGenerationMethod, V as setIdentifierResetMethod, T as setIdentifierUpdateMethod, W as setKeyInfoForResource, s as storeFor } from "./request-state-C955e0AL.js";
 import '@ember/debug';
 import './utils/string.js';
 import "./symbols-sql1_mdx.js";

package/dist/reactive.js

@@ -1,5 +1,5 @@
-import { L as ReactiveResource, M as isNonIdentityCacheableField, N as getFieldCacheKeyStrict, r as recordIdentifierFor, H as withSignalStore, G as createInternalMemo } from "./request-subscription-CjHGziEX.js";
-export { O as checkout, P as commit } from "./request-subscription-CjHGziEX.js";
+import { L as ReactiveResource, M as isNonIdentityCacheableField, N as getFieldCacheKeyStrict, r as recordIdentifierFor, H as withSignalStore, G as createInternalMemo } from "./request-state-C955e0AL.js";
+export { O as checkout, P as commit } from "./request-state-C955e0AL.js";
 import { isResourceSchema } from './types/schema/fields.js';
 import { D as Destroy, C as Context } from "./symbols-sql1_mdx.js";
 export { a as Checkout } from "./symbols-sql1_mdx.js";