v3.0.0 (#6)

* storage user id constraint, only deserialize if 200

* fix readme badge workflow links

* integrate DataGridVueDotnet docs

* v3 wip

* update workflows to use pnpm

* add .npmrc

* fix path casing

* remove extra docs folder around vuepress site

* update example api domain

* fix docs site dev run

* couple more documentation links

* doc site theme update and pwa support

* add development environment notes to readme

* update gitignore

* Improved default layout styles of custom column filters set using the filter-{fieldName} slot.

* ensure updated generated markdown files are comitted

* footer slots and suffix Async to public async methods

* #4 accessibility improvements

* add/remove columns accessibility

* keep focused header focused when using arrow keys to reorder

* add grid id to server side storage requests

* add loading spinner

* update features

* update dotnet docs

.github/workflows/ci_cd.yml

@@ -4,9 +4,6 @@ on:
   push:
     branches: [ "**" ]
 
-permissions:
-  id-token: write
-
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -15,14 +12,14 @@ jobs:
         node-version: [18.x]
     steps:
     - uses: actions/checkout@v4
+    - name: Install pnpm
+      uses: pnpm/action-setup@v2
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-        registry-url: 'https://registry.npmjs.org'
-    - run: npm ci
-    - run: npm run build
+        cache: 'pnpm'
+    - run: pnpm run ci-all
 
   newVersion:
     needs: build
@@ -39,16 +36,34 @@ jobs:
 
   publish:
     needs: newVersion
-    if: ${{ needs.newVersion.outputs.version-updated }}
+    if: ${{ needs.newVersion.outputs.versionUpdated }}
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
     steps:
-      - run: npm publish --provenance
+      - run: pnpm publish --access public --no-git-checks
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-  tag:
-    needs: [publish, newVersion]
+          NPM_CONFIG_PROVENANCE: true
+
+  create_release:
     runs-on: ubuntu-latest
+    needs: [publish, newVersion]
+    permissions:
+      contents: write
+    env:
+      ESCAPED_VERSION: ''
     steps:
-      - run: git tag v${{ needs.newVersion.outputs.version }}
-      - run: git push --tags
+      - uses: actions/checkout@v4
+      - name: Escape version
+        run: echo "ESCAPED_VERSION=$(echo "${{ needs.newVersion.outputs.version }}" | sed 's/[^^]/[&]/g; s/\^/\\^/g')" >> $GITHUB_ENV
+      - name: Parse release notes
+        run: (grep -Pzo '(?<=### v${{ env.ESCAPED_VERSION }}\n)\X+?(?=\n\n)' ./vuepress/docs/shared/changelog.md)) | tr -d '\0' > release_notes.txt
+      - name: Create release
+        uses: actions/create-release@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: v${{ needs.newVersion.outputs.version }}
+          release_name: v${{ needs.newVersion.outputs.version }}
+          body_path: ${{ github.workspace }}/release_notes.txt

.github/workflows/docs_ci_cd.yml

@@ -12,35 +12,26 @@ jobs:
   build_and_deploy_job:
     runs-on: ubuntu-latest
     name: Build and Deploy Job
-    defaults:
-      run:
-        working-directory: ./vuepress
-
     strategy:
       matrix:
-        node-version: [18.x]
-
+        node-version: [18.x]        
     steps:
-      - uses: actions/checkout@v3
-        with:
-          submodules: true
-          lfs: false
+      - uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-          cache: 'npm'
-      - run: npm i
-      - run: npm run docs:build
+          cache: 'pnpm'
+      - run: pnpm i --filter './vuepress'
+      - run: pnpm run docs:build
       - name: Deploy
         id: builddeploy
         uses: Azure/static-web-apps-deploy@v1
         with:
           azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_WHITE_GRASS_07FF9650F }}
-          repo_token: ${{ secrets.GITHUB_TOKEN }} # Used for Github integrations (i.e. PR comments)
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
           action: "upload"
-          ###### Repository/Build Configurations - These values can be configured to match your app requirements. ######
-          # For more information regarding Static Web App workflow configurations, please visit: https://aka.ms/swaworkflowconfig
-          app_location: "/vuepress/docs/.vuepress/dist"
+          app_location: "/vuepress/.vuepress/dist"
           skip_app_build: true
-          ###### End of Repository/Build Configurations ######

.gitignore

@@ -32,5 +32,9 @@ coverage
 vuepress-cache
 vuepress-temp
 
-typedoc-vue.js
+
+/scripts/**/*.js
+
 sitemap.xml
+
+*.tsbuildinfo

.husky/pre-commit

@@ -1,10 +1,11 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npx lint-staged
-npm run compile-readme
+pnpm exec lint-staged
+pnpm compile-readme
 git add README.md
-npm run typedoc
-git add typedoc-out.json
+pnpm typedoc
+git add ./scripts/typedoc/typedoc-out.json
+git add ./vuepress/generated/*
 
-exec git diff --cached --name-only | npx cspell --no-summary --no-progress --no-must-find-files --file-list stdin
+exec git diff --cached --name-only | pnpm exec cspell --no-summary --no-progress --no-must-find-files --file-list stdin

.ncurc.js

@@ -0,0 +1,27 @@
+module.exports = {
+  filter,
+  target,
+  root: true,
+  workspaces: ["vuepress", "dev-app"],
+  format: "group",
+}
+
+const allowNewestPatterns = [
+  /vuepress/,
+  /^typedoc-plugin-markdown$/,
+]
+
+function filter(name, semver) {
+  if (name === '@types/node') {
+    // lock to node 18
+    return semver[0].major === 18
+  }
+  return true
+}
+
+function target(name, semver) {
+  if (allowNewestPatterns.some(pattern => pattern.test(name))) {
+    return 'newest'
+  }
+  return 'latest'
+}

.npmrc

@@ -0,0 +1,3 @@
+registry = https://registry.npmjs.org/
+recursive-install = true
+include-workspace-root = true

.vscode/extensions.json

@@ -1,3 +1,3 @@
 {
-  "recommendations": ["Vue.volar", "Vue.vscode-typescript-vue-plugin"]
+  "recommendations": ["Vue.volar", "Vue.vscode-typescript-vue-plugin", "streetsidesoftware.code-spell-checker"]
 }

.vscode/launch.json

@@ -2,7 +2,7 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "command": "npm run typedoc",
+      "command": "pnpm run typedoc",
       "name": "Debug typedoc",
       "request": "launch",
       "type": "node-terminal"

.vscode/settings.json

@@ -4,8 +4,5 @@
   "editor.insertSpaces": true,
   "editor.detectIndentation": true,
   "editor.tabSize": 2,
-  "editor.indentSize": "tabSize",
-  "[xml]": {
-    "editor.defaultFormatter": "redhat.vscode-xml"
-  }
+  "editor.indentSize": "tabSize"
 }