@knowledge-stack/ksapi 1.118.0 → 1.119.0

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

@@ -0,0 +1,69 @@
+/**
+ * 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 { StructuredChangeType } from './StructuredChangeType';
+/**
+ * One changed key-path in a JSON/YAML document.
+ *
+ * ``path`` is a dotted/indexed locator like ``services.web.image`` or
+ * ``items[3].qty``. ``old`` is null for added, ``new`` is null for removed.
+ * @export
+ * @interface StructuredChange
+ */
+export interface StructuredChange {
+    /**
+     *
+     * @type {string}
+     * @memberof StructuredChange
+     */
+    path: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StructuredChange
+     */
+    old: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof StructuredChange
+     */
+    _new: string | null;
+    /**
+     *
+     * @type {StructuredChangeType}
+     * @memberof StructuredChange
+     */
+    type: StructuredChangeType;
+}
+export declare const StructuredChangePropertyValidationAttributesMap: {
+    [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 StructuredChange interface.
+ */
+export declare function instanceOfStructuredChange(value: object): value is StructuredChange;
+export declare function StructuredChangeFromJSON(json: any): StructuredChange;
+export declare function StructuredChangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): StructuredChange;
+export declare function StructuredChangeToJSON(json: any): StructuredChange;
+export declare function StructuredChangeToJSONTyped(value?: StructuredChange | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/StructuredChange.js

@@ -0,0 +1,57 @@
+/* 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 { StructuredChangeTypeFromJSON, StructuredChangeTypeToJSON, } from './StructuredChangeType';
+export const StructuredChangePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the StructuredChange interface.
+ */
+export function instanceOfStructuredChange(value) {
+    if (!('path' in value) || value['path'] === undefined)
+        return false;
+    if (!('old' in value) || value['old'] === undefined)
+        return false;
+    if (!('_new' in value) || value['_new'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    return true;
+}
+export function StructuredChangeFromJSON(json) {
+    return StructuredChangeFromJSONTyped(json, false);
+}
+export function StructuredChangeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'path': json['path'],
+        'old': json['old'],
+        '_new': json['new'],
+        'type': StructuredChangeTypeFromJSON(json['type']),
+    };
+}
+export function StructuredChangeToJSON(json) {
+    return StructuredChangeToJSONTyped(json, false);
+}
+export function StructuredChangeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'path': value['path'],
+        'old': value['old'],
+        'new': value['_new'],
+        'type': StructuredChangeTypeToJSON(value['type']),
+    };
+}

package/dist/esm/models/StructuredChangeType.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.
+ */
+/**
+ *
+ * @export
+ */
+export declare const StructuredChangeType: {
+    readonly Added: "added";
+    readonly Removed: "removed";
+    readonly Modified: "modified";
+};
+export type StructuredChangeType = typeof StructuredChangeType[keyof typeof StructuredChangeType];
+export declare function instanceOfStructuredChangeType(value: any): boolean;
+export declare function StructuredChangeTypeFromJSON(json: any): StructuredChangeType;
+export declare function StructuredChangeTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): StructuredChangeType;
+export declare function StructuredChangeTypeToJSON(value?: StructuredChangeType | null): any;
+export declare function StructuredChangeTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): StructuredChangeType;

