@typed/navigation 0.17.0 → 0.18.1

package/dist/Navigation.d.ts

@@ -0,0 +1,79 @@
+import type { HttpClientResponse } from '@effect/platform';
+import type { HttpClient } from '@effect/platform/HttpClient';
+import * as LazyRef from '@typed/lazy-ref';
+import * as Context from 'effect/Context';
+import * as Effect from 'effect/Effect';
+import type * as Option from 'effect/Option';
+import type * as Scope from 'effect/Scope';
+import type { Destination } from './Destination.js';
+import { CancelNavigation, type FormSubmitError, NavigationError, RedirectError } from './Error.js';
+import type { TransitionEvent } from './Event.js';
+import type { FormSubmit } from './Forms.js';
+import type { BeforeNavigationHandler, NavigationHandler } from './Handler.js';
+import type { NavigateOptions } from './NavigateOptions.js';
+export interface Navigation {
+    readonly origin: string;
+    readonly base: string;
+    readonly currentEntry: LazyRef.Computed<Destination>;
+    readonly entries: LazyRef.Computed<ReadonlyArray<Destination>>;
+    readonly transition: LazyRef.Computed<Option.Option<TransitionEvent>>;
+    readonly canGoBack: LazyRef.Computed<boolean>;
+    readonly canGoForward: LazyRef.Computed<boolean>;
+    readonly navigate: (url: string | URL, options?: NavigateOptions) => Effect.Effect<Destination, NavigationError>;
+    readonly back: (options?: {
+        readonly info?: unknown;
+    }) => Effect.Effect<Destination, NavigationError>;
+    readonly forward: (options?: {
+        readonly info?: unknown;
+    }) => Effect.Effect<Destination, NavigationError>;
+    readonly traverseTo: (key: Destination['key'], options?: {
+        readonly info?: unknown;
+    }) => Effect.Effect<Destination, NavigationError>;
+    readonly updateCurrentEntry: (options: {
+        readonly state: unknown;
+    }) => Effect.Effect<Destination, NavigationError>;
+    readonly reload: (options?: {
+        readonly info?: unknown;
+        readonly state?: unknown;
+    }) => Effect.Effect<Destination, NavigationError>;
+    readonly beforeNavigation: <R = never, R2 = never>(handler: BeforeNavigationHandler<R, R2>) => Effect.Effect<void, never, R | R2 | Scope.Scope>;
+    readonly onNavigation: <R = never, R2 = never>(handler: NavigationHandler<R, R2>) => Effect.Effect<void, never, R | R2 | Scope.Scope>;
+    readonly submit: (form: FormSubmit) => Effect.Effect<readonly [Destination, HttpClientResponse.HttpClientResponse], NavigationError | FormSubmitError, Navigation | HttpClient | Scope.Scope>;
+}
+export declare const Navigation: Context.Tag<Navigation, Navigation>;
+export declare const CurrentEntry: LazyRef.Computed<Destination, never, Navigation>;
+export declare const Entries: LazyRef.Computed<ReadonlyArray<Destination>, never, Navigation>;
+export declare function getCurrentPathFromUrl(location: Pick<URL, 'pathname' | 'search' | 'hash'>): string;
+export declare const CurrentPath: LazyRef.Computed<string, never, Navigation>;
+export declare const CanGoForward: LazyRef.Computed<boolean, never, Navigation>;
+export declare const CanGoBack: LazyRef.Computed<boolean, never, Navigation>;
+export declare const navigate: (url: string | URL, options?: NavigateOptions) => Effect.Effect<Destination, NavigationError, Navigation>;
+export declare const back: (options?: {
+    readonly info?: unknown;
+}) => Effect.Effect<Destination, NavigationError, Navigation>;
+export declare const forward: (options?: {
+    readonly info?: unknown;
+}) => Effect.Effect<Destination, NavigationError, Navigation>;
+export declare const traverseTo: (key: string, options?: {
+    readonly info?: unknown;
+}) => Effect.Effect<Destination, NavigationError, Navigation>;
+export declare const updateCurrentEntry: (options: {
+    readonly state: unknown;
+}) => Effect.Effect<Destination, NavigationError, Navigation>;
+export declare const reload: (options?: {
+    readonly info?: unknown;
+    readonly state?: unknown;
+}) => Effect.Effect<Destination, NavigationError, Navigation>;
+export declare const Transition: LazyRef.Computed<Option.Option<TransitionEvent>, never, Navigation>;
+export declare function handleRedirect(error: RedirectError): Effect.Effect<Destination, NavigationError, Navigation>;
+export declare function redirectToPath(path: string | URL, options?: {
+    readonly state?: unknown;
+    readonly info?: unknown;
+}): RedirectError;
+export declare function isNavigationError(e: unknown): e is NavigationError;
+export declare function isRedirectError(e: unknown): e is RedirectError;
+export declare function isCancelNavigation(e: unknown): e is CancelNavigation;
+export declare const cancelNavigation: Effect.Effect<never, CancelNavigation, never>;
+export declare function beforeNavigation<R = never, R2 = never>(handler: BeforeNavigationHandler<R, R2>): Effect.Effect<void, never, Navigation | R | R2 | Scope.Scope>;
+export declare function onNavigation<R = never, R2 = never>(handler: NavigationHandler<R, R2>): Effect.Effect<void, never, Navigation | R | R2 | Scope.Scope>;
+export declare function submit(form: FormSubmit): Effect.Effect<readonly [Destination, HttpClientResponse.HttpClientResponse], NavigationError | FormSubmitError, Navigation | HttpClient | Scope.Scope>;

