@warp-drive/core 5.9.0-beta.0 → 5.9.0-beta.1

package/declarations/types/cache.d.ts

@@ -1,429 +1,2 @@
-import type { ResourceBlob } from "./cache/aliases.js";
-import type { Change } from "./cache/change.js";
-import type { Mutation } from "./cache/mutations.js";
-import type { Operation } from "./cache/operations.js";
-import type { CollectionRelationship, ResourceRelationship } from "./cache/relationship.js";
-import type { RequestKey, ResourceKey } from "./identifier.js";
-import type { Value } from "./json/raw.js";
-import type { TypeFromInstanceOrString } from "./record.js";
-import type { RequestContext, StructuredDataDocument, StructuredDocument } from "./request.js";
-import type { CollectionResourceDataDocument, ResourceDocument, SingleResourceDataDocument } from "./spec/document.js";
-import type { ApiError } from "./spec/error.js";
-/**
-* A hash of changed attributes with the key being the attribute name and the value being an
-* array of `[oldValue, newValue]`.
-*
-*/
-export type ChangedAttributesHash = Record<string, [Value | undefined, Value]>;
-export type RelationshipDiff = {
-	kind: "collection";
-	remoteState: ResourceKey[];
-	additions: Set<ResourceKey>;
-	removals: Set<ResourceKey>;
-	localState: ResourceKey[];
-	reordered: boolean;
-} | {
-	kind: "resource";
-	remoteState: ResourceKey | null;
-	localState: ResourceKey | null;
-};
-/**
-* The interface for WarpDrive Caches.
-*
-* A Cache handles in-memory storage of Document and Resource
-* data.
-*
-* @public
-*/
-export interface Cache {
-	/**
-	* The Cache Version that this implementation implements.
-	*
-	* @public
-	*/
-	version: "2";
-	/**
-	* Cache the response to a request
-	*
-	* Unlike `store.push` which has UPSERT
-	* semantics, `put` has `replace` semantics similar to
-	* the `http` method `PUT`
-	*
-	* the individually cacheable resource data it may contain
-	* should upsert, but the document data surrounding it should
-	* fully replace any existing information
-	*
-	* Note that in order to support inserting arbitrary data
-	* to the cache that did not originate from a request `put`
-	* should expect to sometimes encounter a document with only
-	* a `content` member and therefor must not assume the existence
-	* of `request` and `response` on the document.
-	*
-	* @public
-	*/
-	put<T>(doc: StructuredDocument<T> | {
-		content: T;
-	}): ResourceDocument;
-	/**
-	* Update the "remote" or "canonical" (persisted) state of the Cache
-	* by merging new information into the existing state.
-	*
-	* @public
-	* @param op the operation(s) to perform
-	*/
-	patch(op: Operation | Operation[]): void;
-	/**
-	* Update the "local" or "current" (unpersisted) state of the Cache
-	*
-	* @public
-	*/
-	mutate(mutation: Mutation): void;
-	/**
-	* Peek resource data from the Cache.
-	*
-	* In development, if the return value
-	* is JSON the return value
-	* will be deep-cloned and deep-frozen
-	* to prevent mutation thereby enforcing cache
-	* Immutability.
-	*
-	* This form of peek is useful for implementations
-	* that want to feed raw-data from cache to the UI
-	* or which want to interact with a blob of data
-	* directly from the presentation cache.
-	*
-	* An implementation might want to do this because
-	* de-referencing records which read from their own
-	* blob is generally safer because the record does
-	* not require retainining connections to the Store
-	* and Cache to present data on a per-field basis.
-	*
-	* This generally takes the place of `getAttr` as
-	* an API and may even take the place of `getRelationship`
-	* depending on implementation specifics, though this
-	* latter usage is less recommended due to the advantages
-	* of the Graph handling necessary entanglements and
-	* notifications for relational data.
-	*
-	* @public
-	* @return the known resource data, if any
-	*/
-	peek<T = unknown>(cacheKey: ResourceKey<TypeFromInstanceOrString<T>>): T | null;
-	peek(cacheKey: RequestKey): ResourceDocument | null;
-	/**
-	* Peek remote resource data from the Cache.
-	*
-	* This will give the data provided from the server without any local changes.
-	*
-	* In development, if the return value
-	* is JSON the return value
-	* will be deep-cloned and deep-frozen
-	* to prevent mutation thereby enforcing cache
-	* Immutability.
-	*
-	* This form of peek is useful for implementations
-	* that want to feed raw-data from cache to the UI
-	* or which want to interact with a blob of data
-	* directly from the presentation cache.
-	*
-	* An implementation might want to do this because
-	* de-referencing records which read from their own
-	* blob is generally safer because the record does
-	* not require retainining connections to the Store
-	* and Cache to present data on a per-field basis.
-	*
-	* This generally takes the place of `getAttr` as
-	* an API and may even take the place of `getRelationship`
-	* depending on implementation specifics, though this
-	* latter usage is less recommended due to the advantages
-	* of the Graph handling necessary entanglements and
-	* notifications for relational data.
-	*
-	* @public
-	* @return the known data, if any
-	*/
-	peekRemoteState<T = unknown>(cacheKey: ResourceKey<TypeFromInstanceOrString<T>>): T | null;
-	peekRemoteState(cacheKey: RequestKey): ResourceDocument | null;
-	/**
-	* Peek the Cache for the existing request data associated with
-	* a cacheable request
-	*
-	* This is effectively the reverse of `put` for a request in
-	* that it will return the the request, response, and content
-	* whereas `peek` will return just the `content`.
-	*
-	* @public
-	*/
-	peekRequest(cacheKey: RequestKey): StructuredDocument<ResourceDocument> | null;
-	/**
-	* Push resource data from a remote source into the cache for this ResourceKey
-	*
-	* @public
-	* @return if `hasRecord` is true then calculated key changes should be returned
-	*/
-	upsert(cacheKey: ResourceKey, data: ResourceBlob, hasRecord: boolean): void | string[];
-	/**
-	* Create a fork of the cache from the current state.
-	*
-	* Applications should typically not call this method themselves,
-	* preferring instead to fork at the Store level, which will
-	* utilize this method to fork the cache.
-	*
-	* @public
-	*/
-	fork(): Promise<Cache>;
-	/**
-	* Merge a fork back into a parent Cache.
-	*
-	* Applications should typically not call this method themselves,
-	* preferring instead to merge at the Store level, which will
-	* utilize this method to merge the caches.
-	*
-	*/
-	merge(cache: Cache): Promise<void>;
-	/**
-	* Generate the list of changes applied to all
-	* record in the store.
-	*
-	* Each individual resource or document that has
-	* been mutated should be described as an individual
-	* `Change` entry in the returned array.
-	*
-	* A `Change` is described by an object containing up to
-	* three properties: (1) the `CacheKey` of the entity that
-	* changed; (2) the `op` code of that change being one of
-	* `upsert` or `remove`, and if the op is `upsert` a `patch`
-	* containing the data to merge into the cache for the given
-	* entity.
-	*
-	* This `patch` is opaque to the Store but should be understood
-	* by the Cache and may expect to be utilized by an Adapter
-	* when generating data during a `save` operation.
-	*
-	* It is generally recommended that the `patch` contain only
-	* the updated state, ignoring fields that are unchanged
-	*
-	* ```ts
-	* interface Change {
-	*  key: ResourceKey | RequestKey;
-	*  op: 'upsert' | 'remove';
-	*  patch?: unknown;
-	* }
-	* ```
-	*
-	* @public
-	*/
-	diff(): Promise<Change[]>;
-	/**
-	* Serialize the entire contents of the Cache into a Stream
-	* which may be fed back into a new instance of the same Cache
-	* via `cache.hydrate`.
-	*
-	* @return {Promise<ReadableStream>}
-	* @public
-	*/
-	dump(): Promise<ReadableStream<unknown>>;
-	/**
-	* hydrate a Cache from a Stream with content previously serialized
-	* from another instance of the same Cache, resolving when hydration
-	* is complete.
-	*
-	* This method should expect to be called both in the context of restoring
-	* the Cache during application rehydration after SSR **AND** at unknown
-	* times during the lifetime of an already booted application when it is
-	* desired to bulk-load additional information into the cache. This latter
-	* behavior supports optimizing pre/fetching of data for route transitions
-	* via data-only SSR modes.
-	*
-	* @public
-	*/
-	hydrate(stream: ReadableStream<unknown>): Promise<void>;
-	/**
-	* [LIFECYCLE] Signal to the cache that a new record has been instantiated on the client
-	*
-	* It returns properties from options that should be set on the record during the create
-	* process. This return value behavior is deprecated.
-	*
-	* @public
-	*/
-	clientDidCreate(cacheKey: ResourceKey, createArgs?: Record<string, unknown>): Record<string, unknown>;
-	/**
-	* [LIFECYCLE] Signals to the cache that a resource
-	* will be part of a save transaction.
-	*
-	* @public
-	*/
-	willCommit(cacheKey: ResourceKey | ResourceKey[], context: RequestContext | null): void;
-	/**
-	* [LIFECYCLE] Signals to the cache that a resource
-	* was successfully updated as part of a save transaction.
-	*
-	* @public
-	* @param cacheKey - the primary ResourceKey that was operated on
-	* @param result - a document in the cache format containing any updated data
-	*/
-	didCommit(cacheKey: ResourceKey, result: StructuredDataDocument<SingleResourceDataDocument> | null): SingleResourceDataDocument;
-	didCommit(cacheKey: ResourceKey[], result: StructuredDataDocument<SingleResourceDataDocument> | null): SingleResourceDataDocument;
-	didCommit(cacheKey: ResourceKey[], result: StructuredDataDocument<CollectionResourceDataDocument> | null): CollectionResourceDataDocument;
-	/**
-	* [LIFECYCLE] Signals to the cache that a resource
-	* was update via a save transaction failed.
-	*
-	* @public
-	*/
-	commitWasRejected(cacheKey: ResourceKey | ResourceKey[], errors?: ApiError[]): void;
-	/**
-	* [LIFECYCLE] Signals to the cache that all data for a resource
-	* should be cleared.
-	*
-	* This method is a candidate to become a mutation
-	*
-	* @public
-	*/
-	unloadRecord(cacheKey: ResourceKey): void;
-	/**
-	* Retrieve the data for an attribute from the cache
-	*
-	* @public
-	*/
-	getAttr(cacheKey: ResourceKey, field: string | string[]): Value | undefined;
-	/**
-	* Retrieve remote state without any local changes for a specific attribute
-	*
-	* @public
-	*/
-	getRemoteAttr(cacheKey: ResourceKey, field: string | string[]): Value | undefined;
-	/**
-	* Mutate the data for an attribute in the cache
-	*
-	* This method is a candidate to become a mutation
-	*
-	* @public
-	*/
-	setAttr(cacheKey: ResourceKey, field: string | string[], value: Value): void;
-	/**
-	* Query the cache for the changed attributes of a resource.
-	*
-	* Returns a map of field names to tuples of [old, new] values
-	*
-	* ```
-	* { <field>: [<old>, <new>] }
-	* ```
-	*
-	* @public
-	*/
-	changedAttrs(cacheKey: ResourceKey): ChangedAttributesHash;
-	/**
-	* Query the cache for whether any mutated attributes exist
-	*
-	* @public
-	*/
-	hasChangedAttrs(cacheKey: ResourceKey): boolean;
-	/**
-	* Tell the cache to discard any uncommitted mutations to attributes
-	*
-	* This method is a candidate to become a mutation
-	*
-	* @public
-	* @return the names of fields that were restored
-	*/
-	rollbackAttrs(cacheKey: ResourceKey): string[];
-	/**
-	* Query the cache for the changes to relationships of a resource.
-	*
-	* Returns a map of relationship names to RelationshipDiff objects.
-	*
-	* ```ts
-	* type RelationshipDiff =
-	| {
-	kind: 'collection';
-	remoteState: ResourceKey[];
-	additions: Set<ResourceKey>;
-	removals: Set<ResourceKey>;
-	localState: ResourceKey[];
-	reordered: boolean;
-	}
-	| {
-	kind: 'resource';
-	remoteState: ResourceKey | null;
-	localState: ResourceKey | null;
-	};
-	```
-	*
-	* @public
-	*/
-	changedRelationships(cacheKey: ResourceKey): Map<string, RelationshipDiff>;
-	/**
-	* Query the cache for whether any mutated attributes exist
-	*
-	* @public
-	*/
-	hasChangedRelationships(cacheKey: ResourceKey): boolean;
-	/**
-	* Tell the cache to discard any uncommitted mutations to relationships.
-	*
-	* This will also discard the change on any appropriate inverses.
-	*
-	* This method is a candidate to become a mutation
-	*
-	* @public
-	* @return the names of relationships that were restored
-	*/
-	rollbackRelationships(cacheKey: ResourceKey): string[];
-	/**
-	* Query the cache for the current state of a relationship property
-	*
-	* @public
-	* @return resource relationship object
-	*/
-	getRelationship(cacheKey: ResourceKey, field: string, isCollection?: boolean): ResourceRelationship | CollectionRelationship;
-	/**
-	* Query the cache for the server state of a relationship property without any local changes
-	*
-	* @public
-	* @return resource relationship object
-	*/
-	getRemoteRelationship(cacheKey: ResourceKey, field: string, isCollection?: boolean): ResourceRelationship | CollectionRelationship;
-	/**
-	* Update the cache state for the given resource to be marked
-	* as locally deleted, or remove such a mark.
-	*
-	* This method is a candidate to become a mutation
-	*
-	* @public
-	*/
-	setIsDeleted(cacheKey: ResourceKey, isDeleted: boolean): void;
-	/**
-	* Query the cache for any validation errors applicable to the given resource.
-	*
-	* @public
-	*/
-	getErrors(cacheKey: ResourceKey): ApiError[];
-	/**
-	* Query the cache for whether a given resource has any available data
-	*
-	* @public
-	*/
-	isEmpty(cacheKey: ResourceKey): boolean;
-	/**
-	* Query the cache for whether a given resource was created locally and not
-	* yet persisted.
-	*
-	* @public
-	*/
-	isNew(cacheKey: ResourceKey): boolean;
-	/**
-	* Query the cache for whether a given resource is marked as deleted (but not
-	* necessarily persisted yet).
-	*
-	* @public
-	*/
-	isDeleted(cacheKey: ResourceKey): boolean;
-	/**
-	* Query the cache for whether a given resource has been deleted and that deletion
-	* has also been persisted.
-	*
-	* @public
-	*/
-	isDeletionCommitted(cacheKey: ResourceKey): boolean;
-}
+import { Ht as ChangedAttributesHash, Ut as RelationshipDiff, Vt as Cache } from "../internal-Cz-893zD.js";
+export { Cache, ChangedAttributesHash, RelationshipDiff };

