@ptkl/sdk 1.10.0 → 1.12.0

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

@@ -0,0 +1,294 @@
+type PagedResponse<T> = {
+    data: T[];
+    total: number;
+    page: number;
+    limit: number;
+};
+type PaginationParams = {
+    limit?: number;
+    page?: number;
+};
+type RAGConfig = {
+    enabled: boolean;
+    top_k: number;
+    score_threshold: number;
+};
+type LLMSettings = {
+    temperature?: number;
+    top_p?: number;
+    top_k?: number;
+    max_tokens?: number;
+};
+type Agent = {
+    uuid: string;
+    project_uuid: string;
+    name: string;
+    description: string;
+    system_prompt: string;
+    knowledge_bases: string[];
+    rag_config: RAGConfig;
+    llm_settings: LLMSettings;
+    model_tier: string;
+    status: string;
+    created_at: string;
+    updated_at: string;
+};
+type AgentCreatePayload = {
+    name: string;
+    description?: string;
+    system_prompt?: string;
+    knowledge_bases?: string[];
+    rag_config?: RAGConfig;
+    llm_settings?: LLMSettings;
+    model_tier?: string;
+};
+type AgentUpdatePayload = {
+    name?: string;
+    description?: string;
+    system_prompt?: string;
+    knowledge_bases?: string[];
+    rag_config?: RAGConfig;
+    llm_settings?: LLMSettings;
+    model_tier?: string;
+};
+type ChunkingStrategy = {
+    chunk_size: number;
+    chunk_overlap: number;
+};
+type KnowledgeBase = {
+    uuid: string;
+    project_uuid: string;
+    name: string;
+    description: string;
+    chunking_strategy: ChunkingStrategy;
+    document_count: number;
+    chunk_count: number;
+    total_size: number;
+    status: string;
+    created_at: string;
+    updated_at: string;
+};
+type KnowledgeBaseCreatePayload = {
+    name: string;
+    description?: string;
+    chunking_strategy?: ChunkingStrategy;
+};
+type KnowledgeBaseUpdatePayload = {
+    name?: string;
+    description?: string;
+    chunking_strategy?: ChunkingStrategy;
+};
+type Document = {
+    uuid: string;
+    project_uuid: string;
+    knowledge_base_uuid: string;
+    name: string;
+    content_type: string;
+    size: number;
+    processing_status: string;
+    processing_error?: string;
+    retry_count: number;
+    created_at: string;
+    updated_at: string;
+};
+type Participant = {
+    agent_uuid: string;
+    name: string;
+    mode: string;
+    instructions_override?: string;
+};
+type TokenUsage = {
+    prompt_tokens: number;
+    completion_tokens: number;
+    total_tokens: number;
+};
+type ToolCall = {
+    id: string;
+    type: string;
+    function: {
+        name: string;
+        arguments: string;
+    };
+};
+type RAGSource = {
+    document_uuid: string;
+    document_name: string;
+    chunk_index: number;
+    score: number;
+    content: string;
+};
+type Message = {
+    uuid: string;
+    conversation_uuid: string;
+    project_uuid: string;
+    role: string;
+    content: string;
+    agent_uuid?: string;
+    tool_calls?: ToolCall[];
+    tool_call_id?: string;
+    rag_sources?: RAGSource[];
+    token_usage: TokenUsage;
+    created_at: string;
+};
+type Conversation = {
+    uuid: string;
+    project_uuid: string;
+    user_uuid: string;
+    title: string;
+    agent_uuid?: string;
+    tier: string;
+    participants?: Participant[];
+    message_count: number;
+    tokens_used: number;
+    archived_at?: string;
+    created_at: string;
+    updated_at: string;
+};
+type ConversationCreatePayload = {
+    title?: string;
+    agent_uuid?: string;
+};
+type ConversationUpdatePayload = {
+    title?: string;
+    agent_uuid?: string;
+};
+type ParticipantAddPayload = {
+    agent_uuid: string;
+    name?: string;
+    mode?: string;
+    instructions_override?: string;
+};
+type ToolResultApproval = {
+    approved: boolean;
+    mode?: string;
+};
+type ToolResultPayload = {
+    tool_call_id: string;
+    name?: string;
+    content: string;
+    approval?: ToolResultApproval;
+};
+type PageContext = {
+    label: string;
+    description?: string;
+    icon?: string;
+};
+type SendMessagePayload = {
+    content: string;
+    agent_uuid?: string;
+    images?: string[];
+    stream?: boolean;
+    tools?: Record<string, any>[];
+    tool_results?: ToolResultPayload[];
+    page_context?: PageContext;
+};
+type InjectMessagePayload = {
+    role: string;
+    content: string;
+};
+type OCRPayload = {
+    file_name: string;
+    file_data: string;
+    content_type: string;
+};
+type OCRResult = {
+    text: string;
+    char_count: number;
+};
+type UserAccess = {
+    uuid: string;
+    project_uuid: string;
+    user_uuid: string;
+    credit_limit: number;
+    allowed_agent_uuids: string[];
+    status: string;
+    created_at: string;
+    updated_at: string;
+};
+type UserAccessCreatePayload = {
+    user_uuid: string;
+    credit_limit: number;
+    allowed_agent_uuids?: string[];
+};
+type UserAccessUpdatePayload = {
+    credit_limit?: number;
+    allowed_agent_uuids?: string[];
+    status?: string;
+};
+type TopUpPayload = {
+    amount: number;
+    reason?: string;
+};
+type UserMonthlyUsage = {
+    user_uuid: string;
+    year: number;
+    month: number;
+    credits_used: number;
+    credit_limit: number;
+};
+type UserUsageBreakdown = {
+    user_uuid: string;
+    credit_limit: number;
+    breakdown: {
+        year: number;
+        month: number;
+        credits: number;
+    }[];
+};
+type MyAccess = {
+    uuid: string;
+    project_uuid: string;
+    user_uuid: string;
+    credit_limit: number;
+    allowed_agent_uuids: string[];
+    status: string;
+    created_at: string;
+    updated_at: string;
+    credits_used: number;
+    is_admin?: boolean;
+};
+type AggregatedUsage = {
+    user_uuid: string;
+    model_tier: string;
+    prompt_tokens: number;
+    completion_tokens: number;
+    ocr_seconds: number;
+    credits: number;
+    billing_type: string;
+    created_at: string;
+};
+type Tier = {
+    tier: string;
+    can_create_agents: boolean;
+    can_create_kbs: boolean;
+    can_use_workflows: boolean;
+    can_assign_agents: boolean;
+    can_assign_users: boolean;
+    can_choose_model: boolean;
+    kb_ocr_seconds: number;
+    max_agents: number;
+    max_kbs: number;
+    max_msg_per_day: number;
+    max_msg_per_min: number;
+    max_storage_bytes: number;
+    max_users: number;
+};
+type KortexWorkflowMessage = {
+    role: string;
+    content: string;
+};
+type KortexWorkflowPayload = {
+    agent_uuid?: string;
+    system_prompt?: string;
+    response_format?: string;
+    messages: KortexWorkflowMessage[];
+    stream?: boolean;
+    temperature?: number;
+    max_tokens?: number;
+    tools?: Record<string, any>[];
+};
+type KortexWorkflowResult = {
+    content: string;
+    usage: TokenUsage;
+};
+export { PagedResponse, PaginationParams, RAGConfig, LLMSettings, Agent, AgentCreatePayload, AgentUpdatePayload, ChunkingStrategy, KnowledgeBase, KnowledgeBaseCreatePayload, KnowledgeBaseUpdatePayload, Document, Participant, TokenUsage, ToolCall, RAGSource, Message, Conversation, ConversationCreatePayload, ConversationUpdatePayload, ParticipantAddPayload, ToolResultApproval, ToolResultPayload, PageContext, SendMessagePayload, InjectMessagePayload, OCRPayload, OCRResult, UserAccess, UserAccessCreatePayload, UserAccessUpdatePayload, TopUpPayload, UserMonthlyUsage, UserUsageBreakdown, MyAccess, AggregatedUsage, Tier, KortexWorkflowMessage, KortexWorkflowPayload, KortexWorkflowResult, };

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

