@nvisy/sdk 0.52.0 → 0.54.0

package/dist/{services-Bt15MerP.js → services-BMmcawiT.js}

@@ -309,7 +309,9 @@ var ApiTokens = class {
 //#endregion
 //#region src/services/auth.ts
 /**
-* Service for handling authentication operations
+* Authenticated auth operations: ending the current session and minting a
+* desktop token from it. Pre-auth sign-in (login / signup / OIDC start) lives on
+* the guest client ({@link NvisyGuest}).
 */
 var Auth = class {
 	#api;
@@ -317,34 +319,6 @@ var Auth = class {
 		this.#api = api;
 	}
 	/**
-	* Login with email and password, starting a browser session.
-	*
-	* Sets HttpOnly session and CSRF cookies; returns no body. Programmatic
-	* clients should instead create an API token via {@link ApiTokens} and pass
-	* it as `apiToken` when constructing the client.
-	*
-	* @param credentials - Login credentials
-	* @returns Promise that resolves once the session is started
-	* @throws {ApiError} if the request fails
-	*/
-	async loginAccount(credentials) {
-		await this.#api.POST("/auth/login", { body: credentials });
-	}
-	/**
-	* Sign up a new account, starting a browser session.
-	*
-	* Sets HttpOnly session and CSRF cookies; returns no body. Programmatic
-	* clients should instead create an API token via {@link ApiTokens} and pass
-	* it as `apiToken` when constructing the client.
-	*
-	* @param credentials - Signup details
-	* @returns Promise that resolves once the session is started
-	* @throws {ApiError} if the request fails
-	*/
-	async signupAccount(credentials) {
-		await this.#api.POST("/auth/signup", { body: credentials });
-	}
-	/**
 	* Logout, invalidating the current session and clearing its cookies.
 	* @returns Promise that resolves when logout is complete
 	* @throws {ApiError} if the request fails
@@ -353,25 +327,6 @@ var Auth = class {
 		await this.#api.POST("/auth/logout");
 	}
 	/**
-	* Begin an OpenID Connect sign-in with a provider.
-	*
-	* Returns the provider authorize URL to redirect the user to; on consent the
-	* provider redirects to the callback, which signs the user in. Also available
-	* as the standalone `startOidcSignIn` for use without a client.
-	*
-	* @param provider - The identity provider to sign in with
-	* @param query - Optional frontend URL to return to once done
-	* @returns Promise that resolves with the provider authorize URL
-	* @throws {ApiError} if the request fails
-	*/
-	async startOidcSignIn(provider, query) {
-		const { data } = await this.#api.GET("/auth/{provider}/start", { params: {
-			path: { provider },
-			query
-		} });
-		return data;
-	}
-	/**
 	* Mint a long-lived native-app token for a desktop app.
 	*
 	* Requires an active browser session (the desktop login completes in the
@@ -918,7 +873,7 @@ var Detections = class {
 //#endregion
 //#region src/services/documents.ts
 /**
-* Service for handling document operations, including review assignment.
+* Service for handling document operations.
 */
 var Documents = class {
 	#api;
@@ -1043,36 +998,92 @@ var Documents = class {
 		});
 		return data;
 	}
+};
+
+//#endregion
+//#region src/services/guest-auth.ts
+/**
+* Pre-auth authentication operations, reachable without an API token: starting
+* a browser session (login / signup) and beginning an OIDC sign-in. Exposed on
+* the guest client ({@link NvisyGuest}).
+*/
+var GuestAuth = class {
+	#api;
+	constructor(api) {
+		this.#api = api;
+	}
 	/**
-	* Assign a document for review, opening a review thread.
-	* @param workspaceId - Workspace id
-	* @param documentId - Document ID
-	* @param assignment - Review assignment request
-	* @returns Promise that resolves with the review thread
+	* Login with email and password, starting a browser session.
+	*
+	* Sets HttpOnly session and CSRF cookies; returns no body. For a programmatic
+	* client, create an API token instead and pass it as `apiToken` when
+	* constructing a {@link Nvisy} client.
+	*
+	* @param credentials - Login credentials
+	* @returns Promise that resolves once the session is started
 	* @throws {ApiError} if the request fails
 	*/
-	async assignReview(workspaceId, documentId, assignment) {
-		const { data } = await this.#api.PUT("/workspaces/{workspaceId}/documents/{documentId}/review/assign", {
-			params: { path: {
-				workspaceId,
-				documentId
-			} },
-			body: assignment
-		});
+	async loginAccount(credentials) {
+		await this.#api.POST("/auth/login", { body: credentials });
+	}
+	/**
+	* Sign up a new account, starting a browser session.
+	*
+	* Sets HttpOnly session and CSRF cookies; returns no body. For a programmatic
+	* client, create an API token instead and pass it as `apiToken` when
+	* constructing a {@link Nvisy} client.
+	*
+	* @param credentials - Signup details
+	* @returns Promise that resolves once the session is started
+	* @throws {ApiError} if the request fails
+	*/
+	async signupAccount(credentials) {
+		await this.#api.POST("/auth/signup", { body: credentials });
+	}
+	/**
+	* Begin an OpenID Connect sign-in with a provider.
+	*
+	* Returns the provider authorize URL to redirect the user to; on consent the
+	* provider redirects to the callback, which signs the user in.
+	*
+	* @param provider - The identity provider to sign in with
+	* @param query - Optional frontend URL to return to once done
+	* @returns Promise that resolves with the provider authorize URL
+	* @throws {ApiError} if the request fails
+	*/
+	async startOidcSignIn(provider, query) {
+		const { data } = await this.#api.GET("/auth/{provider}/start", { params: {
+			path: { provider },
+			query
+		} });
 		return data;
 	}
