@apiverve/pdfpagenumbers 0.0.0-stage → 1.2.2

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 APIVerve and EvlarSoft LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,210 @@
-# Temporary Holding Version
+# PDF Page Numbers API
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+PDF Page Numbers stamps a page number on every page of a PDF, uploaded or fetched from a URL, and returns a download link to the numbered file. Choose the corner or edge and the font size. Paid plans can also set a label format such as Page 3 of 12, the starting number, and skip a cover page.
+
+[![npm version](https://img.shields.io/npm/v/@apiverve/pdfpagenumbers.svg)](https://www.npmjs.com/package/@apiverve/pdfpagenumbers)
+
+This is a JavaScript wrapper for the [PDF Page Numbers API](https://apiverve.com/marketplace/pdfpagenumbers?utm_source=npm&utm_medium=referral&utm_content=readme)
+
+---
+
+## Installation
+
+Using npm:
+```shell
+npm install @apiverve/pdfpagenumbers
+```
+
+Using yarn:
+```shell
+yarn add @apiverve/pdfpagenumbers
+```
+
+---
+
+## Configuration
+
+Before using the PDF Page Numbers API client, you have to setup your account and obtain your API Key.
+You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=npm&utm_medium=referral&utm_content=readme)
+
+---
+
+## Quick Start
+
+[Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart?utm_source=npm&utm_medium=referral&utm_content=readme)
+
+The PDF Page Numbers API documentation is found here: [https://docs.apiverve.com/ref/pdfpagenumbers](https://docs.apiverve.com/ref/pdfpagenumbers?utm_source=npm&utm_medium=referral&utm_content=readme).
+You can find parameters, example responses, and status codes documented here.
+
+### Setup
+
+```javascript
+const pdfpagenumbersAPI = require('@apiverve/pdfpagenumbers');
+const api = new pdfpagenumbersAPI({
+    api_key: '[YOUR_API_KEY]'
+});
+```
+
+---
+
+## Usage
+
+### File Upload
+
+This API requires a file upload. Use `executeWithFile()` to upload files:
+
+```javascript
+// Upload a file (path, Buffer, or ReadStream)
+api.executeWithFile('/path/to/file.pdf', options, callback);
+```
+
+**Accepted file types:** .pdf
+**Maximum file size:** 10 MB
+
+### Available Parameters
+
+Pass additional parameters via `options.fields`:
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `position` | string | Where to place the number |
+| `fontSize` | number | Font size in points, from 6 to 36 |
+| `format` | string | Label template containing {page}, and optionally {total}, such as Page {page} of {total} |
+| `startAt` | integer | Number for the first numbered page |
+| `skipFirst` | boolean | Leave the first page (a cover) unnumbered |
+
+```javascript
+api.executeWithFile('/path/to/file', {
+    fields: {
+        position: 'bottom-center',
+        fontSize: 10,
+        format: 'Page {page} of {total}',
+        startAt: 1,
+        skipFirst: 'skipFirst'
+    }
+});
+```
+
+---
+
+### Perform Request
+
+Using the API is simple. All you have to do is make a request. The API will return a response with the data you requested.
+
+```javascript
+// This API requires a file upload
+// You can pass a file path, Buffer, or ReadStream
+var filePath = '/path/to/pdf.pdf';
+
+api.executeWithFile(filePath,
+    {
+        fields: {
+        position: 'bottom-center',
+        fontSize: 10,
+        format: 'Page {page} of {total}',
+        startAt: 1,
+        skipFirst: 'skipFirst'
+        }
+    }, function (error, data) {
+    if (error) {
+        return console.error(error);
+    } else {
+        console.log(data);
+    }
+});
+```
+
+---
+
+### Using Promises
+
+You can also use promises to make requests. The API returns a promise that you can use to handle the response.
+
+```javascript
+// This API requires a file upload
+// You can pass a file path, Buffer, or ReadStream
+var filePath = '/path/to/pdf.pdf';
+
+api.executeWithFile(filePath, { fields: { /* parameters */ } })
+    .then(data => {
+        console.log(data);
+    })
+    .catch(error => {
+        console.error(error);
+    });
+```
+
+---
+
+### Using Async/Await
+
+You can also use async/await to make requests. The API returns a promise that you can use to handle the response.
+
+```javascript
+async function makeRequest() {
+    // This API requires a file upload
+// You can pass a file path, Buffer, or ReadStream
+var filePath = '/path/to/pdf.pdf';
+
+    try {
+        const data = await api.executeWithFile(filePath, { fields: { /* parameters */ } });
+        console.log(data);
+    } catch (error) {
+        console.error(error);
+    }
+}
+```
+
+---
+
+## Example Response
+
+```json
+{
+  "status": "ok",
+  "error": null,
+  "data": {
+    "pdfName": "5c9f95f9-9719-47c3-a923-be3bc1f1dc91.pdf",
+    "pageCount": 2,
+    "numberedPages": 2,
+    "position": "bottom-center",
+    "format": "Page {page} of {total}",
+    "startAt": 1,
+    "lastLabel": "Page 2 of 2",
+    "size": 6218,
+    "expires": 1792230037933,
+    "downloadURL": "https://storage.googleapis.com/apiverve/APIData/pdfpagenumbers/5c9f95f9-9719-47c3-a923-be3bc1f1dc91.pdf?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1792230037&Signature=a2sCOtSuSIIEWobe8wq5iHcCdqlJMXhrHE9ewxXsf7qrNBK3NHtxrQYk%2Fn1Jpr08aQBVtJclbKX6CFqRigV2IL4suv%2F%2B8WF9LRX%2BhY%2Frhvkw9RfdydlsvALhpPxnxv547eShgBIsuwvEOPFry%2F1J%2FCvt3X%2BT8Iwpz9EtJJVKH8C3u8u26%2FlNjj7XcRCqx6hcVIWvkJEVuZfMQUjlcbtF4IOwvITwlIQW9ChPzMIlXdXu2amBIy9PinQoKsdVopBfTre4W%2BTH6%2BgynWlvnJAHmxM6mWdfLQxTjCyFzdT4ZmJuq%2BRM36d41N62KxiTGyP1cs0YJECt36nI3a7FTzUOrA%3D%3D"
+  }
+}
+```
+
+---
+
+## Customer Support
+
+Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=npm&utm_medium=referral&utm_content=readme).
+
+---
+
+## Updates
+
+Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
+
+---
+
+## Legal
+
+All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=npm&utm_medium=referral&utm_content=readme) and [Privacy Policy](https://apiverve.com/privacy?utm_source=npm&utm_medium=referral&utm_content=readme).
+
+---
+
+## License
+Licensed under the MIT License (MIT)
+
+Copyright (©) 2026 APIVerve, and EvlarSoft LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/index.d.ts

@@ -0,0 +1,47 @@
+declare module '@apiverve/pdfpagenumbers' {
+  export interface pdfpagenumbersOptions {
+    api_key: string;
+    secure?: boolean;
+  }
+
+  /**
+   * Describes fields the current plan does not unlock. Locked fields arrive as null
+   * in `data`; `locked_fields` names them, using dot paths for nested fields.
+   * Absent when the plan unlocks everything.
+   */
+  export interface PremiumInfo {
+    message: string;
+    upgrade_url: string;
+    locked_fields: string[];
+  }
+
+  export interface pdfpagenumbersResponse {
+    status: string;
+    error: string | null;
+    data: PDFPageNumbersData;
+    code?: number;
+    premium?: PremiumInfo;
+  }
+
+
+  interface PDFPageNumbersData {
+      pdfName:       null | string;
+      pageCount:     number | null;
+      numberedPages: number | null;
+      position:      null | string;
+      format:        null | string;
+      startAt:       number | null;
+      lastLabel:     null | string;
+      size:          number | null;
+      expires:       number | null;
+      downloadURL:   null | string;
+  }
+
+  export default class pdfpagenumbersWrapper {
+    constructor(options: pdfpagenumbersOptions);
+
+    execute(callback: (error: any, data: pdfpagenumbersResponse | null) => void): Promise<pdfpagenumbersResponse>;
+    execute(query: Record<string, any>, callback: (error: any, data: pdfpagenumbersResponse | null) => void): Promise<pdfpagenumbersResponse>;
+    execute(query?: Record<string, any>): Promise<pdfpagenumbersResponse>;
+  }
+}

package/index.js

@@ -0,0 +1,325 @@
+const axios = require('axios');
+
+class pdfpagenumbersWrapper {
+
+    constructor(options) {
+        if (!options || typeof options !== 'object') {
+            throw new Error('Options object must be provided. See documentation: https://docs.apiverve.com/ref/pdfpagenumbers');
+        }
+
+        const { api_key, secure = true } = options;
+
+        if (!api_key || typeof api_key !== 'string') {
+            throw new Error('API key must be provided as a non-empty string. Get your API key at: https://apiverve.com');
+        }
+
+        // Validate API key format (GUID, prefixed keys like apv_xxx, or alphanumeric)
+        const apiKeyPattern = /^[a-zA-Z0-9_-]+$/;
+        if (!apiKeyPattern.test(api_key)) {
+            throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens and underscores. Get your API key at: https://apiverve.com');
+        }
+
+        if (typeof secure !== 'boolean') {
+            throw new Error('Secure parameter must be a boolean value.');
+        }
+
+        this.APIKey = api_key;
+        this.IsSecure = secure;
+
+        // secure is deprecated, all requests must be made over HTTPS
+        this.baseURL = 'https://api.apiverve.com/v1/pdfpagenumbers';
+
+        // Validation rules for parameters (generated from schema)
+        this.validationRules = {"pdf":{"type":"string","required":false},"position":{"type":"string","required":false,"default":"bottom-center"},"fontSize":{"type":"number","required":false,"min":6,"max":36,"default":10},"format":{"type":"string","required":false},"startAt":{"type":"integer","required":false,"min":0,"max":100000},"skipFirst":{"type":"boolean","required":false}};
+    }
+
+    /**
+     * Validate query parameters against schema rules
+     * @param {Object} query - The query parameters to validate
+     * @throws {Error} - If validation fails
+     */
+    validateParams(query) {
+        const errors = [];
+
+        for (const [paramName, rules] of Object.entries(this.validationRules)) {
+            const value = query[paramName];
+
+            // Check required
+            if (rules.required && (value === undefined || value === null || value === '')) {
+                errors.push(`Required parameter [${paramName}] is missing.`);
+                continue;
+            }
+
+            // Skip validation if value is not provided and not required
+            if (value === undefined || value === null) {
+                continue;
+            }
+
+            // Type validation
+            if (rules.type === 'integer' || rules.type === 'number') {
+                const numValue = Number(value);
+                if (isNaN(numValue)) {
+                    errors.push(`Parameter [${paramName}] must be a valid ${rules.type}.`);
+                    continue;
+                }
+
+                if (rules.type === 'integer' && !Number.isInteger(numValue)) {
+                    errors.push(`Parameter [${paramName}] must be an integer.`);
+                    continue;
+                }
+
+                // Min/max validation for numbers
+                if (rules.min !== undefined && numValue < rules.min) {
+                    errors.push(`Parameter [${paramName}] must be at least ${rules.min}.`);
+                }
+                if (rules.max !== undefined && numValue > rules.max) {
+                    errors.push(`Parameter [${paramName}] must be at most ${rules.max}.`);
+                }
+            } else if (rules.type === 'string') {
+                if (typeof value !== 'string') {
+                    errors.push(`Parameter [${paramName}] must be a string.`);
+                    continue;
+                }
+
+                // Length validation for strings
+                if (rules.minLength !== undefined && value.length < rules.minLength) {
+                    errors.push(`Parameter [${paramName}] must be at least ${rules.minLength} characters.`);
+                }
+                if (rules.maxLength !== undefined && value.length > rules.maxLength) {
+                    errors.push(`Parameter [${paramName}] must be at most ${rules.maxLength} characters.`);
+                }
+
+                // Format validation
+                if (rules.format) {
+                    const formatPatterns = {
+                        'email': /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
+                        'url': /^https?:\/\/.+/i,
+                        'ip': /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$/,
+                        'date': /^\d{4}-\d{2}-\d{2}$/,
+                        'hexColor': /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
+                    };
+
+                    if (formatPatterns[rules.format] && !formatPatterns[rules.format].test(value)) {
+                        errors.push(`Parameter [${paramName}] must be a valid ${rules.format}.`);
+                    }
+                }
+            } else if (rules.type === 'boolean') {
+                if (typeof value !== 'boolean' && value !== 'true' && value !== 'false') {
+                    errors.push(`Parameter [${paramName}] must be a boolean.`);
+                }
+            } else if (rules.type === 'array') {
+                if (!Array.isArray(value)) {
+                    errors.push(`Parameter [${paramName}] must be an array.`);
+                }
+            }
+
+            // Enum validation
+            if (rules.enum && Array.isArray(rules.enum)) {
+                if (!rules.enum.includes(value)) {
+                    errors.push(`Parameter [${paramName}] must be one of: ${rules.enum.join(', ')}.`);
+                }
+            }
+        }
+
+        if (errors.length > 0) {
+            throw new Error(`Validation failed: ${errors.join(' ')} See documentation: https://docs.apiverve.com/ref/pdfpagenumbers`);
+        }
+    }
+
+    async execute(query, callback) {
+        // Handle different argument patterns
+        if(arguments.length === 0) {
+            // execute() - no args
+            query = {};
+            callback = null;
+        } else if(arguments.length === 1) {
+            if (typeof query === 'function') {
+                // execute(callback)
+                callback = query;
+                query = {};
+            } else {
+                // execute(query)
+                callback = null;
+            }
+        } else {
+            // execute(query, callback)
+            if (!query || typeof query !== 'object') {
+                throw new Error('Query parameters must be provided as an object.');
+            }
+        }
+
+        // Validate parameters against schema rules
+        this.validateParams(query);
+
+        const method = 'POST';
+        const url = method === 'POST' ? this.baseURL : this.constructURL(query);
+
+        try {
+            const response = await axios({
+                method,
+                url,
+                headers: {
+                    'Content-Type': 'application/json',
+                    'x-api-key': this.APIKey,
+                    'auth-mode': 'npm-package'
+                },
+                data: method === 'POST' ? query : undefined
+            });
+
+            const data = response.data;
+            if (callback) callback(null, data);
+            return data;
+        } catch (error) {
+            let apiError;
+
+            if (error.response && error.response.data) {
+                apiError = error.response.data;
+            } else if (error.message) {
+                apiError = { error: error.message, status: 'error' };
+            } else {
+                apiError = { error: 'An unknown error occurred', status: 'error' };
+            }
+
+            if (callback) {
+                callback(apiError, null);
+                return; // Don't throw if callback is provided
+            }
+
+            throw apiError;
+        }
+    }
+
+    constructURL(query) {
+        let url = this.baseURL;
+
+        if(query && typeof query === 'object')
+        {
+            if (Object.keys(query).length > 0) {
+                const queryString = Object.keys(query)
+                    .map(key => `${encodeURIComponent(key)}=${encodeURIComponent(query[key])}`)
+                    .join('&');
+                url += `?${queryString}`;
+            }
+        }
+        return url;
+    }
+
+    /**
+     * Execute the API request with a file upload
+     * @param {string|Buffer|ReadStream} file - File path, Buffer, or ReadStream
+     * @param {Object} options - Additional options (e.g., additional form fields)
+     * @param {Function} callback - Optional callback function
+     * @returns {Promise} - Promise with the API response
+     */
+    async executeWithFile(file, options = {}, callback) {
+        // Handle callback as second argument
+        if (typeof options === 'function') {
+            callback = options;
+            options = {};
+        }
+
+        if (!file) {
+            throw new Error('File must be provided for file upload. See documentation: https://docs.apiverve.com/ref/pdfpagenumbers');
+        }
+
+        const FormData = require('form-data');
+        const fs = require('fs');
+        const path = require('path');
+
+        const formData = new FormData();
+
+        // Handle different file input types
+        if (typeof file === 'string') {
+            // File path provided
+            if (!fs.existsSync(file)) {
+                throw new Error(`File not found: ${file}`);
+            }
+            formData.append('pdf', fs.createReadStream(file), {
+                filename: path.basename(file)
+            });
+        } else if (Buffer.isBuffer(file)) {
+            // Buffer provided
+            formData.append('pdf', file, {
+                filename: options.filename || 'upload',
+                contentType: options.contentType || 'application/octet-stream'
+            });
+        } else if (file.pipe && typeof file.pipe === 'function') {
+            // ReadStream provided
+            formData.append('pdf', file);
+        } else {
+            throw new Error('File must be a file path (string), Buffer, or ReadStream. See documentation: https://docs.apiverve.com/ref/pdfpagenumbers');
+        }
+
+        // Add any additional form fields
+        if (options.fields && typeof options.fields === 'object') {
+            for (const [key, value] of Object.entries(options.fields)) {
+                formData.append(key, value);
+            }
+        }
+
+        try {
+            const response = await axios({
+                method: 'POST',
+                url: this.baseURL,
+                headers: {
+                    ...formData.getHeaders(),
+                    'x-api-key': this.APIKey,
+                    'auth-mode': 'npm-package'
+                },
+                data: formData,
+                maxContentLength: 10 * 1024 * 1024,
+                maxBodyLength: 10 * 1024 * 1024
+            });
+
+            const data = response.data;
+            if (callback) callback(null, data);
+            return data;
+        } catch (error) {
+            let apiError;
+
+            if (error.response && error.response.data) {
+                apiError = error.response.data;
+            } else if (error.message) {
+                apiError = { error: error.message, status: 'error' };
+            } else {
+                apiError = { error: 'An unknown error occurred', status: 'error' };
+            }
+
+            if (callback) {
+                callback(apiError, null);
+                return;
+            }
+
+            throw apiError;
+        }
+    }
+
+    /**
+     * Execute the API request with a file URL
+     * @param {string} url - URL of the file to process
+     * @param {Object} options - Additional options (e.g., additional parameters)
+     * @param {Function} callback - Optional callback function
+     * @returns {Promise} - Promise with the API response
+     */
+    async executeWithUrl(url, options = {}, callback) {
+        // Handle callback as second argument
+        if (typeof options === 'function') {
+            callback = options;
+            options = {};
+        }
+
+        if (!url || typeof url !== 'string') {
+            throw new Error('URL must be provided as a string. See documentation: https://docs.apiverve.com/ref/pdfpagenumbers');
+        }
+
+        // Validate URL format
+        if (!/^https?:\/\/.+/i.test(url)) {
+            throw new Error('Invalid URL format. URL must start with http:// or https://');
+        }
+
+        const query = { url, ...options };
+        return this.execute(query, callback);
+    }
+}
+
+module.exports = pdfpagenumbersWrapper;

package/package.json

@@ -1,6 +1,47 @@
 {
   "name": "@apiverve/pdfpagenumbers",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.2.2",
+  "description": "PDF Page Numbers stamps a page number on every page of a PDF, uploaded or fetched from a URL, and returns a download link to the numbered file. Choose the corner or edge and the font size. Paid plans can also set a label format such as Page 3 of 12, the starting number, and skip a cover page.",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "LICENSE"
+  ],
+  "scripts": {
+    "test": "mocha",
+    "example": "node examples/basic.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/apiverve/pdfpagenumbers-api.git",
+    "directory": "npm"
+  },
+  "keywords": [
+    "pdf page numbers api", "add page numbers to pdf", "number pdf pages api", "pdf pagination api", "page x of y pdf"
+  ],
+  "author": {
+    "name": "APIVerve",
+    "email": "hello@apiverve.com",
+    "url": "https://apiverve.com"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/apiverve/pdfpagenumbers-api/issues"
+  },
+  "homepage": "https://apiverve.com/marketplace/pdfpagenumbers?utm_source=npm&utm_medium=referral&utm_content=homepage",
+  "devDependencies": {
+    "mocha": "^11.0.1",
+    "chai": "^5.1.2",
+    "dotenv": "^16.4.7"
+  },
+  "dependencies": {
+    "axios": "1.13.2",
+    "form-data": "^4.0.1"
+  }
 }