package/declarations/types/graph.d.ts

@@ -1,47 +1,2 @@
-import type { AddToResourceRelationshipMutation as AddResourceMutation, RemoveFromResourceRelationshipMutation as RemoveResourceMutation } from "./cache/mutations.js";
-import type { AddToResourceRelationshipOperation as AddResourceOperation, RemoveFromResourceRelationshipOperation as RemoveResourceOperation, UpdateResourceRelationshipOperation } from "./cache/operations.js";
-import type { ResourceKey } from "./identifier.js";
-import type { CollectionResourceRelationship, SingleResourceRelationship } from "./spec/json-api-raw.js";
-export interface Operation {
-	op: string;
-}
-export interface UpdateRelationshipOperation {
-	op: "updateRelationship";
-	record: ResourceKey;
-	field: string;
-	value: SingleResourceRelationship | CollectionResourceRelationship;
-}
-export interface DeleteRecordOperation {
-	op: "deleteRecord";
-	record: ResourceKey;
-	isNew: boolean;
-}
-export interface UnknownOperation {
-	op: "never";
-	record: ResourceKey;
-	field: string;
-}
-export interface ReplaceRelatedRecordOperation {
-	op: "replaceRelatedRecord";
-	record: ResourceKey;
-	field: string;
-	value: ResourceKey | null;
-	prior?: ResourceKey;
-	index?: number;
-}
-export interface SortRelatedRecords {
-	op: "sortRelatedRecords";
-	record: ResourceKey;
-	field: string;
-	value: ResourceKey[];
-}
-export interface ReplaceRelatedRecordsOperation {
-	op: "replaceRelatedRecords";
-	record: ResourceKey;
-	field: string;
-	value: ResourceKey[];
-	prior?: ResourceKey[];
-	index?: number;
-}
-export type RemoteRelationshipOperation = UpdateResourceRelationshipOperation | UpdateRelationshipOperation | ReplaceRelatedRecordOperation | ReplaceRelatedRecordsOperation | RemoveResourceOperation | AddResourceOperation | DeleteRecordOperation | SortRelatedRecords;
-export type LocalRelationshipOperation = ReplaceRelatedRecordsOperation | ReplaceRelatedRecordOperation | AddResourceMutation | RemoveResourceMutation | SortRelatedRecords;
+import { a as ReplaceRelatedRecordOperation, c as UnknownOperation, i as RemoteRelationshipOperation, l as UpdateRelationshipOperation, n as LocalRelationshipOperation, o as ReplaceRelatedRecordsOperation, r as Operation, s as SortRelatedRecords, t as DeleteRecordOperation } from "../graph-DLqYXP2z.js";
+export { DeleteRecordOperation, LocalRelationshipOperation, Operation, RemoteRelationshipOperation, ReplaceRelatedRecordOperation, ReplaceRelatedRecordsOperation, SortRelatedRecords, UnknownOperation, UpdateRelationshipOperation };