+};
+
+//#endregion
+//#region src/services/guest-capabilities.ts
+/**
+* The pre-auth subset of the deployment's capabilities: the sign-in methods it
+* offers. The label / recognizer / connector capability reads require an
+* authenticated client and live on {@link Capabilities}.
+*/
+var GuestCapabilities = class {
+	#api;
+	constructor(api) {
+		this.#api = api;
+	}
 	/**
-	* Mark a document's review as verified (resolved).
-	* @param workspaceId - Workspace id
-	* @param documentId - Document ID
-	* @returns Promise that resolves with the review thread
+	* Get the deployment's available sign-in methods.
+	*
+	* Public: reports whether password sign-in is enabled and which OIDC
+	* providers are configured, so a login screen can render the right buttons
+	* before anyone signs in.
+	*
+	* @returns Promise that resolves with the auth capabilities.
 	* @throws {ApiError} if the request fails
 	*/
-	async verifyReview(workspaceId, documentId) {
-		const { data } = await this.#api.POST("/workspaces/{workspaceId}/documents/{documentId}/review/verify", { params: { path: {
-			workspaceId,
-			documentId
-		} } });
+	async getAuthCapabilities() {
+		const { data } = await this.#api.GET("/capabilities/auth");
 		return data;
 	}
 };
@@ -1643,6 +1654,190 @@ var Redactions = class {
 	}
 };
 
