@typed/navigation 0.10.2 → 0.11.0

package/src/Navigation.ts

@@ -35,45 +35,45 @@ export interface Navigation {
   readonly navigate: (
     url: string | URL,
     options?: NavigateOptions
-  ) => Effect.Effect<never, NavigationError, Destination>
+  ) => Effect.Effect<Destination, NavigationError>
 
-  readonly back: (options?: { readonly info?: unknown }) => Effect.Effect<never, NavigationError, Destination>
+  readonly back: (options?: { readonly info?: unknown }) => Effect.Effect<Destination, NavigationError>
 
-  readonly forward: (options?: { readonly info?: unknown }) => Effect.Effect<never, NavigationError, Destination>
+  readonly forward: (options?: { readonly info?: unknown }) => Effect.Effect<Destination, NavigationError>
 
   readonly traverseTo: (
     key: Destination["key"],
     options?: { readonly info?: unknown }
-  ) => Effect.Effect<never, NavigationError, Destination>
+  ) => Effect.Effect<Destination, NavigationError>
 
   readonly updateCurrentEntry: (
     options: { readonly state: unknown }
-  ) => Effect.Effect<never, NavigationError, Destination>
+  ) => Effect.Effect<Destination, NavigationError>
 
   readonly reload: (
     options?: { readonly info?: unknown; readonly state?: unknown }
-  ) => Effect.Effect<never, NavigationError, Destination>
+  ) => Effect.Effect<Destination, NavigationError>
 
   readonly beforeNavigation: <R = never, R2 = never>(
     handler: BeforeNavigationHandler<R, R2>
-  ) => Effect.Effect<R | R2 | Scope.Scope, never, void>
+  ) => Effect.Effect<void, never, R | R2 | Scope.Scope>
 
   readonly onNavigation: <R = never, R2 = never>(
     handler: NavigationHandler<R, R2>
-  ) => Effect.Effect<R | R2 | Scope.Scope, never, void>
+  ) => Effect.Effect<void, never, R | R2 | Scope.Scope>
 
   readonly submit: (
     data: FormData,
     formInput?: Simplify<Omit<FormInputFrom, "data">>
   ) => Effect.Effect<
-    HttpClient.client.Client.Default,
+    Option.Option<HttpClient.response.ClientResponse>,
     NavigationError | HttpClient.error.HttpClientError,
-    Option.Option<HttpClient.response.ClientResponse>
+    Scope.Scope | HttpClient.client.Client.Default
   >
 
   readonly onFormData: <R = never, R2 = never>(
     handler: FormDataHandler<R, R2>
-  ) => Effect.Effect<R | R2 | Scope.Scope, never, void>
+  ) => Effect.Effect<void, never, R | R2 | Scope.Scope>
 }
 
 /**
@@ -203,11 +203,11 @@ export interface NavigationEvent extends Schema.Schema.To<typeof NavigationEvent
 export type BeforeNavigationHandler<R, R2> = (
   event: BeforeNavigationEvent
 ) => Effect.Effect<
-  R,
-  RedirectError | CancelNavigation,
   Option.Option<
-    Effect.Effect<R2, RedirectError | CancelNavigation, unknown>
-  >
+    Effect.Effect<unknown, RedirectError | CancelNavigation, R2>
+  >,
+  RedirectError | CancelNavigation,
+  R
 >
 
 /**
@@ -216,11 +216,11 @@ export type BeforeNavigationHandler<R, R2> = (
 export type NavigationHandler<R, R2> = (
   event: NavigationEvent
 ) => Effect.Effect<
-  R,
-  never,
   Option.Option<
-    Effect.Effect<R2, never, unknown>
-  >
+    Effect.Effect<unknown, never, R2>
+  >,
+  never,
+  R
 >
 
 /**
@@ -229,11 +229,11 @@ export type NavigationHandler<R, R2> = (
 export type FormDataHandler<R, R2> = (
   event: FormDataEvent
 ) => Effect.Effect<
-  R,
-  RedirectError | CancelNavigation,
   Option.Option<
-    Effect.Effect<R2, RedirectError | CancelNavigation, Option.Option<HttpClient.response.ClientResponse>>
-  >
+    Effect.Effect<Option.Option<HttpClient.response.ClientResponse>, RedirectError | CancelNavigation, R2>
+  >,
+  RedirectError | CancelNavigation,
+  R
 >
 
 /**
@@ -400,12 +400,12 @@ export function isCancelNavigation(e: unknown): e is CancelNavigation {
 export const navigate = (
   url: string | URL,
   options?: NavigateOptions
-): Effect.Effect<Navigation, NavigationError, Destination> => Navigation.withEffect((n) => n.navigate(url, options))
+): Effect.Effect<Destination, NavigationError, Navigation> => Navigation.withEffect((n) => n.navigate(url, options))
 
 /**
  * @since 1.0.0
  */