package/dist/Navigation.js

@@ -0,0 +1,49 @@
+import * as LazyRef from '@typed/lazy-ref';
+import * as Context from 'effect/Context';
+import * as Effect from 'effect/Effect';
+import { CancelNavigation, NavigationError, RedirectError } from './Error.js';
+export const Navigation = Context.GenericTag('@typed/Navigation');
+export const CurrentEntry = LazyRef.computedFromTag(Navigation, (nav) => nav.currentEntry);
+export const Entries = LazyRef.computedFromTag(Navigation, (nav) => nav.entries);
+export function getCurrentPathFromUrl(location) {
+    return location.pathname + location.search + location.hash;
+}
+export const CurrentPath = LazyRef.computedFromTag(Navigation, (nav) => LazyRef.map(nav.currentEntry, (e) => getCurrentPathFromUrl(e.url)));
+export const CanGoForward = LazyRef.computedFromTag(Navigation, (nav) => nav.canGoForward);
+export const CanGoBack = LazyRef.computedFromTag(Navigation, (nav) => nav.canGoBack);
+export const navigate = (url, options) => Effect.flatMap(Navigation, (nav) => nav.navigate(url, options));
+export const back = (opts) => Effect.flatMap(Navigation, (nav) => nav.back(opts));
+export const forward = (opts) => Effect.flatMap(Navigation, (nav) => nav.forward(opts));
+export const traverseTo = (key, opts) => Effect.flatMap(Navigation, (nav) => nav.traverseTo(key, opts));
+export const updateCurrentEntry = (opts) => Effect.flatMap(Navigation, (nav) => nav.updateCurrentEntry(opts));
+export const reload = (opts) => Effect.flatMap(Navigation, (nav) => nav.reload(opts));
+export const Transition = LazyRef.computedFromTag(Navigation, (nav) => nav.transition);
+export function handleRedirect(error) {
+    return navigate(error.path, {
+        history: 'replace',
+        ...error.options,
+    });
+}
+export function redirectToPath(path, options) {
+    return new RedirectError({ path, options });
+}
+export function isNavigationError(e) {
+    return NavigationError.is(e);
+}
+export function isRedirectError(e) {
+    return RedirectError.is(e);
+}
+export function isCancelNavigation(e) {
+    return CancelNavigation.is(e);
+}
+export const cancelNavigation = Effect.suspend(() => new CancelNavigation());
+export function beforeNavigation(handler) {
+    return Effect.flatMap(Navigation, (nav) => nav.beforeNavigation(handler));
+}
+export function onNavigation(handler) {
+    return Effect.flatMap(Navigation, (nav) => nav.onNavigation(handler));
+}
+export function submit(form) {
+    return Effect.flatMap(Navigation, (nav) => nav.submit(form));
+}
+//# sourceMappingURL=Navigation.js.map