package/declarations/types/identifier.d.ts

@@ -1,86 +1,2 @@
-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;
-export declare const CACHE_OWNER: "__$co";
-export type CacheKeyType = "record" | "document";
-/**
-* A referentially stable object with a unique string (lid) that can be used
-* as a reference to request data in the cache.
-*
-* Only requests that are assigned a RequestKey are retrievable/replayable from
-* the cache, though requests without RequestKeys may still update cache state.
-*
-* @public
-*/
-export interface RequestKey {
-	lid: string;
-	type: "@document";
-}
-/** @deprecated use {@link RequestKey} */
-export type StableDocumentIdentifier = RequestKey;
-/**
-* Used when an ResourceKey is known to be the stable version
-*/
-interface ResourceKeyBase<T extends string = string> {
-	/**
-	* A string representing a unique identity.
-	*
-	* @public
-	*/
-	lid: string;
-	/**
-	* the primary `ResourceType` or "model name" this ResourceKey belongs to.
-	*
-	* @public
-	*/
-	type: T;
-}
-/**
-* Used when a ResourceKey was not created locally as part
-* of a call to store.createRecord
-*
-* Distinguishing between this ResourceKey and one for a client created
-* resource that was created with an ID is generally speaking not possible
-* at runtime, so anything with an ID typically narrows to this.
-*/
-export interface PersistedResourceKey<T extends string = string> extends ResourceKeyBase<T> {
-	/**
-	* the PrimaryKey for the resource this ResourceKey represents.
-	*
-	* @public
-	*/
-	id: string;
-}
-/** @deprecated use {@link PersistedResourceKey} */
-export type StableExistingRecordIdentifier<T extends string = string> = PersistedResourceKey<T>;
-/**
-* Used when a ResourceKey was created locally
-* (by a call to store.createRecord).
-*
-* It is possible in rare circumstances to have a ResourceKey
-* that is not for a new record but does not have an ID. This would
-* happen if a user intentionally created one for use with a secondary-index
-* prior to the record having been fully loaded.
-*/
-export interface NewResourceKey<T extends string = string> extends ResourceKeyBase<T> {
-	/**
-	* the PrimaryKey for the resource this ResourceKey represents. `null`
-	* if not yet assigned a PrimaryKey value.
-	*
-	* @public
-	*/
-	id: string | null;
-}
-/**
-* A referentially stable object with a unique string (lid) that can be used
-* as a reference to data in the cache.
-*
-* Every resource has a unique ResourceKey, and ResourceKeys may refer
-* to data that has never been loaded (for instance, in an async relationship).
-*
-* @public
-*/
-export type ResourceKey<T extends string = string> = PersistedResourceKey<T> | NewResourceKey<T>;
-/** @deprecated use {@link ResourceKey} */
-export type StableRecordIdentifier<T extends string = string> = ResourceKey<T>;
-export {};
+import { a as DEBUG_STALE_CACHE_OWNER, c as RequestKey, d as StableExistingRecordIdentifier, f as StableRecordIdentifier, i as DEBUG_KEY_TYPE, l as ResourceKey, n as CacheKeyType, o as NewResourceKey, r as DEBUG_CLIENT_ORIGINATED, s as PersistedResourceKey, t as CACHE_OWNER, u as StableDocumentIdentifier } from "../identifier-DQnqOSJK.js";
+export { CACHE_OWNER, CacheKeyType, DEBUG_CLIENT_ORIGINATED, DEBUG_KEY_TYPE, DEBUG_STALE_CACHE_OWNER, NewResourceKey, PersistedResourceKey, RequestKey, ResourceKey, StableDocumentIdentifier, StableExistingRecordIdentifier, StableRecordIdentifier };

