diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml
index 0e5e96c6..6d187850 100644
--- a/.github/workflows/publish_docs.yml
+++ b/.github/workflows/publish_docs.yml
@@ -14,9 +14,13 @@ jobs:
- uses: actions/setup-node@v3
with:
node-version: 18
+ - name: NPM install
+ working-directory: ./superglue
+ run: npm install
+
- name: Build typedoc
working-directory: ./superglue
- run: npm install && npx typedoc
+ run: npx typedoc
- uses: actions/setup-python@v5
with:
diff --git a/docs/reference/components.Nav.md b/docs/reference/components.Nav.md
index 4bde927d..9ace1536 100644
--- a/docs/reference/components.Nav.md
+++ b/docs/reference/components.Nav.md
@@ -47,4 +47,4 @@ store.
###### Defined in
-[lib/components/Nav.tsx:85](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/components/Nav.tsx#L85)
+[lib/components/Nav.tsx:85](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/components/Nav.tsx#L85)
diff --git a/docs/reference/index.md b/docs/reference/index.md
index 1ed5d689..6605046f 100644
--- a/docs/reference/index.md
+++ b/docs/reference/index.md
@@ -40,7 +40,7 @@ The constructor of the `ApplicationBase` class.
###### Defined in
-[lib/index.tsx:151](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L151)
+[lib/index.tsx:151](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L151)
#### Methods
@@ -68,12 +68,12 @@ adding a progress bar.
| Name | Type | Defined in |
| ------ | ------ | ------ |
-| `visit` | [`Visit`](types.requests.md#visit) | [lib/index.tsx:215](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L215) |
-| `remote` | [`Remote`](types.requests.md#remote) | [lib/index.tsx:215](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L215) |
+| `visit` | [`Visit`](types.requests.md#visit) | [lib/index.tsx:215](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L215) |
+| `remote` | [`Remote`](types.requests.md#remote) | [lib/index.tsx:215](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L215) |
###### Defined in
-[lib/index.tsx:211](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L211)
+[lib/index.tsx:211](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L211)
@@ -93,7 +93,7 @@ Called immediately after a component is mounted. Setting state here will trigger
###### Defined in
-[lib/index.tsx:217](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L217)
+[lib/index.tsx:217](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L217)
@@ -114,7 +114,7 @@ cancelled network requests, or cleaning up any DOM elements created in `componen
###### Defined in
-[lib/index.tsx:232](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L232)
+[lib/index.tsx:232](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L232)
@@ -142,7 +142,7 @@ using Redux toolkit's `configureStore` to build the store.
###### Defined in
-[lib/index.tsx:248](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L248)
+[lib/index.tsx:248](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L248)
@@ -156,7 +156,7 @@ using Redux toolkit's `configureStore` to build the store.
###### Defined in
-[lib/index.tsx:253](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L253)
+[lib/index.tsx:253](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L253)
@@ -174,7 +174,7 @@ to render with which payload.
###### Defined in
-[lib/index.tsx:270](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L270)
+[lib/index.tsx:270](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L270)
@@ -192,7 +192,7 @@ to render with which payload.
###### Defined in
-[lib/index.tsx:272](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L272)
+[lib/index.tsx:272](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L272)
## Variables
@@ -204,7 +204,7 @@ to render with which payload.
#### Defined in
-[lib/actions.ts:1](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L1)
+[lib/actions.ts:1](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L1)
***
@@ -216,7 +216,7 @@ to render with which payload.
#### Defined in
-[lib/actions.ts:2](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L2)
+[lib/actions.ts:2](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L2)
***
@@ -228,7 +228,7 @@ to render with which payload.
#### Defined in
-[lib/actions.ts:3](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L3)
+[lib/actions.ts:3](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L3)
***
@@ -240,7 +240,7 @@ to render with which payload.
#### Defined in
-[lib/actions.ts:5](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L5)
+[lib/actions.ts:5](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L5)
***
@@ -252,7 +252,7 @@ to render with which payload.
#### Defined in
-[lib/actions.ts:9](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L9)
+[lib/actions.ts:9](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L9)
***
@@ -264,7 +264,7 @@ to render with which payload.
#### Defined in
-[lib/actions.ts:10](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L10)
+[lib/actions.ts:10](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L10)
***
@@ -276,7 +276,7 @@ to render with which payload.
#### Defined in
-[lib/actions.ts:12](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L12)
+[lib/actions.ts:12](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L12)
***
@@ -288,7 +288,7 @@ to render with which payload.
#### Defined in
-[lib/actions.ts:14](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L14)
+[lib/actions.ts:14](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L14)
***
@@ -300,7 +300,7 @@ to render with which payload.
#### Defined in
-[lib/actions.ts:15](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L15)
+[lib/actions.ts:15](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L15)
***
@@ -312,7 +312,7 @@ to render with which payload.
#### Defined in
-[lib/actions.ts:16](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L16)
+[lib/actions.ts:16](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L16)
## Functions
@@ -358,7 +358,7 @@ A middleware that will update all Fragment across the AllPages slice, if a fragm
#### Defined in
-[lib/middleware.ts:15](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/middleware.ts#L15)
+[lib/middleware.ts:15](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/middleware.ts#L15)
***
@@ -383,7 +383,7 @@ Retrieves data from a JSON object using a [Keypath](types.md#keypath-2)
#### Defined in
-[lib/utils/immutability.ts:22](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/utils/immutability.ts#L22)
+[lib/utils/immutability.ts:22](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/utils/immutability.ts#L22)
***
@@ -407,4 +407,4 @@ Converts a url to a PageKey.
#### Defined in
-[lib/utils/url.ts:57](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/utils/url.ts#L57)
+[lib/utils/url.ts:57](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/utils/url.ts#L57)
diff --git a/docs/reference/types.md b/docs/reference/types.md
index 95adda7c..a8730d92 100644
--- a/docs/reference/types.md
+++ b/docs/reference/types.md
@@ -44,10 +44,10 @@ Re-exports [BeforeSave](types.requests.md#beforesave-2)
| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
-| `type` | `"@@superglue/SAVE_RESPONSE"` | `Action.type` | [lib/types/actions.ts:6](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L6) |
-| `payload` | \{`pageKey`: `string`;`page`: [`VisitResponse`](types.md#visitresponse); \} | - | [lib/types/actions.ts:7](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L7) |
-| `payload.pageKey` | `string` | - | [lib/types/actions.ts:8](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L8) |
-| `payload.page` | [`VisitResponse`](types.md#visitresponse) | - | [lib/types/actions.ts:9](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L9) |
+| `type` | `"@@superglue/SAVE_RESPONSE"` | `Action.type` | [lib/types/actions.ts:6](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L6) |
+| `payload` | \{`pageKey`: `string`;`page`: [`VisitResponse`](types.md#visitresponse); \} | - | [lib/types/actions.ts:7](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L7) |
+| `payload.pageKey` | `string` | - | [lib/types/actions.ts:8](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L8) |
+| `payload.page` | [`VisitResponse`](types.md#visitresponse) | - | [lib/types/actions.ts:9](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L9) |
***
@@ -63,10 +63,10 @@ Re-exports [BeforeSave](types.requests.md#beforesave-2)
| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
-| `type` | `"@@superglue/HANDLE_GRAFT"` | `Action.type` | [lib/types/actions.ts:14](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L14) |
-| `payload` | \{`pageKey`: `string`;`page`: [`GraftResponse`](types.md#graftresponse); \} | - | [lib/types/actions.ts:15](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L15) |
-| `payload.pageKey` | `string` | - | [lib/types/actions.ts:16](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L16) |
-| `payload.page` | [`GraftResponse`](types.md#graftresponse) | - | [lib/types/actions.ts:17](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L17) |
+| `type` | `"@@superglue/HANDLE_GRAFT"` | `Action.type` | [lib/types/actions.ts:14](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L14) |
+| `payload` | \{`pageKey`: `string`;`page`: [`GraftResponse`](types.md#graftresponse); \} | - | [lib/types/actions.ts:15](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L15) |
+| `payload.pageKey` | `string` | - | [lib/types/actions.ts:16](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L16) |
+| `payload.page` | [`GraftResponse`](types.md#graftresponse) | - | [lib/types/actions.ts:17](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L17) |
***
@@ -82,10 +82,10 @@ Re-exports [BeforeSave](types.requests.md#beforesave-2)
| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
-| `type` | `"@@superglue/COPY_PAGE"` | `Action.type` | [lib/types/actions.ts:22](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L22) |
-| `payload` | \{`from`: `string`;`to`: `string`; \} | - | [lib/types/actions.ts:23](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L23) |
-| `payload.from` | `string` | - | [lib/types/actions.ts:24](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L24) |
-| `payload.to` | `string` | - | [lib/types/actions.ts:25](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L25) |
+| `type` | `"@@superglue/COPY_PAGE"` | `Action.type` | [lib/types/actions.ts:22](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L22) |
+| `payload` | \{`from`: `string`;`to`: `string`; \} | - | [lib/types/actions.ts:23](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L23) |
+| `payload.from` | `string` | - | [lib/types/actions.ts:24](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L24) |
+| `payload.to` | `string` | - | [lib/types/actions.ts:25](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L25) |
***
@@ -101,9 +101,9 @@ Re-exports [BeforeSave](types.requests.md#beforesave-2)
| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
-| `type` | `"@@superglue/REMOVE_PAGE"` | `Action.type` | [lib/types/actions.ts:30](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L30) |
-| `payload` | \{`pageKey`: `string`; \} | - | [lib/types/actions.ts:31](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L31) |
-| `payload.pageKey` | `string` | - | [lib/types/actions.ts:32](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L32) |
+| `type` | `"@@superglue/REMOVE_PAGE"` | `Action.type` | [lib/types/actions.ts:30](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L30) |
+| `payload` | \{`pageKey`: `string`; \} | - | [lib/types/actions.ts:31](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L31) |
+| `payload.pageKey` | `string` | - | [lib/types/actions.ts:32](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L32) |
***
@@ -119,9 +119,9 @@ Re-exports [BeforeSave](types.requests.md#beforesave-2)
| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
-| `type` | `"@@superglue/UPDATE_FRAGMENTS"` | `Action.type` | [lib/types/actions.ts:37](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L37) |
-| `payload` | \{`changedFragments`: `Record`\<`string`, `unknown`\>; \} | - | [lib/types/actions.ts:38](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L38) |
-| `payload.changedFragments` | `Record`\<`string`, `unknown`\> | - | [lib/types/actions.ts:39](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L39) |
+| `type` | `"@@superglue/UPDATE_FRAGMENTS"` | `Action.type` | [lib/types/actions.ts:37](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L37) |
+| `payload` | \{`changedFragments`: `Record`\<`string`, `unknown`\>; \} | - | [lib/types/actions.ts:38](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L38) |
+| `payload.changedFragments` | `Record`\<`string`, `unknown`\> | - | [lib/types/actions.ts:39](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L39) |
***
@@ -137,9 +137,9 @@ Re-exports [BeforeSave](types.requests.md#beforesave-2)
| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
-| `type` | `"@@superglue/SET_CSRF_TOKEN"` | `Action.type` | [lib/types/actions.ts:44](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L44) |
-| `payload` | \{`csrfToken`: `string`; \} | - | [lib/types/actions.ts:45](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L45) |
-| `payload.csrfToken` | `string` | - | [lib/types/actions.ts:46](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L46) |
+| `type` | `"@@superglue/SET_CSRF_TOKEN"` | `Action.type` | [lib/types/actions.ts:44](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L44) |
+| `payload` | \{`csrfToken`: `string`; \} | - | [lib/types/actions.ts:45](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L45) |
+| `payload.csrfToken` | `string` | - | [lib/types/actions.ts:46](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L46) |
***
@@ -155,11 +155,11 @@ Re-exports [BeforeSave](types.requests.md#beforesave-2)
| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
-| `type` | `"@@superglue/HISTORY_CHANGE"` | `Action.type` | [lib/types/actions.ts:51](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L51) |
-| `payload` | \{`pathname`: `string`;`search`: `string`;`hash`: `string`; \} | - | [lib/types/actions.ts:52](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L52) |
-| `payload.pathname` | `string` | - | [lib/types/actions.ts:53](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L53) |
-| `payload.search` | `string` | - | [lib/types/actions.ts:54](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L54) |
-| `payload.hash` | `string` | - | [lib/types/actions.ts:55](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L55) |
+| `type` | `"@@superglue/HISTORY_CHANGE"` | `Action.type` | [lib/types/actions.ts:51](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L51) |
+| `payload` | \{`pathname`: `string`;`search`: `string`;`hash`: `string`; \} | - | [lib/types/actions.ts:52](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L52) |
+| `payload.pathname` | `string` | - | [lib/types/actions.ts:53](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L53) |
+| `payload.search` | `string` | - | [lib/types/actions.ts:54](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L54) |
+| `payload.hash` | `string` | - | [lib/types/actions.ts:55](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L55) |
***
@@ -175,10 +175,10 @@ Re-exports [BeforeSave](types.requests.md#beforesave-2)
| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
-| `type` | `"@@superglue/BEFORE_VISIT"` | `Action.type` | [lib/types/actions.ts:65](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L65) |
-| `payload` | \{`fetchArgs`: [`string`, [`BasicRequestInit`](types.md#basicrequestinit)];`currentPageKey`: `string`; \} | - | [lib/types/actions.ts:66](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L66) |
-| `payload.fetchArgs` | [`string`, [`BasicRequestInit`](types.md#basicrequestinit)] | - | [lib/types/actions.ts:67](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L67) |
-| `payload.currentPageKey` | `string` | - | [lib/types/actions.ts:68](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L68) |
+| `type` | `"@@superglue/BEFORE_VISIT"` | `Action.type` | [lib/types/actions.ts:65](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L65) |
+| `payload` | \{`fetchArgs`: [`string`, [`BasicRequestInit`](types.md#basicrequestinit)];`currentPageKey`: `string`; \} | - | [lib/types/actions.ts:66](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L66) |
+| `payload.fetchArgs` | [`string`, [`BasicRequestInit`](types.md#basicrequestinit)] | - | [lib/types/actions.ts:67](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L67) |
+| `payload.currentPageKey` | `string` | - | [lib/types/actions.ts:68](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L68) |
***
@@ -194,10 +194,10 @@ Re-exports [BeforeSave](types.requests.md#beforesave-2)
| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
-| `type` | `"@@superglue/BEFORE_REMOTE"` | `Action.type` | [lib/types/actions.ts:73](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L73) |
-| `payload` | \{`fetchArgs`: [`string`, [`BasicRequestInit`](types.md#basicrequestinit)];`currentPageKey`: `string`; \} | - | [lib/types/actions.ts:74](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L74) |
-| `payload.fetchArgs` | [`string`, [`BasicRequestInit`](types.md#basicrequestinit)] | - | [lib/types/actions.ts:75](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L75) |
-| `payload.currentPageKey` | `string` | - | [lib/types/actions.ts:76](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L76) |
+| `type` | `"@@superglue/BEFORE_REMOTE"` | `Action.type` | [lib/types/actions.ts:73](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L73) |
+| `payload` | \{`fetchArgs`: [`string`, [`BasicRequestInit`](types.md#basicrequestinit)];`currentPageKey`: `string`; \} | - | [lib/types/actions.ts:74](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L74) |
+| `payload.fetchArgs` | [`string`, [`BasicRequestInit`](types.md#basicrequestinit)] | - | [lib/types/actions.ts:75](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L75) |
+| `payload.currentPageKey` | `string` | - | [lib/types/actions.ts:76](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L76) |
***
@@ -213,9 +213,9 @@ Re-exports [BeforeSave](types.requests.md#beforesave-2)
| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
-| `type` | `"@@superglue/BEFORE_FETCH"` | `Action.type` | [lib/types/actions.ts:81](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L81) |
-| `payload` | \{`fetchArgs`: [`string`, [`BasicRequestInit`](types.md#basicrequestinit)]; \} | - | [lib/types/actions.ts:82](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L82) |
-| `payload.fetchArgs` | [`string`, [`BasicRequestInit`](types.md#basicrequestinit)] | - | [lib/types/actions.ts:83](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L83) |
+| `type` | `"@@superglue/BEFORE_FETCH"` | `Action.type` | [lib/types/actions.ts:81](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L81) |
+| `payload` | \{`fetchArgs`: [`string`, [`BasicRequestInit`](types.md#basicrequestinit)]; \} | - | [lib/types/actions.ts:82](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L82) |
+| `payload.fetchArgs` | [`string`, [`BasicRequestInit`](types.md#basicrequestinit)] | - | [lib/types/actions.ts:83](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L83) |
***
@@ -231,9 +231,9 @@ Re-exports [BeforeSave](types.requests.md#beforesave-2)
| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
-| `type` | `"@@superglue/ERROR"` | `Action.type` | [lib/types/actions.ts:88](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L88) |
-| `payload` | \{`message`: `string`; \} | - | [lib/types/actions.ts:89](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L89) |
-| `payload.message` | `string` | - | [lib/types/actions.ts:90](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L90) |
+| `type` | `"@@superglue/ERROR"` | `Action.type` | [lib/types/actions.ts:88](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L88) |
+| `payload` | \{`message`: `string`; \} | - | [lib/types/actions.ts:89](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L89) |
+| `payload.message` | `string` | - | [lib/types/actions.ts:90](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L90) |
***
@@ -249,10 +249,10 @@ Re-exports [BeforeSave](types.requests.md#beforesave-2)
| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
-| `type` | `string` | `Action.type` | [lib/types/actions.ts:97](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L97) |
-| `payload` | \{`pageKey`: `string`;`keyPath`: `string`; \} | - | [lib/types/actions.ts:98](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L98) |
-| `payload.pageKey` | `string` | - | [lib/types/actions.ts:99](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L99) |
-| `payload.keyPath` | `string` | - | [lib/types/actions.ts:100](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L100) |
+| `type` | `string` | `Action.type` | [lib/types/actions.ts:97](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L97) |
+| `payload` | \{`pageKey`: `string`;`keyPath`: `string`; \} | - | [lib/types/actions.ts:98](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L98) |
+| `payload.pageKey` | `string` | - | [lib/types/actions.ts:99](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L99) |
+| `payload.keyPath` | `string` | - | [lib/types/actions.ts:100](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L100) |
***
@@ -268,12 +268,12 @@ Re-exports [BeforeSave](types.requests.md#beforesave-2)
| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
-| `type` | `string` | `Action.type` | [lib/types/actions.ts:105](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L105) |
-| `payload` | \{`pageKey`: `string`;`url`: `string`;`err`: `unknown`;`keyPath`: `string`; \} | - | [lib/types/actions.ts:106](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L106) |
-| `payload.pageKey` | `string` | - | [lib/types/actions.ts:107](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L107) |
-| `payload.url` | `string` | - | [lib/types/actions.ts:108](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L108) |
-| `payload.err` | `unknown` | - | [lib/types/actions.ts:109](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L109) |
-| `payload.keyPath` | `string` | - | [lib/types/actions.ts:110](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L110) |
+| `type` | `string` | `Action.type` | [lib/types/actions.ts:105](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L105) |
+| `payload` | \{`pageKey`: `string`;`url`: `string`;`err`: `unknown`;`keyPath`: `string`; \} | - | [lib/types/actions.ts:106](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L106) |
+| `payload.pageKey` | `string` | - | [lib/types/actions.ts:107](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L107) |
+| `payload.url` | `string` | - | [lib/types/actions.ts:108](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L108) |
+| `payload.err` | `unknown` | - | [lib/types/actions.ts:109](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L109) |
+| `payload.keyPath` | `string` | - | [lib/types/actions.ts:110](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L110) |
***
@@ -285,8 +285,8 @@ Re-exports [BeforeSave](types.requests.md#beforesave-2)
| Property | Type | Defined in |
| ------ | ------ | ------ |
-| `rsp` | `Response` | [lib/types/index.ts:106](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L106) |
-| `json` | [`PageResponse`](types.md#pageresponse) | [lib/types/index.ts:107](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L107) |
+| `rsp` | `Response` | [lib/types/index.ts:106](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L106) |
+| `json` | [`PageResponse`](types.md#pageresponse) | [lib/types/index.ts:107](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L107) |
***
@@ -304,11 +304,11 @@ know would be slower to load.
| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
-| `url` | `string` | A url with props_at keypath in the query parameter to indicate how to dig for the data, and where to place the data. | [lib/types/index.ts:132](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L132) |
-| `type` | `"auto"` \| `"manual"` | When set to `auto` Superglue will automatically make the request using the `url`. When set to `manual`, Superglue does nothing, and you would need to manually use `remote` with the `url` to fetch the missing data. | [lib/types/index.ts:133](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L133) |
-| `path` | `string` | A keypath indicates how to dig for the data and where to place the data. | [lib/types/index.ts:134](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L134) |
-| `successAction` | `string` | a user defined action for Superglue to dispatch when auto deferement is successful | [lib/types/index.ts:135](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L135) |
-| `failAction` | `string` | a user defined action for Superglue to dispatch when auto deferement failed | [lib/types/index.ts:136](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L136) |
+| `url` | `string` | A url with props_at keypath in the query parameter to indicate how to dig for the data, and where to place the data. | [lib/types/index.ts:132](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L132) |
+| `type` | `"auto"` \| `"manual"` | When set to `auto` Superglue will automatically make the request using the `url`. When set to `manual`, Superglue does nothing, and you would need to manually use `remote` with the `url` to fetch the missing data. | [lib/types/index.ts:133](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L133) |
+| `path` | `string` | A keypath indicates how to dig for the data and where to place the data. | [lib/types/index.ts:134](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L134) |
+| `successAction` | `string` | a user defined action for Superglue to dispatch when auto deferement is successful | [lib/types/index.ts:135](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L135) |
+| `failAction` | `string` | a user defined action for Superglue to dispatch when auto deferement failed | [lib/types/index.ts:136](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L136) |
***
@@ -326,17 +326,17 @@ shape the graft responses for you.
| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
-| `data` | [`JSONMappable`](types.md#jsonmappable) | - | [lib/types/index.ts:146](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L146) |
-| `componentIdentifier` | `string` | - | [lib/types/index.ts:147](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L147) |
-| `assets` | `string`[] | - | [lib/types/index.ts:148](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L148) |
-| `csrfToken?` | `string` | - | [lib/types/index.ts:149](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L149) |
-| `fragments` | [`Fragment`](types.md#fragment)[] | - | [lib/types/index.ts:150](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L150) |
-| `defers` | [`Defer`](types.md#defer)[] | - | [lib/types/index.ts:151](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L151) |
-| `slices` | [`JSONObject`](types.md#jsonobject) | - | [lib/types/index.ts:152](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L152) |
-| `renderedAt` | `number` | - | [lib/types/index.ts:154](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L154) |
-| `restoreStrategy` | [`RestoreStrategy`](types.md#restorestrategy-1) | - | [lib/types/index.ts:155](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L155) |
-| `action` | `"graft"` | - | [lib/types/index.ts:178](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L178) |
-| `path` | `string` | Used by superglue to replace the data at that location. | [lib/types/index.ts:179](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L179) |
+| `data` | [`JSONMappable`](types.md#jsonmappable) | - | [lib/types/index.ts:146](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L146) |
+| `componentIdentifier` | `string` | - | [lib/types/index.ts:147](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L147) |
+| `assets` | `string`[] | - | [lib/types/index.ts:148](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L148) |
+| `csrfToken?` | `string` | - | [lib/types/index.ts:149](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L149) |
+| `fragments` | [`Fragment`](types.md#fragment)[] | - | [lib/types/index.ts:150](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L150) |
+| `defers` | [`Defer`](types.md#defer)[] | - | [lib/types/index.ts:151](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L151) |
+| `slices` | [`JSONObject`](types.md#jsonobject) | - | [lib/types/index.ts:152](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L152) |
+| `renderedAt` | `number` | - | [lib/types/index.ts:154](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L154) |
+| `restoreStrategy` | [`RestoreStrategy`](types.md#restorestrategy-1) | - | [lib/types/index.ts:155](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L155) |
+| `action` | `"graft"` | - | [lib/types/index.ts:178](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L178) |
+| `path` | `string` | Used by superglue to replace the data at that location. | [lib/types/index.ts:179](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L179) |
***
@@ -350,8 +350,8 @@ A Fragment identifies a cross cutting concern, like a shared header or footer.
| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
-| `type` | `string` | A user supplied string identifying a fragment. This is usually created using [props_template](https://github.com/thoughtbot/props_template?tab=readme-ov-file#jsonfragments) | [lib/types/index.ts:197](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L197) |
-| `path` | `string` | A Keypath specifying the location of the fragment | [lib/types/index.ts:198](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L198) |
+| `type` | `string` | A user supplied string identifying a fragment. This is usually created using [props_template](https://github.com/thoughtbot/props_template?tab=readme-ov-file#jsonfragments) | [lib/types/index.ts:197](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L197) |
+| `path` | `string` | A Keypath specifying the location of the fragment | [lib/types/index.ts:198](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L198) |
***
@@ -366,12 +366,12 @@ the current page.
| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
-| `currentPageKey` | `string` | The [PageKey](types.md#pagekey-8) of the current page. This can be pass to [Remote](types.requests.md#remote). | [lib/types/index.ts:213](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L213) |
-| `pathname` | `string` | The pathname of the current url. | [lib/types/index.ts:215](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L215) |
-| `search` | `string` | The query string of the current url. | [lib/types/index.ts:217](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L217) |
-| `hash` | `string` | The hash of the current url. | [lib/types/index.ts:219](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L219) |
-| `csrfToken` | `string` | The Rails csrfToken that you can use for forms. | [lib/types/index.ts:221](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L221) |
-| `assets` | `string`[] | The tracked asset digests. | [lib/types/index.ts:223](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L223) |
+| `currentPageKey` | `string` | The [PageKey](types.md#pagekey-8) of the current page. This can be pass to [Remote](types.requests.md#remote). | [lib/types/index.ts:213](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L213) |
+| `pathname` | `string` | The pathname of the current url. | [lib/types/index.ts:215](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L215) |
+| `search` | `string` | The query string of the current url. | [lib/types/index.ts:217](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L217) |
+| `hash` | `string` | The hash of the current url. | [lib/types/index.ts:219](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L219) |
+| `csrfToken` | `string` | The Rails csrfToken that you can use for forms. | [lib/types/index.ts:221](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L221) |
+| `assets` | `string`[] | The tracked asset digests. | [lib/types/index.ts:223](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L223) |
***
@@ -386,8 +386,8 @@ The root state for a Superglue application. It occupies
| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
-| `superglue` | [`SuperglueState`](types.md#supergluestate) | Caontain readonly metadata about the current page | [lib/types/index.ts:232](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L232) |
-| `pages` | [`AllPages`](types.md#allpages) | Every [PageResponse](types.md#pageresponse) that superglue recieves is stored here. | [lib/types/index.ts:234](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L234) |
+| `superglue` | [`SuperglueState`](types.md#supergluestate) | Caontain readonly metadata about the current page | [lib/types/index.ts:232](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L232) |
+| `pages` | [`AllPages`](types.md#allpages) | Every [PageResponse](types.md#pageresponse) that superglue recieves is stored here. | [lib/types/index.ts:234](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L234) |
***
@@ -401,10 +401,10 @@ Helpful props passed to the page component.
| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
-| `pageKey` | `string` | the pagekey of the current page | [lib/types/index.ts:242](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L242) |
-| `navigateTo` | (`path`: `string`, `options`: \{`action`: [`SuggestedAction`](types.md#suggestedaction-1);`ownProps`: `Record`\<`string`, `unknown`\>; \}) => `boolean` | - | [lib/types/index.ts:243](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L243) |
-| `visit` | [`Visit`](types.requests.md#visit) | - | [lib/types/index.ts:244](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L244) |
-| `remote` | [`Remote`](types.requests.md#remote) | - | [lib/types/index.ts:245](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L245) |
+| `pageKey` | `string` | the pagekey of the current page | [lib/types/index.ts:242](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L242) |
+| `navigateTo` | (`path`: `string`, `options`: \{`action`: [`SuggestedAction`](types.md#suggestedaction-1);`ownProps`: `Record`\<`string`, `unknown`\>; \}) => `boolean` | - | [lib/types/index.ts:243](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L243) |
+| `visit` | [`Visit`](types.requests.md#visit) | - | [lib/types/index.ts:244](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L244) |
+| `remote` | [`Remote`](types.requests.md#remote) | - | [lib/types/index.ts:245](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L245) |
***
@@ -420,14 +420,14 @@ navigation.
| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
-| `pageKey` | `string` | The URL of the response converted to a pageKey. Superglue uses this to persist the [VisitResponse](types.md#visitresponse) to store, when that happens. | [lib/types/index.ts:269](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L269) |
-| `page` | [`VisitResponse`](types.md#visitresponse) | The [VisitResponse](types.md#visitresponse) of the page | [lib/types/index.ts:271](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L271) |
-| `redirected` | `boolean` | Indicates if response was redirected | [lib/types/index.ts:273](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L273) |
-| `rsp` | `Response` | The original response object | [lib/types/index.ts:275](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L275) |
-| `fetchArgs` | [`FetchArgs`](types.md#fetchargs-4) | The original args passed to fetch. | [lib/types/index.ts:277](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L277) |
-| `componentIdentifier` | `string` | The [ComponentIdentifier](types.md#componentidentifier-2) extracted from the response. | [lib/types/index.ts:279](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L279) |
-| `needsRefresh` | `boolean` | `true` when assets locally are detected to be out of date | [lib/types/index.ts:281](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L281) |
-| `suggestedAction?` | [`SuggestedAction`](types.md#suggestedaction-1) | The [SuggestedAction](types.md#suggestedaction-1). This can be used for navigation. | [lib/types/index.ts:283](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L283) |
+| `pageKey` | `string` | The URL of the response converted to a pageKey. Superglue uses this to persist the [VisitResponse](types.md#visitresponse) to store, when that happens. | [lib/types/index.ts:269](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L269) |
+| `page` | [`VisitResponse`](types.md#visitresponse) | The [VisitResponse](types.md#visitresponse) of the page | [lib/types/index.ts:271](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L271) |
+| `redirected` | `boolean` | Indicates if response was redirected | [lib/types/index.ts:273](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L273) |
+| `rsp` | `Response` | The original response object | [lib/types/index.ts:275](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L275) |
+| `fetchArgs` | [`FetchArgs`](types.md#fetchargs-4) | The original args passed to fetch. | [lib/types/index.ts:277](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L277) |
+| `componentIdentifier` | `string` | The [ComponentIdentifier](types.md#componentidentifier-2) extracted from the response. | [lib/types/index.ts:279](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L279) |
+| `needsRefresh` | `boolean` | `true` when assets locally are detected to be out of date | [lib/types/index.ts:281](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L281) |
+| `suggestedAction?` | [`SuggestedAction`](types.md#suggestedaction-1) | The [SuggestedAction](types.md#suggestedaction-1). This can be used for navigation. | [lib/types/index.ts:283](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L283) |
***
@@ -439,8 +439,8 @@ navigation.
| Property | Type | Defined in |
| ------ | ------ | ------ |
-| `onClick` | (`event`: `MouseEvent`) => `void` | [lib/types/index.ts:327](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L327) |
-| `onSubmit` | (`event`: `Event`) => `void` | [lib/types/index.ts:328](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L328) |
+| `onClick` | (`event`: `MouseEvent`) => `void` | [lib/types/index.ts:327](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L327) |
+| `onSubmit` | (`event`: `Event`) => `void` | [lib/types/index.ts:328](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L328) |
***
@@ -456,10 +456,10 @@ the page state when navigating back
| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
-| `superglue` | `true` | Is always `true` so superglue can differentiate pages that have superglue enabled or not | [lib/types/index.ts:348](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L348) |
-| `pageKey` | `string` | The page key in [SuperglueState](types.md#supergluestate) to restore from | [lib/types/index.ts:350](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L350) |
-| `posX` | `number` | The scroll position X of the page | [lib/types/index.ts:352](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L352) |
-| `posY` | `number` | The scroll position Y of the page | [lib/types/index.ts:354](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L354) |
+| `superglue` | `true` | Is always `true` so superglue can differentiate pages that have superglue enabled or not | [lib/types/index.ts:348](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L348) |
+| `pageKey` | `string` | The page key in [SuperglueState](types.md#supergluestate) to restore from | [lib/types/index.ts:350](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L350) |
+| `posX` | `number` | The scroll position X of the page | [lib/types/index.ts:352](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L352) |
+| `posY` | `number` | The scroll position Y of the page | [lib/types/index.ts:354](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L354) |
***
@@ -477,7 +477,7 @@ A variation of RequestInit except the headers must be a regular object
| Property | Type | Description | Overrides | Defined in |
| ------ | ------ | ------ | ------ | ------ |
-| `headers?` | \{\} | A Headers object, an object literal, or an array of two-item arrays to set request's headers. | `RequestInit.headers` | [lib/types/index.ts:380](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L380) |
+| `headers?` | \{\} | A Headers object, an object literal, or an array of two-item arrays to set request's headers. | `RequestInit.headers` | [lib/types/index.ts:380](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L380) |
## Type Aliases
@@ -491,7 +491,7 @@ Tuple of Fetch arguments that Superglue passes to Fetch.
#### Defined in
-[lib/types/actions.ts:62](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L62)
+[lib/types/actions.ts:62](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L62)
***
@@ -503,7 +503,7 @@ Tuple of Fetch arguments that Superglue passes to Fetch.
#### Defined in
-[lib/types/actions.ts:114](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L114)
+[lib/types/actions.ts:114](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L114)
***
@@ -515,7 +515,7 @@ Tuple of Fetch arguments that Superglue passes to Fetch.
#### Defined in
-[lib/types/actions.ts:120](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L120)
+[lib/types/actions.ts:120](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L120)
***
@@ -527,7 +527,7 @@ Tuple of Fetch arguments that Superglue passes to Fetch.
#### Defined in
-[lib/types/actions.ts:129](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L129)
+[lib/types/actions.ts:129](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L129)
***
@@ -539,7 +539,7 @@ Tuple of Fetch arguments that Superglue passes to Fetch.
#### Defined in
-[lib/types/actions.ts:134](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/actions.ts#L134)
+[lib/types/actions.ts:134](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/actions.ts#L134)
***
@@ -561,7 +561,7 @@ A PageKey is a combination of a parsed URL's pathname + query string. No hash.
#### Defined in
-[lib/types/index.ts:19](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L19)
+[lib/types/index.ts:19](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L19)
***
@@ -583,7 +583,7 @@ When the page already exists in the store:
#### Defined in
-[lib/types/index.ts:32](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L32)
+[lib/types/index.ts:32](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L32)
***
@@ -598,7 +598,7 @@ or do nothing.
#### Defined in
-[lib/types/index.ts:41](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L41)
+[lib/types/index.ts:41](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L41)
***
@@ -610,7 +610,7 @@ or do nothing.
#### Defined in
-[lib/types/index.ts:42](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L42)
+[lib/types/index.ts:42](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L42)
***
@@ -625,7 +625,7 @@ with your page response.
#### Defined in
-[lib/types/index.ts:48](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L48)
+[lib/types/index.ts:48](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L48)
***
@@ -657,7 +657,7 @@ data.body.posts.post_id=foobar.title
#### Defined in
-[lib/types/index.ts:72](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L72)
+[lib/types/index.ts:72](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L72)
***
@@ -671,7 +671,7 @@ A JSON Primitive value
#### Defined in
-[lib/types/index.ts:79](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L79)
+[lib/types/index.ts:79](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L79)
***
@@ -689,7 +689,7 @@ A JSON Object
#### Defined in
-[lib/types/index.ts:84](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L84)
+[lib/types/index.ts:84](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L84)
***
@@ -703,7 +703,7 @@ A JSON Object or an array of values
#### Defined in
-[lib/types/index.ts:91](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L91)
+[lib/types/index.ts:91](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L91)
***
@@ -717,7 +717,7 @@ A array of JSON key value objects or a JSON Object
#### Defined in
-[lib/types/index.ts:96](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L96)
+[lib/types/index.ts:96](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L96)
***
@@ -731,7 +731,7 @@ A primitive or a mappable object
#### Defined in
-[lib/types/index.ts:101](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L101)
+[lib/types/index.ts:101](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L101)
***
@@ -750,19 +750,19 @@ layout and view that would shape the visit responses for you.
| Name | Type | Defined in |
| ------ | ------ | ------ |
-| `data` | [`JSONMappable`](types.md#jsonmappable) | [lib/types/index.ts:146](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L146) |
-| `componentIdentifier` | [`ComponentIdentifier`](types.md#componentidentifier-2) | [lib/types/index.ts:147](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L147) |
-| `assets` | `string`[] | [lib/types/index.ts:148](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L148) |
-| `csrfToken`? | `string` | [lib/types/index.ts:149](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L149) |
-| `fragments` | [`Fragment`](types.md#fragment)[] | [lib/types/index.ts:150](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L150) |
-| `defers` | [`Defer`](types.md#defer)[] | [lib/types/index.ts:151](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L151) |
-| `slices` | [`JSONObject`](types.md#jsonobject) | [lib/types/index.ts:152](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L152) |
-| `renderedAt` | `number` | [lib/types/index.ts:154](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L154) |
-| `restoreStrategy` | [`RestoreStrategy`](types.md#restorestrategy-1) | [lib/types/index.ts:155](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L155) |
+| `data` | [`JSONMappable`](types.md#jsonmappable) | [lib/types/index.ts:146](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L146) |
+| `componentIdentifier` | [`ComponentIdentifier`](types.md#componentidentifier-2) | [lib/types/index.ts:147](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L147) |
+| `assets` | `string`[] | [lib/types/index.ts:148](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L148) |
+| `csrfToken`? | `string` | [lib/types/index.ts:149](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L149) |
+| `fragments` | [`Fragment`](types.md#fragment)[] | [lib/types/index.ts:150](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L150) |
+| `defers` | [`Defer`](types.md#defer)[] | [lib/types/index.ts:151](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L151) |
+| `slices` | [`JSONObject`](types.md#jsonobject) | [lib/types/index.ts:152](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L152) |
+| `renderedAt` | `number` | [lib/types/index.ts:154](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L154) |
+| `restoreStrategy` | [`RestoreStrategy`](types.md#restorestrategy-1) | [lib/types/index.ts:155](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L155) |
#### Defined in
-[lib/types/index.ts:145](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L145)
+[lib/types/index.ts:145](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L145)
***
@@ -778,12 +778,12 @@ A Page is a VisitResponse that's been saved to the store
| Name | Type | Defined in |
| ------ | ------ | ------ |
-| `savedAt` | `number` | [lib/types/index.ts:162](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L162) |
-| `pageKey` | [`PageKey`](types.md#pagekey-8) | [lib/types/index.ts:163](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L163) |
+| `savedAt` | `number` | [lib/types/index.ts:162](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L162) |
+| `pageKey` | [`PageKey`](types.md#pagekey-8) | [lib/types/index.ts:163](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L163) |
#### Defined in
-[lib/types/index.ts:161](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L161)
+[lib/types/index.ts:161](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L161)
***
@@ -799,7 +799,7 @@ superglue_rails, the generators will handle both cases.
#### Defined in
-[lib/types/index.ts:187](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L187)
+[lib/types/index.ts:187](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L187)
***
@@ -814,7 +814,7 @@ to mutate the Pages in this store.
#### Defined in
-[lib/types/index.ts:205](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L205)
+[lib/types/index.ts:205](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L205)
***
@@ -831,13 +831,13 @@ helpers
| Name | Type | Defined in |
| ------ | ------ | ------ |
-| `pageKey` | [`PageKey`](types.md#pagekey-8) | [lib/types/index.ts:253](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L253) |
-| `fragments` | [`Fragment`](types.md#fragment)[] | [lib/types/index.ts:254](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L254) |
-| `csrfToken`? | `string` | [lib/types/index.ts:255](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L255) |
+| `pageKey` | [`PageKey`](types.md#pagekey-8) | [lib/types/index.ts:253](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L253) |
+| `fragments` | [`Fragment`](types.md#fragment)[] | [lib/types/index.ts:254](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L254) |
+| `csrfToken`? | `string` | [lib/types/index.ts:255](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L255) |
#### Defined in
-[lib/types/index.ts:252](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L252)
+[lib/types/index.ts:252](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L252)
***
@@ -863,7 +863,7 @@ the [Visit](types.requests.md#visit) function. Typically its already generated i
#### Defined in
-[lib/types/index.ts:292](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L292)
+[lib/types/index.ts:292](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L292)
***
@@ -889,7 +889,7 @@ the [Remote](types.requests.md#remote) function. Typically its already generated
#### Defined in
-[lib/types/index.ts:301](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L301)
+[lib/types/index.ts:301](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L301)
***
@@ -901,7 +901,7 @@ the [Remote](types.requests.md#remote) function. Typically its already generated
#### Defined in
-[lib/types/index.ts:306](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L306)
+[lib/types/index.ts:306](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L306)
***
@@ -917,7 +917,7 @@ generated for you in `store.js` and setup correctly in application.js
#### Defined in
-[lib/types/index.ts:313](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L313)
+[lib/types/index.ts:313](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L313)
***
@@ -946,7 +946,7 @@ generated for you in `store.js` and setup correctly in application.js
#### Defined in
-[lib/types/index.ts:331](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L331)
+[lib/types/index.ts:331](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L331)
***
@@ -958,7 +958,7 @@ generated for you in `store.js` and setup correctly in application.js
#### Defined in
-[lib/types/index.ts:357](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L357)
+[lib/types/index.ts:357](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L357)
***
@@ -970,7 +970,7 @@ generated for you in `store.js` and setup correctly in application.js
#### Defined in
-[lib/types/index.ts:364](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L364)
+[lib/types/index.ts:364](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L364)
***
@@ -982,4 +982,4 @@ generated for you in `store.js` and setup correctly in application.js
#### Defined in
-[lib/types/index.ts:371](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/index.ts#L371)
+[lib/types/index.ts:371](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/index.ts#L371)
diff --git a/docs/reference/types.requests.md b/docs/reference/types.requests.md
index 2a9b3287..9cfc8d32 100644
--- a/docs/reference/types.requests.md
+++ b/docs/reference/types.requests.md
@@ -33,7 +33,7 @@ it for UJS navigation. This is usually generated for you in
#### Defined in
-[lib/types/requests.ts:22](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/requests.ts#L22)
+[lib/types/requests.ts:22](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/requests.ts#L22)
***
@@ -51,12 +51,12 @@ Options for Visit
| Property | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
-| `placeholderKey?` | `string` | When present, Superglue will use the page state located at that pageKey and optimistally navigates to it as the next page's state while the requests resolves. | - | [lib/types/requests.ts:36](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/requests.ts#L36) |
-| `revisit?` | `boolean` | When `true` and the request method is a GET, changes the `suggestionAction` of the Meta object to `none` so that Superglue does nothing to window.history. When the GET response was redirected, changes `suggestedAction` to `replace` | - | [lib/types/requests.ts:43](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/requests.ts#L43) |
-| `method?` | `string` | The HTTP method | `BaseProps.method` | [lib/types/requests.ts:67](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/requests.ts#L67) |
-| `body?` | `BodyInit` | The HTTP body | `BaseProps.body` | [lib/types/requests.ts:69](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/requests.ts#L69) |
-| `headers?` | \{\} | The HTTP headers | `BaseProps.headers` | [lib/types/requests.ts:71](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/requests.ts#L71) |
-| `beforeSave?` | [`BeforeSave`](types.requests.md#beforesave-2) | - | `BaseProps.beforeSave` | [lib/types/requests.ts:74](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/requests.ts#L74) |
+| `placeholderKey?` | `string` | When present, Superglue will use the page state located at that pageKey and optimistally navigates to it as the next page's state while the requests resolves. | - | [lib/types/requests.ts:36](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/requests.ts#L36) |
+| `revisit?` | `boolean` | When `true` and the request method is a GET, changes the `suggestionAction` of the Meta object to `none` so that Superglue does nothing to window.history. When the GET response was redirected, changes `suggestedAction` to `replace` | - | [lib/types/requests.ts:43](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/requests.ts#L43) |
+| `method?` | `string` | The HTTP method | `BaseProps.method` | [lib/types/requests.ts:67](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/requests.ts#L67) |
+| `body?` | `BodyInit` | The HTTP body | `BaseProps.body` | [lib/types/requests.ts:69](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/requests.ts#L69) |
+| `headers?` | \{\} | The HTTP headers | `BaseProps.headers` | [lib/types/requests.ts:71](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/requests.ts#L71) |
+| `beforeSave?` | [`BeforeSave`](types.requests.md#beforesave-2) | - | `BaseProps.beforeSave` | [lib/types/requests.ts:74](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/requests.ts#L74) |
***
@@ -87,7 +87,7 @@ make minimum edits to affect its global usage.
#### Defined in
-[lib/types/requests.ts:59](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/requests.ts#L59)
+[lib/types/requests.ts:59](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/requests.ts#L59)
***
@@ -105,11 +105,11 @@ Options for Visit
| Property | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
-| `method?` | `string` | The HTTP method | `BaseProps.method` | [lib/types/requests.ts:67](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/requests.ts#L67) |
-| `body?` | `BodyInit` | The HTTP body | `BaseProps.body` | [lib/types/requests.ts:69](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/requests.ts#L69) |
-| `headers?` | \{\} | The HTTP headers | `BaseProps.headers` | [lib/types/requests.ts:71](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/requests.ts#L71) |
-| `beforeSave?` | [`BeforeSave`](types.requests.md#beforesave-2) | - | `BaseProps.beforeSave` | [lib/types/requests.ts:74](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/requests.ts#L74) |
-| `pageKey?` | `string` | Specifies where to store the remote payload, if not provided [Remote](types.requests.md#remote) will use the `currentPageKey` at SuperglueState | - | [lib/types/requests.ts:85](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/requests.ts#L85) |
+| `method?` | `string` | The HTTP method | `BaseProps.method` | [lib/types/requests.ts:67](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/requests.ts#L67) |
+| `body?` | `BodyInit` | The HTTP body | `BaseProps.body` | [lib/types/requests.ts:69](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/requests.ts#L69) |
+| `headers?` | \{\} | The HTTP headers | `BaseProps.headers` | [lib/types/requests.ts:71](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/requests.ts#L71) |
+| `beforeSave?` | [`BeforeSave`](types.requests.md#beforesave-2) | - | `BaseProps.beforeSave` | [lib/types/requests.ts:74](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/requests.ts#L74) |
+| `pageKey?` | `string` | Specifies where to store the remote payload, if not provided [Remote](types.requests.md#remote) will use the `currentPageKey` at SuperglueState | - | [lib/types/requests.ts:85](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/requests.ts#L85) |
***
@@ -150,4 +150,4 @@ remote("/posts", {beforeSave})
#### Defined in
-[lib/types/requests.ts:108](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/types/requests.ts#L108)
+[lib/types/requests.ts:108](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/types/requests.ts#L108)