package/dist/Navigation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Navigation.js","sourceRoot":"","sources":["../src/Navigation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,OAAO,MAAM,iBAAiB,CAAA;AAC1C,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAIvC,OAAO,EAAE,gBAAgB,EAAwB,eAAe,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAoEnG,MAAM,CAAC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAa,mBAAmB,CAAC,CAAA;AAE7E,MAAM,CAAC,MAAM,YAAY,GACvB,OAAO,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;AAEhE,MAAM,CAAC,MAAM,OAAO,GAIhB,OAAO,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;AAE7D,MAAM,UAAU,qBAAqB,CAAC,QAAmD;IACvF,OAAO,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAA;AAC5D,CAAC;AAED,MAAM,CAAC,MAAM,WAAW,GAAgD,OAAO,CAAC,eAAe,CAC7F,UAAU,EACV,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAC5E,CAAA;AAED,MAAM,CAAC,MAAM,YAAY,GAAiD,OAAO,CAAC,eAAe,CAC/F,UAAU,EACV,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,YAAY,CAC1B,CAAA;AAED,MAAM,CAAC,MAAM,SAAS,GAAiD,OAAO,CAAC,eAAe,CAC5F,UAAU,EACV,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,CACvB,CAAA;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,GAAiB,EACjB,OAAyB,EACgC,EAAE,CAC3D,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAA;AAEjE,MAAM,CAAC,MAAM,IAAI,GAIb,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;AAEjE,MAAM,CAAC,MAAM,OAAO,GAIhB,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;AAEpE,MAAM,CAAC,MAAM,UAAU,GAGwC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAC3E,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAA;AAEhE,MAAM,CAAC,MAAM,kBAAkB,GAI3B,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAA;AAE/E,MAAM,CAAC,MAAM,MAAM,GAG6C,CAAC,IAAI,EAAE,EAAE,CACvE,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;AAEvD,MAAM,CAAC,MAAM,UAAU,GAInB,OAAO,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;AAEhE,MAAM,UAAU,cAAc,CAAC,KAAoB;IACjD,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE;QAC1B,OAAO,EAAE,SAAS;QAClB,GAAG,KAAK,CAAC,OAAO;KACjB,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,IAAkB,EAClB,OAA+D;IAE/D,OAAO,IAAI,aAAa,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;AAC7C,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,CAAU;IAC1C,OAAO,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAC9B,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,CAAU;IACxC,OAAO,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAC5B,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,CAAU;IAC3C,OAAO,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAC/B,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,gBAAgB,EAAE,CAAC,CAAA;AAE5E,MAAM,UAAU,gBAAgB,CAC9B,OAAuC;IAEvC,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAA;AAC3E,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,OAAiC;IAEjC,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;AACvE,CAAC;AAED,MAAM,UAAU,MAAM,CACpB,IAAgB;IAMhB,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;AAC9D,CAAC"}

package/dist/NavigationType.d.ts

@@ -0,0 +1,3 @@
+import * as Schema from 'effect/Schema';
+export declare const NavigationType: Schema.Literal<["push", "replace", "reload", "traverse"]>;
+export type NavigationType = typeof NavigationType.Type;

package/dist/NavigationType.js

@@ -0,0 +1,3 @@
+import * as Schema from 'effect/Schema';
+export const NavigationType = Schema.Literal('push', 'replace', 'reload', 'traverse');
+//# sourceMappingURL=NavigationType.js.map

package/dist/NavigationType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NavigationType.js","sourceRoot":"","sources":["../src/NavigationType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAA"}

package/dist/ProposedDestination.d.ts

@@ -0,0 +1,13 @@
+import * as Schema from 'effect/Schema';
+export declare const ProposedDestination: Schema.SchemaClass<{
+    readonly url: URL;
+    readonly state: unknown;
+    readonly sameDocument: boolean;
+}, {
+    readonly url: string;
+    readonly state: unknown;
+    readonly sameDocument: boolean;
+}, never>;
+export type ProposedDestinationEncoded = Schema.Schema.Encoded<typeof ProposedDestination>;
+export interface ProposedDestination extends Schema.Schema.Type<typeof ProposedDestination> {
+}

package/dist/ProposedDestination.js

@@ -0,0 +1,4 @@
+import * as Schema from 'effect/Schema';
+import { Destination } from './Destination.js';
+export const ProposedDestination = Destination.pipe(Schema.omit('id', 'key'));
+//# sourceMappingURL=ProposedDestination.js.map

