Merge pull request #2 from PSPDFKit-labs/fix/html-input-conversion

chore: add changelog-driven npm + GitHub release workflow

Author: jdrhyne

.github/workflows/release.yml

@@ -0,0 +1,56 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: "https://registry.npmjs.org"
+          cache: "pnpm"
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Install
+        run: pnpm install --frozen-lockfile
+
+      - name: Validate
+        run: |
+          pnpm run lint
+          pnpm test
+
+      - name: Verify tag matches package version
+        run: |
+          TAG_VERSION="${GITHUB_REF_NAME#v}"
+          PKG_VERSION=$(node -e "const fs=require('fs');const p=JSON.parse(fs.readFileSync('package.json','utf8'));process.stdout.write(p.version)")
+          if [ "$TAG_VERSION" != "$PKG_VERSION" ]; then
+            echo "Tag version ($TAG_VERSION) does not match package.json version ($PKG_VERSION)"
+            exit 1
+          fi
+
+      - name: Publish npm package
+        run: npm publish --access public --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true

CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on Keep a Changelog, and this project follows Semantic Versioning.
+
+## [Unreleased]
+
+### Added
+- GitHub tag-based release workflow for automated npm publish and GitHub release creation.
+- Release runbook (`RELEASING.md`) and version sync script for plugin manifest consistency.
+
+## [0.1.1] - 2026-02-28
+
+### Fixed
+- Normalized `nutrient_extract_text.language` schema to avoid OpenClaw schema validation errors (`array schema missing items`).
+- Preserved multi-language OCR support by accepting comma-separated language strings.
+- Added support for HTML inputs in `nutrient_convert_to_pdf`.
+
+### Changed
+- Simplified request `User-Agent` to `NutrientOpenClawPlugin` to avoid hardcoded version churn in code/tests.
+
+## [0.1.0] - 2026-02-04
+
+### Added
+- Initial release of `@nutrient-sdk/nutrient-openclaw`.
+- Core tools: conversion, extraction, OCR, redaction, signing, watermarking, and credits checks.

RELEASING.md

@@ -0,0 +1,44 @@
+# Releasing
+
+This repository uses npm + GitHub tags for releases.
+
+## Prerequisites
+
+- Push access to `PSPDFKit-labs/nutrient-openclaw`
+- npm publish access to `@nutrient-sdk/nutrient-openclaw`
+- `NPM_TOKEN` configured in GitHub repo secrets (automation token)
+
+## Release Flow
+
+1. Ensure `main` is clean and up to date.
+2. Update `CHANGELOG.md`:
+   - Move relevant items from `Unreleased` into a new version section.
+   - Keep entries concise and user-visible.
+3. Bump version and create tag:
+
+```bash
+npm version patch
+```
+
+This runs:
+- `preversion`: lint + tests
+- `version`: syncs `openclaw.plugin.json` version to match `package.json`
+
+4. Push commit and tag:
+
+```bash
+git push origin main
+git push origin --tags
+```
+
+5. GitHub Actions release workflow runs on tag `v*.*.*`:
+   - installs dependencies
+   - runs lint + tests
+   - verifies tag matches `package.json` version
+   - publishes to npm with provenance
+   - creates GitHub release
+
+## Notes
+
+- If you need a non-patch release, use `npm version minor` or `npm version major`.
+- If the workflow fails at publish, verify `NPM_TOKEN` permissions for the `@nutrient-sdk` scope.

openclaw.plugin.json

@@ -2,7 +2,7 @@
   "id": "nutrient-openclaw",
   "name": "Nutrient Document Processing",
   "description": "Process, convert, sign, redact, OCR, and extract data from documents via the Nutrient DWS API.",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "repository": "github:PSPDFKit-labs/nutrient-openclaw",
   "configSchema": {
     "type": "object",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nutrient-sdk/nutrient-openclaw",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "OpenClaw plugin for document processing via Nutrient DWS API",
   "license": "MIT",
   "repository": {
@@ -20,6 +20,10 @@
     "test": "vitest run",
     "test:watch": "vitest",
     "lint": "tsc --noEmit",
+    "sync:version": "node ./scripts/sync-version.mjs",
+    "release:check": "npm run lint && npm test",
+    "preversion": "npm run release:check",
+    "version": "npm run sync:version && git add openclaw.plugin.json",
     "prepublishOnly": "npm run build && npm run test"
   },
   "openclaw": {

scripts/sync-version.mjs

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+
+import fs from 'node:fs';
+import path from 'node:path';
+
+const root = process.cwd();
+const packagePath = path.join(root, 'package.json');
+const pluginPath = path.join(root, 'openclaw.plugin.json');
+
+const pkg = JSON.parse(fs.readFileSync(packagePath, 'utf8'));
+const plugin = JSON.parse(fs.readFileSync(pluginPath, 'utf8'));
+
+if (!pkg.version || typeof pkg.version !== 'string') {
+  throw new Error('package.json version is missing or invalid');
+}
+
+if (plugin.version === pkg.version) {
+  console.log(`openclaw.plugin.json already matches version ${pkg.version}`);
+  process.exit(0);
+}
+
+plugin.version = pkg.version;
+fs.writeFileSync(pluginPath, `${JSON.stringify(plugin, null, 2)}\n`);
+console.log(`Synced openclaw.plugin.json version -> ${pkg.version}`);

src/client.ts

@@ -12,13 +12,14 @@ import type { NutrientClient, NutrientResponse } from './types.js';
 const API_BASE = 'https://api.nutrient.io';
 const CREDIT_USAGE_HEADER = 'x-pspdfkit-credit-usage';
 const REMAINING_CREDITS_HEADER = 'x-pspdfkit-remaining-credits';
+const USER_AGENT = 'NutrientOpenClawPlugin';
 
 /**
  * Create an HTTP client bound to a specific API key.
  *
  * Every request includes:
  * - `Authorization: Bearer <apiKey>`
- * - `User-Agent: NutrientOpenClawPlugin/0.1.0`
+ * - `User-Agent: NutrientOpenClawPlugin`
  *
  * Credit headers (`x-pspdfkit-credit-usage`, `x-pspdfkit-remaining-credits`)
  * are extracted from every response and returned in the `NutrientResponse`.
@@ -33,7 +34,7 @@ export function makeClient(apiKey: string): NutrientClient {
       const url = `${API_BASE}/${endpoint}`;
       const headers: Record<string, string> = {
         Authorization: `Bearer ${apiKey}`,
-        'User-Agent': 'NutrientOpenClawPlugin/0.1.0',
+        'User-Agent': USER_AGENT,
       };
 
       const isFormData = body instanceof FormData;

test/client.test.ts

@@ -50,7 +50,7 @@ describe('makeClient', () => {
     await client.post('build', {});
 
     const call = (globalThis.fetch as ReturnType<typeof vi.fn>).mock.calls[0];
-    expect(call[1].headers['User-Agent']).toBe('NutrientOpenClawPlugin/0.1.0');
+    expect(call[1].headers['User-Agent']).toBe('NutrientOpenClawPlugin');
   });
 
   it('sends Content-Type: application/json for object bodies', async () => {