@knowledge-stack/ksapi 1.66.2 → 1.66.3

package/dist/esm/models/PermissionCapability.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.
+ */
+/**
+ * Permission capability.
+ * @export
+ */
+export const PermissionCapability = {
+    ReadOnly: 'READ_ONLY',
+    ReadWrite: 'READ_WRITE'
+};
+export function instanceOfPermissionCapability(value) {
+    for (const key in PermissionCapability) {
+        if (Object.prototype.hasOwnProperty.call(PermissionCapability, key)) {
+            if (PermissionCapability[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function PermissionCapabilityFromJSON(json) {
+    return PermissionCapabilityFromJSONTyped(json, false);
+}
+export function PermissionCapabilityFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function PermissionCapabilityToJSON(value) {
+    return value;
+}
+export function PermissionCapabilityToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,90 @@
+/**
+ * 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 { PermissionCapability } from './PermissionCapability';
+/**
+ *
+ * @export
+ * @interface PermissionResponse
+ */
+export interface PermissionResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof PermissionResponse
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PermissionResponse
+     */
+    tenantId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PermissionResponse
+     */
+    userId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PermissionResponse
+     */
+    pathPartId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PermissionResponse
+     */
+    materializedPath: string;
+    /**
+     *
+     * @type {PermissionCapability}
+     * @memberof PermissionResponse
+     */
+    capability: PermissionCapability;
+    /**
+     *
+     * @type {Date}
+     * @memberof PermissionResponse
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof PermissionResponse
+     */
+    updatedAt: Date;
+}
+export declare const PermissionResponsePropertyValidationAttributesMap: {
+    [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 PermissionResponse interface.
+ */
+export declare function instanceOfPermissionResponse(value: object): value is PermissionResponse;
+export declare function PermissionResponseFromJSON(json: any): PermissionResponse;
+export declare function PermissionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PermissionResponse;
+export declare function PermissionResponseToJSON(json: any): PermissionResponse;
+export declare function PermissionResponseToJSONTyped(value?: PermissionResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PermissionResponse.js

@@ -0,0 +1,73 @@
+/* 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 { PermissionCapabilityFromJSON, PermissionCapabilityToJSON, } from './PermissionCapability';
+export const PermissionResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the PermissionResponse interface.
+ */
+export function instanceOfPermissionResponse(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('tenantId' in value) || value['tenantId'] === undefined)
+        return false;
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined)
+        return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined)
+        return false;
+    if (!('capability' in value) || value['capability'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function PermissionResponseFromJSON(json) {
+    return PermissionResponseFromJSONTyped(json, false);
+}
+export function PermissionResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'tenantId': json['tenant_id'],
+        'userId': json['user_id'],
+        'pathPartId': json['path_part_id'],
+        'materializedPath': json['materialized_path'],
+        'capability': PermissionCapabilityFromJSON(json['capability']),
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+export function PermissionResponseToJSON(json) {
+    return PermissionResponseToJSONTyped(json, false);
+}
+export function PermissionResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'tenant_id': value['tenantId'],
+        'user_id': value['userId'],
+        'path_part_id': value['pathPartId'],
+        'materialized_path': value['materializedPath'],
+        'capability': PermissionCapabilityToJSON(value['capability']),
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,104 @@
+/**
+ * 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 { PipelineStatus } from './PipelineStatus';
+import type { IngestionMode } from './IngestionMode';
+import type { ChunkType } from './ChunkType';
+/**
+ * Pipeline execution state tracking.
+ * @export
+ * @interface PipelineState
+ */
+export interface PipelineState {
+    /**
+     *
+     * @type {PipelineStatus}
+     * @memberof PipelineState
+     */
+    status: PipelineStatus;
+    /**
+     * Timestamp of the last pipeline execution attempt (set once when a run starts)
+     * @type {Date}
+     * @memberof PipelineState
+     */
+    lastRunTimestamp?: Date | null;
+    /**
+     * Timestamp of the last pipeline state change (set by activities)
+     * @type {Date}
+     * @memberof PipelineState
+     */
+    lastStateUpdateTimestamp?: Date | null;
+    /**
+     * Name of the last activity that executed (e.g., 'document_preparation')
+     * @type {string}
+     * @memberof PipelineState
+     */
+    lastActivity?: string | null;
+    /**
+     * Error message if pipeline failed
+     * @type {string}
+     * @memberof PipelineState
+     */
+    error?: string | null;
+    /**
+     * Temporal workflow ID for tracking the ingestion run
+     * @type {string}
+     * @memberof PipelineState
+     */
+    temporalWorkflowId?: string | null;
+    /**
+     * Number of chunks processed (for progress tracking)
+     * @type {number}
+     * @memberof PipelineState
+     */
+    chunksProcessed?: number | null;
+    /**
+     * DPI used for PDF page screenshots during ingestion
+     * @type {number}
+     * @memberof PipelineState
+     */
+    pageDpi?: number | null;
+    /**
+     *
+     * @type {IngestionMode}
+     * @memberof PipelineState
+     */
+    ingestionMode?: IngestionMode;
+    /**
+     *
+     * @type {ChunkType}
+     * @memberof PipelineState
+     */
+    chunkType?: ChunkType;
+}
+export declare const PipelineStatePropertyValidationAttributesMap: {
+    [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 PipelineState interface.
+ */
+export declare function instanceOfPipelineState(value: object): value is PipelineState;
+export declare function PipelineStateFromJSON(json: any): PipelineState;
+export declare function PipelineStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PipelineState;
+export declare function PipelineStateToJSON(json: any): PipelineState;
+export declare function PipelineStateToJSONTyped(value?: PipelineState | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PipelineState.js

@@ -0,0 +1,65 @@
+/* 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 { PipelineStatusFromJSON, PipelineStatusToJSON, } from './PipelineStatus';
+import { IngestionModeFromJSON, IngestionModeToJSON, } from './IngestionMode';
+import { ChunkTypeFromJSON, ChunkTypeToJSON, } from './ChunkType';
+export const PipelineStatePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the PipelineState interface.
+ */
+export function instanceOfPipelineState(value) {
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function PipelineStateFromJSON(json) {
+    return PipelineStateFromJSONTyped(json, false);
+}
+export function PipelineStateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': PipelineStatusFromJSON(json['status']),
+        'lastRunTimestamp': json['last_run_timestamp'] == null ? undefined : (new Date(json['last_run_timestamp'])),
+        'lastStateUpdateTimestamp': json['last_state_update_timestamp'] == null ? undefined : (new Date(json['last_state_update_timestamp'])),
+        'lastActivity': json['last_activity'] == null ? undefined : json['last_activity'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'temporalWorkflowId': json['temporal_workflow_id'] == null ? undefined : json['temporal_workflow_id'],
+        'chunksProcessed': json['chunks_processed'] == null ? undefined : json['chunks_processed'],
+        'pageDpi': json['page_dpi'] == null ? undefined : json['page_dpi'],
+        'ingestionMode': json['ingestion_mode'] == null ? undefined : IngestionModeFromJSON(json['ingestion_mode']),
+        'chunkType': json['chunk_type'] == null ? undefined : ChunkTypeFromJSON(json['chunk_type']),
+    };
+}
+export function PipelineStateToJSON(json) {
+    return PipelineStateToJSONTyped(json, false);
+}
+export function PipelineStateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': PipelineStatusToJSON(value['status']),
+        'last_run_timestamp': value['lastRunTimestamp'] == null ? value['lastRunTimestamp'] : value['lastRunTimestamp'].toISOString(),
+        'last_state_update_timestamp': value['lastStateUpdateTimestamp'] == null ? value['lastStateUpdateTimestamp'] : value['lastStateUpdateTimestamp'].toISOString(),
+        'last_activity': value['lastActivity'],
+        'error': value['error'],
+        'temporal_workflow_id': value['temporalWorkflowId'],
+        'chunks_processed': value['chunksProcessed'],
+        'page_dpi': value['pageDpi'],
+        'ingestion_mode': IngestionModeToJSON(value['ingestionMode']),
+        'chunk_type': ChunkTypeToJSON(value['chunkType']),
+    };
+}

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

@@ -0,0 +1,28 @@
+/**
+ * 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.
+ */
+/**
+ * Status of the ingestion pipeline workflow.
+ * @export
+ */
+export declare const PipelineStatus: {
+    readonly Pending: "pending";
+    readonly Processing: "processing";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+    readonly Cancelled: "cancelled";
+};
+export type PipelineStatus = typeof PipelineStatus[keyof typeof PipelineStatus];
+export declare function instanceOfPipelineStatus(value: any): boolean;
+export declare function PipelineStatusFromJSON(json: any): PipelineStatus;
+export declare function PipelineStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): PipelineStatus;
+export declare function PipelineStatusToJSON(value?: PipelineStatus | null): any;
+export declare function PipelineStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): PipelineStatus;

package/dist/esm/models/PipelineStatus.js

@@ -0,0 +1,46 @@
+/* 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.
+ */
+/**
+ * Status of the ingestion pipeline workflow.
+ * @export
+ */
+export const PipelineStatus = {
+    Pending: 'pending',
+    Processing: 'processing',
+    Completed: 'completed',
+    Failed: 'failed',
+    Cancelled: 'cancelled'
+};
+export function instanceOfPipelineStatus(value) {
+    for (const key in PipelineStatus) {
+        if (Object.prototype.hasOwnProperty.call(PipelineStatus, key)) {
+            if (PipelineStatus[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function PipelineStatusFromJSON(json) {
+    return PipelineStatusFromJSONTyped(json, false);
+}
+export function PipelineStatusFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function PipelineStatusToJSON(value) {
+    return value;
+}
+export function PipelineStatusToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,65 @@
+/**
+ * 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.
+ */
+/**
+ * Bounding box polygon.
+ * @export
+ * @interface Polygon
+ */
+export interface Polygon {
+    /**
+     * The x-coordinate of the top-left corner of the bounding box.
+     * @type {number}
+     * @memberof Polygon
+     */
+    x: number;
+    /**
+     * The y-coordinate of the top-left corner of the bounding box.
+     * @type {number}
+     * @memberof Polygon
+     */
+    y: number;
+    /**
+     * The width of the bounding box.
+     * @type {number}
+     * @memberof Polygon
+     */
+    width: number;
+    /**
+     * The height of the bounding box.
+     * @type {number}
+     * @memberof Polygon
+     */
+    height: number;
+}
+export declare const PolygonPropertyValidationAttributesMap: {
+    [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 Polygon interface.
+ */
+export declare function instanceOfPolygon(value: object): value is Polygon;
+export declare function PolygonFromJSON(json: any): Polygon;
+export declare function PolygonFromJSONTyped(json: any, ignoreDiscriminator: boolean): Polygon;
+export declare function PolygonToJSON(json: any): Polygon;
+export declare function PolygonToJSONTyped(value?: Polygon | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/Polygon.js

@@ -0,0 +1,56 @@
+/* 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 PolygonPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the Polygon interface.
+ */
+export function instanceOfPolygon(value) {
+    if (!('x' in value) || value['x'] === undefined)
+        return false;
+    if (!('y' in value) || value['y'] === undefined)
+        return false;
+    if (!('width' in value) || value['width'] === undefined)
+        return false;
+    if (!('height' in value) || value['height'] === undefined)
+        return false;
+    return true;
+}
+export function PolygonFromJSON(json) {
+    return PolygonFromJSONTyped(json, false);
+}
+export function PolygonFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'x': json['x'],
+        'y': json['y'],
+        'width': json['width'],
+        'height': json['height'],
+    };
+}
+export function PolygonToJSON(json) {
+    return PolygonToJSONTyped(json, false);
+}
+export function PolygonToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'x': value['x'],
+        'y': value['y'],
+        'width': value['width'],
+        'height': value['height'],
+    };
+}

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

@@ -0,0 +1,54 @@
+/**
+ * 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 { Polygon } from './Polygon';
+/**
+ * Reference to a polygon on a specific page.
+ * @export
+ * @interface PolygonReference
+ */
+export interface PolygonReference {
+    /**
+     * The page number of the source document where the polygon is located.
+     * @type {number}
+     * @memberof PolygonReference
+     */
+    page: number;
+    /**
+     *
+     * @type {Polygon}
+     * @memberof PolygonReference
+     */
+    polygon: Polygon;
+}
+export declare const PolygonReferencePropertyValidationAttributesMap: {
+    [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 PolygonReference interface.
+ */
+export declare function instanceOfPolygonReference(value: object): value is PolygonReference;
+export declare function PolygonReferenceFromJSON(json: any): PolygonReference;
+export declare function PolygonReferenceFromJSONTyped(json: any, ignoreDiscriminator: boolean): PolygonReference;
+export declare function PolygonReferenceToJSON(json: any): PolygonReference;
+export declare function PolygonReferenceToJSONTyped(value?: PolygonReference | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PolygonReference.js

@@ -0,0 +1,49 @@
+/* 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 { PolygonFromJSON, PolygonToJSON, } from './Polygon';
+export const PolygonReferencePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the PolygonReference interface.
+ */
+export function instanceOfPolygonReference(value) {
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('polygon' in value) || value['polygon'] === undefined)
+        return false;
+    return true;
+}
+export function PolygonReferenceFromJSON(json) {
+    return PolygonReferenceFromJSONTyped(json, false);
+}
+export function PolygonReferenceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'polygon': PolygonFromJSON(json['polygon']),
+    };
+}
+export function PolygonReferenceToJSON(json) {
+    return PolygonReferenceToJSONTyped(json, false);
+}
+export function PolygonReferenceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'polygon': PolygonToJSON(value['polygon']),
+    };
+}