npm - totalum-api-sdk - Versions diffs - 3.0.1 → 3.0.3 - Mend

totalum-api-sdk 3.0.1 → 3.0.3

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 (8) hide show

package/README.MD +9 -9
package/dist/common/interfaces.d.ts +1 -0
package/dist/common/response-types.d.ts +0 -29
package/dist/services/FilesService.d.ts +9 -6
package/dist/services/FilesService.js +2 -2
package/dist/test-all-endpoints.d.ts +1 -0
package/dist/test-all-endpoints.js +686 -0
package/package.json +8 -4

package/README.MD CHANGED Viewed

@@ -1,4 +1,4 @@
-## Totalum API SDK (v3.0.1)
+## Totalum API SDK (v3.0.2)
 Official TypeScript/JavaScript SDK for the Totalum API. This library provides a fully typed, modern interface to interact with all Totalum endpoints.
@@ -48,7 +48,7 @@ await totalumClient.crud.getManyToManyReferencesRecords(table, id, prop, query);
 ```javascript
 // v2.x (using axios)
 const result = await totalumClient.crud.getItems(table, {});
-const items = result.data.data;  // Double .data because of axios wrapper
+const items = result.data;  // Double .data because of axios wrapper
 // v3.0 (using fetch)
 const result = await totalumClient.crud.getRecords(table, {});
@@ -64,7 +64,7 @@ const records = result.data;  // Direct access to data
 // v2.x (axios throws errors)
 try {
     const result = await totalumClient.crud.getItems(table, {});
-    const items = result.data.data;
+    const items = result.data;
 } catch (error) {
     console.error('Error:', error.message);
 }
@@ -178,7 +178,7 @@ const result = await totalumClient.crud.getRecords('your_table_name', {});
 ```html
 <head>
-    <script src="https://cdn.jsdelivr.net/npm/totalum-api-sdk@3.0.1/dist/totalum-sdk.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/totalum-api-sdk@3.0.2/dist/totalum-sdk.min.js"></script>
 </head>
   <script>
     //Example of use TotalumSdk in your custom html page
@@ -414,7 +414,7 @@ const tableNameToGet = 'client';
 const result = await totalumClient.filter.nestedFilter(nestedFilter, tableNameToGet, filterOptions);
-const clients = result.data.data;
+const clients = result.data;
 ```
@@ -461,7 +461,7 @@ const tableNameToGet = 'product';
 const result = await totalumClient.filter.nestedFilter(nestedFilter, tableNameToGet, filterOptions);
-const products = result.data.data;
+const products = result.data;
 ```
@@ -911,7 +911,7 @@ Depending on the platform you are using, you will need to transform the file to
             'api-key': 'your api key here', // replace 'your api key here' with your api key
         }
     });
