docstron 1.0.0

package/check-connection.js

@@ -0,0 +1,107 @@
+// Quick check - create check-connection.js
+require('dotenv').config();
+const axios = require('axios');
+
+const API_KEY = process.env.DOCSTRON_API_KEY;
+const BASE_URL = 'https://api.docstron.com';
+
+console.log('Testing connection to Docstron API...');
+console.log('Base URL:', BASE_URL);
+console.log('API Key:', API_KEY ? API_KEY.substring(0, 10) + '...' : 'NOT SET');
+
+axios.get(BASE_URL + '/v1/templates', {
+  headers: {
+    'Authorization': `Bearer ${API_KEY}`,
+    'Content-Type': 'applicaiton/json'
+  },
+  timeout: 10000
+})
+.then(response => {
+  console.log('✅ Connection successful!');
+  console.log('Status:', response.status);
+})
+.catch(error => {
+  console.error('❌ Connection failed!');
+  if (error.response) {
+    console.error('Status:', error.response.status);
+    console.error('Message:', error.response.data);
+  } else if (error.request) {
+    console.error('No response received');
+    console.error('Error:', error.message);
+  } else {
+    console.error('Error:', error.message);
+  }
+});
+
+
+/*
+require('dotenv').config();
+const axios = require('axios');
+
+const KEY = process.env.DOCSTRON_API_KEY;
+
+const urls = [
+  'https://api.docstron.com',
+  'https://docstron.com/api',
+  'https://backend.docstron.com',
+  'https://docstron.com',
+];
+
+(async () => {
+  for (const url of urls) {
+    console.log(`\n👉 Testing: ${url}/templates`);
+
+    try {
+      const res = await axios.get(url + '/templates', {
+        headers: { 'x-api-key': KEY },
+        timeout: 5000,
+      });
+      console.log('✔️ SUCCESS', res.status);
+    } catch (err) {
+      console.log('❌ FAILED');
+      console.log(err.code || err.message);
+    }
+  }
+})();
+*/
+
+// require('dotenv').config();
+// const axios = require('axios');
+// const HttpsProxyAgent = require('https-proxy-agent');
+
+// const API_KEY = process.env.DOCSTRON_API_KEY;
+
+// // corporate proxy
+// const proxyUrl = 'http://10.0.1.222:8080';
+// const httpsAgent = new HttpsProxyAgent(proxyUrl);
+
+// // Correct Docstron API base
+// const BASE_URL = 'https://api.docstron.com';
+
+// (async () => {
+//   try {
+//     const res = await axios.get(`${BASE_URL}/v1/templates`, {
+//       headers: {
+//         'x-api-key': API_KEY,         // ✅ correct
+//         'Accept': 'application/json'
+//       },
+//       httpsAgent,
+//       proxy: false,                   // IMPORTANT
+//       timeout: 15000
+//     });
+
+//     console.log('SUCCESS:', res.status);
+//     console.log(res.data);
+
+//   } catch (err) {
+//     console.error('FAILED');
+
+//     if (err.response) {
+//       console.log('Status:', err.response.status);
+//       console.log('Data:', err.response.data);
+//     } else {
+//       console.log(err.message);
+//     }
+//   }
+// })();
+

package/examples/basic-usage.js

