@wavelengthusaf/client-router 0.0.1

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 (169) hide show
  1. package/.gitlab-ci.yml +84 -0
  2. package/.husky/pre-commit +38 -0
  3. package/.storybook/main.ts +16 -0
  4. package/.storybook/manager.ts +7 -0
  5. package/.storybook/preview.ts +23 -0
  6. package/.storybook/theme.ts +30 -0
  7. package/.storybook/vitest.setup.ts +7 -0
  8. package/README.md +556 -0
  9. package/dist/elements/RouteElement.d.ts +0 -0
  10. package/dist/elements/RouteElement.d.ts.map +0 -0
  11. package/dist/elements/RouteElement.js +0 -0
  12. package/dist/elements/RouteElement.js.map +0 -0
  13. package/dist/elements/RouterElement.d.ts +0 -0
  14. package/dist/elements/RouterElement.d.ts.map +0 -0
  15. package/dist/elements/RouterElement.js +0 -0
  16. package/dist/elements/RouterElement.js.map +0 -0
  17. package/dist/elements/__tests__/RouteElement.test.d.ts +0 -0
  18. package/dist/elements/__tests__/RouteElement.test.d.ts.map +0 -0
  19. package/dist/elements/__tests__/RouteElement.test.js +77 -0
  20. package/dist/elements/__tests__/RouteElement.test.js.map +0 -0
  21. package/dist/elements/__tests__/RouterElement.test.d.ts +0 -0
  22. package/dist/elements/__tests__/RouterElement.test.d.ts.map +0 -0
  23. package/dist/elements/__tests__/RouterElement.test.js +0 -0
  24. package/dist/elements/__tests__/RouterElement.test.js.map +0 -0
  25. package/dist/index.d.ts +0 -0
  26. package/dist/index.d.ts.map +0 -0
  27. package/dist/index.js +0 -0
  28. package/dist/index.js.map +0 -0
  29. package/dist/models/CompiledRoute.d.ts +0 -0
  30. package/dist/models/CompiledRoute.d.ts.map +0 -0
  31. package/dist/models/CompiledRoute.js +0 -0
  32. package/dist/models/CompiledRoute.js.map +0 -0
  33. package/dist/models/MatchedRoute.d.ts +0 -0
  34. package/dist/models/MatchedRoute.d.ts.map +0 -0
  35. package/dist/models/MatchedRoute.js +0 -0
  36. package/dist/models/MatchedRoute.js.map +0 -0
  37. package/dist/models/RouteComponent.d.ts +0 -0
  38. package/dist/models/RouteComponent.d.ts.map +0 -0
  39. package/dist/models/RouteComponent.js +0 -0
  40. package/dist/models/RouteComponent.js.map +0 -0
  41. package/dist/models/RouteContext.d.ts +0 -0
  42. package/dist/models/RouteContext.d.ts.map +0 -0
  43. package/dist/models/RouteContext.js +0 -0
  44. package/dist/models/RouteContext.js.map +0 -0
  45. package/dist/models/RouteDefinition.d.ts +0 -0
  46. package/dist/models/RouteDefinition.d.ts.map +0 -0
  47. package/dist/models/RouteDefinition.js +0 -0
  48. package/dist/models/RouteDefinition.js.map +0 -0
  49. package/dist/models/RouteGuard.d.ts +0 -0
  50. package/dist/models/RouteGuard.d.ts.map +0 -0
  51. package/dist/models/RouteGuard.js +0 -0
  52. package/dist/models/RouteGuard.js.map +0 -0
  53. package/dist/models/RouteParams.d.ts +0 -0
  54. package/dist/models/RouteParams.d.ts.map +0 -0
  55. package/dist/models/RouteParams.js +0 -0
  56. package/dist/models/RouteParams.js.map +0 -0
  57. package/dist/models/index.d.ts +0 -0
  58. package/dist/models/index.d.ts.map +0 -0
  59. package/dist/models/index.js +0 -0
  60. package/dist/models/index.js.map +0 -0
  61. package/dist/prettier.config.d.ts +0 -0
  62. package/dist/prettier.config.d.ts.map +0 -0
  63. package/dist/router/Router.d.ts +0 -0
  64. package/dist/router/Router.d.ts.map +0 -0
  65. package/dist/router/Router.js +0 -0
  66. package/dist/router/Router.js.map +0 -0
  67. package/dist/router/__tests__/Router.test.d.ts +0 -0
  68. package/dist/router/__tests__/Router.test.d.ts.map +0 -0
  69. package/dist/router/__tests__/Router.test.js +0 -0
  70. package/dist/router/__tests__/Router.test.js.map +0 -0
  71. package/dist/src/elements/RouteElement.d.ts +0 -0
  72. package/dist/src/elements/RouteElement.d.ts.map +0 -0
  73. package/dist/src/elements/RouterElement.d.ts +0 -0
  74. package/dist/src/elements/RouterElement.d.ts.map +0 -0
  75. package/dist/src/elements/__tests__/RouteElement.test.d.ts +0 -0
  76. package/dist/src/elements/__tests__/RouteElement.test.d.ts.map +0 -0
  77. package/dist/src/elements/__tests__/RouterElement.test.d.ts +0 -0
  78. package/dist/src/elements/__tests__/RouterElement.test.d.ts.map +0 -0
  79. package/dist/src/index.d.ts +0 -0
  80. package/dist/src/index.d.ts.map +0 -0
  81. package/dist/src/models/CompiledRoute.d.ts +0 -0
  82. package/dist/src/models/CompiledRoute.d.ts.map +0 -0
  83. package/dist/src/models/MatchedRoute.d.ts +0 -0
  84. package/dist/src/models/MatchedRoute.d.ts.map +0 -0
  85. package/dist/src/models/RouteComponent.d.ts +0 -0
  86. package/dist/src/models/RouteComponent.d.ts.map +0 -0
  87. package/dist/src/models/RouteContext.d.ts +0 -0
  88. package/dist/src/models/RouteContext.d.ts.map +0 -0
  89. package/dist/src/models/RouteDefinition.d.ts +0 -0
  90. package/dist/src/models/RouteDefinition.d.ts.map +0 -0
  91. package/dist/src/models/RouteGuard.d.ts +0 -0
  92. package/dist/src/models/RouteGuard.d.ts.map +0 -0
  93. package/dist/src/models/RouteParams.d.ts +0 -0
  94. package/dist/src/models/RouteParams.d.ts.map +0 -0
  95. package/dist/src/models/index.d.ts +0 -0
  96. package/dist/src/models/index.d.ts.map +0 -0
  97. package/dist/src/router/Router.d.ts +0 -0
  98. package/dist/src/router/Router.d.ts.map +0 -0
  99. package/dist/src/router/__tests__/Router.test.d.ts +0 -0
  100. package/dist/src/router/__tests__/Router.test.d.ts.map +0 -0
  101. package/dist/src/stories/RouterElement.stories.d.ts +0 -0
  102. package/dist/src/stories/RouterElement.stories.d.ts.map +0 -0
  103. package/dist/src/stories/RouterElement.stories.test.d.ts +0 -0
  104. package/dist/src/stories/RouterElement.stories.test.d.ts.map +0 -0
  105. package/dist/src/utils/__tests__/compileRoute.test.d.ts +0 -0
  106. package/dist/src/utils/__tests__/compileRoute.test.d.ts.map +0 -0
  107. package/dist/src/utils/__tests__/matchRoute.test.d.ts +0 -0
  108. package/dist/src/utils/__tests__/matchRoute.test.d.ts.map +0 -0
  109. package/dist/src/utils/compileRoute.d.ts +0 -0
  110. package/dist/src/utils/compileRoute.d.ts.map +0 -0
  111. package/dist/src/utils/index.d.ts +0 -0
  112. package/dist/src/utils/index.d.ts.map +0 -0
  113. package/dist/src/utils/matchRoute.d.ts +0 -0
  114. package/dist/src/utils/matchRoute.d.ts.map +0 -0
  115. package/dist/stories/RouterElement.stories.d.ts +0 -0
  116. package/dist/stories/RouterElement.stories.d.ts.map +0 -0
  117. package/dist/stories/RouterElement.stories.js +0 -0
  118. package/dist/stories/RouterElement.stories.js.map +0 -0
  119. package/dist/utils/__tests__/compileRoute.test.d.ts +0 -0
  120. package/dist/utils/__tests__/compileRoute.test.d.ts.map +0 -0
  121. package/dist/utils/__tests__/compileRoute.test.js +0 -0
  122. package/dist/utils/__tests__/compileRoute.test.js.map +0 -0
  123. package/dist/utils/__tests__/matchRoute.test.d.ts +0 -0
  124. package/dist/utils/__tests__/matchRoute.test.d.ts.map +0 -0
  125. package/dist/utils/__tests__/matchRoute.test.js +0 -0
  126. package/dist/utils/__tests__/matchRoute.test.js.map +0 -0
  127. package/dist/utils/compileRoute.d.ts +0 -0
  128. package/dist/utils/compileRoute.d.ts.map +0 -0
  129. package/dist/utils/compileRoute.js +0 -0
  130. package/dist/utils/compileRoute.js.map +0 -0
  131. package/dist/utils/index.d.ts +0 -0
  132. package/dist/utils/index.d.ts.map +0 -0
  133. package/dist/utils/index.js +0 -0
  134. package/dist/utils/index.js.map +0 -0
  135. package/dist/utils/matchRoute.d.ts +0 -0
  136. package/dist/utils/matchRoute.d.ts.map +0 -0
  137. package/dist/utils/matchRoute.js +0 -0
  138. package/dist/utils/matchRoute.js.map +0 -0
  139. package/eslint.config.mjs +89 -0
  140. package/index.ts +15 -0
  141. package/package.json +54 -0
  142. package/prettier.config.ts +30 -0
  143. package/src/elements/RouteElement.ts +67 -0
  144. package/src/elements/RouterElement.ts +97 -0
  145. package/src/elements/__tests__/RouteElement.test.ts +89 -0
  146. package/src/elements/__tests__/RouterElement.test.ts +253 -0
  147. package/src/index.ts +15 -0
  148. package/src/models/CompiledRoute.ts +7 -0
  149. package/src/models/MatchedRoute.ts +7 -0
  150. package/src/models/RouteComponent.ts +6 -0
  151. package/src/models/RouteContext.ts +7 -0
  152. package/src/models/RouteDefinition.ts +6 -0
  153. package/src/models/RouteGuard.ts +6 -0
  154. package/src/models/RouteParams.ts +3 -0
  155. package/src/models/index.ts +17 -0
  156. package/src/router/Router.ts +225 -0
  157. package/src/router/__tests__/Router.test.ts +464 -0
  158. package/src/stories/RouterElement.stories.test.ts +310 -0
  159. package/src/stories/RouterElement.stories.ts +208 -0
  160. package/src/utils/__tests__/compileRoute.test.ts +97 -0
  161. package/src/utils/__tests__/matchRoute.test.ts +180 -0
  162. package/src/utils/compileRoute.ts +37 -0
  163. package/src/utils/index.ts +4 -0
  164. package/src/utils/matchRoute.ts +37 -0
  165. package/tsconfig.build.json +20 -0
  166. package/tsconfig.json +55 -0
  167. package/vitest.config.ts +34 -0
  168. package/vitest.setup.ts +3 -0
  169. package/vitest.shims.d.ts +1 -0
