[ { "path": ".editorconfig", "content": "# EditorConfig helps developers define and maintain consistent\n# coding styles between different editors and IDEs\n# editorconfig.org\n\nroot = true\n\n[*]\nend_of_line = lf\ncharset = utf-8\ntrim_trailing_whitespace = true\ninsert_final_newline = true\nindent_style = space\nindent_size = 2\n\n[*.hbs]\ninsert_final_newline = false\n\n[*.{diff,md}]\ntrim_trailing_whitespace = false\n" }, { "path": ".github/dependabot.yml", "content": "version: 2\nupdates:\n- package-ecosystem: npm\n directory: \"/\"\n schedule:\n interval: daily\n time: \"10:00\"\n open-pull-requests-limit: 10\n labels:\n - dependencies\n ignore:\n - dependency-name: ember-cli\n versions:\n - \">= 0\"" }, { "path": ".github/workflows/addon-docs.yml", "content": "name: Publish Addon Docs\n\non:\n push:\n branches:\n - main\n - master\n tags:\n - \"**\"\njobs:\n build:\n env:\n DEPLOY_KEY: ${{ secrets.DEPLOY_KEY }}\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n with:\n fetch-depth: 0\n token: ${{ secrets.GITHUB_TOKEN }}\n - name: Check for tags and set short-circuit condition\n id: check-tags\n run: |\n # Fetch tags pointing to the current commit\n TAGS=$(git tag --points-at $GITHUB_SHA)\n echo \"Tags found: $TAGS\"\n\n # Check if a tag exists and if the ref is 'refs/heads/main' or 'refs/heads/master'\n if [ -n \"$TAGS\" ] && ([[ \"${GITHUB_REF}\" == \"refs/heads/main\" ]] || [[ \"${GITHUB_REF}\" == \"refs/heads/master\" ]]); then\n echo \"SHORT_CIRCUIT=true\" >> $GITHUB_ENV\n else\n echo \"SHORT_CIRCUIT=false\" >> $GITHUB_ENV\n fi\n - uses: pnpm/action-setup@v4\n if: env.SHORT_CIRCUIT == 'false'\n with:\n version: 10\n - uses: actions/setup-node@v4\n if: env.SHORT_CIRCUIT == 'false'\n with:\n node-version: 20\n cache: pnpm\n - name: Install Dependencies\n if: env.SHORT_CIRCUIT == 'false'\n run: pnpm install --no-lockfile\n - name: Deploy Docs\n if: env.SHORT_CIRCUIT == 'false'\n run: |\n cd test-app\n pnpm ember deploy production\n" }, { "path": ".github/workflows/ci.yml", "content": "name: CI\n\non:\n push:\n branches:\n - main\n - master\n pull_request: {}\n\nconcurrency:\n group: ci-${{ github.head_ref || github.ref }}\n cancel-in-progress: true\n\njobs:\n test:\n name: \"Tests\"\n runs-on: ubuntu-latest\n timeout-minutes: 10\n\n steps:\n - uses: actions/checkout@v4\n - uses: pnpm/action-setup@v4\n with:\n version: 10\n - uses: actions/setup-node@v4\n with:\n node-version: 20\n cache: pnpm\n - name: Install Dependencies\n run: pnpm install --frozen-lockfile\n - name: Lint\n run: pnpm lint\n - name: Run Tests\n run: pnpm test\n\n floating:\n name: \"Floating Dependencies\"\n runs-on: ubuntu-latest\n timeout-minutes: 10\n\n steps:\n - uses: actions/checkout@v4\n - uses: pnpm/action-setup@v4\n with:\n version: 10\n - uses: actions/setup-node@v4\n with:\n node-version: 20\n cache: pnpm\n - name: Install Dependencies\n run: pnpm install --no-lockfile\n - name: Run Tests\n run: pnpm test\n\n try-scenarios:\n name: ${{ matrix.try-scenario }}\n runs-on: ubuntu-latest\n needs: 'test'\n timeout-minutes: 10\n\n strategy:\n fail-fast: false\n matrix:\n try-scenario:\n - ember-lts-4.8\n - ember-lts-4.12\n - ember-lts-5.4\n - ember-release\n - ember-beta\n - ember-canary\n - embroider-safe\n - embroider-optimized\n\n steps:\n - uses: actions/checkout@v4\n - uses: pnpm/action-setup@v4\n with:\n version: 10\n - uses: actions/setup-node@v4\n with:\n node-version: 20\n cache: pnpm\n - name: Install Dependencies\n run: pnpm install --frozen-lockfile\n - name: Run Tests\n run: ./node_modules/.bin/ember try:one ${{ matrix.try-scenario }} --skip-cleanup\n working-directory: test-app\n" }, { "path": ".github/workflows/plan-release.yml", "content": "name: Plan Release\non:\n workflow_dispatch:\n push:\n branches:\n - main\n - master\n pull_request_target: # This workflow has permissions on the repo, do NOT run code from PRs in this workflow. See https://securitylab.github.com/research/github-actions-preventing-pwn-requests/\n types:\n - labeled\n - unlabeled\n\nconcurrency:\n group: plan-release # only the latest one of these should ever be running\n cancel-in-progress: true\n\njobs:\n should-run-release-plan-prepare:\n name: Should we run release-plan prepare?\n runs-on: ubuntu-latest\n outputs:\n should-prepare: ${{ steps.should-prepare.outputs.should-prepare }}\n steps:\n - uses: release-plan/actions/should-prepare-release@v1\n with:\n ref: 'main'\n id: should-prepare\n\n create-prepare-release-pr:\n name: Create Prepare Release PR\n runs-on: ubuntu-latest\n timeout-minutes: 5\n needs: should-run-release-plan-prepare\n permissions:\n contents: write\n issues: read\n pull-requests: write\n if: needs.should-run-release-plan-prepare.outputs.should-prepare == 'true'\n steps:\n - uses: release-plan/actions/prepare@v1\n name: Run release-plan prepare\n with:\n ref: 'main'\n env:\n GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}\n id: explanation\n\n - uses: peter-evans/create-pull-request@v8\n name: Create Prepare Release PR\n with:\n commit-message: \"Prepare Release ${{ steps.explanation.outputs.new-version}} using 'release-plan'\"\n labels: \"internal\"\n sign-commits: true\n branch: release-preview\n title: Prepare Release ${{ steps.explanation.outputs.new-version }}\n body: |\n This PR is a preview of the release that [release-plan](https://github.com/embroider-build/release-plan) has prepared. To release you should just merge this PR 👍\n\n -----------------------------------------\n\n ${{ steps.explanation.outputs.text }}\n" }, { "path": ".github/workflows/publish.yml", "content": "# For every push to the primary branch with .release-plan.json modified,\n# runs release-plan.\n\nname: Publish Stable\n\non:\n workflow_dispatch:\n push:\n branches:\n - main\n - master\n paths:\n - '.release-plan.json'\n\nconcurrency:\n group: publish-${{ github.head_ref || github.ref }}\n cancel-in-progress: true\n\njobs:\n publish:\n name: \"NPM Publish\"\n runs-on: ubuntu-latest\n permissions:\n contents: write\n id-token: write\n attestations: write\n\n steps:\n - uses: actions/checkout@v6\n - uses: pnpm/action-setup@v4\n with:\n version: 9\n - uses: actions/setup-node@v6\n with:\n node-version: 22\n registry-url: 'https://registry.npmjs.org'\n cache: pnpm\n - run: npm install -g npm@latest # ensure that the globally installed npm is new enough to support OIDC\n - run: pnpm install --frozen-lockfile\n - name: Publish to NPM\n run: NPM_CONFIG_PROVENANCE=true pnpm release-plan publish\n env:\n GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}\n" }, { "path": ".github/workflows/push-dist.yml", "content": "# Because this library needs to be built,\n# we can't easily point package.json files at the git repo for easy cross-repo testing.\n#\n# This workflow brings back that capability by placing the compiled assets on a \"dist\" branch\n# (configurable via the \"branch\" option below)\nname: Push dist\n\non:\n push:\n branches:\n - main\n - master\n\njobs:\n push-dist:\n name: Push dist\n permissions:\n contents: write\n runs-on: ubuntu-latest\n timeout-minutes: 10\n\n steps:\n - uses: actions/checkout@v4\n - uses: pnpm/action-setup@v4\n with:\n version: 10\n - uses: actions/setup-node@v4\n with:\n node-version: 20\n cache: pnpm\n - name: Install Dependencies\n run: pnpm install --frozen-lockfile\n - uses: kategengler/put-built-npm-package-contents-on-branch@v2.0.0\n with:\n branch: dist\n token: ${{ secrets.GITHUB_TOKEN }}\n working-directory: 'ember-shepherd'\n" }, { "path": ".gitignore", "content": "# See https://help.github.com/ignore-files/ for more about ignoring files.\n\n# dependencies\nnode_modules/\n\n# misc\n.env*\n.pnp*\n.pnpm-debug.log\n.sass-cache\n.eslintcache\ncoverage/\nnpm-debug.log*\nyarn-error.log\n\n# ember-try\n/.node_modules.ember-try/\n/package.json.ember-try\n/package-lock.json.ember-try\n/yarn.lock.ember-try\n/pnpm-lock.ember-try.yaml\n\n# addon-docs\ndeploy-test-app\n\n" }, { "path": ".npmrc", "content": "####################\n# super strict mode\n####################\nauto-install-peers=false\nstrict-peer-dependents=true\nresolve-peers-from-workspace-root=false\n\n################\n# Optimizations\n################\n# Less strict, but required for tooling to not barf on duplicate peer trees.\n# (many libraries declare the same peers, which resolve to the same\n# versions)\ndedupe-peer-dependents=true\npublic-hoist-pattern[]=ember-source\n\n################\n# Compatibility\n################\n# highest is what everyone is used to, but\n# not ensuring folks are actually compatible with declared ranges.\nresolution-mode=highest" }, { "path": ".prettierignore", "content": "# Prettier is also run from each package, so the ignores here\n# protect against files that may not be within a package\n\n# misc\n!.*\n.lint-todo/\n\n# ember-try\n/.node_modules.ember-try/\n/pnpm-lock.ember-try.yaml\n" }, { "path": ".prettierrc.cjs", "content": "'use strict';\n\nmodule.exports = {\n plugins: ['prettier-plugin-ember-template-tag'],\n singleQuote: true,\n};\n" }, { "path": ".release-plan.json", "content": "{\n \"solution\": {\n \"ember-shepherd\": {\n \"impact\": \"major\",\n \"oldVersion\": \"17.3.1\",\n \"newVersion\": \"18.0.0\",\n \"tagName\": \"latest\",\n \"constraints\": [\n {\n \"impact\": \"major\",\n \"reason\": \"Appears in changelog section :boom: Breaking Change\"\n },\n {\n \"impact\": \"patch\",\n \"reason\": \"Appears in changelog section :house: Internal\"\n }\n ],\n \"pkgJSONPath\": \"./ember-shepherd/package.json\"\n }\n },\n \"description\": \"## Release (2026-02-16)\\n\\n* ember-shepherd 18.0.0 (major)\\n\\n#### :boom: Breaking Change\\n* `ember-shepherd`\\n * [#1816](https://github.com/RobbieTheWagner/ember-shepherd/pull/1816) Update to shepherd.js 15 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\\n * [#1815](https://github.com/RobbieTheWagner/ember-shepherd/pull/1815) Update license to AGPL ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\\n * [#1808](https://github.com/RobbieTheWagner/ember-shepherd/pull/1808) Drop support for Ember < 4.8 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\\n\\n#### :house: Internal\\n* Other\\n * [#1817](https://github.com/RobbieTheWagner/ember-shepherd/pull/1817) release-it -> release-plan ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\\n * [#1807](https://github.com/RobbieTheWagner/ember-shepherd/pull/1807) node 20 / pnpm 10 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\\n* `ember-shepherd`\\n * [#1729](https://github.com/RobbieTheWagner/ember-shepherd/pull/1729) Update blueprints ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\\n\\n#### Committers: 1\\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\\n\"\n}\n" }, { "path": ".tool-versions", "content": "nodejs 20.20.0\npnpm 10.28.0\n" }, { "path": "CHANGELOG.md", "content": "# Changelog\n\n## Release (2026-02-16)\n\n* ember-shepherd 18.0.0 (major)\n\n#### :boom: Breaking Change\n* `ember-shepherd`\n * [#1816](https://github.com/RobbieTheWagner/ember-shepherd/pull/1816) Update to shepherd.js 15 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n * [#1815](https://github.com/RobbieTheWagner/ember-shepherd/pull/1815) Update license to AGPL ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n * [#1808](https://github.com/RobbieTheWagner/ember-shepherd/pull/1808) Drop support for Ember < 4.8 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### :house: Internal\n* Other\n * [#1817](https://github.com/RobbieTheWagner/ember-shepherd/pull/1817) release-it -> release-plan ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n * [#1807](https://github.com/RobbieTheWagner/ember-shepherd/pull/1807) node 20 / pnpm 10 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n* `ember-shepherd`\n * [#1729](https://github.com/RobbieTheWagner/ember-shepherd/pull/1729) Update blueprints ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n\n\n\n\n\n\n\n\n\n\n## v17.3.1 (2024-12-07)\n\n#### :bug: Bug Fix\n* [#1716](https://github.com/RobbieTheWagner/ember-shepherd/pull/1716) Ensure `tourObject` is defined before using it ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### :house: Internal\n* [#1717](https://github.com/RobbieTheWagner/ember-shepherd/pull/1717) Run TypeScript blueprints ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n## v17.3.0 (2024-12-07)\n\n#### :rocket: Enhancement\n* [#1715](https://github.com/RobbieTheWagner/ember-shepherd/pull/1715) Add destructor and set container when testing ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n## v17.2.0 (2024-12-07)\n\n#### :rocket: Enhancement\n* [#1714](https://github.com/RobbieTheWagner/ember-shepherd/pull/1714) Add support for `stepsContainer` ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n## v17.1.4 (2024-12-06)\n\n#### :bug: Bug Fix\n* [#1712](https://github.com/RobbieTheWagner/ember-shepherd/pull/1712) Make button type optional ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### :house: Internal\n* [#1713](https://github.com/RobbieTheWagner/ember-shepherd/pull/1713) Add addon-docs deploy action ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n## v17.1.3 (2024-11-27)\n\n#### :bug: Bug Fix\n* [#1711](https://github.com/RobbieTheWagner/ember-shepherd/pull/1711) Use tracked properties for everything ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n## v17.1.2 (2024-11-26)\n\n#### :bug: Bug Fix\n* [#1710](https://github.com/RobbieTheWagner/ember-shepherd/pull/1710) Use EmberShepherdStepOptions type for steps ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n## v17.1.1 (2024-11-26)\n\n#### :bug: Bug Fix\n* [#1709](https://github.com/RobbieTheWagner/ember-shepherd/pull/1709) Update button types ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n## v17.1.0 (2024-11-26)\n\n#### :rocket: Enhancement\n* [#1708](https://github.com/RobbieTheWagner/ember-shepherd/pull/1708) Add types ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n## v17.0.8 (2024-11-20)\n\n## v17.0.7 (2024-11-20)\n\n#### :house: Internal\n* [#1707](https://github.com/RobbieTheWagner/ember-shepherd/pull/1707) Try embroider again ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n## v17.0.6 (2024-11-20)\n\n## v17.0.5 (2024-11-19)\n\n## v17.0.4 (2024-11-19)\n\n#### :house: Internal\n* [#1706](https://github.com/RobbieTheWagner/ember-shepherd/pull/1706) Go back to not full embroider ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n## v17.0.3 (2024-11-19)\n\n## v17.0.2 (2024-11-19)\n\n## v17.0.1 (2024-11-19)\n\n## v17.0.0 (2024-11-19)\n\n#### :boom: Breaking Change\n* [#1705](https://github.com/RobbieTheWagner/ember-shepherd/pull/1705) Convert to v2 addon ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v16.0.0 (2024-11-19)\n\n#### :boom: Breaking Change\n* [#1693](https://github.com/RobbieTheWagner/ember-shepherd/pull/1693) Bump shepherd.js from 11.2.0 to 14.1.0 ([@dependabot[bot]](https://github.com/apps/dependabot))\n\n#### :rocket: Enhancement\n* [#1704](https://github.com/RobbieTheWagner/ember-shepherd/pull/1704) Add back support for Ember >= 4.4 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### :memo: Documentation\n* [#1703](https://github.com/RobbieTheWagner/ember-shepherd/pull/1703) Update demo and docs ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n* [#1689](https://github.com/RobbieTheWagner/ember-shepherd/pull/1689) Update README.md with working docs link ([@zion](https://github.com/zion))\n\n#### :house: Internal\n* [#1702](https://github.com/RobbieTheWagner/ember-shepherd/pull/1702) Disable embroider-optimized ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n* [#1701](https://github.com/RobbieTheWagner/ember-shepherd/pull/1701) Switch to pnpm ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 2\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n- Simeon ([@zion](https://github.com/zion))\n\n\n## v15.0.0 (2024-03-28)\n\n#### :boom: Breaking Change\n* [#1636](https://github.com/RobbieTheWagner/ember-shepherd/pull/1636) Drop support for Ember < 4.8 and node < 18 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n* [#1373](https://github.com/RobbieTheWagner/ember-shepherd/pull/1373) ember/ember-cli 4.12 drop support for Ember < 4.4 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v14.0.0 (2022-11-30)\n\n#### :boom: Breaking Change\n* [#1237](https://github.com/RobbieTheWagner/ember-shepherd/pull/1237) Bump shepherd.js from 10.0.1 to 11.0.0 ([@dependabot[bot]](https://github.com/apps/dependabot))\n\n#### :house: Internal\n* [#1227](https://github.com/RobbieTheWagner/ember-shepherd/pull/1227) Pin ember-data ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v13.1.0 (2022-10-25)\n\n#### :house: Internal\n* [#1211](https://github.com/RobbieTheWagner/ember-shepherd/pull/1211) ESLint 8, ember-cli 4.8 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v13.0.0 (2022-08-26)\n\n#### :boom: Breaking Change\n* [#1166](https://github.com/RobbieTheWagner/ember-shepherd/pull/1166) ember-cli 4.6, drop node 12 support ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v12.1.0 (2022-02-16)\n\n#### :house: Internal\n* [#983](https://github.com/RobbieTheWagner/ember-shepherd/pull/983) ember-cli 4.1.0 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n* [#975](https://github.com/RobbieTheWagner/ember-shepherd/pull/975) ember-cli 4 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n* [#952](https://github.com/RobbieTheWagner/ember-shepherd/pull/952) Ember 3.28 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n* [#950](https://github.com/RobbieTheWagner/ember-shepherd/pull/950) Bump deps ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v12.0.0 (2021-09-16)\n\n#### :boom: Breaking Change\n* [#779](https://github.com/RobbieTheWagner/ember-shepherd/pull/779) Ember 3.26, ember-auto-import 2 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### :house: Internal\n* [#773](https://github.com/RobbieTheWagner/ember-shepherd/pull/773) Add dependabot automerge ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n* [#654](https://github.com/RobbieTheWagner/ember-shepherd/pull/654) Update eslint-plugin-ember, fix lint ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v11.0.2 (2020-12-14)\n\n#### :memo: Documentation\n* [#551](https://github.com/RobbieTheWagner/ember-shepherd/pull/551) Use the new CodeBlock format ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### :house: Internal\n* [#634](https://github.com/RobbieTheWagner/ember-shepherd/pull/634) Switch from Travis to GitHub actions ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n* [#633](https://github.com/RobbieTheWagner/ember-shepherd/pull/633) Ember 3.22 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v11.0.1 (2020-07-08)\n\n#### :rocket: Enhancement\n* [#450](https://github.com/RobbieTheWagner/ember-shepherd/pull/450) Add support for modalContainer, fix Tour options ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### :house: Internal\n* [#516](https://github.com/RobbieTheWagner/ember-shepherd/pull/516) Add embroider tests ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v11.0.0 (2020-02-25)\n\n#### :boom: Breaking Change\n* [#432](https://github.com/RobbieTheWagner/ember-shepherd/pull/432) Shepherd.js v7 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v9.0.0 (2019-08-29)\n\n#### :boom: Breaking Change\n* [#338](https://github.com/RobbieTheWagner/ember-shepherd/pull/338) Shepherd 5.x ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v8.0.0 (2019-08-01)\n\n#### :boom: Breaking Change\n* [#333](https://github.com/RobbieTheWagner/ember-shepherd/pull/333) Shepherd 4 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v7.0.0 (2019-06-23)\n\n#### :boom: Breaking Change\n* [#325](https://github.com/RobbieTheWagner/ember-shepherd/pull/325) Remove body-scroll-lock, shepherd.js 3.0.0 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### :rocket: Enhancement\n* [#325](https://github.com/RobbieTheWagner/ember-shepherd/pull/325) Remove body-scroll-lock, shepherd.js 3.0.0 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v6.0.0 (2019-05-26)\n\n#### :boom: Breaking Change\n* [#316](https://github.com/RobbieTheWagner/ember-shepherd/pull/316) Ember 3.10, drop support for node 6 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### :rocket: Enhancement\n* [#317](https://github.com/RobbieTheWagner/ember-shepherd/pull/317) Shepherd.js 2.9.0, bump other deps ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v5.0.0 (2019-05-03)\n\n#### :boom: Breaking Change\n* [#305](https://github.com/RobbieTheWagner/ember-shepherd/pull/305) load shepherd.js lazily using ember-auto-import ([@st-h](https://github.com/st-h))\n\n#### :rocket: Enhancement\n* [#307](https://github.com/RobbieTheWagner/ember-shepherd/pull/307) replace fastboot guards with an initializer ([@st-h](https://github.com/st-h))\n* [#305](https://github.com/RobbieTheWagner/ember-shepherd/pull/305) load shepherd.js lazily using ember-auto-import ([@st-h](https://github.com/st-h))\n\n#### Committers: 2\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n- Steve ([@st-h](https://github.com/st-h))\n\n\n## v4.9.0 (2019-04-15)\n\n#### :rocket: Enhancement\n* [#302](https://github.com/RobbieTheWagner/ember-shepherd/pull/302) Update to Shepherd 2.6.0 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v4.8.0 (2019-04-06)\n\n#### :rocket: Enhancement\n* [#297](https://github.com/RobbieTheWagner/ember-shepherd/pull/297) Use ember-cli-addon-docs for documentation ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v4.7.0 (2019-04-05)\n\n#### :rocket: Enhancement\n* [#295](https://github.com/RobbieTheWagner/ember-shepherd/pull/295) Use rootElement, if defined, rather than document.body ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n* [#296](https://github.com/RobbieTheWagner/ember-shepherd/pull/296) Use ember-auto-import to import disable-scroll, bump disable-scroll to 0.4.1 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v4.1.0 (2019-01-02)\n\n#### :rocket: Enhancement\n* [#282](https://github.com/RobbieTheWagner/ember-shepherd/pull/282) feat: Pass tourName option when initializing the Shepherd.Tour ([@scottkidder](https://github.com/scottkidder))\n\n#### Committers: 1\n- Scott Kidder ([@scottkidder](https://github.com/scottkidder))\n\n\n## v4.0.0-beta.14 (2018-11-09)\n\n#### :rocket: Enhancement\n* [#261](https://github.com/RobbieTheWagner/ember-shepherd/pull/261) Add method to hide current step ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n* [#239](https://github.com/RobbieTheWagner/ember-shepherd/pull/239) Document required elements order; add requiredElements tests ([@BrianSipple](https://github.com/BrianSipple))\n\n#### Committers: 3\n- Brian Sipple ([@BrianSipple](https://github.com/BrianSipple))\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n- Scott Kidder ([@scottkidder](https://github.com/scottkidder))\n\n\n## v4.0.0-beta.11 (2018-10-08)\n\n#### :boom: Breaking Change\n* [#248](https://github.com/RobbieTheWagner/ember-shepherd/pull/248) Implement SVG-based modal mode ([@BrianSipple](https://github.com/BrianSipple))\n\n#### :rocket: Enhancement\n* [#256](https://github.com/RobbieTheWagner/ember-shepherd/pull/256) Update project to use shepherd versions with Tippy ([@BrianSipple](https://github.com/BrianSipple))\n* [#253](https://github.com/RobbieTheWagner/ember-shepherd/pull/253) Fix css rules for pointer-events ([@BrianSipple](https://github.com/BrianSipple))\n* [#252](https://github.com/RobbieTheWagner/ember-shepherd/pull/252) Block clicks outside of visible modal opening. ([@BrianSipple](https://github.com/BrianSipple))\n* [#250](https://github.com/RobbieTheWagner/ember-shepherd/pull/250) Hide modal when hiding the current step ([@BrianSipple](https://github.com/BrianSipple))\n\n#### :bug: Bug Fix\n* [#251](https://github.com/RobbieTheWagner/ember-shepherd/pull/251) Use Ember.set to set `this.tourObject` ([@BrianSipple](https://github.com/BrianSipple))\n* [#247](https://github.com/RobbieTheWagner/ember-shepherd/pull/247) Remove cleanupShepherdElements ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 2\n- Brian Sipple ([@BrianSipple](https://github.com/BrianSipple))\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n\n## v4.0.0-beta.10 (2018-09-14)\n\n#### :boom: Breaking Change\n* [#241](https://github.com/RobbieTheWagner/ember-shepherd/pull/241) Change builtInButtons to buttons ([@chuckcarpenter](https://github.com/chuckcarpenter))\n\n#### Committers: 1\n- Chuck Carpenter ([@chuckcarpenter](https://github.com/chuckcarpenter))\n\n\n## v4.0.0-beta.9 (2018-09-13)\n\n#### :boom: Breaking Change\n* [#243](https://github.com/RobbieTheWagner/ember-shepherd/pull/243) Rename `defaults` to `defaultStepOptions`. ([@BrianSipple](https://github.com/BrianSipple))\n* [#245](https://github.com/RobbieTheWagner/ember-shepherd/pull/245) Stop disabling target element pointer events ([@BrianSipple](https://github.com/BrianSipple))\n\n#### Committers: 1\n- Brian Sipple ([@BrianSipple](https://github.com/BrianSipple))\n\n\n## v4.0.0-beta.8 (2018-09-07)\n\n#### :rocket: Enhancement\n* [#237](https://github.com/RobbieTheWagner/ember-shepherd/pull/237) remove required buttons options ([@chuckcarpenter](https://github.com/chuckcarpenter))\n\n#### Committers: 1\n- Chuck Carpenter ([@chuckcarpenter](https://github.com/chuckcarpenter))\n\n" }, { "path": "CONTRIBUTING.md", "content": "# How To Contribute\n\n## Installation\n\n- `git clone `\n- `cd ember-shepherd`\n- `pnpm install`\n\n## Linting\n\n- `pnpm lint`\n- `pnpm lint:fix`\n\n## Building the addon\n\n- `cd ember-shepherd`\n- `pnpm build`\n\n## Running tests\n\n- `cd test-app`\n- `pnpm test` – Runs the test suite on the current Ember version\n- `pnpm test:watch` – Runs the test suite in \"watch mode\"\n\n## Running the test application\n\n- `cd test-app`\n- `pnpm start`\n- Visit the test application at [http://localhost:4200](http://localhost:4200).\n\nFor more information on using ember-cli, visit [https://cli.emberjs.com/release/](https://cli.emberjs.com/release/).\n" }, { "path": "LICENSE.md", "content": "# Shepherd.js License\n\nShepherd.js is dual-licensed under **AGPL-3.0** (for open source and non-commercial use) and a **Commercial License** (for commercial use).\n\n---\n 🆓 Free Use - AGPL-3.0 License\nYou may use Shepherd.js **FREE OF CHARGE** under the AGPL-3.0 license if you are:\n ✅ Open Source Projects\n- Your project is open source and licensed under an AGPL-compatible license (GPL, AGPL, etc.)\n- Your complete source code is publicly available\n ✅ Personal & Non-Commercial Use\n- Personal projects, portfolios, and hobby websites\n- Educational purposes (students, teachers, coursework)\n- Academic research projects\n ✅ Evaluation & Testing\n- Evaluating Shepherd.js for up to 30 days\n- Development, testing, and staging environments during evaluation\n- Proof-of-concept and demo projects\n**Important:** If you use Shepherd.js under AGPL-3.0, you must:\n- Make your complete source code available if you distribute or provide your software over a network\n- License your code under AGPL-3.0 or a compatible license\n- Comply with all AGPL-3.0 terms (see full license text below)\n---\n 💳 Commercial License Required\nYou **must purchase a commercial license** at [shepherdjs.dev/pricing](https://shepherdjs.dev/pricing) if:\n ❌ Commercial Products & Services\n- You're building a commercial product, application, SaaS, or website that generates revenue\n- Your company generates revenue (even if the specific project using Shepherd.js does not)\n- You're using Shepherd.js in any customer-facing commercial application\n ❌ Closed-Source Use\n- You cannot or don't want to open-source your code under AGPL-3.0\n- You want to keep your source code proprietary\n- You want to avoid AGPL's source code disclosure requirements\n ❌ White-Label, Resale, or OEM Use\n- You're embedding Shepherd.js in a product you sell or distribute\n- You're offering Shepherd.js as part of a commercial service or hosting\n- You're using Shepherd.js in a product sold to other businesses\n ❌ Internal Business Tools\n- You're using Shepherd.js for internal tools, dashboards, or admin panels in a revenue-generating company\n- Even if the tool is not customer-facing, commercial licenses are required for for-profit companies\n**Why Commercial License?**\n- ✅ No AGPL obligations - keep your code proprietary\n- ✅ Legal protection and indemnification\n- ✅ Priority support and updates\n- ✅ Lifetime license with no recurring fees\n[**Purchase Commercial License →**](https://shepherdjs.dev/pricing)\n---\n ❓ Still Not Sure?\nIf you're unsure whether you need a commercial license:\n- **Contact us:** [ahoy@shipshape.io](mailto:ahoy@shipshape.io)\n- **View pricing:** [shepherdjs.dev/pricing](https://shepherdjs.dev/pricing)\n**When in doubt:** If your organization generates revenue, you likely need a commercial license.\n---\n\n### GNU AFFERO GENERAL PUBLIC LICENSE\n\nVersion 3, 19 November 2007\n\nCopyright (C) 2007 Free Software Foundation, Inc. \n\nEveryone is permitted to copy and distribute verbatim copies of this license\ndocument, but changing it is not allowed.\n\n### Preamble\n\nThe GNU Affero General Public License is a free, copyleft license for software\nand other kinds of works, specifically designed to ensure cooperation with the\ncommunity in the case of network server software.\n\nThe licenses for most software and other practical works are designed to take\naway your freedom to share and change the works. By contrast, our General Public\nLicenses are intended to guarantee your freedom to share and change all versions\nof a program--to make sure it remains free software for all its users.\n\nWhen we speak of free software, we are referring to freedom, not price. Our\nGeneral Public Licenses are designed to make sure that you have the freedom to\ndistribute copies of free software (and charge for them if you wish), that you\nreceive source code or can get it if you want it, that you can change the\nsoftware or use pieces of it in new free programs, and that you know you can do\nthese things.\n\nDevelopers that use our General Public Licenses protect your rights with two\nsteps: (1) assert copyright on the software, and (2) offer you this License\nwhich gives you legal permission to copy, distribute and/or modify the software.\n\nA secondary benefit of defending all users' freedom is that improvements made in\nalternate versions of the program, if they receive widespread use, become\navailable for other developers to incorporate. Many developers of free software\nare heartened and encouraged by the resulting cooperation. However, in the case\nof software used on network servers, this result may fail to come about. The GNU\nGeneral Public License permits making a modified version and letting the public\naccess it on a server without ever releasing its source code to the public.\n\nThe GNU Affero General Public License is designed specifically to ensure that,\nin such cases, the modified source code becomes available to the community. It\nrequires the operator of a network server to provide the source code of the\nmodified version running there to the users of that server. Therefore, public\nuse of a modified version, on a publicly accessible server, gives the public\naccess to the source code of the modified version.\n\nAn older license, called the Affero General Public License and published by\nAffero, was designed to accomplish similar goals. This is a different license,\nnot a version of the Affero GPL, but Affero has released a new version of the\nAffero GPL which permits relicensing under this license.\n\nThe precise terms and conditions for copying, distribution and modification\nfollow.\n\n### TERMS AND CONDITIONS\n\n#### 0. Definitions.\n\n\"This License\" refers to version 3 of the GNU Affero General Public License.\n\n\"Copyright\" also means copyright-like laws that apply to other kinds of works,\nsuch as semiconductor masks.\n\n\"The Program\" refers to any copyrightable work licensed under this License. Each\nlicensee is addressed as \"you\". \"Licensees\" and \"recipients\" may be individuals\nor organizations.\n\nTo \"modify\" a work means to copy from or adapt all or part of the work in a\nfashion requiring copyright permission, other than the making of an exact copy.\nThe resulting work is called a \"modified version\" of the earlier work or a work\n\"based on\" the earlier work.\n\nA \"covered work\" means either the unmodified Program or a work based on the\nProgram.\n\nTo \"propagate\" a work means to do anything with it that, without permission,\nwould make you directly or secondarily liable for infringement under applicable\ncopyright law, except executing it on a computer or modifying a private copy.\nPropagation includes copying, distribution (with or without modification),\nmaking available to the public, and in some countries other activities as well.\n\nTo \"convey\" a work means any kind of propagation that enables other parties to\nmake or receive copies. Mere interaction with a user through a computer network,\nwith no transfer of a copy, is not conveying.\n\nAn interactive user interface displays \"Appropriate Legal Notices\" to the extent\nthat it includes a convenient and prominently visible feature that (1) displays\nan appropriate copyright notice, and (2) tells the user that there is no\nwarranty for the work (except to the extent that warranties are provided), that\nlicensees may convey the work under this License, and how to view a copy of this\nLicense. If the interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n#### 1. Source Code.\n\nThe \"source code\" for a work means the preferred form of the work for making\nmodifications to it. \"Object code\" means any non-source form of a work.\n\nA \"Standard Interface\" means an interface that either is an official standard\ndefined by a recognized standards body, or, in the case of interfaces specified\nfor a particular programming language, one that is widely used among developers\nworking in that language.\n\nThe \"System Libraries\" of an executable work include anything, other than the\nwork as a whole, that (a) is included in the normal form of packaging a Major\nComponent, but which is not part of that Major Component, and (b) serves only to\nenable use of the work with that Major Component, or to implement a Standard\nInterface for which an implementation is available to the public in source code\nform. A \"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system (if any) on\nwhich the executable work runs, or a compiler used to produce the work, or an\nobject code interpreter used to run it.\n\nThe \"Corresponding Source\" for a work in object code form means all the source\ncode needed to generate, install, and (for an executable work) run the object\ncode and to modify the work, including scripts to control those activities.\nHowever, it does not include the work's System Libraries, or general-purpose\ntools or generally available free programs which are used unmodified in\nperforming those activities but which are not part of the work. For example,\nCorresponding Source includes interface definition files associated with source\nfiles for the work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require, such as by\nintimate data communication or control flow between those subprograms and other\nparts of the work.\n\nThe Corresponding Source need not include anything that users can regenerate\nautomatically from other parts of the Corresponding Source.\n\nThe Corresponding Source for a work in source code form is that same work.\n\n#### 2. Basic Permissions.\n\nAll rights granted under this License are granted for the term of copyright on\nthe Program, and are irrevocable provided the stated conditions are met. This\nLicense explicitly affirms your unlimited permission to run the unmodified\nProgram. The output from running a covered work is covered by this License only\nif the output, given its content, constitutes a covered work. This License\nacknowledges your rights of fair use or other equivalent, as provided by\ncopyright law.\n\nYou may make, run and propagate covered works that you do not convey, without\nconditions so long as your license otherwise remains in force. You may convey\ncovered works to others for the sole purpose of having them make modifications\nexclusively for you, or provide you with facilities for running those works,\nprovided that you comply with the terms of this License in conveying all\nmaterial for which you do not control copyright. Those thus making or running\nthe covered works for you must do so exclusively on your behalf, under your\ndirection and control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\nConveying under any other circumstances is permitted solely under the conditions\nstated below. Sublicensing is not allowed; section 10 makes it unnecessary.\n\n#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\nNo covered work shall be deemed part of an effective technological measure under\nany applicable law fulfilling obligations under article 11 of the WIPO copyright\ntreaty adopted on 20 December 1996, or similar laws prohibiting or restricting\ncircumvention of such measures.\n\nWhen you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention is\neffected by exercising rights under this License with respect to the covered\nwork, and you disclaim any intention to limit operation or modification of the\nwork as a means of enforcing, against the work's users, your or third parties'\nlegal rights to forbid circumvention of technological measures.\n\n#### 4. Conveying Verbatim Copies.\n\nYou may convey verbatim copies of the Program's source code as you receive it,\nin any medium, provided that you conspicuously and appropriately publish on each\ncopy an appropriate copyright notice; keep intact all notices stating that this\nLicense and any non-permissive terms added in accord with section 7 apply to the\ncode; keep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\nYou may charge any price or no price for each copy that you convey, and you may\noffer support or warranty protection for a fee.\n\n#### 5. Conveying Modified Source Versions.\n\nYou may convey a work based on the Program, or the modifications to produce it\nfrom the Program, in the form of source code under the terms of section 4,\nprovided that you also meet all of these conditions:\n\n- a) The work must carry prominent notices stating that you modified it, and\n giving a relevant date.\n- b) The work must carry prominent notices stating that it is released under\n this License and any conditions added under section 7. This requirement\n modifies the requirement in section 4 to \"keep intact all notices\".\n- c) You must license the entire work, as a whole, under this License to anyone\n who comes into possession of a copy. This License will therefore apply, along\n with any applicable section 7 additional terms, to the whole of the work, and\n all its parts, regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not invalidate\n such permission if you have separately received it.\n- d) If the work has interactive user interfaces, each must display Appropriate\n Legal Notices; however, if the Program has interactive interfaces that do not\n display Appropriate Legal Notices, your work need not make them do so.\n\nA compilation of a covered work with other separate and independent works, which\nare not by their nature extensions of the covered work, and which are not\ncombined with it such as to form a larger program, in or on a volume of a\nstorage or distribution medium, is called an \"aggregate\" if the compilation and\nits resulting copyright are not used to limit the access or legal rights of the\ncompilation's users beyond what the individual works permit. Inclusion of a\ncovered work in an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n#### 6. Conveying Non-Source Forms.\n\nYou may convey a covered work in object code form under the terms of sections 4\nand 5, provided that you also convey the machine-readable Corresponding Source\nunder the terms of this License, in one of these ways:\n\n- a) Convey the object code in, or embodied in, a physical product (including a\n physical distribution medium), accompanied by the Corresponding Source fixed\n on a durable physical medium customarily used for software interchange.\n- b) Convey the object code in, or embodied in, a physical product (including a\n physical distribution medium), accompanied by a written offer, valid for at\n least three years and valid for as long as you offer spare parts or customer\n support for that product model, to give anyone who possesses the object code\n either (1) a copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical medium\n customarily used for software interchange, for a price no more than your\n reasonable cost of physically performing this conveying of source, or (2)\n access to copy the Corresponding Source from a network server at no charge.\n- c) Convey individual copies of the object code with a copy of the written\n offer to provide the Corresponding Source. This alternative is allowed only\n occasionally and noncommercially, and only if you received the object code\n with such an offer, in accord with subsection 6b.\n- d) Convey the object code by offering access from a designated place (gratis\n or for a charge), and offer equivalent access to the Corresponding Source in\n the same way through the same place at no further charge. You need not require\n recipients to copy the Corresponding Source along with the object code. If the\n place to copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party) that supports\n equivalent copying facilities, provided you maintain clear directions next to\n the object code saying where to find the Corresponding Source. Regardless of\n what server hosts the Corresponding Source, you remain obligated to ensure\n that it is available for as long as needed to satisfy these requirements.\n- e) Convey the object code using peer-to-peer transmission, provided you inform\n other peers where the object code and Corresponding Source of the work are\n being offered to the general public at no charge under subsection 6d.\n\nA separable portion of the object code, whose source code is excluded from the\nCorresponding Source as a System Library, need not be included in conveying the\nobject code work.\n\nA \"User Product\" is either (1) a \"consumer product\", which means any tangible\npersonal property which is normally used for personal, family, or household\npurposes, or (2) anything designed or sold for incorporation into a dwelling. In\ndetermining whether a product is a consumer product, doubtful cases shall be\nresolved in favor of coverage. For a particular product received by a particular\nuser, \"normally used\" refers to a typical or common use of that class of\nproduct, regardless of the status of the particular user or of the way in which\nthe particular user actually uses, or expects or is expected to use, the\nproduct. A product is a consumer product regardless of whether the product has\nsubstantial commercial, industrial or non-consumer uses, unless such uses\nrepresent the only significant mode of use of the product.\n\n\"Installation Information\" for a User Product means any methods, procedures,\nauthorization keys, or other information required to install and execute\nmodified versions of a covered work in that User Product from a modified version\nof its Corresponding Source. The information must suffice to ensure that the\ncontinued functioning of the modified object code is in no case prevented or\ninterfered with solely because modification has been made.\n\nIf you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as part of a\ntransaction in which the right of possession and use of the User Product is\ntransferred to the recipient in perpetuity or for a fixed term (regardless of\nhow the transaction is characterized), the Corresponding Source conveyed under\nthis section must be accompanied by the Installation Information. But this\nrequirement does not apply if neither you nor any third party retains the\nability to install modified object code on the User Product (for example, the\nwork has been installed in ROM).\n\nThe requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates for a\nwork that has been modified or installed by the recipient, or for the User\nProduct in which it has been modified or installed. Access to a network may be\ndenied when the modification itself materially and adversely affects the\noperation of the network or violates the rules and protocols for communication\nacross the network.\n\nCorresponding Source conveyed, and Installation Information provided, in accord\nwith this section must be in a format that is publicly documented (and with an\nimplementation available to the public in source code form), and must require no\nspecial password or key for unpacking, reading or copying.\n\n#### 7. Additional Terms.\n\n\"Additional permissions\" are terms that supplement the terms of this License by\nmaking exceptions from one or more of its conditions. Additional permissions\nthat are applicable to the entire Program shall be treated as though they were\nincluded in this License, to the extent that they are valid under applicable\nlaw. If additional permissions apply only to part of the Program, that part may\nbe used separately under those permissions, but the entire Program remains\ngoverned by this License without regard to the additional permissions.\n\nWhen you convey a copy of a covered work, you may at your option remove any\nadditional permissions from that copy, or from any part of it. (Additional\npermissions may be written to require their own removal in certain cases when\nyou modify the work.) You may place additional permissions on material, added by\nyou to a covered work, for which you have or can give appropriate copyright\npermission.\n\nNotwithstanding any other provision of this License, for material you add to a\ncovered work, you may (if authorized by the copyright holders of that material)\nsupplement the terms of this License with terms:\n\n- a) Disclaiming warranty or limiting liability differently from the terms of\n sections 15 and 16 of this License; or\n- b) Requiring preservation of specified reasonable legal notices or author\n attributions in that material or in the Appropriate Legal Notices displayed by\n works containing it; or\n- c) Prohibiting misrepresentation of the origin of that material, or requiring\n that modified versions of such material be marked in reasonable ways as\n different from the original version; or\n- d) Limiting the use for publicity purposes of names of licensors or authors of\n the material; or\n- e) Declining to grant rights under trademark law for use of some trade names,\n trademarks, or service marks; or\n- f) Requiring indemnification of licensors and authors of that material by\n anyone who conveys the material (or modified versions of it) with contractual\n assumptions of liability to the recipient, for any liability that these\n contractual assumptions directly impose on those licensors and authors.\n\nAll other non-permissive additional terms are considered \"further restrictions\"\nwithin the meaning of section 10. If the Program as you received it, or any part\nof it, contains a notice stating that it is governed by this License along with\na term that is a further restriction, you may remove that term. If a license\ndocument contains a further restriction but permits relicensing or conveying\nunder this License, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does not survive\nsuch relicensing or conveying.\n\nIf you add terms to a covered work in accord with this section, you must place,\nin the relevant source files, a statement of the additional terms that apply to\nthose files, or a notice indicating where to find the applicable terms.\n\nAdditional terms, permissive or non-permissive, may be stated in the form of a\nseparately written license, or stated as exceptions; the above requirements\napply either way.\n\n#### 8. Termination.\n\nYou may not propagate or modify a covered work except as expressly provided\nunder this License. Any attempt otherwise to propagate or modify it is void, and\nwill automatically terminate your rights under this License (including any\npatent licenses granted under the third paragraph of section 11).\n\nHowever, if you cease all violation of this License, then your license from a\nparticular copyright holder is reinstated (a) provisionally, unless and until\nthe copyright holder explicitly and finally terminates your license, and (b)\npermanently, if the copyright holder fails to notify you of the violation by\nsome reasonable means prior to 60 days after the cessation.\n\nMoreover, your license from a particular copyright holder is reinstated\npermanently if the copyright holder notifies you of the violation by some\nreasonable means, this is the first time you have received notice of violation\nof this License (for any work) from that copyright holder, and you cure the\nviolation prior to 30 days after your receipt of the notice.\n\nTermination of your rights under this section does not terminate the licenses of\nparties who have received copies or rights from you under this License. If your\nrights have been terminated and not permanently reinstated, you do not qualify\nto receive new licenses for the same material under section 10.\n\n#### 9. Acceptance Not Required for Having Copies.\n\nYou are not required to accept this License in order to receive or run a copy of\nthe Program. Ancillary propagation of a covered work occurring solely as a\nconsequence of using peer-to-peer transmission to receive a copy likewise does\nnot require acceptance. However, nothing other than this License grants you\npermission to propagate or modify any covered work. These actions infringe\ncopyright if you do not accept this License. Therefore, by modifying or\npropagating a covered work, you indicate your acceptance of this License to do\nso.\n\n#### 10. Automatic Licensing of Downstream Recipients.\n\nEach time you convey a covered work, the recipient automatically receives a\nlicense from the original licensors, to run, modify and propagate that work,\nsubject to this License. You are not responsible for enforcing compliance by\nthird parties with this License.\n\nAn \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered work results\nfrom an entity transaction, each party to that transaction who receives a copy\nof the work also receives whatever licenses to the work the party's predecessor\nin interest had or could give under the previous paragraph, plus a right to\npossession of the Corresponding Source of the work from the predecessor in\ninterest, if the predecessor has it or can get it with reasonable efforts.\n\nYou may not impose any further restrictions on the exercise of the rights\ngranted or affirmed under this License. For example, you may not impose a\nlicense fee, royalty, or other charge for exercise of rights granted under this\nLicense, and you may not initiate litigation (including a cross-claim or\ncounterclaim in a lawsuit) alleging that any patent claim is infringed by\nmaking, using, selling, offering for sale, or importing the Program or any\nportion of it.\n\n#### 11. Patents.\n\nA \"contributor\" is a copyright holder who authorizes use under this License of\nthe Program or a work on which the Program is based. The work thus licensed is\ncalled the contributor's \"contributor version\".\n\nA contributor's \"essential patent claims\" are all patent claims owned or\ncontrolled by the contributor, whether already acquired or hereafter acquired,\nthat would be infringed by some manner, permitted by this License, of making,\nusing, or selling its contributor version, but do not include claims that would\nbe infringed only as a consequence of further modification of the contributor\nversion. For purposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of this License.\n\nEach contributor grants you a non-exclusive, worldwide, royalty-free patent\nlicense under the contributor's essential patent claims, to make, use, sell,\noffer for sale, import and otherwise run, modify and propagate the contents of\nits contributor version.\n\nIn the following three paragraphs, a \"patent license\" is any express agreement\nor commitment, however denominated, not to enforce a patent (such as an express\npermission to practice a patent or covenant not to sue for patent infringement).\nTo \"grant\" such a patent license to a party means to make such an agreement or\ncommitment not to enforce a patent against the party.\n\nIf you convey a covered work, knowingly relying on a patent license, and the\nCorresponding Source of the work is not available for anyone to copy, free of\ncharge and under the terms of this License, through a publicly available network\nserver or other readily accessible means, then you must either (1) cause the\nCorresponding Source to be so available, or (2) arrange to deprive yourself of\nthe benefit of the patent license for this particular work, or (3) arrange, in a\nmanner consistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have actual\nknowledge that, but for the patent license, your conveying the covered work in a\ncountry, or your recipient's use of the covered work in a country, would\ninfringe one or more identifiable patents in that country that you have reason\nto believe are valid.\n\nIf, pursuant to or in connection with a single transaction or arrangement, you\nconvey, or propagate by procuring conveyance of, a covered work, and grant a\npatent license to some of the parties receiving the covered work authorizing\nthem to use, propagate, modify or convey a specific copy of the covered work,\nthen the patent license you grant is automatically extended to all recipients of\nthe covered work and works based on it.\n\nA patent license is \"discriminatory\" if it does not include within the scope of\nits coverage, prohibits the exercise of, or is conditioned on the non-exercise\nof one or more of the rights that are specifically granted under this License.\nYou may not convey a covered work if you are a party to an arrangement with a\nthird party that is in the business of distributing software, under which you\nmake payment to the third party based on the extent of your activity of\nconveying the work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory patent\nlicense (a) in connection with copies of the covered work conveyed by you (or\ncopies made from those copies), or (b) primarily for and in connection with\nspecific products or compilations that contain the covered work, unless you\nentered into that arrangement, or that patent license was granted, prior to 28\nMarch 2007.\n\nNothing in this License shall be construed as excluding or limiting any implied\nlicense or other defenses to infringement that may otherwise be available to you\nunder applicable patent law.\n\n#### 12. No Surrender of Others' Freedom.\n\nIf conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not excuse\nyou from the conditions of this License. If you cannot convey a covered work so\nas to satisfy simultaneously your obligations under this License and any other\npertinent obligations, then as a consequence you may not convey it at all. For\nexample, if you agree to terms that obligate you to collect a royalty for\nfurther conveying from those to whom you convey the Program, the only way you\ncould satisfy both those terms and this License would be to refrain entirely\nfrom conveying the Program.\n\n#### 13. Remote Network Interaction; Use with the GNU General Public License.\n\nNotwithstanding any other provision of this License, if you modify the Program,\nyour modified version must prominently offer all users interacting with it\nremotely through a computer network (if your version supports such interaction)\nan opportunity to receive the Corresponding Source of your version by providing\naccess to the Corresponding Source from a network server at no charge, through\nsome standard or customary means of facilitating copying of software. This\nCorresponding Source shall include the Corresponding Source for any work covered\nby version 3 of the GNU General Public License that is incorporated pursuant to\nthe following paragraph.\n\nNotwithstanding any other provision of this License, you have permission to link\nor combine any covered work with a work licensed under version 3 of the GNU\nGeneral Public License into a single combined work, and to convey the resulting\nwork. The terms of this License will continue to apply to the part which is the\ncovered work, but the work with which it is combined will remain governed by\nversion 3 of the GNU General Public License.\n\n#### 14. Revised Versions of this License.\n\nThe Free Software Foundation may publish revised and/or new versions of the GNU\nAffero General Public License from time to time. Such new versions will be\nsimilar in spirit to the present version, but may differ in detail to address\nnew problems or concerns.\n\nEach version is given a distinguishing version number. If the Program specifies\nthat a certain numbered version of the GNU Affero General Public License \"or any\nlater version\" applies to it, you have the option of following the terms and\nconditions either of that numbered version or of any later version published by\nthe Free Software Foundation. If the Program does not specify a version number\nof the GNU Affero General Public License, you may choose any version ever\npublished by the Free Software Foundation.\n\nIf the Program specifies that a proxy can decide which future versions of the\nGNU Affero General Public License can be used, that proxy's public statement of\nacceptance of a version permanently authorizes you to choose that version for\nthe Program.\n\nLater license versions may give you additional or different permissions.\nHowever, no additional obligations are imposed on any author or copyright holder\nas a result of your choosing to follow a later version.\n\n#### 15. Disclaimer of Warranty.\n\nTHERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.\nEXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER\nPARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER\nEXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\nMERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE\nQUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE\nDEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n#### 16. Limitation of Liability.\n\nIN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY\nCOPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS\nPERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,\nINCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE\nTHE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED\nINACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE\nPROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY\nHAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.\n\n#### 17. Interpretation of Sections 15 and 16.\n\nIf the disclaimer of warranty and limitation of liability provided above cannot\nbe given local legal effect according to their terms, reviewing courts shall\napply local law that most closely approximates an absolute waiver of all civil\nliability in connection with the Program, unless a warranty or assumption of\nliability accompanies a copy of the Program in return for a fee.\n\nEND OF TERMS AND CONDITIONS\n\n### How to Apply These Terms to Your New Programs\n\nIf you develop a new program, and you want it to be of the greatest possible use\nto the public, the best way to achieve this is to make it free software which\neveryone can redistribute and change under these terms.\n\nTo do so, attach the following notices to the program. It is safest to attach\nthem to the start of each source file to most effectively state the exclusion of\nwarranty; and each file should have at least the \"copyright\" line and a pointer\nto where the full notice is found.\n\n Better introductions for websites and features with a step-by-step guide for your projects.\n Copyright (C) 2012-2021 Afshin Mehrabani\n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as\n published by the Free Software Foundation, either version 3 of the\n License, or (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\nIf your software can interact with users remotely through a computer network,\nyou should also make sure that it provides a way for users to get its source.\nFor example, if your program is a web application, its interface could display a\n\"Source\" link that leads users to an archive of the code. There are many ways\nyou could offer source, and different solutions will be better for different\nprograms; see section 13 for the specific requirements.\n\nYou should also get your employer (if you work as a programmer) or school, if\nany, to sign a \"copyright disclaimer\" for the program, if necessary. For more\ninformation on this, and how to apply and follow the GNU AGPL, see\n.\n" }, { "path": "README.md", "content": "# ember-shepherd\n\n\"Ship\n\n**[ember-shepherd is built and maintained by Ship Shape. Contact us for Ember.js consulting, development, and training for your project](https://shipshape.io/ember-consulting/)**.\n\n[![npm version](https://badge.fury.io/js/ember-shepherd.svg)](http://badge.fury.io/js/ember-shepherd)\n![Download count all time](https://img.shields.io/npm/dt/ember-shepherd.svg)\n[![npm](https://img.shields.io/npm/dm/ember-shepherd.svg)]()\n[![Ember Observer Score](http://emberobserver.com/badges/ember-shepherd.svg)](http://emberobserver.com/addons/ember-shepherd)\n[![CI](https://github.com/RobbieTheWagner/ember-shepherd/actions/workflows/ci.yml/badge.svg)](https://github.com/RobbieTheWagner/ember-shepherd/actions/workflows/ci.yml)\n\nThis is an Ember wrapper for the [Shepherd](https://github.com/shipshapecode/shepherd), site tour, library. It provides additional functionality, on top of Shepherd, as well.\n\n## Compatibility\n\n- Ember.js v4.8 or above\n- Ember CLI v4.8 or above\n\n## Installation\n\n```\nember install ember-shepherd\n```\n\n## Documentation\n\n[View Docs](https://RobbieTheWagner.github.io/ember-shepherd/)\n\n## Contributing\n\nSee the [Contributing](CONTRIBUTING.md) guide for details.\n\n## License\n\n`ember-shepherd` is licensed under **AGPL-3.0** (for open source and non-commercial use) with a **Commercial License** available for commercial use.\n\n- **Free** for open source and non-commercial projects under AGPL-3.0\n- **Commercial license required** for commercial products and revenue-generating companies\n\n📄 [Read License Details](LICENSE.md) \n💳 [Purchase Commercial License](https://shepherdjs.dev/pricing)\n" }, { "path": "RELEASE.md", "content": "# Release Process\n\nReleases in this repo are mostly automated using [release-plan](https://github.com/embroider-build/release-plan/). Once you label all your PRs correctly (see below) you will have an automatically generated PR that updates your CHANGELOG.md file and a `.release-plan.json` that is used to prepare the release once the PR is merged.\n\n## Preparation\n\nSince the majority of the actual release process is automated, the remaining tasks before releasing are:\n\n- correctly labeling **all** pull requests that have been merged since the last release\n- updating pull request titles so they make sense to our users\n\nSome great information on why this is important can be found at [keepachangelog.com](https://keepachangelog.com/en/1.1.0/), but the overall\nguiding principle here is that changelogs are for humans, not machines.\n\nWhen reviewing merged PR's the labels to be used are:\n\n- breaking - Used when the PR is considered a breaking change.\n- enhancement - Used when the PR adds a new feature or enhancement.\n- bug - Used when the PR fixes a bug included in a previous release.\n- documentation - Used when the PR adds or updates documentation.\n- internal - Internal changes or things that don't fit in any other category.\n\n**Note:** `release-plan` requires that **all** PRs are labeled. If a PR doesn't fit in a category it's fine to label it as `internal`\n\n## Release\n\nOnce the prep work is completed, the actual release is straight forward: you just need to merge the open [Plan Release](https://github.com/RobbieTheWagner/ember-shepherd/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR\n" }, { "path": "config/ember-cli-update.json", "content": "{\n \"schemaVersion\": \"1.0.0\",\n \"projectName\": \"ember-shepherd\",\n \"packages\": [\n {\n \"name\": \"@embroider/addon-blueprint\",\n \"version\": \"4.1.2\",\n \"blueprints\": [\n {\n \"name\": \"@embroider/addon-blueprint\",\n \"isBaseBlueprint\": true,\n \"options\": [\n \"--ci-provider=github\",\n \"--pnpm\",\n \"--typescript\"\n ]\n }\n ]\n }\n ]\n}\n" }, { "path": "ember-shepherd/.gitignore", "content": "# The authoritative copies of these live in the monorepo root (because they're\n# more useful on github that way), but the build copies them into here so they\n# will also appear in published NPM packages.\n/README.md\n/LICENSE.md\n\n# compiled output\ndist/\ndeclarations/\n\n# npm/pnpm/yarn pack output\n*.tgz\n\n# deps & caches\nnode_modules/\n.eslintcache\n.prettiercache\n" }, { "path": "ember-shepherd/.prettierignore", "content": "# unconventional js\n/blueprints/*/files/\n\n# compiled output\n/dist/\n/declarations/\n\n# misc\n/coverage/\n" }, { "path": "ember-shepherd/.prettierrc.cjs", "content": "'use strict';\n\nmodule.exports = {\n plugins: ['prettier-plugin-ember-template-tag'],\n overrides: [\n {\n files: '*.{js,gjs,ts,gts,mjs,mts,cjs,cts}',\n options: {\n singleQuote: true,\n templateSingleQuote: false,\n },\n },\n ],\n};\n" }, { "path": "ember-shepherd/.template-lintrc.cjs", "content": "'use strict';\n\nmodule.exports = {\n extends: 'recommended',\n};\n" }, { "path": "ember-shepherd/addon-main.cjs", "content": "'use strict';\n\nconst { addonV1Shim } = require('@embroider/addon-shim');\nmodule.exports = addonV1Shim(__dirname);\n" }, { "path": "ember-shepherd/babel.config.json", "content": "{\n \"plugins\": [\n [\n \"@babel/plugin-transform-typescript\",\n {\n \"allExtensions\": true,\n \"onlyRemoveTypeImports\": true,\n \"allowDeclareFields\": true\n }\n ],\n \"@embroider/addon-dev/template-colocation-plugin\",\n [\n \"babel-plugin-ember-template-compilation\",\n {\n \"targetFormat\": \"hbs\",\n \"transforms\": []\n }\n ],\n [\n \"module:decorator-transforms\",\n { \"runtime\": { \"import\": \"decorator-transforms/runtime\" } }\n ]\n ]\n}\n" }, { "path": "ember-shepherd/eslint.config.mjs", "content": "/**\n * Debugging:\n * https://eslint.org/docs/latest/use/configure/debug\n * ----------------------------------------------------\n *\n * Print a file's calculated configuration\n *\n * npx eslint --print-config path/to/file.js\n *\n * Inspecting the config\n *\n * npx eslint --inspect-config\n *\n */\nimport babelParser from '@babel/eslint-parser';\nimport js from '@eslint/js';\nimport prettier from 'eslint-config-prettier';\nimport ember from 'eslint-plugin-ember/recommended';\nimport importPlugin from 'eslint-plugin-import';\nimport n from 'eslint-plugin-n';\nimport globals from 'globals';\nimport ts from 'typescript-eslint';\n\nconst parserOptions = {\n esm: {\n js: {\n ecmaFeatures: { modules: true },\n ecmaVersion: 'latest',\n },\n ts: {\n projectService: true,\n tsconfigRootDir: import.meta.dirname,\n },\n },\n};\n\nexport default ts.config(\n js.configs.recommended,\n ember.configs.base,\n ember.configs.gjs,\n ember.configs.gts,\n prettier,\n /**\n * Ignores must be in their own object\n * https://eslint.org/docs/latest/use/configure/ignore\n */\n {\n ignores: ['dist/', 'declarations/', 'node_modules/', 'coverage/', '!**/.*'],\n },\n /**\n * https://eslint.org/docs/latest/use/configure/configuration-files#configuring-linter-options\n */\n {\n linterOptions: {\n reportUnusedDisableDirectives: 'error',\n },\n },\n {\n files: ['**/*.js'],\n languageOptions: {\n parser: babelParser,\n },\n },\n {\n files: ['**/*.{js,gjs}'],\n languageOptions: {\n parserOptions: parserOptions.esm.js,\n globals: {\n ...globals.browser,\n },\n },\n },\n {\n files: ['**/*.{ts,gts}'],\n languageOptions: {\n parser: ember.parser,\n parserOptions: parserOptions.esm.ts,\n },\n extends: [...ts.configs.recommendedTypeChecked, ember.configs.gts],\n },\n {\n files: ['src/**/*'],\n plugins: {\n import: importPlugin,\n },\n rules: {\n // require relative imports use full extensions\n 'import/extensions': ['error', 'always', { ignorePackages: true }],\n },\n },\n /**\n * CJS node files\n */\n {\n files: [\n '**/*.cjs',\n '.prettierrc.js',\n '.stylelintrc.js',\n '.template-lintrc.js',\n 'addon-main.cjs',\n ],\n plugins: {\n n,\n },\n\n languageOptions: {\n sourceType: 'script',\n ecmaVersion: 'latest',\n globals: {\n ...globals.node,\n },\n },\n },\n /**\n * ESM node files\n */\n {\n files: ['**/*.mjs'],\n plugins: {\n n,\n },\n\n languageOptions: {\n sourceType: 'module',\n ecmaVersion: 'latest',\n parserOptions: parserOptions.esm.js,\n globals: {\n ...globals.node,\n },\n },\n },\n);\n" }, { "path": "ember-shepherd/package.json", "content": "{\n \"name\": \"ember-shepherd\",\n \"version\": \"18.0.0\",\n \"description\": \"An Ember wrapper for the site tour library Shepherd.\",\n \"keywords\": [\n \"ember-addon\",\n \"tour\",\n \"shepherd\",\n \"user journey\",\n \"site tour\"\n ],\n \"repository\": \"https://github.com/RobbieTheWagner/ember-shepherd\",\n \"license\": \"AGPL-3.0\",\n \"author\": {\n \"name\": \"Robert Wagner\",\n \"email\": \"rwwagner90@gmail.com\",\n \"url\": \"https://github.com/RobbieTheWagner\"\n },\n \"exports\": {\n \".\": {\n \"types\": \"./declarations/index.d.ts\",\n \"default\": \"./dist/index.js\"\n },\n \"./*\": {\n \"types\": \"./declarations/*.d.ts\",\n \"default\": \"./dist/*.js\"\n },\n \"./addon-main.js\": \"./addon-main.cjs\"\n },\n \"typesVersions\": {\n \"*\": {\n \"*\": [\n \"declarations/*\"\n ]\n }\n },\n \"files\": [\n \"addon-main.cjs\",\n \"declarations\",\n \"dist\",\n \"LICENSE.md\"\n ],\n \"scripts\": {\n \"build\": \"rollup --config\",\n \"format\": \"prettier . --cache --write\",\n \"lint\": \"concurrently \\\"pnpm:lint:*(!fix)\\\" --names \\\"lint:\\\" --prefixColors auto\",\n \"lint:fix\": \"concurrently \\\"pnpm:lint:*:fix\\\" --names \\\"fix:\\\" --prefixColors auto && pnpm run format\",\n \"lint:format\": \"prettier . --cache --check\",\n \"lint:hbs\": \"ember-template-lint . --no-error-on-unmatched-pattern\",\n \"lint:hbs:fix\": \"ember-template-lint . --fix --no-error-on-unmatched-pattern\",\n \"lint:js\": \"eslint . --cache\",\n \"lint:js:fix\": \"eslint . --fix\",\n \"lint:types\": \"glint\",\n \"prepack\": \"rollup --config\",\n \"start\": \"rollup --config --watch\",\n \"test\": \"echo 'A v2 addon does not have tests, run tests in test-app'\"\n },\n \"dependencies\": {\n \"@embroider/addon-shim\": \"^1.10.2\",\n \"@embroider/macros\": \"^1.19.6\",\n \"decorator-transforms\": \"^2.3.1\",\n \"shepherd.js\": \"^15.0.0\"\n },\n \"devDependencies\": {\n \"@babel/core\": \"^7.29.0\",\n \"@babel/eslint-parser\": \"^7.28.6\",\n \"@babel/plugin-transform-typescript\": \"^7.28.6\",\n \"@babel/runtime\": \"^7.28.6\",\n \"@ember/library-tsconfig\": \"^1.1.3\",\n \"@embroider/addon-dev\": \"^7.1.6\",\n \"@eslint/js\": \"^9.39.2\",\n \"@glint/core\": \"^1.5.2\",\n \"@glint/environment-ember-loose\": \"^1.5.2\",\n \"@glint/environment-ember-template-imports\": \"^1.5.2\",\n \"@glint/template\": \"^1.7.4\",\n \"@rollup/plugin-babel\": \"^6.1.0\",\n \"@tsconfig/ember\": \"^3.0.12\",\n \"@typescript-eslint/eslint-plugin\": \"^8.57.0\",\n \"@typescript-eslint/parser\": \"^8.54.0\",\n \"babel-plugin-ember-template-compilation\": \"^2.4.1\",\n \"concurrently\": \"^9.2.1\",\n \"ember-source\": \"~5.12.0\",\n \"ember-template-lint\": \"^6.1.0\",\n \"eslint\": \"^9.39.2\",\n \"eslint-config-prettier\": \"^9.1.2\",\n \"eslint-plugin-ember\": \"^12.7.5\",\n \"eslint-plugin-import\": \"^2.32.0\",\n \"eslint-plugin-n\": \"^17.23.2\",\n \"globals\": \"^15.15.0\",\n \"prettier\": \"^3.8.1\",\n \"prettier-plugin-ember-template-tag\": \"^2.1.3\",\n \"rollup\": \"^4.57.1\",\n \"rollup-plugin-copy\": \"^3.5.0\",\n \"typescript\": \"^5.9.3\",\n \"typescript-eslint\": \"^8.54.0\",\n \"webpack\": \"^5.105.0\"\n },\n \"ember\": {\n \"edition\": \"octane\"\n },\n \"ember-addon\": {\n \"version\": 2,\n \"type\": \"addon\",\n \"main\": \"addon-main.cjs\",\n \"app-js\": {\n \"./services/tour.js\": \"./dist/_app_/services/tour.js\"\n }\n }\n}\n" }, { "path": "ember-shepherd/rollup.config.mjs", "content": "import { babel } from '@rollup/plugin-babel';\nimport copy from 'rollup-plugin-copy';\nimport { Addon } from '@embroider/addon-dev/rollup';\n\nconst addon = new Addon({\n srcDir: 'src',\n destDir: 'dist',\n});\n\nexport default {\n // This provides defaults that work well alongside `publicEntrypoints` below.\n // You can augment this if you need to.\n output: addon.output(),\n\n plugins: [\n // These are the modules that users should be able to import from your\n // addon. Anything not listed here may get optimized away.\n // By default all your JavaScript modules (**/*.js) will be importable.\n // But you are encouraged to tweak this to only cover the modules that make\n // up your addon's public API. Also make sure your package.json#exports\n // is aligned to the config here.\n // See https://github.com/embroider-build/embroider/blob/main/docs/v2-faq.md#how-can-i-define-the-public-exports-of-my-addon\n addon.publicEntrypoints(['index.js', '**/*.js']),\n\n // These are the modules that should get reexported into the traditional\n // \"app\" tree. Things in here should also be in publicEntrypoints above, but\n // not everything in publicEntrypoints necessarily needs to go here.\n addon.appReexports([\n 'components/**/*.js',\n 'helpers/**/*.js',\n 'modifiers/**/*.js',\n 'services/**/*.js',\n ]),\n\n // Follow the V2 Addon rules about dependencies. Your code can import from\n // `dependencies` and `peerDependencies` as well as standard Ember-provided\n // package names.\n addon.dependencies(),\n\n // This babel config should *not* apply presets or compile away ES modules.\n // It exists only to provide development niceties for you, like automatic\n // template colocation.\n //\n // By default, this will load the actual babel config from the file\n // babel.config.json.\n babel({\n extensions: ['.js', '.gjs', '.ts', '.gts'],\n babelHelpers: 'bundled',\n }),\n\n // Ensure that standalone .hbs files are properly integrated as Javascript.\n addon.hbs(),\n\n // Ensure that .gjs files are properly integrated as Javascript\n addon.gjs(),\n\n // Emit .d.ts declaration files\n addon.declarations('declarations'),\n\n // addons are allowed to contain imports of .css files, which we want rollup\n // to leave alone and keep in the published output.\n addon.keepAssets(['**/*.css']),\n\n // Remove leftover build artifacts when starting a new build.\n addon.clean(),\n\n // Copy Readme and License into published package\n copy({\n targets: [\n { src: '../README.md', dest: '.' },\n { src: '../LICENSE.md', dest: '.' },\n ],\n }),\n ],\n};\n" }, { "path": "ember-shepherd/src/.gitkeep", "content": "" }, { "path": "ember-shepherd/src/index.ts", "content": "" }, { "path": "ember-shepherd/src/services/tour.ts", "content": "/* eslint-disable ember/no-runloop */\nimport { isEmpty, isPresent } from '@ember/utils';\nimport Service from '@ember/service';\nimport Evented from '@ember/object/evented';\nimport { registerDestructor } from '@ember/destroyable';\nimport type Owner from '@ember/owner';\nimport { bind } from '@ember/runloop';\nimport { isTesting } from '@embroider/macros';\nimport { tracked } from '@glimmer/tracking';\n\nimport { type StepOptions, type Tour } from 'shepherd.js';\n\nimport { type EmberShepherdButton, makeButton } from '../utils/buttons.ts';\nimport { elementIsHidden } from '../utils/dom.ts';\n\ninterface EmberShepherdStepOptions extends Omit {\n buttons?: Array;\n}\n\n/**\n * Interaction with `ember-shepherd` is done entirely through the Tour service, which you can access from any object using the `service` syntax:\n *\n * ```js\n * import Component from '@glimmer/component';\n * import { service } from '@ember/service';\n *\n * export default class MyCoolComponent extends Component {\n *\n * @service tour;\n *\n * // OR\n *\n * @service('tour') tourService;\n * };\n * ```\n *\n * The following configuration options can be `set` on the Tour service to control the way that Shepherd is used. **The only required option is `steps`, which is set via `addSteps`.**\n *\n * @class Tour\n */\nexport default class TourService extends Service.extend(Evented) {\n declare tourName?: string;\n\n // Configuration Options\n\n /**\n * The prefix to add to all the `shepherd-*` class names.\n *\n * @default undefined\n * @property classPrefix\n * @type String\n */\n @tracked classPrefix?: string;\n\n /**\n * `confirmCancel` is a boolean flag, when set to `true` it will pop up a native browser\n * confirm window on cancel, to ensure you want to cancel.\n *\n * @default false\n * @property confirmCancel\n * @type Boolean\n */\n @tracked confirmCancel = false;\n\n /**\n * `confirmCancelMessage` is a string to display in the confirm dialog when `confirmCancel`\n * is set to true.\n *\n * @default undefined\n * @property confirmCancelMessage\n * @type String\n */\n @tracked confirmCancelMessage?: string;\n\n /**\n * `defaultStepOptions` is used to set the options that will be applied to each step by default.\n * You can pass in any of the options that you can with Shepherd.\n *\n * **⚠️ You must set `defaultStepOptions` *BEFORE* calling `addSteps` to set the steps.**\n *\n * It will be an object of a form something like:\n *\n * ```js\n * this.tour.set('defaultStepOptions', {\n * classes: 'custom-class-name-1 custom-class-name-2',\n * scrollTo: true,\n * cancelIcon: {\n * enabled: true\n * },\n * });\n * ```\n *\n * > **default value:** `{}`\n *\n * @default {}\n * @property defaultStepOptions\n * @type StepOptions\n */\n @tracked defaultStepOptions: StepOptions = {};\n\n /**\n * @default undefined\n * @property errorTitle\n * @type String\n */\n @tracked errorTitle?: string;\n\n /**\n * Exiting the tour with the escape key will be enabled unless this is explicitly set to false.\n *\n * @default undefined\n * @property exitOnEsc\n * @type Boolean\n */\n @tracked exitOnEsc?: boolean;\n\n /**\n * @default false\n * @property isActive\n * @type Boolean\n */\n @tracked isActive = false;\n\n /**\n * Navigating the tour via left and right arrow keys will be enabled unless this is explicitly set to false.\n *\n * @default undefined\n * @property keyboardNavigation\n * @type Boolean\n */\n @tracked keyboardNavigation?: boolean;\n\n /**\n * @default undefined\n * @property messageForUser\n * @type String\n */\n @tracked messageForUser?: string;\n\n /**\n * `modal` is a boolean, that should be set to true, if you would like the rest of the screen, other than the current element, greyed out, and the current element highlighted. If you do not need modal functionality, you can remove this option or set it to false.\n *\n * > **default value:** `false`\n *\n * @default false\n * @property modal\n * @type Boolean\n */\n @tracked modal = false;\n\n /**\n * An optional container element for the modal. If not set, the modal will be appended to `document.body`.\n * @default undefined\n * @property modalContainer\n * @type HTMLElement\n */\n @tracked modalContainer?: HTMLElement;\n\n /**\n * `requiredElements` is an array of objects that indicate DOM elements that are **REQUIRED** by your tour and must\n * exist and be visible for the tour to start. If any elements are not present, it will keep the tour from starting.\n *\n * You can also specify a message, which will tell the user what they need to do to make the tour work.\n *\n * **⚠️ You must set `requiredElements` *BEFORE* calling `addSteps` to set the steps.**\n *\n * _Example_\n * ```js\n * this.tour.requiredElements = [\n * {\n * selector: '.search-result-element',\n * message: 'No search results found. Please execute another search, and try to start the tour again.',\n * title: 'No results'\n * },\n * {\n * selector: '.username-element',\n * message: 'User not logged in, please log in to start this tour.',\n * title: 'Please login'\n * },\n * ];\n * ```\n\n * > **default value:** `[]`\n *\n * @default []\n * @property requiredElements\n * @type Array\n */\n @tracked requiredElements = [];\n\n /**\n * An optional container element for the steps. If not set, the steps will be appended to `document.body`.\n * @default undefined\n * @property stepsContainer\n * @type HTMLElement\n */\n @tracked stepsContainer?: HTMLElement;\n\n /**\n * A reference to the Shepherd Tour instance.\n *\n * @property tourObject\n * @type Tour\n */\n @tracked declare tourObject?: Tour;\n\n constructor(owner: Owner) {\n super(owner);\n\n // eslint-disable-next-line @typescript-eslint/no-misused-promises\n registerDestructor(this, () => this.tourObject?.cancel());\n }\n\n /**\n * Take a set of steps, create a tour object based on the current configuration and load the shepherd.js dependency.\n * This method returns a promise which resolves when the shepherd.js dependency has been loaded and shepherd is ready to use.\n *\n * You must pass an array of steps to `addSteps`, something like this:\n *\n * ```js\n * this.tour.addSteps([\n * {\n * attachTo: {\n * element:'.first-element',\n * on: 'bottom'\n * },\n * beforeShowPromise: function() {\n * return new Promise(function(resolve) {\n * Ember.run.scheduleOnce('afterRender', this, function() {\n * window.scrollTo(0, 0);\n * this.get('documents.firstObject').set('isSelected', true);\n * resolve();\n * });\n * });\n * },\n * buttons: [\n * {\n * classes: 'shepherd-button-secondary',\n * text: 'Exit',\n * type: 'cancel'\n * },\n * {\n * classes: 'shepherd-button-primary',\n * text: 'Back',\n * type: 'back'\n * },\n * {\n * classes: 'shepherd-button-primary',\n * text: 'Next',\n * type: 'next'\n * }\n * ],\n * cancelIcon: {\n * enabled: true\n * },\n * classes: 'custom-class-name-1 custom-class-name-2',\n * highlightClass: 'highlight',\n * id: 'intro',\n * scrollTo: false,\n * title: 'Welcome to Ember-Shepherd!',\n * text: 'Ember-Shepherd is a JavaScript library for guiding users through your Ember app.',\n * when: {\n * show: () => {\n * console.log('show step');\n * },\n * hide: () => {\n * console.log('hide step');\n * }\n * }\n * },\n * ...\n * ]);\n * ```\n *\n * @method addSteps\n * @param {array} steps An array of steps\n * @returns {Promise} Promise that resolves when everything has been set up and shepherd is ready to use\n * @public\n */\n addSteps(steps: Array) {\n return this._initialize().then(() => {\n const tour = this.tourObject as Tour;\n\n // Return nothing if there are no steps\n if (isEmpty(steps)) {\n return;\n }\n /* istanbul ignore next: also can't test this due to things attached to root blowing up tests */\n if (!this._requiredElementsPresent()) {\n tour.addStep({\n buttons: [\n {\n text: 'Exit',\n // eslint-disable-next-line @typescript-eslint/no-misused-promises, @typescript-eslint/unbound-method\n action: tour.cancel,\n },\n ],\n id: 'error',\n title: this.errorTitle,\n text: this.messageForUser,\n });\n return;\n }\n\n steps.forEach((step) => {\n if (step.buttons) {\n step.buttons = step.buttons.map(makeButton.bind(this), this);\n }\n\n tour.addStep(step);\n });\n });\n }\n\n /**\n * Get the tour object and call back\n *\n * @method back\n * @public\n */\n back() {\n this.tourObject?.back();\n // @ts-expect-error TODO: refactor away from Evented mixin\n // eslint-disable-next-line @typescript-eslint/no-unsafe-call\n this.trigger('back');\n }\n\n /**\n * Cancel the tour\n *\n * @method cancel\n * @public\n */\n async cancel() {\n await this.tourObject?.cancel();\n }\n\n /**\n * Complete the tour\n *\n * @method complete\n * @public\n */\n complete() {\n this.tourObject?.complete();\n }\n\n /**\n * Hides the current step\n *\n * @method hide\n * @public\n */\n hide() {\n this.tourObject?.hide();\n }\n\n /**\n * Advance the tour to the next step and trigger next\n *\n * @method next\n * @public\n */\n next() {\n this.tourObject?.next();\n // @ts-expect-error TODO: refactor away from Evented mixin\n // eslint-disable-next-line @typescript-eslint/no-unsafe-call\n this.trigger('next');\n }\n\n /**\n * Show a specific step, by passing its id\n *\n * @param {string} [id] The id of the step you want to show\n * @method show\n * @public\n */\n show(id: string) {\n this.tourObject?.show(id);\n }\n\n /**\n * Start the tour. The Promise from addSteps() must be in a resolved state prior to starting the tour!\n *\n * @method start\n * @public\n */\n async start() {\n const tourObject = this.tourObject;\n if (tourObject == undefined) {\n throw new Error(\n 'the Promise from addSteps must be in a resolved state before the tour can be started',\n );\n }\n this.isActive = true;\n await tourObject.start();\n }\n\n /**\n * When the tour starts, setup the step event listeners\n *\n * @method _onTourStart\n * @private\n */\n _onTourStart() {\n // @ts-expect-error TODO: refactor away from Evented mixin\n // eslint-disable-next-line @typescript-eslint/no-unsafe-call\n this.trigger('start');\n }\n\n /**\n * This function is called when a tour is completed or cancelled to initiate cleanup.\n *\n * @method _onTourFinish\n * @param {string} [completeOrCancel] 'complete' or 'cancel'\n * @private\n */\n _onTourFinish(completeOrCancel: 'complete' | 'cancel') {\n if (!this.isDestroyed) {\n this.isActive = false;\n }\n // @ts-expect-error TODO: refactor away from Evented mixin\n // eslint-disable-next-line @typescript-eslint/no-unsafe-call\n this.trigger(completeOrCancel);\n }\n\n /**\n * Initializes the tour, creates a new Shepherd.Tour. sets options, and binds events\n *\n * @method _initialize\n * @private\n */\n _initialize() {\n const {\n classPrefix,\n confirmCancel,\n confirmCancelMessage,\n defaultStepOptions,\n exitOnEsc,\n keyboardNavigation,\n modal,\n modalContainer,\n stepsContainer,\n tourName,\n } = this;\n\n // Ensure `floatingUIOptions` exists on `defaultStepOptions`\n defaultStepOptions.floatingUIOptions =\n defaultStepOptions.floatingUIOptions || {};\n\n return import('shepherd.js').then((module) => {\n const Shepherd = module.default;\n const tourObject = new Shepherd.Tour({\n classPrefix,\n confirmCancel,\n confirmCancelMessage,\n defaultStepOptions,\n exitOnEsc,\n keyboardNavigation,\n modalContainer:\n modalContainer ??\n (isTesting()\n ? (document.querySelector('#ember-testing') as HTMLElement)\n : document.body),\n stepsContainer:\n stepsContainer ??\n (isTesting()\n ? (document.querySelector('#ember-testing') as HTMLElement)\n : document.body),\n tourName,\n useModalOverlay: modal,\n });\n\n tourObject.on('start', bind(this, '_onTourStart'));\n tourObject.on('complete', bind(this, '_onTourFinish', 'complete'));\n tourObject.on('cancel', bind(this, '_onTourFinish', 'cancel'));\n\n this.tourObject = tourObject;\n });\n }\n\n /**\n * Observes the array of requiredElements, which are the elements that must be present at the start of the tour,\n * and determines if they exist, and are visible, if either is false, it will stop the tour from executing.\n *\n * @method _requiredElementsPresent\n * @private\n */\n _requiredElementsPresent() {\n let allElementsPresent = true;\n\n const requiredElements = this.requiredElements;\n\n if (isPresent(requiredElements)) {\n /* istanbul ignore next: also can't test this due to things attached to root blowing up tests */\n requiredElements.forEach(\n (element: { message: string; selector: string; title: string }) => {\n const selectedElement = document.querySelector(element.selector);\n\n if (\n allElementsPresent &&\n (!selectedElement ||\n elementIsHidden(selectedElement as HTMLElement))\n ) {\n allElementsPresent = false;\n this.errorTitle = element.title;\n this.messageForUser = element.message;\n }\n },\n );\n }\n return allElementsPresent;\n }\n}\n" }, { "path": "ember-shepherd/src/template-registry.ts", "content": "// Easily allow apps, which are not yet using strict mode templates, to consume your Glint types, by importing this file.\n// Add all your components, helpers and modifiers to the template registry here, so apps don't have to do this.\n// See https://typed-ember.gitbook.io/glint/environments/ember/authoring-addons\n\n// import type MyComponent from './components/my-component';\n\n// Uncomment this once entries have been added! 👇\n// export default interface Registry {\n// MyComponent: typeof MyComponent\n// }\n" }, { "path": "ember-shepherd/src/unpublished-development-types/index.d.ts", "content": "// Add any types here that you need for local development only.\n// These will *not* be published as part of your addon, so be careful that your published code does not rely on them!\nimport 'ember-source/types/stable';\nimport 'ember-source/types/preview';\n" }, { "path": "ember-shepherd/src/utils/buttons.ts", "content": "/* eslint-disable ember/no-runloop */\nimport { bind } from '@ember/runloop';\nimport { assert } from '@ember/debug';\n\nimport { type StepOptionsButton } from 'shepherd.js';\n\nimport type TourService from '../services/tour';\n\nexport type EmberShepherdButton = StepOptionsButton & {\n type?: 'back' | 'cancel' | 'next';\n};\n\n/**\n * Creates a button of the specified type, with the given classes and text\n *\n * @function makeButton\n * @param {object} [button] Description here\n * @param {string} [button.type] The type of button cancel, back, or next\n * @param {classes} [button.classes] Classes to apply to the button\n * @param {string} [button.text] The text for the button\n * @param {action} [button.action] The action to call\n * @private\n * @return {{action: *, classes: *, text: *}} Description here\n */\nexport function makeButton(\n this: TourService,\n button: EmberShepherdButton,\n): EmberShepherdButton {\n const { classes, disabled, label, secondary, text, type } = button;\n const builtInButtonTypes = ['back', 'cancel', 'next'];\n\n if (!type) {\n return button;\n }\n\n assert(\n `'type' property must be one of 'back', 'cancel', or 'next'`,\n builtInButtonTypes.includes(type),\n );\n\n const action = bind(this, function () {\n void this[type]();\n });\n\n return {\n action,\n classes,\n disabled,\n label,\n secondary,\n text,\n type,\n };\n}\n" }, { "path": "ember-shepherd/src/utils/dom.ts", "content": "/**\n * Helper method to check if element is hidden, since we cannot use :visible without jQuery\n *\n * @function elementIsHidden\n * @param {HTMLElement} element The element to check for visibility\n * @private\n * @return {boolean} true if element is hidden\n */\nexport function elementIsHidden(element: HTMLElement) {\n return element.offsetWidth === 0 && element.offsetHeight === 0;\n}\n" }, { "path": "ember-shepherd/tsconfig.json", "content": "{\n \"extends\": \"@ember/library-tsconfig\",\n \"include\": [\"src/**/*\", \"unpublished-development-types/**/*\"],\n \"glint\": {\n \"environment\": [\"ember-loose\", \"ember-template-imports\"]\n },\n \"compilerOptions\": {\n \"allowJs\": true,\n \"declarationDir\": \"declarations\",\n /**\n https://www.typescriptlang.org/tsconfig#rootDir\n \"Default: The longest common path of all non-declaration input files.\"\n\n Because we want our declarations' structure to match our rollup output,\n we need this \"rootDir\" to match the \"srcDir\" in the rollup.config.mjs.\n\n This way, we can have simpler `package.json#exports` that matches\n imports to files on disk\n */\n \"rootDir\": \"./src\",\n \"types\": [\"ember-source/types\"]\n }\n}\n" }, { "path": "ember-shepherd/unpublished-development-types/index.d.ts", "content": "// Add any types here that you need for local development only.\n// These will *not* be published as part of your addon, so be careful that your published code does not rely on them!\n\nimport '@glint/environment-ember-loose';\nimport '@glint/environment-ember-template-imports';\n\n// Uncomment if you need to support consuming projects in loose mode\n//\n// declare module '@glint/environment-ember-loose/registry' {\n// export default interface Registry {\n// // Add any registry entries from other addons here that your addon itself uses (in non-strict mode templates)\n// // See https://typed-ember.gitbook.io/glint/using-glint/ember/using-addons\n// }\n// }\n" }, { "path": "package.json", "content": "{\n \"version\": \"17.3.1\",\n \"private\": true,\n \"repository\": \"https://github.com/RobbieTheWagner/ember-shepherd\",\n \"license\": \"AGPL-3.0\",\n \"author\": {\n \"name\": \"Robert Wagner\",\n \"email\": \"rwwagner90@gmail.com\",\n \"url\": \"https://github.com/RobbieTheWagner\"\n },\n \"scripts\": {\n \"build\": \"pnpm --filter ember-shepherd build\",\n \"lint\": \"pnpm --filter '*' lint\",\n \"lint:fix\": \"pnpm --filter '*' lint:fix\",\n \"prepare\": \"pnpm build\",\n \"start\": \"concurrently 'pnpm:start:*' --restart-after 5000 --prefixColors auto\",\n \"start:addon\": \"pnpm --filter ember-shepherd start --no-watch.clearScreen\",\n \"start:test-app\": \"pnpm --filter test-app start\",\n \"test\": \"pnpm --filter '*' test\",\n \"test:ember\": \"pnpm --filter '*' test:ember\"\n },\n \"devDependencies\": {\n \"@glint/core\": \"^1.5.2\",\n \"concurrently\": \"^9.2.1\",\n \"prettier\": \"^3.8.1\",\n \"prettier-plugin-ember-template-tag\": \"^2.1.3\",\n \"release-plan\": \"^0.17.4\"\n },\n \"engines\": {\n \"node\": \">= 20\"\n }\n}\n" }, { "path": "pnpm-workspace.yaml", "content": "packages:\n - ember-shepherd\n - test-app\n\nonlyBuiltDependencies:\n - '@parcel/watcher'\n - core-js\n - ember-modal-dialog\n" }, { "path": "test-app/.editorconfig", "content": "# EditorConfig helps developers define and maintain consistent\n# coding styles between different editors and IDEs\n# editorconfig.org\n\nroot = true\n\n[*]\nend_of_line = lf\ncharset = utf-8\ntrim_trailing_whitespace = true\ninsert_final_newline = true\nindent_style = space\nindent_size = 2\n\n[*.hbs]\ninsert_final_newline = false\n\n[*.{diff,md}]\ntrim_trailing_whitespace = false\n" }, { "path": "test-app/.ember-cli", "content": "{\n /**\n Setting `isTypeScriptProject` to true will force the blueprint generators to generate TypeScript\n rather than JavaScript by default, when a TypeScript version of a given blueprint is available.\n */\n \"isTypeScriptProject\": true,\n\n /**\n Setting `componentAuthoringFormat` to \"strict\" will force the blueprint generators to generate GJS\n or GTS files for the component and the component rendering test. \"strict\" is the default.\n */\n \"componentAuthoringFormat\": \"strict\",\n\n /**\n Setting `routeAuthoringFormat` to \"strict\" will force the blueprint generators to generate GJS\n or GTS templates for routes. \"strict\" is the default\n */\n \"routeAuthoringFormat\": \"strict\"\n}\n" }, { "path": "test-app/.gitignore", "content": "# compiled output\n/dist/\n/declarations/\n\n# dependencies\n/node_modules/\n\n# misc\n/.env*\n/.pnp*\n/.eslintcache\n/coverage/\n/npm-debug.log*\n/testem.log\n/yarn-error.log\n\n# broccoli-debug\n/DEBUG/\n\n# addon-docs\ndeploy-test-app/\ntmp/\n" }, { "path": "test-app/.prettierignore", "content": "# unconventional js\n/blueprints/*/files/\n\n# compiled output\n/dist/\n\n# misc\n/coverage/\n!.*\n.*/\n/pnpm-lock.yaml\nember-cli-update.json\n*.html\n" }, { "path": "test-app/.prettierrc.js", "content": "'use strict';\n\nmodule.exports = {\n plugins: ['prettier-plugin-ember-template-tag'],\n overrides: [\n {\n files: '*.{js,gjs,ts,gts,mjs,mts,cjs,cts}',\n options: {\n singleQuote: true,\n templateSingleQuote: false,\n },\n },\n ],\n};\n" }, { "path": "test-app/.stylelintignore", "content": "# unconventional files\n/blueprints/*/files/\n\n# compiled output\n/dist/\n" }, { "path": "test-app/.stylelintrc.js", "content": "'use strict';\n\nmodule.exports = {\n extends: ['stylelint-config-standard'],\n rules: {\n 'color-hex-length': null,\n 'font-family-no-missing-generic-family-keyword': null,\n },\n};\n" }, { "path": "test-app/.template-lintrc.js", "content": "'use strict';\n\nmodule.exports = {\n extends: 'recommended',\n};\n" }, { "path": "test-app/.watchmanconfig", "content": "{\n \"ignore_dirs\": [\"dist\"]\n}\n" }, { "path": "test-app/README.md", "content": "# test-app\n\nThis README outlines the details of collaborating on this Ember application.\nA short introduction of this app could easily go here.\n\n## Prerequisites\n\nYou will need the following things properly installed on your computer.\n\n- [Git](https://git-scm.com/)\n- [Node.js](https://nodejs.org/) (with npm)\n- [Ember CLI](https://cli.emberjs.com/release/)\n- [Google Chrome](https://google.com/chrome/)\n\n## Installation\n\n- `git clone ` this repository\n- `cd test-app`\n- `npm install`\n\n## Running / Development\n\n- `npm run start`\n- Visit your app at [http://localhost:4200](http://localhost:4200).\n- Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).\n\n### Code Generators\n\nMake use of the many generators for code, try `ember help generate` for more details\n\n### Running Tests\n\n- `npm run test`\n- `npm run test:ember -- --server`\n\n### Linting\n\n- `npm run lint`\n- `npm run lint:fix`\n\n### Building\n\n- `npm exec ember build` (development)\n- `npm run build` (production)\n\n### Deploying\n\nSpecify what it takes to deploy your app.\n\n## Further Reading / Useful Links\n\n- [ember.js](https://emberjs.com/)\n- [ember-cli](https://cli.emberjs.com/release/)\n- Development Browser Extensions\n - [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)\n - [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)\n" }, { "path": "test-app/app/app.ts", "content": "import '@warp-drive/ember/install';\nimport Application from '@ember/application';\nimport Resolver from 'ember-resolver';\nimport loadInitializers from 'ember-load-initializers';\nimport config from 'test-app/config/environment';\nimport { importSync, isDevelopingApp, macroCondition } from '@embroider/macros';\n\nif (macroCondition(isDevelopingApp())) {\n importSync('./deprecation-workflow');\n}\n\nexport default class App extends Application {\n modulePrefix = config.modulePrefix;\n podModulePrefix = config.podModulePrefix;\n Resolver = Resolver;\n}\n\nloadInitializers(App, config.modulePrefix);\n" }, { "path": "test-app/app/components/.gitkeep", "content": "" }, { "path": "test-app/app/config/environment.d.ts", "content": "/**\n * Type declarations for\n * import config from 'test-app/config/environment'\n */\ndeclare const config: {\n environment: string;\n modulePrefix: string;\n podModulePrefix: string;\n locationType: 'history' | 'hash' | 'none';\n rootURL: string;\n APP: Record;\n};\n\nexport default config;\n" }, { "path": "test-app/app/controllers/.gitkeep", "content": "" }, { "path": "test-app/app/controllers/docs/demo.js", "content": "import Controller from '@ember/controller';\nimport { action } from '@ember/object';\nimport { inject as service } from '@ember/service';\nimport { steps as defaultSteps } from '../../data';\n\nexport default class DocsDemoController extends Controller {\n @service tour;\n\n usage = `//Inject the service: tour: service()\nlet tour = this.tour;\ntour.set('defaultStepOptions', shepherdStepDefaults);\ntour.set('disableScroll', true);\ntour.set('modal', true);\ntour.set('requiredElements', requiredElements);\ntour.addSteps(steps);\n\n// Methods to control the tour\ntour.start();\ntour.next();\ntour.back();\ntour.cancel();`;\n\n @action\n toggleHelpModal() {\n this.tour.set('modal', true);\n this.tour.addSteps(defaultSteps);\n this.tour.start();\n }\n\n @action\n toggleHelpNonmodal() {\n this.tour.set('modal', false);\n this.tour.addSteps(defaultSteps);\n this.tour.start();\n }\n}\n" }, { "path": "test-app/app/data.js", "content": "export const builtInButtons = {\n cancel: {\n classes: 'cancel-button',\n secondary: true,\n text: 'Exit',\n type: 'cancel',\n },\n next: {\n classes: 'next-button',\n text: 'Next',\n type: 'next',\n },\n back: {\n classes: 'back-button',\n text: 'Back',\n type: 'back',\n },\n};\n\nexport const defaultStepOptions = {\n classes: 'shepherd-theme-arrows custom-default-class',\n scrollTo: true,\n cancelIcon: {\n enabled: true,\n },\n};\n\nexport const steps = [\n {\n attachTo: {\n element: '.first-element',\n on: 'bottom',\n },\n buttons: [builtInButtons.cancel, builtInButtons.next],\n classes: 'custom-class-name-1 custom-class-name-2',\n id: 'intro',\n title: 'Welcome to Ember Shepherd!',\n text: `\n

\n Ember Shepherd is a JavaScript library for guiding users through your Ember app.\n It is an Ember addon that wraps Shepherd\n and extends its functionality. Shepherd uses Popper.js,\n another open source library, to render dialogs for each tour \"step\".\n

\n\n

\n Popper makes sure your steps never end up off screen or cropped by an\n overflow. Try resizing your browser to see what we mean.\n

`,\n },\n {\n attachTo: {\n element: '.install-element .shiki-code-block',\n on: 'bottom',\n },\n buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],\n classes: 'custom-class-name-1 custom-class-name-2',\n id: 'installation',\n title: 'Installation',\n text: 'Installation is simple, if you are using Ember-CLI, just install like any other addon.',\n },\n {\n attachTo: {\n element: '.usage-element .shiki-code-block',\n on: 'bottom',\n },\n buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],\n classes: 'custom-class-name-1 custom-class-name-2',\n id: 'usage',\n title: 'Usage',\n text: 'To use the tour service, simply inject it into your application and use it like this example.',\n },\n {\n attachTo: {\n element: '.modal-element',\n on: 'top',\n },\n buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],\n classes: 'custom-class-name-1 custom-class-name-2',\n id: 'modal',\n text: `\n

\n We implemented true modal functionality by disabling clicking of the rest of the page.\n

\n\n

\n If you would like to enable modal, simply do this.tour.set('modal', true).\n

`,\n },\n {\n attachTo: {\n element: '.built-in-buttons-element',\n on: 'top',\n },\n buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],\n classes: 'custom-class-name-1 custom-class-name-2',\n id: 'buttons',\n text: `For the common button types (\"next\", \"back\", \"cancel\", etc.), we implemented Ember actions\n that perform these actions on your tour automatically. To use them, simply include\n in the buttons array in each step.`,\n },\n {\n attachTo: {\n element: '.disable-scroll-element',\n on: 'top',\n },\n buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],\n classes: 'custom-class-name-1 custom-class-name-2',\n id: 'disableScroll',\n text: `\n

\n When navigating the user through a tour, you may want to disable scrolling, so they\n cannot mess up your carefully planned out, amazing tour. This is now easily achieved\n with this.tour.set('disableScroll', true).\n

\n\n

\n Try scrolling right now, then exit the tour and see that you can again!\n

`,\n },\n {\n buttons: [builtInButtons.cancel, builtInButtons.back],\n id: 'noAttachTo',\n title: 'Centered Modals',\n classes: 'custom-class-name-1 custom-class-name-2',\n text: 'If no attachTo is specified, the modal will appear in the center of the screen, as per the Shepherd docs.',\n },\n];\n" }, { "path": "test-app/app/deprecation-workflow.ts", "content": "import setupDeprecationWorkflow from 'ember-cli-deprecation-workflow';\n\n/**\n * Docs: https://github.com/ember-cli/ember-cli-deprecation-workflow\n */\nsetupDeprecationWorkflow({\n /**\n false by default, but if a developer / team wants to be more aggressive about being proactive with\n handling their deprecations, this should be set to \"true\"\n */\n throwOnUnhandled: false,\n workflow: [\n /* ... handlers ... */\n /* to generate this list, run your app for a while (or run the test suite),\n * and then run in the browser console:\n *\n * deprecationWorkflow.flushDeprecations()\n *\n * And copy the handlers here\n */\n /* example: */\n /* { handler: 'silence', matchId: 'template-action' }, */\n ],\n});\n" }, { "path": "test-app/app/helpers/.gitkeep", "content": "" }, { "path": "test-app/app/index.html", "content": "\n\n \n \n Ember Shepherd\n \n \n\n {{content-for \"head\"}}\n\n \n \n\n {{content-for \"head-footer\"}}\n \n \n {{content-for \"body\"}}\n\n \n \n\n {{content-for \"body-footer\"}}\n \n\n" }, { "path": "test-app/app/models/.gitkeep", "content": "" }, { "path": "test-app/app/router.js", "content": "import AddonDocsRouter, { docsRoute } from 'ember-cli-addon-docs/router';\nimport config from 'test-app/config/environment';\n\nconst Router = AddonDocsRouter.extend({\n location: config.locationType,\n rootURL: config.rootURL,\n});\n\nRouter.map(function () {\n docsRoute(this, function () {\n this.route('demo');\n this.route('faq');\n this.route('style-variables');\n this.route('usage');\n\n this.route('not-found', { path: '/*path' });\n });\n});\n\nexport default Router;\n" }, { "path": "test-app/app/routes/.gitkeep", "content": "" }, { "path": "test-app/app/routes/docs/demo.js", "content": "import Route from '@ember/routing/route';\nimport config from '../../config/environment';\nimport { inject as service } from '@ember/service';\nimport { scheduleOnce } from '@ember/runloop';\nimport { steps as defaultSteps, defaultStepOptions } from '../../data';\n\nexport default class DocsDemoRoute extends Route {\n @service tour;\n\n disableScroll = false;\n\n async beforeModel() {\n const tour = this.tour;\n\n tour.set('defaultStepOptions', defaultStepOptions);\n tour.set('disableScroll', this.disableScroll);\n tour.set('modal', true);\n tour.set('confirmCancel', false);\n\n await tour.addSteps(defaultSteps);\n\n tour.on('cancel', () => {\n console.log('cancel');\n });\n }\n\n model() {\n return {\n links: [\n {\n href: 'https://github.com/RobbieTheWagner/ember-shepherd',\n text: 'Docs',\n type: 'href',\n },\n {\n href: 'https://github.com/RobbieTheWagner/ember-shepherd',\n text: 'GitHub',\n type: 'href',\n },\n {\n href: 'https://shipshape.io',\n text: 'Ship Shape',\n type: 'href',\n },\n ],\n };\n }\n\n activate() {\n if (config.environment !== 'test') {\n // eslint-disable-next-line ember/no-runloop\n scheduleOnce('afterRender', this, this._startTour);\n }\n }\n\n _startTour() {\n this.tour.start();\n }\n}\n" }, { "path": "test-app/app/styles/app.css", "content": "@import url(\"https://cdn.jsdelivr.net/npm/shepherd.js@14.3.0/dist/css/shepherd.min.css\");\n@import url(\"./fonts.css\");\n@import url(\"./shepherd-theme.css\");\n\nhtml,\nbody {\n -webkit-font-smoothing: antialiased;\n -moz-osx-font-smoothing: grayscale;\n}\n\nbody {\n height: 100%;\n margin: 0;\n}\n\na,\nbutton {\n transition: 0.25s ease-in-out;\n}\n\n.button {\n cursor: pointer;\n display: inline-block;\n text-decoration: none;\n text-transform: uppercase;\n transition: 0.25s ease-in-out;\n}\n\n.button:hover {\n background: #f3f5f5;\n transform: translateX(10px) translateY(-10px);\n}\n\n.demo-page .panel {\n background-color: rgb(248 250 252);\n border-color: #d8d8d8;\n border-style: solid;\n border-width: 1px;\n color: black;\n font-size: 0.75em;\n margin-bottom: 1.25rem;\n padding: 1.25rem;\n text-align: center;\n}\n\n.demo-page .button.dark {\n background: white;\n color: black;\n}\n\n@media (width <= 568px) {\n .demo-page .button {\n display: block;\n margin: 1em auto 0;\n }\n}\n\n.demo-page .page-title {\n color: black;\n font-size: 50pt;\n\n .ember-title {\n font-family: Pacifico;\n }\n}\n\n@media only screen and (width >= 40.0625em) {\n .demo-page h1,\n .demo-page h2,\n .demo-page h3,\n .demo-page h4,\n .demo-page h5,\n .demo-page h6 {\n line-height: 1.4;\n }\n\n .demo-page h1 {\n font-size: 2.75rem;\n }\n\n .demo-page h2 {\n font-size: 2.3125rem;\n }\n\n .demo-page h3 {\n font-size: 1.6875rem;\n }\n\n .demo-page h4 {\n font-size: 1.4375rem;\n }\n\n .demo-page h5 {\n font-size: 1.125rem;\n }\n\n .demo-page h6 {\n font-size: 1rem;\n }\n}\n\n:root {\n --brand-primary: #ef898b;\n}\n\n.hero {\n padding: 0 2rem;\n}\n" }, { "path": "test-app/app/styles/fonts.css", "content": "@import url(\"https://fonts.googleapis.com/css?family=Pacifico\");\n\n@font-face {\n font-family: \"GT Pressura\";\n src:\n url(\"/fonts/GTPressura-Bold.woff2\") format(\"woff2\"),\n url(\"/fonts/GTPressura-Bold.woff\") format(\"woff\");\n font-weight: bold;\n font-style: normal;\n}\n\n@font-face {\n font-family: \"Founders Grotesk\";\n src:\n url(\"/fonts/FoundersGrotesk-Regular.woff2\") format(\"woff2\"),\n url(\"/fonts/FoundersGrotesk-Regular.woff\") format(\"woff\");\n font-weight: normal;\n font-style: normal;\n}\n" }, { "path": "test-app/app/styles/shepherd-theme.css", "content": ".shepherd-logo {\n height: auto;\n width: 217px;\n}\n\n.shepherd-logo .lines,\n.shepherd-logo .open-eye,\n.shepherd-logo .wink {\n transition:\n visibility 0s,\n opacity 0.25s ease-in-out;\n}\n\n.shepherd-logo .open-eye {\n opacity: 1;\n visibility: visible;\n}\n\n.shepherd-logo .lines,\n.shepherd-logo .wink {\n opacity: 0;\n visibility: hidden;\n}\n\n.shepherd-logo:hover .lines,\n.shepherd-logo:hover .wink {\n opacity: 1;\n visibility: visible;\n}\n\n.shepherd-logo:hover .open-eye {\n opacity: 0;\n visibility: hidden;\n}\n\n.footer-icon path {\n fill: #16202d;\n transition: 0.25s ease-in-out;\n}\n\n.footer-icon:hover path {\n fill: #959fac;\n}\n\n.footer-logo {\n left: 50%;\n transform: translateX(-50%) translateY(-50%);\n}\n\n.hero-outer .hero-followup {\n padding-top: 20px;\n}\n\npre {\n border: 1px solid rgb(0 0 0 / 15%);\n line-height: 1.4em;\n}\n\n.shepherd-button {\n background: #ffffff;\n border-top: solid 4px #16202d;\n border-radius: 0;\n color: #16202d;\n display: flex;\n flex-grow: 1;\n font-family: \"GT Pressura\", sans-serif;\n font-size: 1rem;\n justify-content: center;\n margin: 0;\n padding: 1rem;\n text-align: center;\n text-transform: uppercase;\n}\n\n.shepherd-button:hover {\n background: #16202d;\n color: #ffffff;\n}\n\n.shepherd-button.shepherd-button-secondary {\n background: #cad5d5;\n}\n\n.shepherd-button.shepherd-button-secondary:hover {\n color: #cad5d5;\n background: #16202d;\n}\n\n.shepherd-cancel-icon {\n font-family: \"GT Pressura\", sans-serif;\n}\n\n.shepherd-element {\n border: solid 4px #16202d;\n padding: 0;\n}\n\n.shepherd-element,\n.shepherd-header,\n.shepherd-footer {\n border-radius: 0;\n}\n\n.shepherd-element .shepherd-arrow {\n border-width: 0;\n height: auto;\n width: auto;\n}\n\n.shepherd-arrow::before {\n display: none;\n}\n\n.shepherd-element .shepherd-arrow::after {\n content: url(\"/img/arrow.svg\");\n display: inline-block;\n}\n\n.shepherd-element[data-popper-placement^=\"top\"] .shepherd-arrow,\n.shepherd-element.shepherd-pinned-top .shepherd-arrow {\n bottom: -35px;\n}\n\n.shepherd-element[data-popper-placement^=\"top\"] .shepherd-arrow::after,\n.shepherd-element.shepherd-pinned-top .shepherd-arrow::after {\n transform: rotate(270deg);\n}\n\n.shepherd-element[data-popper-placement^=\"bottom\"] .shepherd-arrow {\n top: -35px;\n}\n\n.shepherd-element[data-popper-placement^=\"bottom\"] .shepherd-arrow::after {\n transform: rotate(90deg);\n}\n\n.shepherd-element[data-popper-placement^=\"left\"] .shepherd-arrow,\n.shepherd-element.shepherd-pinned-left .shepherd-arrow {\n right: -35px;\n}\n\n.shepherd-element[data-popper-placement^=\"left\"] .shepherd-arrow::after,\n.shepherd-element.shepherd-pinned-left .shepherd-arrow::after {\n transform: rotate(180deg);\n}\n\n.shepherd-element[data-popper-placement^=\"right\"] .shepherd-arrow,\n.shepherd-element.shepherd-pinned-right .shepherd-arrow {\n left: -35px;\n}\n\n.shepherd-footer {\n padding: 0;\n}\n\n.shepherd-footer button:not(:last-of-type) {\n border-right: solid 4px #16202d;\n}\n\n.shepherd-has-title .shepherd-content .shepherd-cancel-icon {\n margin-top: -7px;\n}\n\n.shepherd-has-title .shepherd-content .shepherd-header {\n background: transparent;\n font-family: \"GT Pressura\", sans-serif;\n padding-bottom: 0;\n padding-left: 2rem;\n}\n\n.shepherd-has-title .shepherd-content .shepherd-header .shepherd-title {\n font-size: 1.2rem;\n text-transform: uppercase;\n}\n\n.shepherd-text {\n font-size: 1.2rem;\n padding: 2rem;\n}\n\n.shepherd-text a,\n.shepherd-text a:visited,\n.shepherd-text a:active {\n border-bottom: 1px dotted;\n border-bottom-color: rgb(0 0 0 / 75%);\n color: rgb(0 0 0 / 75%);\n text-decoration: none;\n}\n\n.shepherd-text a:hover,\n.shepherd-text a:visited:hover,\n.shepherd-text a:active:hover {\n border-bottom-style: solid;\n}\n" }, { "path": "test-app/app/templates/application.hbs", "content": "
\n \n\n {{outlet}}\n\n \n
" }, { "path": "test-app/app/templates/docs/demo.hbs", "content": "{{! template-lint-disable }}\n
\n
\n
\n

ember\n Shepherd\n

\n
\n
\n

Guide your users through a tour of your app.

\n
\n
\n
Installation
\n
\n
\n \n
\n
\n
Usage
\n
\n
\n \n
\n
\n
Additional Features
\n
\n
\n \n Modal\n
\n \n Built-in Buttons\n
\n \n Disable Scroll\n
\n \n {{!--
\n
\n \n Modal Demo\n \n
\n
\n \n Non-modal\n \n
\n
--}}\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n\n
" }, { "path": "test-app/app/templates/docs/faq.md", "content": "## Q/A\n\n### Q: Woah, events? How does that work with buttons?\n\nA: Don't worry, it's not too bad! You can just set up an action to start (or cancel, or advance, etc.) the tour like so:\n\n```js\n// app/routes/application.js\n\nimport Route from \"@ember/routing/route\";\nimport { service } from \"@ember/service\";\n\nexport default Route.extend({\n tour: service(),\n\n actions: {\n startTour() {\n this.tour.start();\n },\n },\n});\n```\n\n### Q: How do I make a tour span multiple route transitions?\n\nA : You can use `beforeShowPromise` to ensure you have fully transitioned to the new route before showing\nthe step by doing something like this:\n\n```js\nbeforeShowPromise() {\n return new Promise(function(resolve) {\n router.transitionTo('myurl').finally(() => {\n Ember.run.scheduleOnce('afterRender', this, function() {\n resolve();\n });\n });\n });\n}\n```\n" }, { "path": "test-app/app/templates/docs/index.md", "content": "# ember-shepherd\n\n\"Ship\n\n**[ember-shepherd is built and maintained by Ship Shape. Contact us for Ember.js consulting, development, and training for your project](https://shipshape.io/ember-consulting/)**.\n\n[![npm version](https://badge.fury.io/js/ember-shepherd.svg)](http://badge.fury.io/js/ember-shepherd)\n![Download count all time](https://img.shields.io/npm/dt/ember-shepherd.svg)\n[![npm](https://img.shields.io/npm/dm/ember-shepherd.svg)]()\n[![Ember Observer Score](http://emberobserver.com/badges/ember-shepherd.svg)](http://emberobserver.com/addons/ember-shepherd)\n[![CI](https://github.com/RobbieTheWagner/ember-shepherd/actions/workflows/ci.yml/badge.svg)](https://github.com/RobbieTheWagner/ember-shepherd/actions/workflows/ci.yml)\n\n## Installation\n\n```\nember install ember-shepherd\n```\n" }, { "path": "test-app/app/templates/docs/not-found.hbs", "content": "
\n

Not found

\n

This page doesn't exist. Head home?

\n
" }, { "path": "test-app/app/templates/docs/usage.md", "content": "## Usage\n\nThe styles are no longer automatically added for Shepherd. You will need to add them to your styles manually. How you do this will vary depending on your app, but one possible way is to add this to your app's CSS:\n\n```css\n@import url(\"https://cdn.jsdelivr.net/npm/shepherd.js@14.3.0/dist/css/shepherd.min.css\");\n```\n\nMost of the usage documentation can be found in the [API Reference for the Tour Service](api/services/tour).\n\n## Step Options\n\nSee the [Step docs](https://docs.shepherdjs.dev/api/step/interfaces/stepoptions/) for all available Step options.\n\n## Interacting with `ember-shepherd`\n\n`ember-shepherd` uses the [`Ember.Evented`](http://emberjs.com/api/classes/Ember.Evented.html) mixin to manage events. The API is demonstrated below.\n\n```js\n// Start the tour\nthis.tour.start();\n\n//Show a specific step\nthis.tour.show(id);\n\n// Stop the tour\nthis.tour.cancel();\n\n// Go to the next step\nthis.tour.next();\n\n// Go to the previous step\nthis.tour.back();\n```\n" }, { "path": "test-app/app/templates/docs.hbs", "content": "\n \n \n \n \n\n \n \n\n \n \n \n\n \n
\n
\n {{outlet}}\n
\n
\n \n" }, { "path": "test-app/app/templates/index.hbs", "content": "
\n
\n \n
\n
\n
\n

\n \n {{svg-jar\n \"ember\"\n class=\"docs-h-full docs-w-auto docs-max-w-full docs-fill-current\"\n height=\"auto\"\n width=\"125px\"\n }}\n \n\n Shepherd\n

\n\n \n An Ember addon for the site tour library Shepherd\n

\n\n \n Read the docs →\n \n
\n
\n
\n\n \n {{svg-jar \"ember-consulting\"}}\n
\n \n \n
" }, { "path": "test-app/config/addon-docs.js", "content": "/* eslint-env node */\n'use strict';\n\nconst AddonDocsConfig = require('ember-cli-addon-docs/lib/config');\n\nmodule.exports = class extends AddonDocsConfig {\n // See https://ember-learn.github.io/ember-cli-addon-docs/docs/deploying\n // for details on configuration you can override here.\n};\n" }, { "path": "test-app/config/deploy.js", "content": "'use strict';\n\nmodule.exports = function (deployTarget) {\n let ENV = {\n build: {},\n // include other plugin configuration that applies to all deploy targets here\n };\n\n if (deployTarget === 'development') {\n ENV.build.environment = 'development';\n // configure other plugins for development deploy target here\n }\n\n if (deployTarget === 'staging') {\n ENV.build.environment = 'production';\n // configure other plugins for staging deploy target here\n }\n\n if (deployTarget === 'production') {\n ENV.build.environment = 'production';\n // configure other plugins for production deploy target here\n }\n\n // Note: if you need to build some configuration asynchronously, you can return\n // a promise that resolves with the ENV object instead of returning the\n // ENV object synchronously.\n return ENV;\n};\n" }, { "path": "test-app/config/ember-cli-update.json", "content": "{\n \"schemaVersion\": \"1.0.0\",\n \"packages\": [\n {\n \"name\": \"@ember-tooling/classic-build-app-blueprint\",\n \"version\": \"6.10.0\",\n \"blueprints\": [\n {\n \"name\": \"@ember-tooling/classic-build-app-blueprint\",\n \"isBaseBlueprint\": true,\n \"options\": [\n \"--no-welcome\",\n \"--pnpm\",\n \"--ci-provider=github\",\n \"--typescript\"\n ]\n }\n ]\n }\n ]\n}\n" }, { "path": "test-app/config/ember-try.js", "content": "'use strict';\n\nconst getChannelURL = require('ember-source-channel-url');\nconst { embroiderSafe, embroiderOptimized } = require('@embroider/test-setup');\n\nmodule.exports = async function () {\n return {\n usePnpm: true,\n scenarios: [\n {\n name: 'ember-lts-4.8',\n npm: {\n devDependencies: {\n 'ember-resolver': '^11.0.1',\n 'ember-source': '~4.8.0',\n },\n },\n },\n {\n name: 'ember-lts-4.12',\n npm: {\n devDependencies: {\n 'ember-source': '~4.12.0',\n },\n },\n },\n {\n name: 'ember-lts-5.4',\n npm: {\n devDependencies: {\n 'ember-source': '~5.4.0',\n },\n },\n },\n {\n name: 'ember-release',\n npm: {\n devDependencies: {\n 'ember-source': await getChannelURL('release'),\n },\n },\n },\n {\n name: 'ember-beta',\n npm: {\n devDependencies: {\n 'ember-source': await getChannelURL('beta'),\n },\n },\n },\n {\n name: 'ember-canary',\n npm: {\n devDependencies: {\n 'ember-source': await getChannelURL('canary'),\n },\n },\n },\n embroiderSafe(),\n embroiderOptimized(),\n ],\n };\n};\n" }, { "path": "test-app/config/environment.js", "content": "'use strict';\n\nmodule.exports = function (environment) {\n const ENV = {\n modulePrefix: 'test-app',\n environment,\n rootURL: '/',\n locationType: 'history',\n EmberENV: {\n EXTEND_PROTOTYPES: false,\n FEATURES: {\n // Here you can enable experimental features on an ember canary build\n // e.g. EMBER_NATIVE_DECORATOR_SUPPORT: true\n },\n },\n\n APP: {\n // Here you can pass flags/options to your application instance\n // when it is created\n },\n };\n\n if (environment === 'development') {\n // ENV.APP.LOG_RESOLVER = true;\n // ENV.APP.LOG_ACTIVE_GENERATION = true;\n // ENV.APP.LOG_TRANSITIONS = true;\n // ENV.APP.LOG_TRANSITIONS_INTERNAL = true;\n // ENV.APP.LOG_VIEW_LOOKUPS = true;\n }\n\n if (environment === 'test') {\n // Testem prefers this...\n ENV.locationType = 'none';\n\n // keep test console output quieter\n ENV.APP.LOG_ACTIVE_GENERATION = false;\n ENV.APP.LOG_VIEW_LOOKUPS = false;\n\n ENV.APP.rootElement = '#ember-testing';\n ENV.APP.autoboot = false;\n }\n\n if (environment === 'production') {\n // Allow ember-cli-addon-docs to update the rootURL in compiled assets\n ENV.rootURL = 'ADDON_DOCS_ROOT_URL';\n }\n\n return ENV;\n};\n" }, { "path": "test-app/config/optional-features.json", "content": "{\n \"application-template-wrapper\": false,\n \"default-async-observers\": true,\n \"jquery-integration\": false,\n \"template-only-glimmer-components\": true,\n \"no-implicit-route-model\": true\n}\n" }, { "path": "test-app/config/targets.js", "content": "'use strict';\n\nconst browsers = [\n 'last 1 Chrome versions',\n 'last 1 Firefox versions',\n 'last 1 Safari versions',\n];\n\nmodule.exports = {\n browsers,\n};\n" }, { "path": "test-app/ember-cli-build.js", "content": "'use strict';\n\nconst EmberApp = require('ember-cli/lib/broccoli/ember-app');\n// const { Webpack } = require('@embroider/webpack');\n\nmodule.exports = function (defaults) {\n let app = new EmberApp(defaults, {\n autoImport: {\n watchDependencies: ['ember-shepherd'],\n },\n 'ember-cli-addon-docs': {\n documentingAddonAt: '../ember-shepherd',\n },\n 'ember-cli-babel': { enableTypeScriptTransform: true },\n });\n\n return app.toTree();\n\n // const { maybeEmbroider } = require('@embroider/test-setup');\n\n // return maybeEmbroider(app);\n\n // return require('@embroider/compat').compatBuild(app, Webpack, {\n // staticAddonTrees: true,\n // staticAddonTestSupportTrees: true,\n // staticHelpers: true,\n // staticModifiers: true,\n // staticComponents: true,\n // staticEmberSource: true,\n\n // packagerOptions: {\n // webpackConfig: {\n // // slow, but highest fidelity\n // devtool: 'source-map',\n // module: {\n // rules: [\n // {\n // test: /\\.(png|svg|jpg|jpeg|gif)$/i,\n // type: 'asset/resource',\n // },\n // {\n // test: /\\.(woff|woff2|eot|ttf|otf)$/i,\n // type: 'asset/resource',\n // },\n // ],\n // },\n // },\n // },\n // });\n};\n" }, { "path": "test-app/eslint.config.mjs", "content": "/**\n * Debugging:\n * https://eslint.org/docs/latest/use/configure/debug\n * ----------------------------------------------------\n *\n * Print a file's calculated configuration\n *\n * npx eslint --print-config path/to/file.js\n *\n * Inspecting the config\n *\n * npx eslint --inspect-config\n *\n */\nimport { fileURLToPath } from 'node:url';\nimport { dirname } from 'node:path';\nimport globals from 'globals';\nimport js from '@eslint/js';\n\nimport ts from 'typescript-eslint';\n\nimport ember from 'eslint-plugin-ember/recommended';\n\nimport eslintConfigPrettier from 'eslint-config-prettier';\nimport qunit from 'eslint-plugin-qunit';\nimport n from 'eslint-plugin-n';\n\nimport babelParser from '@babel/eslint-parser';\n\nconst parserOptions = {\n esm: {\n js: {\n ecmaFeatures: { modules: true },\n ecmaVersion: 'latest',\n requireConfigFile: false,\n babelOptions: {\n plugins: [\n [\n '@babel/plugin-proposal-decorators',\n { decoratorsBeforeExport: true },\n ],\n ],\n },\n },\n ts: {\n projectService: true,\n tsconfigRootDir: dirname(fileURLToPath(import.meta.url)),\n },\n },\n};\n\nexport default ts.config(\n js.configs.recommended,\n ember.configs.base,\n ember.configs.gjs,\n ember.configs.gts,\n eslintConfigPrettier,\n /**\n * Ignores must be in their own object\n * https://eslint.org/docs/latest/use/configure/ignore\n */\n {\n ignores: ['dist/', 'node_modules/', 'coverage/', '!**/.*'],\n },\n /**\n * https://eslint.org/docs/latest/use/configure/configuration-files#configuring-linter-options\n */\n {\n linterOptions: {\n reportUnusedDisableDirectives: 'error',\n },\n },\n {\n files: ['**/*.js'],\n languageOptions: {\n parser: babelParser,\n },\n },\n {\n files: ['**/*.{js,gjs}'],\n languageOptions: {\n parserOptions: parserOptions.esm.js,\n globals: {\n ...globals.browser,\n },\n },\n },\n {\n files: ['**/*.{ts,gts}'],\n languageOptions: {\n parser: ember.parser,\n parserOptions: parserOptions.esm.ts,\n },\n extends: [...ts.configs.recommendedTypeChecked, ember.configs.gts],\n },\n {\n ...qunit.configs.recommended,\n files: ['tests/**/*-test.{js,gjs,ts,gts}'],\n plugins: {\n qunit,\n },\n },\n /**\n * CJS node files\n */\n {\n ...n.configs['flat/recommended-script'],\n files: [\n '**/*.cjs',\n 'config/**/*.js',\n 'tests/dummy/config/**/*.js',\n 'testem.js',\n 'testem*.js',\n 'index.js',\n '.prettierrc.js',\n '.stylelintrc.js',\n '.template-lintrc.js',\n 'ember-cli-build.js',\n ],\n plugins: {\n n,\n },\n\n languageOptions: {\n sourceType: 'script',\n ecmaVersion: 'latest',\n globals: {\n ...globals.node,\n },\n },\n },\n /**\n * ESM node files\n */\n {\n ...n.configs['flat/recommended-module'],\n files: ['**/*.mjs'],\n plugins: {\n n,\n },\n\n languageOptions: {\n sourceType: 'module',\n ecmaVersion: 'latest',\n parserOptions: parserOptions.esm.js,\n globals: {\n ...globals.node,\n },\n },\n },\n);\n" }, { "path": "test-app/package.json", "content": "{\n \"name\": \"test-app\",\n \"version\": \"0.0.0\",\n \"private\": true,\n \"description\": \"Test app for ember-shepherd addon\",\n \"repository\": \"https://github.com/RobbieTheWagner/ember-shepherd\",\n \"license\": \"MIT\",\n \"author\": \"\",\n \"directories\": {\n \"doc\": \"doc\",\n \"test\": \"tests\"\n },\n \"scripts\": {\n \"build\": \"ember build --environment=production\",\n \"format\": \"prettier . --cache --write\",\n \"lint\": \"concurrently \\\"pnpm:lint:*(!fix)\\\" --names \\\"lint:\\\" --prefixColors auto\",\n \"lint:css\": \"stylelint \\\"**/*.css\\\"\",\n \"lint:css:fix\": \"concurrently \\\"pnpm:lint:css -- --fix\\\"\",\n \"lint:fix\": \"concurrently \\\"pnpm:lint:*:fix\\\" --names \\\"fix:\\\" --prefixColors auto && pnpm format\",\n \"lint:format\": \"prettier . --cache --check\",\n \"lint:hbs\": \"ember-template-lint .\",\n \"lint:hbs:fix\": \"ember-template-lint . --fix\",\n \"lint:js\": \"eslint . --cache\",\n \"lint:js:fix\": \"eslint . --fix\",\n \"start\": \"ember serve\",\n \"test\": \"concurrently \\\"pnpm:lint\\\" \\\"pnpm:test:*\\\" --names \\\"lint,test:\\\" --prefixColors auto\",\n \"test:ember\": \"ember test\"\n },\n \"dependencies\": {\n \"ember-shepherd\": \"workspace:*\"\n },\n \"devDependencies\": {\n \"@babel/core\": \"^7.29.0\",\n \"@babel/eslint-parser\": \"^7.28.6\",\n \"@babel/helper-module-imports\": \"^7.28.6\",\n \"@babel/plugin-proposal-decorators\": \"^7.29.0\",\n \"@ember-data/adapter\": \"~5.7.0\",\n \"@ember-data/graph\": \"~5.7.0\",\n \"@ember-data/json-api\": \"~5.8.1\",\n \"@ember-data/legacy-compat\": \"~5.7.0\",\n \"@ember-data/model\": \"~5.7.0\",\n \"@ember-data/request\": \"~5.7.0\",\n \"@ember-data/request-utils\": \"~5.8.1\",\n \"@ember-data/serializer\": \"~5.7.0\",\n \"@ember-data/store\": \"~5.7.0\",\n \"@ember/optional-features\": \"^2.3.0\",\n \"@ember/test-helpers\": \"^5.4.1\",\n \"@embroider/macros\": \"^1.19.6\",\n \"@embroider/test-setup\": \"^4.0.0\",\n \"@eslint/js\": \"^9.39.2\",\n \"@glimmer/component\": \"^1.1.2\",\n \"@glimmer/tracking\": \"^1.1.2\",\n \"@glint/environment-ember-loose\": \"^1.5.2\",\n \"@glint/environment-ember-template-imports\": \"^1.5.2\",\n \"@glint/template\": \"^1.7.4\",\n \"@tsconfig/ember\": \"^3.0.12\",\n \"@types/qunit\": \"^2.19.13\",\n \"@types/rsvp\": \"^4.0.9\",\n \"@warp-drive/core-types\": \"~5.7.0\",\n \"@warp-drive/ember\": \"~5.7.0\",\n \"broccoli-asset-rev\": \"^3.0.0\",\n \"concurrently\": \"^9.2.1\",\n \"ember-auto-import\": \"^2.12.0\",\n \"ember-cli\": \"~6.10.0\",\n \"ember-cli-addon-docs\": \"^10.1.0\",\n \"ember-cli-addon-docs-yuidoc\": \"^1.1.0\",\n \"ember-cli-app-version\": \"^7.0.0\",\n \"ember-cli-babel\": \"^8.3.1\",\n \"ember-cli-clean-css\": \"^3.0.0\",\n \"ember-cli-dependency-checker\": \"^3.3.3\",\n \"ember-cli-deploy\": \"^2.0.0\",\n \"ember-cli-deploy-build\": \"^3.0.0\",\n \"ember-cli-deploy-git\": \"^1.3.4\",\n \"ember-cli-deploy-git-ci\": \"^1.0.1\",\n \"ember-cli-deprecation-workflow\": \"^3.4.0\",\n \"ember-cli-htmlbars\": \"^6.3.0\",\n \"ember-cli-inject-live-reload\": \"^2.1.0\",\n \"ember-cli-sri\": \"^2.1.1\",\n \"ember-cli-terser\": \"^4.0.2\",\n \"ember-data\": \"~5.7.0\",\n \"ember-inflector\": \"^6.0.0\",\n \"ember-load-initializers\": \"^3.0.1\",\n \"ember-modifier\": \"^4.2.2\",\n \"ember-page-title\": \"^9.0.3\",\n \"ember-qunit\": \"^9.0.4\",\n \"ember-resolver\": \"^13.1.1\",\n \"ember-shepherd\": \"workspace:*\",\n \"ember-shiki\": \"^0.3.0\",\n \"ember-source\": \"~6.10.1\",\n \"ember-source-channel-url\": \"^3.0.0\",\n \"ember-template-imports\": \"^4.4.0\",\n \"ember-template-lint\": \"^6.1.0\",\n \"ember-try\": \"^3.0.0\",\n \"eslint\": \"^9.39.2\",\n \"eslint-config-prettier\": \"^9.1.2\",\n \"eslint-plugin-ember\": \"^12.7.5\",\n \"eslint-plugin-n\": \"^17.23.2\",\n \"eslint-plugin-qunit\": \"^8.2.5\",\n \"globals\": \"^15.15.0\",\n \"liquid-fire\": \"^0.37.1\",\n \"loader.js\": \"^4.7.0\",\n \"prettier\": \"^3.8.1\",\n \"prettier-plugin-ember-template-tag\": \"^2.1.3\",\n \"qunit\": \"^2.25.0\",\n \"qunit-dom\": \"^3.5.0\",\n \"stylelint\": \"^16.26.1\",\n \"stylelint-config-standard\": \"^40.0.0\",\n \"tracked-built-ins\": \"^4.1.0\",\n \"typescript\": \"^5.9.3\",\n \"typescript-eslint\": \"^8.54.0\",\n \"velocity-animate\": \"^1.5.2\",\n \"webpack\": \"^5.105.0\"\n },\n \"engines\": {\n \"node\": \">= 20.19\"\n },\n \"ember\": {\n \"edition\": \"octane\"\n }\n}\n" }, { "path": "test-app/public/crossdomain.xml", "content": "\n\n\n \n\n \n \n\n \n \n\n" }, { "path": "test-app/public/robots.txt", "content": "# http://www.robotstxt.org\nUser-agent: *\nDisallow:\n" }, { "path": "test-app/testem.js", "content": "'use strict';\n\nmodule.exports = {\n test_page: 'tests/index.html?hidepassed',\n disable_watching: true,\n launch_in_ci: ['Chrome'],\n launch_in_dev: ['Chrome'],\n browser_start_timeout: 120,\n browser_args: {\n Chrome: {\n ci: [\n // --no-sandbox is needed when running Chrome inside a container\n process.env.CI ? '--no-sandbox' : null,\n '--headless',\n '--disable-dev-shm-usage',\n '--disable-software-rasterizer',\n '--mute-audio',\n '--remote-debugging-port=0',\n '--window-size=1440,900',\n ].filter(Boolean),\n },\n },\n};\n" }, { "path": "test-app/tests/acceptance/ember-shepherd-test.js", "content": "import { module, test } from 'qunit';\nimport { visit, click, find } from '@ember/test-helpers';\nimport { setupApplicationTest } from 'ember-qunit';\nimport { builtInButtons, steps as defaultSteps } from '../data';\n\nconst toggleTour = async (tour, modal) => {\n tour.set('modal', modal);\n await tour.addSteps(defaultSteps);\n return await tour.start();\n};\n\nmodule('Acceptance | Tour functionality tests', function (hooks) {\n let tour;\n\n setupApplicationTest(hooks);\n\n hooks.beforeEach(function () {\n tour = this.owner.lookup('service:tour');\n\n tour.set('confirmCancel', false);\n tour.set('modal', true);\n });\n\n hooks.afterEach(async function () {\n return await tour.complete();\n });\n\n module('Cancel link', function () {\n test('Shows cancel link', async function (assert) {\n await visit('/docs/demo');\n\n await toggleTour(tour, true);\n\n const cancelIcon = document.querySelector('.shepherd-cancel-icon');\n assert.ok(cancelIcon, 'Cancel icon shown');\n });\n\n test('Hides cancel link', async function (assert) {\n const defaultStepOptions = {\n cancelIcon: {\n enabled: false,\n },\n classes: 'shepherd-theme-arrows test-defaults',\n };\n\n const steps = [\n {\n attachTo: {\n element: '.first-element',\n on: 'bottom',\n },\n buttons: [builtInButtons.cancel, builtInButtons.next],\n cancelIcon: {\n enabled: false,\n },\n id: 'step-without-cancel-icon',\n },\n ];\n\n await visit('/docs/demo');\n\n tour.set('defaultStepOptions', defaultStepOptions);\n await tour.addSteps(steps);\n\n tour.start();\n\n assert.notOk(\n document.querySelector('.shepherd-element button.shepherd-cancel-icon'),\n );\n });\n\n test('Cancel link cancels the tour', async function (assert) {\n await visit('/docs/demo');\n\n await toggleTour(tour, true);\n\n assert.dom('.shepherd-enabled').exists();\n\n await click(\n document.querySelector('.shepherd-content button.shepherd-cancel-icon'),\n );\n\n assert.dom('.shepherd-enabled').doesNotExist();\n });\n });\n\n module('Required Elements', function () {\n test('Does not warn about required elements when none are specified', async function (assert) {\n await visit('/docs/demo');\n\n await toggleTour(tour, true);\n\n assert\n .dom('.shepherd-element', document.body)\n .hasAttribute('data-shepherd-step-id', defaultSteps[0].id);\n });\n\n test('Does not warn about required elements when none are missing', async function (assert) {\n const requiredElements = [\n {\n selector: 'body',\n message: 'Body element not found 🤔',\n title: 'Error',\n },\n ];\n\n tour.set('requiredElements', requiredElements);\n\n await visit('/docs/demo');\n\n await toggleTour(tour, true);\n\n assert\n .dom('.shepherd-element', document.body)\n .hasAttribute('data-shepherd-step-id', defaultSteps[0].id);\n });\n\n test('Warns about missing required elements when all are not present', async function (assert) {\n const requiredElements = [\n {\n selector: '👻',\n message: '👻 element not found',\n title: 'Missing Required Elements',\n },\n ];\n\n tour.set('requiredElements', requiredElements);\n\n await visit('/docs/demo');\n\n await toggleTour(tour, true);\n\n assert\n .dom('.shepherd-element', document.body)\n .hasAttribute('data-shepherd-step-id', 'error');\n });\n });\n\n module('Tour options', function () {\n test('Defaults applied', async function (assert) {\n const stepsWithoutClasses = [\n {\n attachTo: {\n element: '.first-element',\n on: 'bottom',\n },\n buttons: [builtInButtons.cancel, builtInButtons.next],\n id: 'test-highlight',\n },\n ];\n\n await visit('/docs/demo');\n\n await tour.addSteps(stepsWithoutClasses);\n\n tour.start();\n\n assert.ok(\n document.querySelector('.custom-default-class'),\n 'defaults class applied',\n );\n });\n\n test('configuration works with attachTo object when element is a simple string', async function (assert) {\n const steps = [\n {\n attachTo: {\n element: '.first-element',\n on: 'bottom',\n },\n buttons: [builtInButtons.cancel, builtInButtons.next],\n id: 'test-attachTo-string',\n },\n ];\n\n await tour.addSteps(steps);\n\n await visit('/docs/demo');\n\n tour.start();\n\n assert.ok(document.querySelector('.shepherd-element'), 'tour is visible');\n });\n\n test('configuration works with attachTo object when element is dom element', async function (assert) {\n await visit('/docs/demo');\n\n const steps = [\n {\n attachTo: {\n element: find('.first-element'),\n on: 'bottom',\n },\n buttons: [builtInButtons.cancel, builtInButtons.next],\n id: 'test-attachTo-dom',\n },\n ];\n\n await tour.addSteps(steps);\n tour.start();\n\n assert.ok(document.querySelector('.shepherd-element'), 'tour is visible');\n });\n\n test('buttons work when type is not specified and passed action is triggered', async function (assert) {\n let buttonActionCalled = false;\n\n const steps = [\n {\n attachTo: {\n element: '.first-element',\n on: 'bottom',\n },\n buttons: [\n {\n classes: 'shepherd-button-secondary button-one',\n text: 'button one',\n },\n {\n classes: 'shepherd-button-secondary button-two',\n text: 'button two',\n action() {\n buttonActionCalled = true;\n },\n },\n {\n classes: 'shepherd-button-secondary button-three',\n text: 'button three',\n },\n ],\n id: 'test-buttons-custom-action',\n },\n ];\n\n await visit('/docs/demo');\n\n await tour.addSteps(steps);\n\n await tour.start();\n\n assert.ok(\n document.querySelector('.button-one'),\n 'tour button one is visible',\n );\n assert.ok(\n document.querySelector('.button-two'),\n 'tour button two is visible',\n );\n assert.ok(\n document.querySelector('.button-three'),\n 'tour button three is visible',\n );\n\n await click(document.querySelector('.button-two'));\n\n assert.ok(buttonActionCalled, 'button action triggered');\n });\n\n test('scrollTo works with disableScroll on', async function (assert) {\n // Setup controller tour settings\n tour.set('disableScroll', true);\n tour.set('scrollTo', true);\n\n // Visit route\n await visit('/docs/demo');\n\n document.querySelector('#ember-testing-container').scrollTop = 0;\n\n assert.strictEqual(\n document.querySelector('#ember-testing-container').scrollTop,\n 0,\n 'Scroll is initially 0',\n );\n\n await tour.start();\n\n await click(document.querySelector('.shepherd-content .next-button'));\n\n await click(document.querySelector('.shepherd-content .next-button'));\n\n assert.ok(\n document.querySelector('#ember-testing-container').scrollTop > 0,\n 'Scrolled down correctly',\n );\n });\n\n test('scrollTo works with a custom scrollToHandler', async function (assert) {\n const done = assert.async();\n\n // Override default behavior\n const steps = [\n {\n attachTo: {\n element: '.first-element',\n on: 'bottom',\n },\n buttons: [builtInButtons.cancel, builtInButtons.next],\n id: 'intro',\n scrollTo: true,\n scrollToHandler() {\n document.querySelector('#ember-testing-container').scrollTop = 120;\n assert.strictEqual(\n document.querySelector('#ember-testing-container').scrollTop,\n 120,\n 'Scrolled correctly',\n );\n done();\n },\n },\n ];\n\n // Visit route\n await visit('/docs/demo');\n\n await tour.addSteps(steps);\n\n document.querySelector('#ember-testing-container').scrollTop = 0;\n assert.strictEqual(\n document.querySelector('#ember-testing-container').scrollTop,\n 0,\n 'Scroll is initially 0',\n );\n\n await tour.start();\n await click(document.querySelector('.shepherd-content .next-button'));\n });\n\n test('scrollTo works without a custom scrollToHandler', async function (assert) {\n // Setup controller tour settings\n tour.set('scrollTo', true);\n\n // Visit route\n await visit('/docs/demo');\n\n document.querySelector('#ember-testing-container').scrollTop = 0;\n\n assert.strictEqual(\n document.querySelector('#ember-testing-container').scrollTop,\n 0,\n 'Scroll is initially 0',\n );\n\n await tour.start();\n\n await click(document.querySelector('.shepherd-content .next-button'));\n\n assert.ok(\n document.querySelector('#ember-testing-container').scrollTop > 0,\n 'Scrolled correctly',\n );\n });\n\n test('Show by id works', async function (assert) {\n await visit('/docs/demo');\n\n tour.show('usage');\n\n assert.strictEqual(\n tour.get('tourObject').currentStep.el.querySelector('.shepherd-text')\n .textContent,\n 'To use the tour service, simply inject it into your application and use it like this example.',\n 'Usage step shown',\n );\n });\n\n test('hide method hides the current step', async function (assert) {\n await visit('/docs/demo');\n\n tour.show('usage');\n tour.hide();\n\n assert.false(\n tour.get('tourObject').currentStep.isOpen(),\n 'The step is hidden',\n );\n });\n });\n});\n" }, { "path": "test-app/tests/data.js", "content": "export const builtInButtons = {\n cancel: {\n classes: 'cancel-button',\n secondary: true,\n text: 'Exit',\n type: 'cancel',\n },\n next: {\n classes: 'next-button',\n text: 'Next',\n type: 'next',\n },\n back: {\n classes: 'back-button',\n text: 'Back',\n type: 'back',\n },\n};\n\nexport const defaultStepOptions = {\n classes: 'shepherd-theme-arrows custom-default-class',\n scrollTo: true,\n cancelIcon: {\n enabled: true,\n },\n};\n\nexport const steps = [\n {\n attachTo: {\n element: '.first-element',\n on: 'bottom',\n },\n buttons: [builtInButtons.cancel, builtInButtons.next],\n classes: 'custom-class-name-1 custom-class-name-2',\n id: 'intro',\n title: 'Welcome to Ember Shepherd!',\n text: `\n

\n Ember Shepherd is a JavaScript library for guiding users through your Ember app.\n It is an Ember addon that wraps Shepherd\n and extends its functionality. Shepherd uses Popper.js,\n another open source library, to render dialogs for each tour \"step\".\n

\n \n

\n Popper makes sure your steps never end up off screen or cropped by an\n overflow. Try resizing your browser to see what we mean.\n

`,\n },\n {\n attachTo: {\n element: '.install-element .shiki-code-block',\n on: 'bottom',\n },\n buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],\n classes: 'custom-class-name-1 custom-class-name-2',\n id: 'installation',\n title: 'Installation',\n text: 'Installation is simple, if you are using Ember-CLI, just install like any other addon.',\n },\n {\n attachTo: {\n element: '.usage-element .shiki-code-block',\n on: 'bottom',\n },\n buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],\n classes: 'custom-class-name-1 custom-class-name-2',\n id: 'usage',\n title: 'Usage',\n text: 'To use the tour service, simply inject it into your application and use it like this example.',\n },\n {\n attachTo: {\n element: '.modal-element',\n on: 'top',\n },\n buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],\n classes: 'custom-class-name-1 custom-class-name-2',\n id: 'modal',\n text: `\n

\n We implemented true modal functionality by disabling clicking of the rest of the page.\n

\n \n

\n If you would like to enable modal, simply do this.tour.set('modal', true).\n

`,\n },\n {\n attachTo: {\n element: '.built-in-buttons-element',\n on: 'top',\n },\n buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],\n classes: 'custom-class-name-1 custom-class-name-2',\n id: 'buttons',\n text: `For the common button types (\"next\", \"back\", \"cancel\", etc.), we implemented Ember actions\n that perform these actions on your tour automatically. To use them, simply include\n in the buttons array in each step.`,\n },\n {\n attachTo: {\n element: '.disable-scroll-element',\n on: 'top',\n },\n buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],\n classes: 'custom-class-name-1 custom-class-name-2',\n id: 'disableScroll',\n text: `\n

\n When navigating the user through a tour, you may want to disable scrolling, so they\n cannot mess up your carefully planned out, amazing tour. This is now easily achieved\n with this.tour.set('disableScroll', true).\n

\n \n

\n Try scrolling right now, then exit the tour and see that you can again!\n

`,\n },\n {\n buttons: [builtInButtons.cancel, builtInButtons.back],\n id: 'noAttachTo',\n title: 'Centered Modals',\n classes: 'custom-class-name-1 custom-class-name-2',\n text: 'If no attachTo is specified, the modal will appear in the center of the screen, as per the Shepherd docs.',\n },\n];\n" }, { "path": "test-app/tests/helpers/index.js", "content": "import {\n setupApplicationTest as upstreamSetupApplicationTest,\n setupRenderingTest as upstreamSetupRenderingTest,\n setupTest as upstreamSetupTest,\n} from 'ember-qunit';\n\n// This file exists to provide wrappers around ember-qunit's\n// test setup functions. This way, you can easily extend the setup that is\n// needed per test type.\n\nfunction setupApplicationTest(hooks, options) {\n upstreamSetupApplicationTest(hooks, options);\n\n // Additional setup for application tests can be done here.\n //\n // For example, if you need an authenticated session for each\n // application test, you could do:\n //\n // hooks.beforeEach(async function () {\n // await authenticateSession(); // ember-simple-auth\n // });\n //\n // This is also a good place to call test setup functions coming\n // from other addons:\n //\n // setupIntl(hooks, 'en-us'); // ember-intl\n // setupMirage(hooks); // ember-cli-mirage\n}\n\nfunction setupRenderingTest(hooks, options) {\n upstreamSetupRenderingTest(hooks, options);\n\n // Additional setup for rendering tests can be done here.\n}\n\nfunction setupTest(hooks, options) {\n upstreamSetupTest(hooks, options);\n\n // Additional setup for unit tests can be done here.\n}\n\nexport { setupApplicationTest, setupRenderingTest, setupTest };\n" }, { "path": "test-app/tests/helpers/index.ts", "content": "import {\n setupApplicationTest as upstreamSetupApplicationTest,\n setupRenderingTest as upstreamSetupRenderingTest,\n setupTest as upstreamSetupTest,\n type SetupTestOptions,\n} from 'ember-qunit';\n\n// This file exists to provide wrappers around ember-qunit's\n// test setup functions. This way, you can easily extend the setup that is\n// needed per test type.\n\nfunction setupApplicationTest(hooks: NestedHooks, options?: SetupTestOptions) {\n upstreamSetupApplicationTest(hooks, options);\n\n // Additional setup for application tests can be done here.\n //\n // For example, if you need an authenticated session for each\n // application test, you could do:\n //\n // hooks.beforeEach(async function () {\n // await authenticateSession(); // ember-simple-auth\n // });\n //\n // This is also a good place to call test setup functions coming\n // from other addons:\n //\n // setupIntl(hooks, 'en-us'); // ember-intl\n // setupMirage(hooks); // ember-cli-mirage\n}\n\nfunction setupRenderingTest(hooks: NestedHooks, options?: SetupTestOptions) {\n upstreamSetupRenderingTest(hooks, options);\n\n // Additional setup for rendering tests can be done here.\n}\n\nfunction setupTest(hooks: NestedHooks, options?: SetupTestOptions) {\n upstreamSetupTest(hooks, options);\n\n // Additional setup for unit tests can be done here.\n}\n\nexport { setupApplicationTest, setupRenderingTest, setupTest };\n" }, { "path": "test-app/tests/index.html", "content": "\n\n \n \n Dummy Tests\n \n \n\n {{content-for \"head\"}}\n {{content-for \"test-head\"}}\n\n \n \n \n\n {{content-for \"head-footer\"}}\n {{content-for \"test-head-footer\"}}\n \n \n {{content-for \"body\"}}\n {{content-for \"test-body\"}}\n\n
\n
\n
\n
\n
\n
\n\n \n \n \n \n \n\n {{content-for \"body-footer\"}}\n {{content-for \"test-body-footer\"}}\n \n\n" }, { "path": "test-app/tests/integration/.gitkeep", "content": "" }, { "path": "test-app/tests/test-helper.js", "content": "import Application from 'test-app/app';\nimport config from 'test-app/config/environment';\nimport * as QUnit from 'qunit';\nimport { setApplication } from '@ember/test-helpers';\nimport { setup } from 'qunit-dom';\nimport { start } from 'ember-qunit';\n\nsetApplication(Application.create(config.APP));\n\nsetup(QUnit.assert);\n\nstart();\n" }, { "path": "test-app/tests/test-helper.ts", "content": "import Application from 'test-app/app';\nimport config from 'test-app/config/environment';\nimport * as QUnit from 'qunit';\nimport { setApplication } from '@ember/test-helpers';\nimport { setup } from 'qunit-dom';\nimport { loadTests } from 'ember-qunit/test-loader';\nimport { start, setupEmberOnerrorValidation } from 'ember-qunit';\n\nsetApplication(Application.create(config.APP));\n\nsetup(QUnit.assert);\nsetupEmberOnerrorValidation();\nloadTests();\nstart();\n" }, { "path": "test-app/tests/unit/.gitkeep", "content": "" }, { "path": "test-app/tests/unit/services/tour-test.js", "content": "/* eslint-disable ember/no-runloop */\nimport { module, test } from 'qunit';\nimport { setupTest } from 'ember-qunit';\nimport EmberObject from '@ember/object';\nimport { run } from '@ember/runloop';\nimport { builtInButtons } from '../../data';\n\nconst steps = [\n {\n id: 'intro',\n options: {\n attachTo: {\n element: '.test-element',\n on: 'bottom',\n },\n buttons: [builtInButtons.cancel, builtInButtons.next],\n classes: 'custom-class-name-1 custom-class-name-2',\n title: 'Welcome to Ember-Shepherd!',\n text: 'Test text',\n scrollTo: true,\n scrollToHandler() {\n return 'custom scrollToHandler';\n },\n },\n },\n];\n\nmodule('Unit | Service | tour', function (hooks) {\n setupTest(hooks);\n\n test('it starts the tour when the `start` event is triggered', function (assert) {\n class mockTourObject extends EmberObject {\n start() {\n assert.ok(true, 'The tour was started');\n }\n }\n\n const service = this.owner.factoryFor('service:tour').create({\n steps,\n });\n\n service.set('tourObject', mockTourObject.create());\n\n run(function () {\n service.start();\n });\n });\n\n test('it allows another object to bind to events', function (assert) {\n class mockTourObject extends EmberObject {\n next() {}\n }\n\n const service = this.owner.factoryFor('service:tour').create({\n steps,\n });\n\n service.set('tourObject', mockTourObject.create());\n\n service.on('next', function () {\n assert.ok(true);\n });\n\n run(function () {\n service.next();\n });\n });\n\n test('it passes through a custom scrollToHandler option', function (assert) {\n class mockTourObject extends EmberObject {\n start() {\n assert.strictEqual(\n steps[0].options.scrollToHandler(),\n 'custom scrollToHandler',\n 'The handler was passed through as an option on the step',\n );\n }\n }\n\n const service = this.owner.factoryFor('service:tour').create({\n steps,\n });\n\n service.set('tourObject', mockTourObject.create());\n\n run(function () {\n service.start();\n });\n });\n});\n" }, { "path": "test-app/tests/unit/utils/make-button-test.js", "content": "import { makeButton } from 'ember-shepherd/utils/buttons';\nimport { module, test } from 'qunit';\n\nmodule('Unit | Utility | make-button', function () {\n module('Making an `action` handler for Shepherd button types', function () {\n test('returning an object with an `action` handler if a supported built-in button \"type\" is specified', async function (assert) {\n const context = {\n next() {\n assert.ok(true, 'Action was called in calling context');\n },\n };\n\n const buttonOpts = {\n type: 'next',\n classes: 'foo',\n text: 'Suivant!',\n };\n\n const button = makeButton.call(context, buttonOpts);\n\n assert.strictEqual(button.classes, buttonOpts.classes);\n assert.strictEqual(button.text, buttonOpts.text);\n\n button.action();\n });\n\n test('Throwing an error if the built-in button \"type\" specified is not supported', async function (assert) {\n const badButtonOpts = {\n type: 'cipher',\n classes: 'foo',\n text: 'Encrypt',\n };\n const goodButtonOpts = {\n type: 'next',\n classes: 'foo',\n text: 'Encrypt',\n };\n\n assert.throws(() => makeButton(badButtonOpts));\n\n assert.strictEqual(makeButton(goodButtonOpts).text, goodButtonOpts.text);\n assert.strictEqual(\n makeButton(goodButtonOpts).classes,\n goodButtonOpts.classes,\n );\n });\n });\n});\n" }, { "path": "test-app/tsconfig.json", "content": "{\n \"extends\": \"@tsconfig/ember/tsconfig.json\",\n \"glint\": {\n \"environment\": [\"ember-loose\", \"ember-template-imports\"]\n },\n \"compilerOptions\": {\n \"skipLibCheck\": true,\n \"noEmit\": true,\n \"noEmitOnError\": false,\n \"declaration\": false,\n \"declarationMap\": false,\n // The combination of `baseUrl` with `paths` allows Ember's classic package\n // layout, which is not resolvable with the Node resolution algorithm, to\n // work with TypeScript.\n \"baseUrl\": \".\",\n \"paths\": {\n \"test-app/tests/*\": [\"tests/*\"],\n \"test-app/*\": [\"app/*\"],\n \"*\": [\"types/*\"]\n },\n \"types\": [\"ember-source/types\"]\n }\n}\n" }, { "path": "test-app/types/global.d.ts", "content": "import '@glint/environment-ember-loose';\n" } ]