npm - docstron - Versions diffs - 1.0.0 - Mend

docstron 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (20) hide show

package/.env.example +2 -0
package/LICENSE +21 -0
package/README.md +789 -0
package/check-connection.js +107 -0
package/examples/basic-usage.js +91 -0
package/examples/complete-workflow.js +160 -0
package/examples/generate-pdf.js +325 -0
package/examples/invoice-template.js +187 -0
package/examples/manage-applications.js +114 -0
package/examples/quick-generate.js +101 -0
package/index.js +13 -0
package/lib/Docstron.js +55 -0
package/lib/constants.js +7 -0
package/lib/resources/Applications.js +110 -0
package/lib/resources/Documents.js +173 -0
package/lib/resources/Templates.js +97 -0
package/lib/utils/errors.js +38 -0
package/lib/utils/httpClient.js +68 -0
package/package.json +42 -0
package/test/test.js +213 -0

package/examples/invoice-template.js ADDED Viewed

@@ -0,0 +1,187 @@
+require('dotenv').config();
+const Docstron = require('../index');
+async function createInvoiceTemplate() {
+  const apiKey = process.env.DOCSTRON_API_KEY;
+  const appId = process.env.DOCSTRON_APP_ID;
+  if (!apiKey || !appId) {
+    console.error('❌ Missing credentials. Please check your .env file.');
+    process.exit(1);
+  }
+  const client = new Docstron(apiKey);
+  const invoiceHTML = `
+    <!DOCTYPE html>
+    <html>
+      <head>
+        <meta charset="UTF-8">
+        <style>
+          body {
+            font-family: 'Arial', sans-serif;
+            max-width: 800px;
+            margin: 0 auto;
+            padding: 40px;
+            color: #333;
+          }
+          .header {
+            text-align: center;
+            border-bottom: 3px solid #4a90e2;
+            padding-bottom: 20px;
+            margin-bottom: 30px;
+          }
+          .header h1 {
+            color: #4a90e2;
+            margin: 0;
+          }
+          .info-section {
+            display: flex;
+            justify-content: space-between;
+            margin-bottom: 30px;
+          }
+          .info-box {
+            flex: 1;
+          }
+          .info-box h3 {
+            color: #4a90e2;
+            border-bottom: 2px solid #e0e0e0;
+            padding-bottom: 5px;
+          }
+          table {
+            width: 100%;
+            border-collapse: collapse;
+            margin: 20px 0;
+          }
+          th {
+            background: #4a90e2;
+            color: white;
+            padding: 12px;
+            text-align: left;
+          }
+          td {
+            padding: 10px;
+            border-bottom: 1px solid #e0e0e0;
+          }
+          .total-section {
+            text-align: right;
+            margin-top: 20px;
+          }
+          .total {
+            font-size: 24px;
+            font-weight: bold;
+            color: #4a90e2;
+          }
+          .footer {
+            margin-top: 40px;
+            text-align: center;
+            color: #666;
+            font-size: 12px;
+            border-top: 1px solid #e0e0e0;
+            padding-top: 20px;
+          }
+        </style>
+      </head>
+      <body>
+        <div class="header">
+          <h1>INVOICE</h1>
+          <p>Invoice #{{invoice_number}}</p>
+          <p>Date: {{invoice_date}}</p>
+        </div>
+        <div class="info-section">
+          <div class="info-box">
+            <h3>From:</h3>
+            <p><strong>{{company_name}}</strong></p>
+            <p>{{company_address}}</p>
+            <p>{{company_email}}</p>
+          </div>
+          <div class="info-box">
+            <h3>Bill To:</h3>
+            <p><strong>{{customer_name}}</strong></p>
+            <p>{{customer_address}}</p>
+            <p>{{customer_email}}</p>
+          </div>
+        </div>
+        <table>
+          <thead>
+            <tr>
+              <th>Description</th>
+              <th>Quantity</th>
+              <th>Rate</th>
+              <th>Amount</th>
+            </tr>
+          </thead>
+          <tbody>
+            <tr>
+              <td>{{item_description}}</td>
+              <td>{{item_quantity}}</td>
+              <td>{{item_rate}}</td>
+              <td>{{item_amount}}</td>
+            </tr>
+          </tbody>
+        </table>
+        <div class="total-section">
+          <p><strong>Subtotal:</strong> {{subtotal}}</p>
+          <p><strong>Tax ({{tax_rate}}%):</strong> {{tax_amount}}</p>
+          <p class="total">Total: {{total_amount}}</p>
+        </div>
+        <div class="footer">
+          <p>{{footer_text}}</p>
+          <p>Payment due within 30 days</p>
+        </div>
+      </body>
+    </html>
+  `;
+  try {
+    const template = await client.templates.create({
+      application_id: appId,
+      name: 'Professional Invoice Template - ' + Date.now(),
+      content: invoiceHTML,
+      is_active: true,
+      extra_css: `
+            @page{
+                margin: 2cm;
+                @bottom-center {
+                    content: "Page " counter(page) " of " counter(pages);
+                    font-size: 10px;
+                    color: #666;
+                }
+            }
+        `
+    });
+    console.log('✅ Invoice template created!');
+    console.log('Template ID:', template.template_id);
+    console.log('\nYou can now use this template to generate invoices with your data.');
+    console.log('\nExample data structure:');
+    console.log(JSON.stringify({
+      invoice_number: 'INV-2025-001',
+      invoice_date: '2025-11-08',
+      company_name: 'Acme Corporation',
+      company_address: '123 Business St, City, State 12345',
+      company_email: 'billing@acme.com',
+      customer_name: 'John Doe',
+      customer_address: '456 Customer Ave, City, State 67890',
+      customer_email: 'john@example.com',
+      item_description: 'Web Development Services',
+      item_quantity: '40 hours',
+      item_rate: '$100/hr',
+      item_amount: '$4,000.00',
+      subtotal: '$4,000.00',
+      tax_rate: '10',
+      tax_amount: '$400.00',
+      total_amount: '$4,400.00',
+      footer_text: 'Thank you for your business!'
+    }, null, 2));
+  } catch (error) {
+    console.error('❌ Error:', error.message);
+  }
+}
+createInvoiceTemplate();

