@knowledge-stack/ksapi 1.88.1 → 1.89.0

package/dist/models/WorkflowDefinitionResponse.d.ts

@@ -9,74 +9,79 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { WorkflowRunnerType } from './WorkflowRunnerType';
-import type { SelfHostedRunnerConfigResponse } from './SelfHostedRunnerConfigResponse';
+import type { PathPartApprovalState } from './PathPartApprovalState';
 /**
  * Workflow definition response.
+ *
+ * Doubles as a discriminated-union variant for folder-listing
+ * responses. The ``part_type`` literal is the discriminator: when the
+ * FE walks a folder tree it sees this shape mixed in with
+ * ``FolderResponse`` / ``DocumentResponse`` and can route to the
+ * dedicated workflow page based on ``part_type``.
  * @export
  * @interface WorkflowDefinitionResponse
  */
 export interface WorkflowDefinitionResponse {
     /**
-     *
-     * @type {string}
+     * Path part type
+     * @type {WorkflowDefinitionResponsePartTypeEnum}
      * @memberof WorkflowDefinitionResponse
      */
-    id: string;
+    partType?: WorkflowDefinitionResponsePartTypeEnum;
     /**
      *
      * @type {string}
      * @memberof WorkflowDefinitionResponse
      */
-    name: string;
+    id: string;
     /**
-     *
+     * WORKFLOW_DEFINITION path_part of this definition
      * @type {string}
      * @memberof WorkflowDefinitionResponse
      */
-    description: string | null;
+    pathPartId: string;
     /**
-     *
-     * @type {WorkflowRunnerType}
+     * FOLDER path_part of the containing folder
+     * @type {string}
      * @memberof WorkflowDefinitionResponse
      */
-    runnerType: WorkflowRunnerType;
+    parentPathPartId: string | null;
     /**
-     *
-     * @type {SelfHostedRunnerConfigResponse}
+     * Full materialized path from root
+     * @type {string}
      * @memberof WorkflowDefinitionResponse
      */
-    runnerConfig: SelfHostedRunnerConfigResponse | null;
+    materializedPath: string;
     /**
      *
-     * @type {number}
+     * @type {string}
      * @memberof WorkflowDefinitionResponse
      */
-    maxRunDurationSeconds: number;
+    tenantId: string;
     /**
      *
-     * @type {Array<string>}
+     * @type {string}
      * @memberof WorkflowDefinitionResponse
      */
-    sourcePathPartIds: Array<string>;
+    name: string;
     /**
      *
-     * @type {Array<string>}
+     * @type {string}
      * @memberof WorkflowDefinitionResponse
      */
-    instructionPathPartIds: Array<string>;
+    description: string | null;
     /**
      *
-     * @type {Array<string>}
+     * @type {number}
      * @memberof WorkflowDefinitionResponse
      */
-    outputPathPartIds: Array<string>;
+    maxRunDurationSeconds: number;
     /**
-     *
+     * DOCUMENT path_part of the instruction document
      * @type {string}
      * @memberof WorkflowDefinitionResponse
      */
-    templatePathPartId: string | null;
+    instructionPathPartId: string;
     /**
      *
      * @type {boolean}
@@ -89,6 +94,12 @@ export interface WorkflowDefinitionResponse {
      * @memberof WorkflowDefinitionResponse
      */
     approvalRequired: boolean;
+    /**
+     *
+     * @type {PathPartApprovalState}
+     * @memberof WorkflowDefinitionResponse
+     */
+    approvalState: PathPartApprovalState;
     /**
      *
      * @type {Date}
@@ -102,6 +113,13 @@ export interface WorkflowDefinitionResponse {
      */
     updatedAt: Date;
 }
