@knowledge-stack/ksapi 1.101.2 → 1.103.0

package/dist/esm/models/WorkflowAdoptionStats.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 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.
+ */
+/**
+ * Adoption proxies for a workflow-runs summary.
+ *
+ * These are deliberately labelled "adoption", not "value" — they measure
+ * how much the system is used, not the business value it produced (which is
+ * not derivable from any column we store).
+ * @export
+ * @interface WorkflowAdoptionStats
+ */
+export interface WorkflowAdoptionStats {
+    /**
+     * Runs created in the window.
+     * @type {number}
+     * @memberof WorkflowAdoptionStats
+     */
+    runs: number;
+    /**
+     * Currently-active workflow definitions in scope (not windowed).
+     * @type {number}
+     * @memberof WorkflowAdoptionStats
+     */
+    activeDefinitions: number;
+    /**
+     * Distinct run owners in the window.
+     * @type {number}
+     * @memberof WorkflowAdoptionStats
+     */
+    distinctTriggerers: number;
+}
+export declare const WorkflowAdoptionStatsPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the WorkflowAdoptionStats interface.
+ */
+export declare function instanceOfWorkflowAdoptionStats(value: object): value is WorkflowAdoptionStats;
+export declare function WorkflowAdoptionStatsFromJSON(json: any): WorkflowAdoptionStats;
+export declare function WorkflowAdoptionStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowAdoptionStats;
+export declare function WorkflowAdoptionStatsToJSON(json: any): WorkflowAdoptionStats;
+export declare function WorkflowAdoptionStatsToJSONTyped(value?: WorkflowAdoptionStats | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WorkflowAdoptionStats.js

@@ -0,0 +1,52 @@
+/* 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.
+ */
+export const WorkflowAdoptionStatsPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the WorkflowAdoptionStats interface.
+ */
+export function instanceOfWorkflowAdoptionStats(value) {
+    if (!('runs' in value) || value['runs'] === undefined)
+        return false;
+    if (!('activeDefinitions' in value) || value['activeDefinitions'] === undefined)
+        return false;
+    if (!('distinctTriggerers' in value) || value['distinctTriggerers'] === undefined)
+        return false;
+    return true;
+}
+export function WorkflowAdoptionStatsFromJSON(json) {
+    return WorkflowAdoptionStatsFromJSONTyped(json, false);
+}
+export function WorkflowAdoptionStatsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'runs': json['runs'],
+        'activeDefinitions': json['active_definitions'],
+        'distinctTriggerers': json['distinct_triggerers'],
+    };
+}
+export function WorkflowAdoptionStatsToJSON(json) {
+    return WorkflowAdoptionStatsToJSONTyped(json, false);
+}
+export function WorkflowAdoptionStatsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'runs': value['runs'],
+        'active_definitions': value['activeDefinitions'],
+        'distinct_triggerers': value['distinctTriggerers'],
+    };
+}

package/dist/esm/models/WorkflowDefinitionOrder.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+/**
+ * Sortable fields for workflow-definition listings (time only for now).
+ * @export
+ */
+export declare const WorkflowDefinitionOrder: {
+    readonly CreatedAt: "CREATED_AT";
+    readonly UpdatedAt: "UPDATED_AT";
+};
+export type WorkflowDefinitionOrder = typeof WorkflowDefinitionOrder[keyof typeof WorkflowDefinitionOrder];
+export declare function instanceOfWorkflowDefinitionOrder(value: any): boolean;
+export declare function WorkflowDefinitionOrderFromJSON(json: any): WorkflowDefinitionOrder;
+export declare function WorkflowDefinitionOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowDefinitionOrder;
+export declare function WorkflowDefinitionOrderToJSON(value?: WorkflowDefinitionOrder | null): any;
+export declare function WorkflowDefinitionOrderToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowDefinitionOrder;

package/dist/esm/models/WorkflowDefinitionOrder.js

