[ { "path": ".github/ISSUE_TEMPLATE/bug_report.md", "content": "---\nname: Bug report\nabout: Create a report to help us improve\ntitle: ''\nlabels: bug\nassignees: mateothegreat\n\n---\n\n**Describe the bug**\nA clear and concise description of what the bug is.\n\n**To Reproduce**\nSteps to reproduce the behavior:\n1. Go to '...'\n2. Click on '....'\n3. See error\n\n**Expected behavior**\nA clear and concise description of what you expected to happen.\n\n**Logs**\nIf available please provide any available logs, screenshots, etc.\n\n**Additional context**\nAdd any other context about the problem here.\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.md", "content": "---\nname: Feature request\nabout: Suggest an idea for this project\ntitle: ''\nlabels: enhancement\nassignees: mateothegreat\n\n---\n\n**Is your feature request related to a problem? Please describe.**\nA clear and concise description of what the problem is. Ex. I'm always frustrated when [...]\n\n**Describe the solution you'd like**\nA clear and concise description of what you want to happen.\n\n**Additional context**\nAdd any other context or screenshots about the feature request here.\n" }, { "path": ".github/dependabot.yml", "content": "# To get started with Dependabot version updates, you'll need to specify which\n# package ecosystems to update and where the package manifests are located.\n# Please see the documentation for all configuration options:\n# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file\nversion: 2\nupdates:\n - package-ecosystem: \"npm\" # See documentation for possible values\n directory: \"/\" # Location of package manifests\n schedule:\n interval: \"daily\"\n" }, { "path": ".github/workflows/demo.yaml", "content": "name: ๐Ÿ“ฑ Demo\non:\n workflow_dispatch:\n workflow_call:\n secrets:\n VERCEL_TOKEN:\n required: true\nconcurrency:\n group: demo\n cancel-in-progress: true\njobs:\n build:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - name: install vercel\n run: npm install --global vercel@latest\n - name: vercel pull\n run: vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }}\n - name: vercel build\n run: vercel build --local-config demo/vercel.json --prod --token=${{ secrets.VERCEL_TOKEN }}\n - name: vercel deploy\n run: vercel deploy --local-config demo/vercel.json --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }}\n" }, { "path": ".github/workflows/docs.yaml", "content": "name: ๐Ÿ“š Docs\non:\n workflow_dispatch:\n workflow_call:\npermissions:\n id-token: write\n pages: write\ndefaults:\n run:\n shell: bash\n working-directory: ./docs\njobs:\n setup:\n name: ๐Ÿ”ง Request\n uses: ./.github/workflows/setup.yaml\n build:\n name: \"๐Ÿ“š Build Docs\"\n needs: setup\n environment:\n name: github-pages\n url: ${{ steps.deployment.outputs.page_url }}\n runs-on: ubuntu-latest\n steps:\n # [setup] checkout the repo.\n - uses: actions/checkout@v5.0.0\n with:\n fetch-depth: 0\n persist-credentials: false\n # [setup] setup node.js.\n - name: Setup Node.js\n uses: actions/setup-node@v4.4.0\n with:\n node-version: 20.x\n - name: ๐Ÿ“Š Generate diagrams\n run: make diagrams\n - name: ๐Ÿ“š Build documentation\n run: npm run docs:build\n - name: ๐Ÿ“ค Upload Pages artifact\n uses: actions/upload-pages-artifact@v3.0.1\n with:\n path: tmp/build\n - id: deployment\n name: ๐Ÿ“ค Deploy documentation to GitHub Pages\n uses: actions/deploy-pages@v4.0.5\n # [setup] authenticate with the cicd app to get proper credentials for pushing to the repo later.\n - name: cicd app auth\n id: app\n uses: actions/create-github-app-token@v2.1.1\n with:\n app-id: ${{ secrets.CICD_APP_ID }}\n private-key: ${{ secrets.CICD_APP_PRIVATE_KEY }}\n # [setup] configure git for later changelog generation, commit, and the finalpush.\n - name: ๐Ÿ”ง Commit and push diagrams\n run: |\n git config --global user.name \"mateothegreat[bot]\"\n git config --global user.email \"mateothegreat[bot]@users.noreply.github.com\"\n git remote set-url origin https://x-access-token:${{ steps.app.outputs.token }}@github.com/${{ github.repository }}.git\n git add .\n git commit -am \"chore(docs): update diagrams\"\n git push origin HEAD:main\n" }, { "path": ".github/workflows/release.yaml", "content": "name: ๐Ÿš€ Release\nrun-name: ๐Ÿš€ Release (${{ github.event.inputs.label }})\non:\n workflow_dispatch:\n inputs:\n label:\n description: \"The label to add to the release\"\n required: false\n default: \"standard release\"\n type: string\n build_docs:\n description: \"Release the docs?\"\n required: false\n default: false\n type: boolean\n build_demo:\n description: \"Release the demo?\"\n required: false\n default: false\n type: boolean\nconcurrency:\n group: release\n cancel-in-progress: true\njobs:\n release:\n name: ๐Ÿš€ Release ${{ github.event.inputs.label }}\n runs-on: ubuntu-latest\n permissions:\n contents: write\n packages: write\n steps:\n # [setup] authenticate with the cicd app to get proper credentials for pushing to the repo later.\n - name: cicd app auth\n id: app\n uses: actions/create-github-app-token@v2.1.1\n with:\n app-id: ${{ secrets.CICD_APP_ID }}\n private-key: ${{ secrets.CICD_APP_PRIVATE_KEY }}\n # [setup] checkout the repo.\n - uses: actions/checkout@v5.0.0\n with:\n fetch-depth: 0\n persist-credentials: false\n # [setup] setup node.js.\n - name: Setup Node.js\n uses: actions/setup-node@v4.4.0\n with:\n node-version: 20.x\n # [setup] configure git for later changelog generation, commit, and the finalpush.\n - name: configure git\n run: |\n git config --global user.name \"mateothegreat[bot]\"\n git config --global user.email \"mateothegreat[bot]@users.noreply.github.com\"\n git remote set-url origin https://x-access-token:${{ steps.app.outputs.token }}@github.com/${{ github.repository }}.git\n # [build] install dependencies first.\n - name: install\n run: npm install\n # [build] build the package which outputs to the dist/ directory.\n - name: build\n run: npm run build\n # [version] bump the version\n - name: npm version\n id: version\n run: |\n version=$(npm version patch --no-git-tag-version --json | sed 's/^v//' || {\n echo \"npm version patch failed, git is dirty\"\n exit 1\n })\n echo \"version=$version\" >> \"$GITHUB_OUTPUT\"\n echo \"version is now: $version\"\n # [version] generate the new changelog.\n - name: generate changelog\n uses: orhun/git-cliff-action@98c93442bb05a455a77bee982867857ae748eeea\n id: git-cliff\n with:\n config: ./docs/cliff.toml\n args: --tag ${{ steps.version.outputs.version }}\n env:\n OUTPUT: docs/changelog.md\n # [version] commit the changelog and package.json.\n - name: commit\n run: |\n git add docs/changelog.md package.json\n git commit -am \"chore(release): update of changelog and bumping package.json for ${{ steps.version.outputs.version }}\"\n git push origin HEAD:main\n git tag -a ${{ steps.version.outputs.version }} -m \"release: ${{ steps.version.outputs.version }}\"\n git push origin ${{ steps.version.outputs.version }}\n # [publish] prepare to publish by setting up credentials.\n - name: write to .npmrc\n run: echo \"//registry.npmjs.org/:_authToken=${{secrets.NPM_TOKEN}}\" > ~/.npmrc\n # [publish] release publicly only if the build was successful above.\n - name: publish\n working-directory: dist\n run: |\n cp ../package.json .\n npm publish --access public\n # [publish] create a github release.\n - name: create github release\n uses: softprops/action-gh-release@v2.3.2\n with:\n body: ${{ steps.git-cliff.outputs.content }}\n tag_name: ${{ steps.version.outputs.version }}\n docs:\n if: ${{ github.event.inputs.build_docs == true }}\n needs: release\n permissions:\n id-token: write\n pages: write\n uses: ./.github/workflows/docs.yaml\n demo:\n if: ${{ github.event.inputs.build_demo == true }}\n needs: release\n uses: ./.github/workflows/demo.yaml\n secrets: inherit\n notify:\n if: always()\n continue-on-error: true\n needs: release\n runs-on: ubuntu-latest\n steps:\n - uses: Ilshidur/action-discord@ad5235de713df3ef38022185499b02ffe93b7efe\n with:\n status: ${{ needs.build.result }}\n webhook: ${{ secrets.DISCORD_WEBHOOK }}\n env:\n DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}\n" }, { "path": ".github/workflows/setup.yaml", "content": "name: ๐Ÿ”ง Setup\non:\n workflow_call:\njobs:\n node:\n name: \"Runtime\" \n environment:\n name: dev\n runs-on: ubuntu-latest\n steps:\n - name: โฌ‡๏ธ Check out repo\n uses: actions/checkout@v4\n - name: โŽ” Setup node\n uses: actions/setup-node@v4\n with:\n node-version-file: \"package.json\"\n cache: \"npm\"\n - name: ๐Ÿ“ฆ Cache node_modules\n uses: actions/cache@v3\n id: cache-node-modules\n with:\n path: node_modules\n key: ${{ hashFiles('package-lock.json') }} \n - name: ๐Ÿ“ฆ Install dependencies\n if: steps.cache-node-modules.outputs.cache-hit != 'true'\n run: |\n npm ci --legacy-peer-deps \n" }, { "path": ".github/workflows/test.yaml", "content": "name: โšก Test Runner\non:\n workflow_dispatch:\n workflow_call:\npermissions:\n contents: write\njobs:\n setup:\n name: \"๐Ÿ”ง Setup\"\n environment:\n name: dev\n runs-on: ubuntu-latest\n steps:\n - name: โฌ‡๏ธ Check out repo\n uses: actions/checkout@v4\n - name: โŽ” Setup node\n uses: actions/setup-node@v4\n with:\n node-version-file: \"package.json\"\n cache: \"npm\"\n # cache-dependency-path: \"package-lock.json\"\n - name: ๐Ÿงน Clean install for cross-platform compatibility\n run: |\n npm ci --legacy-peer-deps\n test:\n name: ๐Ÿƒ Test\n needs: setup\n environment:\n name: dev\n runs-on: ubuntu-latest\n steps:\n - name: โฌ‡๏ธ Check out repo\n uses: actions/checkout@v4\n - name: โŽ” Setup node (reuse cache from setup)\n uses: actions/setup-node@v4\n with:\n node-version-file: \"package.json\"\n cache: \"npm\"\n - name: Hydrate npm module cache\n uses: actions/cache@v3\n id: hydrate\n with:\n path: node_modules\n key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }}\n - name: Install dependencies\n if: steps.hydrate.outputs.cache-hit != 'true'\n run: npm ci --legacy-peer-deps\n - name: ๐Ÿงช Run Tests\n run: npm run test:ci\n - name: โš™๏ธ Generating coverage badges\n run: |\n npx --yes coverage-badges-cli \\\n --source tmp/coverage/coverage-summary.json \\\n --style plastic \\\n --type statements \\\n --iconWidth 190 \\\n --label \"Test Coverage\" \\\n --output docs/assets/coverage-badge.svg\n - name: โฌ†๏ธ Push badges branch\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git add docs/assets/coverage-badge.svg\n git commit -m \"chore: update coverage badge\"\n git push\n" }, { "path": "LICENSE", "content": "MIT License\n\nCopyright (c) 2025 Matthew Davis \n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "demo/cypress/e2e/route-activation.cy.ts", "content": "/// \n\nconst routes = require(\"../fixtures/routes.json\");\ndescribe.only(\"route activation\", () => {\n beforeEach(() => {\n cy.viewport(1500, 1500);\n cy.visit(\"http://localhost:8173\");\n });\n\n routes.forEach((route) => {\n it(`should activate ${route.id} when visiting ${route.path}`, () => {\n cy.clickAndValidateActiveClasses(`a[href='${route.path}']`, \"active\", route.active);\n });\n });\n\n // it.only(\"displays two todo items by default\", () => {\n // // cy.get(\"a[href='/props']\").should(\"have.length\", 1).click();\n // // cy.contains(\"props.svelte\").should(\"exist\");\n\n // // cy.get(\"a[href='/props/foo']\").should(\"have.length\", 1).click();\n // // cy.contains(\"display-params.svelte\").should(\"exist\");\n // // cy.contains(`\"child\": \"foo\"`).should(\"exist\");\n\n // // cy.get(\"a\").filter('[href^=\"/props/bar?\"]').should(\"have.length\", 1).click();\n // // cy.contains(\"display-params.svelte\").should(\"exist\");\n // // cy.contains(`\"child\": \"bar\"`).should(\"exist\");\n\n // // cy.get(\"a\").filter('[href=\"/props/foo\"]').should(\"not.have.class\", \"active\");\n // // cy.get(\"a\").filter('[href^=\"/props/bar\"]').should(\"have.class\", \"active\");\n\n // cy.clickAndValidateActiveClasses(\"a[href='/props']\", \"active\");\n // });\n\n // it(\"can add new todo items\", () => {\n // // We'll store our item text in a variable so we can reuse it\n // const newItem = \"Feed the cat\";\n\n // // Let's get the input element and use the `type` command to\n // // input our new list item. After typing the content of our item,\n // // we need to type the enter key as well in order to submit the input.\n // // This input has a data-test attribute so we'll use that to select the\n // // element in accordance with best practices:\n // // https://on.cypress.io/selecting-elements\n // cy.get(\"[data-test=new-todo]\").type(`${newItem}{enter}`);\n\n // // Now that we've typed our new item, let's check that it actually was added to the list.\n // // Since it's the newest item, it should exist as the last element in the list.\n // // In addition, with the two default items, we should have a total of 3 elements in the list.\n // // Since assertions yield the element that was asserted on,\n // // we can chain both of these assertions together into a single statement.\n // cy.get(\".todo-list li\")\n // .should(\"have.length\", 3)\n // .last()\n // .should(\"have.text\", newItem);\n // });\n\n // it(\"can check off an item as completed\", () => {\n // // In addition to using the `get` command to get an element by selector,\n // // we can also use the `contains` command to get an element by its contents.\n // // However, this will yield the