package/dist/ProposedDestination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProposedDestination.js","sourceRoot":"","sources":["../src/ProposedDestination.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9C,MAAM,CAAC,MAAM,mBAAmB,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAA"}

package/dist/Url.d.ts

@@ -0,0 +1,13 @@
+import * as Schema from 'effect/Schema';
+export declare const UrlFromSelf: Schema.instanceOf<URL>;
+export declare const Url: Schema.transformOrFail<typeof Schema.String, Schema.instanceOf<URL>, never>;
+export declare const UrlSearchParamsFromSelf: Schema.instanceOf<URLSearchParams>;
+export declare const UrlSearchParamsFromString: Schema.transform<typeof Schema.String, Schema.instanceOf<URLSearchParams>>;
+export declare const UrlSearchParams: Schema.transform<Schema.Record$<typeof Schema.String, Schema.Union<[typeof Schema.String, Schema.Array$<typeof Schema.String>]>>, Schema.instanceOf<URLSearchParams>>;
+type AnySchemaEncoded<T> = Schema.Schema<any, T, any> | Schema.Schema<any, T, never>;
+type AnyFormDataFieldSchema = AnySchemaEncoded<string> | AnySchemaEncoded<readonly string[]> | AnySchemaEncoded<string | readonly string[]>;
+type UrlSearchParamsFields = Record<string, AnyFormDataFieldSchema>;
+export declare function schemaUrlSearchParams<const Fields extends UrlSearchParamsFields>(fields: Fields): Schema.Schema<{
+    readonly [K in keyof Schema.Struct.Type<Fields>]: Schema.Struct.Type<Fields>[K];
+}, URLSearchParams, Schema.Schema.Context<Fields[keyof Fields]>>;
+export {};

package/dist/Url.js

@@ -0,0 +1,72 @@
+import * as Effect from 'effect/Effect';
+import * as ParseResult from 'effect/ParseResult';
+import * as Schema from 'effect/Schema';
+export const UrlFromSelf = Schema.instanceOf(URL).annotations({
+    equivalence: () => (a, b) => a.href === b.href,
+    jsonSchema: {
+        title: 'URL',
+        identifier: 'URL',
+        type: 'string',
+        format: 'uri',
+    },
+});
+export const Url = Schema.String.pipe(Schema.transformOrFail(UrlFromSelf, {
+    decode: (s) => Effect.try({
+        try: () => new URL(s),
+        catch: () => new ParseResult.Type(UrlFromSelf.ast, s, 'Expected a URL'),
+    }),
+    encode: (url) => Effect.succeed(url.href),
+}));
+export const UrlSearchParamsFromSelf = Schema.instanceOf(URLSearchParams).annotations({
+    equivalence: () => (a, b) => a.toString() === b.toString(),
+});
+export const UrlSearchParamsFromString = Schema.String.pipe(Schema.transform(UrlSearchParamsFromSelf, {
+    decode: (s) => new URLSearchParams(s),
+    encode: (searchParams) => `?${searchParams.toString()}`,
+}));
+export const UrlSearchParams = Schema.Record({
+    key: Schema.String,
+    value: Schema.Union(Schema.String, Schema.Array(Schema.String)),
+}).pipe(Schema.transform(UrlSearchParamsFromSelf, {
+    strict: true,
+    decode: structToUrlSearchParams,
+    encode: urlSearchParamsToStruct,
+}));
+export function schemaUrlSearchParams(fields) {
+    const struct = Schema.Struct(fields);
+    const encode = ParseResult.encode(struct);
+    const decode = ParseResult.decodeUnknown(struct);
+    return Schema.transformOrFail(UrlSearchParamsFromSelf, Schema.typeSchema(struct), {
+        strict: true,
+        decode: (searchParams) => decode(urlSearchParamsToStruct(searchParams)),
+        encode: (struct) => Effect.map(encode(struct), (_) => structToUrlSearchParams(_)),
+    });
+}
+function structToUrlSearchParams(struct) {
+    const searchParams = new URLSearchParams();
+    for (const [key, value] of Object.entries(struct)) {
+        if (Array.isArray(value)) {
+            for (const v of value) {
+                searchParams.append(key, v);
+            }
+        }
+        else {
+            searchParams.set(key, value);
+        }
+    }
+    return searchParams;
+}
+function urlSearchParamsToStruct(searchParams) {
+    const struct = {};
+    searchParams.forEach((_, key) => {
+        const values = searchParams.getAll(key);
+        if (values.length === 1) {
+            struct[key] = values[0];
+        }
+        else {
+            struct[key] = values;
+        }
+    });
+    return struct;
+}
+//# sourceMappingURL=Url.js.map

