@shivaedev/react 0.50.0 → 0.52.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/CHANGELOG.md +29 -0
  2. package/README.md +137 -79
  3. package/dist/adapters/permissionBoundary.d.ts.map +1 -1
  4. package/dist/adapters/permissionBoundary.js +21 -2
  5. package/dist/adapters/permissionBoundary.js.map +1 -1
  6. package/dist/adapters/permissionGuard.d.ts +4 -3
  7. package/dist/adapters/permissionGuard.d.ts.map +1 -1
  8. package/dist/adapters/permissionGuard.js +3 -4
  9. package/dist/adapters/permissionGuard.js.map +1 -1
  10. package/dist/adapters/signInRedirect.d.ts +4 -0
  11. package/dist/adapters/signInRedirect.d.ts.map +1 -0
  12. package/dist/adapters/signInRedirect.js +6 -0
  13. package/dist/adapters/signInRedirect.js.map +1 -0
  14. package/dist/client/adapters/SessionGeneration.d.ts +3 -1
  15. package/dist/client/adapters/SessionGeneration.d.ts.map +1 -1
  16. package/dist/client/adapters/SessionGeneration.js +4 -1
  17. package/dist/client/adapters/SessionGeneration.js.map +1 -1
  18. package/dist/{adapters → client/adapters}/queryRoute.d.ts +12 -5
  19. package/dist/client/adapters/queryRoute.d.ts.map +1 -0
  20. package/dist/{adapters → client/adapters}/queryRoute.js +14 -1
  21. package/dist/client/adapters/queryRoute.js.map +1 -0
  22. package/dist/client/adapters/useWarmQueries.d.ts +4 -0
  23. package/dist/client/adapters/useWarmQueries.d.ts.map +1 -0
  24. package/dist/client/adapters/useWarmQueries.js +36 -0
  25. package/dist/client/adapters/useWarmQueries.js.map +1 -0
  26. package/dist/client/authSession.d.ts +10 -2
  27. package/dist/client/authSession.d.ts.map +1 -1
  28. package/dist/client/authSession.js +32 -3
  29. package/dist/client/authSession.js.map +1 -1
  30. package/dist/client/sessionBoundary.d.ts +2 -1
  31. package/dist/client/sessionBoundary.d.ts.map +1 -1
  32. package/dist/client/sessionBoundary.js +2 -1
  33. package/dist/client/sessionBoundary.js.map +1 -1
  34. package/dist/client/useDebouncedValue.js +1 -1
  35. package/dist/client/useDebouncedValue.js.map +1 -1
  36. package/dist/client/useDelay.js +1 -1
  37. package/dist/client/useDelay.js.map +1 -1
  38. package/package.json +7 -7
  39. package/src/adapters/permissionBoundary.ts +23 -2
  40. package/src/adapters/permissionGuard.ts +6 -5
  41. package/src/adapters/signInRedirect.ts +7 -0
  42. package/src/client/adapters/SessionGeneration.ts +6 -0
  43. package/src/{adapters → client/adapters}/queryRoute.ts +24 -9
  44. package/src/client/adapters/useWarmQueries.ts +39 -0
  45. package/src/client/authSession.ts +57 -4
  46. package/src/client/sessionBoundary.ts +3 -0
  47. package/src/client/useDebouncedValue.ts +1 -1
  48. package/src/client/useDelay.ts +1 -1
  49. package/dist/adapters/queryRoute.d.ts.map +0 -1
  50. package/dist/adapters/queryRoute.js.map +0 -1
@@ -1,10 +1,12 @@
1
- import type { LoaderFnContext } from "@tanstack/react-router";
1
+ import { type AnyRouter, type LoaderFnContext, useMatch } from "@tanstack/react-router";
2
2
  import type * as AsyncResult from "effect/reactivity/AsyncResult";
3
3
  import type * as Atom from "effect/reactivity/Atom";
4
4
  import type * as AtomRegistry from "effect/reactivity/AtomRegistry";
5
5
  import { loadQuery } from "#adapters/loadQuery.ts";
6
6
  import { type QueryRouteRedirects, queryRouteFailure } from "#adapters/queryRouteFailure.ts";
7
7
  import { useQueryRetry } from "#adapters/useQueryRetry.ts";
8
+ import type { QueryOptions } from "#client/resultState.ts";
9
+ import { type LoadedQueryState, useLoaderQuery } from "#client/useLoaderQuery.ts";
8
10
 
