POLAR@3

.editorconfig

@@ -1,4 +1,15 @@
-[*.{js,ts,vue,json}]
+[*.{js,ts,vue,json,html,css}]
+indent_style = tab
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.yaml]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[vue2/*.{js,ts,vue,json}]
 indent_style = space
 indent_size = 2
 trim_trailing_whitespace = true

.env

@@ -0,0 +1 @@
+VITE_DEV_LANDING=""

.github/CODEOWNERS

@@ -1 +1 @@
-/packages @warm-coolguy @dopenguin @oeninghe-dataport
+* @warm-coolguy @dopenguin @oeninghe-dataport

.github/workflows/preview.yaml

@@ -0,0 +1,54 @@
+name: Deploy PR previews
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
+
+permissions:
+  contents: write
+  pull-requests: write
+
+concurrency: preview-${{ github.ref }}
+
+jobs:
+  deploy-preview:
+    name: Create deployment preview
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+
+      - name: Set up Node.js
+        if: github.event.action != 'closed'
+        uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f
+        with:
+          node-version: 24.12.0
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install documentation build dependencies
+        run: sudo apt install mkdocs mkdocs-material
+
+      - name: Install NPM dependencies
+        run: npm ci
+
+      - name: Build preview
+        run: |
+          npm run build:ci
+          npm run preview:build:ci -- --base="./"
+
+      - name: Build documentation
+        run: |
+          npm run docs:ci
+          mv docs-html ./.dist.preview/docs-html
+
+      - name: Deploy preview to GitHub Pages
+        uses: rossjrw/pr-preview-action@5fd5f8e2f88e735fc3d1151302b32242037e3962
+        with:
+          source-dir: ./.dist.preview/
+          preview-branch: gh-pages
+          qr-code: true
+          wait-for-pages-deployment: false

.github/workflows/publish-packages.yml

@@ -1,45 +1,35 @@
-name: Publish packages with updated changelog to npmjs.org
+name: Publish @polar/polar to NPM registry
 
 on:
   push:
-    branches:
-      - main
+    tags:
+      - v*
 
 jobs:
   publish:
+    name: Publish package @polar/polar
     runs-on: ubuntu-latest
-    outputs:
-      matrix: ${{ steps.matrix.outputs.TAGS }}
     steps:
-      - uses: actions/checkout@v4
-        with:
-          ssh-key: ${{ secrets.MAIN_BOT_KEY_PRIVATE }}
-      - uses: actions/setup-node@v4
+      - name: Checkout repository
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+
+      - name: Set up Node.js
+        uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f
         with:
-          node-version: 20.16.0
+          node-version: 24.12.0
           registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: |
-          RETURN_TAGS=$(node ./scripts/versionPackages)
-          echo "TAGS=$RETURN_TAGS" >> $GITHUB_ENV
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - uses: EndBug/add-and-commit@v9
-        with:
-          author_name: Dataport Geo Bot
-          author_email: polar@dataport.de
-      - run: |
-          for TAG in ${{ env.TAGS }}
-          do
-            git config user.name "Dataport Geo Bot"
-            git config user.email "polar@dataport.de"
-            git tag $TAG
-            git push origin $TAG
-            echo "Released and tagged $TAG"
-          done
-      - run: node ./scripts/publishPackages ${{ env.TAGS }}
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build package
+        run: npm run build:ci
+
+      - name: Publish to NPM
+        run: npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - run: node ./scripts/createRelease ${{ env.TAGS }}
+
+      - name: Create GitHub release
+        run: node scripts/create-github-release.ts
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/publish-pages-next.yml

@@ -0,0 +1,40 @@
+name: Publish bleeding-edge documentation to gh-pages/next
+
+on:
+  push:
+    branches:
+      - next
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    name: Deploy documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+
+      - name: Set up Node.js
+        uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f
+        with:
+          node-version: 24.12.0
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install documentation build dependencies
+        run: |
+          sudo apt update
+          sudo apt install mkdocs mkdocs-material
+
+      - name: Install NPM dependencies
+        run: npm ci
+
+      - name: Build documentation
+        run: npm run docs:ci
+
+      - name: Deploy documentation to gh-pages/next
+        uses: JamesIves/github-pages-deploy-action@4a3abc783e1a24aeb44c16e869ad83caf6b4cc23
+        with:
+          folder: docs-html
+          target-folder: next

.github/workflows/run-tests.yaml

@@ -0,0 +1,57 @@
+name: Run automated tests
+on: push
+
+jobs:
+  lint:
+    name: Linting
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+
+      - name: Set up Node.js
+        uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f
+        with:
+          node-version: 24.12.0
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install dependencies and run linter
+        run: |
+          npm ci
+          npm run lint:ci
+
+  test:
+    name: Unit tests and e2e tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+
+      - name: Set up Node.js
+        uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f
+        with:
+          node-version: 24.12.0
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install dependencies and run tests
+        run: |
+          npm ci
+          npm run test:ci
+
+  type-check:
+    name: Type-checking
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+
+      - name: Set up Node.js
+        uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f
+        with:
+          node-version: 24.12.0
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install dependencies and run type-checking
+        run: |
+          npm ci
+          npm run tsc:ci

.gitignore

@@ -1,10 +1,19 @@
+node_modules
+.eslintcache
+
+git-hooks.config.json
+
+/docs-html
+.dist.preview
+.vscode/settings.json
+
+# Old gitignore, maybe cleanup when migrated
 **/.eslintcache
 **/*.tgz
 **/.cache
 **/coverage
 **/dist
 **/dist-test
-**/docs
 **/node_modules
 **/tests_output
 **/test-results/
@@ -17,3 +26,7 @@
 /public
 logs/*.log
 logs
+*.patch
+!/patches/**/*.patch
+
+.DS_Store

.husky/commit-msg

@@ -0,0 +1,20 @@
+#!/bin/sh
+set -e
+eval `node .husky/prepareConfig.js`
+if [ "$POLAR_SKIP_COMMIT_MSG" = "yes" ]
+then
+	exit 0
+fi
+
+if [ "$POLAR_LINT_COMMIT_MESSAGE" = "yes" ]
+then
+	if ! npx --no -- commitlint --edit $1
+	then
+		echo "Cannot commit: Invalid commit message." >&2
+		echo "Please edit your commit message appropriately." >&2
+		echo >&2
+		echo "If you want to commit anyway, set POLAR_LINT_COMMIT_MESSAGE=no" >&2
+		echo "If you want to skip all commit-msg checks, set POLAR_SKIP_COMMIT_MSG=yes" >&2
+		exit 1
+	fi
+fi