package/declarations/types/json/raw.d.ts

@@ -1,6 +1,2 @@
-export type PrimitiveValue = string | number | boolean | null;
-export interface ObjectValue {
-	[key: string]: Value;
-}
-export type ArrayValue = Value[];
-export type Value = PrimitiveValue | ArrayValue | ObjectValue;
+import { i as Value, n as ObjectValue, r as PrimitiveValue, t as ArrayValue } from "../../raw-D5hnjiq7.js";
+export { ArrayValue, ObjectValue, PrimitiveValue, Value };

package/declarations/types/params.d.ts

@@ -1,8 +1,2 @@
-export type SerializablePrimitive = string | number | boolean | null;
-export type Serializable = SerializablePrimitive | SerializablePrimitive[];
-export type QueryParamsSerializationOptions = {
-	arrayFormat?: "bracket" | "indices" | "repeat" | "comma";
-};
-export type QueryParamsSource = ({
-	include?: string | string[];
-} & Record<Exclude<string, "include">, Serializable>) | URLSearchParams;
+import { i as SerializablePrimitive, n as QueryParamsSource, r as Serializable, t as QueryParamsSerializationOptions } from "../params-DrEx3bf8.js";
+export { QueryParamsSerializationOptions, QueryParamsSource, Serializable, SerializablePrimitive };