9
11
  interface QueryRouteInput<TParams, TSearch, TContext> {
10
12
  readonly context: TContext;
@@ -12,13 +14,21 @@ interface QueryRouteInput<TParams, TSearch, TContext> {
12
14
  readonly search: TSearch;
13
15
  }
14
16
 
15
- export function queryRoute<
16
- TParams extends object,
17
- TSearch extends object,
18
- A,
19
- E,
20
- TContext extends { readonly registry: AtomRegistry.AtomRegistry } = { readonly registry: AtomRegistry.AtomRegistry },
21
- >(
17
+ interface QueryRouteContext {
18
+ readonly redirects?: QueryRouteRedirects;
19
+ readonly registry: AtomRegistry.AtomRegistry;
20
+ }
21
+
22
+ function useLoadedQuery<TParams, TSearch, A, E, TContext>(
23
+ query: (route: QueryRouteInput<TParams, TSearch, TContext>) => Atom.Atom<AsyncResult.AsyncResult<A, E>>,
24
+ ): { readonly loaded: A; readonly query: Atom.Atom<AsyncResult.AsyncResult<A, E>> } {
25
+ const match = useMatch<AnyRouter, undefined, false>({ strict: false });
26
+ const { context, params, loaderDeps }: { context: TContext; params: TParams; loaderDeps: TSearch } = match;
27
+ const loaded: A = match.loaderData;
28
+ return { loaded, query: query({ context, params, search: loaderDeps }) };
29
+ }
30
+
31
+ export function queryRoute<TParams extends object, TSearch extends object, A, E, TContext extends QueryRouteContext = QueryRouteContext>(
22
32
  query: (route: QueryRouteInput<TParams, TSearch, TContext>) => Atom.Atom<AsyncResult.AsyncResult<A, E>>,
23
33
  options: { readonly redirects?: QueryRouteRedirects } = {},
24
34
  ) {
@@ -33,10 +43,15 @@ export function queryRoute<
33
43
  try {
34
44
  return await loadQuery(context.context.registry, query({ context: context.context, params: context.params, search: context.deps }), context);
35
45
  } catch (error) {
36
- throw queryRouteFailure(error, context.location, options.redirects);
46
+ throw queryRouteFailure(error, context.location, { ...context.context.redirects, ...options.redirects });
37
47
  }
38
48
  },
39
49
  loaderDeps: ({ search }: { readonly search: TSearch }) => search,
50
+ useLoaded: () => useLoadedQuery(query),
51
+ useQuery: (queryOptions: QueryOptions<E> = {}): LoadedQueryState<A, E> => {
52
+ const { loaded, query: atom } = useLoadedQuery(query);
53
+ return useLoaderQuery(atom, loaded, queryOptions);
54
+ },
40
55
  useRetry: () =>
41
56
  useQueryRetry((match) => {
42
57
  const { context, params, loaderDeps }: { context: TContext; params: TParams; loaderDeps: TSearch } = match;
@@ -0,0 +1,39 @@
1
+ import type * as Atom from "effect/reactivity/Atom";
2
+ import type * as AtomRegistry from "effect/reactivity/AtomRegistry";
3
+ import { useEffect, useMemo } from "react";
4
+ import { warmQueries } from "@shivaedev/contract/warmQueries.ts";
5
+
6
+ function warmMounts(registry: AtomRegistry.AtomRegistry) {
7
+ const mounted = new Map<Atom.Atom<unknown>, () => void>();
8
+ return {
9
+ follow(queries: readonly Atom.Atom<unknown>[]) {
10
+ const listed = new Set(queries);
11
+ if (listed.size !== mounted.size || queries.some((query) => !mounted.has(query))) {
12
+ registry.set(warmQueries, listed);
13
+ }
14
+ for (const query of listed) {
15
+ if (!mounted.has(query)) {
16
+ mounted.set(query, registry.mount(query));
17
+ }
18
+ }
19
+ for (const [query, unmount] of mounted) {
20
+ if (!listed.has(query)) {
21
+ mounted.delete(query);
22
+ unmount();
23
+ }
24
+ }
25
+ },
26
+ release() {
27
+ for (const unmount of mounted.values()) {
28
+ unmount();
29
+ }
30
+ mounted.clear();
31
+ },
32
+ };
33
+ }
34
+
35
+ export function useWarmQueries(registry: AtomRegistry.AtomRegistry, queries: readonly Atom.Atom<unknown>[]) {
36
+ const warm = useMemo(() => warmMounts(registry), [registry]);
37
+ useEffect(() => () => warm.release(), [warm]);
38
+ useEffect(() => warm.follow(queries), [warm, queries]);
39
+ }
@@ -1,15 +1,30 @@
1
- import { Effect } from "effect";
2
- import type * as AsyncResult from "effect/reactivity/AsyncResult";
1
+ import { Effect, type Layer, Option } from "effect";
2
+ import * as AsyncResult from "effect/reactivity/AsyncResult";
3
3
  import * as Atom from "effect/reactivity/Atom";
4
4
  import * as AtomRegistry from "effect/reactivity/AtomRegistry";
5
+ import {
6
+ forgetSession,
7
+ type RememberedSession,
8
+ recallSession,
9
+ rememberSession,
10
+ type SessionMemory,
11
+ type VerifiedSession,
12
+ } from "@shivaedev/identity/client/SessionMemory.ts";
5
13
 
6
14
  export interface AuthSession<A, E> {
7
15
  readonly atom: Atom.Atom<AsyncResult.AsyncResult<A, E>>;
8
16
  readonly refresh: Effect.Effect<A, E, AtomRegistry.AtomRegistry>;
9
17
  }
10
18
 
11
- export function authSession<A, E>(read: Effect.Effect<A, E>): AuthSession<A, E> {
12
- const atom = Atom.make(read);
19
+ export interface RememberedAuthSession<E> extends AuthSession<RememberedSession | null, E> {
20
+ readonly signOut: <A, TError, R>(request: Effect.Effect<A, TError, R>) => Effect.Effect<A, TError, R>;
21
+ }
22
+
23
+ export interface AuthSessionOptions {
24
+ readonly remember: Layer.Layer<SessionMemory>;
25
+ }
26
+
27
+ function refreshing<A, E>(atom: Atom.Atom<AsyncResult.AsyncResult<A, E>>): AuthSession<A, E> {
13
28
  const refresh = Effect.gen(function* () {
14
29
  const registry = yield* AtomRegistry.AtomRegistry;
15
30
  registry.refresh(atom);
@@ -17,3 +32,41 @@ export function authSession<A, E>(read: Effect.Effect<A, E>): AuthSession<A, E>
17
32
  });
18
33
  return { atom, refresh };
19
34
  }
35
+
36
+ function remembering<E>(read: Effect.Effect<VerifiedSession | null, E>, memory: Layer.Layer<SessionMemory>) {
37
+ const recalled = Atom.make(Effect.provide(recallSession, memory));
38
+ const check = Atom.make(read.pipe(Effect.flatMap(rememberSession), Effect.provide(memory)));
39
+ return Atom.readable(
40
+ (get): AsyncResult.AsyncResult<RememberedSession | null, E> => {
41
+ const remembered = Option.flatten(AsyncResult.value(get(recalled)));
42
+ const verified = get(check);
43
+ if (Option.isSome(AsyncResult.value(verified)) || Option.isNone(remembered)) {
44
+ return verified;
45
+ }
46
+ if (AsyncResult.isFailure(verified)) {
47
+ return AsyncResult.failure(verified.cause, {
48
+ previousSuccess: Option.some(AsyncResult.success(remembered.value)),
49
+ waiting: verified.waiting,
50
+ });
51
+ }
52
+ return AsyncResult.success(remembered.value, { waiting: true });
53
+ },
54
+ (refresh) => refresh(check),
55
+ );
56
+ }
57
+
58
+ export function authSession<A, E>(read: Effect.Effect<A, E>): AuthSession<A, E>;
59
+ export function authSession<E>(read: Effect.Effect<VerifiedSession | null, E>, options: AuthSessionOptions): RememberedAuthSession<E>;
60
+ export function authSession<A extends VerifiedSession | null, E>(
61
+ read: Effect.Effect<A, E>,
62
+ options?: AuthSessionOptions,
63
+ ): AuthSession<A, E> | RememberedAuthSession<E> {
64
+ if (options === undefined) {
65
+ return refreshing(Atom.make(read));
66
+ }
67
+ const forget = Effect.provide(forgetSession, options.remember);
68
+ return {
69
+ ...refreshing(remembering(read, options.remember)),
70
+ signOut: (request) => Effect.tap(request, () => forget),
71
+ };
72
+ }
@@ -25,6 +25,7 @@ export interface SessionBoundaryProps<TSession, TClient> {
25
25
  readonly session: TSession | undefined;
26
26
  readonly signedOut?: ReactNode;
27
27
  readonly signOut?: Atom.Atom<AsyncResult.AsyncResult<unknown, unknown>> | undefined;
28
+ readonly warm?: ((client: TClient) => readonly Atom.Atom<unknown>[]) | undefined;
28
29
  }
29
30
  export function useSessionRecheck(): () => void {
30
31
  return useContext(RecheckContext);
@@ -40,6 +41,7 @@ export function SessionBoundary<TSession, TClient>({
40
41
  signOut,
41
42
  redirectTo,
42
43
  navigate,
44
+ warm,
43
45
  children,
44
46
  }: SessionBoundaryProps<TSession, TClient>): ReactNode {
45
47
  const registry = useContext(RegistryContext);
@@ -56,6 +58,7 @@ export function SessionBoundary<TSession, TClient>({
56
58
  queryRetention,
57
59
  recheck: retry,
58
60
  session,
61
+ warm,
59
62
  });
60
63
  return createElement(
61
64
  SignOutRegistryContext.Provider,
@@ -22,7 +22,7 @@ function debounce<A>(value: A, millis: number, runtime: TimerRuntime) {
22
22
 
23
23
  export function useDebouncedValue<A>(value: A, duration: Duration.Input, runtime: TimerRuntime = defaultRuntime): A {
24
24
  const registry = useContext(RegistryContext);
25
- const millis = Duration.toMillis(Duration.fromInputUnsafe(duration));
25
+ const millis = Duration.toMillis(duration);
26
26
  const [held, hold] = useState(() => ({ ...debounce(value, millis, runtime), registry, runtime }));
27
27
  let owner = held;
28
28
  if (held.registry !== registry || held.runtime !== runtime) {
@@ -8,7 +8,7 @@ type TimerRuntime = Pick<Atom.AtomRuntime<never, unknown>, "fn">;
8
8
 
9
9
  export function useDelay(duration: Duration.Input, runtime: TimerRuntime = defaultRuntime) {
10
10
  const registry = useContext(RegistryContext);
11
- const millis = Duration.toMillis(Duration.fromInputUnsafe(duration));
11
+ const millis = Duration.toMillis(duration);
12
12
  const timer = useMemo(
13
13
  () => runtime.fn((complete: () => void) => Effect.andThen(Effect.sleep(millis), Effect.sync(complete))).pipe(Atom.setIdleTTL(0)),
14
14
  [runtime, millis],
@@ -1 +0,0 @@
1
- {"version":3,"file":"queryRoute.d.ts","sourceRoot":"","sources":["../../src/adapters/queryRoute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,KAAK,WAAW,MAAM,+BAA+B,CAAC;AAClE,OAAO,KAAK,KAAK,IAAI,MAAM,wBAAwB,CAAC;AACpD,OAAO,KAAK,KAAK,YAAY,MAAM,gCAAgC,CAAC;AAEpE,OAAO,EAAE,KAAK,mBAAmB,EAAqB,MAAM,gCAAgC,CAAC;AAG7F,UAAU,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ;IACnD,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CACzB;AAED,wBAAgB,UAAU,CACzB,OAAO,SAAS,MAAM,EACtB,OAAO,SAAS,MAAM,EACtB,CAAC,EACD,CAAC,EACD,QAAQ,SAAS;IAAE,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC,YAAY,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC,YAAY,CAAA;CAAE,EAEpH,KAAK,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EACvG,OAAO,GAAE;IAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,mBAAmB,CAAA;CAAO;IAGzD,MAAM,YACI,IAAI,CAAC,eAAe,EAAE,iBAAiB,GAAG,UAAU,CAAC,GAAG;QAChE,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;QAC3B,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;QACvB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;KACzB,KACC,OAAO,CAAC,CAAC,CAAC;IAOb,UAAU,eAAe;QAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;KAAE;IACrD,QAAQ;EAMT"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"queryRoute.js","sourceRoot":"","sources":["../../src/adapters/queryRoute.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAA4B,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAC7F,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAQ3D,MAAM,UAAU,UAAU,CAOzB,KAAuG,EACvG,OAAO,GAAiD,EAAE;IAE1D,OAAO;QACN,MAAM,EAAE,KAAK,EACZ,OAIC,EACY,EAAE;YACf,IAAI,CAAC;gBACJ,OAAO,MAAM,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;YAC9I,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,MAAM,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;YACrE,CAAC;QACF,CAAC;QACD,UAAU,EAAE,CAAC,EAAE,MAAM,EAAgC,EAAE,EAAE,CAAC,MAAM;QAChE,QAAQ,EAAE,GAAG,EAAE,CACd,aAAa,CAAC,CAAC,KAAK,EAAE,EAAE;YACvB,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,GAAgE,KAAK,CAAC;YAC3G,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QAC1E,CAAC,CAAC;KACH,CAAC;AACH,CAAC"}