@warp-drive/core 5.8.0-alpha.3 → 5.8.0-alpha.30

package/declarations/types/request.d.ts

@@ -1,3 +1,4 @@
+import type { FetchError } from "../request/-private/utils.js";
 import type { Store } from "../store/-private.js";
 import type { ResourceKey } from "./identifier.js";
 import type { QueryParamsSerializationOptions } from "./params.js";
@@ -8,12 +9,14 @@ export declare const SkipCache: "___(unique) Symbol(SkipCache)";
 export declare const EnableHydration: "___(unique) Symbol(EnableHydration)";
 export declare const IS_FUTURE: "___(unique) Symbol(IS_FUTURE)";
 export declare const STRUCTURED: "___(unique) Symbol(DOC)";
+export type { FetchError };
 export type HTTPMethod = "QUERY" | "GET" | "OPTIONS" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "CONNECT" | "TRACE";
 /**
-* Use these options to adjust CacheHandler behavior for a request.
+* Use these options to adjust {@link CacheHandler} behavior for a request
+* via {@link RequestInfo.cacheOptions}.
 *
 */
-export type CacheOptions = {
+export interface CacheOptions {
 	/**
 	* A key that uniquely identifies this request. If not present, the url wil be used
 	* as the key for any GET request, while all other requests will not be cached.
@@ -57,7 +60,7 @@ export type CacheOptions = {
 	*
 	*/
 	[SkipCache]?: boolean;
-};
+}
 export type FindRecordRequestOptions<
 	RT = unknown,
 	T = unknown
@@ -158,11 +161,15 @@ 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.
+* When a {@link Future} resolves, it returns an object
+* containing the original {@link RequestInfo | request},
+* the {@link Response | response} set by the handler chain (if any), and
+* the processed content.
 */
 export interface StructuredDataDocument<T> {
+	/**
+	* @private
+	*/
 	[STRUCTURED]?: true;
 	/**
 	* @see {@link ImmutableRequestInfo}
@@ -172,25 +179,34 @@ export interface StructuredDataDocument<T> {
 	content: T;
 }
 /**
-* When a handler chain rejects, it throws an Error that maintains the
-* `{ request, response, content }` shape but is also an Error instance
+* When a {@link Future} rejects, it throws either an {@link Error}
+* an {@link AggregateError} or a {@link DOMException} 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 {
+	/**
+	* @private
+	*/
 	[STRUCTURED]?: true;
+	/**
+	* @see {@link ImmutableRequestInfo}
+	*/
 	request: ImmutableRequestInfo;
 	response: Response | ResponseInfo | null;
 	error: string | object;
 	content?: T;
 }
 /**
-* A union of the resolve/reject data types for a request.
+* A union of the resolve/reject data types for the {@link Future}
+* returned by {@link Store.request | request}
 *
-* See the docs for:
+* See also the docs for:
 *
+* - {@link Future}
 * - {@link StructuredDataDocument} (resolved/successful requests)
 * - {@link StructuredErrorDocument} (rejected/failed requests)
 */
@@ -349,7 +365,3 @@ export interface RequestContext {
 	setStream(stream: ReadableStream | Promise<ReadableStream | null>): void;
 	setResponse(response: Response | ResponseInfo | null): void;
 }
-export declare function withBrand<T>(obj: RequestInfo): RequestInfo<T> & {
-	[RequestSignature]: T;
-};
-export {};

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

@@ -673,7 +673,7 @@ export interface ArrayField {
 		*
 		* Configures which extensions this array is allowed to use.
 		* Extensions are registered with the store's schema service
-		* via {@link SchemaService.registerDangerousArrayExtension}
+		* via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}
 		*
 		* Extensions should only be used for temporary enhancements
 		* to arrays to support migrating away from deprecated behaviors
@@ -786,7 +786,7 @@ export interface SchemaArrayField {
 		*
 		* Configures which extensions this array is allowed to use.
 		* Extensions are registered with the store's schema service
-		* via {@link SchemaService.registerDangerousArrayExtension}
+		* via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}
 		*
 		* Extensions should only be used for temporary enhancements
 		* to arrays to support migrating away from deprecated behaviors