package/dist/esm/models/StructuredChangeType.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.
+ */
+/**
+ *
+ * @export
+ */
+export const StructuredChangeType = {
+    Added: 'added',
+    Removed: 'removed',
+    Modified: 'modified'
+};
+export function instanceOfStructuredChangeType(value) {
+    for (const key in StructuredChangeType) {
+        if (Object.prototype.hasOwnProperty.call(StructuredChangeType, key)) {
+            if (StructuredChangeType[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function StructuredChangeTypeFromJSON(json) {
+    return StructuredChangeTypeFromJSONTyped(json, false);
+}
+export function StructuredChangeTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function StructuredChangeTypeToJSON(value) {
+    return value;
+}
+export function StructuredChangeTypeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,82 @@
+/**
+ * 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 { StructuredChange } from './StructuredChange';
+/**
+ * A key-path diff of two JSON/YAML versions.
+ *
+ * ``added``/``removed``/``modified`` are full totals; ``changes`` is capped at
+ * the engine limit and ``omitted`` reports exactly how many were dropped, so a
+ * truncated diff never silently hides a change.
+ * @export
+ * @interface StructuredDiff
+ */
+export interface StructuredDiff {
+    /**
+     *
+     * @type {Array<StructuredChange>}
+     * @memberof StructuredDiff
+     */
+    changes: Array<StructuredChange>;
+    /**
+     *
+     * @type {number}
+     * @memberof StructuredDiff
+     */
+    added: number;
+    /**
+     *
+     * @type {number}
+     * @memberof StructuredDiff
+     */
+    removed: number;
+    /**
+     *
+     * @type {number}
+     * @memberof StructuredDiff
+     */
+    modified: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof StructuredDiff
+     */
+    truncated: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof StructuredDiff
+     */
+    omitted: number;
+}
+export declare const StructuredDiffPropertyValidationAttributesMap: {
+    [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 StructuredDiff interface.
+ */
+export declare function instanceOfStructuredDiff(value: object): value is StructuredDiff;
+export declare function StructuredDiffFromJSON(json: any): StructuredDiff;
+export declare function StructuredDiffFromJSONTyped(json: any, ignoreDiscriminator: boolean): StructuredDiff;
+export declare function StructuredDiffToJSON(json: any): StructuredDiff;
+export declare function StructuredDiffToJSONTyped(value?: StructuredDiff | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/StructuredDiff.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 { StructuredChangeFromJSON, StructuredChangeToJSON, } from './StructuredChange';
+export const StructuredDiffPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the StructuredDiff interface.
+ */
+export function instanceOfStructuredDiff(value) {
+    if (!('changes' in value) || value['changes'] === undefined)
+        return false;
+    if (!('added' in value) || value['added'] === undefined)
+        return false;
+    if (!('removed' in value) || value['removed'] === undefined)
+        return false;
+    if (!('modified' in value) || value['modified'] === undefined)
+        return false;
+    if (!('truncated' in value) || value['truncated'] === undefined)
+        return false;
+    if (!('omitted' in value) || value['omitted'] === undefined)
+        return false;
+    return true;
+}
+export function StructuredDiffFromJSON(json) {
+    return StructuredDiffFromJSONTyped(json, false);
+}
+export function StructuredDiffFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'changes': (json['changes'].map(StructuredChangeFromJSON)),
+        'added': json['added'],
+        'removed': json['removed'],
+        'modified': json['modified'],
+        'truncated': json['truncated'],
+        'omitted': json['omitted'],
+    };
+}
+export function StructuredDiffToJSON(json) {
+    return StructuredDiffToJSONTyped(json, false);
+}
+export function StructuredDiffToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'changes': (value['changes'].map(StructuredChangeToJSON)),
+        'added': value['added'],
+        'removed': value['removed'],
+        'modified': value['modified'],
+        'truncated': value['truncated'],
+        'omitted': value['omitted'],
+    };
+}

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

@@ -0,0 +1,72 @@
+/**
+ * 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 { BlockChangeType } from './BlockChangeType';
+/**
+ * One changed table cell (``old`` null for added, ``new`` for removed).
+ * @export
+ * @interface TableCellChange
+ */
+export interface TableCellChange {
+    /**
+     *
+     * @type {number}
+     * @memberof TableCellChange
+     */
+    row: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TableCellChange
+     */
+    col: number;
+    /**
+     *
+     * @type {BlockChangeType}
+     * @memberof TableCellChange
+     */
+    type: BlockChangeType;
+    /**
+     *
+     * @type {string}
+     * @memberof TableCellChange
+     */
+    old: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof TableCellChange
+     */
+    _new: string | null;
+}
+export declare const TableCellChangePropertyValidationAttributesMap: {
+    [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 TableCellChange interface.
+ */
+export declare function instanceOfTableCellChange(value: object): value is TableCellChange;
+export declare function TableCellChangeFromJSON(json: any): TableCellChange;
+export declare function TableCellChangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): TableCellChange;
+export declare function TableCellChangeToJSON(json: any): TableCellChange;
+export declare function TableCellChangeToJSONTyped(value?: TableCellChange | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/TableCellChange.js

@@ -0,0 +1,61 @@
+/* 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 { BlockChangeTypeFromJSON, BlockChangeTypeToJSON, } from './BlockChangeType';
+export const TableCellChangePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the TableCellChange interface.
+ */
+export function instanceOfTableCellChange(value) {
+    if (!('row' in value) || value['row'] === undefined)
+        return false;
+    if (!('col' in value) || value['col'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('old' in value) || value['old'] === undefined)
+        return false;
+    if (!('_new' in value) || value['_new'] === undefined)
+        return false;
+    return true;
+}
+export function TableCellChangeFromJSON(json) {
+    return TableCellChangeFromJSONTyped(json, false);
+}
+export function TableCellChangeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'row': json['row'],
+        'col': json['col'],
+        'type': BlockChangeTypeFromJSON(json['type']),
+        'old': json['old'],
+        '_new': json['new'],
+    };
+}
+export function TableCellChangeToJSON(json) {
+    return TableCellChangeToJSONTyped(json, false);
+}
+export function TableCellChangeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'row': value['row'],
+        'col': value['col'],
+        'type': BlockChangeTypeToJSON(value['type']),
+        'old': value['old'],
+        'new': value['_new'],
+    };
+}

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

@@ -10,13 +10,18 @@
  * Do not edit the class manually.
  */
 import type { TextDiff } from './TextDiff';
+import type { DocumentDiff } from './DocumentDiff';
 import type { CellDiff } from './CellDiff';
 import type { DiffFormat } from './DiffFormat';
+import type { StructuredDiff } from './StructuredDiff';
+import type { UserInfo } from './UserInfo';
 /**
  * The diff between two document versions.
  *
  * ``format`` selects the populated payload: ``text`` (side-by-side line diff,
- * for Word/PDF/text) or ``cells`` (cell-level diff, for spreadsheets).
+ * for PDF/Markdown/text), ``cells`` (cell-level diff, for spreadsheets),
+ * ``structured`` (key-path diff, for JSON/YAML), or ``document`` (structured
+ * block diff, for Word .docx).
  * @export
  * @interface VersionDiffResponse
  */
@@ -63,6 +68,72 @@ export interface VersionDiffResponse {
      * @memberof VersionDiffResponse
      */
     cells?: CellDiff | null;
+    /**
+     *
+     * @type {StructuredDiff}
+     * @memberof VersionDiffResponse
+     */
+    structured?: StructuredDiff | null;
+    /**
+     *
+     * @type {DocumentDiff}
+     * @memberof VersionDiffResponse
+     */
+    document?: DocumentDiff | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof VersionDiffResponse
+     */
+    degraded?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof VersionDiffResponse
+     */
+    degradedReason?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof VersionDiffResponse
+     */
+    algorithmVersion?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VersionDiffResponse
+     */
+    fromContentHash?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof VersionDiffResponse
+     */
+    toContentHash?: string | null;
+    /**
+     *
+     * @type {UserInfo}
+     * @memberof VersionDiffResponse
+     */
+    fromUploader?: UserInfo | null;
+    /**
+     *
+     * @type {UserInfo}
+     * @memberof VersionDiffResponse
+     */
+    toUploader?: UserInfo | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof VersionDiffResponse
+     */
+    fromUploadedAt?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof VersionDiffResponse
+     */
+    toUploadedAt?: Date | null;
 }
 export declare const VersionDiffResponsePropertyValidationAttributesMap: {
     [property: string]: {

package/dist/esm/models/VersionDiffResponse.js

@@ -12,8 +12,11 @@
  * Do not edit the class manually.
  */
 import { TextDiffFromJSON, TextDiffToJSON, } from './TextDiff';
+import { DocumentDiffFromJSON, DocumentDiffToJSON, } from './DocumentDiff';
 import { CellDiffFromJSON, CellDiffToJSON, } from './CellDiff';
 import { DiffFormatFromJSON, DiffFormatToJSON, } from './DiffFormat';
+import { StructuredDiffFromJSON, StructuredDiffToJSON, } from './StructuredDiff';
+import { UserInfoFromJSON, UserInfoToJSON, } from './UserInfo';
 export const VersionDiffResponsePropertyValidationAttributesMap = {};
 /**
  * Check if a given object implements the VersionDiffResponse interface.
@@ -42,6 +45,17 @@ export function VersionDiffResponseFromJSONTyped(json, ignoreDiscriminator) {
         'format': DiffFormatFromJSON(json['format']),
         'text': json['text'] == null ? undefined : TextDiffFromJSON(json['text']),
         'cells': json['cells'] == null ? undefined : CellDiffFromJSON(json['cells']),
+        'structured': json['structured'] == null ? undefined : StructuredDiffFromJSON(json['structured']),
+        'document': json['document'] == null ? undefined : DocumentDiffFromJSON(json['document']),
+        'degraded': json['degraded'] == null ? undefined : json['degraded'],
+        'degradedReason': json['degraded_reason'] == null ? undefined : json['degraded_reason'],
+        'algorithmVersion': json['algorithm_version'] == null ? undefined : json['algorithm_version'],
+        'fromContentHash': json['from_content_hash'] == null ? undefined : json['from_content_hash'],
+        'toContentHash': json['to_content_hash'] == null ? undefined : json['to_content_hash'],
+        'fromUploader': json['from_uploader'] == null ? undefined : UserInfoFromJSON(json['from_uploader']),
+        'toUploader': json['to_uploader'] == null ? undefined : UserInfoFromJSON(json['to_uploader']),
+        'fromUploadedAt': json['from_uploaded_at'] == null ? undefined : (new Date(json['from_uploaded_at'])),
+        'toUploadedAt': json['to_uploaded_at'] == null ? undefined : (new Date(json['to_uploaded_at'])),
     };
 }
 export function VersionDiffResponseToJSON(json) {
@@ -59,5 +73,16 @@ export function VersionDiffResponseToJSONTyped(value, ignoreDiscriminator = fals
         'format': DiffFormatToJSON(value['format']),
         'text': TextDiffToJSON(value['text']),
         'cells': CellDiffToJSON(value['cells']),
+        'structured': StructuredDiffToJSON(value['structured']),
+        'document': DocumentDiffToJSON(value['document']),
+        'degraded': value['degraded'],
+        'degraded_reason': value['degradedReason'],
+        'algorithm_version': value['algorithmVersion'],
+        'from_content_hash': value['fromContentHash'],
+        'to_content_hash': value['toContentHash'],
+        'from_uploader': UserInfoToJSON(value['fromUploader']),
+        'to_uploader': UserInfoToJSON(value['toUploader']),
+        'from_uploaded_at': value['fromUploadedAt'] == null ? value['fromUploadedAt'] : value['fromUploadedAt'].toISOString(),
+        'to_uploaded_at': value['toUploadedAt'] == null ? value['toUploadedAt'] : value['toUploadedAt'].toISOString(),
     };
 }