@thoughtbot/superglue 2.0.0-alpha.1 → 2.0.0-alpha.10

package/dist/{index-MyfFLe4E.d.mts → index-j0c-9ZLt.d.mts}

@@ -1,4 +1,4 @@
-import { Action, ThunkDispatch, EnhancedStore, Tuple, StoreEnhancer, ThunkAction } from '@reduxjs/toolkit';
+import { Action, EnhancedStore, Tuple, StoreEnhancer, ThunkDispatch, ThunkAction } from '@reduxjs/toolkit';
 import { History } from 'history';
 
 type FetchArgs = [string, BasicRequestInit];
@@ -42,8 +42,8 @@ interface RemoteProps extends BaseProps {
     pageKey?: PageKey;
     force?: boolean;
 }
-interface BeforeSave {
-    <T extends PageResponse>(prevPage: SaveResponse, receivedPage: T): T;
+interface BeforeSave<T = JSONMappable> {
+    <U extends SaveResponse<T> | GraftResponse<T>>(prevPage: Page<T>, receivedPage: U): U;
 }
 interface ApplicationRemote {
     (input: string | PageKey, options?: RemoteProps & {
@@ -69,6 +69,17 @@ declare const rootReducer: {
     fragments: typeof fragmentReducer;
 };
 
+type FragmentProxy = {
+    __fragment: true;
+};
+type ProxiedContent<T> = T extends Fragment<infer U, true> ? ProxiedContent<U> & FragmentProxy : T extends Fragment<infer U, false | undefined> ? (ProxiedContent<U> & FragmentProxy) | undefined : T extends (infer U)[] ? ProxiedContent<U>[] : T extends object ? {
+    [K in keyof T]: ProxiedContent<T[K]>;
+} : T;
+type FragmentRefOrId = FragmentRef | string;
+declare function useContent<T = JSONMappable>(): ProxiedContent<T>;
+declare function useContent<T = JSONMappable>(fragmentRef: FragmentRefOrId): ProxiedContent<T>;
+declare function unproxy<T>(proxy: T): Unproxy<T>;
+
 type PageKey = string;
 type RestoreStrategy = 'fromCacheOnly' | 'revisitOnly' | 'fromCacheAndRevisitInBackground';
 type NavigationAction = 'push' | 'replace' | 'none';
@@ -82,15 +93,13 @@ type JSONObject = {
 type JSONMappable = JSONValue[] | JSONObject;
 type JSONKeyable = JSONObject[] | JSONObject;
 type JSONValue = JSONPrimitive | JSONMappable;
-type Fragment<T> = {
+type Fragment<T, Present = false> = {
     __id: string;
-} & {
     __fragmentType?: T;
+    __required?: Present extends boolean ? Present : false;
 };
-type Unproxied<T> = T extends Fragment<unknown> ? {
-    __id: string;
-} : T extends (infer U)[] ? Unproxied<U>[] : T extends object ? {
-    [K in keyof T]: Unproxied<T[K]>;
+type Unproxy<T> = T extends FragmentProxy ? FragmentRef : T extends Fragment<unknown, unknown> ? FragmentRef : T extends (infer U)[] ? Unproxy<U>[] : T extends object ? {
+    [K in keyof T]: Unproxy<T[K]>;
 } : T;
 interface ParsedResponse {
     rsp: Response;
@@ -108,7 +117,7 @@ type SaveResponse<T = JSONMappable> = {
     componentIdentifier: ComponentIdentifier;
     assets: string[];
     csrfToken?: string;
-    fragments: FragmentRef[];
+    fragments: FragmentPath[];
     defers: Defer[];
     slices: JSONObject;
     action: 'savePage';
@@ -123,34 +132,37 @@ type GraftResponse<T = JSONMappable> = {
     componentIdentifier: ComponentIdentifier;
     assets: string[];
     csrfToken?: string;
-    fragments: FragmentRef[];
+    fragments: FragmentPath[];
     defers: Defer[];
     slices: JSONObject;
     action: 'graft';
     renderedAt: number;
-    restoreStrategy: RestoreStrategy;
     path: Keypath;
     fragmentContext?: string;
 };
-type StreamMutateMessage = {
+type StreamMessage = {
     data: JSONMappable;
     fragmentIds: string[];
     handler: 'append' | 'prepend' | 'save';
     options: Record<string, string>;
 };
 type StreamResponse = {
-    data: StreamMutateMessage[];
-    fragments: FragmentRef[];
+    data: StreamMessage[];
+    fragments: FragmentPath[];
     assets: string[];
     csrfToken?: string;
     action: 'handleStreamResponse';
     renderedAt: number;
+    slices: JSONObject;
 };
 type PageResponse = GraftResponse | SaveResponse | StreamResponse;
-type FragmentRef = {
+type FragmentPath = {
     id: string;
     path: Keypath;
 };
+type FragmentRef = {
+    __id: string;
+};
 type AllPages<T = JSONMappable> = Record<PageKey, Page<T>>;
 type AllFragments = Record<string, JSONMappable>;
 interface SuperglueState {
@@ -268,4 +280,4 @@ declare const visit: VisitCreator;
 
 declare function saveAndProcessPage(pageKey: string, page: PageResponse): SaveAndProcessPageThunk;
 
-export { type Visit as $, type ApplicationRemote as A, type VisitCreator as B, type ComponentIdentifier as C, type Defer as D, type RemoteCreator as E, type FetchArgs as F, type GraftResponse as G, type Handlers as H, type Dispatch as I, type JSONMappable as J, type Keypath as K, type UJSHandlers as L, type Meta as M, type NavigationContextProps as N, type HistoryState as O, type PageKey as P, type SaveAndProcessPageThunk as Q, type RestoreStrategy as R, type SuperglueStore as S, type MetaThunk as T, type Unproxied as U, type VisitMeta as V, type VisitMetaThunk as W, type DefermentThunk as X, type BasicRequestInit as Y, type BuildStore as Z, type BuildVisitAndRemote as _, type JSONValue as a, type VisitProps as a0, type Remote as a1, type RemoteProps as a2, type BeforeSave as a3, type GraftingSuccessAction as a4, type GraftingErrorAction as a5, MismatchedComponentError as a6, remote as a7, visit as a8, type NavigationProviderProps as b, type NavigateTo as c, type SaveResponse as d, type SuperglueState as e, type SetupProps as f, type ApplicationVisit as g, type ApplicationProps as h, superglueReducer as i, type NavigationAction as j, type JSONPrimitive as k, type JSONObject as l, type JSONKeyable as m, type Fragment as n, type ParsedResponse as o, pageReducer as p, type Page as q, rootReducer as r, saveAndProcessPage as s, type StreamMutateMessage as t, type StreamResponse as u, type PageResponse as v, type FragmentRef as w, type AllPages as x, type AllFragments as y, type RootState as z };
+export { type BasicRequestInit as $, type ApplicationRemote as A, type AllPages as B, type ComponentIdentifier as C, type Defer as D, type AllFragments as E, type FetchArgs as F, type GraftResponse as G, type Handlers as H, type RootState as I, type JSONMappable as J, type Keypath as K, type VisitCreator as L, type Meta as M, type NavigationProviderProps as N, type RemoteCreator as O, type PageKey as P, type Dispatch as Q, type RestoreStrategy as R, type SuperglueStore as S, type UJSHandlers as T, type Unproxy as U, type VisitMeta as V, type HistoryState as W, type SaveAndProcessPageThunk as X, type MetaThunk as Y, type VisitMetaThunk as Z, type DefermentThunk as _, type JSONValue as a, type BuildStore as a0, type BuildVisitAndRemote as a1, type Visit as a2, type VisitProps as a3, type Remote as a4, type RemoteProps as a5, type BeforeSave as a6, type GraftingSuccessAction as a7, type GraftingErrorAction as a8, useContent as a9, MismatchedComponentError as aa, remote as ab, visit as ac, type NavigateTo as b, type NavigationContextProps as c, type SaveResponse as d, type PageResponse as e, type Fragment as f, type FragmentProxy as g, type SuperglueState as h, type ApplicationProps as i, type SetupProps as j, type ApplicationVisit as k, superglueReducer as l, type NavigationAction as m, type JSONPrimitive as n, type JSONObject as o, pageReducer as p, type JSONKeyable as q, rootReducer as r, saveAndProcessPage as s, type ParsedResponse as t, unproxy as u, type Page as v, type StreamMessage as w, type StreamResponse as x, type FragmentPath as y, type FragmentRef as z };

package/dist/superglue.d.mts

@@ -1,8 +1,8 @@
 import * as history from 'history';
-import { J as JSONMappable, K as Keypath, a as JSONValue, P as PageKey, A as ApplicationRemote, S as SuperglueStore, N as NavigationContextProps, b as NavigationProviderProps, c as NavigateTo, d as SaveResponse, F as FetchArgs, U as Unproxied, e as SuperglueState, f as SetupProps, g as ApplicationVisit, H as Handlers, h as ApplicationProps } from './index-MyfFLe4E.mjs';
-export { y as AllFragments, x as AllPages, Y as BasicRequestInit, a3 as BeforeSave, Z as BuildStore, _ as BuildVisitAndRemote, C as ComponentIdentifier, D as Defer, X as DefermentThunk, I as Dispatch, n as Fragment, w as FragmentRef, G as GraftResponse, a5 as GraftingErrorAction, a4 as GraftingSuccessAction, O as HistoryState, m as JSONKeyable, l as JSONObject, k as JSONPrimitive, M as Meta, T as MetaThunk, j as NavigationAction, q as Page, v as PageResponse, o as ParsedResponse, a1 as Remote, E as RemoteCreator, a2 as RemoteProps, R as RestoreStrategy, z as RootState, Q as SaveAndProcessPageThunk, t as StreamMutateMessage, u as StreamResponse, L as UJSHandlers, $ as Visit, B as VisitCreator, V as VisitMeta, W as VisitMetaThunk, a0 as VisitProps, p as pageReducer, r as rootReducer, s as saveAndProcessPage, i as superglueReducer } from './index-MyfFLe4E.mjs';
+import { J as JSONMappable, K as Keypath, a as JSONValue, P as PageKey, A as ApplicationRemote, S as SuperglueStore, N as NavigationProviderProps, b as NavigateTo, c as NavigationContextProps, F as FetchArgs, d as SaveResponse, e as PageResponse, f as Fragment, U as Unproxy, g as FragmentProxy, h as SuperglueState, i as ApplicationProps, j as SetupProps, k as ApplicationVisit, H as Handlers } from './index-j0c-9ZLt.mjs';
+export { E as AllFragments, B as AllPages, $ as BasicRequestInit, a6 as BeforeSave, a0 as BuildStore, a1 as BuildVisitAndRemote, C as ComponentIdentifier, D as Defer, _ as DefermentThunk, Q as Dispatch, y as FragmentPath, z as FragmentRef, G as GraftResponse, a8 as GraftingErrorAction, a7 as GraftingSuccessAction, W as HistoryState, q as JSONKeyable, o as JSONObject, n as JSONPrimitive, M as Meta, Y as MetaThunk, m as NavigationAction, v as Page, t as ParsedResponse, a4 as Remote, O as RemoteCreator, a5 as RemoteProps, R as RestoreStrategy, I as RootState, X as SaveAndProcessPageThunk, w as StreamMessage, x as StreamResponse, T as UJSHandlers, a2 as Visit, L as VisitCreator, V as VisitMeta, Z as VisitMetaThunk, a3 as VisitProps, p as pageReducer, r as rootReducer, s as saveAndProcessPage, l as superglueReducer, u as unproxy, a9 as useContent } from './index-j0c-9ZLt.mjs';
 import React from 'react';
-import { Subscription, Consumer, ChannelNameWithParams } from '@rails/actioncable';
+import { ChannelNameWithParams, Subscription } from '@rails/actioncable';
 import { DebouncedFunc } from 'lodash';
 import * as _reduxjs_toolkit from '@reduxjs/toolkit';
 
@@ -31,7 +31,7 @@ declare class StreamActions {
 }
 declare function useStreamSource(channel: StreamSourceProps): {
     connected: boolean;
-    subscription: Subscription<Consumer> | null;
+    subscription: Subscription | null;
 };
 
 declare const NavigationContext: React.Context<NavigationContextProps>;
@@ -66,28 +66,19 @@ declare const beforeRemote: _reduxjs_toolkit.ActionCreatorWithPayload<{
     currentPageKey: PageKey;
     fetchArgs: FetchArgs;
 }, string>;
+declare const receiveResponse: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[{
+    pageKey: string;
+    response: PageResponse;
+}], {
+    pageKey: string;
+    response: PageResponse;
+}, "@@superglue/RECEIVE_RESPONSE", never, never>;
 
-type ProxiedContent<T> = T & {
-    readonly [K in keyof T]: T[K] extends {
-        __id: string;
-    } ? unknown : T[K] extends (infer U)[] ? ProxiedContent<U>[] : T[K] extends object ? ProxiedContent<T[K]> : T[K];
+type Unpack<T> = T extends Fragment<infer U, unknown> ? U : T extends FragmentProxy ? T : never;
+declare function useSetFragment(): {
+    <T extends Fragment<unknown, unknown>>(fragmentRef: T, updater: (draft: Unproxy<Unpack<T>>) => void): void;
+    <T = unknown>(fragmentId: string, updater: (draft: T) => void): void;
 };
-type FragmentRef = {
-    __id: string;
-} | string;
-declare function useContent<T = JSONMappable>(): ProxiedContent<T>;
-declare function useContent<T = JSONMappable>(fragmentRef: FragmentRef): ProxiedContent<T>;
-declare function useContent<T = JSONMappable>(fragmentRef: FragmentRef, options: {
-    optional: false;
-}): ProxiedContent<T>;
-declare function useContent<T = JSONMappable>(fragmentRef: FragmentRef, options: {
-    optional: true;
-}): ProxiedContent<T> | undefined;
-declare function unproxy<T>(proxy: T): Unproxied<T>;
-
-declare function useSetFragment(): (fragmentRef: {
-    __id: string;
-} | string, updater: (draft: unknown) => void) => void;
 
 declare function useSuperglue(): SuperglueState;
 
@@ -102,4 +93,4 @@ declare const setup: ({ initialPage, baseUrl, path, store, buildVisitAndRemote,
 };
 declare function Application({ initialPage, baseUrl, path, store, buildVisitAndRemote, history, mapping, ...rest }: ApplicationProps): React.JSX.Element;
 
-export { Application, ApplicationProps, ApplicationRemote, ApplicationVisit, FetchArgs, GRAFTING_ERROR, GRAFTING_SUCCESS, Handlers, JSONMappable, JSONValue, Keypath, NavigateTo, NavigationContext, NavigationContextProps, NavigationProvider, NavigationProviderProps, PageKey, SaveResponse, SetupProps, SuperglueState, SuperglueStore, Unproxied, beforeFetch, beforeRemote, beforeVisit, copyPage, getIn, prepareStore, removePage, saveResponse, setup, unproxy, urlToPageKey, useContent, useSetFragment, useStreamSource, useSuperglue };
+export { Application, ApplicationProps, ApplicationRemote, ApplicationVisit, FetchArgs, Fragment, GRAFTING_ERROR, GRAFTING_SUCCESS, Handlers, JSONMappable, JSONValue, Keypath, NavigateTo, NavigationContext, NavigationContextProps, NavigationProvider, NavigationProviderProps, PageKey, PageResponse, SaveResponse, SetupProps, SuperglueState, SuperglueStore, Unproxy, beforeFetch, beforeRemote, beforeVisit, copyPage, getIn, prepareStore, receiveResponse, removePage, saveResponse, setup, urlToPageKey, useSetFragment, useStreamSource, useSuperglue };