Chore: Release/1.0.0

.eslintignore

@@ -2,4 +2,5 @@ coverage/
 dist/
 node_modules/
 examples/
+docs/
 webpack.config.js

.eslintrc

@@ -33,7 +33,8 @@
       {
         "singleQuote": true,
         "trailingComma": "all",
-        "printWidth": 120
+        "printWidth": 120,
+        "endOfLine": "auto"
       }
     ],
     "brace-style": ["error", "1tbs"],
@@ -52,6 +53,7 @@
     ],
     "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/no-unsafe-function-type": "off",
     "@typescript-eslint/ban-ts-comment": "off",
     "@typescript-eslint/ban-types": "off",
     "jest/no-standalone-expect": "off",

.github/workflows/build.yml

@@ -6,10 +6,11 @@ jobs:
   build_and_test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
         with:
-          node-version: "16.x"
+          node-version: 22
+          cache: npm
 
       - name: 'Install'
         run: npm ci

.github/workflows/docs.yml

@@ -0,0 +1,83 @@
+name: Deploy docs to GitHub Pages
+
+on:
+  push:
+    # NOTE: `new/add-docs-page` is a TEMPORARY entry so the team can review a live
+    # deploy from the docs branch. Remove it before/at merge so main deploys only
+    # from main.
+    branches: [main]
+  # Validate the bundle + docs build on any PR that touches them, so reviewers
+  # get a green check without needing Pages enabled or a merge to main. The
+  # deploy job below is skipped for PRs.
+  pull_request:
+    paths:
+      - "docs/site/**"
+      - "src/**"
+      - ".github/workflows/docs.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# One deploy at a time, but keep PR builds from cancelling a main deploy (and
+# vice versa) by scoping the group per ref.
+concurrency:
+  group: pages-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-node@v5
+        with:
+          node-version: 22
+          cache: npm
+
+      # 1. Build the Orb browser bundle from source so the live demos stay in sync.
+      - name: Build Orb bundle
+        run: |
+          npm ci
+          npm run build:release
+
+      # 2. Refresh the copies the docs site embeds.
+      - name: Sync bundle into docs site
+        run: |
+          cp dist/browser/orb.min.js docs/site/public/orb.min.js
+          cp dist/browser/orb.worker.min.js docs/site/public/orb.worker.min.js
+          # The module worker loads this shared vendor chunk as a sibling; without
+          # it the worker fails silently and layout simulation never runs.
+          cp dist/browser/orb.worker.vendor.min.js docs/site/public/orb.worker.vendor.min.js
+
+      # 3. Build the VitePress site.
+      - name: Build docs
+        working-directory: docs/site
+        run: |
+          npm install
+          npm run build
+
+      # 4. Package for Pages. Only needed for an actual deploy, so skip on PRs
+      #    (where these steps would also fail until Pages is enabled).
+      - uses: actions/configure-pages@v5
+        if: github.event_name != 'pull_request'
+
+      - uses: actions/upload-pages-artifact@v3
+        if: github.event_name != 'pull_request'
+        with:
+          path: docs/site/.vitepress/dist
+
+  deploy:
+    needs: build
+    # Deploy only from main; PRs run the build job above for validation only.
+    if: github.event_name != 'pull_request'
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/release.yml

@@ -8,21 +8,35 @@ on:
 jobs:
   publish:
     runs-on: ubuntu-latest
-    if: github.repository == 'memgraph/orb'
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+      # Required for npm trusted publishing (OIDC) and provenance
+      id-token: write
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v5
         with:
-          node-version: "16.x"
+          # semantic-release needs full history + tags to compute the next version
+          fetch-depth: 0
+      - uses: actions/setup-node@v5
+        with:
+          node-version: 22
+          cache: npm
+
+      # npm >= 11.5 is required for trusted publishing; Node 22 ships npm 10
+      - name: 'Update npm'
+        run: npm install -g npm@latest
 
       - name: 'Install'
         run: npm ci
       - name: 'Lint'
         run: npm run lint
       - name: 'Build'
         run: npm run build:release
+      - name: 'Test'
+        run: npm run test
       - name: 'Release'
         run: npm run release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -6,6 +6,7 @@ node_modules/
 
 # IDEs and editors
 .idea/
+.vscode/
 
 # Optional npm cache directory
 .npm

.husky/commit-msg

@@ -1,5 +1,3 @@
-#!/usr/bin/env sh
 [ -n "$CI" ] && exit 0
-. "$(dirname -- "$0")/_/husky.sh"
 
 npx --no-install commitlint --edit $1

.husky/pre-commit

@@ -1,5 +1,3 @@
-#!/bin/sh
 [ -n "$CI" ] && exit 0
-. "$(dirname "$0")/_/husky.sh"
 
-npm run lint
+npm run lint

.releaserc

@@ -1,4 +1,5 @@
 {
+  "branches": ["main"],
   "plugins": [
     ["@semantic-release/commit-analyzer", {
       "preset": "eslint"
@@ -8,10 +9,10 @@
     }],
     "@semantic-release/changelog",
     "@semantic-release/npm",
-    '@semantic-release/github',
+    "@semantic-release/github",
     ["@semantic-release/git", {
       "assets": ["package.json", "CHANGELOG.md"],
       "message": "Chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-    }],
-  ],
+    }]
+  ]
 }