@knowledge-stack/ksapi 1.117.0 → 1.119.0

package/docs/CellChange.md

@@ -1,7 +1,7 @@
 
 # CellChange
 
-One changed spreadsheet cell (``old`` is null for added, ``new`` for removed).
+One changed spreadsheet cell (``old`` is null for added, ``new`` for removed).  ``old``/``new`` are the displayed values (cached result for a formula cell); ``*_formula`` carry the formula text so a formula edit is visible even when the computed value is unchanged. ``formatting_changed`` flags a bold/colour/ number-format change on an otherwise unchanged cell.
 
 ## Properties
 
@@ -12,6 +12,13 @@ Name | Type
 `old` | string
 `_new` | string
 `type` | [CellChangeType](CellChangeType.md)
+`oldFormula` | string
+`newFormula` | string
+`formulaChanged` | boolean
+`formattingChanged` | boolean
+`commentChanged` | boolean
+`oldComment` | string
+`newComment` | string
 
 ## Example
 
@@ -25,6 +32,13 @@ const example = {
   "old": null,
   "_new": null,
   "type": null,
+  "oldFormula": null,
+  "newFormula": null,
+  "formulaChanged": null,
+  "formattingChanged": null,
+  "commentChanged": null,
+  "oldComment": null,
+  "newComment": null,
 } satisfies CellChange
 
 console.log(example)

package/docs/CellDiff.md

@@ -12,6 +12,7 @@ Name | Type
 `removed` | number
 `modified` | number
 `truncated` | boolean
+`sheetVisibilityChanges` | [Array<SheetVisibilityChange>](SheetVisibilityChange.md)
 
 ## Example
 
@@ -25,6 +26,7 @@ const example = {
   "removed": null,
   "modified": null,
   "truncated": null,
+  "sheetVisibilityChanges": null,
 } satisfies CellDiff
 
 console.log(example)

package/docs/ChangeClass.md

@@ -0,0 +1,33 @@
+
+# ChangeClass
+
+What kind of change this is, so an auditor can filter (numbers move money).
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ChangeClass } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ChangeClass
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ChangeClass
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ChunksApi.md

@@ -304,7 +304,7 @@ example().catch(console.error);
 | **chunkId** | `string` |  | [Defaults to `undefined`] |
 | **prev** | `number` | Number of preceding items to include (max 50). | [Optional] [Defaults to `1`] |
 | **next** | `number` | Number of succeeding items to include (max 50). | [Optional] [Defaults to `1`] |
-| **contentType** | `PartType` | Filter by content type: SECTION or CHUNK. Omit to return both. SECTION is rejected when the anchor is a chunk (always). | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT, DOCUMENT_VERSION, SECTION, CHUNK, THREAD, THREAD_MESSAGE, WORKFLOW_DEFINITION, WORKFLOW_RUN, DATA_SOURCE, DATA_SOURCE_TABLE, API_CONNECTION] |
+| **contentType** | `PartType` | Filter by content type: SECTION or CHUNK. Omit to return both. SECTION is rejected when the anchor is a chunk (always). | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT, DOCUMENT_VERSION, SECTION, CHUNK, THREAD, THREAD_MESSAGE, WORKFLOW_DEFINITION, WORKFLOW_RUN, DATA_SOURCE, DATA_SOURCE_SCHEMA, DATA_SOURCE_TABLE, API_CONNECTION] |
 | **withinSection** | `boolean` | When true (default), traverse only the anchor\'s sibling chain under the same parent. When false, traverse the entire document version in DFS order, crossing section boundaries. | [Optional] [Defaults to `true`] |
 
 ### Return type

package/docs/DataSourceDescriptionResponse.md

