@warp-drive/core 5.6.0-alpha.14 → 5.6.0-alpha.17

package/dist/{configure-BgaZESRo.js → configure-B48bFHOl.js}

@@ -43,20 +43,56 @@ const OBJECT_SIGNAL = getOrSetGlobal('#{}', Symbol('#{}'));
  */
 
 /**
- * The hooks which MUST be configured in order to use this library,
- * either for framework specfic signals or TC39 signals.
+ * The hooks which MUST be configured in order to use reactive arrays,
+ * resources and documents with framework specfic signals or TC39 signals.
  *
  * Support for multiple frameworks simultaneously can be done via
  * this abstraction by returning multiple signals from the `createSignal`
  * method, and consuming the correct one via the correct framework via
  * the `consumeSignal` and `notifySignal` methods.
  *
+ * Unlike many signals implementations, WarpDrive does not wrap values as
+ * signals directly, but instead uses signals to alert the reactive layer
+ * to changes in the underlying cache. E.g. a signal is associated to a value,
+ * but does not serve as the cache for that value directly. We refer to this as
+ * a "gate", the pattern has also been called "side-signals".
+ *
+ * A no-op implementation is allowed, though it may lead to performance issues
+ * in locations that use createMemo as no memoization would be done. This is
+ * typically desirable only when integrating with a framework that does its own
+ * memoization and does not integrate with any signals-like primitive. For these
+ * scenarios you may also be interested in integrating with the {@link NotificationManager}
+ * more directly.
+ *
+ * @public
+ */
+
+/**
+ * Contains information a {@link SignalHooks} implementation may want
+ * to use, such as the specialized key used for the signal
+ * representing an array's contents / length.
+ *
+ * ```ts
+ * interface HooksOptions {
+ *   wellknown: {
+ *     Array: symbol | string;
+ *   }
+ * }
+ * ```
+ *
+ * @public
  */
 
 /**
  * Configures the signals implementation to use. Supports multiple
  * implementations simultaneously.
  *
+ * See {@link HooksOptions} for the options passed to the provided function
+ * when called.
+ *
+ * See {@link SignalHooks} for the implementation the callback function should
+ * return.
+ *
  * @public
  * @param buildConfig - a function that takes options and returns a configuration object
  */

package/dist/configure.js

@@ -1 +1 @@
-export { s as setupSignals } from "./configure-BgaZESRo.js";
+export { s as setupSignals } from "./configure-B48bFHOl.js";

package/dist/graph/-private.js

@@ -1,9 +1,9 @@
 import { deprecate, warn } from '@ember/debug';
-import { p as peekCache } from "../request-state-DgwTEXLU.js";
+import { p as peekCache } from "../request-state-CjLph1LP.js";
 import '../types/request.js';
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 import '../utils/string.js';
-import "../configure-BgaZESRo.js";
+import "../configure-B48bFHOl.js";
 import { getOrSetGlobal, peekTransient, setTransient } from '../types/-private.js';
 function coerceId(id) {
   if (macroCondition(getGlobalConfig().WarpDrive.deprecations.DEPRECATE_NON_STRICT_ID)) {

package/dist/{handler-cHghx9Y9.js → handler-C2T-IyJK.js}

@@ -1,4 +1,4 @@
-import { G as ReactiveDocument } from "./request-state-DgwTEXLU.js";
+import { J as ReactiveDocument } from "./request-state-CjLph1LP.js";
 import { SkipCache, EnableHydration } from './types/request.js';
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 const MUTATION_OPS = new Set(['createRecord', 'updateRecord', 'deleteRecord']);

package/dist/index.js

@@ -1,10 +1,10 @@
 import { setLogging, getRuntimeConfig } from './types/runtime.js';
 import { a as cloneResponseProperties, I as IS_CACHE_HANDLER, b as assertValidRequest, e as executeNextHandler, d as getRequestResult, u as upgradePromise, s as setPromiseResult, f as clearRequestResult } from "./context-COmAnXUQ.js";
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
-import { w as waitFor } from "./configure-BgaZESRo.js";
+import { w as waitFor } from "./configure-B48bFHOl.js";
 import { peekUniversalTransient, setUniversalTransient } from './types/-private.js';
-export { S as Store, r as recordIdentifierFor, K as setIdentifierForgetMethod, H as setIdentifierGenerationMethod, L as setIdentifierResetMethod, J as setIdentifierUpdateMethod, N as setKeyInfoForResource, s as storeFor } from "./request-state-DgwTEXLU.js";
-export { C as CacheHandler } from "./handler-cHghx9Y9.js";
+export { S as Store, r as recordIdentifierFor, N as setIdentifierForgetMethod, K as setIdentifierGenerationMethod, O as setIdentifierResetMethod, L as setIdentifierUpdateMethod, P as setKeyInfoForResource, s as storeFor } from "./request-state-CjLph1LP.js";
+export { C as CacheHandler } from "./handler-C2T-IyJK.js";
 import '@ember/debug';
 import './utils/string.js';
 

package/dist/reactive/-private.js

@@ -1 +1 @@
-export { E as Editable, L as Legacy } from "../symbols-BmDcn6hS.js";
+export { E as Editable, L as Legacy } from "../symbols-SIstXMLI.js";