@knowledge-stack/ksapi 1.81.0 → 1.83.0

package/src/models/WorkflowRunResponse.ts

@@ -37,6 +37,11 @@ import {
 
 /**
  * Workflow run response.
+ * 
+ * Note: ``run_token_jti`` is intentionally NOT exposed. It's an
+ * internal token identifier persisted on the run row for callback
+ * auth — clients should treat run dispatch state as observable via
+ * ``status`` (RUNNING => dispatched), not via JTI presence.
  * @export
  * @interface WorkflowRunResponse
  */
@@ -95,6 +100,18 @@ export interface WorkflowRunResponse {
      * @memberof WorkflowRunResponse
      */
     error: string | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof WorkflowRunResponse
+     */
+    inputPathPartIds: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof WorkflowRunResponse
+     */
+    inputVersionIds: Array<string>;
     /**
      * 
      * @type {Date}
@@ -141,6 +158,8 @@ export function instanceOfWorkflowRunResponse(value: object): value is WorkflowR
     if (!('completedAt' in value) || value['completedAt'] === undefined) return false;
     if (!('runSnapshot' in value) || value['runSnapshot'] === undefined) return false;
     if (!('error' in value) || value['error'] === undefined) return false;
+    if (!('inputPathPartIds' in value) || value['inputPathPartIds'] === undefined) return false;
+    if (!('inputVersionIds' in value) || value['inputVersionIds'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
     return true;
@@ -165,6 +184,8 @@ export function WorkflowRunResponseFromJSONTyped(json: any, ignoreDiscriminator:
         'completedAt': (json['completed_at'] == null ? null : new Date(json['completed_at'])),
         'runSnapshot': WorkflowRunSnapshotFromJSON(json['run_snapshot']),
         'error': json['error'],
+        'inputPathPartIds': json['input_path_part_ids'],
+        'inputVersionIds': json['input_version_ids'],
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
     };
@@ -190,6 +211,8 @@ export function WorkflowRunResponseToJSONTyped(value?: WorkflowRunResponse | nul
         'completed_at': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
         'run_snapshot': WorkflowRunSnapshotToJSON(value['runSnapshot']),
         'error': value['error'],
+        'input_path_part_ids': value['inputPathPartIds'],
+        'input_version_ids': value['inputVersionIds'],
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
     };

package/src/models/WorkflowRunSnapshot.ts

@@ -20,6 +20,13 @@ import {
     ABCDPathSnapshotToJSON,
     ABCDPathSnapshotToJSONTyped,
 } from './ABCDPathSnapshot';
+import type { InstructionSnapshot } from './InstructionSnapshot';
+import {
+    InstructionSnapshotFromJSON,
+    InstructionSnapshotFromJSONTyped,
+    InstructionSnapshotToJSON,
+    InstructionSnapshotToJSONTyped,
+} from './InstructionSnapshot';
 import type { WorkflowRunnerType } from './WorkflowRunnerType';
 import {
     WorkflowRunnerTypeFromJSON,
@@ -72,10 +79,10 @@ export interface WorkflowRunSnapshot {
     sources: Array<ABCDPathSnapshot>;
     /**
      * 
-     * @type {Array<ABCDPathSnapshot>}
+     * @type {Array<InstructionSnapshot>}
      * @memberof WorkflowRunSnapshot
      */
-    instructions: Array<ABCDPathSnapshot>;
+    instructions: Array<InstructionSnapshot>;
     /**
      * 
      * @type {Array<ABCDPathSnapshot>}
@@ -141,7 +148,7 @@ export function WorkflowRunSnapshotFromJSONTyped(json: any, ignoreDiscriminator:
         'userId': json['user_id'],
         'maxRunDurationSeconds': json['max_run_duration_seconds'],
         'sources': ((json['sources'] as Array<any>).map(ABCDPathSnapshotFromJSON)),
-        'instructions': ((json['instructions'] as Array<any>).map(ABCDPathSnapshotFromJSON)),
+        'instructions': ((json['instructions'] as Array<any>).map(InstructionSnapshotFromJSON)),
         'outputs': ((json['outputs'] as Array<any>).map(ABCDPathSnapshotFromJSON)),
         'template': ABCDPathSnapshotFromJSON(json['template']),
     };
@@ -164,7 +171,7 @@ export function WorkflowRunSnapshotToJSONTyped(value?: WorkflowRunSnapshot | nul
         'user_id': value['userId'],
         'max_run_duration_seconds': value['maxRunDurationSeconds'],
         'sources': ((value['sources'] as Array<any>).map(ABCDPathSnapshotToJSON)),
-        'instructions': ((value['instructions'] as Array<any>).map(ABCDPathSnapshotToJSON)),
+        'instructions': ((value['instructions'] as Array<any>).map(InstructionSnapshotToJSON)),
         'outputs': ((value['outputs'] as Array<any>).map(ABCDPathSnapshotToJSON)),
         'template': ABCDPathSnapshotToJSON(value['template']),
     };

package/src/models/WorkflowRunStatus.ts

@@ -14,13 +14,31 @@
 
 
 /**
- * Lifecycle status of a workflow run.
+ * Combined lifecycle + approval-rollup status of a workflow run.
+ * 
+ * Absorbs the prior split between ``status`` (PENDING/RUNNING/COMPLETED/
+ * FAILED) and ``approval_state`` (in_progress/awaiting_review/approved/
+ * rejected/failed). One state field per run.
+ * 
+ * Allowed transitions::
+ * 
+ *     PENDING        -> IN_PROGRESS              (agent dispatched)
+ *     IN_PROGRESS    -> COMPLETED                (workflow.approval_required=FALSE)
+ *     IN_PROGRESS    -> NEEDS_APPROVAL           (workflow.approval_required=TRUE, agent done)
+ *     NEEDS_APPROVAL -> APPROVED                 (run folder approved by reviewer)
+ *     NEEDS_APPROVAL -> REJECTED                 (run folder or any child rejected)
+ *     APPROVED       -> NEEDS_APPROVAL           (run folder unapproved)
+ *     REJECTED       -> NEEDS_APPROVAL           (rejection reversed; mutable)
+ *     any non-terminal -> FAILED                 (agent error)
  * @export
  */
 export const WorkflowRunStatus = {
     Pending: 'PENDING',
-    Running: 'RUNNING',
+    InProgress: 'IN_PROGRESS',
     Completed: 'COMPLETED',
+    NeedsApproval: 'NEEDS_APPROVAL',
+    Approved: 'APPROVED',
+    Rejected: 'REJECTED',
     Failed: 'FAILED'
 } as const;
 export type WorkflowRunStatus = typeof WorkflowRunStatus[keyof typeof WorkflowRunStatus];

package/src/models/WorkflowRunnerType.ts

@@ -18,7 +18,8 @@
  * @export
  */
 export const WorkflowRunnerType = {
-    SelfHosted: 'SELF_HOSTED'
+    SelfHosted: 'SELF_HOSTED',
+    KsInternal: 'KS_INTERNAL'
 } as const;
 export type WorkflowRunnerType = typeof WorkflowRunnerType[keyof typeof WorkflowRunnerType];
 

package/src/models/index.ts

@@ -76,6 +76,7 @@ export * from './ImageTaxonomy';
 export * from './InformationStatistics';
 export * from './IngestDocumentResponse';
 export * from './IngestionMode';
+export * from './InstructionSnapshot';
 export * from './InviteLinkSettingsRequest';
 export * from './InviteLinkSettingsResponse';
 export * from './InviteResponse';
@@ -117,6 +118,8 @@ export * from './PasswordResetRequest';
 export * from './PasswordResetWithTokenRequest';
 export * from './PathOrder';
 export * from './PathPartAncestorItem';
+export * from './PathPartApprovalDecision';
+export * from './PathPartApprovalResponse';
 export * from './PathPartResponse';
 export * from './PathPartTagsResponse';
 export * from './PermissionCapability';
@@ -126,9 +129,11 @@ export * from './PipelineStatus';
 export * from './Polygon';
 export * from './PolygonReference';
 export * from './ReferenceType';
+export * from './RejectFileRequest';
 export * from './ResolvedReferenceInput';
 export * from './ResolvedReferenceOutput';
 export * from './RootResponse';
+export * from './RunLockResponse';
 export * from './SSOInitiateResponse';
 export * from './ScoredChunkResponse';
 export * from './SearchSortOrder';