@ptkl/sdk 0.10.0 → 0.10.1

package/dist/index.iife.js

@@ -532,12 +532,210 @@ var ProtokolSDK010 = (function (exports, axios) {
     }
 
     class Ratchet extends PlatformBaseClient {
+        /**
+         * Get all database connections for the current project
+         *
+         * @returns List of all configured ratchet connections
+         *
+         * @example
+         * ```typescript
+         * const ratchet = new Ratchet();
+         * const connections = await ratchet.getConnections();
+         * console.log(connections.data); // Array of connections
+         * ```
+         */
+        async getConnections() {
+            return await this.client.get("/v1/ratchet/connection");
+        }
+        /**
+         * Get a specific database connection by ID
+         *
+         * @param id - Connection ID
+         * @returns Connection details including queries
+         *
+         * @example
+         * ```typescript
+         * const ratchet = new Ratchet();
+         * const connection = await ratchet.getConnection('users_db');
+         * console.log(connection.data.queries); // Available queries for this connection
+         * ```
+         */
+        async getConnection(id) {
+            return await this.client.get(`/v1/ratchet/connection/${id}`);
+        }
+        /**
+         * Create a new database connection
+         *
+         * Supports multiple database types:
+         * - MySQL: Use credentials with host, dbname, user, password
+         * - PostgreSQL: Use credentials with host, dbname, user, password
+         * - MongoDB: Use DSN connection string
+         * - BigQuery: Use service_account_json and project_id
+         *
+         * @param connection - Connection configuration
+         * @returns Created connection details
+         *
+         * @example
+         * ```typescript
+         * const ratchet = new Ratchet();
+         *
+         * // MySQL/PostgreSQL connection
+         * await ratchet.createConnection({
+         *   id: 'users_db',
+         *   type: 'MySQL',
+         *   credentials: {
+         *     type: 'Credentials',
+         *     host: 'localhost',
+         *     dbname: 'users',
+         *     user: 'admin',
+         *     password: 'secret'
+         *   }
+         * });
+         *
+         * // MongoDB connection
+         * await ratchet.createConnection({
+         *   id: 'mongo_db',
+         *   type: 'MongoDB',
+         *   credentials: {
+         *     type: 'DSN',
+         *     dsn: 'mongodb://localhost:27017/mydb'
+         *   }
+         * });
+         *
+         * // BigQuery connection
+         * await ratchet.createConnection({
+         *   id: 'analytics_bq',
+         *   type: 'BigQuery',
+         *   credentials: {
+         *     type: 'ServiceAccount',
+         *     service_account_json: '{"type":"service_account",...}',
+         *     project_id: 'my-project-id'
+         *   }
+         * });
+         * ```
+         */
+        async createConnection(connection) {
+            return await this.client.post("/v1/ratchet/connection", connection);
+        }
+        /**
+         * Update an existing database connection
+         *
+         * @param connection - Updated connection configuration
+         * @returns Success status
+         *
+         * @example
+         * ```typescript
+         * const ratchet = new Ratchet();
+         * await ratchet.updateConnection({
+         *   id: 'users_db',
+         *   type: 'postgres',
+         *   credentials: {
+         *     type: 'postgres',
+         *     host: 'localhost',
+         *     dbname: 'users',
+         *     user: 'admin',
+         *     password: 'new_secret'
+         *   },
+         *   queries: [
+         *     { id: 'get_user', expression: 'SELECT * FROM users WHERE id = $1' }
+         *   ]
+         * });
+         * ```
+         */
+        async updateConnection(connection) {
+            return await this.client.put("/v1/ratchet/connection", connection);
+        }
+        /**
+         * Delete a database connection
+         *
+         * @param id - Connection ID to delete
+         * @returns Success status
+         *
+         * @example
+         * ```typescript
+         * const ratchet = new Ratchet();
+         * await ratchet.deleteConnection('users_db');
+         * ```
+         */
+        async deleteConnection(id) {
+            return await this.client.delete(`/v1/ratchet/connection/${id}`);
+        }
+        /**
+         * Test a database connection without saving it
+         *
+         * @param connection - Connection configuration to test
+         * @returns Success status if connection is valid
+         *
+         * @example
+         * ```typescript
+         * const ratchet = new Ratchet();
+         * const isValid = await ratchet.testConnection({
+         *   id: 'test_db',
+         *   type: 'postgres',
+         *   credentials: {
+         *     type: 'postgres',
+         *     host: 'localhost',
+         *     dbname: 'test',
+         *     user: 'admin',
+         *     password: 'secret'
+         *   }
+         * });
+         * ```
+         */
+        async testConnection(connection) {
+            return await this.client.post("/v1/ratchet/test/connection", connection);
+        }
+        /**
+         * Execute a predefined database query
+         *
+         * Runs a query that has been previously configured in a ratchet connection.
+         * The query is identified by a qualified name in the format: `connectionId.queryId`
+         *
+         * @param name - Qualified name of the query (format: `connectionId.queryId`)
+         * @param params - Array of parameters to pass to the query
+         * @returns Query execution results
+         *
+         * @example
+         * ```typescript
+         * const ratchet = new Ratchet();
+         *
+         * // Execute a query with parameters
+         * const result = await ratchet.query('users_db.get_user_by_id', [123]);
+         *
+         * // Execute a query without parameters
+         * const allUsers = await ratchet.query('users_db.get_all_users', []);
+         * ```
+         */
         async query(name, params) {
-            return await this.client.post('/v1/ratchet/query', {
+            return await this.client.post("/v1/ratchet/query", {
                 name: name,
-                params: params
+                params: params,
             });
         }
+        /**
+         * Inspect and execute a custom query without saving it
+         *
+         * This allows you to test queries before saving them to a connection.
+         *
+         * @param request - Query inspection request with connection name, query, and params
+         * @returns Query execution results
+         *
+         * @example
+         * ```typescript
+         * const ratchet = new Ratchet();
+         * const result = await ratchet.inspectQuery({
+         *   name: 'users_db.test_query',
+         *   query: {
+         *     id: 'test_query',
+         *     expression: 'SELECT * FROM users WHERE email = $1'
+         *   },
+         *   params: ['user@example.com']
+         * });
+         * ```
+         */
+        async inspectQuery(request) {
+            return await this.client.post("/v1/ratchet/query/inspect", request);
+        }
     }
 
     class Sandbox extends PlatformBaseClient {
@@ -997,6 +1195,23 @@ var ProtokolSDK010 = (function (exports, axios) {
         async libraries() {
             return await this.requestv1("GET", "media/library/list");
         }
+        /**
+         * Upload files using multipart form data
+         *
+         * @param payload - Upload configuration with files, directory, and options
+         * @returns Upload response from the server
+         *
+         * @example
+         * ```typescript
+         * const result = await dms.upload({
+         *   files: [file1, file2],
+         *   uploadDir: '/documents/invoices',
+         *   public: true,
+         *   replace: true,
+         *   metadata: { category: 'finance' }
+         * });
+         * ```
+         */
         async upload(payload) {
             let files = payload.files;
             let formData = new FormData();
@@ -1013,9 +1228,12 @@ var ProtokolSDK010 = (function (exports, axios) {
                 if (payload.public) {
                     formData.append('is_public', "true");
                 }
+                if (payload.replace) {
+                    formData.append('replace', "true");
+                }
                 if (payload.expiresAt)
                     formData.append('expiresAt', new Date(payload.expiresAt).toISOString());
-                if (Object.keys(payload.metadata).length > 0)
+                if (payload.metadata && Object.keys(payload.metadata).length > 0)
                     formData.append('metadata', JSON.stringify(payload.metadata));
                 return await this.request("POST", "media/upload", {
                     data: formData,
@@ -1028,6 +1246,28 @@ var ProtokolSDK010 = (function (exports, axios) {
         async delete(data) {
             return this.request('POST', 'media/delete', data);
         }
+        /**
+         * Upload files using base64-encoded content
+         *
+         * @param data - Upload payload with base64-encoded files
+         * @returns Upload response from the server
+         *
+         * @example
+         * ```typescript
+         * const result = await dms.uploadBase64({
+         *   path: '/documents/reports',
+         *   is_public: false,
+         *   replace: true,
+         *   files: [
+         *     {
+         *       name: 'report.pdf',
+         *       content_type: 'application/pdf',
+         *       data: 'base64EncodedContent...'
+         *     }
+         *   ]
+         * });
+         * ```
+         */
         async uploadBase64(data) {
             return this.request('POST', `media/upload`, {
                 data,
@@ -1036,7 +1276,7 @@ var ProtokolSDK010 = (function (exports, axios) {
                 }
             });
         }
-        async getMedia(lib, key, encoding) {
+        async getMedia(key, encoding) {
             return this.request('GET', `media/get/${key}`, {
                 params: {
                     encoding
@@ -1044,7 +1284,7 @@ var ProtokolSDK010 = (function (exports, axios) {
                 responseType: (!encoding) ? 'blob' : null
             });
         }
-        async download(lib, key) {
+        async download(key) {
             return this.request('POST', `media/download`, {
                 data: {
                     key
@@ -1056,7 +1296,7 @@ var ProtokolSDK010 = (function (exports, axios) {
             return this.request('GET', `media/exif/${key}`);
         }
         async html2pdf(data) {
-            const { output_pdf = false, input_path, input_html, output_path, output_file_name, output_type, data: templateData } = data;
+            const { output_pdf = false, input_path, input_html, output_path, output_file_name, output_type, data: templateData, replace, } = data;
             const type = output_pdf ? 'arraybuffer' : 'json';
             const contentType = output_pdf ? 'application/pdf' : 'application/json';
             return this.request('POST', `media/pdf/html2pdf`, {
@@ -1067,7 +1307,27 @@ var ProtokolSDK010 = (function (exports, axios) {
                     input_html,
                     output_file_name,
                     output_type,
-                    data: templateData
+                    data: templateData,
+                    replace,
+                },
+                headers: {
+                    'Content-Type': contentType
+                },
+                responseType: type
+            });
+        }
+        async pdf2html(data) {
+            const { output_html = false, input_path, input_pdf, output_path, output_file_name, replace, } = data;
+            const type = output_html ? 'arraybuffer' : 'json';
+            const contentType = output_html ? 'text/html' : 'application/json';
+            return this.request('POST', `media/pdf/pdf2html`, {
+                data: {
+                    output_html,
+                    input_path,
+                    output_path,
+                    input_pdf,
+                    output_file_name,
+                    replace,
                 },
                 headers: {
                     'Content-Type': contentType
@@ -1084,8 +1344,8 @@ var ProtokolSDK010 = (function (exports, axios) {
         async dirs(data) {
             return await this.request("POST", `media/library/dirs`, { data });
         }
-        async fillPdf(lib, data) {
-            const { input_path, output_path, output_pdf = false, output_type, output_file_name, form_data, forms } = data;
+        async fillPdf(data) {
+            const { input_path, output_path, output_pdf = false, output_type, output_file_name, replace, form_data, forms } = data;
             const responseType = output_pdf ? 'arraybuffer' : 'json';
             const contentType = output_pdf ? 'application/pdf' : 'application/json';
             return this.request('POST', `media/pdf/fill`, {
@@ -1096,6 +1356,7 @@ var ProtokolSDK010 = (function (exports, axios) {
                     output_type,
                     output_file_name,
                     form_data,
+                    replace,
                     forms
                 },
                 headers: {
@@ -1173,7 +1434,7 @@ var ProtokolSDK010 = (function (exports, axios) {
          * // excelResult.data is a Blob
          * ```
          */
-        async convertData(lib, data, params) {
+        async convertData(data, params) {
             const { from, to, sheet_name, include_header, include_footer, header_as_comment, footer_as_comment, separator_rows, field_order, } = params;
             const queryParams = { from, to };
             // Add optional parameters if provided
@@ -1240,7 +1501,7 @@ var ProtokolSDK010 = (function (exports, axios) {
          * // }
          * ```
          */
-        async getDataInfo(lib, data, params) {
+        async getDataInfo(data, params) {
             const { format } = params;
             return this.request('POST', `media/convert/info`, {
                 data,
@@ -1284,7 +1545,7 @@ var ProtokolSDK010 = (function (exports, axios) {
          * }
          * ```
          */
-        async validateData(lib, data, params) {
+        async validateData(data, params) {
             const { format } = params;
             return this.request('POST', `media/convert/validate`, {
                 data,
@@ -1332,7 +1593,7 @@ var ProtokolSDK010 = (function (exports, axios) {
          * // Auto-detects header, items, and footer sections
          * ```
          */
-        async jsonToCsv(lib, jsonData, options) {
+        async jsonToCsv(jsonData, options) {
             let params = {};
             if (options === null || options === void 0 ? void 0 : options.field_order) {
                 params.field_order = options.field_order.join(',');
@@ -1391,7 +1652,7 @@ var ProtokolSDK010 = (function (exports, axios) {
          * link.click();
          * ```
          */
-        async jsonToExcel(lib, jsonData, options) {
+        async jsonToExcel(jsonData, options) {
             const params = {};
             if (options === null || options === void 0 ? void 0 : options.sheet_name) {
                 params.sheet_name = options.sheet_name;
@@ -1430,7 +1691,7 @@ var ProtokolSDK010 = (function (exports, axios) {
          * // ]
          * ```
          */
-        async csvToJson(lib, csvData) {
+        async csvToJson(csvData) {
             return this.request('POST', `media/convert/csv-to-json`, {
                 data: csvData,
                 responseType: 'json',
@@ -1463,7 +1724,7 @@ var ProtokolSDK010 = (function (exports, axios) {
          * // Use url for download or further processing
          * ```
          */
-        async csvToExcel(lib, csvData, options) {
+        async csvToExcel(csvData, options) {
             const params = {};
             if (options === null || options === void 0 ? void 0 : options.sheet_name) {
                 params.sheet_name = options.sheet_name;
@@ -1503,7 +1764,7 @@ var ProtokolSDK010 = (function (exports, axios) {
          * const jsonFromBuffer = await dms.excelToJson(libraryRef, arrayBuffer);
          * ```
          */
-        async excelToJson(lib, excelData, options) {
+        async excelToJson(excelData, options) {
             const params = {};
             if (options === null || options === void 0 ? void 0 : options.sheet_name) {
                 params.sheet_name = options.sheet_name;
@@ -1547,7 +1808,7 @@ var ProtokolSDK010 = (function (exports, axios) {
          * link.click();
          * ```
          */
-        async excelToCsv(lib, excelData, options) {
+        async excelToCsv(excelData, options) {
             const params = {};
             if (options === null || options === void 0 ? void 0 : options.sheet_name) {
                 params.sheet_name = options.sheet_name;

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ptkl/sdk",
-  "version": "0.10.0",
+  "version": "0.10.1",
   "scripts": {
     "build": "rollup -c",
     "build:monaco": "npm run build && node scripts/generate-monaco-types.cjs",

package/dist/types/api/integrations/dms.d.ts

@@ -1,6 +1,6 @@
 import IntegrationsBaseClient from "../integrationsBaseClient";
 import { AxiosResponse } from "axios";
-import { PDFFillOptions, DataConversionParams, DataValidationParams, DataInfoParams, DataInfo, DataValidationResult, ConversionOptions, HTML2PDFOptions } from "../../types/integrations";
+import { PDFFillOptions, DataConversionParams, DataValidationParams, DataInfoParams, DataInfo, DataValidationResult, ConversionOptions, HTML2PDFOptions, PDF2HTMLOptions, MediaUploadPayload, MediaUploadBase64Payload } from "../../types/integrations";
 /**
  * Document Management System (DMS) API client
  *
@@ -83,17 +83,57 @@ import { PDFFillOptions, DataConversionParams, DataValidationParams, DataInfoPar
 export default class DMS extends IntegrationsBaseClient {
     list(data: any): Promise<AxiosResponse<any, any>>;
     libraries(): Promise<AxiosResponse<any, any>>;
-    upload(payload: any): Promise<AxiosResponse<any, any> | undefined>;
+    /**
+     * Upload files using multipart form data
+     *
+     * @param payload - Upload configuration with files, directory, and options
+     * @returns Upload response from the server
+     *
+     * @example
+     * ```typescript
+     * const result = await dms.upload({
+     *   files: [file1, file2],
+     *   uploadDir: '/documents/invoices',
+     *   public: true,
+     *   replace: true,
+     *   metadata: { category: 'finance' }
+     * });
+     * ```
+     */
+    upload(payload: MediaUploadPayload): Promise<AxiosResponse<any, any> | undefined>;
     delete(data: any): Promise<AxiosResponse<any, any>>;
-    uploadBase64(data: any): Promise<AxiosResponse<any, any>>;
-    getMedia(lib: string, key: string, encoding: string): Promise<AxiosResponse<any, any>>;
-    download(lib: string, key: string): Promise<AxiosResponse<any, any>>;
+    /**
+     * Upload files using base64-encoded content
+     *
+     * @param data - Upload payload with base64-encoded files
+     * @returns Upload response from the server
+     *
+     * @example
+     * ```typescript
+     * const result = await dms.uploadBase64({
+     *   path: '/documents/reports',
+     *   is_public: false,
+     *   replace: true,
+     *   files: [
+     *     {
+     *       name: 'report.pdf',
+     *       content_type: 'application/pdf',
+     *       data: 'base64EncodedContent...'
+     *     }
+     *   ]
+     * });
+     * ```
+     */
+    uploadBase64(data: MediaUploadBase64Payload): Promise<AxiosResponse<any, any>>;
+    getMedia(key: string, encoding: string): Promise<AxiosResponse<any, any>>;
+    download(key: string): Promise<AxiosResponse<any, any>>;
     getExifData(key: string): Promise<AxiosResponse<any, any>>;
     html2pdf(data: HTML2PDFOptions): Promise<AxiosResponse<any, any>>;
+    pdf2html(data: PDF2HTMLOptions): Promise<AxiosResponse<any, any>>;
     createDir(path: string): Promise<AxiosResponse<any, any>>;
     deleteDir(path: string): Promise<AxiosResponse<any, any>>;
     dirs(data: string): Promise<AxiosResponse<any, any>>;
-    fillPdf(lib: string, data: PDFFillOptions): Promise<AxiosResponse<any, any>>;
+    fillPdf(data: PDFFillOptions): Promise<AxiosResponse<any, any>>;
     /**
      * Convert data between different formats (JSON, CSV, Excel)
      *
@@ -155,7 +195,7 @@ export default class DMS extends IntegrationsBaseClient {
      * // excelResult.data is a Blob
      * ```
      */
-    convertData(lib: string, data: any, params: DataConversionParams): Promise<AxiosResponse<any>>;
+    convertData(data: any, params: DataConversionParams): Promise<AxiosResponse<any>>;
     /**
      * Get information about data format and structure
      *
@@ -187,7 +227,7 @@ export default class DMS extends IntegrationsBaseClient {
      * // }
      * ```
      */
-    getDataInfo(lib: string, data: any, params: DataInfoParams): Promise<AxiosResponse<DataInfo>>;
+    getDataInfo(data: any, params: DataInfoParams): Promise<AxiosResponse<DataInfo>>;
     /**
      * Validate data format without performing conversion
      *
@@ -222,7 +262,7 @@ export default class DMS extends IntegrationsBaseClient {
      * }
      * ```
      */
-    validateData(lib: string, data: any, params: DataValidationParams): Promise<AxiosResponse<DataValidationResult>>;
+    validateData(data: any, params: DataValidationParams): Promise<AxiosResponse<DataValidationResult>>;
     /**
      * Convert JSON data to CSV format
      *
@@ -261,7 +301,7 @@ export default class DMS extends IntegrationsBaseClient {
      * // Auto-detects header, items, and footer sections
      * ```
      */
-    jsonToCsv(lib: string, jsonData: any, options?: ConversionOptions): Promise<AxiosResponse<string>>;
+    jsonToCsv(jsonData: any, options?: ConversionOptions): Promise<AxiosResponse<string>>;
     /**
      * Convert JSON data to Excel (.xlsx) format
      *
@@ -307,7 +347,7 @@ export default class DMS extends IntegrationsBaseClient {
      * link.click();
      * ```
      */
-    jsonToExcel(lib: string, jsonData: any, options?: ConversionOptions): Promise<AxiosResponse<Blob>>;
+    jsonToExcel(jsonData: any, options?: ConversionOptions): Promise<AxiosResponse<Blob>>;
     /**
      * Convert CSV data to JSON format
      *
@@ -330,7 +370,7 @@ export default class DMS extends IntegrationsBaseClient {
      * // ]
      * ```
      */
-    csvToJson(lib: string, csvData: string): Promise<AxiosResponse<any[]>>;
+    csvToJson(csvData: string): Promise<AxiosResponse<any[]>>;
     /**
      * Convert CSV data to Excel (.xlsx) format
      *
@@ -355,7 +395,7 @@ export default class DMS extends IntegrationsBaseClient {
      * // Use url for download or further processing
      * ```
      */
-    csvToExcel(lib: string, csvData: string, options?: ConversionOptions): Promise<AxiosResponse<Blob>>;
+    csvToExcel(csvData: string, options?: ConversionOptions): Promise<AxiosResponse<Blob>>;
     /**
      * Convert Excel (.xlsx) data to JSON format
      *
@@ -382,7 +422,7 @@ export default class DMS extends IntegrationsBaseClient {
      * const jsonFromBuffer = await dms.excelToJson(libraryRef, arrayBuffer);
      * ```
      */
-    excelToJson(lib: string, excelData: Blob | ArrayBuffer, options?: ConversionOptions): Promise<AxiosResponse<any[]>>;
+    excelToJson(excelData: Blob | ArrayBuffer, options?: ConversionOptions): Promise<AxiosResponse<any[]>>;
     /**
      * Convert Excel (.xlsx) data to CSV format
      *
@@ -413,7 +453,7 @@ export default class DMS extends IntegrationsBaseClient {
      * link.click();
      * ```
      */
-    excelToCsv(lib: string, excelData: Blob | ArrayBuffer, options?: ConversionOptions): Promise<AxiosResponse<string>>;
+    excelToCsv(excelData: Blob | ArrayBuffer, options?: ConversionOptions): Promise<AxiosResponse<string>>;
     request(method: string, endpoint: string, params?: any): Promise<AxiosResponse<any, any>>;
     requestv1(method: string, endpoint: string, params?: any): Promise<AxiosResponse<any, any>>;
 }