package/dist/Url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Url.js","sourceRoot":"","sources":["../src/Url.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,WAAW,MAAM,oBAAoB,CAAA;AACjD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC;IAC5D,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI;IAC9C,UAAU,EAAE;QACV,KAAK,EAAE,KAAK;QACZ,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,KAAK;KACd;CACF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CACnC,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE;IAClC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CACZ,MAAM,CAAC,GAAG,CAAC;QACT,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;QACrB,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,EAAE,gBAAgB,CAAC;KACxE,CAAC;IACJ,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;CAC1C,CAAC,CACH,CAAA;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG,MAAM,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,WAAW,CAAC;IACpF,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,QAAQ,EAAE;CAC3D,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CACzD,MAAM,CAAC,SAAS,CAAC,uBAAuB,EAAE;IACxC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC;IACrC,MAAM,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE;CACxD,CAAC,CACH,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC;IAC3C,GAAG,EAAE,MAAM,CAAC,MAAM;IAClB,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;CAChE,CAAC,CAAC,IAAI,CACL,MAAM,CAAC,SAAS,CAAC,uBAAuB,EAAE;IACxC,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,uBAAuB;IAC/B,MAAM,EAAE,uBAAuB;CAChC,CAAC,CACH,CAAA;AAUD,MAAM,UAAU,qBAAqB,CACnC,MAAc;IAMd,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IACpC,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IACzC,MAAM,MAAM,GAAG,WAAW,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;IAEhD,OAAO,MAAM,CAAC,eAAe,CAAC,uBAAuB,EAAE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;QAChF,MAAM,EAAE,IAAI;QACZ,MAAM,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,MAAM,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;QACvE,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CACjB,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAC/B,uBAAuB,CAAC,CAAyD,CAAC,CACnF;KACJ,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,uBAAuB,CAC9B,MAA4D;IAE5D,MAAM,YAAY,GAAG,IAAI,eAAe,EAAE,CAAA;IAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;gBACtB,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;YAC7B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAe,CAAC,CAAA;QACxC,CAAC;IACH,CAAC;IACD,OAAO,YAAY,CAAA;AACrB,CAAC;AAED,SAAS,uBAAuB,CAC9B,YAA6B;IAE7B,MAAM,MAAM,GAA+C,EAAE,CAAA;IAC7D,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;QAC9B,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACvC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;QACzB,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAA;QACtB,CAAC;IACH,CAAC,CAAC,CAAA;IACF,OAAO,MAAM,CAAA;AACf,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+export * from './Blocking.js';
+export * from './Destination.js';
+export * from './Error.js';
+export * from './Event.js';
+export * from './Forms.js';
+export * from './Handler.js';
+export * from './Layer.js';
+export * from './NavigateOptions.js';
+export * from './Navigation.js';
+export * from './NavigationType.js';
+export * from './ProposedDestination.js';
+export * from './Url.js';

package/dist/index.js

@@ -0,0 +1,13 @@
+export * from './Blocking.js';
+export * from './Destination.js';
+export * from './Error.js';
+export * from './Event.js';
+export * from './Forms.js';
+export * from './Handler.js';
+export * from './Layer.js';
+export * from './NavigateOptions.js';
+export * from './Navigation.js';
+export * from './NavigationType.js';
+export * from './ProposedDestination.js';
+export * from './Url.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,sBAAsB,CAAA;AACpC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,qBAAqB,CAAA;AACnC,cAAc,0BAA0B,CAAA;AACxC,cAAc,UAAU,CAAA"}

package/dist/internal/fromWindow.d.ts

@@ -0,0 +1,4 @@
+import { GetRandomValues } from '@typed/id';
+import * as Layer from 'effect/Layer';
+import { Navigation } from '../Navigation.js';
+export declare const fromWindow: (window: Window) => Layer.Layer<Navigation, never, GetRandomValues>;

package/dist/internal/fromWindow.js

