@warp-drive/core 5.8.0-alpha.5 → 5.8.0-alpha.6

package/declarations/build-config.d.ts

@@ -1 +1,18 @@
-export { setConfig } from "@warp-drive/build-config";
+/**
+* This module provides a build-plugin that enables configuration of deprecations,
+* optional features, development/testing support and debug logging.
+*
+* Available settings include:
+*
+* - {@link LOGGING | debugging}
+* - {@link DEPRECATIONS | deprecations}
+* - {@link FEATURES | features}
+* - {@link WarpDriveConfig.polyfillUUID | polyfillUUID}
+* - {@link WarpDriveConfig.includeDataAdapterInProduction | includeDataAdapterInProduction}
+* - {@link WarpDriveConfig.compatWith | compatWith}
+*
+* @module
+*/
+import type { WarpDriveConfig } from "@warp-drive/build-config";
+export { setConfig, babelPlugin } from "@warp-drive/build-config";
+export type { WarpDriveConfig };

package/declarations/index.d.ts

@@ -2,13 +2,90 @@
 * @module
 * @mergeModuleWith <project>
 */
+import type { CAUTION_MEGA_DANGER_ZONE_Extension } from "./reactive.js";
 import type { ReactiveDocument } from "./reactive/-private/document.js";
-export { Fetch } from "./request/-private/fetch.js";
-export { RequestManager } from "./request/-private/manager.js";
-export { Store, type StoreRequestContext, CacheHandler, type CachePolicy, type StoreRequestInput, recordIdentifierFor, storeFor } from "./store/-private.js";
+import type { Handler } from "./request.js";
+import { Fetch } from "./request/-private/fetch.js";
+import { RequestManager } from "./request/-private/manager.js";
+import { CacheHandler, type CachePolicy, Store } from "./store/-private.js";
+import type { CacheCapabilitiesManager } from "./types.js";
+import type { Cache } from "./types/cache.js";
+import type { Derivation, HashFn, Transformation } from "./types/schema/concepts.js";
+import type { ObjectSchema, PolarisResourceSchema, Trait } from "./types/schema/fields.js";
+export { Fetch, RequestManager };
+export { Store, CacheHandler, type CachePolicy };
+export { type StoreRequestContext, type StoreRequestInput, recordIdentifierFor, storeFor } from "./store/-private.js";
 /**
 * @deprecated use `ReactiveDocument` instead
 */
 export type Document<T> = ReactiveDocument<T>;
 export type { DocumentCacheOperation, CacheOperation, NotificationType } from "./store/-private/managers/notification-manager.js";
 export { setIdentifierGenerationMethod, setIdentifierUpdateMethod, setIdentifierForgetMethod, setIdentifierResetMethod, setKeyInfoForResource } from "./store/-private/managers/cache-key-manager.js";
+/**
+* Options for setting up a Store instance with `useRecommendedStore`.
+*/
+export interface StoreSetupOptions {
+	/**
+	* The Cache implementation to use
+	*/
+	cache: new (capabilities: CacheCapabilitiesManager) => Cache;
+	/**
+	* The Cache policy to use.
+	*
+	* Defaults to {@link DefaultCachePolicy} configured to
+	* respect `Expires`, `X-WarpDrive-Expires`, and `Cache-Control` headers
+	* with a fallback to 30s soft expiration and 15m hard expiration.
+	*/
+	policy?: CachePolicy;
+	/**
+	* The request handlers to use. {@link Fetch} will automatically
+	* be added to the end of the handler chain and {@link CacheHandler}
+	* will automatically be added as the cache handler.
+	*/
+	handlers?: Handler[];
+	/**
+	* Schemas describing the structure of your resource data.
+	*
+	* See {@link PolarisResourceSchema,} and {@link ObjectSchema} for more information.
+	*/
+	schemas?: Array<PolarisResourceSchema | ObjectSchema>;
+	/**
+	* {@link Trait | Traits} to use with {@link PolarisResourceSchema, | Resource Schemas}
+	*/
+	traits?: Trait[];
+	/**
+	* {@link Derivation | Derivations} to use for derived fields.
+	*/
+	derivations?: Derivation[];
+	/**
+	* {@link Transformation | Transformations} to use for transforming fields.
+	*/
+	transformations?: Transformation[];
+	/**
+	* {@link HashFn | Hash Functions} to use for embedded object identity and polymorphic type calculations
+	*/
+	hashFns?: HashFn[];
+	/**
+	* {@link CAUTION_MEGA_DANGER_ZONE_Extension | Extensions} to use with resources, objects and arrays
+	* to provide custom behaviors and capabilities that are not described by Schema.
+	*
+	* This feature should only be used during a transition period to support migrating towards
+	* schemas from existing Model and ModelFragments implementations.
+	*/
+	CAUTION_MEGA_DANGER_ZONE_extensions?: CAUTION_MEGA_DANGER_ZONE_Extension[];
+}
+/**
+* Creates a configured Store class with recommended defaults
+* for schema handling, reactivity, caching, and request management.
+*
+* ```ts
+* import { useRecommendedStore } from '@warp-drive/core';
+* import { JSONAPICache } from '@warp-drive/json-api';
+*
+* export const Store = useRecommendedStore({
+*   cache: JSONAPICache,
+*   schemas: [],
+* });
+* ```
+*/
+export declare function useRecommendedStore(options: StoreSetupOptions, StoreKlass?: typeof Store): typeof Store;