@@ -1285,6 +1285,9 @@ export interface LegacyBelongsToField {
 		*
 		* If null, the relationship is unidirectional.
 		*
+		* If the inverse field definition uses a sourceKey,
+		* this should still be the name of the field, not the sourceKey.
+		*
 		* @public
 		*/
 		inverse: string | null;
@@ -1307,8 +1310,9 @@ export interface LegacyBelongsToField {
 		*/
 		polymorphic?: boolean;
 		/**
-		* Whether this field should ever make use of the legacy support infra
-		* from @ember-data/model and the LegacyNetworkMiddleware for adapters and serializers.
+		* Whether this field should ever make use of the legacy request infra
+		* from @warp-drive/legacy/compat and the LegacyNetworkMiddleware for
+		* adapters and serializers.
 		*
 		* When true, none of the legacy support will be utilized. Sync relationships
 		* will be expected to already have all their data. When reloading a sync relationship
@@ -1433,6 +1437,9 @@ export interface LinksModeBelongsToField {
 		*
 		* If null, the relationship is unidirectional.
 		*
+		* If the inverse field definition uses a sourceKey,
+		* this should still be the name of the field, not the sourceKey.
+		*
 		* @public
 		*/
 		inverse: string | null;
@@ -1571,7 +1578,7 @@ export interface LegacyHasManyField {
 		*
 		* Configures which extensions this array is allowed to use.
 		* Extensions are registered with the store's schema service
-		* via {@link SchemaService.registerDangerousArrayExtension}
+		* via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}
 		*
 		* Extensions should only be used for temporary enhancements
 		* to arrays to support migrating away from deprecated behaviors
@@ -1604,6 +1611,9 @@ export interface LegacyHasManyField {
 		*
 		* If null, the relationship is unidirectional.
 		*
+		* If the inverse field definition uses a sourceKey,
+		* this should still be the name of the field, not the sourceKey.
+		*
 		* @public
 		*/
 		inverse: string | null;
@@ -1742,7 +1752,7 @@ export interface LinksModeHasManyField {
 		*
 		* Configures which extensions this array is allowed to use.
 		* Extensions are registered with the store's schema service
-		* via {@link SchemaService.registerDangerousArrayExtension}
+		* via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}
 		*
 		* Extensions should only be used for temporary enhancements
 		* to arrays to support migrating away from deprecated behaviors
@@ -1777,6 +1787,9 @@ export interface LinksModeHasManyField {
 		*
 		* If null, the relationship is unidirectional.
 		*
+		* If the inverse field definition uses a sourceKey,
+		* this should still be the name of the field, not the sourceKey.
+		*
 		* @public
 		*/
 		inverse: string | null;
@@ -2125,18 +2138,29 @@ export interface ObjectSchema {
 	objectExtensions?: string[];
 }
 export type Schema = ResourceSchema | ObjectSchema;
+/**
+* A trait for use on a PolarisMode record
+*/
 export interface PolarisTrait {
 	name: string;
 	mode: "polaris";
 	fields: PolarisModeFieldSchema[];
 	traits?: string[];
 }
+/**
+* A trait for use on a LegacyMode record
+*/
 export interface LegacyTrait {
 	name: string;
 	mode: "legacy";
 	fields: LegacyModeFieldSchema[];
 	traits?: string[];
 }
+/**
+* A union of
+* - {@link LegacyTrait}
+* - {@link PolarisTrait}
+*/
 export type Trait = LegacyTrait | PolarisTrait;
 /**
 * A no-op type utility that enables type-checking resource schema

package/declarations/{store/-types/q → types/schema}/schema-service.d.ts

@@ -1,9 +1,9 @@
-import type { CAUTION_MEGA_DANGER_ZONE_Extension, ProcessedExtension } from "../../../reactive.js";
-import type { ExtensibleField } from "../../../reactive/-private/schema.js";
-import type { ResourceKey } from "../../../types/identifier.js";
-import type { ObjectValue } from "../../../types/json/raw.js";
-import type { Derivation, HashFn, Transformation } from "../../../types/schema/concepts.js";
-import type { ArrayField, CacheableFieldSchema, DerivedField, FieldSchema, GenericField, HashField, IdentityField, LegacyAttributeField, LegacyRelationshipField, ObjectField, Schema, Trait } from "../../../types/schema/fields.js";
+import type { CAUTION_MEGA_DANGER_ZONE_Extension, ProcessedExtension } from "../../reactive.js";
+import type { ExtensibleField } from "../../reactive/-private/schema.js";
+import type { ResourceKey } from "../identifier.js";
+import type { ObjectValue } from "../json/raw.js";
+import type { Derivation, HashFn, Transformation } from "./concepts.js";
+import type { ArrayField, CacheableFieldSchema, DerivedField, FieldSchema, GenericField, HashField, IdentityField, LegacyAttributeField, LegacyRelationshipField, ObjectField, Schema, Trait } from "./fields.js";
 export type AttributesSchema = Record<string, LegacyAttributeField>;
 export type RelationshipsSchema = Record<string, LegacyRelationshipField>;
 interface ObjectWithStringTypeProperty {
@@ -66,7 +66,7 @@ export interface SchemaService {
 	* Queries whether the SchemaService recognizes `type` as a resource type
 	*
 	* @public
-	* @deprecated
+	* @deprecated - use {@link SchemaService.hasResource | hasResource}
 	*/
 	doesTypeExist?(type: string): boolean;
 	/**
@@ -251,7 +251,7 @@ export interface SchemaService {
 	* ```
 	*
 	* @public
-	* @deprecated
+	* @deprecated - use {@link SchemaService.fields | fields}
 	*/
 	attributesDefinitionFor?(key: ResourceKey | ObjectWithStringTypeProperty): AttributesSchema;
 	/**
@@ -330,7 +330,7 @@ export interface SchemaService {
 	* ```
 	*
 	* @public
-	* @deprecated
+	* @deprecated - use {@link SchemaService.fields | fields}
 	*/
 	relationshipsDefinitionFor?(key: ResourceKey | ObjectWithStringTypeProperty): RelationshipsSchema;
 	/**
@@ -342,6 +342,8 @@ export interface SchemaService {
 	/**
 	* Register an extension for either objects or arrays
 	*
+	* See also {@link CAUTION_MEGA_DANGER_ZONE_Extension}
+	*
 	* @public
 	*/
 	CAUTION_MEGA_DANGER_ZONE_registerExtension?(extension: CAUTION_MEGA_DANGER_ZONE_Extension): void;

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

@@ -1,11 +1,21 @@
 import type { PersistedResourceKey } from "../identifier.js";
 import type { ApiError } from "./error.js";
 import type { Links, Meta, PaginationLinks } from "./json-api-raw.js";
+/**
+* This type represents a raw {json:api} document for a meta-only
+* document returned by a request intended to be inserted into the cache.
+*/
 export interface ResourceMetaDocument {
 	lid?: string;
 	meta: Meta;
 	links?: Links | PaginationLinks;
 }
+/**
+* This type represents a raw {json:api} document for a single resource
+* returned by a request intended to be inserted into the cache.
+*
+* For the Reactive value returned by a request using the store, use {@link ReactiveDataDocument} instead.
+*/
 export interface SingleResourceDataDocument<
 	T = PersistedResourceKey,
 	R = PersistedResourceKey
@@ -16,6 +26,12 @@ export interface SingleResourceDataDocument<
 	data: T | null;
 	included?: R[];
 }
+/**
+* This type represents a raw {json:api} document for a resource collection
+* returned by a request intended to be inserted into the cache.
+*
+* For the Reactive value returned by a request using the store, use {@link ReactiveDataDocument} instead.
+*/
 export interface CollectionResourceDataDocument<T = PersistedResourceKey> {
 	lid?: string;
 	links?: Links | PaginationLinks;
@@ -23,11 +39,29 @@ export interface CollectionResourceDataDocument<T = PersistedResourceKey> {
 	data: T[];
 	included?: T[];
 }
+/**
+* A type useful for representing the raw {json:api} documents that
+* the cache may use.
+*
+* For the Reactive value returned by a request using the store, use {@link ReactiveDataDocument} instead.
+*/
 export type ResourceDataDocument<T = PersistedResourceKey> = SingleResourceDataDocument<T> | CollectionResourceDataDocument<T>;
+/**
+* A type useful for representing the raw {json:api} Error documents that
+* the cache may use.
+*
+* For the Reactive value returned by a request using the store, use {@link ReactiveErrorDocument} instead.
+*/
 export interface ResourceErrorDocument {
 	lid?: string;
 	links?: Links | PaginationLinks;
 	meta?: Meta;
 	errors: ApiError[];
 }
+/**
+* A type useful for representing the raw {json:api} documents that
+* the cache may use.
+*
+* For the Reactive value returned by a request using the store, use {@link ReactiveDocument} instead.
+*/
 export type ResourceDocument<T = PersistedResourceKey> = ResourceMetaDocument | SingleResourceDataDocument<T> | CollectionResourceDataDocument<T> | ResourceErrorDocument;

package/declarations/types/symbols.d.ts

@@ -9,7 +9,7 @@ export declare const RecordStore: "___(unique) Symbol(Store)";
 * record implementations to provide a typescript
 * hint for the type of the resource.
 *
-* When used, EmberData/WarpDrive APIs can
+* When used, WarpDrive APIs can
 * take advantage of this to provide better type
 * safety and intellisense.
 *
@@ -45,7 +45,7 @@ export declare const Type: "___(unique) Symbol($type)";
 * record implementations to provide a typescript
 * hint for the type of the resource.
 *
-* When used, EmberData/WarpDrive APIs can
+* When used, WarpDrive APIs can
 * take advantage of this to provide better type
 * safety and intellisense.
 *

package/declarations/types.d.ts

@@ -7,5 +7,5 @@
 export type { StableRecordIdentifier, ResourceKey } from "./types/identifier.js";
 export type { CacheCapabilitiesManager } from "./store/-types/q/cache-capabilities-manager.js";
 export type { ModelSchema } from "./store/deprecated/-private.js";
-export type { SchemaService } from "./store/-types/q/schema-service.js";
+export type { SchemaService } from "./types/schema/schema-service.js";
 export type { BaseFinderOptions, FindRecordOptions, LegacyResourceQuery, QueryOptions, FindAllOptions } from "./store/-types/q/store.js";

package/dist/build-config.js

@@ -1 +1 @@
-export { setConfig } from '@warp-drive/build-config';
+export { babelPlugin, setConfig } from '@warp-drive/build-config';