@@ -0,0 +1,91 @@
+require('dotenv').config();
+const Docstron = require('../index');
+
+async function basicExample() {
+    const apiKey = process.env.DOCSTRON_API_KEY;
+    const appId = process.env.DOCSTRON_APP_ID;
+
+    // Validate credentials
+    if (!apiKey) {
+        console.error('❌ Error: DOCSTRON_API_KEY not found!');
+        console.error('\n💡 Please create a .env file with:');
+        console.error('   DOCSTRON_API_KEY=your-api-key-here');
+        console.error('   DOCSTRON_APP_ID=app-your-application-id-here\n');
+        process.exit(1);
+    }
+
+    if (!appId) {
+        console.error('❌ Error: DOCSTRON_APP_ID not found!');
+        console.error('\n💡 Please add to your .env file:');
+        console.error('   DOCSTRON_APP_ID=app-your-application-id-here\n');
+        process.exit(1);
+    }
+
+    const client = new Docstron(apiKey);
+
+    try {
+        console.log('Docstron SDK v' + Docstron.getVersion());
+        console.log('API Key:', apiKey.substring(0, 10) + '...');
+        console.log('App ID:', appId);
+        console.log('Creating a template...\n');
+
+        // Create a simple template
+        const template = await client.templates.create({
+            application_id: appId,
+            name: 'My First Template - ' + Date.now(),
+            content: '<h1>Hello {{name}}!</h1><p>Welcome to {{company}}</p>',
+            is_active: true
+        });
+
+        console.log('✅ Template created successfully!');
+        console.log('Template ID:', template.template_id);
+        console.log('Template Name:', template.name);
+        console.log('Created At:', template.created_at);
+        console.log('\n');
+
+        // Get the template
+        console.log('Retrieving the template...');
+        const retrieved = await client.templates.get(template.template_id);
+        console.log('✅ Template retrieved:', retrieved.name);
+        console.log('\n');
+
+        // Update the template
+        console.log('Updating the template...');
+        const updated = await client.templates.update(template.template_id, {
+            name: 'Updated Template Name - ' + Date.now()
+        });
+        console.log('✅ Template updated:', updated.name);
+        console.log('\n');
+
+        // Clean up - delete the test template
+        console.log('Cleaning up...');
+        await client.templates.delete(template.template_id);
+        console.log('✅ Test template deleted');
+        console.log('\n🎉 All operations completed successfully!');
+
+    } catch (error) {
+        console.error('❌ Error:', error.message);
+
+        if (error.name === 'ValidationError') {
+            console.error('\nValidation errors:');
+            error.errors.forEach(err => {
+                console.error(`  - ${err.field}: ${err.message}`);
+            });
+        } else if (error.name === 'AuthenticationError') {
+            console.error('\n💡 Your API key appears to be invalid.');
+            console.error('   Please check your .env file and verify the key at:');
+            console.error('   https://docstron.com/dashboard');
+        } else if (error.name === 'NotFoundError') {
+            console.error('\n💡 Application not found.');
+            console.error('   Please check your DOCSTRON_APP_ID in .env file');
+        } else if (error.statusCode === 0) {
+            console.error('\n💡 Cannot connect to Docstron API.');
+            console.error('   Possible issues:');
+            console.error('   - Check your internet connection');
+            console.error('   - Verify the API endpoint is correct');
+            console.error('   - API might be temporarily unavailable');
+        }
+    }
+}
+
+basicExample();

package/examples/complete-workflow.js