@@ -0,0 +1,358 @@
+import { GetRandomValues, Uuid4 } from '@typed/id';
+import * as LazyRef from '@typed/lazy-ref';
+import { Schema } from 'effect';
+import * as Context from 'effect/Context';
+import * as Effect from 'effect/Effect';
+import * as Exit from 'effect/Exit';
+import * as Layer from 'effect/Layer';
+import * as Option from 'effect/Option';
+import * as Runtime from 'effect/Runtime';
+import * as Scope from 'effect/Scope';
+import { NavigationError } from '../Error.js';
+import { Navigation } from '../Navigation.js';
+import { getOriginalState, getUrl, isPatchedState, makeDestination, makeHandlersState, NavigationState, setupFromModelAndIntent, } from './shared.js';
+export const fromWindow = (window) => Layer.scoped(Navigation, Effect.gen(function* () {
+    const getRandomValues = yield* GetRandomValues;
+    const { run, runPromise } = yield* scopedRuntime();
+    const hasNativeNavigation = !!window.navigation;
+    const base = getBaseHref(window);
+    const modelAndIntent = yield* hasNativeNavigation
+        ? setupWithNavigation(window.navigation, runPromise)
+        : setupWithHistory(window, base, (event) => run(handleHistoryEvent(event)));
+    const navigation = setupFromModelAndIntent(modelAndIntent, window.location.origin, base, getRandomValues, hasNativeNavigation ? () => getNavigationState(window.navigation) : undefined);
+    return navigation;
+    function handleHistoryEvent(event) {
+        return Effect.gen(function* () {
+            if (event._tag === 'PushState') {
+                return yield* navigation.navigate(event.url, {}, event.skipCommit);
+            }
+            else if (event._tag === 'ReplaceState') {
+                if (Option.isSome(event.url)) {
+                    return yield* navigation.navigate(event.url.value, { history: 'replace', state: event.state }, event.skipCommit);
+                }
+                else {
+                    return yield* navigation.updateCurrentEntry(event);
+                }
+            }
+            else if (event._tag === 'Traverse') {
+                const { entries, index } = yield* modelAndIntent.state;
+                const toIndex = Math.min(Math.max(0, index + event.delta), entries.length - 1);
+                const to = entries[toIndex];
+                const result = yield* navigation.traverseTo(to.key, {}, event.skipCommit);
+                return result;
+            }
+            else {
+                yield* navigation.traverseTo(event.key, {}, event.skipCommit);
+                return yield* navigation.updateCurrentEntry({
+                    state: event.state,
+                });
+            }
+        });
+    }
+}));
+function getBaseHref(window) {
+    const base = window.document.querySelector('base');
+    return base ? base.href : '/';
+}
+const getNavigationState = (navigation) => {
+    const entries = navigation.entries().map(nativeEntryToDestination);
+    // biome-ignore lint/style/noNonNullAssertion: <explanation>
+    const { index } = navigation.currentEntry;
+    return {
+        entries,
+        index,
+        transition: Option.none(),
+    };
+};
+function setupWithNavigation(navigation, runPromise) {
+    return Effect.gen(function* () {
+        const state = yield* LazyRef.fromEffect(Effect.sync(() => getNavigationState(navigation)), {
+            eq: Schema.equivalence(Schema.typeSchema(NavigationState)),
+        });
+        const { beforeHandlers, handlers } = yield* makeHandlersState;
+        const commit = (to, event) => Effect.gen(function* () {
+            const { key, state, url } = to;
+            const { info, type } = event;
+            if (type === 'push' || type === 'replace') {
+                yield* Effect.promise(() => navigation.navigate(url.toString(), {
+                    history: type,
+                    state,
+                    info,
+                }).committed);
+            }
+            else if (event.type === 'reload') {
+                yield* Effect.promise(() => navigation.reload({ state, info }).committed);
+            }
+            else {
+                yield* Effect.promise(() => navigation.traverseTo(key, { info }).committed);
+            }
+        }).pipe(Effect.catchAllDefect((cause) => new NavigationError({ cause })));
+        const runHandlers = (native) => Effect.gen(function* () {
+            const eventHandlers = yield* handlers;
+            const matches = [];
+            const event = {
+                type: native.navigationType,
+                // biome-ignore lint/style/noNonNullAssertion: <explanation>
+                destination: nativeEntryToDestination(navigation.currentEntry),
+                info: native.info,
+            };
+            for (const [handler, ctx] of eventHandlers) {
+                const match = yield* Effect.provide(handler(event), ctx);
+                if (match !== undefined && Option.isSome(match)) {
+                    matches.push(Effect.provide(match.value, ctx));
+                }
+            }
+            if (matches.length > 0) {
+                yield* Effect.all(matches);
+            }
+        });
+        navigation.addEventListener('navigate', (ev) => {
+            if (shouldNotIntercept(ev))
+                return;
+            ev.intercept({
+                handler: () => runPromise(runHandlers(ev)),
+            });
+        });
+        return {
+            state,
+            beforeHandlers,
+            handlers,
+            commit,
+        };
+    });
+}
+function nativeEntryToDestination(entry) {
+    return {
+        id: Uuid4.make(entry.id),
+        key: Uuid4.make(entry.key),
+        // biome-ignore lint/style/noNonNullAssertion: <explanation>
+        url: new URL(entry.url),
+        state: entry.getState(),
+        sameDocument: entry.sameDocument,
+    };
+}
+function shouldNotIntercept(navigationEvent) {
+    return (!navigationEvent.canIntercept ||
+        // If this is just a hashChange,
+        // just let the browser handle scrolling to the content.
+        navigationEvent.hashChange ||
+        // If this is a download,
+        // let the browser perform the download.
+        !!navigationEvent.downloadRequest ||
+        // If this is a form submission,
+        // let that go to the server.
+        !!navigationEvent.formData);
+}
+function setupWithHistory(window, base, onEvent) {
+    return Effect.gen(function* () {
+        const { location } = window;
+        const { getHistoryState, original: history, unpatch } = patchHistory(window, onEvent, base);
+        yield* Effect.addFinalizer(() => unpatch);
+        const state = yield* LazyRef.fromEffect(Effect.suspend(() => Effect.map(makeDestination(new URL(location.href), getHistoryState(), location.origin), (destination) => ({
+            entries: [destination],
+            index: 0,
+            transition: Option.none(),
+        }))), { eq: Schema.equivalence(Schema.typeSchema(NavigationState)) });
+        const { beforeHandlers, handlers } = yield* makeHandlersState;
+        const commit = ({ id, key, state, url }, event) => Effect.sync(() => {
+            const { type } = event;
+            if (type === 'push') {
+                history.pushState({
+                    __typed__navigation__id__: id,
+                    __typed__navigation__key__: key,
+                    __typed__navigation__state__: state,
+                }, '', url);
+            }
+            else if (type === 'replace') {
+                history.replaceState({
+                    __typed__navigation__id__: id,
+                    __typed__navigation__key__: key,
+                    __typed__navigation__state__: state,
+                }, '', url);
+            }
+            else if (event.type === 'reload') {
+                location.reload();
+            }
+            else {
+                history.go(event.delta);
+                history.replaceState({
+                    __typed__navigation__id__: id,
+                    __typed__navigation__key__: key,
+                    __typed__navigation__state__: state,
+                }, '', window.location.href);
+            }
+        });
+        return {
+            state,
+            beforeHandlers,
+            handlers,
+            commit,
+        };
+    });
+}
+function patchHistory(window, onEvent, base) {
+    const { history, location } = window;
+    const stateDescriptor = Object.getOwnPropertyDescriptor(Object.getPrototypeOf(history), 'state') ||
+        Object.getOwnPropertyDescriptor(history, 'state');
+    const methods = {
+        pushState: history.pushState.bind(history),
+        replaceState: history.replaceState.bind(history),
+        go: history.go.bind(history),
+        back: history.back.bind(history),
+        forward: history.forward.bind(history),
+    };
+    const getStateDescriptor = stateDescriptor?.get?.bind(history);
+    const getHistoryState = () => getStateDescriptor?.();
+    const original = {
+        get length() {
+            return history.length;
+        },
+        get scrollRestoration() {
+            return history.scrollRestoration;
+        },
+        set scrollRestoration(mode) {
+            history.scrollRestoration = mode;
+        },
+        get state() {
+            return getHistoryState();
+        },
+        ...methods,
+        pushState(data, _, url) {
+            return methods.pushState(data, _, url?.toString());
+        },
+        replaceState(data, _, url) {
+            return methods.replaceState(data, _, url?.toString());
+        },
+    };
+    history.pushState = (state, _, url) => {
+        if (url) {
+            onEvent({
+                _tag: 'PushState',
+                state,
+                url: getUrl(location.origin, url, base),
+                skipCommit: false,
+            });
+        }
+        else {
+            onEvent({
+                _tag: 'ReplaceState',
+                state,
+                url: Option.none(),
+                skipCommit: false,
+            });
+        }
+    };
+    history.replaceState = (state, _, url) => {
+        onEvent({
+            _tag: 'ReplaceState',
+            state,
+            url: url ? Option.some(getUrl(location.origin, url, base)) : Option.none(),
+            skipCommit: false,
+        });
+    };
+    history.go = (delta) => {
+        if (delta && delta !== 0) {
+            onEvent({ _tag: 'Traverse', delta, skipCommit: false });
+        }
+    };
+    history.back = () => {
+        onEvent({ _tag: 'Traverse', delta: -1, skipCommit: false });
+    };
+    history.forward = () => {
+        onEvent({ _tag: 'Traverse', delta: 1, skipCommit: false });
+    };
+    const onHashChange = (ev) => {
+        onEvent({
+            _tag: 'ReplaceState',
+            state: history.state,
+            url: Option.some(new URL(ev.newURL)),
+            skipCommit: false,
+        });
+    };
+    window.addEventListener('hashchange', onHashChange, { capture: true });
+    const onPopState = (ev) => {
+        if (isPatchedState(ev.state)) {
+            onEvent({
+                _tag: 'TraverseTo',
+                key: ev.state.__typed__navigation__key__,
+                state: ev.state.__typed__navigation__state__,
+                skipCommit: true,
+            });
+        }
+        else {
+            onEvent({
+                _tag: 'ReplaceState',
+                state: ev.state,
+                url: Option.some(new URL(location.href)),
+                skipCommit: true,
+            });
+        }
+    };
+    window.addEventListener('popstate', onPopState, { capture: true });
+    const unpatch = Effect.sync(() => {
+        history.pushState = original.pushState;
+        history.replaceState = original.replaceState;
+        history.go = original.go;
+        history.back = original.back;
+        history.forward = original.forward;
+        if (stateDescriptor) {
+            try {
+                Object.defineProperty(history, 'state', stateDescriptor);
+            }
+            catch {
+                // We tried, but it didn't work
+            }
+        }
+        window.removeEventListener('hashchange', onHashChange);
+        window.removeEventListener('popstate', onPopState);
+    });
+    Object.defineProperty(history, 'state', {
+        get() {
+            return getOriginalState(getStateDescriptor?.() ?? history.state);
+        },
+        set(value) {
+            const { __typed__navigation__id__, __typed__navigation__key__ } = getStateDescriptor?.() ?? original.state;
+            if (isPatchedState(value)) {
+                // The setter is not actually modifying the history.state
+                // We need to call the original replaceState to update the actual state
+                original.replaceState.call(history, value, '', location.href);
+            }
+            else {
+                // The setter is not actually modifying the history.state
+                // We need to call the original replaceState to update the actual state
+                original.replaceState.call(history, {
+                    __typed__navigation__id__,
+                    __typed__navigation__key__,
+                    __typed__navigation__state__: value,
+                }, '', location.href);
+            }
+            return value;
+        },
+    });
+    return {
+        getHistoryState,
+        original,
+        patched: history,
+        unpatch,
+    };
+}
+function scopedRuntime() {
+    return Effect.map(Effect.runtime(), (runtime) => {
+        const scope = Context.get(runtime.context, Scope.Scope);
+        const runFork = Runtime.runFork(runtime);
+        const runPromise = (effect) => new Promise((resolve, reject) => {
+            const fiber = runFork(effect, { scope });
+            fiber.addObserver(Exit.match({
+                onFailure: (cause) => reject(Runtime.makeFiberFailure(cause)),
+                onSuccess: resolve,
+            }));
+        });
+        return {
+            runtime,
+            scope: Context.unsafeGet(runtime.context, Scope.Scope),
+            run: (eff) => runFork(eff, { scope }),
+            runPromise,
+        };
+    });
+}
+//# sourceMappingURL=fromWindow.js.map