@knowledge-stack/ksapi 1.118.0 → 1.120.0

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,

package/docs/DataSourcesApi.md

@@ -6,10 +6,14 @@ All URIs are relative to *http://localhost:8000*
 |------------- | ------------- | -------------|
 | [**createDataSource**](DataSourcesApi.md#createdatasourceoperation) | **POST** /v1/data-sources | Create Data Source Handler |
 | [**deleteDataSource**](DataSourcesApi.md#deletedatasource) | **DELETE** /v1/data-sources/{data_source_id} | Delete Data Source Handler |
+| [**deleteDataSourceSchema**](DataSourcesApi.md#deletedatasourceschema) | **DELETE** /v1/data-sources/{data_source_id}/schemas/{schema_id} | Delete Data Source Schema Handler |
+| [**deleteDataSourceTable**](DataSourcesApi.md#deletedatasourcetable) | **DELETE** /v1/data-sources/{data_source_id}/tables/{table_id} | Delete Data Source Table Handler |
+| [**generateDataSourceDescription**](DataSourcesApi.md#generatedatasourcedescription) | **POST** /v1/data-sources/{data_source_id}/describe | Generate Data Source Description Handler |
 | [**getDataSource**](DataSourcesApi.md#getdatasource) | **GET** /v1/data-sources/{data_source_id} | Get Data Source Handler |
 | [**getDataSourceCatalog**](DataSourcesApi.md#getdatasourcecatalog) | **GET** /v1/data-sources/{data_source_id}/catalog | Get Data Source Catalog Handler |
 | [**listDataSourceSchemas**](DataSourcesApi.md#listdatasourceschemas) | **GET** /v1/data-sources/{data_source_id}/schemas | List Data Source Schemas Handler |
 | [**modelDataSourceTable**](DataSourcesApi.md#modeldatasourcetable) | **POST** /v1/data-sources/{data_source_id}/tables | Model Data Source Table Handler |
+| [**modelDataSourceTables**](DataSourcesApi.md#modeldatasourcetables) | **POST** /v1/data-sources/{data_source_id}/tables/batch | Model Data Source Tables Handler |
 | [**queryDataSource**](DataSourcesApi.md#querydatasource) | **POST** /v1/data-sources/{data_source_id}/query | Query Data Source Handler |
 | [**testDataSourceConnection**](DataSourcesApi.md#testdatasourceconnection) | **POST** /v1/data-sources/{data_source_id}/test | Test Data Source Connection Handler |
 | [**updateDataSource**](DataSourcesApi.md#updatedatasourceoperation) | **PATCH** /v1/data-sources/{data_source_id} | Update Data Source Handler |
@@ -98,7 +102,7 @@ example().catch(console.error);
 
 Delete Data Source Handler
 
-Move a connector and its modeled tables to trash.  Soft-delete via the path_part subtree (the tables are children, so they trash with it). Connectors carry no Qdrant vectors, so there is no trash-sync workflow.
+Move a connector and its schemas/tables to trash.  Soft-delete via the path_part subtree (schemas + tables are children, so they trash with it). The connector\'s generated ``.overview`` description Document IS ingested, so its Qdrant points are flipped to trashed via the set-trashed workflow (best-effort, mirrors the document delete path).
 
 ### Example
 
@@ -167,6 +171,237 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## deleteDataSourceSchema
+
+> deleteDataSourceSchema(dataSourceId, schemaId)
+
+Delete Data Source Schema Handler
+
+Un-model a schema and the tables under it (hard-delete the namespace).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DataSourcesApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteDataSourceSchemaRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DataSourcesApi(config);
+
+  const body = {
+    // string
+    dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    schemaId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteDataSourceSchemaRequest;
+
+  try {
+    const data = await api.deleteDataSourceSchema(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataSourceId** | `string` |  | [Defaults to `undefined`] |
+| **schemaId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteDataSourceTable
+
+> deleteDataSourceTable(dataSourceId, tableId)
+
+Delete Data Source Table Handler
+
+Un-model a single table (hard-delete it from its schema).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DataSourcesApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteDataSourceTableRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DataSourcesApi(config);
+
+  const body = {
+    // string
+    dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    tableId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteDataSourceTableRequest;
+
+  try {
+    const data = await api.deleteDataSourceTable(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataSourceId** | `string` |  | [Defaults to `undefined`] |
+| **tableId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## generateDataSourceDescription
+
+> DataSourceDescriptionResponse generateDataSourceDescription(dataSourceId)
+
+Generate Data Source Description Handler
+
+(Re)generate the connector\'s hidden, searchable \'Database overview\' Document.  Requires ``can_write`` on the connector. The structural overview is deterministic; an LLM prose summary is prepended best-effort. The document ingests through the normal pipeline so the agent\'s semantic search finds it.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DataSourcesApi,
+} from '@knowledge-stack/ksapi';
+import type { GenerateDataSourceDescriptionRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DataSourcesApi(config);
+
+  const body = {
+    // string
+    dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GenerateDataSourceDescriptionRequest;
+
+  try {
+    const data = await api.generateDataSourceDescription(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataSourceId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**DataSourceDescriptionResponse**](DataSourceDescriptionResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getDataSource
 
 > DataSourceDetailResponse getDataSource(dataSourceId)
@@ -401,7 +636,7 @@ example().catch(console.error);
 
 Model Data Source Table Handler
 
-Model a table as a queryable PathPart child; auto-introspect columns.
+Model a table under its (auto-created) Schema PDO; auto-introspect columns.
 
 ### Example
 
@@ -473,6 +708,84 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## modelDataSourceTables
+
+> BulkModelTablesResponse modelDataSourceTables(dataSourceId, bulkModelTablesRequest)
+
+Model Data Source Tables Handler
+
+Import several tables across one or more schemas; per-item results.  Schemas are auto find-or-created. Duplicates are pre-checked against the already-modeled tables and earlier items in the same batch (so a conflict never triggers a failed INSERT, which would otherwise roll back the batch\'s prior writes); introspection failures are reported per item. One bad item never aborts the batch.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DataSourcesApi,
+} from '@knowledge-stack/ksapi';
+import type { ModelDataSourceTablesRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DataSourcesApi(config);
+
+  const body = {
+    // string
+    dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // BulkModelTablesRequest
+    bulkModelTablesRequest: ...,
+  } satisfies ModelDataSourceTablesRequest;
+
+  try {
+    const data = await api.modelDataSourceTables(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataSourceId** | `string` |  | [Defaults to `undefined`] |
+| **bulkModelTablesRequest** | [BulkModelTablesRequest](BulkModelTablesRequest.md) |  | |
+
+### Return type
+
+[**BulkModelTablesResponse**](BulkModelTablesResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## queryDataSource
 
 > DataSourceQueryResponse queryDataSource(dataSourceId, dataSourceQueryRequest)

package/docs/DocumentBlockChange.md

@@ -0,0 +1,73 @@
+
+# DocumentBlockChange
+
+One changed block in a Word document, ordered by position.  ``from_paragraph_index``/``to_paragraph_index`` are the 0-based position of the ``<w:p>`` in ``word/document.xml`` body (the same index citation anchors use, so the frontend aligns changes to its docx render). ``anchor_text`` is a text-match fallback for that alignment. ``old``/``new`` are null on the absent side; ``*_spans`` mark changed word ranges (CJK-aware).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | [BlockChangeType](BlockChangeType.md)
+`kind` | [BlockKind](BlockKind.md)
+`changeClass` | [ChangeClass](ChangeClass.md)
+`fromParagraphIndex` | number
+`toParagraphIndex` | number
+`oldText` | string
+`newText` | string
+`oldSpans` | [Array&lt;DiffSpan&gt;](DiffSpan.md)
+`newSpans` | [Array&lt;DiffSpan&gt;](DiffSpan.md)
+`formattingChanged` | boolean
+`numericDelta` | string
+`numericPct` | string
+`anchorText` | string
+`surface` | string
+`cellChanges` | [Array&lt;TableCellChange&gt;](TableCellChange.md)
+`revisions` | [Array&lt;RevisionEdit&gt;](RevisionEdit.md)
+`oldImageRef` | string
+`newImageRef` | string
+`imageRegions` | [Array&lt;PixelRegion&gt;](PixelRegion.md)
+`imageNote` | string
+
+## Example
+
+```typescript
+import type { DocumentBlockChange } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "kind": null,
+  "changeClass": null,
+  "fromParagraphIndex": null,
+  "toParagraphIndex": null,
+  "oldText": null,
+  "newText": null,
+  "oldSpans": null,
+  "newSpans": null,
+  "formattingChanged": null,
+  "numericDelta": null,
+  "numericPct": null,
+  "anchorText": null,
+  "surface": null,
+  "cellChanges": null,
+  "revisions": null,
+  "oldImageRef": null,
+  "newImageRef": null,
+  "imageRegions": null,
+  "imageNote": null,
+} satisfies DocumentBlockChange
+
+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 DocumentBlockChange
+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/DocumentDiff.md

@@ -0,0 +1,51 @@
+
+# DocumentDiff
+
+A structured block diff of two Word (.docx) versions.  ``added``/``removed``/``modified`` are full totals; ``blocks`` is capped and ``omitted_blocks`` reports exactly how many were dropped (never a silent cap). ``surfaces_checked`` attests which OOXML surfaces were diffed, ``unaccepted_revisions`` counts tracked changes present (the rendered text may not be final), and ``decode_degraded`` flags a partial parse.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`blocks` | [Array<DocumentBlockChange>](DocumentBlockChange.md)
+`added` | number
+`removed` | number
+`modified` | number
+`truncated` | boolean
+`omittedBlocks` | number
+`surfacesChecked` | Array<string>
+`unacceptedRevisions` | number
+`decodeDegraded` | boolean
+
+## Example
+
+```typescript
+import type { DocumentDiff } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "blocks": null,
+  "added": null,
+  "removed": null,
+  "modified": null,
+  "truncated": null,
+  "omittedBlocks": null,
+  "surfacesChecked": null,
+  "unacceptedRevisions": null,
+  "decodeDegraded": null,
+} satisfies DocumentDiff
+
+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 DocumentDiff
+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/DocumentVersionsApi.md

@@ -567,7 +567,7 @@ example().catch(console.error);
 
 Get Document Version Diff Handler
 
-Side-by-side diff of a version against a previous one of the same document.  Diffs the two versions\' plaintext on the fly (no stored diff), so any pair of versions can be compared. ``from_version_id`` defaults to the immediate predecessor; the first version diffs against empty (all additions). Requires read permission on the document.
+Side-by-side diff of a version against a previous one of the same document.  Diffs the two versions on the fly (no stored diff), so any pair of versions can be compared. ``from_version_id`` defaults to the immediate predecessor; the first version diffs against empty (all additions). Requires read permission on both versions. Viewing a diff is a sensitive read, so it emits a ``document.diff.viewed`` audit event (a durable write on this GET, by design — like a download).
 
 ### Example
 

package/docs/ExcludedCommonFile.md

@@ -0,0 +1,37 @@
+
+# ExcludedCommonFile
+
+A definition common file that could not be applied to a run at Start.  Common files resolve resiliently (record-and-continue): one that is missing/deleted or unreadable by the run-starter is recorded here rather than failing the run, so the exclusion is auditable and visible to the FE.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pathPartId` | string
+`reason` | [CommonFileExclusionReason](CommonFileExclusionReason.md)
+
+## Example
+
+```typescript
+import type { ExcludedCommonFile } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pathPartId": null,
+  "reason": null,
+} satisfies ExcludedCommonFile
+
+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 ExcludedCommonFile
+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)
+
+