+//#endregion
+//#region src/services/reviews.ts
+/**
+* Service for document reviews: assigning a document to a reviewer and tracking
+* the review through its lifecycle, with a timeline of events.
+*/
+var Reviews = class {
+	#api;
+	constructor(api) {
+		this.#api = api;
+	}
+	/**
+	* List the reviews on a document, most recent first.
+	* @param workspaceId - Workspace id
+	* @param documentId - Document ID
+	* @returns Promise that resolves with the document's reviews
+	* @throws {ApiError} if the request fails
+	*/
+	async listForDocument(workspaceId, documentId) {
+		const { data } = await this.#api.GET("/workspaces/{workspaceId}/documents/{documentId}/reviews", { params: { path: {
+			workspaceId,
+			documentId
+		} } });
+		return data;
+	}
+	/**
+	* Open a review on a document.
+	* @param workspaceId - Workspace id
+	* @param documentId - Document ID
+	* @param review - Review creation request
+	* @returns Promise that resolves with the created review
+	* @throws {ApiError} if the request fails
+	*/
+	async createForDocument(workspaceId, documentId, review) {
+		const { data } = await this.#api.POST("/workspaces/{workspaceId}/documents/{documentId}/reviews", {
+			params: { path: {
+				workspaceId,
+				documentId
+			} },
+			body: review
+		});
+		return data;
+	}
+	/**
+	* List a workspace's reviews.
+	* @param workspaceId - Workspace id
+	* @param query - Optional pagination and filters (assignee, documentId,
+	*   reviewStatus, limit, after)
+	* @returns Promise that resolves with a paginated list of reviews
+	* @throws {ApiError} if the request fails
+	*/
+	async listReviews(workspaceId, query) {
+		const { data } = await this.#api.GET("/workspaces/{workspaceId}/reviews", { params: {
+			path: { workspaceId },
+			query
+		} });
+		return data;
+	}
+	/**
+	* Get review details by ID.
+	* @param workspaceId - Workspace id
+	* @param reviewId - Review ID
+	* @returns Promise that resolves with the review details
+	* @throws {ApiError} if the request fails
+	*/
+	async getReview(workspaceId, reviewId) {
+		const { data } = await this.#api.GET("/workspaces/{workspaceId}/reviews/{reviewId}", { params: { path: {
+			workspaceId,
+			reviewId
+		} } });
+		return data;
+	}
+	/**
+	* Assign a reviewer to a review (idempotent).
+	* @param workspaceId - Workspace id
+	* @param reviewId - Review ID
+	* @param accountId - Account id of the reviewer to assign
+	* @returns Promise that resolves with the updated review
+	* @throws {ApiError} if the request fails
+	*/
+	async assignReviewer(workspaceId, reviewId, accountId) {
+		const { data } = await this.#api.POST("/workspaces/{workspaceId}/reviews/{reviewId}/assignees/{accountId}", { params: { path: {
+			workspaceId,
+			reviewId,
+			accountId
+		} } });
+		return data;
+	}
+	/**
+	* Remove a reviewer from a review.
+	* @param workspaceId - Workspace id
+	* @param reviewId - Review ID
+	* @param accountId - Account id of the reviewer to remove
+	* @returns Promise that resolves with the updated review
+	* @throws {ApiError} if the request fails
+	*/
+	async unassignReviewer(workspaceId, reviewId, accountId) {
+		const { data } = await this.#api.DELETE("/workspaces/{workspaceId}/reviews/{reviewId}/assignees/{accountId}", { params: { path: {
+			workspaceId,
+			reviewId,
+			accountId
+		} } });
+		return data;
+	}
+	/**
+	* Verify (resolve) a review.
+	* @param workspaceId - Workspace id
+	* @param reviewId - Review ID
+	* @returns Promise that resolves with the updated review
+	* @throws {ApiError} if the request fails
+	*/
+	async verifyReview(workspaceId, reviewId) {
+		const { data } = await this.#api.POST("/workspaces/{workspaceId}/reviews/{reviewId}/verify", { params: { path: {
+			workspaceId,
+			reviewId
+		} } });
+		return data;
+	}
+	/**
+	* Reopen a resolved review.
+	* @param workspaceId - Workspace id
+	* @param reviewId - Review ID
+	* @returns Promise that resolves with the updated review
+	* @throws {ApiError} if the request fails
+	*/
+	async reopenReview(workspaceId, reviewId) {
+		const { data } = await this.#api.POST("/workspaces/{workspaceId}/reviews/{reviewId}/reopen", { params: { path: {
+			workspaceId,
+			reviewId
+		} } });
+		return data;
+	}
+	/**
+	* Get a review's timeline: the events in its life.
+	* @param workspaceId - Workspace id
+	* @param reviewId - Review ID
+	* @param query - Optional pagination (limit, after)
+	* @returns Promise that resolves with a paginated list of review events
+	* @throws {ApiError} if the request fails
+	*/
+	async getTimeline(workspaceId, reviewId, query) {
+		const { data } = await this.#api.GET("/workspaces/{workspaceId}/reviews/{reviewId}/timeline", { params: {
+			path: {
+				workspaceId,
+				reviewId
+			},
+			query
+		} });
+		return data;
+	}
+	/**
+	* Link a detection to a review (idempotent).
+	* @param workspaceId - Workspace id
+	* @param reviewId - Review ID
+	* @param detectionId - Detection ID
+	* @returns Promise that resolves with the updated review
+	* @throws {ApiError} if the request fails
+	*/
+	async linkDetection(workspaceId, reviewId, detectionId) {
+		const { data } = await this.#api.POST("/workspaces/{workspaceId}/reviews/{reviewId}/detections/{detectionId}", { params: { path: {
+			workspaceId,
+			reviewId,
+			detectionId
+		} } });
+		return data;
+	}
+	/**
+	* Link a redaction to a review (idempotent).
+	* @param workspaceId - Workspace id
+	* @param reviewId - Review ID
+	* @param redactionId - Redaction ID
+	* @returns Promise that resolves with the updated review
+	* @throws {ApiError} if the request fails
+	*/
+	async linkRedaction(workspaceId, reviewId, redactionId) {
+		const { data } = await this.#api.POST("/workspaces/{workspaceId}/reviews/{reviewId}/redactions/{redactionId}", { params: { path: {
+			workspaceId,
+			reviewId,
+			redactionId
+		} } });
+		return data;
+	}
+};
+
 //#endregion
 //#region src/services/status.ts
 /**
@@ -2173,5 +2368,5 @@ var Workspaces = class {
 };
 
 //#endregion
-export { Auth as _, Status as a, Activities as b, Policies as c, Members as d, Invites as f, Capabilities as g, Connections as h, Syncs as i, Pipelines as l, Detections as m, Webhooks as n, Redactions as o, Documents as p, Threads as r, Providers as s, Workspaces as t, Notifications as u, ApiTokens as v, Account as x, Analytics as y };
-//# sourceMappingURL=services-Bt15MerP.js.map
+export { Activities as C, Analytics as S, Detections as _, Status as a, Auth as b, Providers as c, Notifications as d, Members as f, Documents as g, GuestAuth as h, Syncs as i, Policies as l, GuestCapabilities as m, Webhooks as n, Reviews as o, Invites as p, Threads as r, Redactions as s, Workspaces as t, Pipelines as u, Connections as v, Account as w, ApiTokens as x, Capabilities as y };
+//# sourceMappingURL=services-BMmcawiT.js.map