feat: add docs website

.changeset/two-buckets-cheer.md

@@ -0,0 +1,6 @@
+---
+"@hyperse/track-docs": patch
+"@hyperse/track": patch
+---
+
+add docs website

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Something not working as it should
+title: ""
+labels: "type: bug \U0001F41B"
+assignees: tianyingchun
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Environment (please complete the following information):**
+
+- @hyperse/track version:
+- Nodejs version
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ""
+labels: ""
+assignees: ""
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/gh-pages.yml

@@ -0,0 +1,48 @@
+name: github pages
+
+on:
+  push:
+    branches: 
+      - main  # Set a branch name to trigger deployment
+    paths:
+      - '.github/workflows/gh-pages.yml'
+      - 'website/**'
+  pull_request:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    defaults:
+      run:
+        working-directory: website
+    strategy:
+      matrix:
+        node-version: [20.x]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: 📥 Install Dependencies
+        run: yarn --frozen-lockfile
+
+      - name: Build
+        run: |
+          yarn build
+
+      - name: Unit tests
+        run: |
+          yarn test
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v4
+        if: github.ref == 'refs/heads/main'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./website/build

.yarnrc.yml

@@ -4,4 +4,4 @@ enableGlobalCache: false
 
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-4.3.0.cjs
+yarnPath: .yarn/releases/yarn-4.3.1.cjs

package.json

@@ -9,7 +9,8 @@
     "pipe",
     "track engine",
     "google track",
-    "facebook track"
+    "facebook track",
+    "klaviyo track"
   ],
   "repository": {
     "type": "git",
@@ -29,6 +30,10 @@
     "./dist/",
     "./index.js"
   ],
+  "workspaces": [
+    "website",
+    "./"
+  ],
   "scripts": {
     "build": "tsup",
     "lint": "eslint .",
@@ -54,28 +59,28 @@
   },
   "devDependencies": {
     "@changesets/changelog-github": "0.5.0",
-    "@changesets/cli": "2.27.6",
+    "@changesets/cli": "2.27.7",
     "@commitlint/cli": "19.3.0",
     "@commitlint/config-conventional": "19.2.2",
-    "@hyperse/eslint-config-hyperse": "^1.0.10",
-    "@hyperse/exec-program": "^1.0.6",
+    "@hyperse/eslint-config-hyperse": "^1.0.12",
+    "@hyperse/exec-program": "^1.0.10",
     "@types/lodash": "^4",
-    "@types/node": "^20.14.9",
+    "@types/node": "^22.1.0",
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
     "@vitest/coverage-istanbul": "^2.0.5",
     "@vitest/ui": "^2.0.5",
     "commitizen": "4.3.0",
     "cz-conventional-changelog": "3.3.0",
-    "eslint": "^9.6.0",
-    "husky": "9.0.11",
-    "lint-staged": "15.2.7",
-    "next": "14.2.4",
+    "eslint": "^9.8.0",
+    "husky": "9.1.4",
+    "lint-staged": "15.2.8",
+    "next": "14.2.5",
     "npm-run-all": "^4.1.5",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
-    "tsup": "^8.1.0",
-    "typescript": "^5.5.2",
+    "tsup": "^8.2.4",
+    "typescript": "^5.5.4",
     "vite": "^5.3.5",
     "vitest": "^2.0.5"
   },
@@ -85,5 +90,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "packageManager": "[email protected].0"
+  "packageManager": "[email protected].1"
 }

tsconfig.json

@@ -5,7 +5,9 @@
     "rootDir": ".",
     "outDir": "dist",
     "types": ["vitest/globals"],
-    "paths": {},
+    "paths": {
+      "@/*": ["./src/*"]
+    },
     "lib": ["dom", "dom.iterable", "esnext"],
     "isolatedModules": true,
     "jsx": "preserve"

vitest.config.ts

@@ -1,20 +1,13 @@
-import { fileURLToPath } from 'url';
 import { configDefaults, defineConfig } from 'vitest/config';
 
 export default defineConfig({
   test: {
     globals: true,
-    testTimeout: 100000000,
+    testTimeout: 100000,
     exclude: [...configDefaults.exclude],
     alias: {
-      '~/': fileURLToPath(new URL('./src/', import.meta.url)),
+      '@/': new URL('./src/', import.meta.url).pathname,
     },
     include: ['**/?(*.){test,spec}.?(c|m)[jt]s?(x)'],
-    coverage: {
-      provider: 'istanbul',
-      reporter: ['html'],
-      include: ['src/**'],
-      enabled: true,
-    },
   },
 });

website/.gitignore

@@ -0,0 +1,135 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+.netrc
+.env
+.env.*
+build

website/CHANGELOG.md

@@ -0,0 +1 @@
+# @hyperse/track-docs