@kortex-app/api 0.0.1-next.202511101646-afc43f26284 → 0.0.1-next.202511131258-3f92ba93f

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@kortex-app/api",
-  "version": "0.0.1-next.202511101646-afc43f26284",
+  "version": "0.0.1-next.202511131258-3f92ba93f",
   "description": "API for Kortex extensions",
   "repository": "https://github.com/kortex-hub/kortex",
   "publishConfig": {
+    "provenance": true,
     "access": "public"
   },
   "license": "Apache-2.0",

package/src/extension-api.d.ts

@@ -431,6 +431,12 @@ declare module '@kortex-app/api' {
     flowId: string;
   }
 
+  export interface FlowExecuteParams {
+    flowId: string;
+    logger: Logger;
+    params?: Record<string, string>;
+  }
+
   export interface FlowGenerateCommandLineResult {
     command: string;
     args: string[];
@@ -497,7 +503,7 @@ declare module '@kortex-app/api' {
       /**
        * @experimental expect change
        */
-      execute(flowId: string, logger: Logger): Promise<void>;
+      execute(options: FlowExecuteParams): Promise<void>;
     };
   }
 
@@ -802,6 +808,62 @@ declare module '@kortex-app/api' {
     logo?: string | { light: string; dark: string };
   }
 
+  // details of a scheduled task execution (from getExecution)
+  export interface ProviderScheduleExecution {
+    id: string;
+    lastExecution: Date;
+    output: string;
+    duration: number;
+    exitCode?: number;
+  }
+
+  // item representing a scheduled task (from listing)
+  export interface ProviderScheduleItem {
+    id: string;
+    metadata: Record<string, string>;
+    cronExpression: string;
+  }
+
+  // command to execute for the scheduled task
+  export interface ProviderSchedulerCommand {
+    command: string;
+    env: Record<string, string>;
+    args: string[];
+  }
+
+  // options to schedule a task
+  export interface ProviderSchedulerOptions {
+    command: ProviderSchedulerCommand;
+    cronExpression: string;
+    metadata: Record<string, string>;
+  }
+
+  // result of scheduling a task
+  export interface ProviderScheduleResult {
+    id: string;
+  }
+
+  export interface ProviderSchedulerListOptions {
+    metadataKeys?: string[];
+  }
+
+  // allow to schedule tasks, including listing, canceling and getting execution details
+  export interface ProviderScheduler {
+    name: string;
+
+    // schedule a task and return a schedule id
+    schedule(options: ProviderSchedulerOptions): Promise<ProviderScheduleResult>;
+
+    // cancel a scheduled task by id
+    cancel(id: string): Promise<void>;
+
+    // list scheduled tasks
+    list(options: ProviderSchedulerListOptions): Promise<ProviderScheduleItem[]>;
+
+    // get execution details for a scheduled task
+    getExecution(id: string): Promise<ProviderScheduleExecution | undefined>;
+  }
+
   export interface Provider {
     setContainerProviderConnectionFactory(
       containerProviderConnectionFactory: ContainerProviderConnectionFactory,
@@ -841,6 +903,8 @@ declare module '@kortex-app/api' {
 
     registerCleanup(cleanup: ProviderCleanup): Disposable;
 
+    registerScheduler(scheduler: ProviderScheduler): Disposable;
+
     dispose(): void;
     readonly name: string;
     readonly id: string;
@@ -1166,6 +1230,10 @@ declare module '@kortex-app/api' {
     readonly label: string;
   }
 
+  export interface SchedulerOptions {
+    name: string;
+  }
+
   export namespace provider {
     export function createProvider(provider: ProviderOptions): Provider;
     export const onDidUpdateProvider: Event<ProviderEvent>;