package/examples/manage-applications.js ADDED Viewed

@@ -0,0 +1,114 @@
+require('dotenv').config();
+const Docstron = require('../index');
+async function manageApplicationsExample() {
+    const apiKey = process.env.DOCSTRON_API_KEY;
+    if (!apiKey) {
+        console.error('❌ Missing DOCSTRON_API_KEY. Please check your .env file.');
+        process.exit(1);
+    }
+    const client = new Docstron(apiKey);
+    try {
+        console.log('🏢 Application Management Examples\n');
+        console.log('='.repeat(50));
+        // Example 1: List all applications
+        console.log('\n📃 Example 1: List all applications... \n');
+        const allApps = await client.applications.list();
+        console.log(`✅ Found ${allApps.length} application(s)`);
+        allApps.forEach((apps, index) => {
+            console.log(` ${index + 1}. ${apps.name} (${apps.app_id})`);
+            console.log(`       Status: ${apps.is_active ? 'Active' : 'Inactive'}`);
+            console.log(`       Created: ${apps.created_at}`);
+        });
+        console.log('');
+        // Example 2: Create a new application
+        console.log('📝 Example 2: Create a new application... \n');
+        const newApp = await client.applications.create({
+            name: 'Test Application - ' + Date.now(),
+            description: 'Created by Node SDK for testing purposes',
+            is_active: true
+        });
+        console.log('✅ Application Created!');
+        console.log('   App ID:', newApp.app_id);
+        console.log('   Name:', newApp.name);
+        console.log('   Description:', newApp.description);
+        console.log('   Status:', newApp.is_active ? 'Active' : 'Inactive');
+        console.log('   Created:', newApp.created_at);
+        console.log('');
+        // Example 3: Get specific application details
+        console.log('📖 Example 3: Get application details... \n');
+        const appDetails = await client.applications.get(newApp.app_id);
+        console.log('✅ Applicaiton details retrieved');
+        console.log('   Name:', appDetails.name);
+        console.log('   Description:', appDetails.description);
+        console.log('   Status:', appDetails.is_active ? 'Active' : 'Inactive');
+        console.log('   Created:', appDetails.created_at);
+        console.log('');
+        // Example 4: Update application
+        console.log('✏️  Example 4: Update application...\n');
+        const updatedApp = await client.applications.update(newApp.app_id, {
+            name: 'Updated Test Application',
+            description: 'Updated description',
+            is_active: true
+        });
+        console.log('✅ Application updated!');
+        console.log('   New Name:', updatedApp.name);
+        console.log('   New Description:', updatedApp.description);
+        console.log('   Updated At:', updatedApp.updated_at);
+        console.log('');
+        // Example 5: Deactivate application
+        console.log('🔒 Example 5: Deactivate application...\n');
+        const deactivated = await client.applications.update(newApp.app_id, {
+            is_active: false
+        });
+        console.log('✅ Application deactivated!');
+        console.log('   Status:', deactivated.is_active ? 'Active' : 'Inactive');
+        console.log('');
+        // Example 6: Get only active applications
+        console.log('📋 Example 6: List active applications only...\n');
+        const activeApps = await client.applications.listActive();
+        console.log(`✅ Found ${activeApps.length} active application(s):`);
+        activeApps.forEach((app, index) => {
+            console.log(`   ${index + 1}. ${app.name} (${app.app_id})`);
+        });
+        console.log('');
+        // Example 7: Get only inactive applications
+        console.log('📋 Example 7: List inactive applications only...\n');
+        const inactiveApps = await client.applications.listInactive();
+        console.log(`✅ Found ${inactiveApps.length} inactive application(s):`);
+        inactiveApps.forEach((app, index) => {
+            console.log(`   ${index + 1}. ${app.name} (${app.app_id})`);
+        });
+        console.log('');
+        // Example 8: Delete application (cleanup)
+        console.log('🗑️  Example 8: Delete test application...\n');
+        await client.applications.delete(newApp.app_id);
+        console.log('✅ Application deleted successfully!');
+        console.log('');
+        console.log('='.repeat(50));
+        console.log('🎉 All application management examples completed!\n');
+    } catch (error) {
+        console.error('\n❌ Error:', error.message);
+        if (error.name === 'ValidationError') {
+            console.error('Validation errors:');
+            error.errors?.forEach(err => {
+                console.error(`  - ${err.field}: ${err.message}`);
+            });
+        }
+    }
+}
+manageApplicationsExample();

