Run the examples against staging and fail on their errors; fix the thumbnail example

The examples step sent the staging token to the production API and passed
on 401s, because every example catches and prints its own error. A CI-only
preload now points the clients at CONVERT_API_BASE_URI and any printed error
fails the step.

pdf -> extract is now the data-extraction converter (returns JSON), so the
thumbnail example converts page 1 straight to JPG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Author: tomasr78

.github/examples-base-uri.js

@@ -0,0 +1,11 @@
+// Preloaded by CI before the examples (node --require): the examples call require('../lib')(token)
+// against the production API, so this points every client they create at CONVERT_API_BASE_URI instead.
+const lib = require.resolve('../lib');
+const ConvertAPI = require(lib);
+
+if (process.env.CONVERT_API_BASE_URI) {
+  require.cache[lib].exports = (credentials, options = {}) => ConvertAPI(
+    credentials,
+    Object.assign({ baseUri: process.env.CONVERT_API_BASE_URI }, options),
+  );
+}

.github/workflows/build.yml

@@ -64,12 +64,18 @@ jobs:
       - name: Build
         run: npm run build
 
-      # The examples catch and print their own errors, so this step shows they run against the built lib
-      # rather than gating the merge.
+      # The examples call the production API and catch and print their own errors, so the preload points
+      # them at CONVERT_API_BASE_URI and any printed error fails the step.
       - name: Run the examples
         env:
           API_TOKEN: ${{ secrets.CONVERTAPI_STAGING_TOKEN }}
-        run: npm run test:examples
+        run: |
+          set -euo pipefail
+          node --require ./.github/examples-base-uri.js examples/ 2>&1 | tee examples.log
+          if grep -q '^Error' examples.log; then
+            echo "::error::An example failed, see the errors above"
+            exit 1
+          fi
 
   build:
     name: build

CHANGELOG.md

@@ -9,6 +9,8 @@ each one is a GitHub Release `v{version}` (see [RELEASING.md](RELEASING.md)).
   closes the high and critical advisories in what `npm install convertapi` resolves, among them
   GHSA-jqh4-m9w3-8hp9, GHSA-fjxv-7rqg-78g4 and GHSA-r4q5-vmmm-2653.
 - The examples and README use an API token (`API_TOKEN`) instead of the retired secret and API key.
+- The PDF thumbnail example converts the first page straight to JPG (`PageRange: 1`), since `pdf → extract`
+  is now the data-extraction converter and returns JSON.
 - `package.json` points at the renamed repository, https://github.com/ConvertAPI/convertapi-library-node.
 - Published from GitHub Actions with npm provenance. Tested on Node.js 20, 22 and 24.
 

examples/create_pdf_thumbnail.js

@@ -3,21 +3,14 @@
 // set your api token
 var convertapi = require('../lib')(process.env.API_TOKEN);
 
-// Example of extracting first page from PDF and then chaining conversion PDF page to JPG.
-// https://www.convertapi.com/pdf-to-extract
+// Example of converting the first page of a PDF to a JPG thumbnail.
 // https://www.convertapi.com/pdf-to-jpg
 
 var dir = require('os').tmpdir();
 
-var pdfResultPromise = convertapi.convert('extract', {
-  File: './examples/files/test.pdf',
-  PageRange: 1
-});
-
 convertapi.convert('jpg', {
-    File: pdfResultPromise,
-    ScaleImage: true,
-    ScaleProportions: true,
+    File: './examples/files/test.pdf',
+    PageRange: 1,
     ImageHeight: 300,
     ImageWidth: 300
   })