@thomasfosterau/effect-sveltekit 0.7.0 → 0.9.0

package/README.md

@@ -47,9 +47,9 @@ optional `effectKit()` Vite plugin lets route files export bare Effects instead.
 
 | Entry point                        | What it provides                                                                                                                                                                                                                                                                                                            |
 | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `@thomasfosterau/effect-sveltekit` | Universal helpers: `load` / `makeUniversalRuntime`, the `Remote` call namespace, `Hooks` (`reroute`, `transport`), `ResponseHeaders`, `sveltekitConfig` / `readConfig`, `apiClient`                                                                                                                                         |
+| `@thomasfosterau/effect-sveltekit` | Universal helpers: `load` / `makeUniversalRuntime`, the `Remote` call namespace and `Hooks` (`reroute`, `transport`), each also exported member by member, `ResponseHeaders`, `sveltekitConfig` / `readConfig`, `apiClient`                                                                                                 |
 | `…/server`                         | Server wrappers (`serverLoad`, `action`, `actions`, `endpoint`), `Hooks`, `Endpoint`, `makeServerRuntime`, the per-request runtime seam (`makeRuntimeAdapter` / `RequestRuntime`), `Errors`, `RemoteFunction` / `RemoteFunctionUsageError`, `KitError` / `KitErrorBody`, request decoding (`decodeParams`, `decodeJson`, …) |
-| `…/client`                         | Browser-only `Navigation`, `State` (incl. the `CurrentPage` service), `Remote`, `Realtime`, `Forms` and `Hooks` namespaces, and `useRemoteQuery` / `RemoteQueryResult`                                                                                                                                                      |
+| `…/client`                         | Browser-only `Navigation`, `State` (incl. the `CurrentPage` service), `Remote`, `Realtime`, `Forms` and `Hooks` namespaces, each also exported member by member, and `useRemoteQuery` / `RemoteQueryResult`                                                                                                                 |
 | `…/vite`                           | The `effectKit()` Vite plugin (auto-wraps bare-Effect route exports)                                                                                                                                                                                                                                                        |
 | `…/adapter`                        | The Effect HTTP deployment adapter (`effectAdapter`)                                                                                                                                                                                                                                                                        |
 | `…/adapter/handler`                | The SvelteKit app as an Effect HTTP app (`makeHandler`, `makeHandlerWith`, `AssetSource`, `toWebHandler`, the `SvelteKitServerError` / `AssetFetchError` defects)                                                                                                                                                           |
