@nvisy/sdk 0.33.0 → 0.35.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/CHANGELOG.md +76 -1
- package/dist/auth/index.d.ts +2 -2
- package/dist/auth/index.js +1 -1
- package/dist/{client-CULULKFQ.d.ts → client-jMgO90LH.d.ts} +140 -109
- package/dist/client-jMgO90LH.d.ts.map +1 -0
- package/dist/{config-BwallLvT.d.ts → config-BhUEqFOg.d.ts} +5 -4
- package/dist/config-BhUEqFOg.d.ts.map +1 -0
- package/dist/datatypes/index.d.ts +2 -2
- package/dist/{error-C_RvXw4Z.js → error-D4r5BMhi.js} +8 -12
- package/dist/error-D4r5BMhi.js.map +1 -0
- package/dist/{errors-BZvRatQn.d.ts → errors-Anm66raZ.d.ts} +2 -2
- package/dist/{errors-BZvRatQn.d.ts.map → errors-Anm66raZ.d.ts.map} +1 -1
- package/dist/{index-0_K3HaXB.d.ts → index-BPKkfko3.d.ts} +2177 -1431
- package/dist/index-BPKkfko3.d.ts.map +1 -0
- package/dist/index.d.ts +4 -4
- package/dist/index.js +11 -5
- package/dist/index.js.map +1 -1
- package/dist/services/index.d.ts +2 -2
- package/dist/services/index.js +2 -2
- package/dist/{services-CTpA4P73.js → services-Dr7H1ECH.js} +214 -164
- package/dist/services-Dr7H1ECH.js.map +1 -0
- package/dist/webhooks/index.d.ts +2 -2
- package/package.json +3 -3
- package/dist/client-CULULKFQ.d.ts.map +0 -1
- package/dist/config-BwallLvT.d.ts.map +0 -1
- package/dist/error-C_RvXw4Z.js.map +0 -1
- package/dist/index-0_K3HaXB.d.ts.map +0 -1
- package/dist/services-CTpA4P73.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -8,6 +8,79 @@ and this project adheres to
|
|
|
8
8
|
|
|
9
9
|
## [Unreleased]
|
|
10
10
|
|
|
11
|
+
## [0.35.0] - 2026-08-26
|
|
12
|
+
|
|
13
|
+
The platform renamed the core "pipeline run" concept to "detection" and made
|
|
14
|
+
redaction an independent resource. This release renames the SDK to match.
|
|
15
|
+
|
|
16
|
+
### Added
|
|
17
|
+
|
|
18
|
+
- `nvisy.detections` service (replaces `nvisy.runs`): `listDetections`,
|
|
19
|
+
`listPipelineDetections`, `createDetection`, `getDetection`, `getAnalysis`
|
|
20
|
+
(the audit), `downloadAudit`, `events` / `streamEvents` (SSE), plus
|
|
21
|
+
`listRedactions` and `createRedaction`
|
|
22
|
+
- `nvisy.redactions` service, parallel to detections: `getReview`
|
|
23
|
+
- Detection datatypes (`Detection`, `CreateDetection`, `DetectionPage`,
|
|
24
|
+
`DetectionStatus`, `DetectionId`, `DetectionMetadata`, `DetectionStatusEvent`,
|
|
25
|
+
`PipelineDetectionsQuery`) and redaction datatypes (`RedactDetection`,
|
|
26
|
+
`RedactionId`, `RedactionResult`, `RedactionResultPage`)
|
|
27
|
+
|
|
28
|
+
### Changed
|
|
29
|
+
|
|
30
|
+
- Regenerated the API schema against the updated platform handlers
|
|
31
|
+
- **Breaking:** `nvisy.runs` is renamed to `nvisy.detections`; its methods are
|
|
32
|
+
renamed accordingly (`createRun` → `createDetection`, `getRun` →
|
|
33
|
+
`getDetection`, `getDetections` → `getAnalysis`, `redact` →
|
|
34
|
+
`createRedaction`, `listRuns` / `listPipelineRuns` → `listDetections` /
|
|
35
|
+
`listPipelineDetections`)
|
|
36
|
+
- **Breaking:** `analytics.getRunTimeSeries()` is renamed to
|
|
37
|
+
`analytics.getDetectionTimeSeries()`
|
|
38
|
+
- **Breaking:** the run analytics, notification-payload, and activity datatypes
|
|
39
|
+
are renamed to their detection/redaction equivalents (`RunAnalytics` →
|
|
40
|
+
`DetectionAnalytics`, `RunTimeSeries` → `DetectionTimeSeries`,
|
|
41
|
+
`PipelineRun*Params` → `Detection*Params` / `Redaction*Params`, etc.)
|
|
42
|
+
|
|
43
|
+
### Removed
|
|
44
|
+
|
|
45
|
+
- **Breaking:** the `PipelineRun*` / `Run*` datatypes (`PipelineRun`,
|
|
46
|
+
`CreatePipelineRun`, `PipelineRunPage`, `PipelineRunStatus`,
|
|
47
|
+
`PipelineRunsQuery`, `RunId`, `RunMetadata`, `RunStatusEvent`), and the
|
|
48
|
+
per-modality `*Redact` audit-event datatypes (`TextRedact`, `ImageRedact`,
|
|
49
|
+
`AudioRedact`, `TabularRedact`) — the platform no longer exposes them
|
|
50
|
+
|
|
51
|
+
## [0.34.0] - 2026-08-18
|
|
52
|
+
|
|
53
|
+
### Added
|
|
54
|
+
|
|
55
|
+
- The redesigned detection-result model reachable from `Audit`: the document
|
|
56
|
+
container (`DocumentContext`, `CodecParams`, `Report`), reviewer edits
|
|
57
|
+
(`EditSet`), the redaction decision (`Redaction`, `Selection`, `Suppress`,
|
|
58
|
+
`ManualIntent`), attribution rationales (`CitedAttribution`,
|
|
59
|
+
`FreeformAttribution`), reconciliation events (`Conflict`, `Contested`,
|
|
60
|
+
`Deduplication`, `Calibration`), and the per-modality event kinds for text,
|
|
61
|
+
image, audio, and tabular content (`*Model`, `*Pattern`, `*Manual`, `*Edit`,
|
|
62
|
+
`*Add`, `*Redact`, `*Refinement`, `*Retag`)
|
|
63
|
+
|
|
64
|
+
### Changed
|
|
65
|
+
|
|
66
|
+
- Regenerated the API schema against the updated platform handlers
|
|
67
|
+
- The default user-agent version is now injected from `package.json` at build
|
|
68
|
+
time, so it always matches the published version (previously a hand-maintained
|
|
69
|
+
constant that had drifted)
|
|
70
|
+
- **Breaking:** the `Audit` datatype is now exported from the audit module
|
|
71
|
+
(unchanged import path via the package root and `@nvisy/sdk/datatypes`)
|
|
72
|
+
- **Breaking:** the activity feed's query datatypes are renamed —
|
|
73
|
+
`ActivityListQuery` → `ActivityFilterQuery` and `ActivityExportQuery` →
|
|
74
|
+
`ActivityExportOptions` — now composed with the date window and pagination by
|
|
75
|
+
`listActivities()` / `exportActivities()`
|
|
76
|
+
|
|
77
|
+
### Removed
|
|
78
|
+
|
|
79
|
+
- **Breaking:** detection-model datatypes the platform no longer exposes:
|
|
80
|
+
`EntityGroup`, `AuditContext`, `AttributionKind`, `Review`, the per-modality
|
|
81
|
+
`*EntityRecord` types (`TextEntityRecord`, `ImageEntityRecord`,
|
|
82
|
+
`AudioEntityRecord`, `TabularEntityRecord`), and `ScopeParams`
|
|
83
|
+
|
|
11
84
|
## [0.33.0] - 2026-08-18
|
|
12
85
|
|
|
13
86
|
### Added
|
|
@@ -687,7 +760,9 @@ and this project adheres to
|
|
|
687
760
|
- Network error handling for timeouts, DNS resolution, and connection issues
|
|
688
761
|
- Configuration validation with detailed error messages
|
|
689
762
|
|
|
690
|
-
[Unreleased]: https://github.com/nvisycom/sdk-ts/compare/v0.
|
|
763
|
+
[Unreleased]: https://github.com/nvisycom/sdk-ts/compare/v0.35.0...HEAD
|
|
764
|
+
[0.35.0]: https://github.com/nvisycom/sdk-ts/compare/v0.34.0...v0.35.0
|
|
765
|
+
[0.34.0]: https://github.com/nvisycom/sdk-ts/compare/v0.33.0...v0.34.0
|
|
691
766
|
[0.33.0]: https://github.com/nvisycom/sdk-ts/compare/v0.32.0...v0.33.0
|
|
692
767
|
[0.32.0]: https://github.com/nvisycom/sdk-ts/compare/v0.31.0...v0.32.0
|
|
693
768
|
[0.31.0]: https://github.com/nvisycom/sdk-ts/compare/v0.30.0...v0.31.0
|
package/dist/auth/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { t as ClientConfig } from "../config-
|
|
2
|
-
import {
|
|
1
|
+
import { t as ClientConfig } from "../config-BhUEqFOg.js";
|
|
2
|
+
import { dr as Signup, lr as AuthToken, ur as Login } from "../index-BPKkfko3.js";
|
|
3
3
|
//#region src/auth/config.d.ts
|
|
4
4
|
/**
|
|
5
5
|
* Configuration options for standalone authentication functions.
|
package/dist/auth/index.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { t as ClientConfig } from "./config-
|
|
2
|
-
import { $n as
|
|
1
|
+
import { t as ClientConfig } from "./config-BhUEqFOg.js";
|
|
2
|
+
import { $n as ChatMessage, $t as ReplyInvite, Aa as Account$1, At as NotificationPage, Cn as PipelineDetectionsQuery, Dn as RedactionResultPage, Dr as Audit, En as RedactionResult, Fa as UpdateAccount, Fn as ConnectionSync, Ft as UnreadStatus, Gn as SyncConnection, Gt as InviteCode, Ht as CreateInvite, Ia as paths, In as ConnectionSyncPage, It as UpdateNotificationSettings, Jt as InvitePreview, Ki as ApiToken, Ln as ConnectionVerification, Lt as ListMembers, M as CreatePolicy, Mt as NotificationSettings, On as WorkspaceDetectionsQuery, Pa as PublicAccount, Pn as ConnectionPage, Pt as UnreadCountEvent, Qi as UpdateApiToken, Qn as UpdateConnection, Qt as ListInvites, Rt as Member, Sn as DetectionStatusEvent, Tt as MarkedReadStatus, Ut as GenerateInviteCode, Vt as UpdateMember, X as Policy, Xi as CreateApiToken, Xn as SyncStatus, Yi as ApiTokenWithJWT, Yt as InviteSent, _a as ActivityPage, _n as Detection, _t as PipelineSummaryPage, ar as SendChatMessage, bn as DetectionPage, bt as CursorPagination, c as WorkspacePage, cn as ListFiles, d as CreateWebhook, dn as DateWindow, dr as Signup, dt as CreatePipeline, f as TestWebhook, ft as Pipeline, ga as ActivityFilterQuery, gn as CreateDetection, h as WebhookCreated, ha as ActivityExportOptions, ht as PipelineStatus, in as File, ir as CreateChatSession, jn as Connection, lr as AuthToken, lt as UpdatePolicy, m as Webhook, na as DetectionTimeSeries, nn as Health, nr as ChatSessionPage, o as UpdateWorkspace, on as FilePage, or as LabelCatalog, p as UpdateWebhook, pa as WorkspaceAnalytics, pn as ExportQuery, qi as ApiTokenPage, qt as InvitePage, rr as ChatToken, s as Workspace, sr as RecognizerCatalog, t as CreateWorkspace, tr as ChatSession, tt as PolicySummaryPage, un as UpdateFile, ur as Login, v as WebhookPage, wn as RedactDetection, y as WebhookResult, yt as UpdatePipeline, zn as CreateConnection, zt as MemberPage } from "./index-BPKkfko3.js";
|
|
3
3
|
import { Client } from "openapi-fetch";
|
|
4
4
|
//#region src/services/account.d.ts
|
|
5
5
|
/**
|
|
@@ -66,39 +66,40 @@ declare class Activities {
|
|
|
66
66
|
* @returns Promise that resolves with a paginated list of activities
|
|
67
67
|
* @throws {ApiError} if the request fails
|
|
68
68
|
*/
|
|
69
|
-
listActivities(workspaceSlug: string, query?:
|
|
69
|
+
listActivities(workspaceSlug: string, query?: ActivityFilterQuery & DateWindow & CursorPagination): Promise<ActivityPage>;
|
|
70
70
|
/**
|
|
71
|
-
* Export the workspace's activity log
|
|
71
|
+
* Export the workspace's activity log as a file.
|
|
72
72
|
* @param workspaceSlug - Workspace slug
|
|
73
|
-
* @param query - Optional
|
|
73
|
+
* @param query - Optional filters (type, actor), date window (from, to), and
|
|
74
|
+
* output format (`csv` default, or `json`)
|
|
74
75
|
* @returns Promise that resolves with the file response
|
|
75
76
|
* @throws {ApiError} if the request fails
|
|
76
77
|
*/
|
|
77
|
-
exportActivities(workspaceSlug: string, query?:
|
|
78
|
+
exportActivities(workspaceSlug: string, query?: ActivityFilterQuery & DateWindow & ActivityExportOptions): Promise<Response>;
|
|
78
79
|
}
|
|
79
80
|
//#endregion
|
|
80
81
|
//#region src/services/analytics.d.ts
|
|
81
82
|
/**
|
|
82
|
-
* Service for workspace analytics: aggregate totals and
|
|
83
|
+
* Service for workspace analytics: aggregate totals and detection time series.
|
|
83
84
|
*/
|
|
84
85
|
declare class Analytics {
|
|
85
86
|
#private;
|
|
86
87
|
constructor(api: ApiClient);
|
|
87
88
|
/**
|
|
88
|
-
* Get aggregate analytics for a workspace: storage,
|
|
89
|
+
* Get aggregate analytics for a workspace: storage, detection health, usage.
|
|
89
90
|
* @param workspaceSlug - Workspace slug
|
|
90
91
|
* @returns Promise that resolves with the workspace analytics
|
|
91
92
|
* @throws {ApiError} if the request fails
|
|
92
93
|
*/
|
|
93
94
|
getAnalytics(workspaceSlug: string): Promise<WorkspaceAnalytics>;
|
|
94
95
|
/**
|
|
95
|
-
* Get a workspace's daily
|
|
96
|
+
* Get a workspace's daily detection activity over a date window.
|
|
96
97
|
* @param workspaceSlug - Workspace slug
|
|
97
98
|
* @param query - Optional date window (`from` / `to`, YYYY-MM-DD)
|
|
98
|
-
* @returns Promise that resolves with the
|
|
99
|
+
* @returns Promise that resolves with the detection time series
|
|
99
100
|
* @throws {ApiError} if the request fails
|
|
100
101
|
*/
|
|
101
|
-
|
|
102
|
+
getDetectionTimeSeries(workspaceSlug: string, query?: DateWindow): Promise<DetectionTimeSeries>;
|
|
102
103
|
}
|
|
103
104
|
//#endregion
|
|
104
105
|
//#region src/services/api-tokens.d.ts
|
|
@@ -325,6 +326,119 @@ declare class Connections {
|
|
|
325
326
|
verifyConnection(workspaceSlug: string, connectionId: string): Promise<ConnectionVerification>;
|
|
326
327
|
}
|
|
327
328
|
//#endregion
|
|
329
|
+
//#region src/services/detections.d.ts
|
|
330
|
+
/**
|
|
331
|
+
* Service for pipeline detections (one analysis pass of a file) and the
|
|
332
|
+
* redactions produced from them.
|
|
333
|
+
*/
|
|
334
|
+
declare class Detections {
|
|
335
|
+
#private;
|
|
336
|
+
constructor(api: ApiClient);
|
|
337
|
+
/**
|
|
338
|
+
* List all detections in a workspace
|
|
339
|
+
* @param workspaceSlug - Workspace slug
|
|
340
|
+
* @param query - Optional pagination and filters (status, fileId,
|
|
341
|
+
* pipelineId, triggerType, triggeredBy, limit, after)
|
|
342
|
+
* @returns Promise that resolves with a paginated list of detections
|
|
343
|
+
* @throws {ApiError} if the request fails
|
|
344
|
+
*/
|
|
345
|
+
listDetections(workspaceSlug: string, query?: CursorPagination & WorkspaceDetectionsQuery): Promise<DetectionPage>;
|
|
346
|
+
/**
|
|
347
|
+
* List detections for a specific pipeline
|
|
348
|
+
* @param workspaceSlug - Workspace slug
|
|
349
|
+
* @param pipelineSlug - Pipeline slug
|
|
350
|
+
* @param query - Optional pagination and filters (status, fileId,
|
|
351
|
+
* triggerType, triggeredBy, limit, after)
|
|
352
|
+
* @returns Promise that resolves with a paginated list of detections
|
|
353
|
+
* @throws {ApiError} if the request fails
|
|
354
|
+
*/
|
|
355
|
+
listPipelineDetections(workspaceSlug: string, pipelineSlug: string, query?: CursorPagination & PipelineDetectionsQuery): Promise<DetectionPage>;
|
|
356
|
+
/**
|
|
357
|
+
* Start a new detection over a file for a pipeline
|
|
358
|
+
* @param workspaceSlug - Workspace slug
|
|
359
|
+
* @param pipelineSlug - Pipeline slug
|
|
360
|
+
* @param detection - Detection creation request
|
|
361
|
+
* @returns Promise that resolves with the created detection
|
|
362
|
+
* @throws {ApiError} if the request fails
|
|
363
|
+
*/
|
|
364
|
+
createDetection(workspaceSlug: string, pipelineSlug: string, detection: CreateDetection): Promise<Detection>;
|
|
365
|
+
/**
|
|
366
|
+
* Get detection details by ID
|
|
367
|
+
* @param workspaceSlug - Workspace slug
|
|
368
|
+
* @param detectionId - Detection ID
|
|
369
|
+
* @returns Promise that resolves with the detection details
|
|
370
|
+
* @throws {ApiError} if the request fails
|
|
371
|
+
*/
|
|
372
|
+
getDetection(workspaceSlug: string, detectionId: string): Promise<Detection>;
|
|
373
|
+
/**
|
|
374
|
+
* Get a detection's analysis (audit)
|
|
375
|
+
* @param workspaceSlug - Workspace slug
|
|
376
|
+
* @param detectionId - Detection ID
|
|
377
|
+
* @returns Promise that resolves with the audit
|
|
378
|
+
* @throws {ApiError} if the request fails
|
|
379
|
+
*/
|
|
380
|
+
getAnalysis(workspaceSlug: string, detectionId: string): Promise<Audit>;
|
|
381
|
+
/**
|
|
382
|
+
* Download a detection's audit as a file.
|
|
383
|
+
*
|
|
384
|
+
* `format` is `csv` (default) — a zip of entities.csv, provenance.csv, and
|
|
385
|
+
* reviews.csv — or `json`, a pretty-printed JSON file.
|
|
386
|
+
*
|
|
387
|
+
* @param workspaceSlug - Workspace slug
|
|
388
|
+
* @param detectionId - Detection ID
|
|
389
|
+
* @param query - Optional output format (`csv` default, or `json`)
|
|
390
|
+
* @returns Promise that resolves with the file response
|
|
391
|
+
* @throws {ApiError} if the request fails
|
|
392
|
+
*/
|
|
393
|
+
downloadAudit(workspaceSlug: string, detectionId: string, query?: ExportQuery): Promise<Response>;
|
|
394
|
+
/**
|
|
395
|
+
* Open the raw Server-Sent Events stream of a detection's status changes.
|
|
396
|
+
*
|
|
397
|
+
* Returns the underlying `Response` so callers can handle the
|
|
398
|
+
* `text/event-stream` body themselves. Most callers want
|
|
399
|
+
* {@link streamEvents}, which parses each frame into a typed
|
|
400
|
+
* {@link DetectionStatusEvent}.
|
|
401
|
+
*
|
|
402
|
+
* @param workspaceSlug - Workspace slug
|
|
403
|
+
* @param detectionId - Detection ID
|
|
404
|
+
* @returns Promise that resolves with the event-stream response
|
|
405
|
+
* @throws {ApiError} if the request fails
|
|
406
|
+
*/
|
|
407
|
+
events(workspaceSlug: string, detectionId: string): Promise<Response>;
|
|
408
|
+
/**
|
|
409
|
+
* Stream a detection's status changes as Server-Sent Events.
|
|
410
|
+
*
|
|
411
|
+
* Yields the current status immediately, then each transition, and ends
|
|
412
|
+
* once the detection settles. Break out of the loop to close the stream
|
|
413
|
+
* early. For the raw response, use {@link events}.
|
|
414
|
+
*
|
|
415
|
+
* @param workspaceSlug - Workspace slug
|
|
416
|
+
* @param detectionId - Detection ID
|
|
417
|
+
* @yields each {@link DetectionStatusEvent} as it arrives
|
|
418
|
+
* @throws {ApiError} if the request fails to open
|
|
419
|
+
* @throws {NvisyError} if the response has no readable body
|
|
420
|
+
*/
|
|
421
|
+
streamEvents(workspaceSlug: string, detectionId: string): AsyncGenerator<DetectionStatusEvent>;
|
|
422
|
+
/**
|
|
423
|
+
* List the redactions produced from a detection
|
|
424
|
+
* @param workspaceSlug - Workspace slug
|
|
425
|
+
* @param detectionId - Detection ID
|
|
426
|
+
* @param query - Optional pagination (limit, after)
|
|
427
|
+
* @returns Promise that resolves with a paginated list of redactions
|
|
428
|
+
* @throws {ApiError} if the request fails
|
|
429
|
+
*/
|
|
430
|
+
listRedactions(workspaceSlug: string, detectionId: string, query?: CursorPagination): Promise<RedactionResultPage>;
|
|
431
|
+
/**
|
|
432
|
+
* Redact a detection, producing a redaction result
|
|
433
|
+
* @param workspaceSlug - Workspace slug
|
|
434
|
+
* @param detectionId - Detection ID
|
|
435
|
+
* @param redaction - Redaction request (optional reviewer edits)
|
|
436
|
+
* @returns Promise that resolves with the created redaction result
|
|
437
|
+
* @throws {ApiError} if the request fails
|
|
438
|
+
*/
|
|
439
|
+
createRedaction(workspaceSlug: string, detectionId: string, redaction: RedactDetection): Promise<RedactionResult>;
|
|
440
|
+
}
|
|
441
|
+
//#endregion
|
|
328
442
|
//#region src/services/files.d.ts
|
|
329
443
|
/**
|
|
330
444
|
* Service for handling file operations
|
|
@@ -658,109 +772,22 @@ declare class Policies {
|
|
|
658
772
|
deletePolicy(workspaceSlug: string, policySlug: string): Promise<void>;
|
|
659
773
|
}
|
|
660
774
|
//#endregion
|
|
661
|
-
//#region src/services/
|
|
775
|
+
//#region src/services/redactions.d.ts
|
|
662
776
|
/**
|
|
663
|
-
* Service for
|
|
777
|
+
* Service for workspace redactions, independent of the detection they came
|
|
778
|
+
* from.
|
|
664
779
|
*/
|
|
665
|
-
declare class
|
|
780
|
+
declare class Redactions {
|
|
666
781
|
#private;
|
|
667
782
|
constructor(api: ApiClient);
|
|
668
783
|
/**
|
|
669
|
-
*
|
|
670
|
-
* @param workspaceSlug - Workspace slug
|
|
671
|
-
* @param query - Optional pagination and filters (status, fileId,
|
|
672
|
-
* pipelineId, triggerType, triggeredBy, limit, after)
|
|
673
|
-
* @returns Promise that resolves with a paginated list of pipeline runs
|
|
674
|
-
* @throws {ApiError} if the request fails
|
|
675
|
-
*/
|
|
676
|
-
listRuns(workspaceSlug: string, query?: CursorPagination & PipelineRunsQuery & {
|
|
677
|
-
pipelineId?: string;
|
|
678
|
-
}): Promise<PipelineRunPage>;
|
|
679
|
-
/**
|
|
680
|
-
* List runs for a specific pipeline
|
|
681
|
-
* @param workspaceSlug - Workspace slug
|
|
682
|
-
* @param pipelineSlug - Pipeline slug
|
|
683
|
-
* @param query - Optional pagination and filters (status, fileId,
|
|
684
|
-
* triggerType, triggeredBy, limit, after)
|
|
685
|
-
* @returns Promise that resolves with a paginated list of pipeline runs
|
|
686
|
-
* @throws {ApiError} if the request fails
|
|
687
|
-
*/
|
|
688
|
-
listPipelineRuns(workspaceSlug: string, pipelineSlug: string, query?: CursorPagination & PipelineRunsQuery): Promise<PipelineRunPage>;
|
|
689
|
-
/**
|
|
690
|
-
* Trigger a new run for a pipeline
|
|
691
|
-
* @param workspaceSlug - Workspace slug
|
|
692
|
-
* @param pipelineSlug - Pipeline slug
|
|
693
|
-
* @param run - Pipeline run creation request
|
|
694
|
-
* @returns Promise that resolves with the created pipeline run
|
|
695
|
-
* @throws {ApiError} if the request fails
|
|
696
|
-
*/
|
|
697
|
-
createRun(workspaceSlug: string, pipelineSlug: string, run: CreatePipelineRun): Promise<PipelineRun>;
|
|
698
|
-
/**
|
|
699
|
-
* Get pipeline run details by ID
|
|
700
|
-
* @param workspaceSlug - Workspace slug
|
|
701
|
-
* @param runId - Run ID
|
|
702
|
-
* @returns Promise that resolves with the pipeline run details
|
|
703
|
-
* @throws {ApiError} if the request fails
|
|
704
|
-
*/
|
|
705
|
-
getRun(workspaceSlug: string, runId: string): Promise<PipelineRun>;
|
|
706
|
-
/**
|
|
707
|
-
* Get the detections (audit) for a pipeline run
|
|
784
|
+
* Get a redaction's review audit
|
|
708
785
|
* @param workspaceSlug - Workspace slug
|
|
709
|
-
* @param
|
|
786
|
+
* @param redactionId - Redaction ID
|
|
710
787
|
* @returns Promise that resolves with the audit
|
|
711
788
|
* @throws {ApiError} if the request fails
|
|
712
789
|
*/
|
|
713
|
-
|
|
714
|
-
/**
|
|
715
|
-
* Download a run's audit as a file.
|
|
716
|
-
*
|
|
717
|
-
* `format` is `csv` (default) — a zip of entities.csv, provenance.csv, and
|
|
718
|
-
* reviews.csv — or `json`, a pretty-printed JSON file.
|
|
719
|
-
*
|
|
720
|
-
* @param workspaceSlug - Workspace slug
|
|
721
|
-
* @param runId - Run ID
|
|
722
|
-
* @param query - Optional output format (`csv` default, or `json`)
|
|
723
|
-
* @returns Promise that resolves with the file response
|
|
724
|
-
* @throws {ApiError} if the request fails
|
|
725
|
-
*/
|
|
726
|
-
downloadAudit(workspaceSlug: string, runId: string, query?: ExportQuery): Promise<Response>;
|
|
727
|
-
/**
|
|
728
|
-
* Open the raw Server-Sent Events stream of a run's status changes.
|
|
729
|
-
*
|
|
730
|
-
* Returns the underlying `Response` so callers can handle the
|
|
731
|
-
* `text/event-stream` body themselves. Most callers want
|
|
732
|
-
* {@link streamEvents}, which parses each frame into a typed
|
|
733
|
-
* {@link RunStatusEvent}.
|
|
734
|
-
*
|
|
735
|
-
* @param workspaceSlug - Workspace slug
|
|
736
|
-
* @param runId - Run ID
|
|
737
|
-
* @returns Promise that resolves with the event-stream response
|
|
738
|
-
* @throws {ApiError} if the request fails
|
|
739
|
-
*/
|
|
740
|
-
events(workspaceSlug: string, runId: string): Promise<Response>;
|
|
741
|
-
/**
|
|
742
|
-
* Stream a run's status changes as Server-Sent Events.
|
|
743
|
-
*
|
|
744
|
-
* Yields the current status immediately, then each transition, and ends
|
|
745
|
-
* once the run settles (analyzed, completed, failed, or cancelled). Break
|
|
746
|
-
* out of the loop to close the stream early. For the raw response, use
|
|
747
|
-
* {@link events}.
|
|
748
|
-
*
|
|
749
|
-
* @param workspaceSlug - Workspace slug
|
|
750
|
-
* @param runId - Run ID
|
|
751
|
-
* @yields each {@link RunStatusEvent} as it arrives
|
|
752
|
-
* @throws {ApiError} if the request fails to open
|
|
753
|
-
* @throws {NvisyError} if the response has no readable body
|
|
754
|
-
*/
|
|
755
|
-
streamEvents(workspaceSlug: string, runId: string): AsyncGenerator<RunStatusEvent>;
|
|
756
|
-
/**
|
|
757
|
-
* Apply redactions to a pipeline run
|
|
758
|
-
* @param workspaceSlug - Workspace slug
|
|
759
|
-
* @param runId - Run ID
|
|
760
|
-
* @returns Promise that resolves with the updated pipeline run
|
|
761
|
-
* @throws {ApiError} if the request fails
|
|
762
|
-
*/
|
|
763
|
-
redact(workspaceSlug: string, runId: string): Promise<PipelineRun>;
|
|
790
|
+
getReview(workspaceSlug: string, redactionId: string): Promise<Audit>;
|
|
764
791
|
}
|
|
765
792
|
//#endregion
|
|
766
793
|
//#region src/services/status.d.ts
|
|
@@ -1100,9 +1127,13 @@ declare class Nvisy {
|
|
|
1100
1127
|
*/
|
|
1101
1128
|
get notifications(): Notifications;
|
|
1102
1129
|
/**
|
|
1103
|
-
* Service for
|
|
1130
|
+
* Service for pipeline detections and their redactions.
|
|
1131
|
+
*/
|
|
1132
|
+
get detections(): Detections;
|
|
1133
|
+
/**
|
|
1134
|
+
* Service for workspace redactions.
|
|
1104
1135
|
*/
|
|
1105
|
-
get
|
|
1136
|
+
get redactions(): Redactions;
|
|
1106
1137
|
/**
|
|
1107
1138
|
* Service for managing connection syncs.
|
|
1108
1139
|
*/
|
|
@@ -1117,5 +1148,5 @@ declare class Nvisy {
|
|
|
1117
1148
|
get workspaces(): Workspaces;
|
|
1118
1149
|
}
|
|
1119
1150
|
//#endregion
|
|
1120
|
-
export {
|
|
1121
|
-
//# sourceMappingURL=client-
|
|
1151
|
+
export { Account as S, Catalog as _, Syncs as a, Analytics as b, Policies as c, Members as d, Invites as f, Chat as g, Connections as h, Webhooks as i, Pipelines as l, Detections as m, Nvisy as n, Status as o, Files as p, Workspaces as r, Redactions as s, ApiClient as t, Notifications as u, Auth as v, Activities as x, ApiTokens as y };
|
|
1152
|
+
//# sourceMappingURL=client-jMgO90LH.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client-jMgO90LH.d.ts","names":[],"sources":["../src/services/account.ts","../src/services/activities.ts","../src/services/analytics.ts","../src/services/api-tokens.ts","../src/services/auth.ts","../src/services/catalog.ts","../src/services/chat.ts","../src/services/connections.ts","../src/services/detections.ts","../src/services/files.ts","../src/services/invites.ts","../src/services/members.ts","../src/services/notifications.ts","../src/services/pipelines.ts","../src/services/policies.ts","../src/services/redactions.ts","../src/services/status.ts","../src/services/syncs.ts","../src/services/webhooks.ts","../src/services/workspaces.ts","../src/client.ts"],"mappings":";;;;;;;cAUa;;EAGA,YAAA,KAAK;;;;;;EASX,cAAc,QAAQ;;;;;;;EAWtB,cAAc,SAAS,gBAAgB,QAAQ;;;;;;EAY/C,iBAAiB;;;;;;;EAUjB,iBAAiB,mBAAmB,QAAQ;;;;;;;;EAc5C,aAAa,kBAAkB,QAAQ,OAAO,QAAQ;;;;;;;EAsBtD,aAAa,mBAAmB;;;;;;;cC/E1B;;EAGA,YAAA,KAAK;;;;;;;;;EAYX,eACL,uBACA,QAAQ,sBAAsB,aAAa,mBACzC,QAAQ;;;;;;;;;EAkBL,iBACL,uBACA,QAAQ,sBAAsB,aAAa,wBACzC,QAAQ;;;;;;;cCzCC;;EAGA,YAAA,KAAK;;;;;;;EAUX,aAAa,wBAAwB,QAAQ;;;;;;;;EAiB7C,uBACL,uBACA,QAAQ,aACN,QAAQ;;;;;;;cC9BC;;EAGA,YAAA,KAAK;;;;;;;EAUX,cAAc,QAAQ,mBAAmB,QAAQ;;;;;;;EAajD,YAAY,kBAAkB,QAAQ;;;;;;;EAatC,eAAe,OAAO,iBAAiB,QAAQ;;;;;;;;EAc/C,eACL,iBACA,SAAS,iBACP,QAAQ;;;;;;;EAcL,eAAe,kBAAkB;;;;;;;cC7E3B;;EAGA,YAAA,KAAK;;;;;;;EAUX,aAAa,aAAa,QAAQ,QAAQ;;;;;;;EAa1C,cAAc,aAAa,SAAS,QAAQ;;;;;;EAY5C,iBAAiB;;;;;;;;cCrCX;;EAGA,YAAA,KAAK;;;;;EAQX,cAAc,QAAQ;;;;;EAStB,mBAAmB,QAAQ;;;;;;;cCXrB;;EAGA,YAAA,KAAK;;;;;;;;EAWX,aACL,uBACA,QAAQ,mBACN,QAAQ;;;;;;;;EAiBL,cACL,uBACA,SAAS,oBACP,QAAQ;;;;;;;EAiBL,cAAc,uBAAuB,oBAAoB;;;;;;;;EAgBzD,aACL,uBACA,oBACE,QAAQ;;;;;;;;;;;;;;;EAwBL,YACL,uBACA,mBACA,SAAS,kBACP,QAAQ;;;;;;;;;;;;;;;EA0BJ,cACN,uBACA,mBACA,SAAS,kBACP,eAAe;;;;;;;cCtIN;;EAGA,YAAA,KAAK;;;;;;;;EAWX,gBACL,uBACA,QAAQ;IAAqB;MAC3B,QAAQ;;;;;;;;EAiBL,iBACL,uBACA,YAAY,mBACV,QAAQ;;;;;;;;EAkBL,cACL,uBACA,uBACE,QAAQ;;;;;;;;;EAkBL,iBACL,uBACA,sBACA,SAAS,mBACP,QAAQ;;;;;;;;EAkBL,iBACL,uBACA,uBACE;;;;;;;;EAgBG,iBACL,uBACA,uBACE,QAAQ;;;;;;;;cC/GC;;EAGA,YAAA,KAAK;;;;;;;;;EAYX,eACL,uBACA,QAAQ,mBAAmB,2BACzB,QAAQ;;;;;;;;;;EAmBL,uBACL,uBACA,sBACA,QAAQ,mBAAmB,0BACzB,QAAQ;;;;;;;;;EAkBL,gBACL,uBACA,sBACA,WAAW,kBACT,QAAQ;;;;;;;;EAkBL,aACL,uBACA,sBACE,QAAQ;;;;;;;;EAiBL,YACL,uBACA,sBACE,QAAQ;;;;;;;;;;;;;EAsBL,cACL,uBACA,qBACA,QAAQ,cACN,QAAQ;;;;;;;;;;;;;;EAwBL,OAAO,uBAAuB,sBAAsB,QAAQ;;;;;;;;;;;;;;EAwB3D,aACN,uBACA,sBACE,eAAe;;;;;;;;;EAqBZ,eACL,uBACA,qBACA,QAAQ,mBACN,QAAQ;;;;;;;;;EAkBL,gBACL,uBACA,qBACA,WAAW,kBACT,QAAQ;;;;;;;cC9OC;;EAGA,YAAA,KAAK;;;;;;;;EAWX,YACL,uBACA,OAAO,OAAO,SACZ,QAAQ;;;;;;;;EA+BL,UACL,uBACA,QAAQ,YAAY,mBAClB,QAAQ;;;;;;;;EAcL,QAAQ,uBAAuB,iBAAiB,QAAQ;;;;;;;;EAiBxD,aAAa,uBAAuB,iBAAiB,QAAQ;;;;;;;;;EAmB7D,WACL,uBACA,gBACA,SAAS,aACP,QAAQ;;;;;;;;EAkBL,WAAW,uBAAuB,iBAAiB;;;;;;;cCtH7C;;EAGA,YAAA,KAAK;;;;;;;;EAWX,YACL,uBACA,QAAQ,cAAc,mBACpB,QAAQ;;;;;;;;EAiBL,WACL,uBACA,QAAQ,eACN,QAAQ;;;;;;;;EAkBL,aAAa,uBAAuB,mBAAmB;;;;;;;;;EAcvD,cACL,uBACA,kBACA,OAAO,cACL,QAAQ;;;;;;;;EAkBL,mBACL,uBACA,SAAS,qBACP,QAAQ;;;;;;;;EAkBL,kBACL,oBACA,QAAQ,qBACN,QAAQ;;;;;;;EAcL,cAAc,qBAAqB,QAAQ;;;;;;;cCtIrC;;EAGA,YAAA,KAAK;;;;;;;;EAWX,YACL,uBACA,QAAQ,cAAc,mBACpB,QAAQ;;;;;;;;EAiBL,UAAU,uBAAuB,mBAAmB,QAAQ;;;;;;;;;EAoB5D,aACL,uBACA,kBACA,SAAS,eACP,QAAQ;;;;;;;;EAoBL,aAAa,uBAAuB,mBAAmB;;;;;;;EAYvD,eAAe,wBAAwB;;;;;;;cCxFjC;;EAGA,YAAA,KAAK;;;;;;;EAUX,kBAAkB,QAAQ,mBAAmB,QAAQ;;;;;;EAYrD,gCAAgC,QAAQ;;;;;;EAUxC,eAAe,QAAQ;;;;;;EAUvB,SAAS,yBAAyB;;;;;;;;;;;;EAiBlC,UAAU,QAAQ;;;;;;;;;;;;EAkBjB,gBAAgB,eAAe;;;;;;;cCjF1B;;EAGA,YAAA,KAAK;;;;;;;;EAWX,cACL,uBACA,QAAQ;IAAqB;IAAiB,SAAS;MACrD,QAAQ;;;;;;;;EAiBL,eACL,uBACA,UAAU,iBACR,QAAQ;;;;;;;;EAkBL,YACL,uBACA,uBACE,QAAQ;;;;;;;;;EAkBL,eACL,uBACA,sBACA,SAAS,iBACP,QAAQ;;;;;;;;EAkBL,eACL,uBACA,uBACE;;;;;;;cCtGS;;EAGA,YAAA,KAAK;;;;;;;;EAWX,aACL,uBACA,QAAQ,mBACN,QAAQ;;;;;;;;EAiBL,aACL,uBACA,QAAQ,eACN,QAAQ;;;;;;;;EAkBL,UAAU,uBAAuB,qBAAqB,QAAQ;;;;;;;;;EAkB9D,aACL,uBACA,oBACA,SAAS,eACP,QAAQ;;;;;;;;EAkBL,aAAa,uBAAuB,qBAAqB;;;;;;;;cCpGnD;;EAGA,YAAA,KAAK;;;;;;;;EAWX,UAAU,uBAAuB,sBAAsB,QAAQ;;;;;;;cCfzD;;EAGA,YAAA,KAAK;;;;;EAQX,eAAe,QAAQ;;;;;;;cCLjB;;EAGA,YAAA,KAAK;;;;;;;;EAWX,mBACL,uBACA,QAAQ;IAAqB;IAAqB,SAAS;MACzD,QAAQ;;;;;;;;;EAeL,UACL,uBACA,sBACA,MAAM,iBACJ,QAAQ;;;;;;;;;EAmBL,UACL,uBACA,sBACA,QAAQ,mBACN,QAAQ;;;;;;;;;EAkBL,QACL,uBACA,sBACA,iBACE,QAAQ;;;;;;;;;EAkBL,WACL,uBACA,sBACA,iBACE,QAAQ;;;;;;;cCpGC;;EAGA,YAAA,KAAK;;;;;;;;EAWX,aACL,uBACA,QAAQ,mBACN,QAAQ;;;;;;;;EAiBL,cACL,uBACA,SAAS,gBACP,QAAQ;;;;;;;;EAkBL,WAAW,uBAAuB,oBAAoB,QAAQ;;;;;;;;;EAkB9D,cACL,uBACA,mBACA,SAAS,gBACP,QAAQ;;;;;;;;EAkBL,cAAc,uBAAuB,oBAAoB;;;;;;;;;EAiBzD,YACL,uBACA,mBACA,UAAU,cACR,QAAQ;;;;;;;cCrHC;;EAGA,YAAA,KAAK;;;;;;;EAUX,eAAe,QAAQ,mBAAmB,QAAQ;;;;;;;EAalD,aAAa,wBAAwB,QAAQ;;;;;;;EAa7C,gBAAgB,WAAW,kBAAkB,QAAQ;;;;;;;;EAcrD,gBACL,uBACA,SAAS,kBACP,QAAQ;;;;;;;EAcL,gBAAgB,wBAAwB;;;;;;;EAYxC,wBACL,wBACE,QAAQ;;;;;;;;EAiBL,2BACL,uBACA,UAAU,6BACR,QAAQ;;;;;;;;EAkBL,aAAa,uBAAuB,QAAQ,OAAO;;;;;;;EAqBnD,aAAa,wBAAwB;;;;;;;;;;KCzGhC,YAAY,OAAc;;;;;;;;;;;cAsBzB;;;;;;;;;;;;;;;;;EA4BA,YAAA,QAAQ;;;;;;;;;;;;;;;;;;;;;EAyFpB,aAAa,mBAAmB;;;;;;MAS5B;;;;;;;;;MAYA,OAAO;;;;MAOP,QAAQ;;;;MAOR,UAAU;;;;MAOV,WAAW;;;;MAOX,cAAc;;;;MAOd,aAAa;;;;MAOb,QAAQ;;;;MAOR,aAAa;;;;MAOb,eAAe;;;;MAOf,SAAS;;;;MAOT,aAAa;;;;MAOb,YAAY;;;;MAOZ,WAAW;;;;MAOX,WAAW;;;;MAOX,WAAW;;;;MAOX,iBAAiB;;;;MAOjB,cAAc;;;;MAOd,cAAc;;;;MAOd,SAAS;;;;MAOT,YAAY;;;;MAOZ,cAAc"}
|
|
@@ -10,9 +10,10 @@
|
|
|
10
10
|
/**
|
|
11
11
|
* Current SDK version.
|
|
12
12
|
*
|
|
13
|
-
*
|
|
13
|
+
* Injected from `package.json` at build time, so it always matches the
|
|
14
|
+
* published version. Used in the default user agent string.
|
|
14
15
|
*/
|
|
15
|
-
declare const VERSION
|
|
16
|
+
declare const VERSION: string;
|
|
16
17
|
/**
|
|
17
18
|
* Configuration options for creating a Nvisy client.
|
|
18
19
|
*
|
|
@@ -85,8 +86,8 @@ declare const DEFAULTS: {
|
|
|
85
86
|
/**
|
|
86
87
|
* Default user agent string.
|
|
87
88
|
*/
|
|
88
|
-
readonly USER_AGENT:
|
|
89
|
+
readonly USER_AGENT: `@nvisy/sdk v.${string}`;
|
|
89
90
|
};
|
|
90
91
|
//#endregion
|
|
91
92
|
export { DEFAULTS as n, VERSION as r, ClientConfig as t };
|
|
92
|
-
//# sourceMappingURL=config-
|
|
93
|
+
//# sourceMappingURL=config-BhUEqFOg.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config-BhUEqFOg.d.ts","names":[],"sources":["../src/config.ts"],"mappings":";;;;;;;;;;;;;;;cAsBa;;;;;;;;;;;;;;;;;UAmBI;;;;;;EAMhB;;;;;;EAOA;;;;;;;;EASA,UAAU;;;;;;EAOV;;;;;;;;EASA;;;;;;;;;EAUA,eAAe,WAAW;;;;;cAMd;;;;WAAA;;;;WAAA"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { $ as
|
|
2
|
-
export type { Account, AccountRef, Activity,
|
|
1
|
+
import { $ as PolicyRule, $i as DetectionAnalytics, $n as ChatMessage, $r as ImageModel, $t as ReplyInvite, A as Color, Aa as Account, Ai as TabularRetag, An as AzureCredentials, Ar as Calibration, At as NotificationPage, B as Label, Bi as TextManual, Bn as GcsCredentials, Br as EditSet, Bt as MemberSortField, C as Language, Ca as InviteActivityParams, Ci as TabularEntity, Cn as PipelineDetectionsQuery, Cr as AudioModel, Ct as DetectionCompletedParams, D as ScopeMetadata, Da as RedactionActivityParams, Di as TabularModel, Dn as RedactionResultPage, Dr as Audit, Dt as MemberJoinedParams, E as Languages, Ea as PolicyActivityParams, Ei as TabularManual, En as RedactionResult, Er as AudioRetag, Et as MemberInvitedParams, F as GdprArticle9Treatment, Fa as UpdateAccount, Fi as TextData, Fn as ConnectionSync, Fr as Contested, Ft as UnreadStatus, G as LanguageTag, Gi as TimeSpan, Gn as SyncConnection, Gr as ImageAuditKind, Gt as InviteCode, H as LabelLocale, Hi as TextPattern, Hn as OpenAiCredentials, Hr as FreeformAttribution, Ht as CreateInvite, I as GdprSensitiveScope, Ii as TextEdit, In as ConnectionSyncPage, Ir as Deduplication, It as UpdateNotificationSettings, J as PciDssPart, Ji as ApiTokenType, Jn as SyncSchedule, Jr as ImageEdit, Jt as InvitePreview, K as LocalizedText, Ki as ApiToken, Kn as SyncDeletionPolicy, Kr as ImageAuditLog, Kt as InviteExpiration, L as HipaaAccountNumbers, Li as TextEntity, Ln as ConnectionVerification, Lr as Dimensions, Lt as ListMembers, M as CreatePolicy, Ma as Handle, Mi as TextAuditEvent, Mn as ConnectionConfig, Mr as CitedAttribution, Mt as NotificationSettings, N as DateGranularity, Na as PasswordChange, Ni as TextAuditKind, Nn as ConnectionId, Nr as CodecParams, Nt as RedactionCreatedParams, O as AudioRedaction, Oa as WebhookActivityParams, Oi as TabularPattern, On as WorkspaceDetectionsQuery, Or as AuditHash, Ot as Notification, P as DateStyle, Pa as PublicAccount, Pi as TextAuditLog, Pn as ConnectionPage, Pr as Conflict, Pt as UnreadCountEvent, Q as PolicyDraft, Qi as UpdateApiToken, Qn as UpdateConnection, Qr as ImageManual, Qt as ListInvites, R as HipaaDeidMethod, Ri as TextHint, Rn as ConnectionsQuery, Rr as DocumentContext, Rt as Member, S as CountryCode, Sa as FileActivityParams, Si as TabularEdit, Sn as DetectionStatusEvent, Sr as AudioManual, St as ConnectionSyncFailedParams, T as LanguageSpan, Ta as PipelineActivityParams, Ti as TabularLocation, Tn as RedactionId, Tr as AudioRefinement, Tt as MarkedReadStatus, U as LabelRef, Ui as TextRefinement, Un as S3Credentials, Ur as ImageAdd, Ut as GenerateInviteCode, V as LabelEntry, Vi as TextModel, Vn as LlmConfig, Vr as EntityCoRef, Vt as UpdateMember, W as LabelScope, Wi as TextRetag, Wn as StorageConfig, Wr as ImageAuditEvent, Wt as Invite, X as Policy, Xi as CreateApiToken, Xn as SyncStatus, Xr as ImageHint, Xt as InviteSortField, Y as PciPanRender, Yi as ApiTokenWithJWT, Yn as SyncScheduleInput, Yr as ImageEntity, Yt as InviteSent, Z as PolicyDefinition, Zi as TokenExpiration, Zn as SyncTriggerType, Zr as ImageLocation, Zt as InviteStatus, _ as WebhookId, _a as ActivityPage, _i as Suppress, _n as Detection, _r as AudioData, _t as PipelineSummaryPage, a as RetentionSettings, aa as ProviderType, ai as ModelEvent, an as FileKind, ar as SendChatMessage, at as TabularRedaction, b as WebhookStatus, ba as ConnectionActivityParams, bi as TabularAuditKind, bn as DetectionPage, br as AudioHint, bt as CursorPagination, c as WorkspacePage, ca as StorageKindEntry, ci as Point, cn as ListFiles, cr as RegisteredRecognizer, ct as TextRedaction, d as CreateWebhook, da as UsageAnalytics, di as RasterMode, dn as DateWindow, dr as Signup, dt as CreatePipeline, ea as DetectionDayEntry, ei as ImagePattern, en as SortOrder, er as ChatRole, et as PolicySummary, f as TestWebhook, fa as UsageReport, fi as Redaction, fn as ExportFormat, fr as Attribution, ft as Pipeline, g as WebhookEvent, ga as ActivityFilterQuery, gi as SourceRef, gn as CreateDetection, gr as AudioAuditLog, gt as PipelineSummary, h as WebhookCreated, ha as ActivityExportOptions, hi as Selection, hn as ValidationErrorDetail, hr as AudioAuditKind, ht as PipelineStatus, i as RetentionOverride, ia as ModelUsageEntry, ii as ManualIntent, in as File, ir as CreateChatSession, it as Sha2Algorithm, j as ConfidenceThreshold, ja as AccountRef, ji as TextAdd, jn as Connection, jr as Category, jt as NotificationPayload, k as ClampBucket, ka as WorkspaceActivityParams, ki as TabularRefinement, kn as AnthropicCredentials, kr as BoundingBox, kt as NotificationEvent, l as WorkspaceRole, la as TokenCounts, li as Polygon, ln as ModalityToken, lr as AuthToken, lt as UpdatePolicy, m as Webhook, ma as Activity, mi as RuleMatch, mn as ErrorResponse, mr as AudioAuditEvent, mt as PipelineFilter, n as OcrPolicy, na as DetectionTimeSeries, ni as ImageRetag, nn as Health, nr as ChatSessionPage, nt as PolicyTemplate, o as UpdateWorkspace, oa as RecognizerId, oi as OperatorId, on as FilePage, or as LabelCatalog, ot as TemplateOrigin, p as UpdateWebhook, pa as WorkspaceAnalytics, pi as Report, pn as ExportQuery, pr as AudioAdd, pt as PipelineDefinition, q as ModalityRedactions, qi as ApiTokenPage, qn as SyncMode, qr as ImageData, qt as InvitePage, r as Retention, ra as ModelUsage, ri as LeakProfile, rn as HealthStatus, rr as ChatToken, rt as Predicate, s as Workspace, sa as StorageAnalytics, si as PatternEvent, sn as FormatToken, sr as RecognizerCatalog, st as TerminalFallback, t as CreateWorkspace, ta as DetectionStatusEntry, ti as ImageRefinement, tn as ComponentHealth, tr as ChatSession, tt as PolicySummaryPage, u as WorkspaceSettings, ua as Usage, ui as RangeOfUint, un as UpdateFile, ur as Login, ut as Waveform, v as WebhookPage, va as ActivityPayload, vi as TabularAdd, vn as DetectionId, vr as AudioEdit, vt as PipelineTriggerType, w as LanguageProvenance, wa as MemberActivityParams, wi as TabularHint, wn as RedactDetection, wr as AudioPattern, wt as DetectionFailedParams, x as Confidence, xa as DetectionActivityParams, xi as TabularAuditLog, xn as DetectionStatus, xr as AudioLocation, xt as ConnectionSyncCompletedParams, y as WebhookResult, ya as ActivityType, yi as TabularAuditEvent, yn as DetectionMetadata, yr as AudioEntity, yt as UpdatePipeline, z as ImageRedaction, zi as TextLocation, zn as CreateConnection, zr as Dpi, zt as MemberPage } from "../index-BPKkfko3.js";
|
|
2
|
+
export type { Account, AccountRef, Activity, ActivityExportOptions, ActivityFilterQuery, ActivityPage, ActivityPayload, ActivityType, AnthropicCredentials, ApiToken, ApiTokenPage, ApiTokenType, ApiTokenWithJWT, Attribution, AudioAdd, AudioAuditEvent, AudioAuditKind, AudioAuditLog, AudioData, AudioEdit, AudioEntity, AudioHint, AudioLocation, AudioManual, AudioModel, AudioPattern, AudioRedaction, AudioRefinement, AudioRetag, Audit, AuditHash, AuthToken, AzureCredentials, BoundingBox, Calibration, Category, ChatMessage, ChatRole, ChatSession, ChatSessionPage, ChatToken, CitedAttribution, ClampBucket, CodecParams, Color, ComponentHealth, Confidence, ConfidenceThreshold, Conflict, Connection, ConnectionActivityParams, ConnectionConfig, ConnectionId, ConnectionPage, ConnectionSync, ConnectionSyncCompletedParams, ConnectionSyncFailedParams, ConnectionSyncPage, ConnectionVerification, ConnectionsQuery, Contested, CountryCode, CreateApiToken, CreateChatSession, CreateConnection, CreateDetection, CreateInvite, CreatePipeline, CreatePolicy, CreateWebhook, CreateWorkspace, CursorPagination, DateGranularity, DateStyle, DateWindow, Deduplication, Detection, DetectionActivityParams, DetectionAnalytics, DetectionCompletedParams, DetectionDayEntry, DetectionFailedParams, DetectionId, DetectionMetadata, DetectionPage, DetectionStatus, DetectionStatusEntry, DetectionStatusEvent, DetectionTimeSeries, Dimensions, DocumentContext, Dpi, EditSet, EntityCoRef, ErrorResponse, ExportFormat, ExportQuery, File, FileActivityParams, FileKind, FilePage, FormatToken, FreeformAttribution, GcsCredentials, GdprArticle9Treatment, GdprSensitiveScope, GenerateInviteCode, Handle, Health, HealthStatus, HipaaAccountNumbers, HipaaDeidMethod, ImageAdd, ImageAuditEvent, ImageAuditKind, ImageAuditLog, ImageData, ImageEdit, ImageEntity, ImageHint, ImageLocation, ImageManual, ImageModel, ImagePattern, ImageRedaction, ImageRefinement, ImageRetag, Invite, InviteActivityParams, InviteCode, InviteExpiration, InvitePage, InvitePreview, InviteSent, InviteSortField, InviteStatus, Label, LabelCatalog, LabelEntry, LabelLocale, LabelRef, LabelScope, Language, LanguageProvenance, LanguageSpan, LanguageTag, Languages, LeakProfile, ListFiles, ListInvites, ListMembers, LlmConfig, LocalizedText, Login, ManualIntent, MarkedReadStatus, Member, MemberActivityParams, MemberInvitedParams, MemberJoinedParams, MemberPage, MemberSortField, ModalityRedactions, ModalityToken, ModelEvent, ModelUsage, ModelUsageEntry, Notification, NotificationEvent, NotificationPage, NotificationPayload, NotificationSettings, OcrPolicy, OpenAiCredentials, OperatorId, PasswordChange, PatternEvent, PciDssPart, PciPanRender, Pipeline, PipelineActivityParams, PipelineDefinition, PipelineDetectionsQuery, PipelineFilter, PipelineStatus, PipelineSummary, PipelineSummaryPage, PipelineTriggerType, Point, Policy, PolicyActivityParams, PolicyDefinition, PolicyDraft, PolicyRule, PolicySummary, PolicySummaryPage, PolicyTemplate, Polygon, Predicate, ProviderType, PublicAccount, RangeOfUint, RasterMode, RecognizerCatalog, RecognizerId, RedactDetection, Redaction, RedactionActivityParams, RedactionCreatedParams, RedactionId, RedactionResult, RedactionResultPage, RegisteredRecognizer, ReplyInvite, Report, Retention, RetentionOverride, RetentionSettings, RuleMatch, S3Credentials, ScopeMetadata, Selection, SendChatMessage, Sha2Algorithm, Signup, SortOrder, SourceRef, StorageAnalytics, StorageConfig, StorageKindEntry, Suppress, SyncConnection, SyncDeletionPolicy, SyncMode, SyncSchedule, SyncScheduleInput, SyncStatus, SyncTriggerType, TabularAdd, TabularAuditEvent, TabularAuditKind, TabularAuditLog, TabularEdit, TabularEntity, TabularHint, TabularLocation, TabularManual, TabularModel, TabularPattern, TabularRedaction, TabularRefinement, TabularRetag, TemplateOrigin, TerminalFallback, TestWebhook, TextAdd, TextAuditEvent, TextAuditKind, TextAuditLog, TextData, TextEdit, TextEntity, TextHint, TextLocation, TextManual, TextModel, TextPattern, TextRedaction, TextRefinement, TextRetag, TimeSpan, TokenCounts, TokenExpiration, UnreadCountEvent, UnreadStatus, UpdateAccount, UpdateApiToken, UpdateConnection, UpdateFile, UpdateMember, UpdateNotificationSettings, UpdatePipeline, UpdatePolicy, UpdateWebhook, UpdateWorkspace, Usage, UsageAnalytics, UsageReport, ValidationErrorDetail, Waveform, Webhook, WebhookActivityParams, WebhookCreated, WebhookEvent, WebhookId, WebhookPage, WebhookResult, WebhookStatus, Workspace, WorkspaceActivityParams, WorkspaceAnalytics, WorkspaceDetectionsQuery, WorkspacePage, WorkspaceRole, WorkspaceSettings };
|
|
@@ -2,19 +2,12 @@ import { n as NvisyError, t as NvisyApiError } from "./errors-BOLD8iC1.js";
|
|
|
2
2
|
|
|
3
3
|
//#region src/config.ts
|
|
4
4
|
/**
|
|
5
|
-
* @fileoverview Configuration types and constants for the Nvisy SDK.
|
|
6
|
-
*
|
|
7
|
-
* This module provides configuration interfaces, default values, and environment
|
|
8
|
-
* variable names used throughout the SDK.
|
|
9
|
-
*
|
|
10
|
-
* @module config
|
|
11
|
-
*/
|
|
12
|
-
/**
|
|
13
5
|
* Current SDK version.
|
|
14
6
|
*
|
|
15
|
-
*
|
|
7
|
+
* Injected from `package.json` at build time, so it always matches the
|
|
8
|
+
* published version. Used in the default user agent string.
|
|
16
9
|
*/
|
|
17
|
-
const VERSION = "0.
|
|
10
|
+
const VERSION = "0.35.0";
|
|
18
11
|
/**
|
|
19
12
|
* Default configuration values used when options are not explicitly provided.
|
|
20
13
|
*/
|
|
@@ -37,7 +30,10 @@ const DEFAULTS = {
|
|
|
37
30
|
*/
|
|
38
31
|
const errorMiddleware = {
|
|
39
32
|
async onResponse({ response }) {
|
|
40
|
-
if (!response.ok)
|
|
33
|
+
if (!response.ok) {
|
|
34
|
+
const error = await response.clone().json();
|
|
35
|
+
throw new NvisyApiError(error, response.status);
|
|
36
|
+
}
|
|
41
37
|
return response;
|
|
42
38
|
},
|
|
43
39
|
onError({ error }) {
|
|
@@ -48,4 +44,4 @@ const errorMiddleware = {
|
|
|
48
44
|
|
|
49
45
|
//#endregion
|
|
50
46
|
export { DEFAULTS as n, VERSION as r, errorMiddleware as t };
|
|
51
|
-
//# sourceMappingURL=error-
|
|
47
|
+
//# sourceMappingURL=error-D4r5BMhi.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"error-D4r5BMhi.js","names":[],"sources":["../src/config.ts","../src/middleware/error.ts"],"sourcesContent":["/**\n * @fileoverview Configuration types and constants for the Nvisy SDK.\n *\n * This module provides configuration interfaces, default values, and environment\n * variable names used throughout the SDK.\n *\n * @module config\n */\n\n/**\n * Compile-time version token, replaced with the `package.json` version by the\n * build (see `tsdown.config.ts`). Declared so it type-checks; the `typeof`\n * guard below keeps it safe when the define isn't applied (tests, direct `tsc`).\n */\ndeclare const __SDK_VERSION__: string | undefined;\n\n/**\n * Current SDK version.\n *\n * Injected from `package.json` at build time, so it always matches the\n * published version. Used in the default user agent string.\n */\nexport const VERSION =\n\ttypeof __SDK_VERSION__ === \"string\" ? __SDK_VERSION__ : \"0.0.0-dev\";\n\n/**\n * Configuration options for creating a Nvisy client.\n *\n * The `apiToken` field is required for authentication. All other fields are optional\n * and will use sensible defaults when omitted.\n *\n * @example\n * ```typescript\n * const config: ClientConfig = {\n * apiToken: \"your-api-token\",\n * baseUrl: \"https://api.nvisy.com\",\n * headers: { \"X-Custom-Header\": \"value\" },\n * };\n * const client = new Client(config);\n * ```\n */\nexport interface ClientConfig {\n\t/**\n\t * API token for authentication.\n\t *\n\t * Tokens can be obtained from the Nvisy dashboard or via the auth endpoints.\n\t */\n\tapiToken: string;\n\n\t/**\n\t * Base URL for the Nvisy API.\n\t *\n\t * @default \"https://api.nvisy.com\"\n\t */\n\tbaseUrl?: string;\n\n\t/**\n\t * Custom headers to include with every request.\n\t *\n\t * These headers are merged with the default headers (Content-Type, User-Agent,\n\t * and Authorization). Custom headers take precedence over defaults if there\n\t * are conflicts.\n\t */\n\theaders?: Record<string, string>;\n\n\t/**\n\t * Custom user agent string to identify your application.\n\t *\n\t * @default \"@nvisy/sdk v.{version}\"\n\t */\n\tuserAgent?: string;\n\n\t/**\n\t * Enable logging for requests and responses.\n\t *\n\t * When enabled, logs request method, URL, status, and timing to console.\n\t *\n\t * @default false\n\t */\n\twithLogging?: boolean;\n\n\t/**\n\t * Custom fetch implementation used for every request. Must match the WHATWG\n\t * `fetch` signature. Defaults to the global `fetch`.\n\t *\n\t * Lets a host swap in a non-browser transport — e.g. a desktop (Tauri) app\n\t * passing `@tauri-apps/plugin-http`'s `fetch`, which performs the request in\n\t * the native process and so is not subject to browser CORS.\n\t */\n\tfetch?: typeof globalThis.fetch;\n}\n\n/**\n * Default configuration values used when options are not explicitly provided.\n */\nexport const DEFAULTS = {\n\t/**\n\t * Default base URL for the Nvisy API.\n\t */\n\tBASE_URL: \"https://api.nvisy.com\",\n\n\t/**\n\t * Default user agent string.\n\t */\n\tUSER_AGENT: `@nvisy/sdk v.${VERSION}`,\n} as const;\n","import type { Middleware } from \"openapi-fetch\";\nimport type { ErrorResponse } from \"@/datatypes/index.js\";\nimport { NvisyApiError, NvisyError } from \"@/errors.js\";\n\n/**\n * Middleware that automatically throws NvisyApiError for error responses.\n * This replaces the need for manual checks in services.\n */\nexport const errorMiddleware: Middleware = {\n\tasync onResponse({ response }) {\n\t\tif (!response.ok) {\n\t\t\tconst error = (await response.clone().json()) as ErrorResponse;\n\t\t\tthrow new NvisyApiError(error, response.status);\n\t\t}\n\t\treturn response;\n\t},\n\n\tonError({ error }) {\n\t\t// Wrap fetch errors (network failures, CORS, etc.) in NvisyError\n\t\tif (error instanceof Error) {\n\t\t\tthrow new NvisyError(error.message);\n\t\t}\n\t\tthrow new NvisyError(\"An unknown network error occurred\");\n\t},\n};\n"],"mappings":";;;;;;;;;AAsBA,MAAa;;;;AAyEb,MAAa,WAAW;;;;CAIvB,UAAU;;;;CAKV,YAAY,gBAAgB;AAC7B;;;;;;;;ACjGA,MAAa,kBAA8B;CAC1C,MAAM,WAAW,EAAE,YAAY;EAC9B,IAAI,CAAC,SAAS,IAAI;GACjB,MAAM,QAAS,MAAM,SAAS,MAAM,CAAC,CAAC,KAAK;GAC3C,MAAM,IAAI,cAAc,OAAO,SAAS,MAAM;EAC/C;EACA,OAAO;CACR;CAEA,QAAQ,EAAE,SAAS;EAElB,IAAI,iBAAiB,OACpB,MAAM,IAAI,WAAW,MAAM,OAAO;EAEnC,MAAM,IAAI,WAAW,mCAAmC;CACzD;AACD"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { mn as ErrorResponse } from "./index-BPKkfko3.js";
|
|
2
2
|
//#region src/errors.d.ts
|
|
3
3
|
/**
|
|
4
4
|
* Base error class for all Nvisy SDK errors.
|
|
@@ -124,4 +124,4 @@ declare class NvisyApiError extends NvisyError implements ErrorResponse {
|
|
|
124
124
|
}
|
|
125
125
|
//#endregion
|
|
126
126
|
export { NvisyError as n, NvisyApiError as t };
|
|
127
|
-
//# sourceMappingURL=errors-
|
|
127
|
+
//# sourceMappingURL=errors-Anm66raZ.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors-
|
|
1
|
+
{"version":3,"file":"errors-Anm66raZ.d.ts","names":[],"sources":["../src/errors.ts"],"mappings":";;;;;;;;;;;;;;;;;;;cAgCa,mBAAmB;;;;WAIf;;;;;;EAOJ,YAAA;;;;;;;;;;;;;;;;;;;;;;;;cA4BA,sBAAsB,sBAAsB;;;;WAIxC;;;;WAKA;;;;;WAMA;;;;;WAMA;;;;;WAMA,aAAa;;;;WAKb;;;;;;;EAQJ,YAAA,UAAU,eAAe;;;;;;;;;EAkBrC;;;;;;;;;EAYA;;;;;;;;;EAYA;;;;;;;;EAeA,UAAU"}
|