@thoughtbot/superglue 1.0.3 → 2.0.0-alpha.10

package/dist/{index-BYr1PoYr.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,18 +42,18 @@ interface RemoteProps extends BaseProps {
     pageKey?: PageKey;
     force?: boolean;
 }
-interface BeforeSave {
-    (prevPage: VisitResponse, receivedPage: VisitResponse): VisitResponse;
+interface BeforeSave<T = JSONMappable> {
+    <U extends SaveResponse<T> | GraftResponse<T>>(prevPage: Page<T>, receivedPage: U): U;
 }
 interface ApplicationRemote {
-    (input: string | PageKey, options: RemoteProps & {
+    (input: string | PageKey, options?: RemoteProps & {
         dataset?: {
             [name: string]: string | undefined;
         };
     }): Promise<Meta>;
 }
 interface ApplicationVisit {
-    (input: string | PageKey, options: VisitProps & {
+    (input: string | PageKey, options?: VisitProps & {
         dataset?: {
             [name: string]: string | undefined;
         };
@@ -62,11 +62,24 @@ interface ApplicationVisit {
 
 declare function pageReducer(state: AllPages | undefined, action: Action): AllPages;
 declare function superglueReducer(state: SuperglueState | undefined, action: Action): SuperglueState;
+declare function fragmentReducer(state: AllFragments | undefined, action: Action): AllFragments;
 declare const rootReducer: {
     superglue: typeof superglueReducer;
     pages: typeof pageReducer;
+    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';
@@ -80,6 +93,14 @@ type JSONObject = {
 type JSONMappable = JSONValue[] | JSONObject;
 type JSONKeyable = JSONObject[] | JSONObject;
 type JSONValue = JSONPrimitive | JSONMappable;
+type Fragment<T, Present = false> = {
+    __id: string;
+    __fragmentType?: T;
+    __required?: Present extends boolean ? Present : false;
+};
+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;
     json: PageResponse;
@@ -91,30 +112,59 @@ type Defer = {
     successAction: string;
     failAction: string;
 };
-type VisitResponse<T = JSONMappable> = {
+type SaveResponse<T = JSONMappable> = {
     data: T;
     componentIdentifier: ComponentIdentifier;
     assets: string[];
     csrfToken?: string;
-    fragments: Fragment[];
+    fragments: FragmentPath[];
     defers: Defer[];
     slices: JSONObject;
+    action: 'savePage';
     renderedAt: number;
     restoreStrategy: RestoreStrategy;
 };
-type Page<T = JSONMappable> = VisitResponse<T> & {
+type Page<T = JSONMappable> = SaveResponse<T> & {
     savedAt: number;
 };
-type GraftResponse<T = JSONMappable> = VisitResponse<T> & {
+type GraftResponse<T = JSONMappable> = {
+    data: T;
+    componentIdentifier: ComponentIdentifier;
+    assets: string[];
+    csrfToken?: string;
+    fragments: FragmentPath[];
+    defers: Defer[];
+    slices: JSONObject;
     action: 'graft';
+    renderedAt: number;
     path: Keypath;
+    fragmentContext?: string;
+};
+type StreamMessage = {
+    data: JSONMappable;
+    fragmentIds: string[];
+    handler: 'append' | 'prepend' | 'save';
+    options: Record<string, string>;
 };
-type PageResponse = GraftResponse | VisitResponse;
-type Fragment = {
-    type: string;
+type StreamResponse = {
+    data: StreamMessage[];
+    fragments: FragmentPath[];
+    assets: string[];
+    csrfToken?: string;
+    action: 'handleStreamResponse';
+    renderedAt: number;
+    slices: JSONObject;
+};
+type PageResponse = GraftResponse | SaveResponse | StreamResponse;
+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 {
     currentPageKey: PageKey;
     search: Record<string, string | undefined>;
@@ -124,15 +174,16 @@ interface SuperglueState {
 interface RootState<T = JSONMappable> {
     superglue: SuperglueState;
     pages: AllPages<T>;
+    fragments: AllFragments;
     [name: string]: unknown;
 }
 interface Meta {
     pageKey: PageKey;
-    page: VisitResponse;
+    page: PageResponse;
     redirected: boolean;
     rsp: Response;
     fetchArgs: FetchArgs;
-    componentIdentifier: ComponentIdentifier;
+    componentIdentifier?: ComponentIdentifier;
     needsRefresh: boolean;
 }
 interface VisitMeta extends Meta {
@@ -201,7 +252,7 @@ interface BuildVisitAndRemote {
     };
 }
 interface SetupProps {
-    initialPage: VisitResponse;
+    initialPage: SaveResponse;
     baseUrl: string;
     path: string;
     store: SuperglueStore;
@@ -212,7 +263,7 @@ interface SetupProps {
     } | null>;
 }
 interface ApplicationProps extends React.ComponentPropsWithoutRef<'div'> {
-    initialPage: VisitResponse;
+    initialPage: SaveResponse;
     baseUrl: string;
     path: string;
     buildVisitAndRemote: BuildVisitAndRemote;
@@ -227,6 +278,6 @@ declare class MismatchedComponentError extends Error {
 declare const remote: RemoteCreator;
 declare const visit: VisitCreator;
 
-declare function saveAndProcessPage(pageKey: string, page: VisitResponse | GraftResponse): SaveAndProcessPageThunk;
+declare function saveAndProcessPage(pageKey: string, page: PageResponse): SaveAndProcessPageThunk;
 
-export { type GraftingSuccessAction as $, type ApplicationVisit as A, type SaveAndProcessPageThunk as B, type ComponentIdentifier as C, type Defer as D, type MetaThunk as E, type FetchArgs as F, type GraftResponse as G, type Handlers as H, type VisitMetaThunk as I, type JSONMappable as J, type Keypath as K, type DefermentThunk as L, type Meta as M, type NavigationContextProps as N, type BasicRequestInit as O, type PageKey as P, type BuildStore as Q, type RestoreStrategy as R, type SuperglueState as S, type BuildVisitAndRemote as T, type UJSHandlers as U, type VisitResponse as V, type Visit as W, type VisitProps as X, type Remote as Y, type RemoteProps as Z, type BeforeSave as _, type JSONValue as a, type GraftingErrorAction as a0, MismatchedComponentError as a1, remote as a2, visit as a3, type NavigationProviderProps as b, type NavigateTo as c, type SuperglueStore as d, type SetupProps as e, type ApplicationRemote as f, type ApplicationProps as g, superglueReducer as h, type NavigationAction as i, type JSONPrimitive as j, type JSONObject as k, type JSONKeyable as l, type ParsedResponse as m, type Page as n, type PageResponse as o, pageReducer as p, type Fragment as q, rootReducer as r, saveAndProcessPage as s, type AllPages as t, type RootState as u, type VisitMeta as v, type VisitCreator as w, type RemoteCreator as x, type Dispatch as y, type HistoryState 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,13 +1,39 @@
 import * as history from 'history';
-import { J as JSONMappable, K as Keypath, a as JSONValue, P as PageKey, N as NavigationContextProps, b as NavigationProviderProps, c as NavigateTo, V as VisitResponse, F as FetchArgs, S as SuperglueState, d as SuperglueStore, e as SetupProps, A as ApplicationVisit, f as ApplicationRemote, H as Handlers, g as ApplicationProps } from './index-BYr1PoYr.mjs';
-export { t as AllPages, O as BasicRequestInit, _ as BeforeSave, Q as BuildStore, T as BuildVisitAndRemote, C as ComponentIdentifier, D as Defer, L as DefermentThunk, y as Dispatch, q as Fragment, G as GraftResponse, a0 as GraftingErrorAction, $ as GraftingSuccessAction, z as HistoryState, l as JSONKeyable, k as JSONObject, j as JSONPrimitive, M as Meta, E as MetaThunk, i as NavigationAction, n as Page, o as PageResponse, m as ParsedResponse, Y as Remote, x as RemoteCreator, Z as RemoteProps, R as RestoreStrategy, u as RootState, B as SaveAndProcessPageThunk, U as UJSHandlers, W as Visit, w as VisitCreator, v as VisitMeta, I as VisitMetaThunk, X as VisitProps, p as pageReducer, r as rootReducer, s as saveAndProcessPage, h as superglueReducer } from './index-BYr1PoYr.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 { ChannelNameWithParams, Subscription } from '@rails/actioncable';
+import { DebouncedFunc } from 'lodash';
 import * as _reduxjs_toolkit from '@reduxjs/toolkit';
 
 declare function getIn(node: JSONMappable, path: Keypath): JSONValue;
 
 declare function urlToPageKey(url: string): PageKey;
 
+type StreamSourceProps = string | ChannelNameWithParams;
+declare class StreamActions {
+    attributePrefix: string;
+    remote: DebouncedFunc<ApplicationRemote>;
+    private store;
+    constructor({ remote, store, }: {
+        remote: ApplicationRemote;
+        store: SuperglueStore;
+    });
+    refresh(pageKey: string): void;
+    prepend(fragments: string[], data: JSONMappable, options?: {
+        saveAs?: string;
+    }): void;
+    save(fragment: string, data: JSONMappable): void;
+    append(fragments: string[], data: JSONMappable, options?: {
+        saveAs?: string;
+    }): void;
+    handle(rawMessage: string, currentPageKey: string): void;
+}
+declare function useStreamSource(channel: StreamSourceProps): {
+    connected: boolean;
+    subscription: Subscription | null;
+};
+
 declare const NavigationContext: React.Context<NavigationContextProps>;
 declare const NavigationProvider: React.ForwardRefExoticComponent<NavigationProviderProps & React.RefAttributes<{
     navigateTo: NavigateTo | null;
@@ -17,18 +43,11 @@ declare const GRAFTING_ERROR = "@@superglue/GRAFTING_ERROR";
 declare const GRAFTING_SUCCESS = "@@superglue/GRAFTING_SUCCESS";
 declare const saveResponse: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[{
     pageKey: string;
-    page: VisitResponse;
+    page: SaveResponse;
 }], {
     pageKey: string;
-    page: VisitResponse;
+    page: SaveResponse;
 }, "@@superglue/SAVE_RESPONSE", never, never>;
-declare const updateFragments: _reduxjs_toolkit.ActionCreatorWithPayload<{
-    name: string;
-    path: Keypath;
-    pageKey: PageKey;
-    value: JSONMappable;
-    previousValue?: JSONMappable;
-}, string>;
 declare const copyPage: _reduxjs_toolkit.ActionCreatorWithPayload<{
     from: PageKey;
     to: PageKey;
@@ -47,18 +66,31 @@ 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 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;
+};
 
 declare function useSuperglue(): SuperglueState;
-declare function useContent<T = JSONMappable>(): T;
 
-declare const prepareStore: (store: SuperglueStore, initialPage: VisitResponse, path: string) => void;
+declare const prepareStore: (store: SuperglueStore, initialPage: SaveResponse, path: string) => void;
 declare const setup: ({ initialPage, baseUrl, path, store, buildVisitAndRemote, history, navigatorRef, }: SetupProps) => {
     visit: ApplicationVisit;
     remote: ApplicationRemote;
     nextHistory: history.History;
     initialPageKey: string;
     ujs: Handlers;
+    streamActions: StreamActions;
 };
 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, SetupProps, SuperglueState, SuperglueStore, VisitResponse, beforeFetch, beforeRemote, beforeVisit, copyPage, getIn, prepareStore, removePage, saveResponse, setup, updateFragments, urlToPageKey, useContent, 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 };