@@ -0,0 +1,77 @@
+export type TimberSource = 'system' | 'user';
+export type TimberLevel = 'debug' | 'info' | 'warn' | 'error';
+export type TimberActorType = 'user' | 'api_key' | 'service' | 'system';
+export interface TimberActor {
+    type: TimberActorType;
+    id: string;
+    name?: string;
+    ip?: string;
+    user_agent?: string;
+}
+export interface TimberChanges {
+    before?: Record<string, any>;
+    after?: Record<string, any>;
+}
+export interface TimberEntry {
+    id: string;
+    timestamp: string;
+    source: TimberSource;
+    level: TimberLevel;
+    service: string;
+    project_uuid: string;
+    actor: TimberActor;
+    action?: string;
+    resource_type?: string;
+    resource_id?: string;
+    resource_name?: string;
+    message?: string;
+    changes?: TimberChanges;
+    attributes?: Record<string, any>;
+    trace_id?: string;
+    span_id?: string;
+    request_id?: string;
+}
+export interface TimberQueryParams {
+    limit?: number;
+    cursor?: string;
+    source?: TimberSource;
+    level?: TimberLevel;
+    from?: string | Date;
+    to?: string | Date;
+    actor_id?: string;
+    actor_name?: string;
+    actor_type?: TimberActorType;
+    action?: string;
+    resource_type?: string;
+    resource_id?: string;
+    request_uuid?: string;
+    search?: string;
+}
+export interface TimberQueryResponse {
+    data: TimberEntry[];
+    meta: {
+        limit: number;
+        has_more: boolean;
+        next_cursor?: string;
+    };
+}
+export interface TimberWritePayload {
+    level?: TimberLevel;
+    message: string;
+    service?: string;
+    resource_type?: string;
+    resource_id?: string;
+    resource_name?: string;
+    attributes?: Record<string, any>;
+    trace_id?: string;
+    span_id?: string;
+    request_id?: string;
+}
+export type TimberLogPayload = Omit<TimberWritePayload, 'level'>;
+export interface TimberUsage {
+    tier: 'free' | 'pro' | string;
+    period?: string;
+    bytes_ingested?: number;
+    gb_ingested?: number;
+    [key: string]: any;
+}

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 };

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