package/examples/quick-generate.js ADDED Viewed

@@ -0,0 +1,101 @@
+require('dotenv').config();
+const Docstron = require('../index');
+const fs = require('fs');
+const path = require('path');
+async function quickGenerateExample() {
+    const apiKey = process.env.DOCSTRON_API_KEY;
+    const appId = process.env.DOCSTRON_APP_ID;
+    if (!apiKey) {
+        console.error('❌ Missing DOCSTRON_API_KEY. Please check your .env file.');
+        process.exit(1);
+    }
+    const client = new Docstron(apiKey);
+    try {
+        console.log('⚡ Quick Generate PDF Examples\n');
+        console.log('='.repeat(50));
+        // Example 1: Quick generate without saving template
+        console.log('\n📄 Example 1: Quick generate (no template save)...');
+        const doc1 = await client.documents.quickGenerate({
+            html: `
+        <html>
+          <head>
+            <style>
+              body { font-family: Arial; padding: 40px; }
+              h1 { color: #3498db; }
+            </style>
+          </head>
+          <body>
+            <h1>Hello {{name}}!</h1>
+            <p>This is a quick PDF generated on {{date}}</p>
+            <p>Message: {{message}}</p>
+          </body>
+        </html>
+      `,
+            data: {
+                name: 'World',
+                date: new Date().toLocaleDateString(),
+                message: 'No template needed!'
+            },
+            response_type: 'document_id'
+        });
+        console.log('✅ PDF generated!');
+        console.log('   Document ID:', doc1.document_id);
+        console.log('   Download URL:', doc1.download_url);
+        /*
+        // Example 2: Quick generate with extra CSS
+        console.log('\n📄 Example 2: Quick generate with custom CSS...');
+        const doc2 = await client.documents.quickGenerate({
+            html: '<h1>Styled PDF</h1><p>This has custom page margins</p>',
+            data: {},
+            extra_css: '@page { margin: 3cm; } h1 { color: #e74c3c; }',
+            response_type: 'document_id'
+        });
+        console.log('✅ PDF generated with custom styling!');
+        console.log('   Document ID:', doc2.document_id);
+        // Example 3: Quick generate and save as template
+        if (appId) {
+            console.log('\n📄 Example 3: Quick generate and save as template...');
+            const doc3 = await client.documents.quickGenerate({
+                html: '<h1>Receipt</h1><p>Amount: {{amount}}</p>',
+                data: { amount: '$99.99' },
+                response_type: 'document_id',
+                save_template: true,
+                application_id: appId
+            });
+            console.log('✅ PDF generated and template saved!');
+            console.log('   Document ID:', doc3.document_id);
+            console.log('   Template ID:', doc3.template_id);
+        }
+        // Example 4: Quick generate with password protection
+        console.log('\n📄 Example 4: Password-protected PDF...');
+        const doc4 = await client.documents.quickGenerate({
+            html: '<h1>Confidential</h1><p>This PDF is password protected</p>',
+            data: {},
+            response_type: 'document_id',
+            password: 'SecurePass123!'
+        });
+        console.log('✅ Password-protected PDF generated!');
+        console.log('   Document ID:', doc4.document_id);
+        console.log('   Password: SecurePass123!');
+        */
+        console.log('\n' + '='.repeat(50));
+        console.log('🎉 Quick generate examples completed!\n');
+    } catch (error) {
+        console.error('\n❌ Error:', error.message);
+        if (error.statusCode) {
+            console.error('Status Code:', error.statusCode);
+        }
+    }
+}
+quickGenerateExample();

