@githits/mcp 0.31.0 → 0.33.0
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/README.md +2 -0
- package/dist/client.d.ts +46 -27
- package/dist/client.js +1 -1
- package/dist/index.d.ts +32 -13
- package/dist/index.js +24 -19
- package/dist/shared/chunk-0ch431yh.js +1524 -0
- package/dist/shared/chunk-0sd6v5ad.js +352 -0
- package/dist/shared/chunk-nawnggb2.js +31 -0
- package/dist/smoke-test.js +1 -1
- package/dist/tools.d.ts +12 -1
- package/dist/tools.js +1 -1
- package/package.json +1 -1
- package/dist/shared/chunk-f7dn7map.js +0 -31
- package/dist/shared/chunk-mpab140t.js +0 -1515
- package/dist/shared/chunk-yw09kwnr.js +0 -352
package/README.md
CHANGED
|
@@ -157,6 +157,8 @@ boundary is authenticated and reached.
|
|
|
157
157
|
|
|
158
158
|
The package expects callers to provide service implementations through `McpToolServices` or a request-scoped `McpToolServicesProvider`. `McpToolServices.readService` is required for the advertised compact `read` tool; remote hosts should construct the `ReadServiceImpl` instance per request with that request's endpoint, token, headers, fetch function, and diagnostics. GitHits does not populate MCP initialize instructions because hosts expose them inconsistently; `quick_start` owns shared guidance instead. Callers may still pass their own `instructions` explicitly. Use `quickStartOptions` to configure the guide. Servers can pass `traceTool` to `createMcpServer()` or `registerMcpTools()` to wrap public tool execution for instrumentation without receiving arguments or auth data.
|
|
159
159
|
|
|
160
|
+
Network-backed tools forward the MCP request's abort signal to their service call as an optional trailing `ServiceRequestOptions` argument (`{ signal }`), so a cancelled call or closed connection aborts the backend request. The bundled service implementations behind these tools honor it; custom service implementations should forward `options?.signal` to their own requests. Calls without a signal keep their single-argument shape.
|
|
161
|
+
|
|
160
162
|
Only imports from `@githits/mcp`, `@githits/mcp/client`, `@githits/mcp/smoke-test`, `@githits/mcp/tools`, and `@githits/mcp/package.json` are public. The workspace alias `@githits/mcp/internal` is not exported, is not supported for external consumers, and must not be used by remote MCP server implementations.
|
|
161
163
|
|
|
162
164
|
Remote MCP servers should provide request-scoped services through `createMcpServer()` and keep transport, auth/session handling, deployment config, and observability outside this package.
|
package/dist/client.d.ts
CHANGED
|
@@ -168,6 +168,17 @@ interface ReadTarget {
|
|
|
168
168
|
startLine?: number;
|
|
169
169
|
endLine?: number;
|
|
170
170
|
}
|
|
171
|
+
/**
|
|
172
|
+
* Optional per-call controls shared by network-backed service methods.
|
|
173
|
+
*
|
|
174
|
+
* `signal` is the caller's cancellation signal, such as an MCP request
|
|
175
|
+
* cancellation. Services combine it with their own request deadline: a caller
|
|
176
|
+
* abort rejects with the signal's reason and is never retried, while an
|
|
177
|
+
* internal deadline keeps each service's timeout error mapping.
|
|
178
|
+
*/
|
|
179
|
+
interface ServiceRequestOptions {
|
|
180
|
+
signal?: AbortSignal;
|
|
181
|
+
}
|
|
171
182
|
/** Nullable registry-version association carried by public error inventories. */
|
|
172
183
|
interface RecoveryRef {
|
|
173
184
|
ref: string;
|
|
@@ -862,7 +873,7 @@ interface CodeNavigationService {
|
|
|
862
873
|
}
|
|
863
874
|
/** Additive client capability for the unpromoted CodeDiff surface. */
|
|
864
875
|
interface CodeDiffService {
|
|
865
|
-
codeDiff(params: CodeDiffParams): Promise<CodeDiffResult>;
|
|
876
|
+
codeDiff(params: CodeDiffParams, options?: ServiceRequestOptions): Promise<CodeDiffResult>;
|
|
866
877
|
}
|
|
867
878
|
/**
|
|
868
879
|
* GraphQL resolver error for CodeDiff. `partial` is present only when the
|
|
@@ -887,7 +898,7 @@ declare class CodeNavigationServiceImpl implements CodeNavigationService, CodeDi
|
|
|
887
898
|
private postGraphqlWithTargetResolutionFallback;
|
|
888
899
|
search(params: UnifiedSearchParams, options?: UnifiedSearchReadOptions): Promise<UnifiedSearchOutcome>;
|
|
889
900
|
searchStatus(searchRef: string, waitTimeoutMs?: number, options?: UnifiedSearchReadOptions): Promise<UnifiedSearchOutcome>;
|
|
890
|
-
codeDiff(params: CodeDiffParams): Promise<CodeDiffResult>;
|
|
901
|
+
codeDiff(params: CodeDiffParams, options?: ServiceRequestOptions): Promise<CodeDiffResult>;
|
|
891
902
|
private executeCodeDiff;
|
|
892
903
|
private createCodeDiffRootError;
|
|
893
904
|
private executeUnifiedSearch;
|
|
@@ -1112,7 +1123,7 @@ interface GrepResult {
|
|
|
1112
1123
|
totalMatches: number;
|
|
1113
1124
|
}
|
|
1114
1125
|
interface GrepService {
|
|
1115
|
-
grep(params: GrepParams): Promise<GrepResult>;
|
|
1126
|
+
grep(params: GrepParams, options?: ServiceRequestOptions): Promise<GrepResult>;
|
|
1116
1127
|
}
|
|
1117
1128
|
interface GrepServiceRuntime {
|
|
1118
1129
|
clientHeaders?: ClientHeaderBuilder;
|
|
@@ -1149,7 +1160,7 @@ declare class GrepServiceImpl implements GrepService {
|
|
|
1149
1160
|
private readonly fetchFn;
|
|
1150
1161
|
private readonly runtime;
|
|
1151
1162
|
constructor(endpointUrl: string, tokenProvider: TokenProvider, fetchFn?: typeof fetch, runtime?: GrepServiceRuntime);
|
|
1152
|
-
grep(params: GrepParams): Promise<GrepResult>;
|
|
1163
|
+
grep(params: GrepParams, options?: ServiceRequestOptions): Promise<GrepResult>;
|
|
1153
1164
|
private executeGrep;
|
|
1154
1165
|
}
|
|
1155
1166
|
type ListFileIntent = "PRODUCTION" | "TEST" | "BENCHMARK" | "EXAMPLE" | "GENERATED" | "FIXTURE" | "BUILD" | "VENDOR";
|
|
@@ -1268,7 +1279,7 @@ interface ListResult {
|
|
|
1268
1279
|
preparation: ListSitePreparation | null;
|
|
1269
1280
|
}
|
|
1270
1281
|
interface ListService {
|
|
1271
|
-
list(params: ListParams): Promise<ListResult>;
|
|
1282
|
+
list(params: ListParams, options?: ServiceRequestOptions): Promise<ListResult>;
|
|
1272
1283
|
}
|
|
1273
1284
|
interface ListServiceRuntime {
|
|
1274
1285
|
clientHeaders?: ClientHeaderBuilder;
|
|
@@ -1316,7 +1327,7 @@ declare class ListServiceImpl implements ListService {
|
|
|
1316
1327
|
private readonly fetchFn;
|
|
1317
1328
|
private readonly runtime;
|
|
1318
1329
|
constructor(endpointUrl: string, tokenProvider: TokenProvider, fetchFn?: typeof fetch, runtime?: ListServiceRuntime);
|
|
1319
|
-
list(params: ListParams): Promise<ListResult>;
|
|
1330
|
+
list(params: ListParams, options?: ServiceRequestOptions): Promise<ListResult>;
|
|
1320
1331
|
private executeList;
|
|
1321
1332
|
}
|
|
1322
1333
|
interface PackageSummaryParams {
|
|
@@ -1325,6 +1336,12 @@ interface PackageSummaryParams {
|
|
|
1325
1336
|
/** Include verbose/json-only fields such as recent advisories and changes. */
|
|
1326
1337
|
includeVerboseFields?: boolean;
|
|
1327
1338
|
}
|
|
1339
|
+
/** Logical artifact repository that supplied validated release metadata. */
|
|
1340
|
+
interface RegistryRepository {
|
|
1341
|
+
id: string;
|
|
1342
|
+
name: string;
|
|
1343
|
+
url: string;
|
|
1344
|
+
}
|
|
1328
1345
|
interface PackageIdentity {
|
|
1329
1346
|
name: string;
|
|
1330
1347
|
registry?: string;
|
|
@@ -1339,6 +1356,7 @@ interface PackageIdentity {
|
|
|
1339
1356
|
versionCount?: number;
|
|
1340
1357
|
downloadsRefreshedAt?: string;
|
|
1341
1358
|
githubRepository?: GithubRepository;
|
|
1359
|
+
registryRepository?: RegistryRepository;
|
|
1342
1360
|
}
|
|
1343
1361
|
interface GithubRepository {
|
|
1344
1362
|
stargazersCount?: number;
|
|
@@ -1395,6 +1413,7 @@ interface PackageVersionIdentity {
|
|
|
1395
1413
|
publishedAt?: string;
|
|
1396
1414
|
deprecated?: boolean;
|
|
1397
1415
|
deprecationReason?: string;
|
|
1416
|
+
registryRepository?: RegistryRepository;
|
|
1398
1417
|
}
|
|
1399
1418
|
interface VulnerabilityDetail {
|
|
1400
1419
|
osvId?: string;
|
|
@@ -2080,14 +2099,14 @@ interface PackageDocResult {
|
|
|
2080
2099
|
page?: PackageDocPage;
|
|
2081
2100
|
}
|
|
2082
2101
|
interface PackageIntelligenceService {
|
|
2083
|
-
packageSummary(params: PackageSummaryParams): Promise<PackageSummary>;
|
|
2084
|
-
packageVulnerabilities(params: PackageVulnerabilitiesParams): Promise<VulnerabilityReport>;
|
|
2085
|
-
packageDependencies(params: PackageDependenciesParams): Promise<DependencyReport>;
|
|
2086
|
-
packageUpgradeDependencyProbe(params: PackageUpgradeDependencyProbeParams): Promise<DependencyReport>;
|
|
2087
|
-
packageUpgradeReview(params: PackageUpgradeReviewParams): Promise<PackageUpgradeReviewResponse>;
|
|
2088
|
-
packageChangelog(params: PackageChangelogParams): Promise<ChangelogReport>;
|
|
2089
|
-
listPackageDocs(params: ListPackageDocsParams): Promise<PackageDocsList>;
|
|
2090
|
-
readPackageDoc(params: ReadPackageDocParams): Promise<PackageDocResult>;
|
|
2102
|
+
packageSummary(params: PackageSummaryParams, options?: ServiceRequestOptions): Promise<PackageSummary>;
|
|
2103
|
+
packageVulnerabilities(params: PackageVulnerabilitiesParams, options?: ServiceRequestOptions): Promise<VulnerabilityReport>;
|
|
2104
|
+
packageDependencies(params: PackageDependenciesParams, options?: ServiceRequestOptions): Promise<DependencyReport>;
|
|
2105
|
+
packageUpgradeDependencyProbe(params: PackageUpgradeDependencyProbeParams, options?: ServiceRequestOptions): Promise<DependencyReport>;
|
|
2106
|
+
packageUpgradeReview(params: PackageUpgradeReviewParams, options?: ServiceRequestOptions): Promise<PackageUpgradeReviewResponse>;
|
|
2107
|
+
packageChangelog(params: PackageChangelogParams, options?: ServiceRequestOptions): Promise<ChangelogReport>;
|
|
2108
|
+
listPackageDocs(params: ListPackageDocsParams, options?: ServiceRequestOptions): Promise<PackageDocsList>;
|
|
2109
|
+
readPackageDoc(params: ReadPackageDocParams, options?: ServiceRequestOptions): Promise<PackageDocResult>;
|
|
2091
2110
|
}
|
|
2092
2111
|
declare class PackageIntelligenceServiceImpl implements PackageIntelligenceService {
|
|
2093
2112
|
private readonly endpointUrl;
|
|
@@ -2100,21 +2119,21 @@ declare class PackageIntelligenceServiceImpl implements PackageIntelligenceServi
|
|
|
2100
2119
|
clientVersion?: string;
|
|
2101
2120
|
diagnostics?: ServiceDiagnostics;
|
|
2102
2121
|
});
|
|
2103
|
-
packageSummary(params: PackageSummaryParams): Promise<PackageSummary>;
|
|
2122
|
+
packageSummary(params: PackageSummaryParams, options?: ServiceRequestOptions): Promise<PackageSummary>;
|
|
2104
2123
|
private executePackageSummary;
|
|
2105
2124
|
private createHttpError;
|
|
2106
2125
|
private createTransportError;
|
|
2107
2126
|
private createGraphQLError;
|
|
2108
2127
|
private normalise;
|
|
2109
|
-
packageVulnerabilities(params: PackageVulnerabilitiesParams): Promise<VulnerabilityReport>;
|
|
2128
|
+
packageVulnerabilities(params: PackageVulnerabilitiesParams, options?: ServiceRequestOptions): Promise<VulnerabilityReport>;
|
|
2110
2129
|
private executePackageVulnerabilities;
|
|
2111
2130
|
private fetchPackageVulnerabilitiesPage;
|
|
2112
2131
|
private normaliseVulnerabilityReport;
|
|
2113
2132
|
private fetchTransitiveVulnerabilityAudit;
|
|
2114
2133
|
private normaliseTransitiveVulnerabilityAudit;
|
|
2115
|
-
packageDependencies(params: PackageDependenciesParams): Promise<DependencyReport>;
|
|
2116
|
-
packageUpgradeDependencyProbe(params: PackageUpgradeDependencyProbeParams): Promise<DependencyReport>;
|
|
2117
|
-
packageUpgradeReview(params: PackageUpgradeReviewParams): Promise<PackageUpgradeReviewResponse>;
|
|
2134
|
+
packageDependencies(params: PackageDependenciesParams, options?: ServiceRequestOptions): Promise<DependencyReport>;
|
|
2135
|
+
packageUpgradeDependencyProbe(params: PackageUpgradeDependencyProbeParams, options?: ServiceRequestOptions): Promise<DependencyReport>;
|
|
2136
|
+
packageUpgradeReview(params: PackageUpgradeReviewParams, options?: ServiceRequestOptions): Promise<PackageUpgradeReviewResponse>;
|
|
2118
2137
|
private executePackageUpgradeReview;
|
|
2119
2138
|
private fetchUpgradeStatementPage;
|
|
2120
2139
|
private executePackageUpgradeDependencyProbe;
|
|
@@ -2124,13 +2143,13 @@ declare class PackageIntelligenceServiceImpl implements PackageIntelligenceServi
|
|
|
2124
2143
|
private normaliseVulnerabilitySummaryDetail;
|
|
2125
2144
|
private normaliseTransitiveAuditAdvisory;
|
|
2126
2145
|
private normaliseDependencyIssuesSummary;
|
|
2127
|
-
packageChangelog(params: PackageChangelogParams): Promise<ChangelogReport>;
|
|
2146
|
+
packageChangelog(params: PackageChangelogParams, options?: ServiceRequestOptions): Promise<ChangelogReport>;
|
|
2128
2147
|
private executePackageChangelog;
|
|
2129
2148
|
private fetchPackageChangelogPage;
|
|
2130
|
-
listPackageDocs(params: ListPackageDocsParams): Promise<PackageDocsList>;
|
|
2149
|
+
listPackageDocs(params: ListPackageDocsParams, options?: ServiceRequestOptions): Promise<PackageDocsList>;
|
|
2131
2150
|
private executeListPackageDocs;
|
|
2132
2151
|
private normalisePackageDocsList;
|
|
2133
|
-
readPackageDoc(params: ReadPackageDocParams): Promise<PackageDocResult>;
|
|
2152
|
+
readPackageDoc(params: ReadPackageDocParams, options?: ServiceRequestOptions): Promise<PackageDocResult>;
|
|
2134
2153
|
private executeReadPackageDoc;
|
|
2135
2154
|
}
|
|
2136
2155
|
interface ReadParams {
|
|
@@ -2182,7 +2201,7 @@ interface ReadSymbolResolutionResult {
|
|
|
2182
2201
|
}
|
|
2183
2202
|
type ReadResult = ReadCodeResult | ReadDocsResult | ReadSymbolResolutionResult;
|
|
2184
2203
|
interface ReadService {
|
|
2185
|
-
read(params: ReadParams): Promise<ReadResult>;
|
|
2204
|
+
read(params: ReadParams, options?: ServiceRequestOptions): Promise<ReadResult>;
|
|
2186
2205
|
}
|
|
2187
2206
|
interface ReadServiceRuntime {
|
|
2188
2207
|
clientHeaders?: ClientHeaderBuilder;
|
|
@@ -2197,7 +2216,7 @@ declare class ReadServiceImpl implements ReadService {
|
|
|
2197
2216
|
private readonly fetchFn;
|
|
2198
2217
|
private readonly runtime;
|
|
2199
2218
|
constructor(endpointUrl: string, tokenProvider: TokenProvider, fetchFn?: typeof fetch, runtime?: ReadServiceRuntime);
|
|
2200
|
-
read(params: ReadParams): Promise<ReadResult>;
|
|
2219
|
+
read(params: ReadParams, options?: ServiceRequestOptions): Promise<ReadResult>;
|
|
2201
2220
|
private executeRead;
|
|
2202
2221
|
}
|
|
2203
2222
|
/**
|
|
@@ -2296,7 +2315,7 @@ interface ResolveTargetResult {
|
|
|
2296
2315
|
ambiguousReason: string;
|
|
2297
2316
|
}
|
|
2298
2317
|
interface ResolveTargetService {
|
|
2299
|
-
resolveTarget(params: ResolveTargetParams): Promise<ResolveTargetResult>;
|
|
2318
|
+
resolveTarget(params: ResolveTargetParams, options?: ServiceRequestOptions): Promise<ResolveTargetResult>;
|
|
2300
2319
|
}
|
|
2301
2320
|
declare class ResolveTargetServiceImpl implements ResolveTargetService {
|
|
2302
2321
|
private readonly endpointUrl;
|
|
@@ -2309,7 +2328,7 @@ declare class ResolveTargetServiceImpl implements ResolveTargetService {
|
|
|
2309
2328
|
clientVersion?: string;
|
|
2310
2329
|
diagnostics?: ServiceDiagnostics;
|
|
2311
2330
|
});
|
|
2312
|
-
resolveTarget(params: ResolveTargetParams): Promise<ResolveTargetResult>;
|
|
2331
|
+
resolveTarget(params: ResolveTargetParams, options?: ServiceRequestOptions): Promise<ResolveTargetResult>;
|
|
2313
2332
|
private executeResolveTarget;
|
|
2314
2333
|
}
|
|
2315
|
-
export { AGENTIC_ASK_REQUEST_TIMEOUT_MS, AgentInfo, AgenticAskRateLimitScope, AgenticAskRequest, AgenticAskRequestOptions, AgenticAskResponse, AgenticAskService, AgenticAskServiceImpl, AgenticAskServiceRuntimeOptions, CodeDiffError, CodeDiffErrorDetails, CodeDiffErrorRef, CodeDiffMode, CodeDiffOptions, CodeDiffPackageInfo, CodeDiffPackageTarget, CodeDiffParams, CodeDiffPartialResult, CodeDiffRefKind, CodeDiffRefResolution, CodeDiffRepositoryTarget, CodeDiffResult, CodeDiffService, CodeDiffTarget, CodeDiffVersionSource, CodeNavigationService, CodeNavigationServiceImpl, CodeSymbolCandidate, CodeSymbolResolution, CodeSymbolSuggestion, ContentModification, ContentSafety, DEFAULT_API_URL, DEFAULT_CODE_NAV_URL, DEFAULT_MCP_URL, DiscoveryIndexingEstimate, GitHitsService, GitHitsServiceImpl, GrepAccessError, GrepBackendError, GrepContentSafety, GrepCorpus, GrepFileIssue, GrepGraphQLError, GrepHit, GrepLineSlice, GrepNetworkError, GrepParams, GrepPathSelector, GrepReadAction, GrepReadiness, GrepRepositoryHit, GrepResult, GrepService, GrepServiceImpl, GrepSiteHit, GrepTarget, GrepTargetStatus, GrepTraversal, GrepUnavailableTarget, IndexingDurationEstimate, KnownLatestVersionMaliciousStatus, KnownMaliciousAdvisoryClassificationReason, LatestVersionMaliciousStatus, ListAccessError, ListAction, ListAvailableVersion, ListBackendError, ListBrowseAction, ListEntry, ListEntryKind, ListFileIntent, ListGraphQLError, ListIndexingEstimate, ListInventoryKind, ListNetworkError, ListParams, ListReadAction, ListResolution, ListResult, ListService, ListServiceImpl, ListSiteJob, ListSitePreparation, ListSiteWait, ListSiteWaitOutcome, ListTargetIdentity, ListTargetResolution, MalformedGrepResponseError, MalformedListResponseError, MaliciousAdvisoryClassificationReason, PKGSEER_REGISTRY_LIST, PackageIntelligenceService, PackageIntelligenceServiceImpl, RawCodeDiff, RawCodeDiffContentCoverage, RawCodeDiffContentFailure, RawCodeDiffFile, RawCodeDiffFileContentStatus, RawCodeDiffFileStatus, RawCodeDiffPathEncoding, RawCodeDiffScope, RawCodeDiffScopeStatus, RawCodeDiffSummary, ReadCodeResult, ReadDocsResult, ReadParams, ReadResult, ReadService, ReadServiceImpl, ReadSymbolResolutionResult, ReadTarget, RefreshingGitHitsService, ResolveTargetKind, ResolveTargetLatestVersionMaliciousAdvisory, ResolveTargetLatestVersionMaliciousEvidence, ResolveTargetMatch, ResolveTargetParams, ResolveTargetReference, ResolveTargetResult, ResolveTargetService, ResolveTargetServiceImpl, ResolveTargetTarget, ServiceDiagnostics, SessionIdConfigError, TokenProvider, createClientHeaderBuilder, createStaticTokenProvider, getApiUrl, getCodeNavigationUrl, getEnvApiToken, getEnvSessionId, getMcpUrl, toPkgseerRegistry, toPkgseerRegistryLowercase };
|
|
2334
|
+
export { AGENTIC_ASK_REQUEST_TIMEOUT_MS, AgentInfo, AgenticAskRateLimitScope, AgenticAskRequest, AgenticAskRequestOptions, AgenticAskResponse, AgenticAskService, AgenticAskServiceImpl, AgenticAskServiceRuntimeOptions, CodeDiffError, CodeDiffErrorDetails, CodeDiffErrorRef, CodeDiffMode, CodeDiffOptions, CodeDiffPackageInfo, CodeDiffPackageTarget, CodeDiffParams, CodeDiffPartialResult, CodeDiffRefKind, CodeDiffRefResolution, CodeDiffRepositoryTarget, CodeDiffResult, CodeDiffService, CodeDiffTarget, CodeDiffVersionSource, CodeNavigationService, CodeNavigationServiceImpl, CodeSymbolCandidate, CodeSymbolResolution, CodeSymbolSuggestion, ContentModification, ContentSafety, DEFAULT_API_URL, DEFAULT_CODE_NAV_URL, DEFAULT_MCP_URL, DiscoveryIndexingEstimate, GitHitsService, GitHitsServiceImpl, GrepAccessError, GrepBackendError, GrepContentSafety, GrepCorpus, GrepFileIssue, GrepGraphQLError, GrepHit, GrepLineSlice, GrepNetworkError, GrepParams, GrepPathSelector, GrepReadAction, GrepReadiness, GrepRepositoryHit, GrepResult, GrepService, GrepServiceImpl, GrepSiteHit, GrepTarget, GrepTargetStatus, GrepTraversal, GrepUnavailableTarget, IndexingDurationEstimate, KnownLatestVersionMaliciousStatus, KnownMaliciousAdvisoryClassificationReason, LatestVersionMaliciousStatus, ListAccessError, ListAction, ListAvailableVersion, ListBackendError, ListBrowseAction, ListEntry, ListEntryKind, ListFileIntent, ListGraphQLError, ListIndexingEstimate, ListInventoryKind, ListNetworkError, ListParams, ListReadAction, ListResolution, ListResult, ListService, ListServiceImpl, ListSiteJob, ListSitePreparation, ListSiteWait, ListSiteWaitOutcome, ListTargetIdentity, ListTargetResolution, MalformedGrepResponseError, MalformedListResponseError, MaliciousAdvisoryClassificationReason, PKGSEER_REGISTRY_LIST, PackageIntelligenceService, PackageIntelligenceServiceImpl, RawCodeDiff, RawCodeDiffContentCoverage, RawCodeDiffContentFailure, RawCodeDiffFile, RawCodeDiffFileContentStatus, RawCodeDiffFileStatus, RawCodeDiffPathEncoding, RawCodeDiffScope, RawCodeDiffScopeStatus, RawCodeDiffSummary, ReadCodeResult, ReadDocsResult, ReadParams, ReadResult, ReadService, ReadServiceImpl, ReadSymbolResolutionResult, ReadTarget, RefreshingGitHitsService, RegistryRepository, ResolveTargetKind, ResolveTargetLatestVersionMaliciousAdvisory, ResolveTargetLatestVersionMaliciousEvidence, ResolveTargetMatch, ResolveTargetParams, ResolveTargetReference, ResolveTargetResult, ResolveTargetService, ResolveTargetServiceImpl, ResolveTargetTarget, ServiceDiagnostics, ServiceRequestOptions, SessionIdConfigError, TokenProvider, createClientHeaderBuilder, createStaticTokenProvider, getApiUrl, getCodeNavigationUrl, getEnvApiToken, getEnvSessionId, getMcpUrl, toPkgseerRegistry, toPkgseerRegistryLowercase };
|
package/dist/client.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{GrepGraphQLError2,GrepBackendError2,GrepAccessError2,GrepNetworkError2,MalformedGrepResponseError2,GrepServiceImpl2,ListAccessError2,ListGraphQLError2,ListBackendError2,ListNetworkError2,MalformedListResponseError2,ListServiceImpl2,ReadServiceImpl2,RefreshingGitHitsService2,ResolveTargetServiceImpl2,createStaticTokenProvider2,SessionIdConfigError2,getEnvSessionId2,createClientHeaderBuilder2}from"./shared/chunk-
|
|
1
|
+
import{GrepGraphQLError2,GrepBackendError2,GrepAccessError2,GrepNetworkError2,MalformedGrepResponseError2,GrepServiceImpl2,ListAccessError2,ListGraphQLError2,ListBackendError2,ListNetworkError2,MalformedListResponseError2,ListServiceImpl2,ReadServiceImpl2,RefreshingGitHitsService2,ResolveTargetServiceImpl2,createStaticTokenProvider2,SessionIdConfigError2,getEnvSessionId2,createClientHeaderBuilder2}from"./shared/chunk-0sd6v5ad.js";import{DEFAULT_MCP_URL2,DEFAULT_API_URL2,DEFAULT_CODE_NAV_URL2,getMcpUrl2,getApiUrl2,getCodeNavigationUrl2,getEnvApiToken2,GitHitsServiceImpl2,AGENTIC_ASK_REQUEST_TIMEOUT_MS2,AgenticAskServiceImpl2,PKGSEER_REGISTRY_LIST2,toPkgseerRegistry2,toPkgseerRegistryLowercase2,CodeDiffError2,CodeNavigationServiceImpl2,PackageIntelligenceServiceImpl2}from"./shared/chunk-0ch431yh.js";export{AGENTIC_ASK_REQUEST_TIMEOUT_MS2 as AGENTIC_ASK_REQUEST_TIMEOUT_MS,AgenticAskServiceImpl2 as AgenticAskServiceImpl,CodeDiffError2 as CodeDiffError,CodeNavigationServiceImpl2 as CodeNavigationServiceImpl,DEFAULT_API_URL2 as DEFAULT_API_URL,DEFAULT_CODE_NAV_URL2 as DEFAULT_CODE_NAV_URL,DEFAULT_MCP_URL2 as DEFAULT_MCP_URL,GitHitsServiceImpl2 as GitHitsServiceImpl,GrepAccessError2 as GrepAccessError,GrepBackendError2 as GrepBackendError,GrepGraphQLError2 as GrepGraphQLError,GrepNetworkError2 as GrepNetworkError,GrepServiceImpl2 as GrepServiceImpl,ListAccessError2 as ListAccessError,ListBackendError2 as ListBackendError,ListGraphQLError2 as ListGraphQLError,ListNetworkError2 as ListNetworkError,ListServiceImpl2 as ListServiceImpl,MalformedGrepResponseError2 as MalformedGrepResponseError,MalformedListResponseError2 as MalformedListResponseError,PKGSEER_REGISTRY_LIST2 as PKGSEER_REGISTRY_LIST,PackageIntelligenceServiceImpl2 as PackageIntelligenceServiceImpl,ReadServiceImpl2 as ReadServiceImpl,RefreshingGitHitsService2 as RefreshingGitHitsService,ResolveTargetServiceImpl2 as ResolveTargetServiceImpl,SessionIdConfigError2 as SessionIdConfigError,createClientHeaderBuilder2 as createClientHeaderBuilder,createStaticTokenProvider2 as createStaticTokenProvider,getApiUrl2 as getApiUrl,getCodeNavigationUrl2 as getCodeNavigationUrl,getEnvApiToken2 as getEnvApiToken,getEnvSessionId2 as getEnvSessionId,getMcpUrl2 as getMcpUrl,toPkgseerRegistry2 as toPkgseerRegistry,toPkgseerRegistryLowercase2 as toPkgseerRegistryLowercase};
|
package/dist/index.d.ts
CHANGED
|
@@ -85,6 +85,17 @@ interface ReadTarget {
|
|
|
85
85
|
endLine?: number;
|
|
86
86
|
}
|
|
87
87
|
/**
|
|
88
|
+
* Optional per-call controls shared by network-backed service methods.
|
|
89
|
+
*
|
|
90
|
+
* `signal` is the caller's cancellation signal, such as an MCP request
|
|
91
|
+
* cancellation. Services combine it with their own request deadline: a caller
|
|
92
|
+
* abort rejects with the signal's reason and is never retried, while an
|
|
93
|
+
* internal deadline keeps each service's timeout error mapping.
|
|
94
|
+
*/
|
|
95
|
+
interface ServiceRequestOptions {
|
|
96
|
+
signal?: AbortSignal;
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
88
99
|
* Back-compat alias — the canonical registry union now lives in
|
|
89
100
|
* `src/shared/pkgseer-registry.ts`. Re-exported here so existing
|
|
90
101
|
* consumers of `CodeNavigationRegistry` compile unchanged.
|
|
@@ -723,7 +734,7 @@ interface CodeNavigationService {
|
|
|
723
734
|
}
|
|
724
735
|
/** Additive client capability for the unpromoted CodeDiff surface. */
|
|
725
736
|
interface CodeDiffService {
|
|
726
|
-
codeDiff(params: CodeDiffParams): Promise<CodeDiffResult>;
|
|
737
|
+
codeDiff(params: CodeDiffParams, options?: ServiceRequestOptions): Promise<CodeDiffResult>;
|
|
727
738
|
}
|
|
728
739
|
/**
|
|
729
740
|
* Parameters for search API call.
|
|
@@ -871,7 +882,7 @@ interface GrepResult {
|
|
|
871
882
|
totalMatches: number;
|
|
872
883
|
}
|
|
873
884
|
interface GrepService {
|
|
874
|
-
grep(params: GrepParams): Promise<GrepResult>;
|
|
885
|
+
grep(params: GrepParams, options?: ServiceRequestOptions): Promise<GrepResult>;
|
|
875
886
|
}
|
|
876
887
|
type ListFileIntent = "PRODUCTION" | "TEST" | "BENCHMARK" | "EXAMPLE" | "GENERATED" | "FIXTURE" | "BUILD" | "VENDOR";
|
|
877
888
|
interface ListParams {
|
|
@@ -988,7 +999,7 @@ interface ListResult {
|
|
|
988
999
|
preparation: ListSitePreparation | null;
|
|
989
1000
|
}
|
|
990
1001
|
interface ListService {
|
|
991
|
-
list(params: ListParams): Promise<ListResult>;
|
|
1002
|
+
list(params: ListParams, options?: ServiceRequestOptions): Promise<ListResult>;
|
|
992
1003
|
}
|
|
993
1004
|
interface PackageSummaryParams {
|
|
994
1005
|
registry: PkgseerRegistry;
|
|
@@ -996,6 +1007,12 @@ interface PackageSummaryParams {
|
|
|
996
1007
|
/** Include verbose/json-only fields such as recent advisories and changes. */
|
|
997
1008
|
includeVerboseFields?: boolean;
|
|
998
1009
|
}
|
|
1010
|
+
/** Logical artifact repository that supplied validated release metadata. */
|
|
1011
|
+
interface RegistryRepository {
|
|
1012
|
+
id: string;
|
|
1013
|
+
name: string;
|
|
1014
|
+
url: string;
|
|
1015
|
+
}
|
|
999
1016
|
interface PackageIdentity {
|
|
1000
1017
|
name: string;
|
|
1001
1018
|
registry?: string;
|
|
@@ -1010,6 +1027,7 @@ interface PackageIdentity {
|
|
|
1010
1027
|
versionCount?: number;
|
|
1011
1028
|
downloadsRefreshedAt?: string;
|
|
1012
1029
|
githubRepository?: GithubRepository;
|
|
1030
|
+
registryRepository?: RegistryRepository;
|
|
1013
1031
|
}
|
|
1014
1032
|
interface GithubRepository {
|
|
1015
1033
|
stargazersCount?: number;
|
|
@@ -1066,6 +1084,7 @@ interface PackageVersionIdentity {
|
|
|
1066
1084
|
publishedAt?: string;
|
|
1067
1085
|
deprecated?: boolean;
|
|
1068
1086
|
deprecationReason?: string;
|
|
1087
|
+
registryRepository?: RegistryRepository;
|
|
1069
1088
|
}
|
|
1070
1089
|
interface VulnerabilityDetail {
|
|
1071
1090
|
osvId?: string;
|
|
@@ -1751,14 +1770,14 @@ interface PackageDocResult {
|
|
|
1751
1770
|
page?: PackageDocPage;
|
|
1752
1771
|
}
|
|
1753
1772
|
interface PackageIntelligenceService {
|
|
1754
|
-
packageSummary(params: PackageSummaryParams): Promise<PackageSummary>;
|
|
1755
|
-
packageVulnerabilities(params: PackageVulnerabilitiesParams): Promise<VulnerabilityReport>;
|
|
1756
|
-
packageDependencies(params: PackageDependenciesParams): Promise<DependencyReport>;
|
|
1757
|
-
packageUpgradeDependencyProbe(params: PackageUpgradeDependencyProbeParams): Promise<DependencyReport>;
|
|
1758
|
-
packageUpgradeReview(params: PackageUpgradeReviewParams): Promise<PackageUpgradeReviewResponse>;
|
|
1759
|
-
packageChangelog(params: PackageChangelogParams): Promise<ChangelogReport>;
|
|
1760
|
-
listPackageDocs(params: ListPackageDocsParams): Promise<PackageDocsList>;
|
|
1761
|
-
readPackageDoc(params: ReadPackageDocParams): Promise<PackageDocResult>;
|
|
1773
|
+
packageSummary(params: PackageSummaryParams, options?: ServiceRequestOptions): Promise<PackageSummary>;
|
|
1774
|
+
packageVulnerabilities(params: PackageVulnerabilitiesParams, options?: ServiceRequestOptions): Promise<VulnerabilityReport>;
|
|
1775
|
+
packageDependencies(params: PackageDependenciesParams, options?: ServiceRequestOptions): Promise<DependencyReport>;
|
|
1776
|
+
packageUpgradeDependencyProbe(params: PackageUpgradeDependencyProbeParams, options?: ServiceRequestOptions): Promise<DependencyReport>;
|
|
1777
|
+
packageUpgradeReview(params: PackageUpgradeReviewParams, options?: ServiceRequestOptions): Promise<PackageUpgradeReviewResponse>;
|
|
1778
|
+
packageChangelog(params: PackageChangelogParams, options?: ServiceRequestOptions): Promise<ChangelogReport>;
|
|
1779
|
+
listPackageDocs(params: ListPackageDocsParams, options?: ServiceRequestOptions): Promise<PackageDocsList>;
|
|
1780
|
+
readPackageDoc(params: ReadPackageDocParams, options?: ServiceRequestOptions): Promise<PackageDocResult>;
|
|
1762
1781
|
}
|
|
1763
1782
|
interface ReadParams {
|
|
1764
1783
|
target: string;
|
|
@@ -1809,7 +1828,7 @@ interface ReadSymbolResolutionResult {
|
|
|
1809
1828
|
}
|
|
1810
1829
|
type ReadResult = ReadCodeResult | ReadDocsResult | ReadSymbolResolutionResult;
|
|
1811
1830
|
interface ReadService {
|
|
1812
|
-
read(params: ReadParams): Promise<ReadResult>;
|
|
1831
|
+
read(params: ReadParams, options?: ServiceRequestOptions): Promise<ReadResult>;
|
|
1813
1832
|
}
|
|
1814
1833
|
type ResolveTargetKind = "PACKAGE" | "REPOSITORY" | "SITE";
|
|
1815
1834
|
type KnownLatestVersionMaliciousStatus = "NOT_APPLICABLE" | "CLEAR" | "AFFECTED" | "UNKNOWN";
|
|
@@ -1885,7 +1904,7 @@ interface ResolveTargetResult {
|
|
|
1885
1904
|
ambiguousReason: string;
|
|
1886
1905
|
}
|
|
1887
1906
|
interface ResolveTargetService {
|
|
1888
|
-
resolveTarget(params: ResolveTargetParams): Promise<ResolveTargetResult>;
|
|
1907
|
+
resolveTarget(params: ResolveTargetParams, options?: ServiceRequestOptions): Promise<ResolveTargetResult>;
|
|
1889
1908
|
}
|
|
1890
1909
|
import { z as z3 } from "zod";
|
|
1891
1910
|
/** Annotation fields required by OpenAI's MCP marketplace validation. */
|