-export const back: (options?: { readonly info?: unknown }) => Effect.Effect<Navigation, NavigationError, Destination> =
+export const back: (options?: { readonly info?: unknown }) => Effect.Effect<Destination, NavigationError, Navigation> =
   (opts) => Navigation.withEffect((n) => n.back(opts))
 
 /**
@@ -413,7 +413,7 @@ export const back: (options?: { readonly info?: unknown }) => Effect.Effect<Navi
  */
 export const forward: (
   options?: { readonly info?: unknown }
-) => Effect.Effect<Navigation, NavigationError, Destination> = (
+) => Effect.Effect<Destination, NavigationError, Navigation> = (
   opts
 ) => Navigation.withEffect((n) => n.forward(opts))
 
@@ -423,7 +423,7 @@ export const forward: (
 export const traverseTo: (
   key: Uuid,
   options?: { readonly info?: unknown }
-) => Effect.Effect<Navigation, NavigationError, Destination> = (key, opts) =>
+) => Effect.Effect<Destination, NavigationError, Navigation> = (key, opts) =>
   Navigation.withEffect((n) => n.traverseTo(key, opts))
 
 /**
@@ -431,7 +431,7 @@ export const traverseTo: (
  */
 export const updateCurrentEntry: (
   options: { readonly state: unknown }
-) => Effect.Effect<Navigation, NavigationError, Destination> = (opts) =>
+) => Effect.Effect<Destination, NavigationError, Navigation> = (opts) =>
   Navigation.withEffect((n) => n.updateCurrentEntry(opts))
 
 /**
@@ -439,7 +439,7 @@ export const updateCurrentEntry: (
  */
 export const reload: (
   options?: { readonly info?: unknown; readonly state?: unknown }
-) => Effect.Effect<Navigation, NavigationError, Destination> = (
+) => Effect.Effect<Destination, NavigationError, Navigation> = (
   opts
 ) => Navigation.withEffect((n) => n.reload(opts))
 
@@ -508,9 +508,9 @@ export function submit(
   data: FormData,
   formInput?: Simplify<Omit<FormInputFrom, "data">>
 ): Effect.Effect<
-  Navigation | HttpClient.client.Client.Default,
+  Option.Option<HttpClient.response.ClientResponse>,
   NavigationError | HttpClient.error.HttpClientError,
-  Option.Option<HttpClient.response.ClientResponse>
+  Navigation | HttpClient.client.Client.Default | Scope.Scope
 > {
   return Navigation.withEffect((n) => n.submit(data, formInput))
 }
@@ -520,6 +520,6 @@ export function submit(
  */
 export function onFormData<R = never, R2 = never>(
   handler: FormDataHandler<R, R2>
-): Effect.Effect<Navigation | R | R2 | Scope.Scope, never, void> {
+): Effect.Effect<void, never, Navigation | R | R2 | Scope.Scope> {
   return Navigation.withEffect((n) => n.onFormData(handler))
 }

package/src/internal/fromWindow.ts

@@ -38,7 +38,7 @@ declare global {
   }
 }
 
