@warp-drive/core 5.7.0-alpha.13 → 5.7.0-alpha.15

package/declarations/types/request.d.ts

@@ -1,4 +1,4 @@
-import type { StableRecordIdentifier } from "./identifier.js";
+import type { ResourceKey } from "./identifier.js";
 import type { QueryParamsSerializationOptions } from "./params.js";
 import type { ExtractSuggestedCacheTypes, TypedRecordInstance, TypeFromInstanceOrString } from "./record.js";
 import type { ResourceIdentifierObject } from "./spec/json-api-raw.js";
@@ -105,14 +105,14 @@ export type DeleteRequestOptions<
 	op: "deleteRecord";
 	body?: string | BodyInit | FormData;
 	data: {
-		record: StableRecordIdentifier<TypeFromInstanceOrString<T>>;
+		record: ResourceKey<TypeFromInstanceOrString<T>>;
 	};
 	records: [ResourceIdentifierObject<TypeFromInstanceOrString<T>>];
 	[RequestSignature]?: RT;
 };
 type ImmutableRequest<T> = Readonly<T> & {
 	readonly headers: ImmutableHeaders;
-	readonly records: [StableRecordIdentifier];
+	readonly records: [ResourceKey];
 };
 export type UpdateRequestOptions<
 	RT = unknown,
@@ -124,7 +124,7 @@ export type UpdateRequestOptions<
 	op: "updateRecord";
 	body?: string | BodyInit | FormData;
 	data: {
-		record: StableRecordIdentifier<TypeFromInstanceOrString<T>>;
+		record: ResourceKey<TypeFromInstanceOrString<T>>;
 	};
 	records: [ResourceIdentifierObject<TypeFromInstanceOrString<T>>];
 	[RequestSignature]?: RT;
@@ -139,7 +139,7 @@ export type CreateRequestOptions<
 	op: "createRecord";
 	body?: string | BodyInit | FormData;
 	data: {
-		record: StableRecordIdentifier<TypeFromInstanceOrString<T>>;
+		record: ResourceKey<TypeFromInstanceOrString<T>>;
 	};
 	records: [ResourceIdentifierObject<TypeFromInstanceOrString<T>>];
 	[RequestSignature]?: RT;
