@squidcloud/jira-client 1.0.500 → 1.0.501

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -10,3 +10,48 @@ export declare const CONNECTOR_IDS: readonly ["bitbucket", "confluence", "connec
10
10
  * @category Platform
11
11
  */
12
12
  export type ConnectorId = (typeof CONNECTOR_IDS)[number];
13
+ /** Where one file/folder sits in a connector's own tracking, independent of the KB ledger. */
14
+ export type ConnectorPathStatusClassification = 'indexed' | 'staged' | 'failed' | 'skipped' | 'folder_tracked';
15
+ /** The durable ingestion status of one file in the knowledge base ledger, as {@link ConnectorPathStatusEntry.kbStatus}. */
16
+ export interface ConnectorKbFileStatus {
17
+ /** The file's current durable status in the knowledge base ledger. */
18
+ status: 'no_record' | 'in_progress' | 'completed' | 'failed';
19
+ /** Present only when `status` is `'failed'`. */
20
+ errorMessage?: string;
21
+ /** Present only when `status` is `'failed'`, when known. */
22
+ errorCode?: string;
23
+ /** When this status was last recorded; absent when `status` is `'no_record'`. */
24
+ updatedAt?: Date;
25
+ }
26
+ /** One file or folder a connector knows about at or under a searched path. */
27
+ export interface ConnectorPathStatusEntry {
28
+ /** The connector-specific id of the document. */
29
+ documentId: string;
30
+ /** The document's name. */
31
+ name: string;
32
+ /** Whether this document is a file or a folder. */
33
+ type: 'file' | 'folder';
34
+ /** Folder path, when this document was indexed through a folder. With `name`, forms the KB ledger's lookup path. */
35
+ folderPath?: string;
36
+ /** Where this document sits in the connector's own tracking. */
37
+ classification: ConnectorPathStatusClassification;
38
+ /** Message describing the most recent failure, when `classification` is `'failed'` or `'skipped'`. */
39
+ errorMessage?: string;
40
+ /** Last successful ingestion, when the document has one. */
41
+ lastIndexedDate?: Date;
42
+ /** The knowledge-base context ID this document maps to, when it has one. */
43
+ contextId?: string;
44
+ /** The KB ledger's own status for this file, when the connector resolved one. */
45
+ kbStatus?: ConnectorKbFileStatus;
46
+ }
47
+ /** A connector's own record of files/folders matching a searched path, from `Squid.getConnectorPathStatus`. */
48
+ export interface ConnectorPathStatusResult {
49
+ /** False when the integration's type doesn't expose path-status search (most types). */
50
+ supported: boolean;
51
+ /** The knowledge base this integration indexes into, when resolvable. */
52
+ knowledgeBaseId?: string;
53
+ /** The matching files/folders, absent when `supported` is false. */
54
+ entries?: Array<ConnectorPathStatusEntry>;
55
+ /** True when more matches exist than `entries` returns. */
56
+ truncated?: boolean;
57
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/jira-client",
3
- "version": "1.0.500",
3
+ "version": "1.0.501",
4
4
  "description": "Squid Jira Client - SDK for interacting with the Jira connector",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/jira-client/src/index.d.ts",
@@ -23,7 +23,7 @@
23
23
  "license": "ISC",
24
24
  "dependencies": {
25
25
  "assertic": "^1.3.0",
26
- "@squidcloud/client": "^1.0.500"
26
+ "@squidcloud/client": "^1.0.501"
27
27
  },
28
28
  "engines": {
29
29
  "node": ">=20.0.0"