@warp-drive-mirror/core 5.10.0-alpha.10 → 5.10.0-alpha.13

package/dist/unpkg/dev-deprecated/{src-BlewXGbB.js → src-Isk_Je7q.js}

@@ -1,15 +1,15 @@
 import { getOrSetGlobal, peekTransient, peekUniversalTransient, setTransient, setUniversalTransient } from "./types/-private.js";
-import { A as ARRAY_SIGNAL, C as createInternalMemo, D as notifyInternalSignal, N as waitFor, O as peekInternalSignal, P as willSyncFlushWatchers, S as consumeInternalSignal, T as getOrCreateInternalSignal, _ as entangleSignal, f as createSignalDescriptor, g as entangleInitiallyStaleSignal, h as defineSignal, j as OBJECT_SIGNAL, k as withSignalStore, p as defineGate, w as createInternalSignal, x as Signals } from "./-private-DrQgwtNS.js";
+import { A as ARRAY_SIGNAL, C as createInternalMemo, D as notifyInternalSignal, N as waitFor, O as peekInternalSignal, P as willSyncFlushWatchers, S as consumeInternalSignal, T as getOrCreateInternalSignal, _ as entangleSignal, f as createSignalDescriptor, g as entangleInitiallyStaleSignal, h as defineSignal, j as OBJECT_SIGNAL, k as withSignalStore, p as defineGate, w as createInternalSignal, x as Signals } from "./-private-BH4O810v.js";
 import { EnableHydration, STRUCTURED, SkipCache } from "./types/request.js";
 import { CACHE_OWNER, DEBUG_CLIENT_ORIGINATED, DEBUG_KEY_TYPE, DEBUG_STALE_CACHE_OWNER } from "./types/identifier.js";
-import { a as upgradePromise, c as executeNextHandler, d as getRequestResult, f as setPromiseResult, l as clearRequestResult, m as assertValidRequest, o as DOMError, p as cloneResponseProperties, s as IS_CACHE_HANDLER, t as withBrand } from "./request-nAaeDlS9.js";
+import { a as upgradePromise, c as executeNextHandler, d as getRequestResult, f as setPromiseResult, l as clearRequestResult, m as assertValidRequest, o as DOMError, p as cloneResponseProperties, s as IS_CACHE_HANDLER, t as withBrand } from "./request-Fe-vpe-u.js";
 import { getRuntimeConfig, setIsMaybeMirage, setLogging } from "./types/runtime.js";
-import { a as SOURCE, i as Destroy, n as Commit, r as Context, t as Checkout } from "./-private-Dtj8O5W7.js";
+import { a as SOURCE, i as Destroy, n as Commit, r as Context, t as Checkout } from "./-private-CmNOwhK0.js";
 import { dasherize } from "./utils/string.js";
 import { t as getGlobalConfig } from "./runtime-e4oZ_UWz.js";
 import { RecordStore, Type } from "./types/symbols.js";
 import { isResourceSchema } from "./types/schema/fields.js";
-import { t as DefaultCachePolicy } from "./store-X1WN7P_O.js";
+import { t as DefaultCachePolicy } from "./store-CCZBSe0p.js";
 import * as _importSync20 from "@ember/object";
 
 //#region src/reactive/-private/document.ts