+/**
+ * @export
+ */
+export declare const WorkflowDefinitionResponsePartTypeEnum: {
+    readonly WorkflowDefinition: "WORKFLOW_DEFINITION";
+};
+export type WorkflowDefinitionResponsePartTypeEnum = typeof WorkflowDefinitionResponsePartTypeEnum[keyof typeof WorkflowDefinitionResponsePartTypeEnum];
 export declare const WorkflowDefinitionResponsePropertyValidationAttributesMap: {
     [property: string]: {
         maxLength?: number;

package/dist/models/WorkflowDefinitionResponse.js

@@ -13,14 +13,19 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkflowDefinitionResponsePropertyValidationAttributesMap = void 0;
+exports.WorkflowDefinitionResponsePropertyValidationAttributesMap = exports.WorkflowDefinitionResponsePartTypeEnum = void 0;
 exports.instanceOfWorkflowDefinitionResponse = instanceOfWorkflowDefinitionResponse;
 exports.WorkflowDefinitionResponseFromJSON = WorkflowDefinitionResponseFromJSON;
 exports.WorkflowDefinitionResponseFromJSONTyped = WorkflowDefinitionResponseFromJSONTyped;
 exports.WorkflowDefinitionResponseToJSON = WorkflowDefinitionResponseToJSON;
 exports.WorkflowDefinitionResponseToJSONTyped = WorkflowDefinitionResponseToJSONTyped;
-const WorkflowRunnerType_1 = require("./WorkflowRunnerType");
-const SelfHostedRunnerConfigResponse_1 = require("./SelfHostedRunnerConfigResponse");
+const PathPartApprovalState_1 = require("./PathPartApprovalState");
+/**
+ * @export
+ */
+exports.WorkflowDefinitionResponsePartTypeEnum = {
+    WorkflowDefinition: 'WORKFLOW_DEFINITION'
+};
 exports.WorkflowDefinitionResponsePropertyValidationAttributesMap = {};
 /**
  * Check if a given object implements the WorkflowDefinitionResponse interface.
@@ -28,28 +33,28 @@ exports.WorkflowDefinitionResponsePropertyValidationAttributesMap = {};
 function instanceOfWorkflowDefinitionResponse(value) {
     if (!('id' in value) || value['id'] === undefined)
         return false;
-    if (!('name' in value) || value['name'] === undefined)
-        return false;
-    if (!('description' in value) || value['description'] === undefined)
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined)
         return false;
-    if (!('runnerType' in value) || value['runnerType'] === undefined)
+    if (!('parentPathPartId' in value) || value['parentPathPartId'] === undefined)
         return false;
-    if (!('runnerConfig' in value) || value['runnerConfig'] === undefined)
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined)
         return false;
-    if (!('maxRunDurationSeconds' in value) || value['maxRunDurationSeconds'] === undefined)
+    if (!('tenantId' in value) || value['tenantId'] === undefined)
         return false;
-    if (!('sourcePathPartIds' in value) || value['sourcePathPartIds'] === undefined)
+    if (!('name' in value) || value['name'] === undefined)
         return false;
-    if (!('instructionPathPartIds' in value) || value['instructionPathPartIds'] === undefined)
+    if (!('description' in value) || value['description'] === undefined)
         return false;
-    if (!('outputPathPartIds' in value) || value['outputPathPartIds'] === undefined)
+    if (!('maxRunDurationSeconds' in value) || value['maxRunDurationSeconds'] === undefined)
         return false;
-    if (!('templatePathPartId' in value) || value['templatePathPartId'] === undefined)
+    if (!('instructionPathPartId' in value) || value['instructionPathPartId'] === undefined)
         return false;
     if (!('isActive' in value) || value['isActive'] === undefined)
         return false;
     if (!('approvalRequired' in value) || value['approvalRequired'] === undefined)
         return false;
+    if (!('approvalState' in value) || value['approvalState'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -64,18 +69,19 @@ function WorkflowDefinitionResponseFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'partType': json['part_type'] == null ? undefined : json['part_type'],
         'id': json['id'],
+        'pathPartId': json['path_part_id'],
+        'parentPathPartId': json['parent_path_part_id'],
+        'materializedPath': json['materialized_path'],
+        'tenantId': json['tenant_id'],
         'name': json['name'],
         'description': json['description'],
-        'runnerType': (0, WorkflowRunnerType_1.WorkflowRunnerTypeFromJSON)(json['runner_type']),
-        'runnerConfig': (0, SelfHostedRunnerConfigResponse_1.SelfHostedRunnerConfigResponseFromJSON)(json['runner_config']),
         'maxRunDurationSeconds': json['max_run_duration_seconds'],
-        'sourcePathPartIds': json['source_path_part_ids'],
-        'instructionPathPartIds': json['instruction_path_part_ids'],
-        'outputPathPartIds': json['output_path_part_ids'],
-        'templatePathPartId': json['template_path_part_id'],
+        'instructionPathPartId': json['instruction_path_part_id'],
         'isActive': json['is_active'],
         'approvalRequired': json['approval_required'],
+        'approvalState': (0, PathPartApprovalState_1.PathPartApprovalStateFromJSON)(json['approval_state']),
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
     };
@@ -88,18 +94,19 @@ function WorkflowDefinitionResponseToJSONTyped(value, ignoreDiscriminator = fals
         return value;
     }
     return {
+        'part_type': value['partType'],
         'id': value['id'],
+        'path_part_id': value['pathPartId'],
+        'parent_path_part_id': value['parentPathPartId'],
+        'materialized_path': value['materializedPath'],
+        'tenant_id': value['tenantId'],
         'name': value['name'],
         'description': value['description'],
-        'runner_type': (0, WorkflowRunnerType_1.WorkflowRunnerTypeToJSON)(value['runnerType']),
-        'runner_config': (0, SelfHostedRunnerConfigResponse_1.SelfHostedRunnerConfigResponseToJSON)(value['runnerConfig']),
         'max_run_duration_seconds': value['maxRunDurationSeconds'],
-        'source_path_part_ids': value['sourcePathPartIds'],
-        'instruction_path_part_ids': value['instructionPathPartIds'],
-        'output_path_part_ids': value['outputPathPartIds'],
-        'template_path_part_id': value['templatePathPartId'],
+        'instruction_path_part_id': value['instructionPathPartId'],
         'is_active': value['isActive'],
         'approval_required': value['approvalRequired'],
+        'approval_state': (0, PathPartApprovalState_1.PathPartApprovalStateToJSON)(value['approvalState']),
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
     };

package/dist/models/WorkflowExecutionState.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Execution lifecycle of a workflow run.
+ *
+ * Two-step flow lifecycle:
+ *
+ * * ``PENDING`` — entry state when the create call carries uploads.
+ *   Inputs are being ingested by Temporal; the run cannot be started
+ *   yet. The ingestion-completion hook auto-flips the run to
+ *   ``NOT_STARTED`` once every input under ``inputs/`` reaches
+ *   ``pipeline_state.status == COMPLETED``.
+ * * ``NOT_STARTED`` — entry state when the create call has no
+ *   uploads (KB references only), OR the post-ingestion landing
+ *   pad. The user can Start the run from here.
+ * * ``IN_PROGRESS`` — set by ``POST /v1/workflow-runs/{id}/start``,
+ *   which builds the snapshot and dispatches the Temporal workflow.
+ * * ``COMPLETED`` / ``FAILED`` — terminal; ``completed_at`` is set.
+ * @export
+ */
+export declare const WorkflowExecutionState: {
+    readonly Pending: "PENDING";
+    readonly NotStarted: "NOT_STARTED";
+    readonly InProgress: "IN_PROGRESS";
+    readonly Completed: "COMPLETED";
+    readonly Failed: "FAILED";
+};
+export type WorkflowExecutionState = typeof WorkflowExecutionState[keyof typeof WorkflowExecutionState];
+export declare function instanceOfWorkflowExecutionState(value: any): boolean;
+export declare function WorkflowExecutionStateFromJSON(json: any): WorkflowExecutionState;
+export declare function WorkflowExecutionStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowExecutionState;
+export declare function WorkflowExecutionStateToJSON(value?: WorkflowExecutionState | null): any;
+export declare function WorkflowExecutionStateToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowExecutionState;

package/dist/models/WorkflowExecutionState.js

@@ -0,0 +1,68 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowExecutionState = void 0;
+exports.instanceOfWorkflowExecutionState = instanceOfWorkflowExecutionState;
+exports.WorkflowExecutionStateFromJSON = WorkflowExecutionStateFromJSON;
+exports.WorkflowExecutionStateFromJSONTyped = WorkflowExecutionStateFromJSONTyped;
+exports.WorkflowExecutionStateToJSON = WorkflowExecutionStateToJSON;
+exports.WorkflowExecutionStateToJSONTyped = WorkflowExecutionStateToJSONTyped;
+/**
+ * Execution lifecycle of a workflow run.
+ *
+ * Two-step flow lifecycle:
+ *
+ * * ``PENDING`` — entry state when the create call carries uploads.
+ *   Inputs are being ingested by Temporal; the run cannot be started
+ *   yet. The ingestion-completion hook auto-flips the run to
+ *   ``NOT_STARTED`` once every input under ``inputs/`` reaches
+ *   ``pipeline_state.status == COMPLETED``.
+ * * ``NOT_STARTED`` — entry state when the create call has no
+ *   uploads (KB references only), OR the post-ingestion landing
+ *   pad. The user can Start the run from here.
+ * * ``IN_PROGRESS`` — set by ``POST /v1/workflow-runs/{id}/start``,
+ *   which builds the snapshot and dispatches the Temporal workflow.
+ * * ``COMPLETED`` / ``FAILED`` — terminal; ``completed_at`` is set.
+ * @export
+ */
+exports.WorkflowExecutionState = {
+    Pending: 'PENDING',
+    NotStarted: 'NOT_STARTED',
+    InProgress: 'IN_PROGRESS',
+    Completed: 'COMPLETED',
+    Failed: 'FAILED'
+};
+function instanceOfWorkflowExecutionState(value) {
+    for (const key in exports.WorkflowExecutionState) {
+        if (Object.prototype.hasOwnProperty.call(exports.WorkflowExecutionState, key)) {
+            if (exports.WorkflowExecutionState[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function WorkflowExecutionStateFromJSON(json) {
+    return WorkflowExecutionStateFromJSONTyped(json, false);
+}
+function WorkflowExecutionStateFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function WorkflowExecutionStateToJSON(value) {
+    return value;
+}
+function WorkflowExecutionStateToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/WorkflowRunResponse.d.ts

@@ -10,55 +10,97 @@
  * Do not edit the class manually.
  */
 import type { WorkflowRunSnapshot } from './WorkflowRunSnapshot';
-import type { WorkflowRunStatus } from './WorkflowRunStatus';
-import type { WorkflowRunnerType } from './WorkflowRunnerType';
+import type { WorkflowExecutionState } from './WorkflowExecutionState';
+import type { PathPartApprovalState } from './PathPartApprovalState';
+import type { UserInfo } from './UserInfo';
 /**
  * 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.
+ * Doubles as a discriminated-union variant for folder-listing
+ * responses so the FE can mix WD/Run entries with regular folders +
+ * documents and route based on ``part_type``.
+ *
+ * Two-step flow note: a NOT_STARTED run has ``started_at=None`` and
+ * ``run_snapshot=None``; both are populated when Start dispatches the
+ * run. The flat ``input_path_part_ids`` list carries the
+ * currently-pinned KB references so the FE can render them on a
+ * NOT_STARTED run (the snapshot's typed list is not available yet).
  * @export
  * @interface WorkflowRunResponse
  */
 export interface WorkflowRunResponse {
+    /**
+     * Path part type
+     * @type {WorkflowRunResponsePartTypeEnum}
+     * @memberof WorkflowRunResponse
+     */
+    partType?: WorkflowRunResponsePartTypeEnum;
     /**
      *
      * @type {string}
      * @memberof WorkflowRunResponse
      */
     id: string;
+    /**
+     * WORKFLOW_RUN path_part of this run
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    pathPartId: string;
+    /**
+     * FOLDER path_part of the containing folder
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    parentPathPartId: string | null;
+    /**
+     * Full materialized path from root
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    materializedPath: string;
     /**
      *
      * @type {string}
      * @memberof WorkflowRunResponse
      */
-    workflowDefinitionId: string;
+    tenantId: string;
+    /**
+     * Run display name; mirrors ``path_part.name`` (the run's UUID until a slug feature lands).
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    name: string;
     /**
      *
      * @type {string}
      * @memberof WorkflowRunResponse
      */
-    userId: string;
+    workflowDefinitionId: string;
     /**
      *
-     * @type {WorkflowRunnerType}
+     * @type {UserInfo}
      * @memberof WorkflowRunResponse
      */
-    runnerType: WorkflowRunnerType;
+    triggeredBy: UserInfo;
     /**
      *
-     * @type {WorkflowRunStatus}
+     * @type {WorkflowExecutionState}
      * @memberof WorkflowRunResponse
      */
-    status: WorkflowRunStatus;
+    executionState: WorkflowExecutionState;
     /**
      *
+     * @type {PathPartApprovalState}
+     * @memberof WorkflowRunResponse
+     */
+    approvalState: PathPartApprovalState;
+    /**
+     * When Start dispatched the run. NULL while the run is NOT_STARTED.
      * @type {Date}
      * @memberof WorkflowRunResponse
      */
-    startedAt: Date;
+    startedAt: Date | null;
     /**
      *
      * @type {Date}
@@ -66,11 +108,11 @@ export interface WorkflowRunResponse {
      */
     completedAt: Date | null;
     /**
-     *
+     * Frozen workflow configuration captured at Start time. NULL while the run is NOT_STARTED.
      * @type {WorkflowRunSnapshot}
      * @memberof WorkflowRunResponse
      */
-    runSnapshot: WorkflowRunSnapshot;
+    runSnapshot: WorkflowRunSnapshot | null;
     /**
      *
      * @type {string}
@@ -78,17 +120,41 @@ export interface WorkflowRunResponse {
      */
     error: string | null;
     /**
-     *
+     * FOLDER path_part of the run's ``inputs/`` subfolder
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    inputsPathPartId: string;
+    /**
+     * FOLDER path_part of the run's ``outputs/`` subfolder
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    outputsPathPartId: string;
+    /**
+     * FOLDER path_part of the run's ``discussions/`` subfolder
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    discussionsPathPartId: string;
+    /**
+     * Flat list of currently-pinned KB-reference path_part ids (DOCUMENT + FOLDER). On a NOT_STARTED run this is the only surface for KB refs (run_snapshot is NULL).
      * @type {Array<string>}
      * @memberof WorkflowRunResponse
      */
-    inputPathPartIds: Array<string>;
+    inputPathPartIds?: Array<string>;
     /**
      *
      * @type {Array<string>}
      * @memberof WorkflowRunResponse
      */
-    inputVersionIds: Array<string>;
+    outputsPathPartIds: Array<string>;
+    /**
+     * The run's primary chat thread (1:1). NULL while NOT_STARTED; set by Start. The FE opens the run by opening this thread.
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    runThreadId?: string | null;
     /**
      *
      * @type {Date}
@@ -102,6 +168,13 @@ export interface WorkflowRunResponse {
      */
     updatedAt: Date;
 }
+/**
+ * @export
+ */
+export declare const WorkflowRunResponsePartTypeEnum: {
+    readonly WorkflowRun: "WORKFLOW_RUN";
+};
+export type WorkflowRunResponsePartTypeEnum = typeof WorkflowRunResponsePartTypeEnum[keyof typeof WorkflowRunResponsePartTypeEnum];
 export declare const WorkflowRunResponsePropertyValidationAttributesMap: {
     [property: string]: {
         maxLength?: number;