-    const fileNameId = result.data.data;
+    const fileNameId = result.data;
 ```
@@ -1082,7 +1082,7 @@ if (result.errors) {
     return;
 }
-const invoiceData = result.data.data;
+const invoiceData = result.data;
 const metadata = result.data.metadata;
 console.log('Invoice data:', invoiceData);
@@ -1136,7 +1136,7 @@ if (result.errors) {
     return;
 }
-const documentData = result.data.data;
+const documentData = result.data;
 const metadata = result.data.metadata;
 console.log('Extracted data:', documentData);

package/dist/common/interfaces.d.ts CHANGED Viewed

@@ -10,6 +10,7 @@ export interface ErrorResult {
 export interface TotalumApiResponse<T> {
     data?: T;
     errors?: ErrorResult | null;
+    metadata?: any;
 }
 export interface StructureLevels {
     id: string;

package/dist/common/response-types.d.ts CHANGED Viewed

@@ -17,12 +17,6 @@ export interface DeleteObjectResponse {
     /** The number of documents that were deleted */
     deletedCount: number;
 }
-export interface GetObjectsResponse<T = DataValues> {
-    data: T[];
-    metadata?: {
-        count?: number;
-    };
-}
 export interface FileUploadResponse {
     fileName: string;
 }
@@ -74,23 +68,6 @@ export interface ScanInvoiceData {
         [key: string]: any;
     };
 }
-export interface ScanInvoiceResponse {
-    data: ScanInvoiceData;
-    metadata: {
-        ocrFullResult?: any;
-        usageUnits: number;
-        exactUsageUnits: number;
-    };
-}
-export interface ScanDocumentResponse {
-    data: any;
-    metadata: {
-        ocrFullResult?: any;
-        ocrFullResultText?: string;
-        usageUnits: number;
-        exactUsageUnits: number;
-    };
-}
 export interface PdfGenerationResponse {
     fileName: string;
 }
@@ -143,12 +120,6 @@ export interface LookupFilterResult {
     result: DataValues[] | number;
     count?: number;
 }
-export interface NestedFilterResponse {
-    data: DataValues[];
-    metadata?: {
-        count?: number;
-    };
-}
 export type CustomAggregationResponse = any;
 export interface NotificationVisibility {
     sendTo: "all" | "admins" | "specificUsers";

package/dist/services/FilesService.d.ts CHANGED Viewed

@@ -1,5 +1,5 @@
 import { TotalumApiResponse } from "../common/interfaces";
-import { FileDeleteResponse, OcrImageResponse, OcrPdfResponse, ScanInvoiceResponse, ScanDocumentResponse } from "../common/response-types";
+import { FileDeleteResponse, OcrImageResponse, OcrPdfResponse, ScanInvoiceData } from "../common/response-types";
 import { FetchClient } from "../common/fetch-client";
 export declare class FilesService {
     private client;
@@ -45,12 +45,15 @@ export declare class FilesService {
      * @param {object} data - PDF creation data
      * @param {string} data.html - HTML content to convert
      * @param {string} data.name - Name for the generated PDF
-     * @returns {Promise<TotalumApiResponse<string>>} - The generated PDF filename
+     * @returns {Promise<TotalumApiResponse<{url: string, fileName: string}>>} - The generated PDF url
      */
     createPdfFromHtml(data: {
         html: string;
         name: string;
-    }): Promise<TotalumApiResponse<string>>;
+    }): Promise<TotalumApiResponse<{
+        url: string;
+        fileName: string;
+    }>>;
     /**
      * Performs OCR on an image file.
      * @param {string} fileName - The file name of the uploaded image
@@ -68,9 +71,9 @@ export declare class FilesService {
      * The response includes both data and metadata with OCR details and usage tracking.
      * @param {string} fileName - The file name of the uploaded invoice
      * @param {any} options - Optional scanning options
-     * @returns {Promise<TotalumApiResponse<ScanInvoiceResponse>>}
+     * @returns {Promise<TotalumApiResponse<ScanInvoiceData>>}
      */
-    scanInvoice(fileName: string, options?: any): Promise<TotalumApiResponse<ScanInvoiceResponse>>;
+    scanInvoice(fileName: string, options?: any): Promise<TotalumApiResponse<ScanInvoiceData>>;
     /**
      * Scans a document and extracts specified properties.
      * The response includes both data (based on provided schema) and metadata with OCR details.
@@ -79,5 +82,5 @@ export declare class FilesService {
      * @param {any} options - Optional scanning options
      * @returns {Promise<TotalumApiResponse<ScanDocumentResponse>>}
      */
-    scanDocument(fileName: string, properties: any, options?: any): Promise<TotalumApiResponse<ScanDocumentResponse>>;
+    scanDocument(fileName: string, properties: any, options?: any): Promise<TotalumApiResponse<any>>;
 }

package/dist/services/FilesService.js CHANGED Viewed

@@ -73,7 +73,7 @@ class FilesService {
      * @param {object} data - PDF creation data
      * @param {string} data.html - HTML content to convert
      * @param {string} data.name - Name for the generated PDF
-     * @returns {Promise<TotalumApiResponse<string>>} - The generated PDF filename
+     * @returns {Promise<TotalumApiResponse<{url: string, fileName: string}>>} - The generated PDF url
      */
     createPdfFromHtml(data) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -118,7 +118,7 @@ class FilesService {
      * The response includes both data and metadata with OCR details and usage tracking.
      * @param {string} fileName - The file name of the uploaded invoice
      * @param {any} options - Optional scanning options
-     * @returns {Promise<TotalumApiResponse<ScanInvoiceResponse>>}
+     * @returns {Promise<TotalumApiResponse<ScanInvoiceData>>}
      */
     scanInvoice(fileName, options) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/test-all-endpoints.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/dist/test-all-endpoints.js ADDED Viewed

@@ -0,0 +1,686 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+const axios_1 = __importDefault(require("axios"));
+/**
+ * Comprehensive test suite for all Totalum API SDK endpoints
+ *
+ * This test is fully autonomous - it will:
+ * - Create a test table with properties
+ * - Create and test records
+ * - Generate PDF files for testing
+ * - Clean up everything at the end
+ *
+ * To run this test:
+ * 1. Set your API key: export TOTALUM_API_KEY=your-key-here
+ * 2. Run: npm run test-endpoints
+ */
+// Configuration
+const CONFIG = {
+    API_KEY: '',
+    //BASE_URL: 'https://api.sp-dev-tot-env.app/',
+    BASE_URL: 'http://localhost:9000/',
+    TEST_TABLE_NAME: `sdk_test_${Date.now()}`, // Unique table name
+    TEST_TABLE_ID: '', //no need to set this
+    TEST_RECORD_ID: '', //no need to set this
+    TEST_USER_EMAIL: 'contacto@totalum.app',
+};
+// Color codes for console output
+const colors = {
+    reset: '\x1b[0m',
+    green: '\x1b[32m',
+    red: '\x1b[31m',
+    yellow: '\x1b[33m',
+    blue: '\x1b[36m',
+    gray: '\x1b[90m',
+};
+// Test results tracking
+let totalTests = 0;
+let passedTests = 0;
+let failedTests = 0;
+let skippedTests = 0;
+// Validate API key
+if (!CONFIG.API_KEY || CONFIG.API_KEY === 'your-api-key-here') {
+    console.error(`${colors.red}✗ ERROR: TOTALUM_API_KEY environment variable is not set${colors.reset}`);
+    console.log(`${colors.yellow}Please set your API key:${colors.reset}`);
+    console.log(`  export TOTALUM_API_KEY=your-key-here`);
+    console.log(`  npm run test-endpoints\n`);
+    process.exit(1);
+}
+// Initialize SDK
+let sdk;
+try {
+    sdk = new index_1.TotalumApiSdk({
+        apiKey: { 'api-key': CONFIG.API_KEY },
+        baseUrl: CONFIG.BASE_URL
+    });
+    console.log(`${colors.blue}✓ SDK initialized successfully${colors.reset}\n`);
+}
+catch (error) {
+    console.error(`${colors.red}✗ Failed to initialize SDK: ${error}${colors.reset}`);
+    process.exit(1);
+}
+// Axios instance for direct API calls (for table creation/deletion)
+const axiosInstance = axios_1.default.create({
+    baseURL: CONFIG.BASE_URL,
+    headers: {
+        'api-key': CONFIG.API_KEY,
+        'Content-Type': 'application/json',
+    },
+});
+// Helper functions
+function logTest(name) {
+    console.log(`${colors.gray}Testing: ${name}${colors.reset}`);
+}
+function logSuccess(name, data) {
+    totalTests++;
+    passedTests++;
+    console.log(`${colors.green}✓ ${name}${colors.reset}`);
+    if (data) {
+        console.log(`  ${colors.gray}Response:${colors.reset}`, JSON.stringify(data, null, 2));
+    }
+    console.log('');
+}
+function logError(name, error) {
+    totalTests++;
+    failedTests++;
+    console.error(`${colors.red}✗ ${name}${colors.reset}`);
+    console.error(`  ${colors.red}Error:${colors.reset}`, (error === null || error === void 0 ? void 0 : error.message) || error);
+    console.log('');
+}
+function logSkip(name, reason) {
+    totalTests++;
+    skippedTests++;
+    console.log(`${colors.yellow}⊘ ${name} (SKIPPED)${colors.reset}`);
+    if (reason) {
+        console.log(`  ${colors.gray}Reason: ${reason}${colors.reset}`);
+    }
+    console.log('');
+}
+function logSection(name) {
+    console.log(`\n${colors.blue}${'='.repeat(60)}${colors.reset}`);
+    console.log(`${colors.blue}${name}${colors.reset}`);
+    console.log(`${colors.blue}${'='.repeat(60)}${colors.reset}\n`);
+}
+// Setup and teardown functions
+function setupTestTable() {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b;
+        logSection('SETUP: Creating Test Table');
+        try {
+            logTest('Create test table structure');
+            const createTableResponse = yield axiosInstance.post('/api/v1/data-structure/', {
+                type: CONFIG.TEST_TABLE_NAME,
+            });
+            if ((_b = (_a = createTableResponse.data) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.insertedId) {
+                CONFIG.TEST_TABLE_ID = createTableResponse.data.data.insertedId.toString();
+                logSuccess('Create test table structure', { tableId: CONFIG.TEST_TABLE_ID });
+            }
+            else {
+                throw new Error('Failed to get table ID from response');
+            }
+        }
+        catch (error) {
+            logError('Create test table structure', error);
+            throw error;
+        }
+        // Create properties for the test table
+        const properties = [
+            {
+                id: 'name',
+                name: 'Name',
+                propertyType: 'string',
+                required: true,
+            },
+            {
+                id: 'description',
+                name: 'Description',
+                propertyType: 'long-string',
+            },
+            {
+                id: 'value',
+                name: 'Value',
+                propertyType: 'number',
+            }
+        ];
+        for (const property of properties) {
+            try {
+                logTest(`Create property: ${property.name}`);
+                yield axiosInstance.post(`/api/v1/data-structure/${CONFIG.TEST_TABLE_ID}/property`, property);
+                logSuccess(`Create property: ${property.name}`);
+            }
+            catch (error) {
+                logError(`Create property: ${property.name}`, error);
+                throw error;
+            }
+        }
+        console.log(`${colors.green}✓ Test table setup complete${colors.reset}\n`);
+    });
+}
+function teardownTestTable() {
+    return __awaiter(this, void 0, void 0, function* () {
+        logSection('TEARDOWN: Cleaning Up Test Table');
+        if (!CONFIG.TEST_TABLE_ID) {
+            console.log(`${colors.yellow}No test table to clean up${colors.reset}\n`);
+            return;
+        }
+        try {
+            logTest('Delete test table structure');
+            yield axiosInstance.delete(`/api/v1/data-structure/${CONFIG.TEST_TABLE_ID}`);
+            logSuccess('Delete test table structure');
+        }
+        catch (error) {
+            logError('Delete test table structure', error);
+        }
+        console.log(`${colors.green}✓ Test table cleanup complete${colors.reset}\n`);
+    });
+}
+// Main test function
+function runTests() {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+        console.log(`${colors.blue}╔${'═'.repeat(58)}╗${colors.reset}`);
+        console.log(`${colors.blue}║  TOTALUM API SDK - COMPREHENSIVE ENDPOINT TEST SUITE  ║${colors.reset}`);
+        console.log(`${colors.blue}╚${'═'.repeat(58)}╝${colors.reset}\n`);
+        try {
+            // Setup test environment
+            yield setupTestTable();
+            // ===========================================
+            // 1. CRUD SERVICE TESTS
+            // ===========================================
+            logSection('1. CRUD SERVICE TESTS');
+            // Test: Create Record
+            try {
+                logTest('crud.createRecord');
+                const createResult = yield sdk.crud.createRecord(CONFIG.TEST_TABLE_NAME, {
+                    name: 'Test Record',
+                    description: 'Created by SDK test suite',
+                    value: 123,
+                    isActive: true,
+                });
+                if (createResult.errors) {
+                    logError('crud.createRecord', createResult.errors);
+                }
+                else if (createResult.data) {
+                    CONFIG.TEST_RECORD_ID = createResult.data._id;
+                    logSuccess('crud.createRecord', { recordId: CONFIG.TEST_RECORD_ID });
+                }
+            }
+            catch (error) {
+                logError('crud.createRecord', error);
+            }
+            // Test: Get Record by ID
+            if (CONFIG.TEST_RECORD_ID) {
+                try {
+                    logTest('crud.getRecordById');
+                    const getResult = yield sdk.crud.getRecordById(CONFIG.TEST_TABLE_NAME, CONFIG.TEST_RECORD_ID);
+                    if (getResult.errors) {
+                        logError('crud.getRecordById', getResult.errors);
+                    }
+                    else {
+                        logSuccess('crud.getRecordById', { name: (_a = getResult.data) === null || _a === void 0 ? void 0 : _a.name });
+                    }
+                }
+                catch (error) {
+                    logError('crud.getRecordById', error);
+                }
+            }
+            else {
+                logSkip('crud.getRecordById', 'No record ID available');
+            }
+            // Test: Get Records (with query)
+            try {
+                logTest('crud.getRecords');
+                const getRecordsResult = yield sdk.crud.getRecords(CONFIG.TEST_TABLE_NAME, {
+                    filter: [{ name: 'Test Record' }],
+                    pagination: { limit: 10, page: 1 },
+                    returnCount: true,
+                });
+                if (getRecordsResult.errors) {
+                    logError('crud.getRecords', getRecordsResult.errors);
+                }
+                else {
+                    logSuccess('crud.getRecords', {
+                        recordCount: Array.isArray(getRecordsResult.data) ? getRecordsResult.data.length : 0,
+                    });
+                }
+            }
+            catch (error) {
+                logError('crud.getRecords', error);
+            }
+            // Test: Edit Record by ID
+            if (CONFIG.TEST_RECORD_ID) {
+                try {
+                    logTest('crud.editRecordById');
+                    const editResult = yield sdk.crud.editRecordById(CONFIG.TEST_TABLE_NAME, CONFIG.TEST_RECORD_ID, { description: 'Updated by SDK test suite', value: 456 });
+                    if (editResult.errors) {
+                        logError('crud.editRecordById', editResult.errors);
+                    }
+                    else {
+                        logSuccess('crud.editRecordById', { value: (_b = editResult.data) === null || _b === void 0 ? void 0 : _b.value });
+                    }
+                }
+                catch (error) {
+                    logError('crud.editRecordById', error);
+                }
+            }
+            else {
+                logSkip('crud.editRecordById', 'No record ID available');
+            }
+            // Test: Get Historic Record Updates
+            if (CONFIG.TEST_RECORD_ID) {
+                try {
+                    logTest('crud.getHistoricRecordUpdatesById');
+                    const historyResult = yield sdk.crud.getHistoricRecordUpdatesById(CONFIG.TEST_RECORD_ID);
+                    if (historyResult.errors) {
+                        logError('crud.getHistoricRecordUpdatesById', historyResult.errors);
+                    }
+                    else {
+                        logSuccess('crud.getHistoricRecordUpdatesById', {
+                            updateCount: Array.isArray(historyResult.data) ? historyResult.data.length : 0,
+                        });
+                    }
+                }
+                catch (error) {
+                    logError('crud.getHistoricRecordUpdatesById', error);
+                }
+            }
+            else {
+                logSkip('crud.getHistoricRecordUpdatesById', 'No record ID available');
+            }
+            // Test: Get Nested Data
+            try {
+                logTest('crud.getNestedData');
+                const nestedResult = yield sdk.crud.getNestedData({
+                    [CONFIG.TEST_TABLE_NAME]: {
+                        tableFilter: { filter: [{ name: 'Test Record' }] },
+                    },
+                });
+                if (nestedResult.errors) {
+                    logError('crud.getNestedData', nestedResult.errors);
+                }
+                else {
+                    logSuccess('crud.getNestedData', {
+                        resultCount: Array.isArray(nestedResult.data) ? nestedResult.data.length : 0,
+                    });
+                }
+            }
+            catch (error) {
+                logError('crud.getNestedData', error);
+            }
+            // Test: Add Many-to-Many Reference (skip if no reference data)
+            logSkip('crud.addManyToManyReferenceRecord', 'Requires specific reference configuration');
+            // Test: Get Many-to-Many References
+            logSkip('crud.getManyToManyReferencesRecords', 'Requires specific reference configuration');
+            // Test: Drop Many-to-Many Reference
+            logSkip('crud.dropManyToManyReferenceRecord', 'Requires specific reference configuration');
+            // Test: Delete Record by ID (run last for CRUD tests)
+            if (CONFIG.TEST_RECORD_ID) {
+                try {
+                    logTest('crud.deleteRecordById');
+                    const deleteResult = yield sdk.crud.deleteRecordById(CONFIG.TEST_TABLE_NAME, CONFIG.TEST_RECORD_ID);
+                    if (deleteResult.errors) {
+                        logError('crud.deleteRecordById', deleteResult.errors);
+                    }
+                    else {
+                        logSuccess('crud.deleteRecordById', { acknowledged: (_c = deleteResult.data) === null || _c === void 0 ? void 0 : _c.acknowledged });
+                    }
+                }
+                catch (error) {
+                    logError('crud.deleteRecordById', error);
+                }
+            }
+            else {
+                logSkip('crud.deleteRecordById', 'No record ID available');
+            }
+            // ===========================================
+            // 2. FILTER SERVICE TESTS
+            // ===========================================
+            logSection('2. FILTER SERVICE TESTS');
+            // Test: Nested Filter
+            try {
+                logTest('filter.nestedFilter');
+                const nestedFilterResult = yield sdk.filter.nestedFilter({
+                    [CONFIG.TEST_TABLE_NAME]: {
+                        tableFilter: [],
+                    },
+                }, CONFIG.TEST_TABLE_NAME, { pagination: { limit: 5, page: 1 } });
+                if (nestedFilterResult.errors) {
+                    logError('filter.nestedFilter', nestedFilterResult.errors);
+                }
+                else {
+                    logSuccess('filter.nestedFilter', {
+                        resultCount: Array.isArray(nestedFilterResult.data) ? nestedFilterResult.data.length : 0,
+                    });
+                }
+            }
+            catch (error) {
+                logError('filter.nestedFilter', error);
+            }
+            // Test: Lookup Filter (deprecated)
+            logSkip('filter.lookUpFilter', 'Deprecated - use nestedFilter instead');
+            // Test: Run Custom Mongo Aggregation Query
+            logSkip('filter.runCustomMongoAggregationQuery', 'Requires custom MongoDB query configuration');
+            // ===========================================
+            // 3. FILES SERVICE TESTS
+            // ===========================================
+            logSection('3. FILES SERVICE TESTS');
+            // Test: Generate PDF from HTML (do this first to use for file tests)
+            let generatedPdfFileName;
+            try {
+                logTest('files.createPdfFromHtml');
+                const pdfResult = yield sdk.files.createPdfFromHtml({
+                    html: '<html><body><h1>Test PDF</h1><p>Generated by SDK test suite for testing file operations</p></body></html>',
+                    name: 'test-pdf.pdf',
+                });
+                if (pdfResult.errors) {
+                    logError('files.createPdfFromHtml', pdfResult.errors);
+                }
+                else if (pdfResult.data) {
+                    generatedPdfFileName = pdfResult.data.fileName;
+                    logSuccess('files.createPdfFromHtml', { fileName: pdfResult.data });
+                }
+            }
+            catch (error) {
+                logError('files.createPdfFromHtml', error);
+            }
+            // Test: Upload File
+            let uploadedFileName;
+            try {
+                logTest('files.uploadFile');
+                // Create a simple test file
+                const fileContent = 'This is a test file created by the SDK test suite';
+                const blob = new Blob([fileContent], { type: 'text/plain' });
+                const formData = new FormData();
+                formData.append('file', blob, 'test-file.txt');
+                const uploadResult = yield sdk.files.uploadFile(formData);
+                if (uploadResult.errors) {
+                    logError('files.uploadFile', uploadResult.errors);
+                }
+                else if (uploadResult.data) {
+                    uploadedFileName = uploadResult.data;
+                    logSuccess('files.uploadFile', { fileName: uploadResult.data });
+                }
+            }
+            catch (error) {
+                logError('files.uploadFile', error);
+            }
+            // Test: Get Download URL (use generated PDF)
+            if (generatedPdfFileName) {
+                try {
+                    logTest('files.getDownloadUrl');
+                    const downloadUrlResult = yield sdk.files.getDownloadUrl(generatedPdfFileName);
+                    if (downloadUrlResult.errors) {
+                        logError('files.getDownloadUrl', downloadUrlResult.errors);
+                    }
+                    else {
+                        logSuccess('files.getDownloadUrl', { urlExists: !!downloadUrlResult.data });
+                    }
+                }
+                catch (error) {
+                    logError('files.getDownloadUrl', error);
+                }
+            }
+            else {
+                logSkip('files.getDownloadUrl', 'No PDF file available');
+            }
+            // Test: Generate PDF by Template
+            logSkip('files.generatePdfByTemplate', 'Requires template configuration');
+            // Test: OCR of Image
+            logSkip('files.ocrOfImage', 'Requires uploaded image file');
+            // Test: OCR of PDF (use generated PDF)
+            if (generatedPdfFileName) {
+                try {
+                    logTest('files.ocrOfPdf');
+                    const ocrResult = yield sdk.files.ocrOfPdf(generatedPdfFileName);
+                    if (ocrResult.errors) {
+                        logError('files.ocrOfPdf', ocrResult.errors);
+                    }
+                    else {
+                        logSuccess('files.ocrOfPdf', {
+                            pageCount: Array.isArray((_d = ocrResult.data) === null || _d === void 0 ? void 0 : _d.pages)
+                                ? ocrResult.data.pages.length
+                                : 0,
+                        });
+                    }
+                }
+                catch (error) {
+                    logError('files.ocrOfPdf', error);
+                }
+            }
+            else {
+                logSkip('files.ocrOfPdf', 'No PDF file available');
+            }
+            // Test: Scan Invoice
+            logSkip('files.scanInvoice', 'Requires uploaded invoice file');
+            // Test: Scan Document
+            logSkip('files.scanDocument', 'Requires uploaded document file and schema');
+            // Test: Delete Files (cleanup)
+            if (uploadedFileName) {
+                try {
+                    logTest('files.deleteFile (uploaded file)');
+                    const deleteFileResult = yield sdk.files.deleteFile(uploadedFileName);
+                    if (deleteFileResult.errors) {
+                        logError('files.deleteFile (uploaded file)', deleteFileResult.errors);
+                    }
+                    else {
+                        logSuccess('files.deleteFile (uploaded file)', { acknowledged: (_e = deleteFileResult.data) === null || _e === void 0 ? void 0 : _e.acknowledged });
+                    }
+                }
+                catch (error) {
+                    logError('files.deleteFile (uploaded file)', error);
+                }
+            }
+            if (generatedPdfFileName) {
+                try {
+                    logTest('files.deleteFile (generated PDF)');
+                    const deleteFileResult = yield sdk.files.deleteFile(generatedPdfFileName);
+                    if (deleteFileResult.errors) {
+                        logError('files.deleteFile (generated PDF)', deleteFileResult.errors);
+                    }
+                    else {
+                        logSuccess('files.deleteFile (generated PDF)', { acknowledged: (_f = deleteFileResult.data) === null || _f === void 0 ? void 0 : _f.acknowledged });
+                    }
+                }
+                catch (error) {
+                    logError('files.deleteFile (generated PDF)', error);
+                }
+            }
+            // ===========================================
+            // 4. OPENAI SERVICE TESTS
+            // ===========================================
+            logSection('4. OPENAI SERVICE TESTS');
+            // Test: Create Chat Completion
+            try {
+                logTest('openai.createChatCompletion');
+                const chatResult = yield sdk.openai.createChatCompletion({
+                    model: 'gpt-3.5-turbo',
+                    messages: [{ role: 'user', content: 'Say "SDK test successful" if you can read this.' }],
+                    max_tokens: 50,
+                });
+                if (chatResult.errors) {
+                    logError('openai.createChatCompletion', chatResult.errors);
+                }
+                else {
+                    logSuccess('openai.createChatCompletion', {
+                        response: (_k = (_j = (_h = (_g = chatResult.data) === null || _g === void 0 ? void 0 : _g.choices) === null || _h === void 0 ? void 0 : _h[0]) === null || _j === void 0 ? void 0 : _j.message) === null || _k === void 0 ? void 0 : _k.content,
+                    });
+                }
+            }
+            catch (error) {
+                logError('openai.createChatCompletion', error);
+            }
+            // Test: Create Completion (deprecated)
+            logSkip('openai.createCompletion', 'Deprecated - use createChatCompletion instead');
+            // Test: Generate Image
+            try {
+                logTest('openai.generateImage');
+                const imageResult = yield sdk.openai.generateImage({
+                    prompt: 'A simple test image',
+                    size: '256x256',
+                    fileName: 'test-generated-image.png',
+                });
+                if (imageResult.errors) {
+                    logError('openai.generateImage', imageResult.errors);
+                }
+                else {
+                    logSuccess('openai.generateImage', { fileName: imageResult.data });
+                    // Cleanup generated image
+                    if (imageResult.data) {
+                        try {
+                            yield sdk.files.deleteFile(imageResult.data);
+                        }
+                        catch (e) {
+                            // Ignore cleanup errors
+                        }
+                    }
+                }
+            }
+            catch (error) {
+                logError('openai.generateImage', error);
+            }
+            // ===========================================
+            // 5. NOTIFICATION SERVICE TESTS
+            // ===========================================
+            logSection('5. NOTIFICATION SERVICE TESTS');
+            // Test: Create Notification
+            try {
+                logTest('notification.createNotification');
+                const notificationResult = yield sdk.notification.createNotification({
+                    name: 'Test Notification',
+                    title: 'SDK Test',
+                    description: 'This is a test notification from the SDK test suite',
+                    visibility: {
+                        sendTo: 'specificUsers',
+                        specificUsersEmails: [CONFIG.TEST_USER_EMAIL],
+                    },
+                    action: {
+                        actionType: 'none',
+                    },
+                    email: {
+                        sendEmail: false,
+                    },
+                });
+                if (notificationResult.errors) {
+                    logError('notification.createNotification', notificationResult.errors);
+                }
+                else {
+                    logSuccess('notification.createNotification', { acknowledged: (_l = notificationResult.data) === null || _l === void 0 ? void 0 : _l.acknowledged });
+                }
+            }
+            catch (error) {
+                logError('notification.createNotification', error);
+            }
+            // ===========================================
+            // 6. STATISTIC SERVICE TESTS
+            // ===========================================
+            logSection('6. STATISTIC SERVICE TESTS');
+            // Test: Get Statistic (Quantity)
+            try {
+                logTest('statistic.getStatistic (quantity)');
+                const statisticResult = yield sdk.statistic.getStatistic([], {
+                    statisticType: 'quantity',
+                    tableName: CONFIG.TEST_TABLE_NAME,
+                    propertyName: '_id',
+                });
+                if (statisticResult.errors) {
+                    logError('statistic.getStatistic (quantity)', statisticResult.errors);
+                }
+                else {
+                    logSuccess('statistic.getStatistic (quantity)', { count: statisticResult.data });
+                }
+            }
+            catch (error) {
+                logError('statistic.getStatistic (quantity)', error);
+            }
+            // Test: Get Statistic (Add/Sum)
+            logSkip('statistic.getStatistic (add)', 'Requires numeric property configuration');
+            // ===========================================
+            // 7. EMAIL SERVICE TESTS
+            // ===========================================
+            logSection('7. EMAIL SERVICE TESTS');
+            // Test: Send Email
+            try {
+                logTest('email.sendEmail');
+                const emailResult = yield sdk.email.sendEmail({
+                    to: [CONFIG.TEST_USER_EMAIL],
+                    subject: 'SDK Test Email',
+                    html: '<h1>Test Email</h1><p>This is a test email from the SDK test suite</p>',
+                    fromName: 'SDK Test Suite',
+                });
+                if (emailResult.errors) {
+                    logError('email.sendEmail', emailResult.errors);
+                }
+                else {
+                    logSuccess('email.sendEmail', { emailId: (_m = emailResult.data) === null || _m === void 0 ? void 0 : _m.id });
+                }
+            }
+            catch (error) {
+                logError('email.sendEmail', error);
+            }
+            // Test: Send Email with Attachments
+            logSkip('email.sendEmail (with attachments)', 'Requires valid attachment URLs');
+            // ===========================================
+            // 8. SDK UTILITY TESTS
+            // ===========================================
+            logSection('8. SDK UTILITY TESTS');
+            // Test: Change Base URL
+            try {
+                logTest('sdk.changeBaseUrl');
+                const originalUrl = CONFIG.BASE_URL;
+                sdk.changeBaseUrl('https://api-test.totalum.app/');
+                sdk.changeBaseUrl(originalUrl); // Change back
+                logSuccess('sdk.changeBaseUrl', { message: 'Base URL changed successfully' });
+            }
+            catch (error) {
+                logError('sdk.changeBaseUrl', error);
+            }
+        }
+        finally {
+            // Cleanup test environment
+            yield teardownTestTable();
+        }
+        // ===========================================
+        // FINAL RESULTS
+        // ===========================================
+        console.log(`\n${colors.blue}╔${'═'.repeat(58)}╗${colors.reset}`);
+        console.log(`${colors.blue}║                     TEST RESULTS                       ║${colors.reset}`);
+        console.log(`${colors.blue}╚${'═'.repeat(58)}╝${colors.reset}\n`);
+        console.log(`Total Tests:   ${totalTests}`);
+        console.log(`${colors.green}Passed:        ${passedTests}${colors.reset}`);
+        console.log(`${colors.red}Failed:        ${failedTests}${colors.reset}`);
+        console.log(`${colors.yellow}Skipped:       ${skippedTests}${colors.reset}`);
+        const executedTests = totalTests - skippedTests;
+        const successRate = executedTests > 0 ? ((passedTests / executedTests) * 100).toFixed(2) : '0';
+        console.log(`\nSuccess Rate:  ${successRate}% (excluding skipped tests)\n`);
+        if (failedTests > 0) {
+            console.log(`${colors.red}⚠ Some tests failed. Please check the errors above.${colors.reset}\n`);
+            process.exit(1);
+        }
+        else if (passedTests === 0) {
+            console.log(`${colors.yellow}⚠ No tests passed. Check your configuration and API credentials.${colors.reset}\n`);
+            process.exit(1);
+        }
+        else {
+            console.log(`${colors.green}✓ All executed tests passed successfully!${colors.reset}\n`);
+            process.exit(0);
+        }
+    });
+}
+// Run the tests
+runTests().catch((error) => {
+    console.error(`${colors.red}Unhandled error during test execution:${colors.reset}`, error);
+    process.exit(1);
+});

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "totalum-api-sdk",
-  "version": "3.0.1",
+  "version": "3.0.3",
   "description": "Totalum sdk wrapper and utils of totalum api",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -8,17 +8,21 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsc; npx webpack"
+    "build": "tsc; npx webpack",
+    "test-endpoints": "ts-node test-all-endpoints.ts"
   },
   "author": "Totalum",
   "license": "ISC",
   "devDependencies": {
+    "@types/node": "^24.8.1",
     "@types/qs": "^6.9.7",
+    "axios": "^1.12.2",
+    "openai": "^4.104.0",
     "ts-loader": "^9.5.0",
+    "ts-node": "^10.9.2",
     "typescript": "^5.9.2",
     "webpack": "^5.89.0",
-    "webpack-cli": "^5.1.4",
-    "openai": "^4.104.0"
+    "webpack-cli": "^5.1.4"
   },
   "dependencies": {
     "qs": "^6.11.2"