@ai-matrx/summon 0.1.8 → 0.1.10

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.1.10
+
+UNVERIFIED: this release has no Unreleased entry and the source comparison could not be made (the caller supplied no source comparison). Whether source changed is unknown; consumer action is unknown.
+Check the package's gitHead on npm against this version's gitHead: `git diff <previous gitHead> <this gitHead> -- apps/shared/summon/src`.
+
+## 0.1.9
+
+SOURCE CHANGED WITH NO RELEASE NOTE. This release shipped source changes that nobody described in an Unreleased entry,
+so they may include breaking API changes. Consumer action is UNKNOWN: read the diff before upgrading.
+Diff: `git diff b3962adfda 33bf3a23be -- apps/shared/summon/src`
+
+Changed shipped source files (3):
+- `apps/shared/summon/src/core/augment.ts`
+- `apps/shared/summon/src/core/types.ts`
+- `apps/shared/summon/src/index.ts`
+
 ## 0.1.8
 ### Unreleased
 

package/README.md

@@ -201,6 +201,30 @@ Pass the same `ports` object to both. The overlays slice keys are fixed. Without
 
 Provider knobs: `fallbacks` (`loading`, `error` components), `errorReportExtras` (extra controls in the error card), `renderWrapper` (wrap every rendered overlay), `keepAliveLimit` (8), `importTimeoutMs` (12 s; a render module that has not loaded becomes a `ChunkLoadError` with Try again), `stallWarnMs` (10 s).
 