@@ -0,0 +1,43 @@
+/* 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.
+ */
+/**
+ * Sortable fields for workflow-definition listings (time only for now).
+ * @export
+ */
+export const WorkflowDefinitionOrder = {
+    CreatedAt: 'CREATED_AT',
+    UpdatedAt: 'UPDATED_AT'
+};
+export function instanceOfWorkflowDefinitionOrder(value) {
+    for (const key in WorkflowDefinitionOrder) {
+        if (Object.prototype.hasOwnProperty.call(WorkflowDefinitionOrder, key)) {
+            if (WorkflowDefinitionOrder[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function WorkflowDefinitionOrderFromJSON(json) {
+    return WorkflowDefinitionOrderFromJSONTyped(json, false);
+}
+export function WorkflowDefinitionOrderFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function WorkflowDefinitionOrderToJSON(value) {
+    return value;
+}
+export function WorkflowDefinitionOrderToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/esm/models/WorkflowDefinitionResponse.d.ts

@@ -11,6 +11,7 @@
  */
 import type { ItemPermissions } from './ItemPermissions';
 import type { PathPartApprovalState } from './PathPartApprovalState';
+import type { UserInfo } from './UserInfo';
 /**
  * Workflow definition response.
  *
@@ -95,12 +96,36 @@ export interface WorkflowDefinitionResponse {
      * @memberof WorkflowDefinitionResponse
      */
     approvalRequired: boolean;
+    /**
+     * Whether this definition is a non-runnable template
+     * @type {boolean}
+     * @memberof WorkflowDefinitionResponse
+     */
+    isTemplate: boolean;
+    /**
+     * Source definition this workflow was copied from (a template or any other workflow); null if hand-authored.
+     * @type {string}
+     * @memberof WorkflowDefinitionResponse
+     */
+    createdFromId: string | null;
+    /**
+     * Number of workflows copied from this definition.
+     * @type {number}
+     * @memberof WorkflowDefinitionResponse
+     */
+    copyCount?: number;
     /**
      *
      * @type {PathPartApprovalState}
      * @memberof WorkflowDefinitionResponse
      */
     approvalState: PathPartApprovalState;
+    /**
+     * Current owner (creator) of the workflow, or null if unowned.
+     * @type {UserInfo}
+     * @memberof WorkflowDefinitionResponse
+     */
+    owner?: UserInfo | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/WorkflowDefinitionResponse.js

@@ -13,6 +13,7 @@
  */
 import { ItemPermissionsFromJSON, ItemPermissionsToJSON, } from './ItemPermissions';
 import { PathPartApprovalStateFromJSON, PathPartApprovalStateToJSON, } from './PathPartApprovalState';
+import { UserInfoFromJSON, UserInfoToJSON, } from './UserInfo';
 /**
  * @export
  */
@@ -46,6 +47,10 @@ export function instanceOfWorkflowDefinitionResponse(value) {
         return false;
     if (!('approvalRequired' in value) || value['approvalRequired'] === undefined)
         return false;
+    if (!('isTemplate' in value) || value['isTemplate'] === undefined)
+        return false;
+    if (!('createdFromId' in value) || value['createdFromId'] === undefined)
+        return false;
     if (!('approvalState' in value) || value['approvalState'] === undefined)
         return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
@@ -74,7 +79,11 @@ export function WorkflowDefinitionResponseFromJSONTyped(json, ignoreDiscriminato
         'instructionPathPartId': json['instruction_path_part_id'],
         'isActive': json['is_active'],
         'approvalRequired': json['approval_required'],
+        'isTemplate': json['is_template'],
+        'createdFromId': json['created_from_id'],
+        'copyCount': json['copy_count'] == null ? undefined : json['copy_count'],
         'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
+        'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
         'permissions': json['permissions'] == null ? undefined : ItemPermissionsFromJSON(json['permissions']),
@@ -100,7 +109,11 @@ export function WorkflowDefinitionResponseToJSONTyped(value, ignoreDiscriminator
         'instruction_path_part_id': value['instructionPathPartId'],
         'is_active': value['isActive'],
         'approval_required': value['approvalRequired'],
+        'is_template': value['isTemplate'],
+        'created_from_id': value['createdFromId'],
+        'copy_count': value['copyCount'],
         'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
+        'owner': UserInfoToJSON(value['owner']),
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
         'permissions': ItemPermissionsToJSON(value['permissions']),

package/dist/esm/models/WorkflowRunOrder.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ */
+/**
+ * Sortable fields for run listings (all default newest-first).
+ * @export
+ */
+export declare const WorkflowRunOrder: {
+    readonly StartedAt: "STARTED_AT";
+    readonly CreatedAt: "CREATED_AT";
+    readonly CompletedAt: "COMPLETED_AT";
+};
+export type WorkflowRunOrder = typeof WorkflowRunOrder[keyof typeof WorkflowRunOrder];
+export declare function instanceOfWorkflowRunOrder(value: any): boolean;
+export declare function WorkflowRunOrderFromJSON(json: any): WorkflowRunOrder;
+export declare function WorkflowRunOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRunOrder;
+export declare function WorkflowRunOrderToJSON(value?: WorkflowRunOrder | null): any;
+export declare function WorkflowRunOrderToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowRunOrder;

package/dist/esm/models/WorkflowRunOrder.js

@@ -0,0 +1,44 @@
+/* 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.
+ */
+/**
+ * Sortable fields for run listings (all default newest-first).
+ * @export
+ */
+export const WorkflowRunOrder = {
+    StartedAt: 'STARTED_AT',
+    CreatedAt: 'CREATED_AT',
+    CompletedAt: 'COMPLETED_AT'
+};
+export function instanceOfWorkflowRunOrder(value) {
+    for (const key in WorkflowRunOrder) {
+        if (Object.prototype.hasOwnProperty.call(WorkflowRunOrder, key)) {
+            if (WorkflowRunOrder[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function WorkflowRunOrderFromJSON(json) {
+    return WorkflowRunOrderFromJSONTyped(json, false);
+}
+export function WorkflowRunOrderFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function WorkflowRunOrderToJSON(value) {
+    return value;
+}
+export function WorkflowRunOrderToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/esm/models/WorkflowRunResponse.d.ts

@@ -156,6 +156,12 @@ export interface WorkflowRunResponse {
      * @memberof WorkflowRunResponse
      */
     runThreadId?: string | null;
+    /**
+     * Current owner (creator) of the run, or null if unowned. Usually the same user as ``triggered_by`` unless ownership was transferred.
+     * @type {UserInfo}
+     * @memberof WorkflowRunResponse
+     */
+    owner?: UserInfo | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/WorkflowRunResponse.js

@@ -98,6 +98,7 @@ export function WorkflowRunResponseFromJSONTyped(json, ignoreDiscriminator) {
         'inputPathPartIds': json['input_path_part_ids'] == null ? undefined : json['input_path_part_ids'],
         'outputsPathPartIds': json['outputs_path_part_ids'],
         'runThreadId': json['run_thread_id'] == null ? undefined : json['run_thread_id'],
+        'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
         'permissions': json['permissions'] == null ? undefined : ItemPermissionsFromJSON(json['permissions']),
@@ -132,6 +133,7 @@ export function WorkflowRunResponseToJSONTyped(value, ignoreDiscriminator = fals
         'input_path_part_ids': value['inputPathPartIds'],
         'outputs_path_part_ids': value['outputsPathPartIds'],
         'run_thread_id': value['runThreadId'],
+        'owner': UserInfoToJSON(value['owner']),
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
         'permissions': ItemPermissionsToJSON(value['permissions']),

package/dist/esm/models/WorkflowRunSummaryResponse.d.ts

@@ -0,0 +1,111 @@
+/**
+ * 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.
+ */
+import type { WorkflowAdoptionStats } from './WorkflowAdoptionStats';
+/**
+ * Aggregate workflow-runs health over a window, permission-scoped.
+ *
+ * Read-gated like the run list: the numbers cover only runs under workflows
+ * the caller can read (OWNER/ADMIN ⇒ tenant-wide). All windowed metrics
+ * filter runs by ``created_at`` in ``[window_start, window_end]``; the
+ * approval backlog and ``active_definitions`` are point-in-time (not
+ * windowed). ``failure_rate`` and the duration percentiles are ``None`` when
+ * their denominator set is empty.
+ * @export
+ * @interface WorkflowRunSummaryResponse
+ */
+export interface WorkflowRunSummaryResponse {
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkflowRunSummaryResponse
+     */
+    windowStart: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkflowRunSummaryResponse
+     */
+    windowEnd: Date | null;
+    /**
+     * Runs created in the window.
+     * @type {number}
+     * @memberof WorkflowRunSummaryResponse
+     */
+    total: number;
+    /**
+     * Run count per execution_state (all states present).
+     * @type {{ [key: string]: number; }}
+     * @memberof WorkflowRunSummaryResponse
+     */
+    countsByState: {
+        [key: string]: number;
+    };
+    /**
+     * FAILED / (COMPLETED + FAILED); null when no terminal runs.
+     * @type {number}
+     * @memberof WorkflowRunSummaryResponse
+     */
+    failureRate: number | null;
+    /**
+     * Median run duration over terminal runs; null when none.
+     * @type {number}
+     * @memberof WorkflowRunSummaryResponse
+     */
+    durationP50Seconds: number | null;
+    /**
+     * p95 run duration over terminal runs; null when none.
+     * @type {number}
+     * @memberof WorkflowRunSummaryResponse
+     */
+    durationP95Seconds: number | null;
+    /**
+     * Runs currently awaiting approval (point-in-time).
+     * @type {number}
+     * @memberof WorkflowRunSummaryResponse
+     */
+    pendingApprovalCount: number;
+    /**
+     * Age of the oldest pending-approval request; null when none.
+     * @type {number}
+     * @memberof WorkflowRunSummaryResponse
+     */
+    oldestPendingAgeSeconds: number | null;
+    /**
+     *
+     * @type {WorkflowAdoptionStats}
+     * @memberof WorkflowRunSummaryResponse
+     */
+    adoption: WorkflowAdoptionStats;
+}
+export declare const WorkflowRunSummaryResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the WorkflowRunSummaryResponse interface.
+ */
+export declare function instanceOfWorkflowRunSummaryResponse(value: object): value is WorkflowRunSummaryResponse;
+export declare function WorkflowRunSummaryResponseFromJSON(json: any): WorkflowRunSummaryResponse;
+export declare function WorkflowRunSummaryResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRunSummaryResponse;
+export declare function WorkflowRunSummaryResponseToJSON(json: any): WorkflowRunSummaryResponse;
+export declare function WorkflowRunSummaryResponseToJSONTyped(value?: WorkflowRunSummaryResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WorkflowRunSummaryResponse.js

@@ -0,0 +1,81 @@
+/* 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.
+ */
+import { WorkflowAdoptionStatsFromJSON, WorkflowAdoptionStatsToJSON, } from './WorkflowAdoptionStats';
+export const WorkflowRunSummaryResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the WorkflowRunSummaryResponse interface.
+ */
+export function instanceOfWorkflowRunSummaryResponse(value) {
+    if (!('windowStart' in value) || value['windowStart'] === undefined)
+        return false;
+    if (!('windowEnd' in value) || value['windowEnd'] === undefined)
+        return false;
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('countsByState' in value) || value['countsByState'] === undefined)
+        return false;
+    if (!('failureRate' in value) || value['failureRate'] === undefined)
+        return false;
+    if (!('durationP50Seconds' in value) || value['durationP50Seconds'] === undefined)
+        return false;
+    if (!('durationP95Seconds' in value) || value['durationP95Seconds'] === undefined)
+        return false;
+    if (!('pendingApprovalCount' in value) || value['pendingApprovalCount'] === undefined)
+        return false;
+    if (!('oldestPendingAgeSeconds' in value) || value['oldestPendingAgeSeconds'] === undefined)
+        return false;
+    if (!('adoption' in value) || value['adoption'] === undefined)
+        return false;
+    return true;
+}
+export function WorkflowRunSummaryResponseFromJSON(json) {
+    return WorkflowRunSummaryResponseFromJSONTyped(json, false);
+}
+export function WorkflowRunSummaryResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'windowStart': (new Date(json['window_start'])),
+        'windowEnd': (json['window_end'] == null ? null : new Date(json['window_end'])),
+        'total': json['total'],
+        'countsByState': json['counts_by_state'],
+        'failureRate': json['failure_rate'],
+        'durationP50Seconds': json['duration_p50_seconds'],
+        'durationP95Seconds': json['duration_p95_seconds'],
+        'pendingApprovalCount': json['pending_approval_count'],
+        'oldestPendingAgeSeconds': json['oldest_pending_age_seconds'],
+        'adoption': WorkflowAdoptionStatsFromJSON(json['adoption']),
+    };
+}
+export function WorkflowRunSummaryResponseToJSON(json) {
+    return WorkflowRunSummaryResponseToJSONTyped(json, false);
+}
+export function WorkflowRunSummaryResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'window_start': value['windowStart'].toISOString(),
+        'window_end': value['windowEnd'] == null ? value['windowEnd'] : value['windowEnd'].toISOString(),
+        'total': value['total'],
+        'counts_by_state': value['countsByState'],
+        'failure_rate': value['failureRate'],
+        'duration_p50_seconds': value['durationP50Seconds'],
+        'duration_p95_seconds': value['durationP95Seconds'],
+        'pending_approval_count': value['pendingApprovalCount'],
+        'oldest_pending_age_seconds': value['oldestPendingAgeSeconds'],
+        'adoption': WorkflowAdoptionStatsToJSON(value['adoption']),
+    };
+}