package/index.js ADDED Viewed

@@ -0,0 +1,13 @@
+const Docstron = require('./lib/Docstron');
+const {
+    DocstronError,
+    ValidationError,
+    AuthenticationError,
+    NotFoundError
+} = require('./lib/utils/errors');
+module.exports = Docstron;
+module.exports.DocstronError = DocstronError;
+module.exports.ValidationError = ValidationError;
+module.exports.AuthenticationError = AuthenticationError;
+module.exports.NotFoundError = NotFoundError;

package/lib/Docstron.js ADDED Viewed

@@ -0,0 +1,55 @@
+const HttpClient = require('./utils/httpClient');
+const Templates = require('./resources/Templates');
+const Documents = require('./resources/Documents');
+const Applications = require('./resources/Applications');
+const { DEFAULT_BASE_URL } = require('./constants');
+class Docstron {
+    /**
+     * Create new Docstron client
+     * @param {string} apiKey - Your Docstron API key
+     * @param {Object} [Options] - Configuration options
+     * @param {string} [Options.baseURL] - Custom base URL
+     */
+    constructor(apiKey, options = {}) {
+        if (!apiKey) {
+            throw new Error('API key is required');
+        }
+        this.apiKey = apiKey;
+        this.baseURL = options.baseURL || DEFAULT_BASE_URL;
+        const httpClient = new HttpClient(this.apiKey, this.baseURL);
+        // v0.1.0 - Templates Only
+        this.templates = new Templates(httpClient);
+        // v0.2.0 - Documents
+        this.documents = new Documents(httpClient);
+        // v0.3.0 - Applications
+        this.applications = new Applications(httpClient);
+    }
+    /**
+     * Get the current SDK version
+     * @returns {string} version number
+     */
+    static getVersion() {
+        return '0.3.0';
+    }
+    /**
+     * Check which features are available
+     * @returns {Object} Available features
+     */
+    static getFeatures() {
+        return {
+            templates: true, // v0.1.0+
+            documents: true, // v0.2.0+
+            applications: true // v0.3.0+
+        }
+    }
+}
+module.exports = Docstron;