-export const fromWindow: Layer.Layer<Window, never, Navigation> = Navigation.scoped(
+export const fromWindow: Layer.Layer<Navigation, never, Window> = Navigation.scoped(
   Window.withEffect((window) => {
     const getRandomValues = (length: number) => Effect.sync(() => window.crypto.getRandomValues(new Uint8Array(length)))
     return Effect.gen(function*(_) {
@@ -108,12 +108,8 @@ const getNavigationState = (navigation: NativeNavigation): NavigationState => {
 
 function setupWithNavigation(
   navigation: NativeNavigation,
-  runPromise: <E, A>(effect: Effect.Effect<Scope.Scope, E, A>) => Promise<A>
-): Effect.Effect<
-  Scope.Scope | GetRandomValues,
-  never,
-  ModelAndIntent
-> {
+  runPromise: <E, A>(effect: Effect.Effect<A, E, Scope.Scope>) => Promise<A>
+): Effect.Effect<ModelAndIntent, never, Scope.Scope | GetRandomValues> {
   return Effect.gen(function*(_) {
     const state = yield* _(
       RefSubject.fromEffect(
@@ -150,7 +146,7 @@ function setupWithNavigation(
     const runHandlers = (native: NativeEvent) =>
       Effect.gen(function*(_) {
         const eventHandlers = yield* _(handlers)
-        const matches: Array<Effect.Effect<never, never, unknown>> = []
+        const matches: Array<Effect.Effect<unknown>> = []
 
         const event: NavigationEvent = {
           type: native.navigationType,
@@ -220,11 +216,7 @@ function shouldNotIntercept(navigationEvent: NativeEvent): boolean {
 function setupWithHistory(
   window: Window,
   onEvent: (event: HistoryEvent) => void
-): Effect.Effect<
-  GetRandomValues | Scope.Scope,
-  never,
-  ModelAndIntent
-> {
+): Effect.Effect<ModelAndIntent, never, GetRandomValues | Scope.Scope> {
   return Effect.gen(function*(_) {
     const { location } = window
     const { original: history, unpatch } = patchHistory(window, onEvent)
@@ -355,11 +347,15 @@ function patchHistory(window: Window, onEvent: (event: HistoryEvent) => void) {
 
   // In a proper browser this will allow patching to hide the id/key's associated with the state
   if (stateDescriptor) {
-    Object.defineProperty(history, "state", {
-      get() {
-        return getOriginalState(stateDescriptor.get!.call(history))
-      }
-    })
+    try {
+      Object.defineProperty(history, "state", {
+        get() {
+          return getOriginalState(stateDescriptor.get!.call(history))
+        }
+      })
+    } catch {
+      // We tried, but it didn't work
+    }
   }
 
   const onHashChange = (ev: HashChangeEvent) => {
@@ -386,7 +382,11 @@ function patchHistory(window: Window, onEvent: (event: HistoryEvent) => void) {
     history.forward = original.forward
 
     if (stateDescriptor) {
-      Object.defineProperty(history, "state", stateDescriptor)
+      try {
+        Object.defineProperty(history, "state", stateDescriptor)
+      } catch {
+        // We tried, but it didn't work
+      }
     }
 
     window.removeEventListener("hashchange", onHashChange)
@@ -403,19 +403,15 @@ function patchHistory(window: Window, onEvent: (event: HistoryEvent) => void) {
 type ScopedRuntime<R> = {
   readonly runtime: Runtime.Runtime<R | Scope.Scope>
   readonly scope: Scope.Scope
-  readonly run: <E, A>(effect: Effect.Effect<R | Scope.Scope, E, A>) => Fiber.RuntimeFiber<E, A>
-  readonly runPromise: <E, A>(effect: Effect.Effect<R | Scope.Scope, E, A>) => Promise<A>
+  readonly run: <E, A>(effect: Effect.Effect<A, E, R | Scope.Scope>) => Fiber.RuntimeFiber<A, E>
+  readonly runPromise: <E, A>(effect: Effect.Effect<A, E, R | Scope.Scope>) => Promise<A>
 }
 
-function scopedRuntime<R>(): Effect.Effect<
-  R | Scope.Scope,
-  never,
-  ScopedRuntime<R>
-> {
+function scopedRuntime<R>(): Effect.Effect<ScopedRuntime<R>, never, R | Scope.Scope> {
   return Effect.map(Effect.runtime<R | Scope.Scope>(), (runtime) => {
     const scope = Context.get(runtime.context, Scope.Scope)
     const runFork = Runtime.runFork(runtime)
-    const runPromise = <E, A>(effect: Effect.Effect<R | Scope.Scope, E, A>): Promise<A> =>
+    const runPromise = <E, A>(effect: Effect.Effect<A, E, R | Scope.Scope>): Promise<A> =>
       new Promise((resolve, reject) => {
         const fiber = runFork(effect, { scope })
         fiber.addObserver(Exit.match({

package/src/internal/memory.ts

@@ -18,7 +18,7 @@ import {
   setupFromModelAndIntent
 } from "./shared.js"
 
-export const memory = (options: MemoryOptions): Layer.Layer<never, never, Navigation> =>
+export const memory = (options: MemoryOptions): Layer.Layer<Navigation> =>
   Navigation.scoped(
     Effect.gen(function*(_) {
       const getRandomValues = yield* _(GetRandomValues)
@@ -33,7 +33,7 @@ export const memory = (options: MemoryOptions): Layer.Layer<never, never, Naviga
 
 export function initialMemory(
   options: InitialMemoryOptions
-): Layer.Layer<never, never, Navigation> {
+): Layer.Layer<Navigation> {
   return Navigation.scoped(
     Effect.gen(function*(_) {
       const getRandomValues = yield* _(GetRandomValues)
@@ -56,11 +56,7 @@ export function initialMemory(
 
 function setupMemory(
   options: MemoryOptions
-): Effect.Effect<
-  GetRandomValues | Scope.Scope,
-  never,
-  ModelAndIntent
-> {
+): Effect.Effect<ModelAndIntent, never, GetRandomValues | Scope.Scope> {
   return Effect.gen(function*(_) {
     const state = yield* _(
       RefSubject.fromEffect(

package/src/internal/shared.ts

@@ -92,7 +92,7 @@ export function setupFromModelAndIntent(
   const runBeforeHandlers = (event: BeforeNavigationEvent) =>
     Effect.gen(function*(_) {
       const handlers = yield* _(beforeHandlers)
-      const matches: Array<Effect.Effect<never, RedirectError | CancelNavigation, unknown>> = []
+      const matches: Array<Effect.Effect<unknown, RedirectError | CancelNavigation>> = []
 
       for (const [handler, ctx] of handlers) {
         const exit = yield* _(handler(event), Effect.provide(ctx), Effect.either)
@@ -121,7 +121,7 @@ export function setupFromModelAndIntent(
   const runHandlers = (event: NavigationEvent) =>
     Effect.gen(function*(_) {
       const eventHandlers = yield* _(handlers)
-      const matches: Array<Effect.Effect<never, never, unknown>> = []
+      const matches: Array<Effect.Effect<unknown>> = []
 
       for (const [handler, ctx] of eventHandlers) {
         const match = yield* _(handler(event), Effect.provide(ctx))
@@ -138,14 +138,14 @@ export function setupFromModelAndIntent(
   const runFormDataHandlers = (
     event: FormDataEvent
   ): Effect.Effect<
-    HttpClient.client.Client.Default,
+    Either.Either<RedirectError | CancelNavigation, Option.Option<HttpClient.response.ClientResponse>>,
     NavigationError | HttpClient.error.HttpClientError,
-    Either.Either<RedirectError | CancelNavigation, Option.Option<HttpClient.response.ClientResponse>>
+    Scope.Scope | HttpClient.client.Client.Default
   > =>
     Effect.gen(function*(_) {
       const handlers = yield* _(formDataHandlers)
       const matches: Array<
-        Effect.Effect<never, RedirectError | CancelNavigation, Option.Option<HttpClient.response.ClientResponse>>
+        Effect.Effect<Option.Option<HttpClient.response.ClientResponse>, RedirectError | CancelNavigation>
       > = []
 
       for (const [handler, ctx] of handlers) {
@@ -183,11 +183,11 @@ export function setupFromModelAndIntent(
 
   const runNavigationEvent = (
     beforeEvent: BeforeNavigationEvent,
-    get: Effect.Effect<never, never, NavigationState>,
-    set: (a: NavigationState) => Effect.Effect<never, never, NavigationState>,
+    get: Effect.Effect<NavigationState>,
+    set: (a: NavigationState) => Effect.Effect<NavigationState>,
     depth: number,
     skipCommit: boolean = false
-  ): Effect.Effect<never, NavigationError, Destination> =>
+  ): Effect.Effect<Destination, NavigationError> =>
     Effect.gen(function*(_) {
       let current = yield* _(get)
       current = yield* _(set({ ...current, transition: Option.some(beforeEvent) }))
@@ -246,10 +246,10 @@ export function setupFromModelAndIntent(
 
   const handleError = (
     error: RedirectError | CancelNavigation,
-    get: Effect.Effect<never, never, NavigationState>,
-    set: (a: NavigationState) => Effect.Effect<never, never, NavigationState>,
+    get: Effect.Effect<NavigationState>,
+    set: (a: NavigationState) => Effect.Effect<NavigationState>,
     depth: number
-  ): Effect.Effect<never, NavigationError, Destination> =>
+  ): Effect.Effect<Destination, NavigationError> =>
     Effect.gen(function*(_) {
       if (depth >= 25) {
         return yield* _(Effect.dieMessage(`Redirect loop detected.`))
@@ -355,7 +355,7 @@ export function setupFromModelAndIntent(
 
   const beforeNavigation = <R = never, R2 = never>(
     handler: BeforeNavigationHandler<R, R2>
-  ): Effect.Effect<R | R2 | Scope.Scope, never, void> =>
+  ): Effect.Effect<void, never, R | R2 | Scope.Scope> =>
     Effect.contextWithEffect((ctx) => {
       const entry = [handler, ctx] as const
 
@@ -373,7 +373,7 @@ export function setupFromModelAndIntent(
 
   const onNavigation = <R = never, R2 = never>(
     handler: NavigationHandler<R, R2>
-  ): Effect.Effect<R | R2 | Scope.Scope, never, void> =>
+  ): Effect.Effect<void, never, R | R2 | Scope.Scope> =>
     Effect.contextWithEffect((ctx) => {
       const entry = [handler, ctx] as const
 
@@ -410,9 +410,9 @@ export function setupFromModelAndIntent(
     data: FormData,
     input?: Omit<FormInputFrom, "data">
   ): Effect.Effect<
-    HttpClient.client.Client.Default,
+    Option.Option<HttpClient.response.ClientResponse>,
     NavigationError | HttpClient.error.HttpClientError,
-    Option.Option<HttpClient.response.ClientResponse>
+    Scope.Scope | HttpClient.client.Client.Default
   > =>
     state.runUpdates(({ get, set }) =>
       Effect.gen(function*(_) {
@@ -457,7 +457,7 @@ export function setupFromModelAndIntent(
 
   const onFormData = <R = never, R2 = never>(
     handler: FormDataHandler<R, R2>
-  ): Effect.Effect<R | R2 | Scope.Scope, never, void> =>
+  ): Effect.Effect<void, never, R | R2 | Scope.Scope> =>
     Effect.contextWithEffect((ctx) => {
       const entry = [handler, ctx] as const