@@ -0,0 +1,160 @@
+require('dotenv').config();
+const Docstron = require('../index');
+const path = require('path');
+const fs = require('fs');
+
+/**
+ * Complete workflow: Application → Template → Document
+ * This demonstrates the full Docstron workflow from start to finish
+ */
+
+async function completeWorkflow() {
+    const apiKey = process.env.DOCSTRON_API_KEY;
+
+    if (!apiKey) {
+        console.error('❌ Missing DOCSTRON_API_KEY');
+        process.exit(1);
+    }
+
+    const client = new Docstron(apiKey);
+
+    console.log('🚀 Complete Docstron Workflow\n');
+    console.log('='.repeat(50));
+    console.log('SDK Version:', Docstron.getVersion());
+    console.log('Features:', JSON.stringify(Docstron.getFeatures(), null, 2));
+    console.log('');
+
+    try {
+        /*
+        // Step 1: Create Application
+        console.log('Step 1: Creating application...\n');
+        const app = await client.applications.create({
+            name: 'Invoice System - ' + Date.now(),
+            description: 'Complete workflow demo application',
+            is_active: true
+        });
+        console.log('✅ Application created!');
+        console.log('   App ID:', app.app_id);
+        console.log('');
+        */
+
+        /*
+        // Step 2: Create Template
+        console.log('Step 2: Creating template...\n');
+        const template = await client.templates.create({
+            application_id: 'app-c673a1f1-ff8e-4367-98c2-063e57061a55', //app.app_id, //app-c673a1f1-ff8e-4367-98c2-063e57061a55
+            name: 'Professional Invoice',
+            content: `
+        <!DOCTYPE html>
+        <html>
+          <head>
+            <style>
+              body { font-family: Arial; padding: 40px; }
+              .header { text-align: center; border-bottom: 2px solid #333; padding-bottom: 20px; }
+              .details { margin: 30px 0; }
+              .total { font-size: 24px; font-weight: bold; color: #e74c3c; text-align: right; }
+            </style>
+          </head>
+          <body>
+            <div class="header">
+              <h1>INVOICE</h1>
+              <p>Invoice #{{invoice_number}}</p>
+            </div>
+            <div class="details">
+              <p><strong>Customer:</strong> {{customer_name}}</p>
+              <p><strong>Date:</strong> {{date}}</p>
+              <p><strong>Service:</strong> {{service}}</p>
+            </div>
+            <p class="total">Total: {{total}}</p>
+          </body>
+        </html>
+      `,
+            is_active: true
+        });
+        console.log('✅ Template created!');
+        console.log('   Template ID:', template.template_id);
+        console.log('');
+        */
+
+        /*
+        // Step 3: Generate Document
+        console.log('Step 3: Generating PDF...\n');
+        const doc = await client.documents.generate(template.template_id, {
+            data: {
+                invoice_number: 'INV-DEMO-001',
+                customer_name: 'Demo Client',
+                date: new Date().toLocaleDateString(),
+                service: 'SDK Demo Services',
+                total: '$999.00'
+            },
+            response_type: 'document_id'
+        });
+        console.log('✅ PDF generated!');
+        console.log('   Document ID:', doc.document_id);
+        console.log('   Download URL:', doc.download_url);
+        console.log('');
+        */
+
+        /*
+        // Step 4: Download PDF
+        console.log('Step 4: Downloading PDF...\n');
+        const outputDir = path.join(__dirname, '../output');
+        if (!fs.existsSync(outputDir)) {
+            fs.mkdirSync(outputDir, { recursive: true });
+        }
+        const outputPath = path.join(outputDir, 'complete-workflow-demo.pdf');
+        await client.documents.download(doc.document_id, outputPath); //document-815b139b-12dd-46de-ab42-0e832bf6f7b0
+        console.log('✅ PDF downloaded!');
+        console.log('   Saved to:', outputPath);
+        console.log('');
+        */
+
+        /*
+        // Step 5: Get Statistics
+        console.log('Step 5: Getting statistics...\n');
+        const appDetails = await client.applications.get(app.app_id);
+        const templates = await client.templates.list(app.templateId);
+        const documents = await client.documents.list(app.documentId);
+
+        console.log('✅ Statistics:');
+        console.log(`   Application: ${appDetails.name}`);
+        console.log(`   Templates created: ${templates.length}`);
+        console.log(`   Total documents: ${documents.length}`);
+        console.log('');
+        */
+
+        /*
+        // Step 6: Cleanup
+        console.log('Step 6: Cleaning up...\n');
+        await client.documents.delete(doc.document_id);
+        console.log('✅ Document deleted');
+        await client.templates.delete(template.template_id);
+        console.log('✅ Template deleted');
+        await client.applications.delete(app.app_id);
+        console.log('✅ Application deleted');
+        console.log('');
+        */
+
+        console.log('='.repeat(50));
+        console.log('🎉 Complete workflow finished successfully!\n');
+        console.log('Summary:');
+        console.log('  ✅ Created application');
+        console.log('  ✅ Created template');
+        console.log('  ✅ Generated PDF');
+        console.log('  ✅ Downloaded PDF');
+        console.log('  ✅ Cleaned up resources');
+        console.log('');
+        console.log(`PDF saved at: ${outputPath}`);
+        console.log('');
+        
+        
+
+    } catch (error) {
+        console.error('\n❌ Workflow failed:', error.message);
+        if (error.statusCode) {
+            console.error('Status Code:', error.statusCode);
+        }
+    }
+}
+
+completeWorkflow();