@@ -22,10 +22,15 @@ function urlFromLink(link) {
 * returned by `Cache.put` or `Cache.peek`, converting ResourceKeys into
 * ReactiveResource instances.
 *
+* The [Using The Response](/guides/the-manual/requests/using-the-response) guide
+* shows when a request's content is a ReactiveDocument.
+*
 * It is not directly instantiated by the user, and its properties should not
 * be directly modified. Whether individual properties are mutable or not is
 * determined by the record instance itself.
 *
+* @summary The reactive wrapper around a request's response document that exposes its data or errors
+* as live records, plus meta, links, and pagination helpers.
 * @public
 */
 const ReactiveDocumentProto = {
@@ -600,6 +605,8 @@ implement this hook.
 
 ⚠️ Caution: Requests that do not have a `method` assigned are assumed to be `GET`
 
+@summary Overrides how the store generates `lid` cache keys for resources and documents; must be set
+before the store is created.
 @public
 */
 function setIdentifierGenerationMethod(method) {
@@ -634,6 +641,8 @@ prior to this `UpdateMethod` being called; however, calls to the parent method
 `updateRecordIdentifier` that attempt to change the `id` or calling update
 without providing an `id` when one is missing will throw an error.
 
+@summary Registers a callback run when an existing resource key receives new data, for updating your
+own secondary lookup tables.
 @public
 */
 function setIdentifierUpdateMethod(method) {
@@ -651,6 +660,8 @@ import { setIdentifierForgetMethod } from '@warp-drive-mirror/core';
 Takes method which can expect to receive an existing `Identifier` that should be eliminated
 from any secondary lookup tables or caches that the user has populated for it.
 
+@summary Registers a callback run when the store releases a resource key, for cleaning up your own
+lookup tables.
 @public
 */
 function setIdentifierForgetMethod(method) {
@@ -670,6 +681,8 @@ Takes a method which can expect to be called when the parent application is dest
 If you have properly used a WeakMap to encapsulate the state of your customization
 to the application instance, you may not need to implement the `resetMethod`.
 
+@summary Registers a callback run when the store's key cache is torn down, for resetting any custom
+key-generation state.
 @public
 */
 function setIdentifierResetMethod(method) {
@@ -688,6 +701,8 @@ This configuration MUST occur prior to the store instance being created.
 import { setKeyInfoForResource } from '@warp-drive-mirror/core';
 ```
 
+@summary Overrides how the store derives the `type` and `id` of a new `ResourceKey` from resource data;
+must be set before the store is created.
 @public
 */
 function setKeyInfoForResource(method) {
@@ -1267,6 +1282,7 @@ const identifier = recordIdentifierFor(record);
 const { id, type, lid } = identifier;
 ```
 
+@summary Returns the stable `ResourceKey` (type, id, and lid) the store assigned to a record instance.
 @public
 @param record a record instance previously obstained from the store.
 */
@@ -1924,9 +1940,15 @@ var CacheManager = class {
 //#region src/store/-private/managers/notification-manager.ts
 /**
 * The kinds of change notifications the {@link NotificationManager} can emit for a resource.
+*
+* @summary The lifecycle notification kinds sent to resource subscribers: `added`, `removed`, `updated`,
+* or `state`.
 */
 /**
 * The kinds of change notifications the {@link NotificationManager} can emit for a request document.
+*
+* @summary The notification kinds sent to request document subscribers, such as `updated` or
+* `invalidated`.
 */
 function isCacheOperationValue(value) {
 	return value === "added" || value === "state" || value === "updated" || value === "removed" || value === "invalidated";
@@ -1934,6 +1956,9 @@ function isCacheOperationValue(value) {
 /**
 * The full set of notification kinds the {@link NotificationManager} can emit for a resource,
 * including both {@link CacheOperation}s and finer-grained field-level change notifications.
+*
+* @summary Every notification kind a resource subscriber can receive, from lifecycle operations to
+* `attributes`, `relationships`, `errors`, `meta`, and `identity` changes.
 */
 /**
 * The shape accepted by {@link NotificationManager.notify} and
@@ -1941,6 +1966,8 @@ function isCacheOperationValue(value) {
 * the `'attributes'` or `'relationships'` namespaces in a single call
 * instead of once per key.
 *
+* @summary A set of field names passed to `notify` or `notifyChange` to report many `attributes` or
+* `relationships` changes in one call.
 * @since 5.9.0
 * @public
 */
@@ -1975,6 +2002,8 @@ function isCacheOperationValue(value) {
 * `DocumentCacheOperation` values) are never filtered by channel since they
 * have no local/remote duality.
 *
+* @summary Scopes an `attributes` or `relationships` notification to a resource's local (editable) or
+* remote (persisted) view so only matching subscribers hear it.
 * @public
 */
 /**
@@ -2111,6 +2140,8 @@ function _unsubscribe(token, cache) {
 * This Feature is what allows WarpDrive to create subscriptions that
 * work with any framework or change-notification system.
 *
+* @summary The store service that lets code subscribe to and batch-deliver change notifications for
+* cached resources and request documents.
 * @hideconstructor
 * @public
 */
@@ -2533,10 +2564,15 @@ const MUTABLE_PROPS = [
 * as the base for relationship and legacy record-array types such as
 * {@link LegacyLiveArray}, {@link LegacyQueryArray} and {@link LegacyManyArray}.
 *
+* The [Key Terminology](/guides/the-manual/caching/key-terms#resources) guide explains
+* how it relates to resources.
+*
 * Behaves like a native Array: `Array.isArray(arr)` and `arr instanceof Array`
 * both report `true`. The array stays in sync with the cache, updating
 * reactively as the underlying {@link ResourceKey}s change.
 *
+* @summary Native-Array-compatible reactive list of records backed by cache keys, returned for collection responses
+* and underlying relationship and legacy record arrays.
 * @public
 */
 /**
@@ -2857,6 +2893,8 @@ function createRequestCollection(config) {
 * and "bmw" will have populated LiveArrays, but the LiveArray for "car"
 * would be empty.
 *
+* @summary Legacy reactive array of every record of one type in the store, returned by `store.peekAll` and
+* `store.findAll`.
 * @legacy we recommend againt using LiveArrays. Use {@link Store.request} instead
 */
 /**
@@ -2972,6 +3010,8 @@ function _updateLiveArray() {
 * from the cache, but it does remove the array as well as the overhead it requires
 * from the store for book-keeping.
 *
+* @summary Legacy immutable reactive array of the primary records returned by `store.query`, refreshable with
+* `update()` and released with `destroy()`.
 * @legacy we recommend againt using QueryArrays. Use {@link Store.request} instead
 */
 /**
@@ -3788,6 +3828,10 @@ const app = new EmberApp(defaults, {
 * The `Store` is the central piece of the ***Warp*Drive** experience. It connects
 * requests for data with schemas, caching and reactivity.
 *
+* The [Setup](/guides/configuration/#configure-the-store) guide shows how to configure
+* one, and [Making Requests](/guides/the-manual/requests/) shows how to request data
+* through it.
+*
 * While it's easy to use ***just*** ***Warp*Drive**'s request management, most projects will find they
 * require far more than basic fetch management. For this reason it's often best to start with a `Store`
 * even when you aren't sure yet.
@@ -3795,6 +3839,7 @@ const app = new EmberApp(defaults, {
 * Most projects will only have a single `Store`, though using multiple distinct stores
 * is possible.
 *
+* @summary Central coordinator that connects requests for data with schemas, the cache and reactivity.
 * @public
 * @hideconstructor
 */
@@ -4002,12 +4047,25 @@ var Store = class extends BaseClass {
 		}
 	}
 	/**
-	* ::: tip 💡 For a more complete overview see the [Request Guide](/guides/2-requests/1-overview)
+	* ::: tip 💡 For a more complete overview see the [Request Guide](/guides/the-manual/requests/)
 	* :::
 	*
 	* Issue a request via the configured {@link RequestManager},
 	* inserting the response into the {@link Store.cache | cache} and handing
-	* back a {@link Future} which resolves to a {@link ReactiveDocument | ReactiveDocument}
+	* back a {@link Future} which resolves to a {@link ReactiveDocument | ReactiveDocument}.
+	* Use `store.request` for anything the Store's cache should own, which is nearly all app
+	* code; reach for {@link RequestManager.request | requestManager.request} directly only when
+	* there is no `Store` involved, or you specifically want the unprocessed
+	* {@link StructuredDocument}.
+	*
+	* #### Building Requests
+	*
+	* `requestConfig` can be written by hand, but for anything reused more than once prefer a
+	* request builder — a plain function that returns the right shape for `store.request`. This
+	* repo ships builders for common operations (`findRecord`, `query`, `createRecord`, and more)
+	* for {json:api}, REST, and ActiveRecord-style APIs in `@warp-drive-mirror/utilities`; each builder's
+	* return value also carries its own response type, so `RT` below is inferred automatically
+	* instead of being written by hand. See [Builders](/guides/the-manual/requests/builders.md).
 	*
 	* #### Request Cache Keys
 	*
@@ -4052,6 +4110,29 @@ var Store = class extends BaseClass {
 	* is that `store.request` will convert the response into a {@link ReactiveDocument}
 	* containing {@link Store.instantiateRecord | ReactiveResources}.
 	*
+	* A {@link ReactiveDocument} is either a {@link ReactiveDataDocument} (`content.data` holds
+	* the resource(s)) or a {@link ReactiveErrorDocument} (`content.errors` holds the API's error
+	* objects), depending on whether the `Future` resolves or rejects; both carry the response's
+	* `content.meta`. Read either state reactively with {@link getRequestState} or the
+	* `<Request />` component instead of always `await`-ing the `Future` directly — see
+	* [Using the Response](/guides/the-manual/requests/using-the-response.md).
+	*
+	* #### Typing The Response
+	*
+	* `request<RT>` accepts an explicit type argument, but the more common path is to let it be
+	* inferred: build the request with {@link withResponseType} (or {@link withReactiveResponse}
+	* for the common reactive-document case), or with a builder from `@warp-drive-mirror/utilities` as
+	* described above, and `RT` is inferred from the request object itself. See
+	* [Typing Requests](/guides/the-manual/requests/typing-requests.md) for the full mechanism.
+	*
+	* @example
+	* ```ts
+	* import { findRecord } from '@warp-drive-mirror/utilities/json-api';
+	*
+	* const { content } = await store.request(findRecord('user', '1'));
+	* content.data; // ReactiveResource, typed from the builder's response type
+	* ```
+	*
 	* @public
 	*/
 	request(requestConfig) {
@@ -4653,6 +4734,8 @@ function _convertPreloadRelationshipToJSON(value, type) {
 * for @warp-drive-mirror/legacy/model or when wrapping schema for legacy
 * Adapters/Serializers.
 *
+* @summary Legacy shape of a Model class's static schema API (fields, attributes, relationships, iterators) used
+* by the legacy schema service and Adapters/Serializers.
 */
 function _resourceIsFullDeleted(identifier, cache) {
 	return cache.isDeletionCommitted(identifier) || cache.isNew(identifier) && cache.isDeleted(identifier);
@@ -5108,10 +5191,16 @@ function getPriority(identifier, deduped, priority) {
 /**
 * The request shape accepted by {@link Store.request}, either a fully-formed
 * {@link ImmutableRequestInfo} or the looser {@link LooseStoreRequestInfo}.
+*
+* @summary The request object `store.request` accepts, either a full immutable request info or a looser
+* form with plain `records` and `headers`.
 */
 /**
 * A CacheHandler that adds support for using an WarpDrive Cache with a RequestManager.
 *
+* The [Caching](/guides/the-manual/caching/) guide explains how it decides whether a
+* request can use the cache.
+*
 * This handler will only run when a request has supplied a `store` instance. Requests
 * issued by the store via `store.request()` will automatically have the `store` instance
 * attached to the request.
@@ -5147,7 +5236,10 @@ function getPriority(identifier, deduped, priority) {
 *   method: 'GET',
 *   [EnableHydration]: true
 * });
+* ```
 *
+* @summary The RequestManager cache handler that serves, dedupes, and caches store requests and returns
+* reactive documents when hydration is enabled.
 */
 const CacheHandler = { request(context, next) {
 	if (!context.request.store || context.request.cacheOptions?.[SkipCache]) return next(context.request);
@@ -5441,6 +5533,7 @@ the has-many.
 We call the record to which a relationship belongs-to the
 relationship's _owner_.
 
+@summary Legacy mutable reactive array holding the related records of a legacy or linksMode has-many relationship.
 @public
 */
 /**
@@ -6764,10 +6857,14 @@ const Editables = /* @__PURE__ */ new Map();
 * and a ResourceKey to transform data from the cache into a rich, reactive
 * object.
 *
+* The [ResourceSchemas](/guides/the-manual/schemas/resources/) guide shows how to
+* define the schema it reads.
+*
 * This class is not directly instantiable. To use it, you should
 * configure the store's `instantiateRecord` and `teardownRecord` hooks
 * with the matching hooks provided by this package.
 *
+* @summary The rich, reactive record object that presents a resource's cached data through its `ResourceSchema`.
 * @hideconstructor
 * @public
 */
@@ -7221,6 +7318,8 @@ function assertNeverField(identifier, field, path) {
 * Edits to editable resources will be automatically committed if a new
 * payload from the cache matches their existing value.
 *
+* @summary Resolves with an editable copy of an immutable `ReactiveResource` so its fields can be
+* changed locally.
 * @public
 *
 * @returns a promise that resolves to the editable resource
@@ -7237,6 +7336,8 @@ function checkout(resource) {
 * approach is for either the API or a Handler to reflect saved
 * changes back to update the cache.
 *
+* @summary Forcibly makes an editable resource's local changes its new remote (immutable) state,
+* bypassing a save round-trip.
 * @public
 */
 function commit(record) {
@@ -7254,6 +7355,8 @@ function commit(record) {
 * schema is `legacy`, matching the historical behavior of assigning initial
 * properties when creating a new legacy record.
 *
+* @summary Default store `instantiateRecord` hook that creates a `ReactiveResource` for a resource key
+* from its registered schema.
 * @public
 */
 function instantiateRecord(store, identifier, createArgs) {
@@ -7286,6 +7389,8 @@ function assertReactiveResource(record) {
 * that `record` is a {@link ReactiveResource} and invokes its `Destroy`
 * behavior.
 *
+* @summary Default store `teardownRecord` hook that destroys a `ReactiveResource` when the store
+* releases it.
 * @public
 */
 function teardownRecord(record) {
@@ -7340,16 +7445,25 @@ _constructor[Type] = "@constructor";
 * This should only be used for temporary migration purposes
 * to the new schema system when migrating from either Model
 * or ModelFragments.
+*
+* @summary Registers named methods, getters, and values to add to ReactiveResources, ReactiveObjects,
+* or ReactiveArrays; meant only as a temporary aid when migrating from Model or ModelFragments.
 */
 /**
 * Describes one feature added to a resource by a schema extension, as
 * classified by {@link processExtension} from the property descriptor it
 * was declared with (a method, a plain value, or a getter/setter pair).
+*
+* @summary One normalized feature of a schema extension, tagged by kind as a method, a readonly or
+* mutable value, or a getter/setter accessor.
 */
 /**
 * The result of {@link processExtension} normalizing a
 * {@link CAUTION_MEGA_DANGER_ZONE_Extension} into a lookup of its features
 * by name.
+*
+* @summary A registered schema extension normalized into its kind, name, and a map of its features
+* keyed by property name.
 */
 const BannedKeys = ["constructor", "__proto__"];
 function processExtension(extension) {
@@ -7449,14 +7563,19 @@ function processExtensions(schema, field, scenario, resolvedType) {
 * Utility for constructing a ResourceSchema with the recommended
 * fields for the PolarisMode experience.
 *
+* The [ResourceSchemas](/guides/the-manual/schemas/resources/) guide shows how to
+* create a schema with it.
+*
 * Using this requires registering the PolarisMode derivations
 *
 * ```ts
-* import { registerDerivations } from '@warp-drive-mirror/schema-record';
+* import { registerDerivations } from '@warp-drive-mirror/core/reactive';
 *
 * registerDerivations(schema);
 * ```
 *
+* @summary Adds the default `id` identity plus `$key`, `$type`, and `constructor` derived fields to a
+* PolarisMode resource schema.
 * @public
 * @param schema
 * @return {PolarisResourceSchema}
@@ -7487,6 +7606,8 @@ function withDefaults(schema) {
 *
 * `^` returns the entire identifier object.
 *
+* @summary The `@identity` derivation, which reads a record's `id`, `lid`, `type`, or whole resource key
+* for use in derived fields.
 * @public
 */
 const fromIdentity = (record, options, key) => {
@@ -7510,9 +7631,14 @@ fromIdentity[Type] = "@identity";
 * to use the PolarisMode defaults provided by
 *
 * ```ts
-* import { withDefaults } from '@warp-drive-mirror/schema-record';
+* import { withDefaults } from '@warp-drive-mirror/core/reactive';
 * ```
 *
+* The [Derivations](/guides/the-manual/schemas/derivations#about-built-in-derivations)
+* guide explains when you need to call it.
+*
+* @summary Registers the `@identity` and `@constructor` derivations that schemas built with
+* `withDefaults` depend on.
 * @public
 */
 function registerDerivations(schema) {
@@ -7588,6 +7714,9 @@ function assertConsistentAbstractFieldShape(abstractType, fieldName, existing, i
 * Defines how to convert a `GenericField`, `ObjectField`, or `ArrayField`
 * between the raw value `T` stored in the cache and the presentation value
 * `PT` exposed on the record.
+*
+* @summary A registered converter between a field's raw cache value and the value exposed on the
+* record, with optional default.
 */
 /**
 * Wraps a derivation in a new function with Derivation signature but that looks
@@ -7610,6 +7739,12 @@ function makeCachedDerivation(derivation) {
 /**
 * A SchemaService designed to work with dynamically registered schemas.
 *
+* The [Schemas](/guides/the-manual/schemas/) guide shows how to register schemas
+* with it, and [Advanced Store Configuration](/guides/configuration/advanced#add-a-source-for-schema-for-your-data)
+* shows how to give a store one.
+*
+* @summary The default schema service, which stores resource and object schemas, traits, derivations,
+* transformations, hash functions and extensions registered at runtime.
 * @public
 */
 var SchemaService = class {
@@ -8288,6 +8423,8 @@ function mergeMap(base, toApply) {
 * - {@link LegacyModeFieldSchema}
 * - {@link PolarisModeFieldSchema}
 *
+* @summary Schema-driven reactive records, arrays, and documents the store builds from cached data, plus the
+* `SchemaService` and schema types that define them.
 * @module
 */
 
@@ -8370,6 +8507,9 @@ const ERROR_STATUS_CODE_FOR = /* @__PURE__ */ new Map([
 * A basic Fetch Handler which converts a request into a
 * `fetch` call presuming the response to be `json`.
 *
+* The [Making Requests](/guides/the-manual/requests/#requests-do-not-need-to-use-fetch)
+* guide shows where it sits in the handler chain.
+*
 * ```ts
 * import { RequestManager, Fetch } from '@warp-drive-mirror/core';
 *
@@ -8377,6 +8517,8 @@ const ERROR_STATUS_CODE_FOR = /* @__PURE__ */ new Map([
 *   .use([Fetch]);
 * ```
 *
+* @summary Terminal request handler that sends the request with native `fetch` and resolves with the
+* parsed JSON body, turning HTTP failures into errors.
 * @public
 * @badge Handler
 */
@@ -8506,7 +8648,8 @@ function isDict(v) {
 * import { RequestManager } from '@warp-drive-mirror/core';
 * ```
 *
-* For complete usage guide see the [RequestManager Documentation](/guides/).
+* For a complete usage guide see [Making Requests](/guides/the-manual/requests/), and
+* [Handlers](/guides/the-manual/requests/handlers) for writing the handlers it runs.
 *
 * ## How It Works
 *
@@ -8529,11 +8672,28 @@ function isDict(v) {
 * ```ts [Setup.ts]
 * import { RequestManager, Fetch } from '@warp-drive-mirror/core';
 * import { AutoCompress } from '@warp-drive-mirror/utilities/handlers';
-* import Auth from 'ember-simple-auth/handler';
+* import { AuthHandler } from './auth-handler';
 *
 * // ... create manager
 * const manager = new RequestManager()
-*    .use([Auth, new AutoCompress(), Fetch]); // [!code focus]
+*    .use([AuthHandler, new AutoCompress(), Fetch]); // [!code focus]
+* ```
+*
+* ```ts [auth-handler.ts]
+* import type { Handler, NextFn } from '@warp-drive-mirror/core/request';
+* import type { RequestContext } from '@warp-drive-mirror/core/types/request';
+*
+* const token = '<token>';
+*
+* // adds a bearer token to every request, then passes it along
+* export const AuthHandler: Handler = {
+*   request<T>(context: RequestContext, next: NextFn<T>) {
+*     const headers = new Headers(context.request.headers);
+*     headers.append('Authorization', `Bearer ${token}`);
+*
+*     return next(Object.assign({}, context.request, { headers }));
+*   },
+* };
 * ```
 *
 * ```ts [Usage.ts]
@@ -8549,6 +8709,20 @@ function isDict(v) {
 *
 * :::
 *
+* ### RequestManager vs {@link Store.request}
+*
+* A bare `RequestManager` is the low-level primitive: it runs a request through the configured
+* {@link Handler | handler chain} and settles with the raw {@link StructuredDocument}. It has no
+* cache and does not hydrate {@link ReactiveDocument | ReactiveDocuments} unless you register a
+* cache handler yourself via {@link RequestManager.useCache} and the request opts in.
+*
+* {@link Store.request} issues requests through this same `RequestManager`, but with the Store's
+* cache handler and hydration already wired up — inserting the response into the Store's cache
+* and resolving with a `ReactiveDocument` instead. Use `store.request` for anything the Store's
+* cache should own, which is nearly all app code. Reach for `requestManager.request` directly
+* only when there is no {@link Store} involved, or you specifically want the unprocessed
+* `StructuredDocument`.
+*
 * ### Futures
 *
 * The return value of `manager.request` is a `Future`, which allows
@@ -8587,6 +8761,7 @@ function isDict(v) {
 * type StructuredDocument<T> = StructuredDataDocument<T> | StructuredErrorDocument;
 * ```
 *
+* @summary Runs each request through a chain of handlers that can fulfill, modify, or pass it along, and returns a `Future` for the response.
 * @public
 */
 var RequestManager = class {
@@ -8646,7 +8821,23 @@ var RequestManager = class {
 	/**
 	* Issue a Request.
 	*
-	* Returns a Future that fulfills with a StructuredDocument
+	* Runs `request` through the configured {@link Handler | handler chain} and settles with the
+	* {@link StructuredDocument} the chain produces — a plain `{ request, response, content }`
+	* object, not a {@link ReactiveDocument}. Caching and hydration only happen if a cache handler
+	* has been registered via {@link RequestManager.useCache} and the request opts in; a
+	* `RequestManager` created on its own has neither.
+	*
+	* Most app code should use {@link Store.request} instead, which calls this same method with
+	* the Store's cache handler and hydration already configured. Reach for `requestManager.request`
+	* directly when there is no {@link Store} involved, or when you want the unprocessed
+	* `StructuredDocument`. The `<RT>` generic can be set explicitly or inferred from a request
+	* built with {@link withResponseType} or {@link withReactiveResponse} — see
+	* [Typing Requests](/guides/the-manual/requests/typing-requests.md).
+	*
+	* @example
+	* ```ts
+	* const { content } = await requestManager.request({ url: '/users' });
+	* ```
 	*
 	* @public
 	*/
@@ -8730,6 +8921,8 @@ var RequestManager = class {
 //#endregion
 //#region src/index.ts
 /**
+* @summary Main entry point for WarpDrive: the `Store`, `RequestManager`, `Fetch` handler, `CacheHandler`, and
+* `useRecommendedStore` for building a configured store.
 * @module
 * @mergeModuleWith <project>
 */
@@ -8738,11 +8931,17 @@ globalThis.getWarpDriveRuntimeConfig = getRuntimeConfig;
 globalThis.setWarpDriveIsMaybeMirage = setIsMaybeMirage;
 /**
 * Options for setting up a Store instance with `useRecommendedStore`.
+*
+* @summary Configures the cache, cache policy, request handlers, schemas, and schema extensions that
+* `useRecommendedStore` wires into a Store class.
 */
 /**
 * Creates a configured Store class with recommended defaults
 * for schema handling, reactivity, caching, and request management.
 *
+* The [Setup](/guides/configuration/#configure-the-store) guide walks through
+* configuring the store with it.
+*
 * ```ts
 * import { useRecommendedStore } from '@warp-drive-mirror/core';
 * import { JSONAPICache } from '@warp-drive-mirror/json-api';
@@ -8845,6 +9044,9 @@ globalThis.setWarpDriveIsMaybeMirage = setIsMaybeMirage;
 * {@link RequestManager} won't have it set unless the caller supplies it
 * explicitly, so a handler relying on it should treat it as optional (as
 * `LoggingHandler` does above).
+*
+* @summary Builds a Store subclass preconfigured with the given cache, schemas, and handlers, plus
+* `Fetch`, `CacheHandler`, and a default cache policy.
 */
 function useRecommendedStore(options, StoreKlass = Store) {
 	return class AppStore extends StoreKlass {
@@ -8900,4 +9102,4 @@ function useRecommendedStore(options, StoreKlass = Store) {
 
 //#endregion
 export { setIdentifierGenerationMethod as A, setRecordIdentifier as C, isRequestKey as D, fieldValueIdentity as E, coerceId as F, ensureStringId as I, log as L, setIdentifierUpdateMethod as M, setKeyInfoForResource as N, isResourceKey as O, normalizeModelName as P, logGroup as R, recordIdentifierFor as S, assertPrivateCapabilities as T, isPrivateStore as _, fromIdentity as a, StoreMap as b, instantiateRecord as c, commit as d, createLegacyManyArray as f, assertPrivateStore as g, Store as h, SchemaService as i, setIdentifierResetMethod as j, setIdentifierForgetMethod as k, teardownRecord as l, CacheHandler as m, RequestManager as n, registerDerivations as o, constructResource as p, Fetch as r, withDefaults as s, useRecommendedStore as t, checkout as u, RecordArrayManager as v, storeFor as w, _clearCaches as x, fastPush as y };
-//# sourceMappingURL=src-BlewXGbB.js.map
+//# sourceMappingURL=src-Isk_Je7q.js.map