+### Pay only when something opens: the gate
+
+A large app keeps summon out of every route's first load: the store carries no summon slice or
+middleware, and the root mounts only `<SummonRoot>`.
+
+```tsx
+import { configureStore } from "@reduxjs/toolkit";
+import { createSummonGate } from "@ai-matrx/summon/open";
+import { SummonRoot } from "@ai-matrx/summon/root";
+
+const gate = createSummonGate({ ports });
+const root = createInjectableRootReducer(); // your combineReducers wrapper with an inject(reducers)
+gate.attachReducer((reducers) => root.inject(reducers));
+export const store = configureStore({ reducer: root, middleware: (g) => g().concat(gate.middleware) });
+
+<SummonRoot store={store} ports={ports} runtime={() => import("./WindowRuntime")}>{app}</SummonRoot>;
+```
+
+Openers and selectors come from `./open`, `defineOverlay` from `./root`. The first summon action is
+queued and starts one `import()` of the core, which injects the slices, adds the middleware and
+replays the queue; a module that imports the core statically (a page's `WindowPanel`) installs it
+before it renders. `runtime` (tray sync, router port) mounts once the core is installed.
+`prefetchSummonRuntime()` starts the load early (idle, pointer intent).
+
 ## Ports
 
 Every port has a working default, so a bare host needs none. Override only what you have; pass them as `ports` on the provider (a partial object).

package/dist/{gate-DUvE-Cc1.d.cts → gate-CfjdNWP6.d.cts}

@@ -1,3 +1,4 @@
+import { OverlayHostTypes, OverlayRegistry } from '@ai-matrx/summon';
 import { Reducer, Middleware } from '@reduxjs/toolkit';
 
 /**
@@ -18,8 +19,7 @@ import { Reducer, Middleware } from '@reduxjs/toolkit';
  * `defineOverlay` emits nothing at runtime for this; the augmentation is the host's one-line
  * declaration per overlay (the converter writes it next to each definition).
  */
-interface OverlayRegistry {
-}
+
 /** Every registered overlay id; plain `string` until the host augments the registry. */
 type OverlayId = [keyof OverlayRegistry] extends [never] ? string : Extract<keyof OverlayRegistry, string>;
 /** The open-data type declared for an overlay id. */
@@ -96,8 +96,6 @@ interface OverlayWindowOptions {
  *
  *   declare module "@ai-matrx/summon" { interface OverlayHostTypes { dispatch: AppDispatch } }
  */
-interface OverlayHostTypes {
-}
 type OverlayHostDispatch = OverlayHostTypes extends {
     dispatch: infer D;
 } ? D : (action: unknown) => unknown;
@@ -396,4 +394,4 @@ interface CreateSummonGateOptions {
 }
 declare function createSummonGate(options?: CreateSummonGateOptions): SummonGate;
 
-export { isRegisteredOverlay as $, type AnyOverlayMeta as A, anonymousIdentity as B, type CloseOverlaysBoundToPagePayload as C, DEFAULT_INSTANCE_ID as D, type ErrorSinkPort as E, closeAllInstancesOfOverlay as F, closeOverlay as G, closeOverlaysBoundToPage as H, type InstanceKey as I, consoleErrorSink as J, type KeepAlive as K, type LinkHydrateContext as L, type MobilePresentation as M, type NotifyOptions as N, type OverlayState as O, type PruneStaleInstancesPayload as P, consoleNotify as Q, type RawOpenPayload as R, type SummonPorts as S, type ToggleOverlayPayload as T, type UnbiddenHomeRoute as U, debugOff as V, type WindowPreservation as W, defaultWindowIdFor as X, getOverlayMeta as Y, getOverlayMetaByLinkKey as Z, instanceKey as _, type StateWithOverlays as a, listOpenInstanceKeys as a0, locationRouter as a1, openOverlay as a2, overlayIdsBoundToPage as a3, parseInstanceKey as a4, registerOverlayMeta as a5, resetOverlayRegistry as a6, resolvePorts as a7, selectIsOverlayOpen as a8, selectOpenInstances as a9, selectOverlay as aa, selectOverlayData as ab, subscribeToOverlayRegistry as ac, toggleOverlay as ad, type CreateSummonGateOptions as ae, SUMMON_INSTALLED_ACTION as af, SUMMON_SLICE_KEYS as ag, type SummonAction as ah, type SummonGate as ai, closeAllOverlays as aj, createSummonGate as ak, ensureSummonRuntime as al, focusWindow as am, installSummonCore as an, isSummonAction as ao, isSummonInstalled as ap, minimizeAll as aq, prefetchSummonRuntime as ar, pruneStaleInstances as as, restoreAll as at, restoreWindow as au, selectAnyOverlayTouched as av, selectWindowsHidden as aw, subscribeSummonInstalled as ax, toggleWindowsHidden as ay, type OverlayDefinitionMeta as b, type SummonCore as c, type CloseAllInstancesPayload as d, type CloseOverlayPayload as e, DEFAULT_PORTS as f, type DebugPort as g, type IdentityPort as h, type InstanceMode as i, type NotifyPort as j, type OpenInstanceView as k, type OpenOverlayPayload as l, type OverlayDataOf as m, type OverlayHostDispatch as n, type OverlayHostTypes as o, type OverlayId as p, type OverlayInstance as q, type OverlayLinkSpec as r, type OverlayPersistencePort as s, type OverlayRawData as t, type OverlayRegistry as u, type OverlayWindowOptions as v, type RouterPort as w, type StoredValue as x, type Unsubscribe as y, allOverlayMeta as z };
+export { locationRouter as $, type AnyOverlayMeta as A, closeOverlay as B, type CloseOverlaysBoundToPagePayload as C, DEFAULT_INSTANCE_ID as D, type ErrorSinkPort as E, closeOverlaysBoundToPage as F, consoleErrorSink as G, consoleNotify as H, type InstanceKey as I, debugOff as J, type KeepAlive as K, type LinkHydrateContext as L, type MobilePresentation as M, type NotifyOptions as N, type OverlayState as O, type PruneStaleInstancesPayload as P, defaultWindowIdFor as Q, type RawOpenPayload as R, type SummonPorts as S, type ToggleOverlayPayload as T, type UnbiddenHomeRoute as U, getOverlayMeta as V, type WindowPreservation as W, getOverlayMetaByLinkKey as X, instanceKey as Y, isRegisteredOverlay as Z, listOpenInstanceKeys as _, type StateWithOverlays as a, openOverlay as a0, overlayIdsBoundToPage as a1, parseInstanceKey as a2, registerOverlayMeta as a3, resetOverlayRegistry as a4, resolvePorts as a5, selectIsOverlayOpen as a6, selectOpenInstances as a7, selectOverlay as a8, selectOverlayData as a9, subscribeToOverlayRegistry as aa, toggleOverlay as ab, type CreateSummonGateOptions as ac, SUMMON_INSTALLED_ACTION as ad, SUMMON_SLICE_KEYS as ae, type SummonAction as af, type SummonGate as ag, closeAllOverlays as ah, createSummonGate as ai, ensureSummonRuntime as aj, focusWindow as ak, installSummonCore as al, isSummonAction as am, isSummonInstalled as an, minimizeAll as ao, prefetchSummonRuntime as ap, pruneStaleInstances as aq, restoreAll as ar, restoreWindow as as, selectAnyOverlayTouched as at, selectWindowsHidden as au, subscribeSummonInstalled as av, toggleWindowsHidden as aw, type OverlayDefinitionMeta as b, type SummonCore as c, type CloseAllInstancesPayload as d, type CloseOverlayPayload as e, DEFAULT_PORTS as f, type DebugPort as g, type IdentityPort as h, type InstanceMode as i, type NotifyPort as j, type OpenInstanceView as k, type OpenOverlayPayload as l, type OverlayDataOf as m, type OverlayHostDispatch as n, type OverlayId as o, type OverlayInstance as p, type OverlayLinkSpec as q, type OverlayPersistencePort as r, type OverlayRawData as s, type OverlayWindowOptions as t, type RouterPort as u, type StoredValue as v, type Unsubscribe as w, allOverlayMeta as x, anonymousIdentity as y, closeAllInstancesOfOverlay as z };

package/dist/{gate-DUvE-Cc1.d.ts → gate-CfjdNWP6.d.ts}

@@ -1,3 +1,4 @@
+import { OverlayHostTypes, OverlayRegistry } from '@ai-matrx/summon';
 import { Reducer, Middleware } from '@reduxjs/toolkit';
 
 /**
@@ -18,8 +19,7 @@ import { Reducer, Middleware } from '@reduxjs/toolkit';
  * `defineOverlay` emits nothing at runtime for this; the augmentation is the host's one-line
  * declaration per overlay (the converter writes it next to each definition).
  */
-interface OverlayRegistry {
-}
+
 /** Every registered overlay id; plain `string` until the host augments the registry. */
 type OverlayId = [keyof OverlayRegistry] extends [never] ? string : Extract<keyof OverlayRegistry, string>;
 /** The open-data type declared for an overlay id. */
@@ -96,8 +96,6 @@ interface OverlayWindowOptions {
  *
  *   declare module "@ai-matrx/summon" { interface OverlayHostTypes { dispatch: AppDispatch } }
  */
-interface OverlayHostTypes {
-}
 type OverlayHostDispatch = OverlayHostTypes extends {
     dispatch: infer D;
 } ? D : (action: unknown) => unknown;
@@ -396,4 +394,4 @@ interface CreateSummonGateOptions {
 }
 declare function createSummonGate(options?: CreateSummonGateOptions): SummonGate;
 
-export { isRegisteredOverlay as $, type AnyOverlayMeta as A, anonymousIdentity as B, type CloseOverlaysBoundToPagePayload as C, DEFAULT_INSTANCE_ID as D, type ErrorSinkPort as E, closeAllInstancesOfOverlay as F, closeOverlay as G, closeOverlaysBoundToPage as H, type InstanceKey as I, consoleErrorSink as J, type KeepAlive as K, type LinkHydrateContext as L, type MobilePresentation as M, type NotifyOptions as N, type OverlayState as O, type PruneStaleInstancesPayload as P, consoleNotify as Q, type RawOpenPayload as R, type SummonPorts as S, type ToggleOverlayPayload as T, type UnbiddenHomeRoute as U, debugOff as V, type WindowPreservation as W, defaultWindowIdFor as X, getOverlayMeta as Y, getOverlayMetaByLinkKey as Z, instanceKey as _, type StateWithOverlays as a, listOpenInstanceKeys as a0, locationRouter as a1, openOverlay as a2, overlayIdsBoundToPage as a3, parseInstanceKey as a4, registerOverlayMeta as a5, resetOverlayRegistry as a6, resolvePorts as a7, selectIsOverlayOpen as a8, selectOpenInstances as a9, selectOverlay as aa, selectOverlayData as ab, subscribeToOverlayRegistry as ac, toggleOverlay as ad, type CreateSummonGateOptions as ae, SUMMON_INSTALLED_ACTION as af, SUMMON_SLICE_KEYS as ag, type SummonAction as ah, type SummonGate as ai, closeAllOverlays as aj, createSummonGate as ak, ensureSummonRuntime as al, focusWindow as am, installSummonCore as an, isSummonAction as ao, isSummonInstalled as ap, minimizeAll as aq, prefetchSummonRuntime as ar, pruneStaleInstances as as, restoreAll as at, restoreWindow as au, selectAnyOverlayTouched as av, selectWindowsHidden as aw, subscribeSummonInstalled as ax, toggleWindowsHidden as ay, type OverlayDefinitionMeta as b, type SummonCore as c, type CloseAllInstancesPayload as d, type CloseOverlayPayload as e, DEFAULT_PORTS as f, type DebugPort as g, type IdentityPort as h, type InstanceMode as i, type NotifyPort as j, type OpenInstanceView as k, type OpenOverlayPayload as l, type OverlayDataOf as m, type OverlayHostDispatch as n, type OverlayHostTypes as o, type OverlayId as p, type OverlayInstance as q, type OverlayLinkSpec as r, type OverlayPersistencePort as s, type OverlayRawData as t, type OverlayRegistry as u, type OverlayWindowOptions as v, type RouterPort as w, type StoredValue as x, type Unsubscribe as y, allOverlayMeta as z };
+export { locationRouter as $, type AnyOverlayMeta as A, closeOverlay as B, type CloseOverlaysBoundToPagePayload as C, DEFAULT_INSTANCE_ID as D, type ErrorSinkPort as E, closeOverlaysBoundToPage as F, consoleErrorSink as G, consoleNotify as H, type InstanceKey as I, debugOff as J, type KeepAlive as K, type LinkHydrateContext as L, type MobilePresentation as M, type NotifyOptions as N, type OverlayState as O, type PruneStaleInstancesPayload as P, defaultWindowIdFor as Q, type RawOpenPayload as R, type SummonPorts as S, type ToggleOverlayPayload as T, type UnbiddenHomeRoute as U, getOverlayMeta as V, type WindowPreservation as W, getOverlayMetaByLinkKey as X, instanceKey as Y, isRegisteredOverlay as Z, listOpenInstanceKeys as _, type StateWithOverlays as a, openOverlay as a0, overlayIdsBoundToPage as a1, parseInstanceKey as a2, registerOverlayMeta as a3, resetOverlayRegistry as a4, resolvePorts as a5, selectIsOverlayOpen as a6, selectOpenInstances as a7, selectOverlay as a8, selectOverlayData as a9, subscribeToOverlayRegistry as aa, toggleOverlay as ab, type CreateSummonGateOptions as ac, SUMMON_INSTALLED_ACTION as ad, SUMMON_SLICE_KEYS as ae, type SummonAction as af, type SummonGate as ag, closeAllOverlays as ah, createSummonGate as ai, ensureSummonRuntime as aj, focusWindow as ak, installSummonCore as al, isSummonAction as am, isSummonInstalled as an, minimizeAll as ao, prefetchSummonRuntime as ap, pruneStaleInstances as aq, restoreAll as ar, restoreWindow as as, selectAnyOverlayTouched as at, selectWindowsHidden as au, subscribeSummonInstalled as av, toggleWindowsHidden as aw, type OverlayDefinitionMeta as b, type SummonCore as c, type CloseAllInstancesPayload as d, type CloseOverlayPayload as e, DEFAULT_PORTS as f, type DebugPort as g, type IdentityPort as h, type InstanceMode as i, type NotifyPort as j, type OpenInstanceView as k, type OpenOverlayPayload as l, type OverlayDataOf as m, type OverlayHostDispatch as n, type OverlayId as o, type OverlayInstance as p, type OverlayLinkSpec as q, type OverlayPersistencePort as r, type OverlayRawData as s, type OverlayWindowOptions as t, type RouterPort as u, type StoredValue as v, type Unsubscribe as w, allOverlayMeta as x, anonymousIdentity as y, closeAllInstancesOfOverlay as z };