@wavelengthusaf/client-router 0.0.1 → 0.0.3

package/dist/utils/matchRoute.js

@@ -0,0 +1,25 @@
+export function matchRoute(compiledRoutes, pathname) {
+    for (const compiledRoute of compiledRoutes) {
+        const match = compiledRoute.pattern.exec(pathname);
+        if (!match)
+            continue;
+        const routeParams = {};
+        compiledRoute.paramNames.forEach((name, i) => {
+            const value = match[i + 1];
+            if (value === undefined)
+                return;
+            try {
+                routeParams[name] = decodeURIComponent(value);
+            }
+            catch {
+                routeParams[name] = value;
+            }
+        });
+        return {
+            routeDefinition: compiledRoute.routeDefinition,
+            routeParams,
+        };
+    }
+    return null;
+}
+//# sourceMappingURL=matchRoute.js.map

package/dist/utils/matchRoute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchRoute.js","sourceRoot":"","sources":["../../src/utils/matchRoute.ts"],"names":[],"mappings":"AAMA,MAAM,UAAU,UAAU,CACtB,cAA+B,EAC/B,QAAgB;IAElB,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;QAC3C,MAAM,KAAK,GAA4B,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE5E,IAAI,CAAC,KAAK;YAAE,SAAS;QAErB,MAAM,WAAW,GAAgB,EAAE,CAAC;QAEpC,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;YAC3C,MAAM,KAAK,GAAuB,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAE/C,IAAI,KAAK,KAAK,SAAS;gBAAE,OAAO;YAEhC,IAAI,CAAC;gBACH,WAAW,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAChD,CAAC;YAAC,MAAM,CAAC;gBACP,WAAW,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;YAC5B,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO;YACL,eAAe,EAAE,aAAa,CAAC,eAAe;YAC9C,WAAW;SACZ,CAAC;IACJ,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wavelengthusaf/client-router",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Native TypeScript Router",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,6 +22,12 @@
   "author": "Wavelength",
   "license": "ISC",
   "type": "module",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "devDependencies": {
     "@happy-dom/global-registrator": "^20.9.0",
     "@storybook/addon-a11y": "^10.3.5",

package/.gitlab-ci.yml

@@ -1,84 +0,0 @@
-stages:
-  - setup
-  - build
-  - test
-  - security
-  - deploy
-
-variables:
-  GIT_CLONE_PATH: $CI_BUILDS_DIR/$CI_CONCURRENT_ID/$CI_PROJECT_PATH
-  NODE_VERSION: '22'
-
-cache:
-  key: ${CI_COMMIT_REF_SLUG}
-  paths:
-    - node_modules/
-
-include:
-  - template: Jobs/SAST.gitlab-ci.yml
-  - template: Jobs/Secret-Detection.gitlab-ci.yml
-  - template: Jobs/Dependency-Scanning.gitlab-ci.yml
-
-setup:
-  stage: setup
-  image: node:${NODE_VERSION}-alpine
-  before_script:
-    - npm ci
-  script:
-    - echo "Dependencies installed"
-  artifacts:
-    paths:
-      - node_modules/
-    expire_in: 1 week
-
-build:
-  stage: build
-  needs: ['setup']
-  image: node:${NODE_VERSION}-alpine
-  script:
-    - npm run build
-  artifacts:
-    paths:
-      - dist/
-
-lint:
-  stage: test
-  needs: ['setup']
-  image: node:${NODE_VERSION}-alpine
-  script:
-    - npm run lint
-  allow_failure: false
-
-test:
-  stage: test
-  needs: ['setup']
-  image: node:${NODE_VERSION}-alpine
-  script:
-    - npm run test
-  allow_failure: false
-  coverage: '/All files[^|]*\|[^|]*\s+([\d\.]+)/'
-
-publish:npm:
-  stage: deploy
-  image: node:${NODE_VERSION}-alpine
-  needs: ['setup', 'test']
-  script:
-    - echo "//registry.npmjs.org/:_authToken=$NPM_AUTH_TOKEN" > .npmrc
-    - npm publish --access public
-  rules:
-    - if: $CI_COMMIT_TAG =~ /^v\d+\.\d+\.\d+$/
-    - if: $CI_COMMIT_BRANCH == "master"
-
-pages:
-  stage: deploy
-  image: node:${NODE_VERSION}-alpine
-  needs: ['setup', 'build']
-  script:
-    - npm run build-storybook -- -o public
-    - echo '<meta name="robots" content="noindex" />' >> public/index.html
-  artifacts:
-    paths:
-      - public/
-    expire_in: 30 days
-  rules:
-    - if: $CI_COMMIT_BRANCH == "master"

package/.husky/pre-commit

@@ -1,38 +0,0 @@
-#!/usr/bin/env sh
-echo ------------------------------
-echo Running Husky Pre-Commit Hooks
-echo ------------------------------
-echo
-echo
-echo ----------------------------------
-echo Running Unit Tests
-echo ----------------------------------
-npm run test -- $(git diff --diff-filter=d --name-only --staged) --passWithNoTests
-if [ $? -ne 0 ]; then
-  echo
-  echo "Unit tests failed!"
-  echo
-  exit 1
-else
-  echo
-  echo "Unit tests passed!"
-  echo
-fi
-echo ---------------------------
-echo Running Eslint and Prettier
-echo ---------------------------
-npx eslint --fix $(git diff --diff-filter=d --name-only --staged | grep -E '\.(js|ts|tsx)$')
-if [ $? -ne 0 ]; then
-  echo
-  echo "ESLint failed with errors."
-  echo
-  exit 1
-else
-  echo
-  echo "ESLint passed successfully."
-  echo
-fi
-echo
-echo Pre-commit checks passed!
-exit 0
-

package/.storybook/main.ts

@@ -1,16 +0,0 @@
-const config = {
-  stories: ['../src/stories/**/*.stories.ts'],
-
-  framework: {
-    name: '@storybook/web-components-vite',
-    options: {},
-  },
-
-  addons: [
-    '@storybook/addon-links',
-    '@storybook/addon-docs',
-    '@storybook/addon-a11y',
-  ],
-};
-
-export default config;

package/.storybook/manager.ts

@@ -1,7 +0,0 @@
-import { addons } from 'storybook/manager-api';
-
-import theme from './theme.ts';
-
-addons.setConfig({
-  theme,
-});

package/.storybook/preview.ts

@@ -1,23 +0,0 @@
-import type { Preview } from '@storybook/web-components';
-
-const preview: Preview = {
-  parameters: {
-    controls: {
-      matchers: {
-        color: /(background|color)$/i,
-        date: /Date$/i,
-      },
-    },
-    docs: {
-      source: {
-        language: 'ts',
-        format: 'dedent',
-      },
-    },
-    a11y: {
-      element: 'wavelength-router',
-    },
-  },
-};
-
-export default preview;

package/.storybook/theme.ts

@@ -1,30 +0,0 @@
-import { create } from 'storybook/theming';
-
-export default create({
-  base: 'light',
-
-  colorPrimary: '#007fff',
-  colorSecondary: '#007fff',
-
-  appBg: '#ffffff',
-  appContentBg: '#ffffff',
-  appBorderColor: '#e0e0e0',
-  appBorderRadius: 4,
-
-  textColor: 'rgba(0, 0, 0, 0.87)',
-  textInverseColor: '#ffffff',
-  textMutedColor: 'rgba(0, 0, 0, 0.6)',
-
-  barTextColor: 'rgba(0, 0, 0, 0.6)',
-  barSelectedColor: '#007fff',
-  barBg: '#ffffff',
-  barHoverColor: '#f0f0f0',
-
-  inputBg: '#ffffff',
-  inputBorder: '#e0e0e0',
-  inputTextColor: 'rgba(0, 0, 0, 0.87)',
-  inputBorderRadius: 4,
-
-  booleanBg: '#f6f8fa',
-  booleanSelectedBg: '#e6f4ff',
-});

package/.storybook/vitest.setup.ts

@@ -1,7 +0,0 @@
-import { setProjectAnnotations } from '@storybook/web-components-vite';
-
-import * as projectAnnotations from './preview.ts';
-
-// This is an important step to apply the right configuration when testing your stories.
-// More info at: https://storybook.js.org/docs/api/portable-stories/portable-stories-vitest#setprojectannotations
-setProjectAnnotations([projectAnnotations]);

package/dist/elements/__tests__/RouteElement.test.js

@@ -1,77 +0,0 @@
-import { describe, expect, it, vi, beforeEach } from 'vitest';
-import { RouteElement } from '../RouteElement.ts';
-/* eslint-disable  @typescript-eslint/no-explicit-any */
-describe('RouteElement', () => {
-    beforeEach(() => {
-        if (!customElements.get(RouteElement.tag)) {
-            customElements.define(RouteElement.tag, RouteElement);
-        }
-        document.body.innerHTML = '';
-    });
-    describe('Attribute Accessors & toDefinition Logic', () => {
-        it.each([
-            {
-                it: 'returns default path "*" if attribute is missing',
-                html: `<wavelength-route component="my-view"></wavelength-route>`,
-                expectedPath: '*',
-                expectedTag: 'my-view'
-            },
-            {
-                it: 'extracts specified path and component tag',
-                html: `<wavelength-route path="/home" component="home-view"></wavelength-route>`,
-                expectedPath: '/home',
-                expectedTag: 'home-view'
-            },
-            {
-                it: 'returns null and warns if component attribute is missing',
-                html: `<wavelength-route path="/error"></wavelength-route>`,
-                expectedPath: '/error',
-                expectedTag: '',
-                shouldBeNull: true
-            }
-        ])('$it', ({ html, expectedPath, expectedTag, shouldBeNull }) => {
-            document.body.innerHTML = html;
-            const el = document.querySelector('wavelength-route');
-            const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => { });
-            expect(el.path).toBe(expectedPath);
-            expect(el.componentTag).toBe(expectedTag);
-            const def = el.toDefinition({ document });
-            if (shouldBeNull) {
-                expect(def).toBeNull();
-                expect(warnSpy).toHaveBeenCalled();
-            }
-            else {
-                expect(def?.path).toBe(expectedPath);
-                expect(def?.routeComponent).toBeDefined();
-            }
-            warnSpy.mockRestore();
-        });
-    });
-    describe('SSR / Environment Resilience', () => {
-        it('returns a no-op component if document is missing', () => {
-            const el = document.createElement('wavelength-route');
-            el.setAttribute('component', 'test-view');
-            const def = el.toDefinition({});
-            expect(def?.path).toBe('*');
-            expect(def?.routeComponent.mount).toBeInstanceOf(Function);
-            expect(() => def?.routeComponent.mount({}, {})).not.toThrow();
-            expect(() => def?.routeComponent.unmount?.()).not.toThrow();
-        });
-    });
-    describe('RouteComponent Mounting Logic', () => {
-        it('properly creates element and injects context on mount', () => {
-            const el = document.createElement('wavelength-route');
-            el.setAttribute('component', 'user-profile');
-            const def = el.toDefinition({ document });
-            const container = document.createElement('div');
-            const mockContext = { path: '/user/1', routeParams: { id: '1' }, query: new URLSearchParams() };
-            def?.routeComponent.mount(container, mockContext);
-            const renderedElement = container.querySelector('user-profile');
-            expect(renderedElement).toBeDefined();
-            expect(renderedElement.routeContext).toEqual(mockContext);
-            expect(def?.routeComponent.unmount).toBeDefined();
-            def?.routeComponent.unmount?.();
-        });
-    });
-});
-//# sourceMappingURL=RouteElement.test.js.map