package/.gitlab-ci.yml ADDED
@@ -0,0 +1,84 @@
1
+ stages:
2
+ - setup
3
+ - build
4
+ - test
5
+ - security
6
+ - deploy
7
+
8
+ variables:
9
+ GIT_CLONE_PATH: $CI_BUILDS_DIR/$CI_CONCURRENT_ID/$CI_PROJECT_PATH
10
+ NODE_VERSION: '22'
11
+
12
+ cache:
13
+ key: ${CI_COMMIT_REF_SLUG}
14
+ paths:
15
+ - node_modules/
16
+
17
+ include:
18
+ - template: Jobs/SAST.gitlab-ci.yml
19
+ - template: Jobs/Secret-Detection.gitlab-ci.yml
20
+ - template: Jobs/Dependency-Scanning.gitlab-ci.yml
21
+
22
+ setup:
23
+ stage: setup
24
+ image: node:${NODE_VERSION}-alpine
25
+ before_script:
26
+ - npm ci
27
+ script:
28
+ - echo "Dependencies installed"
29
+ artifacts:
30
+ paths:
31
+ - node_modules/
32
+ expire_in: 1 week
33
+
34
+ build:
35
+ stage: build
36
+ needs: ['setup']
37
+ image: node:${NODE_VERSION}-alpine
38
+ script:
39
+ - npm run build
40
+ artifacts:
41
+ paths:
42
+ - dist/
43
+
44
+ lint:
45
+ stage: test
46
+ needs: ['setup']
47
+ image: node:${NODE_VERSION}-alpine
48
+ script:
49
+ - npm run lint
50
+ allow_failure: false
51
+
52
+ test:
53
+ stage: test
54
+ needs: ['setup']
55
+ image: node:${NODE_VERSION}-alpine
56
+ script:
57
+ - npm run test
58
+ allow_failure: false
59
+ coverage: '/All files[^|]*\|[^|]*\s+([\d\.]+)/'
60
+
61
+ publish:npm:
62
+ stage: deploy
63
+ image: node:${NODE_VERSION}-alpine
64
+ needs: ['setup', 'test']
65
+ script:
66
+ - echo "//registry.npmjs.org/:_authToken=$NPM_AUTH_TOKEN" > .npmrc
67
+ - npm publish --access public
68
+ rules:
69
+ - if: $CI_COMMIT_TAG =~ /^v\d+\.\d+\.\d+$/
70
+ - if: $CI_COMMIT_BRANCH == "master"
71
+
72
+ pages:
73
+ stage: deploy
74
+ image: node:${NODE_VERSION}-alpine
75
+ needs: ['setup', 'build']
76
+ script:
77
+ - npm run build-storybook -- -o public
78
+ - echo '<meta name="robots" content="noindex" />' >> public/index.html
79
+ artifacts:
80
+ paths:
81
+ - public/
82
+ expire_in: 30 days
83
+ rules:
84
+ - if: $CI_COMMIT_BRANCH == "master"
@@ -0,0 +1,38 @@
1
+ #!/usr/bin/env sh
2
+ echo ------------------------------
3
+ echo Running Husky Pre-Commit Hooks
4
+ echo ------------------------------
5
+ echo
6
+ echo
7
+ echo ----------------------------------
8
+ echo Running Unit Tests
9
+ echo ----------------------------------
10
+ npm run test -- $(git diff --diff-filter=d --name-only --staged) --passWithNoTests
11
+ if [ $? -ne 0 ]; then
12
+ echo
13
+ echo "Unit tests failed!"
14
+ echo
15
+ exit 1
16
+ else
17
+ echo
18
+ echo "Unit tests passed!"
19
+ echo
20
+ fi
21
+ echo ---------------------------
22
+ echo Running Eslint and Prettier
23
+ echo ---------------------------
24
+ npx eslint --fix $(git diff --diff-filter=d --name-only --staged | grep -E '\.(js|ts|tsx)$')
25
+ if [ $? -ne 0 ]; then
26
+ echo
27
+ echo "ESLint failed with errors."
28
+ echo
29
+ exit 1
30
+ else
31
+ echo
32
+ echo "ESLint passed successfully."
33
+ echo
34
+ fi
35
+ echo
36
+ echo Pre-commit checks passed!
37
+ exit 0
38
+
@@ -0,0 +1,16 @@
1
+ const config = {
2
+ stories: ['../src/stories/**/*.stories.ts'],
3
+
4
+ framework: {
5
+ name: '@storybook/web-components-vite',
6
+ options: {},
7
+ },
8
+
9
+ addons: [
10
+ '@storybook/addon-links',
11
+ '@storybook/addon-docs',
12
+ '@storybook/addon-a11y',
13
+ ],
14
+ };
15
+
16
+ export default config;
@@ -0,0 +1,7 @@
1
+ import { addons } from 'storybook/manager-api';
2
+
3
+ import theme from './theme.ts';
4
+
5
+ addons.setConfig({
6
+ theme,
7
+ });
@@ -0,0 +1,23 @@
1
+ import type { Preview } from '@storybook/web-components';
2
+
3
+ const preview: Preview = {
4
+ parameters: {
5
+ controls: {
6
+ matchers: {
7
+ color: /(background|color)$/i,
8
+ date: /Date$/i,
9
+ },
10
+ },
11
+ docs: {
12
+ source: {
13
+ language: 'ts',
14
+ format: 'dedent',
15
+ },
16
+ },
17
+ a11y: {
18
+ element: 'wavelength-router',
19
+ },
20
+ },
21
+ };
22
+
23
+ export default preview;
@@ -0,0 +1,30 @@
1
+ import { create } from 'storybook/theming';
2
+
3
+ export default create({
4
+ base: 'light',
5
+
6
+ colorPrimary: '#007fff',
7
+ colorSecondary: '#007fff',
8
+
9
+ appBg: '#ffffff',
10
+ appContentBg: '#ffffff',
11
+ appBorderColor: '#e0e0e0',
12
+ appBorderRadius: 4,
13
+
14
+ textColor: 'rgba(0, 0, 0, 0.87)',
15
+ textInverseColor: '#ffffff',
16
+ textMutedColor: 'rgba(0, 0, 0, 0.6)',
17
+
18
+ barTextColor: 'rgba(0, 0, 0, 0.6)',
19
+ barSelectedColor: '#007fff',
20
+ barBg: '#ffffff',
21
+ barHoverColor: '#f0f0f0',
22
+
23
+ inputBg: '#ffffff',
24
+ inputBorder: '#e0e0e0',
25
+ inputTextColor: 'rgba(0, 0, 0, 0.87)',
26
+ inputBorderRadius: 4,
27
+
28
+ booleanBg: '#f6f8fa',
29
+ booleanSelectedBg: '#e6f4ff',
30
+ });
@@ -0,0 +1,7 @@
1
+ import { setProjectAnnotations } from '@storybook/web-components-vite';
2
+
3
+ import * as projectAnnotations from './preview.ts';
4
+
5
+ // This is an important step to apply the right configuration when testing your stories.
6
+ // More info at: https://storybook.js.org/docs/api/portable-stories/portable-stories-vitest#setprojectannotations
7
+ setProjectAnnotations([projectAnnotations]);