@@ -0,0 +1,37 @@
+
+# DataSourceDescriptionResponse
+
+Result of (re)generating a connector\'s searchable description Document.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`dataSourceId` | string
+`descriptionDocumentId` | string
+
+## Example
+
+```typescript
+import type { DataSourceDescriptionResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "dataSourceId": null,
+  "descriptionDocumentId": null,
+} satisfies DataSourceDescriptionResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DataSourceDescriptionResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DataSourceDetailResponse.md

@@ -1,14 +1,15 @@
 
 # DataSourceDetailResponse
 
-A connector plus the modeled tables the caller can read (describe).
+A connector plus the schemas (and their readable tables) the caller sees.  ``description_document_id`` points at the connector\'s generated, ingested \"Database overview\" Document (a hidden system file); null until generated.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `dataSource` | [DataSourceResponse](DataSourceResponse.md)
-`tables` | [Array<DataSourceTableResponse>](DataSourceTableResponse.md)
+`schemas` | [Array<DataSourceSchemaResponse>](DataSourceSchemaResponse.md)
+`descriptionDocumentId` | string
 
 ## Example
 
@@ -18,7 +19,8 @@ import type { DataSourceDetailResponse } from '@knowledge-stack/ksapi'
 // TODO: Update the object below with actual values
 const example = {
   "dataSource": null,
-  "tables": null,
+  "schemas": null,
+  "descriptionDocumentId": null,
 } satisfies DataSourceDetailResponse
 
 console.log(example)

package/docs/DataSourceSchemaListItem.md

@@ -0,0 +1,37 @@
+
+# DataSourceSchemaListItem
+
+A namespace discovered by live introspection (not a persisted PDO).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`isDefault` | boolean
+
+## Example
+
+```typescript
+import type { DataSourceSchemaListItem } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "isDefault": null,
+} satisfies DataSourceSchemaListItem
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DataSourceSchemaListItem
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DataSourceSchemaListResponse.md

@@ -7,7 +7,7 @@ The source\'s user namespaces (PG schemas / MySQL databases).
 
 Name | Type
 ------------ | -------------
-`schemas` | [Array<DataSourceSchemaResponse>](DataSourceSchemaResponse.md)
+`schemas` | [Array<DataSourceSchemaListItem>](DataSourceSchemaListItem.md)
 
 ## Example
 

package/docs/DataSourceSchemaResponse.md

@@ -1,13 +1,28 @@
 
 # DataSourceSchemaResponse
 
+A schema PDO under a connector, with the readable tables it contains.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
+`partType` | string
+`id` | string
+`pathPartId` | string
+`parentPathPartId` | string
+`materializedPath` | string
+`tenantId` | string
 `name` | string
+`dataSourceId` | string
+`schemaName` | string
 `isDefault` | boolean
+`description` | string
+`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
+`permissions` | [ItemPermissions](ItemPermissions.md)
+`createdAt` | Date
+`updatedAt` | Date
+`tables` | [Array<DataSourceTableResponse>](DataSourceTableResponse.md)
 
 ## Example
 
@@ -16,8 +31,22 @@ import type { DataSourceSchemaResponse } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
+  "partType": null,
+  "id": null,
+  "pathPartId": null,
+  "parentPathPartId": null,
+  "materializedPath": null,
+  "tenantId": null,
   "name": null,
+  "dataSourceId": null,
+  "schemaName": null,
   "isDefault": null,
+  "description": null,
+  "approvalState": null,
+  "permissions": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "tables": null,
 } satisfies DataSourceSchemaResponse
 
 console.log(example)

package/docs/DataSourceTableResponse.md

@@ -1,7 +1,7 @@
 
 # DataSourceTableResponse
 
-Modeled-table response; a discriminated-union variant for listings.
+Modeled-table response; a discriminated-union variant for listings.  The table\'s schema is its parent ``DataSourceSchema`` PDO; the table no longer carries a ``schema_name`` of its own.
 
 ## Properties
 
@@ -15,8 +15,8 @@ Name | Type
 `tenantId` | string
 `name` | string
 `dataSourceId` | string
+`dataSourceSchemaId` | string
 `tableName` | string
-`schemaName` | string
 `description` | string
 `columnConfig` | Array<{ [key: string]: any; }>
 `approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
@@ -39,8 +39,8 @@ const example = {
   "tenantId": null,
   "name": null,
   "dataSourceId": null,
+  "dataSourceSchemaId": null,
   "tableName": null,
-  "schemaName": null,
   "description": null,
   "columnConfig": null,
   "approvalState": null,