@inox-tools/request-state 0.0.0-transitive-runtime-20240819000048

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Luiz Ferraz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,85 @@
+<p align="center">
+    <img alt="InoxTools" width="350px" src="https://github.com/Fryuni/inox-tools/blob/main/assets/shield.png?raw=true"/>
+</p>
+
+# Request State
+
+Astro provides [`Astro.locals`/`context.locals`](https://docs.astro.build/en/reference/api-reference/#astrolocals) for shared state between different components being rendered in a page.
+
+This state can only be accessed from an Astro component using the `Astro` constant or from middlewares from the context. Sharing state between framework components is not provided and inconvenient. State using `Astro.locals` is also not shared with the client after the request completes, resulting in problems with the server and the client rendering different contents.
+
+This library provides a solution for those problems:
+
+- You can share state between any component used in a request, even between frameworks.
+- The final state formed in the server while rendering a request is available for all client code running in the rendered page.
+- UI framework components can keep their state from server to client.
+
+## Installing the dependency
+
+```js
+npm i @inox-tools/request-state
+```
+
+Add the integration to your `astro.config.mjs`:
+
+```js
+// astro.config.mjs
+import { defineConfig } from 'astro';
+import requestState from '@inox-tools/request-state';
+
+export default defineConfig({
+  integrations: [requestState({})],
+});
+```
+
+### Prerequisites
+
+When using the Cloudflare adapter, you'll need to [enable AsyncLocalStorage manually](https://developers.cloudflare.com/workers/runtime-apis/nodejs/#enable-only-asynclocalstorage).
+
+## How to use
+
+Import the two functions anywhere in your code:
+
+```ts
+import { getState, setState } from '@it-astro:state';
+
+setState('some key', 'some value');
+
+const state = getState('some key');
+```
+
+Alternatively, provide an initial value to be used if not present in the state:
+
+```ts
+import { getState } from '@it-astro:state';
+
+// `'initial value'` will be used if `'some key'` is not in the state
+const state = getState('some key', 'initial value');
+```
+
+The state can be any value supported by the [`devalue` library](https://www.npmjs.com/package/devalue) plus:
+
+- `Date`s
+- `URL`s
+- Global symbols (`Symbol.for`)
+- Well-known symbols (`Symbol.XXX`)
+
+### `setState`
+
+Params:
+
+- `key` (`string`): The key of a value in the state
+- `value` (`unknown`): The value to be set
+
+### `getState`
+
+Params:
+
+- `key` (`string`): The key of a value in the state
+- `valueIfMissing` (`unknown`): An optional value to set if there is no value in the state for the given key.
+
+Returns the value of the state for the given key, if present. If now, sets the value to `valueIfMissing` and returns it.
+
+## License
+
+Astro Request State is available under the MIT license.

package/dist/events.js

@@ -0,0 +1,5 @@
+class t extends Event{constructor(r,s,e){super(t.NAME,e);this.previousState=r;this.serverState=s;}static NAME="@it-astro:server-state-loaded"}
+
+export { t as ServerStateLoaded };
+//# sourceMappingURL=events.js.map
+//# sourceMappingURL=events.js.map

package/dist/events.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/events.ts"],"names":["ServerStateLoaded","previousState","serverState","options"],"mappings":"AAEO,MAAMA,CAAAA,SAA0B,KAAM,CAGrC,WAAA,CAQGC,EAKAC,CACTC,CAAAA,CAAAA,CACC,CACD,KAAMH,CAAAA,CAAAA,CAAkB,KAAMG,CAAO,CAAA,CAR5B,mBAAAF,CAKA,CAAA,IAAA,CAAA,WAAA,CAAAC,EAIV,CAnBA,OAAc,KAAO,+BAoBtB","file":"events.js","sourcesContent":["export type State = Map<string, unknown>;\n\nexport class ServerStateLoaded extends Event {\n\tpublic static NAME = '@it-astro:server-state-loaded' as const;\n\n\tpublic constructor(\n\t\t/**\n\t\t * The client state before loading the server state.\n\t\t *\n\t\t * On first load, this will be an empty map.\n\t\t * When using View Transitions and navigating to another page,\n\t\t * this will be state of the previous page.\n\t\t */\n\t\treadonly previousState: State,\n\n\t\t/**\n\t\t * The server state that will be loaded.\n\t\t */\n\t\treadonly serverState: State,\n\t\toptions?: EventInit\n\t) {\n\t\tsuper(ServerStateLoaded.NAME, options);\n\t}\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+/// <reference path="../virtual.d.ts" />
+
+import * as astro from 'astro';
+
+declare const _default: () => astro.AstroIntegration & {};
+
+export { _default as default };

package/dist/index.js

@@ -0,0 +1,8 @@
+import { defineIntegration, createResolver, addVitePlugin } from 'astro-integration-kit';
+import { plugin } from './plugin.js';
+
+var g=defineIntegration({name:"@inox-tools/request-state",setup(){const{resolve:t}=createResolver(import.meta.url);return {hooks:{"astro:config:setup":e=>{const{addMiddleware:r}=e;e.logger.debug("Adding request-state middleware"),r({order:"pre",entrypoint:t("runtime/middleware.js")}),e.logger.debug("Adding request-state virtual module"),addVitePlugin(e,{warnDuplicated:!0,plugin:plugin()});}}}}});
+
+export { g as default };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":["src_default","defineIntegration","resolve","createResolver","params","addMiddleware","addVitePlugin","plugin"],"mappings":";;;AAGA,IAAOA,CAAQC,CAAAA,iBAAAA,CAAkB,CAChC,IAAM,CAAA,2BAAA,CACN,KAAQ,EAAA,CACP,KAAM,CAAE,OAAA,CAAAC,CAAQ,CAAA,CAAIC,eAAe,MAAY,CAAA,IAAA,CAAA,GAAG,CAElD,CAAA,OAAO,CACN,KAAO,CAAA,CACN,oBAAuBC,CAAAA,CAAAA,EAAW,CACjC,KAAM,CAAE,aAAAC,CAAAA,CAAc,EAAID,CAE1BA,CAAAA,CAAAA,CAAO,MAAO,CAAA,KAAA,CAAM,iCAAiC,CACrDC,CAAAA,CAAAA,CAAc,CACb,KAAA,CAAO,MACP,UAAYH,CAAAA,CAAAA,CAAQ,uBAAuB,CAC5C,CAAC,CAEDE,CAAAA,CAAAA,CAAO,MAAO,CAAA,KAAA,CAAM,qCAAqC,CACzDE,CAAAA,aAAAA,CAAcF,CAAQ,CAAA,CACrB,eAAgB,CAChB,CAAA,CAAA,MAAA,CAAQG,MAAO,EAChB,CAAC,EACF,CACD,CACD,CACD,CACD,CAAC","file":"index.js","sourcesContent":["import { defineIntegration, addVitePlugin, createResolver } from 'astro-integration-kit';\nimport { plugin } from './plugin.js';\n\nexport default defineIntegration({\n\tname: '@inox-tools/request-state',\n\tsetup() {\n\t\tconst { resolve } = createResolver(import.meta.url);\n\n\t\treturn {\n\t\t\thooks: {\n\t\t\t\t'astro:config:setup': (params) => {\n\t\t\t\t\tconst { addMiddleware } = params;\n\n\t\t\t\t\tparams.logger.debug('Adding request-state middleware');\n\t\t\t\t\taddMiddleware({\n\t\t\t\t\t\torder: 'pre',\n\t\t\t\t\t\tentrypoint: resolve('runtime/middleware.js'),\n\t\t\t\t\t});\n\n\t\t\t\t\tparams.logger.debug('Adding request-state virtual module');\n\t\t\t\t\taddVitePlugin(params, {\n\t\t\t\t\t\twarnDuplicated: true,\n\t\t\t\t\t\tplugin: plugin(),\n\t\t\t\t\t});\n\t\t\t\t},\n\t\t\t},\n\t\t};\n\t},\n});\n"]}

package/dist/plugin.js

@@ -0,0 +1,10 @@
+import { createResolver } from 'astro-integration-kit';
+
+const r="@it-astro:state",o=`\0${r}`,u=()=>{const{resolve:e}=createResolver(import.meta.url);return {name:"@inox-tools/request-state/vite-plugin",resolveId(t){if(t===r)return o},load(t,s){if(t!==o)return;const n=s?.ssr?"serverState.js":"clientState.js";return `
+export {setState, getState} from '${e("runtime",n)}';
+export {ServerStateLoaded} from '${e("events.js")}';
+`.trim()}}};
+
+export { u as plugin };
+//# sourceMappingURL=plugin.js.map
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/plugin.ts"],"names":["MODULE_ID","RESOLVED_MODULE_ID","plugin","resolve","createResolver","id","options","stateSource"],"mappings":";;AAGA,MAAMA,EAAY,iBACZC,CAAAA,CAAAA,CAAqB,CAAOD,EAAAA,EAAAA,CAAS,CAE9BE,CAAAA,CAAAA,CAAAA,CAAS,IAAc,CACnC,KAAM,CAAE,OAAAC,CAAAA,CAAQ,EAAIC,cAAe,CAAA,MAAA,CAAA,IAAA,CAAY,GAAG,CAAA,CAElD,OAAO,CACN,KAAM,uCACN,CAAA,SAAA,CAAUC,EAAI,CACb,GAAIA,IAAOL,CACV,CAAA,OAAOC,CAET,CAAA,CACA,IAAKI,CAAAA,CAAAA,CAAIC,EAAS,CACjB,GAAID,CAAOJ,GAAAA,CAAAA,CAAoB,OAE/B,MAAMM,EAAcD,CAAS,EAAA,GAAA,CAAM,gBAAmB,CAAA,gBAAA,CAGtD,OAAO,CAAA;AAAA,kCAFYH,EAAAA,CAAAA,CAAQ,SAAWI,CAAAA,CAAW,CAGN,CAAA;AAAA,iCACXJ,EAAAA,CAAAA,CAAQ,WAAW,CAAC,CAAA;AAAA,CACrD,CAAA,IAAA,EACA,CACD,CACD","file":"plugin.js","sourcesContent":["import { createResolver } from 'astro-integration-kit';\nimport type { Plugin } from 'vite';\n\nconst MODULE_ID = '@it-astro:state';\nconst RESOLVED_MODULE_ID = `\\x00${MODULE_ID}`;\n\nexport const plugin = (): Plugin => {\n\tconst { resolve } = createResolver(import.meta.url);\n\n\treturn {\n\t\tname: '@inox-tools/request-state/vite-plugin',\n\t\tresolveId(id) {\n\t\t\tif (id === MODULE_ID) {\n\t\t\t\treturn RESOLVED_MODULE_ID;\n\t\t\t}\n\t\t},\n\t\tload(id, options) {\n\t\t\tif (id !== RESOLVED_MODULE_ID) return;\n\n\t\t\tconst stateSource = options?.ssr ? 'serverState.js' : 'clientState.js';\n\t\t\tconst importPath = resolve('runtime', stateSource);\n\n\t\t\treturn `\nexport {setState, getState} from '${importPath}';\nexport {ServerStateLoaded} from '${resolve('events.js')}';\n`.trim();\n\t\t},\n\t};\n};\n"]}

package/dist/runtime/clientState.js

@@ -0,0 +1,8 @@
+import { parse } from 'devalue';
+import { ServerStateLoaded } from '../events.js';
+
+const i={URL:e=>new URL(e),Date:e=>new Date(e),GlobalSymbol:e=>Symbol.for(e),WellKnownSymbol:e=>Symbol[e]},a=e=>{const t=e.getElementById("it-astro-state");if(t?.textContent){const o=parse(t.textContent,i);return t.remove(),o}};let r=a(document);const n=new Map,s=()=>{const e=new ServerStateLoaded(new Map(n),r??new Map);if(document.dispatchEvent(e)){n.clear();for(const[t,o]of e.serverState.entries())n.set(t,o);}};s(),document.addEventListener("astro:before-swap",e=>{r=a(e.newDocument);}),document.addEventListener("astro:after-swap",s);const f=(e,t)=>(n.has(e)||t!==void 0&&n.set(e,t),n.get(e)),p=(e,t)=>{t===void 0?n.delete(e):n.set(e,t);};
+
+export { f as getState, p as setState };
+//# sourceMappingURL=clientState.js.map
+//# sourceMappingURL=clientState.js.map

package/dist/runtime/clientState.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/runtime/clientState.ts"],"names":["revivers","value","loadState","doc","element","state","parse","nextState","applyState","event","ServerStateLoaded","key","getState","valueIfMissing","setState"],"mappings":";;;AAGA,MAAMA,CAAgD,CAAA,CACrD,IAAMC,CAAU,EAAA,IAAI,IAAIA,CAAK,CAAA,CAC7B,KAAOA,CAAU,EAAA,IAAI,IAAKA,CAAAA,CAAK,EAC/B,YAAeA,CAAAA,CAAAA,EAAU,MAAO,CAAA,GAAA,CAAIA,CAAK,CACzC,CAAA,eAAA,CAAkBA,CAAU,EAAA,MAAA,CAAOA,CAA4B,CAChE,CAAA,CAEMC,EAAaC,CAAqC,EAAA,CACvD,MAAMC,CAAUD,CAAAA,CAAAA,CAAI,cAAe,CAAA,gBAAgB,EAEnD,GAAIC,CAAAA,EAAS,WAAa,CAAA,CACzB,MAAMC,CAAQC,CAAAA,KAAAA,CAAMF,CAAQ,CAAA,WAAA,CAAaJ,CAAQ,CACjD,CAAA,OAAAI,EAAQ,MAAO,EAAA,CACRC,CACR,CACD,CAAA,CAEA,IAAIE,CAAAA,CAAYL,EAAU,QAAQ,CAAA,CAClC,MAAMG,CAAAA,CAAQ,IAAI,GAEZG,CAAAA,CAAAA,CAAa,IAAM,CACxB,MAAMC,CAAQ,CAAA,IAAIC,kBAAkB,IAAI,GAAA,CAAIL,CAAK,CAAGE,CAAAA,CAAAA,EAAa,IAAI,GAAK,EAE1E,GAAI,QAAA,CAAS,aAAcE,CAAAA,CAAK,EAAG,CAClCJ,CAAAA,CAAM,KAAM,EAAA,CACZ,SAAW,CAACM,CAAAA,CAAKV,CAAK,CAAKQ,GAAAA,CAAAA,CAAM,YAAY,OAAQ,EAAA,CACpDJ,CAAM,CAAA,GAAA,CAAIM,EAAKV,CAAK,EAEtB,CACD,CAAA,CAEAO,GAEA,CAAA,QAAA,CAAS,gBAAiB,CAAA,mBAAA,CAAsBC,GAAU,CACzDF,CAAAA,CAAYL,EAAUO,CAAM,CAAA,WAAW,EACxC,CAAC,CAAA,CACD,QAAS,CAAA,gBAAA,CAAiB,mBAAoBD,CAAU,CAAA,CAE3CI,MAAAA,CAAAA,CAAW,CAACD,CAAaE,CAAAA,CAAAA,IAChCR,CAAM,CAAA,GAAA,CAAIM,CAAG,CACbE,EAAAA,CAAAA,GAAmB,QACtBR,CAAM,CAAA,GAAA,CAAIM,EAAKE,CAAc,CAAA,CAGxBR,CAAM,CAAA,GAAA,CAAIM,CAAG,CAGRG,CAAAA,CAAAA,CAAAA,CAAW,CAACH,CAAAA,CAAaV,IAAyB,CAC1DA,CAAAA,GAAU,KACbI,CAAAA,CAAAA,CAAAA,CAAM,OAAOM,CAAG,CAAA,CAEhBN,EAAM,GAAIM,CAAAA,CAAAA,CAAKV,CAAK,EAEtB","file":"clientState.js","sourcesContent":["import { parse } from 'devalue';\nimport { type State, ServerStateLoaded } from '../events.js';\n\nconst revivers: Record<string, (value: any) => any> = {\n\tURL: (value) => new URL(value),\n\tDate: (value) => new Date(value),\n\tGlobalSymbol: (value) => Symbol.for(value),\n\tWellKnownSymbol: (value) => Symbol[value as keyof typeof Symbol],\n};\n\nconst loadState = (doc: Document): State | undefined => {\n\tconst element = doc.getElementById('it-astro-state');\n\n\tif (element?.textContent) {\n\t\tconst state = parse(element.textContent, revivers);\n\t\telement.remove();\n\t\treturn state;\n\t}\n};\n\nlet nextState = loadState(document);\nconst state = new Map();\n\nconst applyState = () => {\n\tconst event = new ServerStateLoaded(new Map(state), nextState ?? new Map());\n\n\tif (document.dispatchEvent(event)) {\n\t\tstate.clear();\n\t\tfor (const [key, value] of event.serverState.entries()) {\n\t\t\tstate.set(key, value);\n\t\t}\n\t}\n};\n\napplyState();\n\ndocument.addEventListener('astro:before-swap', (event) => {\n\tnextState = loadState(event.newDocument);\n});\ndocument.addEventListener('astro:after-swap', applyState);\n\nexport const getState = (key: string, valueIfMissing?: unknown): unknown => {\n\tif (!state.has(key)) {\n\t\tif (valueIfMissing !== undefined) {\n\t\t\tstate.set(key, valueIfMissing);\n\t\t}\n\t}\n\treturn state.get(key);\n};\n\nexport const setState = (key: string, value: unknown): void => {\n\tif (value === undefined) {\n\t\tstate.delete(key);\n\t} else {\n\t\tstate.set(key, value);\n\t}\n};\n"]}

package/dist/runtime/middleware.js

@@ -0,0 +1,9 @@
+import { defineMiddleware } from 'astro/middleware';
+import { collectState } from './serverState.js';
+import { parse } from 'content-type';
+
+const u=defineMiddleware(async(l,o)=>{const{getState:n,result:t}=await collectState(o),e=t.headers.get("Content-Type");if(e===null)return t;const{type:r}=parse(e);if(r!=="text/html"&&!r.startsWith("text/html+"))return t;async function*s(){for await(const i of t.body)yield i;const a=n();a&&(yield `<script id="it-astro-state" type="application/json+devalue">${a}</script>`);}return new Response(s(),t)});
+
+export { u as onRequest };
+//# sourceMappingURL=middleware.js.map
+//# sourceMappingURL=middleware.js.map

package/dist/runtime/middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/runtime/middleware.ts"],"names":["onRequest","defineMiddleware","_","next","getState","result","collectState","contentType","mediaType","parse","render","chunk","state"],"mappings":";;;;MAKaA,CAAYC,CAAAA,gBAAAA,CAAiB,MAAOC,CAAGC,CAAAA,CAAAA,GAAS,CAC5D,KAAM,CAAE,QAAAC,CAAAA,CAAAA,CAAU,OAAAC,CAAO,CAAA,CAAI,MAAMC,YAAaH,CAAAA,CAAI,EAE9CI,CAAcF,CAAAA,CAAAA,CAAO,OAAQ,CAAA,GAAA,CAAI,cAAc,CAErD,CAAA,GAAIE,IAAgB,IAAM,CAAA,OAAOF,EAEjC,KAAM,CAAE,IAAMG,CAAAA,CAAU,EAAIC,KAAMF,CAAAA,CAAW,EAE7C,GAAIC,CAAAA,GAAc,aAAe,CAACA,CAAAA,CAAU,UAAW,CAAA,YAAY,EAAG,OAAOH,CAAAA,CAE7E,eAAgBK,CAAS,EAAA,CACxB,gBAAiBC,CAASN,IAAAA,CAAAA,CAAO,IAChC,CAAA,MAAMM,EAGP,MAAMC,CAAAA,CAAQR,GAEVQ,CAAAA,CAAAA,GACH,MAAM,CAA+DA,4DAAAA,EAAAA,CAAK,CAE5E,SAAA,CAAA,EAAA,CAGA,OAAO,IAAI,QAAA,CAASF,GAAUL,CAAAA,CAAM,CACrC,CAAC","file":"middleware.js","sourcesContent":["import type { ReadableStream } from 'node:stream/web';\nimport { defineMiddleware } from 'astro/middleware';\nimport { collectState } from './serverState.js';\nimport { parse } from 'content-type';\n\nexport const onRequest = defineMiddleware(async (_, next) => {\n\tconst { getState, result } = await collectState(next);\n\n\tconst contentType = result.headers.get('Content-Type');\n\n\tif (contentType === null) return result;\n\n\tconst { type: mediaType } = parse(contentType);\n\n\tif (mediaType !== 'text/html' && !mediaType.startsWith('text/html+')) return result;\n\n\tasync function* render() {\n\t\tfor await (const chunk of result.body as ReadableStream<ArrayBuffer>) {\n\t\t\tyield chunk;\n\t\t}\n\n\t\tconst state = getState();\n\n\t\tif (state) {\n\t\t\tyield `<script id=\"it-astro-state\" type=\"application/json+devalue\">${state}</script>`;\n\t\t}\n\t}\n\n\t// @ts-expect-error generator not assignable to ReadableStream\n\treturn new Response(render(), result);\n});\n"]}

package/dist/runtime/serverState.js

@@ -0,0 +1,8 @@
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { stringify } from 'devalue';
+
+const o=new AsyncLocalStorage,l=(t,e)=>{const n=o.getStore();if(n!==void 0)return n.has(t)||e!==void 0&&n.set(t,e),n.get(t)},p=(t,e)=>{const n=o.getStore();e===void 0?n?.delete(t):n?.set(t,e);},i=new Map(Object.entries(Symbol).filter(([t,e])=>typeof e=="symbol"&&typeof t=="string").map(([t,e])=>[e,t])),c={URL:t=>t instanceof URL&&t.href,Date:t=>t instanceof Date&&t.valueOf(),GlobalSymbol:t=>typeof t=="symbol"&&t.description!==void 0&&t===Symbol.for(t.description)&&t.description,WellKnownSymbol:t=>typeof t=="symbol"&&i.get(t)},d=async t=>{const e=new Map;return {result:await o.run(e,t),getState:()=>e.size>0&&stringify(e,c)}};
+
+export { d as collectState, l as getState, p as setState };
+//# sourceMappingURL=serverState.js.map
+//# sourceMappingURL=serverState.js.map

package/dist/runtime/serverState.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/runtime/serverState.ts"],"names":["store","AsyncLocalStorage","getState","key","valueIfMissing","state","setState","value","wellKnownSymbols","reducers","collectState","cb","stringify"],"mappings":";;;AAKA,MAAMA,CAAQ,CAAA,IAAIC,kBAELC,CAAW,CAAA,CAACC,CAAaC,CAAAA,CAAAA,GAAsC,CAC3E,MAAMC,CAAAA,CAAQL,CAAM,CAAA,QAAA,GACpB,GAAIK,CAAAA,GAAU,KAEd,CAAA,CAAA,OAAKA,EAAM,GAAIF,CAAAA,CAAG,CACbC,EAAAA,CAAAA,GAAmB,QACtBC,CAAM,CAAA,GAAA,CAAIF,EAAKC,CAAc,CAAA,CAGxBC,EAAM,GAAIF,CAAAA,CAAG,CACrB,CAAA,CAEaG,EAAW,CAACH,CAAAA,CAAaI,CAAyB,GAAA,CAC9D,MAAMF,CAAQL,CAAAA,CAAAA,CAAM,QAAS,EAAA,CACzBO,IAAU,KACbF,CAAAA,CAAAA,CAAAA,EAAO,OAAOF,CAAG,CAAA,CAEjBE,GAAO,GAAIF,CAAAA,CAAAA,CAAKI,CAAK,EAEvB,EAOMC,CAAmB,CAAA,IAAI,GAC5B,CAAA,MAAA,CAAO,QAAQ,MAAM,CAAA,CACnB,MAAO,CAAA,CAAC,CAACL,CAAKI,CAAAA,CAAK,IAAM,OAAOA,CAAAA,EAAU,UAAY,OAAOJ,CAAAA,EAAQ,QAAQ,CAAA,CAC7E,IAAI,CAAC,CAACA,CAAKI,CAAAA,CAAK,IAAM,CAACA,CAAAA,CAAOJ,CAAG,CAAC,CACrC,CAEMM,CAAAA,CAAAA,CAAgD,CACrD,GAAA,CAAMF,GAAUA,CAAiB,YAAA,GAAA,EAAOA,CAAM,CAAA,IAAA,CAC9C,KAAOA,CAAUA,EAAAA,CAAAA,YAAiB,IAAQA,EAAAA,CAAAA,CAAM,SAChD,CAAA,YAAA,CAAeA,CACd,EAAA,OAAOA,GAAU,QACjBA,EAAAA,CAAAA,CAAM,cAAgB,KACtBA,CAAAA,EAAAA,CAAAA,GAAU,OAAO,GAAIA,CAAAA,CAAAA,CAAM,WAAW,CAAA,EACtCA,EAAM,WACP,CAAA,eAAA,CAAkBA,CAAU,EAAA,OAAOA,GAAU,QAAYC,EAAAA,CAAAA,CAAiB,GAAID,CAAAA,CAAK,CACpF,CAEaG,CAAAA,CAAAA,CAAe,MAAUC,CAAqD,EAAA,CAC1F,MAAMN,CAAQ,CAAA,IAAI,GAElB,CAAA,OAAO,CACN,MAFc,CAAA,MAAML,CAAM,CAAA,GAAA,CAAIK,EAAOM,CAAE,CAAA,CAGvC,QAAU,CAAA,IAAMN,EAAM,IAAO,CAAA,CAAA,EAAKO,UAAUP,CAAOI,CAAAA,CAAQ,CAC5D,CACD","file":"serverState.js","sourcesContent":["import { AsyncLocalStorage } from 'node:async_hooks';\nimport { stringify } from 'devalue';\n\ntype State = Map<string, unknown>;\n\nconst store = new AsyncLocalStorage<State>();\n\nexport const getState = (key: string, valueIfMissing?: unknown): unknown => {\n\tconst state = store.getStore();\n\tif (state === undefined) return;\n\n\tif (!state.has(key)) {\n\t\tif (valueIfMissing !== undefined) {\n\t\t\tstate.set(key, valueIfMissing);\n\t\t}\n\t}\n\treturn state.get(key);\n};\n\nexport const setState = (key: string, value: unknown): void => {\n\tconst state = store.getStore();\n\tif (value === undefined) {\n\t\tstate?.delete(key);\n\t} else {\n\t\tstate?.set(key, value);\n\t}\n};\n\nexport type CollectedState<T> = {\n\tgetState: () => string | false;\n\tresult: T;\n};\n\nconst wellKnownSymbols = new Map(\n\tObject.entries(Symbol)\n\t\t.filter(([key, value]) => typeof value === 'symbol' && typeof key === 'string')\n\t\t.map(([key, value]) => [value, key])\n);\n\nconst reducers: Record<string, (value: any) => any> = {\n\tURL: (value) => value instanceof URL && value.href,\n\tDate: (value) => value instanceof Date && value.valueOf(),\n\tGlobalSymbol: (value) =>\n\t\ttypeof value === 'symbol' &&\n\t\tvalue.description !== undefined &&\n\t\tvalue === Symbol.for(value.description) &&\n\t\tvalue.description,\n\tWellKnownSymbol: (value) => typeof value === 'symbol' && wellKnownSymbols.get(value),\n};\n\nexport const collectState = async <R>(cb: () => Promise<R>): Promise<CollectedState<R>> => {\n\tconst state = new Map();\n\tconst result = await store.run(state, cb);\n\treturn {\n\t\tresult,\n\t\tgetState: () => state.size > 0 && stringify(state, reducers),\n\t};\n};\n"]}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@inox-tools/request-state",
+  "version": "0.0.0-transitive-runtime-20240819000048",
+  "description": "Shared request state between server and client",
+  "keywords": [
+    "astro-integration",
+    "withastro",
+    "astro"
+  ],
+  "license": "MIT",
+  "author": "Luiz Ferraz <luiz@lferraz.com>",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "virtual.d.ts"
+  ],
+  "dependencies": {
+    "astro-integration-kit": "~0.16.0",
+    "content-type": "^1.0.5",
+    "devalue": "^5.0.0",
+    "@inox-tools/utils": "^0.1.3"
+  },
+  "devDependencies": {
+    "@types/content-type": "^1.1.8",
+    "@types/node": "^22.4.0",
+    "@vitest/coverage-v8": "^2.0.5",
+    "@vitest/ui": "^2.0.5",
+    "astro": "^4.14.2",
+    "jest-extended": "^4.0.2",
+    "tsup": "8.2.4",
+    "typescript": "^5.5.4",
+    "vite": "^5.4.1",
+    "vitest": "^2.0.5"
+  },
+  "peerDependencies": {
+    "astro": "^4"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "prepublish": "pnpm run build",
+    "test": "echo 'No tests for now :('",
+    "test:dev": "vitest --coverage.enabled=true",
+    "test:run": "vitest run --coverage"
+  }
+}

package/src/events.ts

@@ -0,0 +1,24 @@
+export type State = Map<string, unknown>;
+
+export class ServerStateLoaded extends Event {
+	public static NAME = '@it-astro:server-state-loaded' as const;
+
+	public constructor(
+		/**
+		 * The client state before loading the server state.
+		 *
+		 * On first load, this will be an empty map.
+		 * When using View Transitions and navigating to another page,
+		 * this will be state of the previous page.
+		 */
+		readonly previousState: State,
+
+		/**
+		 * The server state that will be loaded.
+		 */
+		readonly serverState: State,
+		options?: EventInit
+	) {
+		super(ServerStateLoaded.NAME, options);
+	}
+}

package/src/index.ts

@@ -0,0 +1,29 @@
+import { defineIntegration, addVitePlugin, createResolver } from 'astro-integration-kit';
+import { plugin } from './plugin.js';
+
+export default defineIntegration({
+	name: '@inox-tools/request-state',
+	setup() {
+		const { resolve } = createResolver(import.meta.url);
+
+		return {
+			hooks: {
+				'astro:config:setup': (params) => {
+					const { addMiddleware } = params;
+
+					params.logger.debug('Adding request-state middleware');
+					addMiddleware({
+						order: 'pre',
+						entrypoint: resolve('runtime/middleware.js'),
+					});
+
+					params.logger.debug('Adding request-state virtual module');
+					addVitePlugin(params, {
+						warnDuplicated: true,
+						plugin: plugin(),
+					});
+				},
+			},
+		};
+	},
+});

package/src/plugin.ts

@@ -0,0 +1,29 @@
+import { createResolver } from 'astro-integration-kit';
+import type { Plugin } from 'vite';
+
+const MODULE_ID = '@it-astro:state';
+const RESOLVED_MODULE_ID = `\x00${MODULE_ID}`;
+
+export const plugin = (): Plugin => {
+	const { resolve } = createResolver(import.meta.url);
+
+	return {
+		name: '@inox-tools/request-state/vite-plugin',
+		resolveId(id) {
+			if (id === MODULE_ID) {
+				return RESOLVED_MODULE_ID;
+			}
+		},
+		load(id, options) {
+			if (id !== RESOLVED_MODULE_ID) return;
+
+			const stateSource = options?.ssr ? 'serverState.js' : 'clientState.js';
+			const importPath = resolve('runtime', stateSource);
+
+			return `
+export {setState, getState} from '${importPath}';
+export {ServerStateLoaded} from '${resolve('events.js')}';
+`.trim();
+		},
+	};
+};

package/src/runtime/clientState.ts

@@ -0,0 +1,57 @@
+import { parse } from 'devalue';
+import { type State, ServerStateLoaded } from '../events.js';
+
+const revivers: Record<string, (value: any) => any> = {
+	URL: (value) => new URL(value),
+	Date: (value) => new Date(value),
+	GlobalSymbol: (value) => Symbol.for(value),
+	WellKnownSymbol: (value) => Symbol[value as keyof typeof Symbol],
+};
+
+const loadState = (doc: Document): State | undefined => {
+	const element = doc.getElementById('it-astro-state');
+
+	if (element?.textContent) {
+		const state = parse(element.textContent, revivers);
+		element.remove();
+		return state;
+	}
+};
+
+let nextState = loadState(document);
+const state = new Map();
+
+const applyState = () => {
+	const event = new ServerStateLoaded(new Map(state), nextState ?? new Map());
+
+	if (document.dispatchEvent(event)) {
+		state.clear();
+		for (const [key, value] of event.serverState.entries()) {
+			state.set(key, value);
+		}
+	}
+};
+
+applyState();
+
+document.addEventListener('astro:before-swap', (event) => {
+	nextState = loadState(event.newDocument);
+});
+document.addEventListener('astro:after-swap', applyState);
+
+export const getState = (key: string, valueIfMissing?: unknown): unknown => {
+	if (!state.has(key)) {
+		if (valueIfMissing !== undefined) {
+			state.set(key, valueIfMissing);
+		}
+	}
+	return state.get(key);
+};
+
+export const setState = (key: string, value: unknown): void => {
+	if (value === undefined) {
+		state.delete(key);
+	} else {
+		state.set(key, value);
+	}
+};

package/src/runtime/middleware.ts

@@ -0,0 +1,31 @@
+import type { ReadableStream } from 'node:stream/web';
+import { defineMiddleware } from 'astro/middleware';
+import { collectState } from './serverState.js';
+import { parse } from 'content-type';
+
+export const onRequest = defineMiddleware(async (_, next) => {
+	const { getState, result } = await collectState(next);
+
+	const contentType = result.headers.get('Content-Type');
+
+	if (contentType === null) return result;
+
+	const { type: mediaType } = parse(contentType);
+
+	if (mediaType !== 'text/html' && !mediaType.startsWith('text/html+')) return result;
+
+	async function* render() {
+		for await (const chunk of result.body as ReadableStream<ArrayBuffer>) {
+			yield chunk;
+		}
+
+		const state = getState();
+
+		if (state) {
+			yield `<script id="it-astro-state" type="application/json+devalue">${state}</script>`;
+		}
+	}
+
+	// @ts-expect-error generator not assignable to ReadableStream
+	return new Response(render(), result);
+});

package/src/runtime/serverState.ts

@@ -0,0 +1,58 @@
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { stringify } from 'devalue';
+
+type State = Map<string, unknown>;
+
+const store = new AsyncLocalStorage<State>();
+
+export const getState = (key: string, valueIfMissing?: unknown): unknown => {
+	const state = store.getStore();
+	if (state === undefined) return;
+
+	if (!state.has(key)) {
+		if (valueIfMissing !== undefined) {
+			state.set(key, valueIfMissing);
+		}
+	}
+	return state.get(key);
+};
+
+export const setState = (key: string, value: unknown): void => {
+	const state = store.getStore();
+	if (value === undefined) {
+		state?.delete(key);
+	} else {
+		state?.set(key, value);
+	}
+};
+
+export type CollectedState<T> = {
+	getState: () => string | false;
+	result: T;
+};
+
+const wellKnownSymbols = new Map(
+	Object.entries(Symbol)
+		.filter(([key, value]) => typeof value === 'symbol' && typeof key === 'string')
+		.map(([key, value]) => [value, key])
+);
+
+const reducers: Record<string, (value: any) => any> = {
+	URL: (value) => value instanceof URL && value.href,
+	Date: (value) => value instanceof Date && value.valueOf(),
+	GlobalSymbol: (value) =>
+		typeof value === 'symbol' &&
+		value.description !== undefined &&
+		value === Symbol.for(value.description) &&
+		value.description,
+	WellKnownSymbol: (value) => typeof value === 'symbol' && wellKnownSymbols.get(value),
+};
+
+export const collectState = async <R>(cb: () => Promise<R>): Promise<CollectedState<R>> => {
+	const state = new Map();
+	const result = await store.run(state, cb);
+	return {
+		result,
+		getState: () => state.size > 0 && stringify(state, reducers),
+	};
+};

package/virtual.d.ts

@@ -0,0 +1,12 @@
+declare module '@it-astro:state' {
+	export const getState: (key: string, valueIfMissing?: unknown) => unknown;
+	export const setState: (key: string, value: unknown) => void;
+
+	export { ServerStateLoaded } from './src/events.js';
+}
+
+declare global {
+	interface DocumentEventMap {
+		[ServerStateLoaded.NAME]: import('./src/events.js').ServerStateLoaded;
+	}
+}