package/examples/generate-pdf.js

@@ -0,0 +1,325 @@
+require('dotenv').config();
+const Docstron = require('../index');
+const fs = require('fs');
+const path = require('path');
+
+async function generatePdfExample() {
+    const apiKey = process.env.DOCSTRON_API_KEY;
+    const appId = process.env.DOCSTRON_APP_ID;
+    const templateId = process.env.DOCSTRON_TEMPLATE_ID;
+
+    if (!apiKey || !appId) {
+        console.error('❌ Missing credentials. Please check your .env file for DOCSTRON_API_KEY and DOCSTRON_APP_ID');
+        process.exit(1);
+    }
+
+    if (templateId === 'template-your-id-here') {
+        console.error('❌ Please set DOCSTRON_TEMPLATE_ID in your .env file');
+        console.error('   Or replace "template-your-id-here" with your actual template ID in the code');
+        process.exit(1);
+    }
+
+    const client = new Docstron(apiKey);
+
+    try {
+        console.log('🎯 Docstron SDK v' + Docstron.getVersion());
+        console.log('📄 PDF Generation Examples\n');
+        console.log('='.repeat(50));
+
+        /*
+        // STEP 1: Creating a template first        
+        console.log('\n 📝 Step 1: Creating a template...');
+        const template = await client.templates.create({
+            application_id: appId,
+            name: 'Invoice Template - ' + Date.now(),
+            content:
+                `<!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>
+                `
+        });
+        console.log('✅ Template created: ', template.template_id);
+        */
+
+
+        // STEP 2: Generate PDF with document_id response
+        /*
+        console.log('📄 Step 2: Generating PDF (document_id response)...');
+        const doc1 = await client.documents.generate('template-940dedbf-30af-422f-8aff-7e8b05f0ad70', {
+            data: {
+                invoice_number: 'INV-2025-001',
+                date: new Date().toLocaleDateString(),
+                customer_name: 'John Doe',
+                customer_email: 'john.doe@example.com',
+                item_name: 'Product A',
+                quantity: 2,
+                price: '$50',
+                total: '$100'
+            },
+            response_type: 'document_id'
+        });
+        console.log('✅ PDF generated!');
+        console.log('  Document ID: ', doc1.document_id);
+        console.log('  Document URL: ', doc1.download_url);
+        */
+
+        /*
+        console.log('📄 Step 2: Generating PDF (document_id response)...');
+        const doc1 = await client.documents.generate('template-5f7ef2fd-3d83-47f8-9fc9-e6820ad52adb', {
+            data: {
+                invoice_number: 'INV-2025-001',
+                invoice_date: new Date().toLocaleDateString(),
+                customer_name: 'Acme Corporation',
+                customer_email: 'billing@acme.com',
+                customer_address: '123 Business St, New York, NY 10001',
+                item_description: 'Web Development Services',
+                item_quantity: '40 hours',
+                item_rate: '$100/hour',
+                item_amount: '$4,000.00',
+                subtotal: '$4,000.00',
+                tax_rate: '10',
+                tax_amount: '$400.00',
+                total_amount: '$4,400.00',
+                notes: 'Payment due within 30 days',
+                company_name: 'Your Company Inc.',
+                company_address: '456 Company Ave, San Francisco, CA 94102',
+                company_email: 'info@yourcompany.com',
+                company_phone: '+1 (555) 123-4567'
+            },
+            response_type: 'document_id'
+        });
+        console.log('✅ PDF generated!');
+        console.log('  Document ID: ', doc1.document_id);
+        console.log('  Document URL: ', doc1.download_url);
+        */
+
+        /*
+        // Step 3: Generate PDF with base64 response
+        console.log('\n📄 Step 3: Generating PDF (base64 response)...');
+        const doc2 = await client.documents.generate(template.template_id, {
+            data: {
+                invoice_number: 'INV-2025-002',
+                date: new Date().toLocaleDateString(),
+                customer_name: 'Jane Smith',
+                customer_email: 'jane@example.com',
+                item_name: 'Consulting Services',
+                quantity: '20 hours',
+                price: '$150/hr',
+                total: '$3,000.00'
+            },
+            response_type: 'json_with_base64'
+        });
+        console.log('✅ PDF generated!');
+        console.log('   Document ID:', doc2.document_id);
+        console.log('   Filename:', doc2.filename);
+        console.log('   Size:', doc2.size_bytes, 'bytes');
+        console.log('   Base64 length:', doc2.pdf_content.length, 'characters');
+        */
+
+        // Step 4: Download the PDF
+
+        console.log('\n 📥 Step 4: Downloading PDF...');
+        const outputPath = path.join(__dirname, '../output', `invoice-${'document-004e98bf-76a7-4548-934e-d95912f7ead9'}.pdf`);
+
+        // Create output directory if it doesn't exist
+        const outputDir = path.dirname(outputPath);
+        if (!fs.existsSync(outputDir)) {
+            fs.mkdirSync(outputDir, { recursive: true });
+        }
+
+        const pdfBuffer = await client.documents.download('document-004e98bf-76a7-4548-934e-d95912f7ead9', outputPath);
+        console.log('✅ PDF downloaded!');
+        console.log('   Saved to:', outputPath);
+        console.log('   Size:', pdfBuffer.length, 'bytes');
+
+
+        // Step 5: Get document details
+        /*
+        console.log('\n📖 Step 5: Getting document details...');
+        const docDetails = await client.documents.get(doc1.document_id);
+        console.log('✅ Document details retrieved!');
+        console.log('   Template ID:', docDetails.template_id);
+        console.log('   Created:', docDetails.created_at);
+        */
+
+        // Step 6: List all documents
+        /*
+        console.log('\n📋 Step 6: Listing all documents...');
+        const allDocs = await client.documents.list();
+        console.log('✅ Found', allDocs.length, 'documents');
+        */
+
+        // Clean up
+        /*
+        console.log('\n🧹 Cleaning up...');
+        await client.documents.delete(doc1.document_id);
+        await client.documents.delete(doc2.document_id);
+        await client.templates.delete(template.template_id);
+        console.log('✅ Test data cleaned up');
+        */
+
+        // Example 1: Simple PDF generation with document_id response
+        /*
+        console.log('📝 Example 1: Generate PDF (get download URL)...\n');
+        const invoice1 = await client.documents.generate(templateId, {
+            data: {
+                invoice_number: 'INV-2025-001',
+                invoice_date: new Date().toLocaleDateString(),
+                customer_name: 'Acme Corporation',
+                customer_email: 'billing@acme.com',
+                customer_address: '123 Business St, New York, NY 10001',
+                item_description: 'Web Development Services',
+                item_quantity: '40 hours',
+                item_rate: '$100/hour',
+                item_amount: '$4,000.00',
+                subtotal: '$4,000.00',
+                tax_rate: '10',
+                tax_amount: '$400.00',
+                total_amount: '$4,400.00',
+                notes: 'Payment due within 30 days',
+                company_name: 'Your Company Inc.',
+                company_address: '456 Company Ave, San Francisco, CA 94102',
+                company_email: 'info@yourcompany.com',
+                company_phone: '+1 (555) 123-4567'
+            },
+            response_type: 'document_id'
+        });
+        console.log('✅ PDF Generated!');
+        const outputPath2 = path.join(__dirname, '../output', `invoice-${invoice1.document_id}.pdf`);
+        const pdfBuffer2 = await client.documents.download(invoice1.document_id, outputPath2);
+        console.log('✅ PDF downloaded!');
+        console.log('   Saved to:', outputPath2);
+        console.log('   Size:', pdfBuffer2.length, 'bytes');
+        */
+
+        console.log('\n' + '='.repeat(50));
+        console.log('🎉 All PDF generation examples completed successfully!\n');
+
+    } catch (error) {
+        console.error('\n❌ Error:', error.message);
+        if (error.statusCode) {
+            console.error('Status Code:', error.statusCode);
+        }
+    }
+}
+
+generatePdfExample();