@@ -388,6 +388,15 @@ import {
 //      Remote.callQuery(getTodos), State.page()
 ```
 
+Every member of `Navigation`, `State`, `Remote`, `Realtime`, `Forms` and
+`Hooks` is also a named export of `…/client` (`goto`, `page`, `callQuery`,
+`fromEventSource`, `enhance`, `handleError`, …), and the named imports are the
+ones to prefer in the browser bundle. The published build turns each namespace
+into a single object, so `Navigation.goto` also keeps `beforeNavigate`,
+`afterNavigate`, `onNavigate` and the navigation-event registry behind them,
+while `import { goto } from "@thomasfosterau/effect-sveltekit/client"` keeps
+only `goto` and what it uses.
+
 `Navigation.goto`, `invalidate`, `invalidateAll`, `refreshAll`, `preloadData`
 and `preloadCode` fail with `Navigation.NavigationError` when SvelteKit rejects
 or throws: for example, `goto` to a URL outside the app, `preloadData` for an
@@ -434,14 +443,14 @@ const logPath = Effect.gen(function* () {
 Move custom types (`Option`, `DateTime`, branded types, `Schema.Class`
 instances, tagged errors, ...) across the server/client boundary — for `load`
 data and remote functions — by building SvelteKit's universal `transport` hook
-from Effect schemas (part of the universal `Hooks` namespace):
+from Effect schemas (also reachable as `Hooks.transport`):
 
 ```ts
 // src/hooks.ts
-import { Hooks } from "@thomasfosterau/effect-sveltekit";
+import { transport as effectTransport } from "@thomasfosterau/effect-sveltekit";
 import { Schema } from "effect";
 
-export const transport = Hooks.transport({
+export const transport = effectTransport({
   Option: Schema.Option(Schema.Number),
   Date: Schema.Date,
 });
@@ -468,8 +477,11 @@ declare global {
 }
 
 // src/hooks.ts
-import { Hooks } from "@thomasfosterau/effect-sveltekit";
-export const transport = Hooks.transport({ ResponseHeaders: Hooks.responseHeadersTransporter });
+import {
+  transport as effectTransport,
+  responseHeadersTransporter,
+} from "@thomasfosterau/effect-sveltekit";
+export const transport = effectTransport({ ResponseHeaders: responseHeadersTransporter });
 
 // src/hooks.server.ts
 import { ResponseHeaders } from "@thomasfosterau/effect-sveltekit";
@@ -490,6 +502,14 @@ export const load = ({ locals }) => ({ headers: locals.headers });
 handler effects; `ResponseHeaders` is the buffer for everything `setHeaders`
 cannot do.)
 
+Import the universal hook helpers by name, as above, rather than through the
+`Hooks` namespace. `src/hooks.ts` runs on every page, and the published build
+turns `Hooks` into a single object: `Hooks.transport` keeps `Hooks.reroute`
+and the default universal runtime (with Effect's `HttpClient`, `Stream` and
+`ManagedRuntime`) in the client bundle, while the named imports keep only the
+transport helpers. The same holds for `Remote`, whose members are also root
+exports (`callQuery`, `callCommand`, …).
+
 ### `$env` as an Effect `Config` source
 
 Back Effect's `Config` with SvelteKit's environment, so app-layer services read
@@ -508,7 +528,9 @@ export const runtime = makeServerRuntime(Database.layer.pipe(Layer.provide(svelt
 ### SvelteKit hooks as Effects (`Hooks`)
 
 Every SvelteKit hook has an explicit Effect wrapper, grouped into a `Hooks`
-namespace per hook file (mirroring the auto-wrap table above):
+namespace per hook file (mirroring the auto-wrap table above). The universal
+members are also exported by name from the root entry; prefer those in
+`src/hooks.ts` (see the `ResponseHeaders` recipe above for why):
 
 | Import path                               | `Hooks` members                                | Runs on                                          |
 | ----------------------------------------- | ---------------------------------------------- | ------------------------------------------------ |
@@ -518,10 +540,10 @@ namespace per hook file (mirroring the auto-wrap table above):
 
 ```ts
 // src/hooks.ts
-import { Hooks } from "@thomasfosterau/effect-sveltekit";
+import { reroute as effectReroute } from "@thomasfosterau/effect-sveltekit";
 import { Effect } from "effect";
 
-export const reroute = Hooks.reroute((event) =>
+export const reroute = effectReroute((event) =>
   Effect.succeed(event.url.pathname === "/old" ? "/new" : undefined),
 );
 ```

package/dist/client.d.ts

@@ -1,8 +1,10 @@
-import { Navigation_d_exports } from "./Navigation.js";
-import { State_d_exports } from "./State.js";
-import { Remote_d_exports } from "./Remote.js";
+import { NavigationError, Navigation_d_exports, afterNavigate, beforeNavigate, goto, invalidate, invalidateAll, onNavigate, preloadCode, preloadData, refreshAll } from "./Navigation.js";
+import { NavigatingSnapshot, PageSnapshot, UpdateCheckError } from "./internal/app-state.js";
+import { CurrentPage, CurrentPageInterface, State_d_exports, checkForUpdate, navigating, page, updated } from "./State.js";
+import { RemoteSubmit, Remote_d_exports, callCommand, callCommandWithUpdates, callPrerender, callQuery, liveQueryStream, submitForm, submitFormWithUpdates } from "./Remote.js";
 import { RemoteQueryResult, useRemoteQuery } from "./remote-reactive.js";
-import { realtime_d_exports } from "./realtime.js";
-import { forms_d_exports } from "./forms.js";
-import { Hooks_d_exports } from "./client/Hooks.js";
-export { forms_d_exports as Forms, Hooks_d_exports as Hooks, Navigation_d_exports as Navigation, realtime_d_exports as Realtime, Remote_d_exports as Remote, type RemoteQueryResult, State_d_exports as State, useRemoteQuery };
+import { EventSourceConstructor, EventSourceError, FromEventSourceOptions, FromWebSocketOptions, SseMessage, WebSocketConstructor, WebSocketError, fromEventSource, fromWebSocket, realtime_d_exports } from "./realtime.js";
+import { EnhanceHandlers, EnhanceOptions, EnhanceOptionsArgs, EnhanceRuntime, ResultOptions, SubmitInput } from "./internal/enhance.js";
+import { ApplyActionError, applyAction, deserialize, enhance, forms_d_exports } from "./forms.js";
+import { Hooks_d_exports, handleError, init } from "./client/Hooks.js";
+export { ApplyActionError, CurrentPage, type CurrentPageInterface, type EnhanceHandlers, type EnhanceOptions, type EnhanceOptionsArgs, type EnhanceRuntime, type EventSourceConstructor, EventSourceError, forms_d_exports as Forms, type FromEventSourceOptions, type FromWebSocketOptions, Hooks_d_exports as Hooks, type NavigatingSnapshot, Navigation_d_exports as Navigation, NavigationError, type PageSnapshot, realtime_d_exports as Realtime, Remote_d_exports as Remote, type RemoteQueryResult, type RemoteSubmit, type ResultOptions, type SseMessage, State_d_exports as State, type SubmitInput, UpdateCheckError, type WebSocketConstructor, WebSocketError, afterNavigate, applyAction, beforeNavigate, callCommand, callCommandWithUpdates, callPrerender, callQuery, checkForUpdate, deserialize, enhance, fromEventSource, fromWebSocket, goto, handleError, init, invalidate, invalidateAll, liveQueryStream, navigating, onNavigate, page, preloadCode, preloadData, refreshAll, submitForm, submitFormWithUpdates, updated, useRemoteQuery };

package/dist/client.js

@@ -1,8 +1,9 @@
-import { Remote_exports } from "./Remote.js";
-import { Navigation_exports } from "./Navigation.js";
-import { State_exports } from "./State.js";
+import { Remote_exports, callCommand, callCommandWithUpdates, callPrerender, callQuery, liveQueryStream, submitForm, submitFormWithUpdates } from "./Remote.js";
+import { NavigationError, Navigation_exports, afterNavigate, beforeNavigate, goto, invalidate, invalidateAll, onNavigate, preloadCode, preloadData, refreshAll } from "./Navigation.js";
+import { UpdateCheckError } from "./internal/app-state.js";
+import { CurrentPage, State_exports, checkForUpdate, navigating, page, updated } from "./State.js";
 import { useRemoteQuery } from "./remote-reactive.js";
-import { realtime_exports } from "./realtime.js";
-import { forms_exports } from "./forms.js";
-import { Hooks_exports } from "./client/Hooks.js";
-export { forms_exports as Forms, Hooks_exports as Hooks, Navigation_exports as Navigation, realtime_exports as Realtime, Remote_exports as Remote, State_exports as State, useRemoteQuery };
+import { EventSourceError, WebSocketError, fromEventSource, fromWebSocket, realtime_exports } from "./realtime.js";
+import { ApplyActionError, applyAction, deserialize, enhance, forms_exports } from "./forms.js";
+import { Hooks_exports, handleError, init } from "./client/Hooks.js";
+export { ApplyActionError, CurrentPage, EventSourceError, forms_exports as Forms, Hooks_exports as Hooks, Navigation_exports as Navigation, NavigationError, realtime_exports as Realtime, Remote_exports as Remote, State_exports as State, UpdateCheckError, WebSocketError, afterNavigate, applyAction, beforeNavigate, callCommand, callCommandWithUpdates, callPrerender, callQuery, checkForUpdate, deserialize, enhance, fromEventSource, fromWebSocket, goto, handleError, init, invalidate, invalidateAll, liveQueryStream, navigating, onNavigate, page, preloadCode, preloadData, refreshAll, submitForm, submitFormWithUpdates, updated, useRemoteQuery };

package/dist/index.d.ts

@@ -1,8 +1,9 @@
-import { Remote_d_exports } from "./Remote.js";
+import { RemoteSubmit, Remote_d_exports, callCommand, callCommandWithUpdates, callPrerender, callQuery, liveQueryStream, submitForm, submitFormWithUpdates } from "./Remote.js";
 import { SvelteKitServices, UniversalRuntime, makeUniversalRuntime } from "./app-runtime.js";
 import { load } from "./universal.js";
-import { ResponseHeaders } from "./response-headers.js";
-import { Hooks_d_exports } from "./Hooks.js";
+import { MarkerTransporterOptions, TransportEntry, markerTransporter, transport, transporter } from "./transport.js";
+import { ResponseHeaders, responseHeadersTransporter } from "./response-headers.js";
+import { Hooks_d_exports, reroute } from "./Hooks.js";
 import { readConfig, sveltekitConfig, sveltekitConfigProvider } from "./config.js";
 import { ApiClientOptions, apiClient } from "./api-client.js";
-export { type ApiClientOptions, Hooks_d_exports as Hooks, Remote_d_exports as Remote, ResponseHeaders, type SvelteKitServices, type UniversalRuntime, apiClient, load, makeUniversalRuntime, readConfig, sveltekitConfig, sveltekitConfigProvider };
+export { type ApiClientOptions, Hooks_d_exports as Hooks, type MarkerTransporterOptions, Remote_d_exports as Remote, type RemoteSubmit, ResponseHeaders, type SvelteKitServices, type TransportEntry, type UniversalRuntime, apiClient, callCommand, callCommandWithUpdates, callPrerender, callQuery, liveQueryStream, load, makeUniversalRuntime, markerTransporter, readConfig, reroute, responseHeadersTransporter, submitForm, submitFormWithUpdates, sveltekitConfig, sveltekitConfigProvider, transport, transporter };

package/dist/index.js

@@ -1,8 +1,9 @@
 import { makeUniversalRuntime } from "./app-runtime.js";
 import { load } from "./universal.js";
-import { Remote_exports } from "./Remote.js";
-import { ResponseHeaders } from "./response-headers.js";
-import { Hooks_exports } from "./Hooks.js";
+import { Remote_exports, callCommand, callCommandWithUpdates, callPrerender, callQuery, liveQueryStream, submitForm, submitFormWithUpdates } from "./Remote.js";
+import { markerTransporter, transport, transporter } from "./transport.js";
+import { ResponseHeaders, responseHeadersTransporter } from "./response-headers.js";
+import { Hooks_exports, reroute } from "./Hooks.js";
 import { readConfig, sveltekitConfig, sveltekitConfigProvider } from "./config.js";
 import { apiClient } from "./api-client.js";
-export { Hooks_exports as Hooks, Remote_exports as Remote, ResponseHeaders, apiClient, load, makeUniversalRuntime, readConfig, sveltekitConfig, sveltekitConfigProvider };
+export { Hooks_exports as Hooks, Remote_exports as Remote, ResponseHeaders, apiClient, callCommand, callCommandWithUpdates, callPrerender, callQuery, liveQueryStream, load, makeUniversalRuntime, markerTransporter, readConfig, reroute, responseHeadersTransporter, submitForm, submitFormWithUpdates, sveltekitConfig, sveltekitConfigProvider, transport, transporter };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thomasfosterau/effect-sveltekit",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "Effect integration for SvelteKit: load/action/endpoint wrappers, remote functions, an effectKit() Vite plugin, and an Effect HTTP deployment adapter",
   "keywords": [
     "effect",