@@ -163,6 +163,11 @@ export interface ConstrainedRequestOptions {
 export interface FindRecordOptions extends ConstrainedRequestOptions {
 	include?: string | string[];
 }
+/**
+* When a handler chain resolves, it returns an object
+* containing the original request, the response set by the handler
+* chain (if any), and the processed content.
+*/
 export interface StructuredDataDocument<T> {
 	[STRUCTURED]?: true;
 	/**
@@ -172,6 +177,14 @@ export interface StructuredDataDocument<T> {
 	response: Response | ResponseInfo | null;
 	content: T;
 }
+/**
+* When a handler chain rejects, it throws an Error that maintains the
+* `{ request, response, content }` shape but is also an Error instance
+* itself.
+*
+* If using the error originates from the {@link Fetch | Fetch Handler}
+* the error will be a {@link FetchError}
+*/
 export interface StructuredErrorDocument<T = unknown> extends Error {
 	[STRUCTURED]?: true;
 	request: ImmutableRequestInfo;
@@ -179,6 +192,14 @@ export interface StructuredErrorDocument<T = unknown> extends Error {
 	error: string | object;
 	content?: T;
 }
+/**
+* A union of the resolve/reject data types for a request.
+*
+* See the docs for:
+*
+* - {@link StructuredDataDocument} (resolved/successful requests)
+* - {@link StructuredErrorDocument} (rejected/failed requests)
+*/
 export type StructuredDocument<T> = StructuredDataDocument<T> | StructuredErrorDocument<T>;
 /**
 * JavaScript's native Request class.
@@ -271,7 +292,7 @@ export interface RequestInfo<
 	* operations on the store.
 	*
 	*/
-	records?: StableRecordIdentifier[];
+	records?: ResourceKey[];
 	disableTestWaiter?: boolean;
 	/**
 	* data that a handler should convert into

package/declarations/types/schema/concepts.d.ts

@@ -1,4 +1,4 @@
-import type { StableRecordIdentifier } from "../identifier.js";
+import type { ResourceKey } from "../identifier.js";
 import type { ObjectValue, Value } from "../json/raw.js";
 import type { OpaqueRecordInstance } from "../record.js";
 import type { Type } from "../symbols.js";
@@ -8,7 +8,7 @@ export type Transformation<
 > = {
 	serialize(value: PT, options: ObjectValue | null, record: OpaqueRecordInstance): T;
 	hydrate(value: T | undefined, options: ObjectValue | null, record: OpaqueRecordInstance): PT;
-	defaultValue?(options: ObjectValue | null, identifier: StableRecordIdentifier): T;
+	defaultValue?(options: ObjectValue | null, identifier: ResourceKey): T;
 	[Type]: string;
 };
 export type Derivation<

package/declarations/types/schema/fields.d.ts

@@ -473,7 +473,7 @@ export interface ObjectField {
 		* Configures which extensions this object should use.
 		*
 		* Extensions are registered with the store's schema service
-		* via {@link SchemaService.registerDangerousObjectExtension}
+		* via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}
 		*
 		* Extensions should only be used for temporary enhancements
 		* to objects to support migrating away from deprecated patterns

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

@@ -1,4 +1,4 @@
-import type { StableExistingRecordIdentifier } from "../identifier.js";
+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 {
@@ -8,8 +8,8 @@ export interface ResourceMetaDocument {
 	links?: Links | PaginationLinks;
 }
 export interface SingleResourceDataDocument<
-	T = StableExistingRecordIdentifier,
-	R = StableExistingRecordIdentifier
+	T = PersistedResourceKey,
+	R = PersistedResourceKey
 > {
 	// the url or cache-key associated with the structured document
 	lid?: string;
@@ -18,7 +18,7 @@ export interface SingleResourceDataDocument<
 	data: T | null;
 	included?: R[];
 }
-export interface CollectionResourceDataDocument<T = StableExistingRecordIdentifier> {
+export interface CollectionResourceDataDocument<T = PersistedResourceKey> {
 	// the url or cache-key associated with the structured document
 	lid?: string;
 	links?: Links | PaginationLinks;
@@ -26,7 +26,7 @@ export interface CollectionResourceDataDocument<T = StableExistingRecordIdentifi
 	data: T[];
 	included?: T[];
 }
-export type ResourceDataDocument<T = StableExistingRecordIdentifier> = SingleResourceDataDocument<T> | CollectionResourceDataDocument<T>;
+export type ResourceDataDocument<T = PersistedResourceKey> = SingleResourceDataDocument<T> | CollectionResourceDataDocument<T>;
 export interface ResourceErrorDocument {
 	// the url or cache-key associated with the structured document
 	lid?: string;
@@ -34,4 +34,4 @@ export interface ResourceErrorDocument {
 	meta?: Meta;
 	errors: ApiError[];
 }
-export type ResourceDocument<T = StableExistingRecordIdentifier> = ResourceMetaDocument | SingleResourceDataDocument<T> | CollectionResourceDataDocument<T> | ResourceErrorDocument;
+export type ResourceDocument<T = PersistedResourceKey> = ResourceMetaDocument | SingleResourceDataDocument<T> | CollectionResourceDataDocument<T> | ResourceErrorDocument;

package/dist/{context-COmAnXUQ.js → context-kQXhkeBj.js}

@@ -306,6 +306,19 @@ function ensureDoc(owner, content, isError) {
     content: content
   };
 }
+
+/**
+ * Additional properties exposed on errors thrown by the
+ * {@link Fetch | Fetch Handler}.
+ *
+ * In the case of an Abort or system/browser level issue,
+ * this extends {@link DOMException}.
+ *
+ * Else it extends from {@link AggregateError} if the
+ * response includes an array of errors, falling back
+ * to {@link Error} as its base.
+ */
+
 function enhanceReason(reason) {
   return new DOMException(reason || 'The user aborted a request.', 'AbortError');
 }