@knowledge-stack/ksapi 1.95.4 → 1.96.0

package/src/models/DiffFormat.ts

@@ -0,0 +1,53 @@
+/* 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
+ */
+export const DiffFormat = {
+    Text: 'text',
+    Cells: 'cells'
+} as const;
+export type DiffFormat = typeof DiffFormat[keyof typeof DiffFormat];
+
+
+export function instanceOfDiffFormat(value: any): boolean {
+    for (const key in DiffFormat) {
+        if (Object.prototype.hasOwnProperty.call(DiffFormat, key)) {
+            if (DiffFormat[key as keyof typeof DiffFormat] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function DiffFormatFromJSON(json: any): DiffFormat {
+    return DiffFormatFromJSONTyped(json, false);
+}
+
+export function DiffFormatFromJSONTyped(json: any, ignoreDiscriminator: boolean): DiffFormat {
+    return json as DiffFormat;
+}
+
+export function DiffFormatToJSON(value?: DiffFormat | null): any {
+    return value as any;
+}
+
+export function DiffFormatToJSONTyped(value: any, ignoreDiscriminator: boolean): DiffFormat {
+    return value as DiffFormat;
+}
+

package/src/models/DiffRow.ts

@@ -0,0 +1,153 @@
+/* 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 { mapValues } from '../runtime';
+import type { DiffRowType } from './DiffRowType';
+import {
+    DiffRowTypeFromJSON,
+    DiffRowTypeFromJSONTyped,
+    DiffRowTypeToJSON,
+    DiffRowTypeToJSONTyped,
+} from './DiffRowType';
+import type { DiffSpan } from './DiffSpan';
+import {
+    DiffSpanFromJSON,
+    DiffSpanFromJSONTyped,
+    DiffSpanToJSON,
+    DiffSpanToJSONTyped,
+} from './DiffSpan';
+
+/**
+ * One aligned side-by-side row.
+ * 
+ * ``left`` is the old version, ``right`` is the new. For ``equal`` both are
+ * present; ``delete`` has left only; ``insert`` has right only; ``replace``
+ * has both plus ``left_spans`` / ``right_spans`` marking the changed words.
+ * Line numbers are 1-based and null on the absent side.
+ * @export
+ * @interface DiffRow
+ */
+export interface DiffRow {
+    /**
+     * 
+     * @type {DiffRowType}
+     * @memberof DiffRow
+     */
+    type: DiffRowType;
+    /**
+     * 
+     * @type {number}
+     * @memberof DiffRow
+     */
+    leftNo?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DiffRow
+     */
+    left?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DiffRow
+     */
+    rightNo?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DiffRow
+     */
+    right?: string | null;
+    /**
+     * 
+     * @type {Array<DiffSpan>}
+     * @memberof DiffRow
+     */
+    leftSpans?: Array<DiffSpan> | null;
+    /**
+     * 
+     * @type {Array<DiffSpan>}
+     * @memberof DiffRow
+     */
+    rightSpans?: Array<DiffSpan> | null;
+}
+
+
+export const DiffRowPropertyValidationAttributesMap: {
+    [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 DiffRow interface.
+ */
+export function instanceOfDiffRow(value: object): value is DiffRow {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function DiffRowFromJSON(json: any): DiffRow {
+    return DiffRowFromJSONTyped(json, false);
+}
+
+export function DiffRowFromJSONTyped(json: any, ignoreDiscriminator: boolean): DiffRow {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': DiffRowTypeFromJSON(json['type']),
+        'leftNo': json['left_no'] == null ? undefined : json['left_no'],
+        'left': json['left'] == null ? undefined : json['left'],
+        'rightNo': json['right_no'] == null ? undefined : json['right_no'],
+        'right': json['right'] == null ? undefined : json['right'],
+        'leftSpans': json['left_spans'] == null ? undefined : ((json['left_spans'] as Array<any>).map(DiffSpanFromJSON)),
+        'rightSpans': json['right_spans'] == null ? undefined : ((json['right_spans'] as Array<any>).map(DiffSpanFromJSON)),
+    };
+}
+
+export function DiffRowToJSON(json: any): DiffRow {
+    return DiffRowToJSONTyped(json, false);
+}
+
+export function DiffRowToJSONTyped(value?: DiffRow | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': DiffRowTypeToJSON(value['type']),
+        'left_no': value['leftNo'],
+        'left': value['left'],
+        'right_no': value['rightNo'],
+        'right': value['right'],
+        'left_spans': value['leftSpans'] == null ? undefined : ((value['leftSpans'] as Array<any>).map(DiffSpanToJSON)),
+        'right_spans': value['rightSpans'] == null ? undefined : ((value['rightSpans'] as Array<any>).map(DiffSpanToJSON)),
+    };
+}
+

package/src/models/DiffRowType.ts

@@ -0,0 +1,55 @@
+/* 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
+ */
+export const DiffRowType = {
+    Equal: 'equal',
+    Insert: 'insert',
+    Delete: 'delete',
+    Replace: 'replace'
+} as const;
+export type DiffRowType = typeof DiffRowType[keyof typeof DiffRowType];
+
+
+export function instanceOfDiffRowType(value: any): boolean {
+    for (const key in DiffRowType) {
+        if (Object.prototype.hasOwnProperty.call(DiffRowType, key)) {
+            if (DiffRowType[key as keyof typeof DiffRowType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function DiffRowTypeFromJSON(json: any): DiffRowType {
+    return DiffRowTypeFromJSONTyped(json, false);
+}
+
+export function DiffRowTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): DiffRowType {
+    return json as DiffRowType;
+}
+
+export function DiffRowTypeToJSON(value?: DiffRowType | null): any {
+    return value as any;
+}
+
+export function DiffRowTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): DiffRowType {
+    return value as DiffRowType;
+}
+

package/src/models/DiffSpan.ts

@@ -0,0 +1,92 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * A changed character range within a row's text (for highlighting).
+ * @export
+ * @interface DiffSpan
+ */
+export interface DiffSpan {
+    /**
+     * 
+     * @type {number}
+     * @memberof DiffSpan
+     */
+    start: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof DiffSpan
+     */
+    end: number;
+}
+export const DiffSpanPropertyValidationAttributesMap: {
+    [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 DiffSpan interface.
+ */
+export function instanceOfDiffSpan(value: object): value is DiffSpan {
+    if (!('start' in value) || value['start'] === undefined) return false;
+    if (!('end' in value) || value['end'] === undefined) return false;
+    return true;
+}
+
+export function DiffSpanFromJSON(json: any): DiffSpan {
+    return DiffSpanFromJSONTyped(json, false);
+}
+
+export function DiffSpanFromJSONTyped(json: any, ignoreDiscriminator: boolean): DiffSpan {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'start': json['start'],
+        'end': json['end'],
+    };
+}
+
+export function DiffSpanToJSON(json: any): DiffSpan {
+    return DiffSpanToJSONTyped(json, false);
+}
+
+export function DiffSpanToJSONTyped(value?: DiffSpan | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'start': value['start'],
+        'end': value['end'],
+    };
+}
+

package/src/models/DocumentDownloadResponse.ts

@@ -0,0 +1,129 @@
+/* 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 { mapValues } from '../runtime';
+import type { DownloadArtifact } from './DownloadArtifact';
+import {
+    DownloadArtifactFromJSON,
+    DownloadArtifactFromJSONTyped,
+    DownloadArtifactToJSON,
+    DownloadArtifactToJSONTyped,
+} from './DownloadArtifact';
+
+/**
+ * A short-lived, audited download link for a document-version artifact.
+ * @export
+ * @interface DocumentDownloadResponse
+ */
+export interface DocumentDownloadResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentDownloadResponse
+     */
+    url: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof DocumentDownloadResponse
+     */
+    expiresIn: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentDownloadResponse
+     */
+    documentId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentDownloadResponse
+     */
+    versionId: string;
+    /**
+     * 
+     * @type {DownloadArtifact}
+     * @memberof DocumentDownloadResponse
+     */
+    artifact: DownloadArtifact;
+}
+
+
+export const DocumentDownloadResponsePropertyValidationAttributesMap: {
+    [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 DocumentDownloadResponse interface.
+ */
+export function instanceOfDocumentDownloadResponse(value: object): value is DocumentDownloadResponse {
+    if (!('url' in value) || value['url'] === undefined) return false;
+    if (!('expiresIn' in value) || value['expiresIn'] === undefined) return false;
+    if (!('documentId' in value) || value['documentId'] === undefined) return false;
+    if (!('versionId' in value) || value['versionId'] === undefined) return false;
+    if (!('artifact' in value) || value['artifact'] === undefined) return false;
+    return true;
+}
+
+export function DocumentDownloadResponseFromJSON(json: any): DocumentDownloadResponse {
+    return DocumentDownloadResponseFromJSONTyped(json, false);
+}
+
+export function DocumentDownloadResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentDownloadResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'url': json['url'],
+        'expiresIn': json['expires_in'],
+        'documentId': json['document_id'],
+        'versionId': json['version_id'],
+        'artifact': DownloadArtifactFromJSON(json['artifact']),
+    };
+}
+
+export function DocumentDownloadResponseToJSON(json: any): DocumentDownloadResponse {
+    return DocumentDownloadResponseToJSONTyped(json, false);
+}
+
+export function DocumentDownloadResponseToJSONTyped(value?: DocumentDownloadResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'url': value['url'],
+        'expires_in': value['expiresIn'],
+        'document_id': value['documentId'],
+        'version_id': value['versionId'],
+        'artifact': DownloadArtifactToJSON(value['artifact']),
+    };
+}
+

package/src/models/DocumentResponse.ts

@@ -20,6 +20,13 @@ import {
     DocumentOriginToJSON,
     DocumentOriginToJSONTyped,
 } from './DocumentOrigin';
+import type { ItemPermissions } from './ItemPermissions';
+import {
+    ItemPermissionsFromJSON,
+    ItemPermissionsFromJSONTyped,
+    ItemPermissionsToJSON,
+    ItemPermissionsToJSONTyped,
+} from './ItemPermissions';
 import type { TagResponse } from './TagResponse';
 import {
     TagResponseFromJSON,
@@ -178,11 +185,11 @@ export interface DocumentResponse {
      */
     tags?: Array<TagResponse> | null;
     /**
-     * Whether the current caller has write access to this document. Only populated by endpoints that compute it (e.g. folder contents).
-     * @type {boolean}
+     * Caller's effective rights; null on mutation responses.
+     * @type {ItemPermissions}
      * @memberof DocumentResponse
      */
-    canWrite?: boolean | null;
+    permissions?: ItemPermissions | null;
     /**
      * Active write-lock state. Null when no checkout is held. Populated on detail endpoints (GET /v1/documents/{id}). Any tenant member with read access may observe this state.
      * @type {DocumentCheckoutResponse}
@@ -270,7 +277,7 @@ export function DocumentResponseFromJSONTyped(json: any, ignoreDiscriminator: bo
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
         'tags': json['tags'] == null ? undefined : ((json['tags'] as Array<any>).map(TagResponseFromJSON)),
-        'canWrite': json['can_write'] == null ? undefined : json['can_write'],
+        'permissions': json['permissions'] == null ? undefined : ItemPermissionsFromJSON(json['permissions']),
         'checkout': json['checkout'] == null ? undefined : DocumentCheckoutResponseFromJSON(json['checkout']),
     };
 }
@@ -304,7 +311,7 @@ export function DocumentResponseToJSONTyped(value?: DocumentResponse | null, ign
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
         'tags': value['tags'] == null ? undefined : ((value['tags'] as Array<any>).map(TagResponseToJSON)),
-        'can_write': value['canWrite'],
+        'permissions': ItemPermissionsToJSON(value['permissions']),
         'checkout': DocumentCheckoutResponseToJSON(value['checkout']),
     };
 }

package/src/models/DownloadArtifact.ts

@@ -0,0 +1,53 @@
+/* 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
+ */
+export const DownloadArtifact = {
+    Source: 'source',
+    FastPlaintext: 'fast_plaintext'
+} as const;
+export type DownloadArtifact = typeof DownloadArtifact[keyof typeof DownloadArtifact];
+
+
+export function instanceOfDownloadArtifact(value: any): boolean {
+    for (const key in DownloadArtifact) {
+        if (Object.prototype.hasOwnProperty.call(DownloadArtifact, key)) {
+            if (DownloadArtifact[key as keyof typeof DownloadArtifact] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function DownloadArtifactFromJSON(json: any): DownloadArtifact {
+    return DownloadArtifactFromJSONTyped(json, false);
+}
+
+export function DownloadArtifactFromJSONTyped(json: any, ignoreDiscriminator: boolean): DownloadArtifact {
+    return json as DownloadArtifact;
+}
+
+export function DownloadArtifactToJSON(value?: DownloadArtifact | null): any {
+    return value as any;
+}
+
+export function DownloadArtifactToJSONTyped(value: any, ignoreDiscriminator: boolean): DownloadArtifact {
+    return value as DownloadArtifact;
+}
+

package/src/models/EventResponse.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { UserInfo } from './UserInfo';
+import {
+    UserInfoFromJSON,
+    UserInfoFromJSONTyped,
+    UserInfoToJSON,
+    UserInfoToJSONTyped,
+} from './UserInfo';
+
 /**
  * One event row, anchored to a path_part subject.
  * 
@@ -59,6 +67,12 @@ export interface EventResponse {
      * @memberof EventResponse
      */
     payload: { [key: string]: any; };
+    /**
+     * 
+     * @type {UserInfo}
+     * @memberof EventResponse
+     */
+    actor?: UserInfo | null;
 }
 export const EventResponsePropertyValidationAttributesMap: {
     [property: string]: {
@@ -107,6 +121,7 @@ export function EventResponseFromJSONTyped(json: any, ignoreDiscriminator: boole
         'ts': (new Date(json['ts'])),
         'actorUserId': json['actor_user_id'],
         'payload': json['payload'],
+        'actor': json['actor'] == null ? undefined : UserInfoFromJSON(json['actor']),
     };
 }
 
@@ -127,6 +142,7 @@ export function EventResponseToJSONTyped(value?: EventResponse | null, ignoreDis
         'ts': value['ts'].toISOString(),
         'actor_user_id': value['actorUserId'],
         'payload': value['payload'],
+        'actor': UserInfoToJSON(value['actor']),
     };
 }
 

package/src/models/FolderResponse.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ItemPermissions } from './ItemPermissions';
+import {
+    ItemPermissionsFromJSON,
+    ItemPermissionsFromJSONTyped,
+    ItemPermissionsToJSON,
+    ItemPermissionsToJSONTyped,
+} from './ItemPermissions';
 import type { TagResponse } from './TagResponse';
 import {
     TagResponseFromJSON,
@@ -113,11 +120,11 @@ export interface FolderResponse {
      */
     tags?: Array<TagResponse> | null;
     /**
-     * Whether the current caller has write access to this folder. Only populated by endpoints that compute it (e.g. folder contents).
-     * @type {boolean}
+     * Caller's effective rights; null on mutation responses.
+     * @type {ItemPermissions}
      * @memberof FolderResponse
      */
-    canWrite?: boolean | null;
+    permissions?: ItemPermissions | null;
 }
 
 
@@ -189,7 +196,7 @@ export function FolderResponseFromJSONTyped(json: any, ignoreDiscriminator: bool
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
         'tags': json['tags'] == null ? undefined : ((json['tags'] as Array<any>).map(TagResponseFromJSON)),
-        'canWrite': json['can_write'] == null ? undefined : json['can_write'],
+        'permissions': json['permissions'] == null ? undefined : ItemPermissionsFromJSON(json['permissions']),
     };
 }
 
@@ -217,7 +224,7 @@ export function FolderResponseToJSONTyped(value?: FolderResponse | null, ignoreD
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
         'tags': value['tags'] == null ? undefined : ((value['tags'] as Array<any>).map(TagResponseToJSON)),
-        'can_write': value['canWrite'],
+        'permissions': ItemPermissionsToJSON(value['permissions']),
     };
 }