aboutsummaryrefslogtreecommitdiff
path: root/packages/demobank-ui/src/route.ts
blob: 4b021d7627421089c1538e3377f8cfde8fd9b081 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/*
 This file is part of GNU Taler
 (C) 2022-2024 Taler Systems S.A.

 GNU Taler is free software; you can redistribute it and/or modify it under the
 terms of the GNU General Public License as published by the Free Software
 Foundation; either version 3, or (at your option) any later version.

 GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY
 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

 You should have received a copy of the GNU General Public License along with
 GNU Taler; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */
import { useNavigationContext } from "./context/navigation.js";

export function urlPattern<
  T extends Record<string, string> = Record<string, never>,
>(pattern: RegExp, reverse: (p: T) => string): RouteDefinition<T> {
  return {
    pattern: new RegExp(pattern),
    url: reverse,
  };
}

export type RouteDefinition<T> = {
  pattern: RegExp;
  url: (p: T) => string;
};

const nullRountDef = {
  pattern: new RegExp(/.*/),
  url: () => "",
};
export function buildNullRoutDefinition<T>(): RouteDefinition<T> {
  return nullRountDef;
}

export type RouteMap<T> = {
  [n in keyof T]: RouteDefinition<T[n]>;
};

export type RouteParamsType<
  P,
  T extends keyof P,
> = P[T] extends RouteDefinition<infer ASD> ? ASD : never;

type Location<E, T extends RouteMap<E>, NAME extends keyof T> = {
  parent: T;
  name: NAME;
  values: RouteParamsType<T, NAME>;
};

/**
 * Search path in the pageList
 * get the values from the path found
 * add params from searchParams
 *
 * @param path
 * @param params
 */
function findMatch<DEF, RM extends RouteMap<DEF>, ROUTES extends keyof RM>(
  pagesMap: RM,
  pageList: Array<ROUTES>,
  path: string,
  params: Record<string, string>,
): Location<DEF, RM, ROUTES> | undefined {
  for (let idx = 0; idx < pageList.length; idx++) {
    const name = pageList[idx];
    const found = pagesMap[name].pattern.exec(path);
    if (found !== null) {
      const values =
        found.groups === undefined ? {} : structuredClone(found.groups);

      Object.entries(params).forEach(([key, value]) => {
        values[key] = value;
      });

      // @ts-expect-error values is a map string which is equivalent to the RouteParamsType
      return { name, parent: pagesMap, values };
    }
  }
  return undefined;
}

export function useCurrentLocation<
  DEF,
  RM extends RouteMap<DEF>,
  ROUTES extends keyof RM,
>(pagesMap: RM) {
  const pageList = Object.keys(pagesMap) as Array<ROUTES>;
  const { path, params } = useNavigationContext();

  return findMatch(pagesMap, pageList, path, params);
}