@thoughtbot/superglue 1.0.1 → 2.0.0-alpha.1

package/dist/{index-BYr1PoYr.d.mts → index-MyfFLe4E.d.mts}

@@ -43,17 +43,17 @@ interface RemoteProps extends BaseProps {
     force?: boolean;
 }
 interface BeforeSave {
-    (prevPage: VisitResponse, receivedPage: VisitResponse): VisitResponse;
+    <T extends PageResponse>(prevPage: SaveResponse, receivedPage: T): T;
 }
 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,9 +62,11 @@ 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 PageKey = string;
@@ -80,6 +82,16 @@ type JSONObject = {
 type JSONMappable = JSONValue[] | JSONObject;
 type JSONKeyable = JSONObject[] | JSONObject;
 type JSONValue = JSONPrimitive | JSONMappable;
+type Fragment<T> = {
+    __id: string;
+} & {
+    __fragmentType?: T;
+};
+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]>;
+} : T;
 interface ParsedResponse {
     rsp: Response;
     json: PageResponse;
@@ -91,30 +103,56 @@ 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: FragmentRef[];
     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: FragmentRef[];
+    defers: Defer[];
+    slices: JSONObject;
     action: 'graft';
+    renderedAt: number;
+    restoreStrategy: RestoreStrategy;
     path: Keypath;
+    fragmentContext?: string;
+};
+type StreamMutateMessage = {
+    data: JSONMappable;
+    fragmentIds: string[];
+    handler: 'append' | 'prepend' | 'save';
+    options: Record<string, string>;
 };
-type PageResponse = GraftResponse | VisitResponse;
-type Fragment = {
-    type: string;
+type StreamResponse = {
+    data: StreamMutateMessage[];
+    fragments: FragmentRef[];
+    assets: string[];
+    csrfToken?: string;
+    action: 'handleStreamResponse';
+    renderedAt: number;
+};
+type PageResponse = GraftResponse | SaveResponse | StreamResponse;
+type FragmentRef = {
+    id: string;
     path: Keypath;
 };
 type AllPages<T = JSONMappable> = Record<PageKey, Page<T>>;
+type AllFragments = Record<string, JSONMappable>;
 interface SuperglueState {
     currentPageKey: PageKey;
     search: Record<string, string | undefined>;
@@ -124,15 +162,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 +240,7 @@ interface BuildVisitAndRemote {
     };
 }
 interface SetupProps {
-    initialPage: VisitResponse;
+    initialPage: SaveResponse;
     baseUrl: string;
     path: string;
     store: SuperglueStore;
@@ -212,7 +251,7 @@ interface SetupProps {
     } | null>;
 }
 interface ApplicationProps extends React.ComponentPropsWithoutRef<'div'> {
-    initialPage: VisitResponse;
+    initialPage: SaveResponse;
     baseUrl: string;
     path: string;
     buildVisitAndRemote: BuildVisitAndRemote;
@@ -227,6 +266,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 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 };

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 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 React from 'react';
+import { Subscription, Consumer, ChannelNameWithParams } 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<Consumer> | 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;
@@ -48,17 +67,39 @@ declare const beforeRemote: _reduxjs_toolkit.ActionCreatorWithPayload<{
     fetchArgs: FetchArgs;
 }, string>;
 
+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 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;
-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, 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 };