@squidcloud/freshdesk-client 1.0.500 → 1.0.502
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.
- package/dist/internal-common/src/ai/kb-version-rules.d.ts +62 -0
- package/dist/internal-common/src/public-types/ai-agent.public-types.d.ts +3 -3
- package/dist/internal-common/src/public-types/ai-knowledge-base.public-types.d.ts +14 -0
- package/dist/internal-common/src/public-types/connector.public-types.d.ts +45 -0
- package/dist/internal-common/src/types/integrations/database.types.d.ts +4 -0
- package/dist/internal-common/src/types/integrations/storage-types.d.ts +11 -0
- package/package.json +2 -2
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Version-family rules for knowledge-base sources that keep every draft of a document (`Deck v01 … v05, vF`).
|
|
3
|
+
* Dependency-free on purpose: connectors bundle it, and the console preview runs the exact same code.
|
|
4
|
+
*/
|
|
5
|
+
/** Overridable rules. A list that is present replaces the default list; an absent one keeps the default. */
|
|
6
|
+
export interface KbVersionRules {
|
|
7
|
+
/** Regular expression with exactly one capture group holding the version number. Matched case-insensitively. */
|
|
8
|
+
versionRegex?: string;
|
|
9
|
+
/** Tokens that mark a final version (`vF`, `final`, ...). */
|
|
10
|
+
finalMarkers?: Array<string>;
|
|
11
|
+
/** Tokens dropped from the name before grouping (`draft`, `(1)`, ...). */
|
|
12
|
+
ignoredTokens?: Array<string>;
|
|
13
|
+
/** Folder names that hold older copies; they are dropped from the folder path before grouping. */
|
|
14
|
+
archiveFolders?: Array<string>;
|
|
15
|
+
}
|
|
16
|
+
/** Rules with every default applied. */
|
|
17
|
+
export type ResolvedKbVersionRules = Required<KbVersionRules>;
|
|
18
|
+
export declare const DEFAULT_KB_VERSION_RULES: ResolvedKbVersionRules;
|
|
19
|
+
/** One source file the rules group into families. */
|
|
20
|
+
export interface KbVersionFileInput {
|
|
21
|
+
/** Caller-chosen id echoed back in the result (a context id, a document id). */
|
|
22
|
+
id: string;
|
|
23
|
+
/** File name including its extension. */
|
|
24
|
+
name: string;
|
|
25
|
+
/** Folder path of the file, `/`-separated; absent when the source does not know it. */
|
|
26
|
+
folderPath?: string;
|
|
27
|
+
/** Families never cross namespaces (integration + site/drive, plus the parent folder id when the path is unknown). */
|
|
28
|
+
namespace: string;
|
|
29
|
+
/** Source last-modified time in epoch millis. */
|
|
30
|
+
lastModified?: number;
|
|
31
|
+
/** A source-provided status (`current`, `superseded`) that only breaks otherwise exact ties. */
|
|
32
|
+
versionStatus?: string;
|
|
33
|
+
}
|
|
34
|
+
/** Why a file lost to its family's winner. */
|
|
35
|
+
export type KbVersionSupersededReason = 'final-marker' | 'higher-version' | 'newer-modified' | 'version-status';
|
|
36
|
+
/** The computed version state of one file. */
|
|
37
|
+
export interface KbVersionFileState {
|
|
38
|
+
id: string;
|
|
39
|
+
/** Stable id of the file's family within its namespace. */
|
|
40
|
+
familyId: string;
|
|
41
|
+
/** Sortable rank key: larger sorts later (more final). */
|
|
42
|
+
versionKey: string;
|
|
43
|
+
/** Number of files in the family. */
|
|
44
|
+
familySize: number;
|
|
45
|
+
superseded: boolean;
|
|
46
|
+
/** The family's winner, present when `superseded`. */
|
|
47
|
+
winnerId?: string;
|
|
48
|
+
reason?: KbVersionSupersededReason;
|
|
49
|
+
}
|
|
50
|
+
/** Applies the defaults to the lists and regex a rule set leaves out. */
|
|
51
|
+
export declare function resolveKbVersionRules(rules: KbVersionRules | undefined): ResolvedKbVersionRules;
|
|
52
|
+
/** Returns why a rule set is invalid, or undefined when it is valid. */
|
|
53
|
+
export declare function validateKbVersionRules(rules: KbVersionRules | undefined): string | undefined;
|
|
54
|
+
/** Fingerprint of the resolved rules; a rule edit changes it, so the applied flags can be told stale. */
|
|
55
|
+
export declare function computeKbVersionRulesRevision(rules: KbVersionRules | undefined): string;
|
|
56
|
+
/**
|
|
57
|
+
* Groups files into version families and marks every file that loses to its family's winner.
|
|
58
|
+
* Rank: final marker > highest version number > newest `lastModified`; `versionStatus` breaks exact ties only.
|
|
59
|
+
* Format variants of a winning version, and families whose winner is ambiguous (an exact tie, or a non-final
|
|
60
|
+
* file newer than a final one and numbered higher), keep every contender unsuperseded.
|
|
61
|
+
*/
|
|
62
|
+
export declare function computeKbVersionStates(files: ReadonlyArray<KbVersionFileInput>, rules?: KbVersionRules): Array<KbVersionFileState>;
|
|
@@ -1144,11 +1144,11 @@ export interface UpsertContextStatusSuccess extends BaseUpsertContextStatus {
|
|
|
1144
1144
|
}
|
|
1145
1145
|
/**
|
|
1146
1146
|
* Names an upsert failure; `DUPLICATE_CONTENT` identifies existing content when contextId is omitted.
|
|
1147
|
-
* `EMBEDDING_FAILED`, `EXTRACTION_TIMED_OUT`, `PROVIDER_ACCESS_DENIED`, and
|
|
1148
|
-
* succeed on retry. Document faults carry `retryable: false` because the same bytes fail again.
|
|
1147
|
+
* `CONTENT_IN_FLIGHT`, `EMBEDDING_FAILED`, `EXTRACTION_TIMED_OUT`, `PROVIDER_ACCESS_DENIED`, and
|
|
1148
|
+
* `SOURCE_UNREACHABLE` may succeed on retry. Document faults carry `retryable: false` because the same bytes fail again.
|
|
1149
1149
|
* @category AI
|
|
1150
1150
|
*/
|
|
1151
|
-
export type UpsertContextErrorCode = 'CONTENT_TOO_LARGE' | 'DUPLICATE_CONTENT' | 'EMBEDDING_FAILED' | 'ENCRYPTED_DOCUMENT' | 'EXTRACTION_TIMED_OUT' | 'IMAGE_OVER_PROVIDER_LIMIT' | 'NO_EMBEDDABLE_CONTENT' | 'PROVIDER_ACCESS_DENIED' | 'SOURCE_OVER_PROVIDER_LIMIT' | 'SOURCE_UNREACHABLE' | 'UNREADABLE_DOCUMENT' | 'UNREADABLE_WORKBOOK' | 'UNSUPPORTED_FILE_TYPE';
|
|
1151
|
+
export type UpsertContextErrorCode = 'CONTENT_IN_FLIGHT' | 'CONTENT_TOO_LARGE' | 'DUPLICATE_CONTENT' | 'EMBEDDING_FAILED' | 'ENCRYPTED_DOCUMENT' | 'EXTRACTION_TIMED_OUT' | 'IMAGE_OVER_PROVIDER_LIMIT' | 'NO_EMBEDDABLE_CONTENT' | 'PROVIDER_ACCESS_DENIED' | 'SOURCE_OVER_PROVIDER_LIMIT' | 'SOURCE_UNREACHABLE' | 'UNREADABLE_DOCUMENT' | 'UNREADABLE_WORKBOOK' | 'UNSUPPORTED_FILE_TYPE';
|
|
1152
1152
|
/**
|
|
1153
1153
|
* The existing context a `DUPLICATE_CONTENT` rejection points at — where the byte-identical original
|
|
1154
1154
|
* already lives.
|
|
@@ -399,6 +399,12 @@ export interface AiKnowledgeBaseChatOptions {
|
|
|
399
399
|
* Composes with every `searchMode` and with `contextMetadataFilter`. Requires `graphRag.enabled`.
|
|
400
400
|
*/
|
|
401
401
|
graphFilter?: AiKnowledgeBaseGraphFilter;
|
|
402
|
+
/**
|
|
403
|
+
* Returns superseded versions of a document (older drafts a source marked as replaced by a newer version)
|
|
404
|
+
* too, instead of only the final version. For questions pinned to a point in time ("the original model",
|
|
405
|
+
* "as of 2019"). Access control still applies.
|
|
406
|
+
*/
|
|
407
|
+
includeSupersededVersions?: boolean;
|
|
402
408
|
}
|
|
403
409
|
/**
|
|
404
410
|
* Graph scope for a knowledge-base search: restricts results to the documents under one concept.
|
|
@@ -760,6 +766,12 @@ export interface AiKnowledgeBaseSearchOptions {
|
|
|
760
766
|
* Composes with every `searchMode` and with `contextMetadataFilter`. Requires `graphRag.enabled`.
|
|
761
767
|
*/
|
|
762
768
|
graphFilter?: AiKnowledgeBaseGraphFilter;
|
|
769
|
+
/**
|
|
770
|
+
* Returns superseded versions of a document (older drafts a source marked as replaced by a newer version)
|
|
771
|
+
* too, instead of only the final version. For questions pinned to a point in time ("the original model",
|
|
772
|
+
* "as of 2019"). Access control still applies.
|
|
773
|
+
*/
|
|
774
|
+
includeSupersededVersions?: boolean;
|
|
763
775
|
}
|
|
764
776
|
/**
|
|
765
777
|
* A single chunk of data returned from an AI search operation.
|
|
@@ -877,6 +889,8 @@ export interface GrepKnowledgeBaseOptions {
|
|
|
877
889
|
* and is clamped to {@link GREP_KNOWLEDGE_BASE_MAX_MATCHES}.
|
|
878
890
|
*/
|
|
879
891
|
maxMatches?: number;
|
|
892
|
+
/** Scans the text of superseded versions too; by default only the final version of a document is scanned. */
|
|
893
|
+
includeSupersededVersions?: boolean;
|
|
880
894
|
}
|
|
881
895
|
/**
|
|
882
896
|
* Request structure for a literal scan over a knowledge base's raw extracted text.
|
|
@@ -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
|
+
}
|
|
@@ -10,6 +10,8 @@ type AssociationName = string;
|
|
|
10
10
|
export interface IntegrationDataSchemaApi extends BaseIntegrationSchema {
|
|
11
11
|
collections: Record<TableName, CollectionSchemaApi>;
|
|
12
12
|
associations?: Record<AssociationName, AssociationSchema>;
|
|
13
|
+
discriminators?: Record<string, DiscriminatorSchema>;
|
|
14
|
+
columnDependencies?: Record<string, ColumnDependency>;
|
|
13
15
|
storedProcedures?: Record<string, StoredProcedureSchema>;
|
|
14
16
|
}
|
|
15
17
|
/**
|
|
@@ -19,6 +21,8 @@ export interface IntegrationDataSchemaApi extends BaseIntegrationSchema {
|
|
|
19
21
|
export interface DiscoverDataConnectionSchemaResponseApi {
|
|
20
22
|
schema: IntegrationDataSchemaApi;
|
|
21
23
|
collectionReadiness: Record<CollectionName, CollectionReadiness>;
|
|
24
|
+
/** What discovery could not read, such as the declared foreign keys, and kept as it was. */
|
|
25
|
+
warnings?: Array<string>;
|
|
22
26
|
}
|
|
23
27
|
/**
|
|
24
28
|
* API-boundary mirror of {@link GenerateAiDescriptionsForDataSchemaResponse}.
|
|
@@ -1,3 +1,14 @@
|
|
|
1
|
+
import { KbVersionRules } from '../../ai/kb-version-rules';
|
|
2
|
+
/** How the SharePoint connector groups versions of one document (`Deck v01 … v05, vF`). */
|
|
3
|
+
export interface SharePointVersioningConfiguration {
|
|
4
|
+
/**
|
|
5
|
+
* When true, every version is still indexed, but versions superseded by a newer one in the same folder are
|
|
6
|
+
* flagged and left out of search unless a search asks for them. Defaults to false.
|
|
7
|
+
*/
|
|
8
|
+
excludeSupersededVersions?: boolean;
|
|
9
|
+
/** Overrides of the default family rules; a list that is present replaces the default list. */
|
|
10
|
+
rules?: KbVersionRules;
|
|
11
|
+
}
|
|
1
12
|
/** Downloads a SharePoint staging sweep keeps in flight when the integration does not say. */
|
|
2
13
|
export declare const SHAREPOINT_DEFAULT_STAGING_CONCURRENCY = 10;
|
|
3
14
|
/** Most downloads a SharePoint staging sweep may keep in flight, so one integration cannot swamp Graph or core. */
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@squidcloud/freshdesk-client",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.502",
|
|
4
4
|
"description": "Squid Freshdesk Client - SDK for interacting with the Freshdesk connector",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/freshdesk-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.
|
|
26
|
+
"@squidcloud/client": "^1.0.502"
|
|
27
27
|
},
|
|
28
28
|
"engines": {
|
|
29
29
|
"node": ">=20.0.0"
|