package/declarations/reactive/-private/schema.d.ts

@@ -153,7 +153,7 @@ export interface ExtensibleField {
 * @param schema
 * @return {PolarisResourceSchema}
 */
-export declare function withDefaults(schema: WithPartial<PolarisResourceSchema, "identity">): ResourceSchema;
+export declare function withDefaults(schema: WithPartial<PolarisResourceSchema, "identity">): PolarisResourceSchema;
 interface FromIdentityDerivation {
 	(record: ReactiveResource, options: {
 		key: "lid";

package/declarations/store/-private/default-cache-policy.d.ts

@@ -75,11 +75,65 @@ export interface CacheControlValue {
 * See also {@link CacheControlValue} and [Response Directives](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Cache-Control#response_directives)
 *
 * @public
-* @param {String} header
-* @return {CacheControlValue}
 */
 export declare function parseCacheControl(header: string): CacheControlValue;
 /**
+* The constraint options for {@link PolicyConfig.constraints}
+*/
+export interface PolicyConfigConstraints {
+	/**
+	* Headers that should be checked for expiration.
+	*
+	*/
+	headers?: {
+		/**
+		* Whether the `Cache-Control` header should be checked for expiration.
+		* If `true`, then the `max-age` and `s-maxage` directives are used alongside
+		* the `Age` and `Date` headers to determine if the expiration time has passed.
+		*
+		* Other directives are ignored.
+		*
+		* 'Cache-Control' will take precedence over 'Expires' if both are present
+		* and both configured to be checked.
+		*
+		*/
+		"Cache-Control"?: boolean;
+		/**
+		* Whether the `Expires` header should be checked for expiration.
+		*
+		* If `true`, then the `Expires` header is used to caclulate the expiration time
+		* and determine if the expiration time has passed.
+		*
+		* 'Cache-Control' will take precedence over 'Expires' if both are present.
+		*
+		*/
+		Expires?: boolean;
+		/**
+		* Whether the `X-WarpDrive-Expires` header should be checked for expiration.
+		*
+		* If `true`, then the `X-WarpDrive-Expires` header is used to caclulate the expiration time
+		* and determine if the expiration time has passed.
+		*
+		* This header will take precedence over 'Cache-Control' and 'Expires' if all three are present.
+		*
+		* The header's value should be a [UTC date string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toUTCString).
+		*
+		*/
+		"X-WarpDrive-Expires"?: boolean;
+	};
+	/**
+	* A function that should be called to determine if the request is expired.
+	*
+	* If present, this function will be called with the request and should return
+	* `true` if the request is expired, `false` if it is not expired, and
+	* `null` if the expiration status is unknown.
+	*
+	* If the function does not return `null`,
+	*
+	*/
+	isExpired?: (request: StructuredDocument<ResourceDocument>) => boolean | null;
+}
+/**
 * The configuration options for the {@link DefaultCachePolicy}
 *
 * ```ts [app/services/store.ts]
@@ -103,10 +157,9 @@ export interface PolicyConfig {
 	*
 	* This is calculated against the `date` header of the response.
 	*
-	* If your API does not provide a `date` header, the `Fetch` handler
-	* provided by `@warp-drive/core` will automatically add
-	* it to responses if it is not present. Responses without a `date`
-	* header will be considered stale immediately.
+	* If your API does not provide a `date` header, the {@link Fetch} handler
+	* will automatically add it to responses if it is not present. Responses
+	* without a `date` header will be considered stale immediately.
 	*
 	*/
 	apiCacheSoftExpires: number;
@@ -118,10 +171,9 @@ export interface PolicyConfig {
 	*
 	* This is calculated against the `date` header of the response.
 	*
-	* If your API does not provide a `date` header, the `Fetch` handler
-	* provided by `@warp-drive/core` will automatically add
-	* it to responses if it is not present. Responses without a `date`
-	* header will be considered hard expired immediately.
+	* If your API does not provide a `date` header, the {@link Fetch} handler
+	* will automatically add it to responses if it is not present. Responses
+	* without a `date` header will be considered hard expired immediately.
 	*
 	*/
 	apiCacheHardExpires: number;
@@ -131,8 +183,8 @@ export interface PolicyConfig {
 	*
 	* This helps reduce flakiness and produce predictably rendered results in test suites.
 	*
-	* Requests that specifically set `cacheOptions.backgroundReload = true` will
-	* still be background reloaded in tests.
+	* Requests that specifically set {@link RequestInfo.cacheOptions.backgroundReload | cacheOptions.backgroundReload }
+	* will still be background reloaded in tests.
 	*
 	* This behavior can be opted out of by setting this value to `true`.
 	*
@@ -141,7 +193,7 @@ export interface PolicyConfig {
 	/**
 	* In addition to the simple time-based expiration strategy, CachePolicy
 	* supports various common server-supplied expiration strategies via
-	* headers, as well as custom expiration strategies via the `isExpired`
+	* headers, as well as custom expiration strategies via the {@link PolicyConfigConstraints.isExpired | isExpired}
 	* function.
 	*
 	* Requests will be validated for expiration against these constraints.
@@ -168,60 +220,9 @@ export interface PolicyConfig {
 	* -  ↳ (if null) Cache-Control header
 	* -  ↳ (if null) Expires header
 	*
+	* See {@link PolicyConfigConstraints} for configuration options.
 	*/
-	constraints?: {
-		/**
-		* Headers that should be checked for expiration.
-		*
-		*/
-		headers?: {
-			/**
-			* Whether the `Cache-Control` header should be checked for expiration.
-			* If `true`, then the `max-age` and `s-maxage` directives are used alongside
-			* the `Age` and `Date` headers to determine if the expiration time has passed.
-			*
-			* Other directives are ignored.
-			*
-			* 'Cache-Control' will take precedence over 'Expires' if both are present
-			* and both configured to be checked.
-			*
-			*/
-			"Cache-Control"?: boolean;
-			/**
-			* Whether the `Expires` header should be checked for expiration.
-			*
-			* If `true`, then the `Expires` header is used to caclulate the expiration time
-			* and determine if the expiration time has passed.
-			*
-			* 'Cache-Control' will take precedence over 'Expires' if both are present.
-			*
-			*/
-			Expires?: boolean;
-			/**
-			* Whether the `X-WarpDrive-Expires` header should be checked for expiration.
-			*
-			* If `true`, then the `X-WarpDrive-Expires` header is used to caclulate the expiration time
-			* and determine if the expiration time has passed.
-			*
-			* This header will take precedence over 'Cache-Control' and 'Expires' if all three are present.
-			*
-			* The header's value should be a [UTC date string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toUTCString).
-			*
-			*/
-			"X-WarpDrive-Expires"?: boolean;
-		};
-		/**
-		* A function that should be called to determine if the request is expired.
-		*
-		* If present, this function will be called with the request and should return
-		* `true` if the request is expired, `false` if it is not expired, and
-		* `null` if the expiration status is unknown.
-		*
-		* If the function does not return `null`,
-		*
-		*/
-		isExpired?: (request: StructuredDocument<ResourceDocument>) => boolean | null;
-	};
+	constraints?: PolicyConfigConstraints;
 }
 /**
 * A basic {@link CachePolicy} that can be added to the Store service.
@@ -257,8 +258,8 @@ export interface PolicyConfig {
 * add the `date` header to responses if it is not present.
 * :::
 *
-* - For manual override of reload see {@link RequestInfo.cacheOptions.reload | cacheOptions.reload}
-* - For manual override of background reload see {@link RequestInfo.cacheOptions.backgroundReload | cacheOptions.backgroundReload}
+* - For manual override of reload see {@link CacheOptions.reload | cacheOptions.reload}
+* - For manual override of background reload see {@link CacheOptions.backgroundReload | cacheOptions.backgroundReload}
 *
 * In order expiration is determined by:
 *
@@ -281,7 +282,7 @@ export interface PolicyConfig {
 * ### Automatic Invalidation / Entanglement
 *
 * It also invalidates any request with an {@link RequestInfo.op | OpCode} of `"query"`
-* for which {@link RequestInfo.cacheOptions.types | cacheOptions.types} was provided
+* for which {@link CacheOptions.types | cacheOptions.types} was provided
 * when a request with an `OpCode` of `"createRecord"` is successful and also includes
 * a matching type in its own `cacheOptions.types` array.
 
@@ -331,7 +332,7 @@ export declare class DefaultCachePolicy implements CachePolicy {
 	* of the store.
 	*
 	* This invalidation is done automatically when using this service
-	* for both the CacheHandler and the LegacyNetworkHandler.
+	* for both the {@link CacheHandler} and the [NetworkHandler](/api/@warp-drive/legacy/compat/variables/LegacyNetworkHandler).
 	*
 	* ```ts
 	* store.lifetimes.invalidateRequestsForType(store, 'person');
@@ -345,7 +346,7 @@ export declare class DefaultCachePolicy implements CachePolicy {
 	* This is invoked by the CacheHandler for both foreground and background requests
 	* once the cache has been updated.
 	*
-	* Note, this is invoked by the CacheHandler regardless of whether
+	* Note, this is invoked by the {@link CacheHandler} regardless of whether
 	* the request has a cache-key.
 	*
 	* This method should not be invoked directly by consumers.
@@ -357,7 +358,7 @@ export declare class DefaultCachePolicy implements CachePolicy {
 	* Invoked to determine if the request may be fulfilled from cache
 	* if possible.
 	*
-	* Note, this is only invoked by the CacheHandler if the request has
+	* Note, this is only invoked by the {@link CacheHandler} if the request has
 	* a cache-key.
 	*
 	* If no cache entry is found or the entry is hard expired,
@@ -372,7 +373,7 @@ export declare class DefaultCachePolicy implements CachePolicy {
 	* Invoked if `isHardExpired` is false to determine if the request
 	* should be update behind the scenes if cache data is already available.
 	*
-	* Note, this is only invoked by the CacheHandler if the request has
+	* Note, this is only invoked by the {@link CacheHandler} if the request has
 	* a cache-key.
 	*
 	* If true, the request will be fulfilled from cache while a backgrounded

package/declarations/store/-private/managers/cache-capabilities-manager.d.ts

@@ -1,6 +1,6 @@
 import type { RequestKey, ResourceKey } from "../../../types/identifier.js";
-import type { CacheCapabilitiesManager as StoreWrapper } from "../../-types/q/cache-capabilities-manager.js";
 import type { SchemaService } from "../../../types/schema/schema-service.js";
+import type { CacheCapabilitiesManager as StoreWrapper } from "../../-types/q/cache-capabilities-manager.js";
 import type { PrivateStore, Store } from "../store-service.js";
 import type { CacheKeyManager } from "./cache-key-manager.js";
 import type { NotificationType } from "./notification-manager.js";

package/declarations/store/-private/new-core-tmp/promise-state.d.ts

@@ -256,6 +256,7 @@ export declare function createPromiseState<
 *
 * If looking to use in a template, consider also the `<Await />` component.
 *
+* See also {@link PromiseState}
 */
 export declare function getPromiseState<
 	T = unknown,

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

@@ -4,11 +4,11 @@ import type { PrivateRequestManager, RequestManager } from "../../request/-priva
 import type { Cache } from "../../types/cache.js";
 import type { PersistedResourceKey, ResourceKey } from "../../types/identifier.js";
 import type { TypedRecordInstance, TypeFromInstance } from "../../types/record.js";
+import type { SchemaService } from "../../types/schema/schema-service.js";
 import type { CollectionResourceDocument, EmptyResourceDocument, JsonApiDocument, ResourceIdentifierObject, SingleResourceDocument } from "../../types/spec/json-api-raw.js";
 import type { Type } from "../../types/symbols.js";
 import type { CacheCapabilitiesManager } from "../-types/q/cache-capabilities-manager.js";
 import type { OpaqueRecordInstance } from "../-types/q/record-instance.js";
-import type { SchemaService } from "../../types/schema/schema-service.js";
 import type { StoreRequestInput } from "./cache-handler/handler.js";
 import type { CachePolicy } from "./cache-handler/types.js";
 import { InstanceCache, storeFor } from "./caches/instance-cache.js";

package/declarations/store/-types/q/cache-capabilities-manager.d.ts

@@ -1,7 +1,7 @@
 import type { RequestKey, ResourceKey } from "../../../types/identifier.js";
+import type { SchemaService } from "../../../types/schema/schema-service.js";
 import type { CacheKeyManager } from "../../-private/managers/cache-key-manager.js";
 import type { NotificationType } from "../../-private/managers/notification-manager.js";
-import type { SchemaService } from "../../../types/schema/schema-service.js";
 /**
 * CacheCapabilitiesManager provides encapsulated API access to the minimal
 * subset of the Store's functionality that Cache implementations

package/declarations/types/request.d.ts

@@ -10,10 +10,11 @@ export declare const IS_FUTURE: "___(unique) Symbol(IS_FUTURE)";
 export declare const STRUCTURED: "___(unique) Symbol(DOC)";
 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 +58,7 @@ export type CacheOptions = {
 	*
 	*/
 	[SkipCache]?: boolean;
-};
+}
 export type FindRecordRequestOptions<
 	RT = unknown,
 	T = unknown

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

@@ -2125,18 +2125,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/dist/build-config.js

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