@@ -0,0 +1,77 @@
+export type TimberSource = 'system' | 'user';
+export type TimberLevel = 'debug' | 'info' | 'warn' | 'error';
+export type TimberActorType = 'user' | 'api_key' | 'service' | 'system';
+export interface TimberActor {
+    type: TimberActorType;
+    id: string;
+    name?: string;
+    ip?: string;
+    user_agent?: string;
+}
+export interface TimberChanges {
+    before?: Record<string, any>;
+    after?: Record<string, any>;
+}
+export interface TimberEntry {
+    id: string;
+    timestamp: string;
+    source: TimberSource;
+    level: TimberLevel;
+    service: string;
+    project_uuid: string;
+    actor: TimberActor;
+    action?: string;
+    resource_type?: string;
+    resource_id?: string;
+    resource_name?: string;
+    message?: string;
+    changes?: TimberChanges;
+    attributes?: Record<string, any>;
+    trace_id?: string;
+    span_id?: string;
+    request_id?: string;
+}
+export interface TimberQueryParams {
+    limit?: number;
+    cursor?: string;
+    source?: TimberSource;
+    level?: TimberLevel;
+    from?: string | Date;
+    to?: string | Date;
+    actor_id?: string;
+    actor_name?: string;
+    actor_type?: TimberActorType;
+    action?: string;
+    resource_type?: string;
+    resource_id?: string;
+    request_uuid?: string;
+    search?: string;
+}
+export interface TimberQueryResponse {
+    data: TimberEntry[];
+    meta: {
+        limit: number;
+        has_more: boolean;
+        next_cursor?: string;
+    };
+}
+export interface TimberWritePayload {
+    level?: TimberLevel;
+    message: string;
+    service?: string;
+    resource_type?: string;
+    resource_id?: string;
+    resource_name?: string;
+    attributes?: Record<string, any>;
+    trace_id?: string;
+    span_id?: string;
+    request_id?: string;
+}
+export type TimberLogPayload = Omit<TimberWritePayload, 'level'>;
+export interface TimberUsage {
+    tier: 'free' | 'pro' | string;
+    period?: string;
+    bytes_ingested?: number;
+    gb_ingested?: number;
+    [key: string]: any;
+}

package/package.json

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