@ptkl/sdk 1.11.0 → 1.13.0

package/dist/v0.10/index.esm.js

@@ -344,6 +344,11 @@ class Component extends PlatformBaseClient {
     async delete(uuid) {
         return await this.client.delete(`/v4/system/component/${this.ref}/model/${uuid}`);
     }
+    async deleteMany(uuids) {
+        return await this.client.delete(`/v4/system/component/${this.ref}/models/bulk`, {
+            data: uuids,
+        });
+    }
     /**
      * Execute aggregate pipeline with optional streaming support
      *
@@ -1288,6 +1293,7 @@ class Workflow extends PlatformBaseClient {
 }
 
 class Forge extends PlatformBaseClient {
+    // --- Management (appservice) ---
     async bundleUpload(buffer) {
         return await this.client.post(`/luma/appservice/v1/forge/upload`, buffer, {
             headers: {
@@ -1305,6 +1311,36 @@ class Forge extends PlatformBaseClient {
     async list() {
         return await this.client.get(`/luma/appservice/v1/forge`);
     }
+    async listServices(ref) {
+        return await this.client.get(`/luma/appservice/v1/forge/${ref}/services`);
+    }
+    // --- Variables ---
+    async getVariables(ref) {
+        return await this.client.get(`/luma/appservice/v1/forge/${ref}/variables`);
+    }
+    async updateVariables(ref, variables) {
+        return await this.client.patch(`/luma/appservice/v1/forge/${ref}/variables`, variables);
+    }
+    async addVariable(ref, key, value) {
+        var _a;
+        const resp = await this.client.get(`/luma/appservice/v1/forge/${ref}/variables`);
+        const current = (_a = resp.data) !== null && _a !== void 0 ? _a : {};
+        current[key] = value;
+        return await this.client.patch(`/luma/appservice/v1/forge/${ref}/variables`, current);
+    }
+    // --- Service execution (forge-runtime) ---
+    async callService(appUuid, serviceName, options) {
+        var _a, _b, _c;
+        const queryString = (options === null || options === void 0 ? void 0 : options.query)
+            ? '?' + new URLSearchParams(options.query).toString()
+            : '';
+        // @ts-ignore
+        const devServiceUrl = isBrowser && ((_a = window.__ENV_VARIABLES__) === null || _a === void 0 ? void 0 : _a.FORGE_DEV_SERVICE_URL);
+        if (devServiceUrl) {
+            return axios.post(`${devServiceUrl}/${serviceName}${queryString}`, (_b = options === null || options === void 0 ? void 0 : options.body) !== null && _b !== void 0 ? _b : {}, (options === null || options === void 0 ? void 0 : options.headers) ? { headers: options.headers } : undefined);
+        }
+        return await this.client.post(`/luma/forge-runtime/api/services/${appUuid}/${serviceName}${queryString}`, (_c = options === null || options === void 0 ? void 0 : options.body) !== null && _c !== void 0 ? _c : {}, (options === null || options === void 0 ? void 0 : options.headers) ? { headers: options.headers } : undefined);
+    }
 }
 
 const BASE = '/luma/kortex/v1';
@@ -2514,6 +2550,72 @@ class DMS extends IntegrationsBaseClient {
             }
         });
     }
+    // ===================================================================
+    // Text Extraction
+    // ===================================================================
+    /**
+     * Extract text from any document format
+     *
+     * Supports PDF, DOCX, XLSX, PPTX, ODT, RTF, EPUB, CSV, images, and 40+ other formats.
+     * Provide either a DMS file path or base64-encoded file data.
+     *
+     * @param payload - File path or base64 data to extract text from
+     * @returns Extracted text content and character count
+     *
+     * @example
+     * ```typescript
+     * // From a DMS file path
+     * const result = await dms.extractText({ input_path: 'uploads/contract.pdf' });
+     * console.log(result.data.text);
+     * console.log(result.data.char_count);
+     *
+     * // From base64 data
+     * const result = await dms.extractText({
+     *   file_data: 'data:application/pdf;base64,...',
+     *   file_name: 'invoice.pdf'
+     * });
+     * ```
+     */
+    async extractText(payload) {
+        return this.request('POST', 'media/extract-text', { data: payload });
+    }
+    // ===================================================================
+    // OCR Extraction
+    // ===================================================================
+    /**
+     * Run OCR extraction on an image using a saved model
+     *
+     * Crops each labeled region from the image and runs OCR to extract text.
+     * Returns structured key-value results.
+     *
+     * @param payload - Model UUID, image (base64 or DMS key), and optional document boundary
+     * @returns Extraction results as label-text pairs
+     *
+     * @example
+     * ```typescript
+     * // From a DMS file
+     * const result = await dms.ocrExtract({
+     *   model_uuid: 'model-uuid',
+     *   image_key: 'uploads/scan.jpg',
+     *   document_boundary: { x: 0.05, y: 0.08, width: 0.9, height: 0.85 }
+     * });
+     *
+     * console.log(result.data.results);
+     * // { name: "John Smith", date_of_birth: "01.01.1990", id_number: "123456789" }
+     *
+     * // From base64
+     * const result = await dms.ocrExtract({
+     *   model_uuid: 'model-uuid',
+     *   image: 'data:image/jpeg;base64,...'
+     * });
+     * ```
+     */
+    async ocrExtract(payload) {
+        return this.request('POST', 'media/ocr/extract', {
+            data: payload,
+            timeout: 120000
+        });
+    }
     async request(method, endpoint, params) {
         return await this.client.request({
             method: method,
@@ -3693,6 +3795,59 @@ class Integrations extends IntegrationsBaseClient {
     }
 }
 
+class Satellites extends IntegrationsBaseClient {
+    async list() {
+        const { data } = await this.client.get('/satellites/templates');
+        return data;
+    }
+    async create(payload) {
+        const { data } = await this.client.post('/satellites/templates', payload.template);
+        if (payload.schema) {
+            await this.createVersion(data.id, payload.schema);
+        }
+        return data;
+    }
+    async get(id) {
+        const { data } = await this.client.get(`/satellites/templates/${encodeURIComponent(id)}`);
+        return data;
+    }
+    async delete(id) {
+        const { data } = await this.client.delete(`/satellites/templates/${encodeURIComponent(id)}`);
+        return data;
+    }
+    async createVersion(id, payload) {
+        const { data } = await this.client.post(`/satellites/templates/${encodeURIComponent(id)}/versions`, payload);
+        return data;
+    }
+    async versions(id) {
+        const { data } = await this.client.get(`/satellites/templates/${encodeURIComponent(id)}/versions`);
+        return data;
+    }
+    async deploy(id, payload) {
+        const { data } = await this.client.post(`/satellites/templates/${encodeURIComponent(id)}/deploy`, payload);
+        return data;
+    }
+    async rollback(id, payload) {
+        const { data } = await this.client.post(`/satellites/templates/${encodeURIComponent(id)}/rollback`, payload);
+        return data;
+    }
+    async permissions(id) {
+        const { data } = await this.client.get(`/satellites/templates/${encodeURIComponent(id)}/permissions`);
+        return data;
+    }
+    async logs(id, params = {}) {
+        const since = params.since instanceof Date ? params.since.toISOString() : params.since;
+        const { data } = await this.client.get(`/satellites/templates/${encodeURIComponent(id)}/logs`, {
+            params: since ? { since } : undefined,
+        });
+        return data;
+    }
+    async execute(id, command, payload = {}) {
+        const { data } = await this.client.post(`/satellites/${encodeURIComponent(id)}/commands/${encodeURIComponent(command)}/execute`, payload);
+        return data;
+    }
+}
+
 // PRN — Protokol Resource Name
 //
 // Format:
@@ -3845,4 +4000,4 @@ class Invoicing extends PlatformBaseClient {
     }
 }
 
-export { APIUser, Apps, Component, ComponentUtils, Config, DMS, Ecommerce, Forge, Functions, Integrations as Integration, Integrations, Invoicing, Kortex, Mail, NBS, PRN, Payments, Platform, Project, Ratchet, Sandbox, MinFin as SerbiaMinFin, System, Thunder, Timber, Users, VPFR, Workflow, parsePRN };
+export { APIUser, Apps, Component, ComponentUtils, Config, DMS, Ecommerce, Forge, Functions, Integrations as Integration, Integrations, Invoicing, Kortex, Mail, NBS, PRN, Payments, Platform, Project, Ratchet, Sandbox, Satellites, MinFin as SerbiaMinFin, System, Thunder, Timber, Users, VPFR, Workflow, parsePRN };

package/dist/v0.10/types/integrations.d.ts

@@ -345,3 +345,100 @@ export type DocumentRevisionItem = {
     updatedBy: DocumentAuditEntry;
 };
 export type DocumentRevisionListResponse = DocumentRevisionItem[];
+export type DMSPlan = {
+    plan: 'free' | 'paid';
+    allowed_storage: number;
+    used_storage: number;
+};
+export type ExtractTextPayload = {
+    input_path?: string;
+    input_data?: string;
+    file_name?: string;
+    output_path?: string;
+    output_text?: boolean;
+    output_file_name?: string;
+    replace?: boolean;
+};
+export type ExtractTextResult = {
+    text: string;
+    char_count: number;
+};
+export type OCRBoundaryRect = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+export type OCRModelRegion = {
+    label: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+export type OCRModelConfig = {
+    psm?: number | null;
+    backend?: string;
+};
+export type OCRModelSample = {
+    uuid: string;
+    ocr_model_uuid: string;
+    image_key: string;
+    image_url?: string;
+    is_primary: boolean;
+    document_boundary?: OCRBoundaryRect | null;
+    created_at?: string;
+    updated_at?: string;
+};
+export type OCRModel = {
+    uuid: string;
+    project_uuid: string;
+    name: string;
+    description: string;
+    engine: 'default' | 'kortex';
+    language: string;
+    config?: OCRModelConfig | null;
+    regions: OCRModelRegion[];
+    samples?: OCRModelSample[];
+    created_by: string;
+    created_at?: string;
+    updated_at?: string;
+};
+export type OCRModelCreatePayload = {
+    name: string;
+    description?: string;
+    engine?: 'default' | 'kortex';
+    language?: string;
+    config?: OCRModelConfig;
+    regions?: OCRModelRegion[];
+};
+export type OCRModelUpdatePayload = {
+    name?: string;
+    description?: string;
+    engine?: string;
+    language?: string;
+    config?: OCRModelConfig;
+    regions?: OCRModelRegion[];
+};
+export type OCRSampleAddPayload = {
+    image_key: string;
+    image_url?: string;
+    is_primary?: boolean;
+    document_boundary?: OCRBoundaryRect;
+};
+export type OCRSampleUpdatePayload = {
+    is_primary?: boolean;
+    document_boundary?: OCRBoundaryRect;
+};
+export type OCRExtractPayload = {
+    model_uuid: string;
+    image_key?: string;
+    image?: string;
+    document_boundary?: OCRBoundaryRect;
+};
+export type OCRExtractResult = {
+    model_uuid: string;
+    model_name: string;
+    results: Record<string, string>;
+    errors?: string[];
+};

package/dist/v0.10/types/satellites.d.ts

@@ -0,0 +1,100 @@
+export type SatelliteEnv = 'dev' | 'live';
+export type SatelliteAuthType = 'bearer' | 'api_key';
+export type SatelliteLocaleText = string | {
+    locales?: Record<string, string>;
+    [locale: string]: any;
+};
+export type SatelliteAuthConfig = {
+    header_name?: string;
+    secret?: string;
+};
+export type SatelliteTemplatePayload = {
+    id: string;
+    label?: SatelliteLocaleText;
+    description?: SatelliteLocaleText;
+    icon?: string;
+    jsonrpc_endpoint_url: string;
+    health_check_url?: string;
+    logs_url?: string;
+    auth_type?: SatelliteAuthType;
+    auth_config?: SatelliteAuthConfig;
+    timeout_ms?: number;
+};
+export type SatelliteTemplate = Omit<SatelliteTemplatePayload, 'auth_config'> & {
+    project_uuid?: string;
+    uuid?: string;
+    status?: string;
+    dev_version?: string;
+    live_version?: string;
+    last_health_status?: string;
+    last_health_checked_at?: string;
+    created_at?: string;
+    updated_at?: string;
+    auth_config?: Omit<SatelliteAuthConfig, 'secret'>;
+};
+export type SatellitePermission = {
+    action: string;
+    label?: SatelliteLocaleText;
+    description?: SatelliteLocaleText;
+};
+export type SatelliteJsonRpcCommand = {
+    name: string;
+    method: string;
+    permission_action?: string;
+};
+export type SatelliteWorkflowNodeField = {
+    name: string;
+    type: string;
+    required?: boolean;
+    label?: SatelliteLocaleText;
+    description?: SatelliteLocaleText;
+    default?: any;
+};
+export type SatelliteWorkflowNode = {
+    name: string;
+    label?: SatelliteLocaleText;
+    description?: SatelliteLocaleText;
+    icon?: string;
+    command: string;
+    inputs?: SatelliteWorkflowNodeField[];
+    outputs?: SatelliteWorkflowNodeField[];
+};
+export type SatelliteSchemaPayload = {
+    schema_version: string;
+    schema?: Record<string, any>;
+    permissions?: SatellitePermission[];
+    jsonrpc_commands?: SatelliteJsonRpcCommand[];
+    workflownodes?: SatelliteWorkflowNode[];
+};
+export type SatelliteCreatePayload = {
+    template: SatelliteTemplatePayload;
+    schema?: SatelliteSchemaPayload;
+};
+export type SatelliteSchemaVersion = SatelliteSchemaPayload & {
+    version?: number;
+    satellite_uuid?: string;
+    project_uuid?: string;
+    created_at?: string;
+};
+export type SatelliteDeployPayload = {
+    schema_version: string;
+    env: SatelliteEnv;
+};
+export type SatellitePermissionExport = {
+    action: string;
+    permission_key: string;
+    label?: SatelliteLocaleText;
+    description?: SatelliteLocaleText;
+};
+export type SatelliteCommandExecutePayload = {
+    inputs?: Record<string, any>;
+    context?: Record<string, any>;
+    session?: string;
+    caller_prn?: string;
+};
+export type SatelliteCommandExecuteResponse<T = any> = {
+    result: T;
+};
+export type SatelliteLogsParams = {
+    since?: string | Date;
+};

package/dist/v0.9/api/forge.d.ts

@@ -4,4 +4,7 @@ export default class Forge extends PlatformBaseClient {
     getWorkspaceApps(): Promise<any>;
     removeVersion(ref: string, version: string): Promise<any>;
     list(): Promise<any>;
+    getVariables(ref: string): Promise<any>;
+    updateVariables(ref: string, variables: Record<string, any>): Promise<any>;
+    addVariable(ref: string, key: string, value: any): Promise<any>;
 }

package/dist/v0.9/api/index.d.ts

@@ -26,5 +26,7 @@ export { default as SerbiaUtil } from './integrations/serbiaUtil';
 export { default as VPFR } from './integrations/vpfr';
 export { default as Mail } from './integrations/mail';
 export { default as Ecommerce } from './integrations/ecommerce';
+export { default as Timber } from './integrations/timber';
+export type { TimberQueryParams, TimberQueryResponse, TimberWritePayload, TimberLogPayload, TimberUsage, TimberEntry, } from '../types/integrations/timber';
 import Platfrom from './platform';
 export default Platfrom;

package/dist/v0.9/api/integrations/timber.d.ts

@@ -0,0 +1,22 @@
+import IntegrationsBaseClient from "../integrationsBaseClient";
+import { TimberLogPayload, TimberQueryParams, TimberQueryResponse, TimberUsage, TimberWritePayload } from "../../types/integrations/timber";
+export default class Timber extends IntegrationsBaseClient {
+    query(params?: TimberQueryParams): Promise<TimberQueryResponse>;
+    write(payload: TimberWritePayload): Promise<{
+        accepted: boolean;
+    }>;
+    usage(): Promise<TimberUsage>;
+    debug(message: string, payload?: TimberLogPayload): Promise<{
+        accepted: boolean;
+    }>;
+    info(message: string, payload?: TimberLogPayload): Promise<{
+        accepted: boolean;
+    }>;
+    warn(message: string, payload?: TimberLogPayload): Promise<{
+        accepted: boolean;
+    }>;
+    error(message: string, payload?: TimberLogPayload): Promise<{
+        accepted: boolean;
+    }>;
+    private normalizeParams;
+}

package/dist/v0.9/api/integrations.d.ts

@@ -6,6 +6,7 @@ import IntegrationsBaseClient from "./integrationsBaseClient";
 import Payments from "./integrations/payments";
 import Minimax from "./integrations/minimax";
 import Ecommerce from "./integrations/ecommerce";
+import Timber from "./integrations/timber";
 export default class Integrations extends IntegrationsBaseClient {
     private integrations;
     constructor(options?: {
@@ -21,6 +22,7 @@ export default class Integrations extends IntegrationsBaseClient {
     getPayments(): Payments;
     getMinimax(): Minimax;
     getEcommerce(): Ecommerce;
+    getTimber(): Timber;
     list(): Promise<any>;
     isInstalled(id: string): Promise<boolean>;
     isActive(id: string): Promise<boolean>;

package/dist/v0.9/index.cjs.js

@@ -19952,6 +19952,19 @@ class Forge extends PlatformBaseClient {
     async list() {
         return await this.client.get(`/luma/appservice/v1/forge`);
     }
+    async getVariables(ref) {
+        return await this.client.get(`/luma/appservice/v1/forge/${ref}/variables`);
+    }
+    async updateVariables(ref, variables) {
+        return await this.client.patch(`/luma/appservice/v1/forge/${ref}/variables`, variables);
+    }
+    async addVariable(ref, key, value) {
+        var _a;
+        const resp = await this.client.get(`/luma/appservice/v1/forge/${ref}/variables`);
+        const current = (_a = resp.data) !== null && _a !== void 0 ? _a : {};
+        current[key] = value;
+        return await this.client.patch(`/luma/appservice/v1/forge/${ref}/variables`, current);
+    }
 }
 
 class Project extends PlatformBaseClient {
@@ -21938,6 +21951,45 @@ class Ecommerce extends IntegrationsBaseClient {
     }
 }
 
+class Timber extends IntegrationsBaseClient {
+    async query(params = {}) {
+        const { data } = await this.client.get("/v1/timber/logs", {
+            params: this.normalizeParams(params),
+        });
+        return data;
+    }
+    async write(payload) {
+        const { data } = await this.client.post("/v1/timber/logs", payload);
+        return data;
+    }
+    async usage() {
+        const { data } = await this.client.get("/v1/timber/usage");
+        return data;
+    }
+    async debug(message, payload) {
+        return this.write({ ...payload, message, level: 'debug' });
+    }
+    async info(message, payload) {
+        return this.write({ ...payload, message, level: 'info' });
+    }
+    async warn(message, payload) {
+        return this.write({ ...payload, message, level: 'warn' });
+    }
+    async error(message, payload) {
+        return this.write({ ...payload, message, level: 'error' });
+    }
+    normalizeParams(params) {
+        const normalized = { ...params };
+        if (params.from instanceof Date) {
+            normalized.from = params.from.toISOString();
+        }
+        if (params.to instanceof Date) {
+            normalized.to = params.to.toISOString();
+        }
+        return normalized;
+    }
+}
+
 // import integrations
 class Integrations extends IntegrationsBaseClient {
     constructor(options) {
@@ -21951,6 +22003,7 @@ class Integrations extends IntegrationsBaseClient {
             'protokol-payments': new Payments().setClient(this.client),
             'protokol-minimax': new Minimax().setClient(this.client),
             'protokol-ecommerce': new Ecommerce().setClient(this.client),
+            'protokol-timber': new Timber().setClient(this.client),
         };
     }
     getSerbiaUtilities() {
@@ -21977,6 +22030,9 @@ class Integrations extends IntegrationsBaseClient {
     getEcommerce() {
         return this.getInterfaceOf('protokol-ecommerce');
     }
+    getTimber() {
+        return this.getInterfaceOf('protokol-timber');
+    }
     async list() {
         const { data } = await this.client.get("/v1/integrations");
         return data;
@@ -22152,6 +22208,7 @@ exports.Sandbox = Sandbox;
 exports.SerbiaUtil = SerbiaUtil;
 exports.System = System;
 exports.Thunder = Thunder;
+exports.Timber = Timber;
 exports.Users = Users;
 exports.VPFR = VPFR;
 exports.Workflow = Workflow;

package/dist/v0.9/index.esm.js

@@ -983,6 +983,19 @@ class Forge extends PlatformBaseClient {
     async list() {
         return await this.client.get(`/luma/appservice/v1/forge`);
     }
+    async getVariables(ref) {
+        return await this.client.get(`/luma/appservice/v1/forge/${ref}/variables`);
+    }
+    async updateVariables(ref, variables) {
+        return await this.client.patch(`/luma/appservice/v1/forge/${ref}/variables`, variables);
+    }
+    async addVariable(ref, key, value) {
+        var _a;
+        const resp = await this.client.get(`/luma/appservice/v1/forge/${ref}/variables`);
+        const current = (_a = resp.data) !== null && _a !== void 0 ? _a : {};
+        current[key] = value;
+        return await this.client.patch(`/luma/appservice/v1/forge/${ref}/variables`, current);
+    }
 }
 
 class Project extends PlatformBaseClient {
@@ -2969,6 +2982,45 @@ class Ecommerce extends IntegrationsBaseClient {
     }
 }
 
+class Timber extends IntegrationsBaseClient {
+    async query(params = {}) {
+        const { data } = await this.client.get("/v1/timber/logs", {
+            params: this.normalizeParams(params),
+        });
+        return data;
+    }
+    async write(payload) {
+        const { data } = await this.client.post("/v1/timber/logs", payload);
+        return data;
+    }
+    async usage() {
+        const { data } = await this.client.get("/v1/timber/usage");
+        return data;
+    }
+    async debug(message, payload) {
+        return this.write({ ...payload, message, level: 'debug' });
+    }
+    async info(message, payload) {
+        return this.write({ ...payload, message, level: 'info' });
+    }
+    async warn(message, payload) {
+        return this.write({ ...payload, message, level: 'warn' });
+    }
+    async error(message, payload) {
+        return this.write({ ...payload, message, level: 'error' });
+    }
+    normalizeParams(params) {
+        const normalized = { ...params };
+        if (params.from instanceof Date) {
+            normalized.from = params.from.toISOString();
+        }
+        if (params.to instanceof Date) {
+            normalized.to = params.to.toISOString();
+        }
+        return normalized;
+    }
+}
+
 // import integrations
 class Integrations extends IntegrationsBaseClient {
     constructor(options) {
@@ -2982,6 +3034,7 @@ class Integrations extends IntegrationsBaseClient {
             'protokol-payments': new Payments().setClient(this.client),
             'protokol-minimax': new Minimax().setClient(this.client),
             'protokol-ecommerce': new Ecommerce().setClient(this.client),
+            'protokol-timber': new Timber().setClient(this.client),
         };
     }
     getSerbiaUtilities() {
@@ -3008,6 +3061,9 @@ class Integrations extends IntegrationsBaseClient {
     getEcommerce() {
         return this.getInterfaceOf('protokol-ecommerce');
     }
+    getTimber() {
+        return this.getInterfaceOf('protokol-timber');
+    }
     async list() {
         const { data } = await this.client.get("/v1/integrations");
         return data;
@@ -3161,4 +3217,4 @@ function parsePRN(s) {
 // Export all API modules for version 0.9
 // This version has specific method signatures and behaviors for v0.9
 
-export { APIUser, Apps, Component, ComponentUtils, Config, DMS, Ecommerce, Forge, Functions, Integrations as Integration, Integrations, Invoicing, Mail, PRN, Payments, Platform, Project, Ratchet, Sandbox, SerbiaUtil, System, Thunder, Users, VPFR, Workflow, Platform as default, parsePRN };
+export { APIUser, Apps, Component, ComponentUtils, Config, DMS, Ecommerce, Forge, Functions, Integrations as Integration, Integrations, Invoicing, Mail, PRN, Payments, Platform, Project, Ratchet, Sandbox, SerbiaUtil, System, Thunder, Timber, Users, VPFR, Workflow, Platform as default, parsePRN };