package/lib/constants.js ADDED Viewed

@@ -0,0 +1,7 @@
+const DEFAULT_BASE_URL = 'https://api.docstron.com';
+const API_VERSION = 'v1';
+module.exports = {
+    DEFAULT_BASE_URL,
+    API_VERSION
+};

package/lib/resources/Applications.js ADDED Viewed

@@ -0,0 +1,110 @@
+class Applications {
+    constructor(httpClient) {
+        this.http = httpClient;
+    }
+    /**
+     * Create a new application
+     * @param {Object} params - Application parameters
+     * @param {string} [params.name] - Application name
+     * @param {string} [params.description] - Application description
+     * @param {boolean} [params.is_active=true] - Whether the application is active
+     * @returns {Promise<Object>} Craeted application
+     */
+    async create(params) {
+        this._validateCreateParams(params);
+        const response = await this.http.post('/v1/applications', params);
+        return response.data;
+    }
+    /**
+     * Get an application by id
+     * @param {string} appId - Application ID
+     * @returns {Promise<Object>} Application details
+     */
+    async get(appId) {
+        if (!appId) {
+            throw new Error('Applicaiton ID is required.');
+        }
+        const response = await this.http.get(`/v1/applications/${appId}`);
+        return response.data;
+    }
+    /**
+     * Update an application
+     * @param {string} appId - The application ID
+     * @param {Object} params - Application parameters
+     * @param {string} [params.name] - New applicatio name
+     * @param {string} [params.description] - New description
+     * @param {boolean} [params.is_active] - New active status
+     * @returns {Promise<Object>} Updated application
+     */
+    async update(appId, params) {
+        if (!appId) {
+            throw new Error('Applicaiton ID is required');
+        }
+        if (!params || Object.keys(params).length === 0) {
+            throw new Error('At least one parameter is required to update');
+        }
+        const response = await this.http.put(`/v1/applications/${appId}`, params);
+        return response.data;
+    }
+    /**
+     * Delete an application
+     * @param {string} appId - The application ID
+     * @return {Promise<Object>} Deletion confirmation
+     */
+    async delete(appId) {
+        if (!appId) {
+            throw new Error('Application ID is required');
+        }
+        const response = await this.http.delete(`/v1/applications/${appId}`);
+        return response.data;
+    }
+    /**
+   * List all applications
+   * @returns {Promise<Array>} List of all applications
+   */
+    async list() {
+        const response = await this.http.get('/v1/applications');
+        return response.data;
+    }
+    /**
+     * Get active applications only
+     * @returns {Promise<Array>} List of active applications
+     */
+    async listActive() {
+        const allApps = await this.list();
+        return allApps.filter(app => app.is_active === true);
+    }
+    /**
+     * Get inactive applications only
+     * @returns {Promise<Array>} List of inactive applications
+     */
+    async listInactive() {
+        const allApps = await this.list();
+        return allApps.filter(app => app.is_active === false);
+    }
+    _validateCreateParams(params) {
+        if (!params.name) {
+            throw new Error('name is required');
+        }
+    }
+}
+module.exports = Applications;