package/eslint.config.mjs

@@ -1,89 +0,0 @@
-import prettier from 'eslint-config-prettier';
-import sonarjs from 'eslint-plugin-sonarjs';
-import storybook from 'eslint-plugin-storybook';
-import wc from 'eslint-plugin-wc';
-import globals from 'globals';
-import tsEslint from 'typescript-eslint';
-
-export default tsEslint.config(
-  {
-    ignores: ['dist/**', 'node_modules/**', 'coverage/**', '.storybook/**'],
-  },
-
-  ...tsEslint.configs.recommended,
-  sonarjs.configs.recommended,
-
-  {
-    files: ['src/**/*.ts'],
-    plugins: {
-      wc,
-    },
-    languageOptions: {
-      parser: tsEslint.parser,
-      parserOptions: {
-        projectService: true,
-        tsconfigRootDir: import.meta.dirname,
-      },
-      globals: {
-        ...globals.browser,
-        ...globals.node,
-      },
-    },
-    rules: {
-      '@typescript-eslint/explicit-member-accessibility': [
-        'error',
-        {
-          accessibility: 'explicit',
-          overrides: {
-            constructors: 'no-public',
-          },
-        },
-      ],
-      '@typescript-eslint/consistent-type-exports': 'error',
-      '@typescript-eslint/no-import-type-side-effects': 'error',
-      '@typescript-eslint/no-explicit-any': 'error',
-
-      ...wc.configs.recommended.rules,
-
-      'wc/no-constructor-attributes': 'error',
-      'wc/no-invalid-element-name': 'error',
-      'wc/guard-super-call': 'error',
-      'wc/attach-shadow-constructor': 'off',
-      'wc/no-self-class': 'off',
-
-      'sonarjs/todo-tag': 'warn',
-      'sonarjs/no-selector-parameter': 'off',
-    },
-  },
-
-  {
-    files: ['**/*.test.ts', '**/*.spec.ts', 'src/**/*.stories.ts'],
-    languageOptions: {
-      parserOptions: {
-        projectService: {
-          allowDefaultProject: ['*.ts', '*.tsx'],
-          extendedReports: true,
-        },
-        tsconfigRootDir: import.meta.dirname,
-      },
-      globals: {
-        ...globals.node,
-        Bun: 'readonly',
-        describe: 'readonly',
-        it: 'readonly',
-        expect: 'readonly',
-        test: 'readonly',
-        beforeAll: 'readonly',
-        afterAll: 'readonly',
-        beforeEach: 'readonly',
-        afterEach: 'readonly',
-      },
-    },
-    rules: {
-      '@typescript-eslint/no-unused-expressions': 'error',
-    },
-  },
-
-  ...storybook.configs['flat/recommended'],
-  prettier,
-);

