@knowledge-stack/ksapi 1.142.2 → 1.144.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.142.2",
+  "version": "1.144.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/PathPartsApi.ts

@@ -28,6 +28,7 @@ import type {
   PathPartResponse,
   PathPartTagsResponse,
   PermissionCapability,
+  ReorderPathPartRequest,
   SortDirection,
   SubtreeChunksResponse,
   TransferOwnerRequest,
@@ -60,6 +61,8 @@ import {
     PathPartTagsResponseToJSON,
     PermissionCapabilityFromJSON,
     PermissionCapabilityToJSON,
+    ReorderPathPartRequestFromJSON,
+    ReorderPathPartRequestToJSON,
     SortDirectionFromJSON,
     SortDirectionToJSON,
     SubtreeChunksResponseFromJSON,
@@ -126,6 +129,11 @@ export interface ListPathPartsRequest {
     updatedBefore?: Date | null;
 }
 
+export interface ReorderPathPartOperationRequest {
+    pathPartId: string;
+    reorderPathPartRequest: ReorderPathPartRequest;
+}
+
 export interface SetPathPartTagsRequest {
     pathPartId: string;
     bulkTagRequest: BulkTagRequest;
@@ -399,6 +407,32 @@ export interface PathPartsApiInterface {
      */
     listPathParts(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponsePathPartResponse>;
 
+    /**
+     * Creates request options for reorderPathPart without sending the request
+     * @param {string} pathPartId 
+     * @param {ReorderPathPartRequest} reorderPathPartRequest 
+     * @throws {RequiredError}
+     * @memberof PathPartsApiInterface
+     */
+    reorderPathPartRequestOpts(requestParameters: ReorderPathPartOperationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Reorder a path part within its sibling list.  The left-nav order follows the path_part sibling linked list: one per-parent chain shared by everyone in the tenant. Moving is confined to the node\'s current parent; use the folder/document move endpoints to change parents.
+     * @summary Reorder Path Part Handler
+     * @param {string} pathPartId 
+     * @param {ReorderPathPartRequest} reorderPathPartRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PathPartsApiInterface
+     */
+    reorderPathPartRaw(requestParameters: ReorderPathPartOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartResponse>>;
+
+    /**
+     * Reorder a path part within its sibling list.  The left-nav order follows the path_part sibling linked list: one per-parent chain shared by everyone in the tenant. Moving is confined to the node\'s current parent; use the folder/document move endpoints to change parents.
+     * Reorder Path Part Handler
+     */
+    reorderPathPart(requestParameters: ReorderPathPartOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartResponse>;
+
     /**
      * Creates request options for setPathPartTags without sending the request
      * @param {string} pathPartId 
@@ -1048,6 +1082,71 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
         return await response.value();
     }
 
+    /**
+     * Creates request options for reorderPathPart without sending the request
+     */
+    async reorderPathPartRequestOpts(requestParameters: ReorderPathPartOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['pathPartId'] == null) {
+            throw new runtime.RequiredError(
+                'pathPartId',
+                'Required parameter "pathPartId" was null or undefined when calling reorderPathPart().'
+            );
+        }
+
+        if (requestParameters['reorderPathPartRequest'] == null) {
+            throw new runtime.RequiredError(
+                'reorderPathPartRequest',
+                'Required parameter "reorderPathPartRequest" was null or undefined when calling reorderPathPart().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/path-parts/{path_part_id}/reorder`;
+        urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ReorderPathPartRequestToJSON(requestParameters['reorderPathPartRequest']),
+        };
+    }
+
+    /**
+     * Reorder a path part within its sibling list.  The left-nav order follows the path_part sibling linked list: one per-parent chain shared by everyone in the tenant. Moving is confined to the node\'s current parent; use the folder/document move endpoints to change parents.
+     * Reorder Path Part Handler
+     */
+    async reorderPathPartRaw(requestParameters: ReorderPathPartOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartResponse>> {
+        const requestOptions = await this.reorderPathPartRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PathPartResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Reorder a path part within its sibling list.  The left-nav order follows the path_part sibling linked list: one per-parent chain shared by everyone in the tenant. Moving is confined to the node\'s current parent; use the folder/document move endpoints to change parents.
+     * Reorder Path Part Handler
+     */
+    async reorderPathPart(requestParameters: ReorderPathPartOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartResponse> {
+        const response = await this.reorderPathPartRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for setPathPartTags without sending the request
      */

package/src/models/EventResponse.ts

@@ -20,13 +20,21 @@ import {
     UserInfoToJSON,
     UserInfoToJSONTyped,
 } from './UserInfo';
+import type { ResolvedRef } from './ResolvedRef';
+import {
+    ResolvedRefFromJSON,
+    ResolvedRefFromJSONTyped,
+    ResolvedRefToJSON,
+    ResolvedRefToJSONTyped,
+} from './ResolvedRef';
 
 /**
  * One event row, anchored to a path_part subject.
  * 
  * ``kind`` is namespaced ``domain.action`` (e.g. ``workflow.approval``,
  * ``document.created``). ``payload`` is the domain-specific structured
- * JSON associated with the event.
+ * JSON associated with the event, stored verbatim and never rewritten —
+ * the human-readable resolution lives alongside it in ``references``.
  * @export
  * @interface EventResponse
  */
@@ -73,6 +81,36 @@ export interface EventResponse {
      * @memberof EventResponse
      */
     actor?: UserInfo | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EventResponse
+     */
+    subjectName?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EventResponse
+     */
+    subjectPath?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EventResponse
+     */
+    subjectObjectId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EventResponse
+     */
+    subjectPartType?: string | null;
+    /**
+     * 
+     * @type {{ [key: string]: ResolvedRef; }}
+     * @memberof EventResponse
+     */
+    references?: { [key: string]: ResolvedRef; };
 }
 export const EventResponsePropertyValidationAttributesMap: {
     [property: string]: {
@@ -122,6 +160,11 @@ export function EventResponseFromJSONTyped(json: any, ignoreDiscriminator: boole
         'actorUserId': json['actor_user_id'],
         'payload': json['payload'],
         'actor': json['actor'] == null ? undefined : UserInfoFromJSON(json['actor']),
+        'subjectName': json['subject_name'] == null ? undefined : json['subject_name'],
+        'subjectPath': json['subject_path'] == null ? undefined : json['subject_path'],
+        'subjectObjectId': json['subject_object_id'] == null ? undefined : json['subject_object_id'],
+        'subjectPartType': json['subject_part_type'] == null ? undefined : json['subject_part_type'],
+        'references': json['references'] == null ? undefined : (mapValues(json['references'], ResolvedRefFromJSON)),
     };
 }
 
@@ -143,6 +186,11 @@ export function EventResponseToJSONTyped(value?: EventResponse | null, ignoreDis
         'actor_user_id': value['actorUserId'],
         'payload': value['payload'],
         'actor': UserInfoToJSON(value['actor']),
+        'subject_name': value['subjectName'],
+        'subject_path': value['subjectPath'],
+        'subject_object_id': value['subjectObjectId'],
+        'subject_part_type': value['subjectPartType'],
+        'references': value['references'] == null ? undefined : (mapValues(value['references'], ResolvedRefToJSON)),
     };
 }
 

package/src/models/ReorderPathPartRequest.ts

@@ -0,0 +1,90 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call. 
+ *
+ * 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 { mapValues } from '../runtime';
+/**
+ * Reorder a path part within its sibling list.
+ * @export
+ * @interface ReorderPathPartRequest
+ */
+export interface ReorderPathPartRequest {
+    /**
+     * Place this node immediately after the given sibling PathPart id (must share the same parent). Pass the current tail's id to move to the end. Requires move_to_head=false.
+     * @type {string}
+     * @memberof ReorderPathPartRequest
+     */
+    prevSiblingPathId?: string | null;
+    /**
+     * Move this node to the head of its sibling list.
+     * @type {boolean}
+     * @memberof ReorderPathPartRequest
+     */
+    moveToHead?: boolean;
+}
+export const ReorderPathPartRequestPropertyValidationAttributesMap: {
+    [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 ReorderPathPartRequest interface.
+ */
+export function instanceOfReorderPathPartRequest(value: object): value is ReorderPathPartRequest {
+    return true;
+}
+
+export function ReorderPathPartRequestFromJSON(json: any): ReorderPathPartRequest {
+    return ReorderPathPartRequestFromJSONTyped(json, false);
+}
+
+export function ReorderPathPartRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReorderPathPartRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'prevSiblingPathId': json['prev_sibling_path_id'] == null ? undefined : json['prev_sibling_path_id'],
+        'moveToHead': json['move_to_head'] == null ? undefined : json['move_to_head'],
+    };
+}
+
+export function ReorderPathPartRequestToJSON(json: any): ReorderPathPartRequest {
+    return ReorderPathPartRequestToJSONTyped(json, false);
+}
+
+export function ReorderPathPartRequestToJSONTyped(value?: ReorderPathPartRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'prev_sibling_path_id': value['prevSiblingPathId'],
+        'move_to_head': value['moveToHead'],
+    };
+}
+

package/src/models/ResolvedRef.ts

@@ -0,0 +1,125 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call. 
+ *
+ * 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 { mapValues } from '../runtime';
+/**
+ * One id resolved to a human-readable, linkable entity.
+ * 
+ * Every UUID that appears in an event (its subject, its actor, and any id
+ * inside the payload) resolves to one of these so the frontend can render a
+ * name and a link instead of a bare UUID. ``object_id`` is what the frontend
+ * routes on: a PDO id for a path_part (never the internal path_part_id), or
+ * the user id for a user.
+ * @export
+ * @interface ResolvedRef
+ */
+export interface ResolvedRef {
+    /**
+     * 
+     * @type {ResolvedRefEntityTypeEnum}
+     * @memberof ResolvedRef
+     */
+    entityType: ResolvedRefEntityTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ResolvedRef
+     */
+    objectId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ResolvedRef
+     */
+    displayName?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ResolvedRef
+     */
+    partType?: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const ResolvedRefEntityTypeEnum = {
+    PathPart: 'path_part',
+    User: 'user'
+} as const;
+export type ResolvedRefEntityTypeEnum = typeof ResolvedRefEntityTypeEnum[keyof typeof ResolvedRefEntityTypeEnum];
+
+export const ResolvedRefPropertyValidationAttributesMap: {
+    [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 ResolvedRef interface.
+ */
+export function instanceOfResolvedRef(value: object): value is ResolvedRef {
+    if (!('entityType' in value) || value['entityType'] === undefined) return false;
+    if (!('objectId' in value) || value['objectId'] === undefined) return false;
+    return true;
+}
+
+export function ResolvedRefFromJSON(json: any): ResolvedRef {
+    return ResolvedRefFromJSONTyped(json, false);
+}
+
+export function ResolvedRefFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResolvedRef {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'entityType': json['entity_type'],
+        'objectId': json['object_id'],
+        'displayName': json['display_name'] == null ? undefined : json['display_name'],
+        'partType': json['part_type'] == null ? undefined : json['part_type'],
+    };
+}
+
+export function ResolvedRefToJSON(json: any): ResolvedRef {
+    return ResolvedRefToJSONTyped(json, false);
+}
+
+export function ResolvedRefToJSONTyped(value?: ResolvedRef | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'entity_type': value['entityType'],
+        'object_id': value['objectId'],
+        'display_name': value['displayName'],
+        'part_type': value['partType'],
+    };
+}
+

package/src/models/index.ts

@@ -227,7 +227,9 @@ export * from './ProposeMemoryChunkRequest';
 export * from './ProposedMemoryChunkResponse';
 export * from './ReasoningPart';
 export * from './ReferenceType';
+export * from './ReorderPathPartRequest';
 export * from './RequestPhoneChangeRequest';
+export * from './ResolvedRef';
 export * from './ResolvedReferenceInput';
 export * from './ResolvedReferenceOutput';
 export * from './ResponseSendPwResetEmail';