package/index.ts

@@ -1,15 +0,0 @@
-export { Router } from './src/router/Router.ts';
-export { RouterElement } from './src/elements/RouterElement.ts';
-export { RouteElement } from './src/elements/RouteElement.ts';
-
-export type {
-  RouteComponent,
-  RouteContext,
-  RouteDefinition,
-  RouteGuard,
-  RouteParams,
-  CompiledRoute,
-  MatchedRoute,
-} from './src/models/index.ts';
-
-export { compileRoute, matchRoute } from './src/utils/index.ts';

package/prettier.config.ts

@@ -1,30 +0,0 @@
-import type { Config } from 'prettier';
-
-const config: Config = {
-  endOfLine: 'lf',
-  arrowParens: 'always',
-  semi: true,
-  trailingComma: 'all',
-  singleQuote: true,
-  printWidth: 80,
-  tabWidth: 2,
-  useTabs: false,
-  plugins: ['@trivago/prettier-plugin-sort-imports'],
-  importOrder: [
-    '^bun.*$',
-    '<THIRD_PARTY_MODULES>',
-    '^@/(.*)$',
-    '^[../]',
-    '^[./]',
-    '(.css|.scss)$',
-  ],
-  importOrderSeparation: true,
-  importOrderSortSpecifiers: true,
-  importOrderParserPlugins: [
-    'typescript',
-    'decorators-legacy',
-    'importAssertions',
-  ],
-};
-
-export default config;