@nvisy/sdk 0.2.0 → 0.4.0

package/CHANGELOG.md

@@ -8,7 +8,82 @@ and this project adheres to
 
 ## [Unreleased]
 
-## [0.2.0] - Unreleased
+## [0.4.0] - 2026-07-12
+
+### Added
+
+- `contexts` service and datatypes (`Context`, `CreateContext`,
+  `UpdateContext`, `ContextEntry`, `ContextsPage`)
+- `connections` service and datatypes (`Connection`, `CreateConnection`,
+  `UpdateConnection`, `ConnectionsQuery`, `ConnectionsPage`)
+- `pipelines` service and datatypes (`Pipeline`, `CreatePipeline`,
+  `UpdatePipeline`, `PipelineDefinition`, `PipelineStatus`, `PipelineSummary`,
+  `PipelineSummariesPage`, and more)
+- `policies` service and datatypes (`Policy`, `CreatePolicy`, `UpdatePolicy`,
+  `PolicyRule`, `PolicyAction`, `PoliciesPage`)
+- `Health` datatypes for the health endpoint (`Health`, `HealthStatus`,
+  `ComponentHealth`, `CheckHealth`)
+
+### Changed
+
+- Regenerated the API schema against the redacted-pipeline platform API
+- **BREAKING**: `runs` is now a pipeline-run service: `listRuns(pipelineId)`,
+  `createRun(pipelineId)`, `getRun(runId)`, `getDetections(runId)`,
+  `redact(runId)` (was integration-run based)
+- **BREAKING**: `status.checkHealth()` now returns `Health` (was
+  `MonitorStatus`)
+- **BREAKING**: `NvisyApiError.resource` and `.suggestion` are now
+  `string | undefined` (were `string | null`)
+
+### Removed
+
+- **BREAKING**: `annotations`, `comments`, `documents`, and `integrations`
+  services and their datatypes (no longer part of the API)
+
+## [0.3.0] - 2026-01-09
+
+### Added
+
+- Logging middleware (`withLogging: true` in config) for request/response
+  logging
+- Page types for all paginated responses: `ActivitiesPage`, `AnnotationsPage`,
+  `ApiTokensPage`, `CommentsPage`, `DocumentsPage`, `FilesPage`,
+  `IntegrationsPage`, `IntegrationRunsPage`, `InvitesPage`, `MembersPage`,
+  `NotificationsPage`, `WebhooksPage`, `WorkspacesPage`
+
+### Changed
+
+- Renamed `Client` class to `Nvisy`
+- Renamed service classes from `*Service` (e.g. `WorkspacesService` →
+  `Workspaces`)
+- Renamed service handler methods to include entity names (e.g. `list` →
+  `listWorkspaces`)
+- Renamed `ClientError` to `NvisyError` and `ApiError` to `NvisyApiError`
+- `NvisyApiError` now extends `NvisyError`
+- **BREAKING**: API path parameters now use camelCase (`workspaceId` instead of
+  `workspace_id`)
+- **BREAKING**: Pagination changed from offset-based to cursor-based
+  - Query params: `offset`/`limit` → `limit`/`after`
+  - Pagination type: `Pagination` → `CursorPagination`
+- **BREAKING**: All list methods now return paginated response objects instead
+  of arrays
+  - Return type: `Promise<T[]>` → `Promise<TPage>` (e.g., `WorkspacesPage`)
+  - Response structure: `{ items: T[], total?: number, nextCursor?: string }`
+- **BREAKING**: Comments service methods simplified
+  - `updateComment(fileId, commentId, ...)` → `updateComment(commentId, ...)`
+  - `deleteComment(fileId, commentId)` → `deleteComment(commentId)`
+- Renamed query types to match schema (dropped `Query` suffix)
+- Renamed request types (dropped `Request` suffix)
+
+### Removed
+
+- `ConfigError` and `NetworkError` classes (use `NvisyError` instead)
+- Re-exports of datatypes and services from main entry point (use
+  `@nvisy/sdk/datatypes` and `@nvisy/sdk/services`)
+- `DocumentStatus` type (removed from API)
+- `ListIntegrationsQuery` type (integration type filter removed)
+
+## [0.2.0] - 2025-06-15
 
 ### Added
 
@@ -31,7 +106,8 @@ and this project adheres to
 
 - `ClientBuilder` class and `Client.builder()` method
 - `Client.fromEnvironment()` method
-- Environment variable support (`NVISY_API_TOKEN`, `NVISY_BASE_URL`, `NVISY_USER_AGENT`)
+- Environment variable support (`NVISY_API_TOKEN`, `NVISY_BASE_URL`,
+  `NVISY_USER_AGENT`)
 - Manual type definitions in datatypes (now use schema re-exports)
 
 ## [0.1.0] - 2025-10-15
@@ -63,6 +139,8 @@ and this project adheres to
 - Network error handling for timeouts, DNS resolution, and connection issues
 - Configuration validation with detailed error messages
 
-[Unreleased]: https://github.com/nvisycom/sdk-ts/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/nvisycom/sdk-ts/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/nvisycom/sdk-ts/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/nvisycom/sdk-ts/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/nvisycom/sdk-ts/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/nvisycom/sdk-ts/releases/tag/v0.1.0

package/README.md

@@ -1,16 +1,20 @@
-# Nvisy.com SDK for TypeScript/JavaScript
+# Nvisy SDK for TypeScript
 
-[![npm version](https://img.shields.io/npm/v/@nvisy/sdk?color=000000&style=flat-square)](https://www.npmjs.com/package/@nvisy/sdk)
-[![build](https://img.shields.io/github/actions/workflow/status/nvisycom/sdk-ts/build.yml?branch=main&color=000000&style=flat-square)](https://github.com/nvisycom/sdk-ts/actions/workflows/build.yml)
+[![npm](https://img.shields.io/npm/v/@nvisy/sdk?style=flat-square)](https://www.npmjs.com/package/@nvisy/sdk)
+[![Build](https://img.shields.io/github/actions/workflow/status/nvisycom/sdk-ts/build.yml?branch=main&label=build%20%26%20test&style=flat-square)](https://github.com/nvisycom/sdk-ts/actions/workflows/build.yml)
 
-Official TypeScript SDK for the Nvisy AI-powered document processing platform. Transform documents into usable data and apply intelligent edits with ease.
+TypeScript client for the [Nvisy](https://nvisy.com/) multimodal redaction platform.
 
-## Features
+Nvisy detects and removes sensitive information across documents, images, and audio.
+It combines deterministic patterns, NER, computer vision, and LLM-driven classification
+into auditable, policy-driven pipelines built for regulated industries such as
+healthcare, legal, government, and financial services.
 
-- Modern ES2022+ JavaScript target
-- Full TypeScript support with strict typing
-- Built-in environment variable support
-- Individual module exports for optimal bundling
+> [!WARNING]
+> **Active development: API not stable.** This project is under active
+> development. Public APIs, configuration shapes, and on-disk formats may change
+> without notice between releases. Pin a specific version if you depend on this
+> in production.
 
 ## Installation
 
@@ -18,50 +22,58 @@ Official TypeScript SDK for the Nvisy AI-powered document processing platform. T
 npm install @nvisy/sdk
 ```
 
-## Usage
-
-### Basic Usage
-
-Create a client with your API token:
+## Quick Start
 
 ```typescript
-import { Client } from "@nvisy/sdk";
+import { Nvisy } from "@nvisy/sdk";
 
-const client = new Client({ apiToken: "your-api-token" });
+const client = new Nvisy({ apiToken: "your-api-token" });
 
-const account = await client.account.get();
-const projects = await client.projects.list();
+const account = await client.account.getAccount();
+const workspaces = await client.workspaces.listWorkspaces();
 ```
 
-### Configuration Options
+The client accepts additional options:
 
 ```typescript
-import { Client } from "@nvisy/sdk";
-
-const client = new Client({
+const client = new Nvisy({
   apiToken: "your-api-token", // Required
-  baseUrl: "https://api.nvisy.com", // Optional: API endpoint (default shown)
-  userAgent: "MyApp/1.0.0", // Optional: custom user agent
-  headers: { // Optional: custom headers
+  baseUrl: "https://api.nvisy.com", // Optional
+  userAgent: "MyApp/1.0.0", // Optional
+  withLogging: true, // Optional
+  headers: { // Optional
     "X-Custom-Header": "value",
   },
 });
 ```
 
-## Changelog
+## Features
 
-See [CHANGELOG.md](CHANGELOG.md) for release notes and version history.
+- Modern ES2022+ JavaScript target
+- Full TypeScript support with strict typing
+- Debug logging for development
+- Individual module exports for optimal bundling
+
+## Deployment
+
+The fastest way to get started is with [Nvisy Cloud](https://nvisy.com).
+
+To run locally, see the [nvisycom/runtime](https://github.com/nvisycom/runtime) and [nvisycom/server](https://github.com/nvisycom/server) repositories.
 
 ## Contributing
 
-See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines.
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and contribution guidelines.
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for release notes and version history.
 
 ## License
 
-MIT License - see [LICENSE.txt](LICENSE.txt) for details.
+MIT License, see [LICENSE.txt](LICENSE.txt)
 
 ## Support
 
-- Documentation: [docs.nvisy.com](https://docs.nvisy.com)
-- Issues: [GitHub Issues](https://github.com/nvisycom/sdk-ts/issues)
-- Email: [support@nvisy.com](mailto:support@nvisy.com)
+- **Documentation**: [docs.nvisy.com](https://docs.nvisy.com)
+- **Issues**: [github.com/nvisycom/sdk-ts/issues](https://github.com/nvisycom/sdk-ts/issues)
+- **Email**: [support@nvisy.com](mailto:support@nvisy.com)

package/dist/auth/index.d.ts

@@ -0,0 +1,76 @@
+import { t as ClientConfig } from "../config-BRQp8Cat.js";
+import { At as Signup, Ot as AuthToken, kt as Login } from "../index-Cmm2g3SG.js";
+//#region src/auth/config.d.ts
+/**
+ * Configuration options for standalone authentication functions.
+ *
+ * This type omits `apiToken` from {@link ClientConfig} since auth functions
+ * are used to obtain a token in the first place.
+ *
+ * @example
+ * ```typescript
+ * import { login } from "@nvisy/sdk/auth";
+ *
+ * const token = await login(
+ *   { email: "user@example.com", password: "..." },
+ *   { baseUrl: "https://api.nvisy.com" }
+ * );
+ * ```
+ */
+type AuthConfig = Omit<ClientConfig, "apiToken">;
+//#endregion
+//#region src/auth/password.d.ts
+/**
+ * Login with email and password to obtain an auth token.
+ *
+ * This is a standalone function that doesn't require an existing {@link Client}
+ * instance. Use the returned token to create an authenticated client.
+ *
+ * @param credentials - Login credentials (email and password)
+ * @param config - Optional configuration (baseUrl, headers, userAgent)
+ * @returns Promise that resolves with the auth token
+ * @throws {ApiError} If the credentials are invalid or the request fails
+ *
+ * @example
+ * ```typescript
+ * import { login } from "@nvisy/sdk/auth";
+ * import { Nvisy } from "@nvisy/sdk";
+ *
+ * const token = await login({
+ *   email: "user@example.com",
+ *   password: "your-password",
+ * });
+ *
+ * const nvisy = new Nvisy({ apiToken: token.accessToken });
+ * ```
+ */
+declare function login(credentials: Login, config?: AuthConfig): Promise<AuthToken>;
+/**
+ * Sign up a new account to obtain an auth token.
+ *
+ * This is a standalone function that doesn't require an existing {@link Client}
+ * instance. Use the returned token to create an authenticated client.
+ *
+ * @param details - Signup details (name, email, password, etc.)
+ * @param config - Optional configuration (baseUrl, headers, userAgent)
+ * @returns Promise that resolves with the auth token
+ * @throws {ApiError} If the signup fails (e.g., email already exists)
+ *
+ * @example
+ * ```typescript
+ * import { signup } from "@nvisy/sdk/auth";
+ * import { Nvisy } from "@nvisy/sdk";
+ *
+ * const token = await signup({
+ *   name: "John Doe",
+ *   email: "john@example.com",
+ *   password: "secure-password",
+ * });
+ *
+ * const nvisy = new Nvisy({ apiToken: token.accessToken });
+ * ```
+ */
+declare function signup(details: Signup, config?: AuthConfig): Promise<AuthToken>;
+//#endregion
+export { type AuthConfig, login, signup };
+//# sourceMappingURL=index.d.ts.map

package/dist/auth/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/auth/config.ts","../../src/auth/password.ts"],"mappings":";;;;;;;;;;;;;;;;;;;KA2BY,aAAa,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;iBCiDR,MACrB,aAAa,OACb,SAAS,aACP,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiCW,OACrB,SAAS,QACT,SAAS,aACP,QAAQ"}

package/dist/auth/index.js

@@ -0,0 +1,106 @@
+import { i as DEFAULTS, t as errorMiddleware } from "../error-DmkKaDjI.js";
+import createClient from "openapi-fetch";
+
+//#region src/auth/password.ts
+/**
+* @fileoverview Standalone password-based authentication functions.
+*
+* This module provides functions for login and signup that don't require
+* an existing API token. Use these to obtain an auth token, then create
+* an authenticated {@link Client} instance.
+*
+* @module auth/password
+*
+* @example
+* ```typescript
+* import { login, signup } from "@nvisy/sdk/auth";
+* import { Nvisy } from "@nvisy/sdk";
+*
+* // Login to get a token
+* const token = await login({ email: "user@example.com", password: "..." });
+*
+* // Create authenticated client
+* const nvisy = new Nvisy({ apiToken: token.accessToken });
+* ```
+*/
+/**
+* Creates an unauthenticated API client for auth operations.
+*
+* @param config - Optional configuration options
+* @returns A configured openapi-fetch client without authentication
+* @internal
+*/
+function createAuthClient(config) {
+	const headers = {
+		"Content-Type": "application/json",
+		"User-Agent": config?.userAgent ?? DEFAULTS.USER_AGENT,
+		...config?.headers
+	};
+	const client = createClient({
+		baseUrl: config?.baseUrl ?? DEFAULTS.BASE_URL,
+		headers
+	});
+	client.use(errorMiddleware);
+	return client;
+}
+/**
+* Login with email and password to obtain an auth token.
+*
+* This is a standalone function that doesn't require an existing {@link Client}
+* instance. Use the returned token to create an authenticated client.
+*
+* @param credentials - Login credentials (email and password)
+* @param config - Optional configuration (baseUrl, headers, userAgent)
+* @returns Promise that resolves with the auth token
+* @throws {ApiError} If the credentials are invalid or the request fails
+*
+* @example
+* ```typescript
+* import { login } from "@nvisy/sdk/auth";
+* import { Nvisy } from "@nvisy/sdk";
+*
+* const token = await login({
+*   email: "user@example.com",
+*   password: "your-password",
+* });
+*
+* const nvisy = new Nvisy({ apiToken: token.accessToken });
+* ```
+*/
+async function login(credentials, config) {
+	const { data } = await createAuthClient(config).POST("/auth/login/", { body: credentials });
+	return data;
+}
+/**
+* Sign up a new account to obtain an auth token.
+*
+* This is a standalone function that doesn't require an existing {@link Client}
+* instance. Use the returned token to create an authenticated client.
+*
+* @param details - Signup details (name, email, password, etc.)
+* @param config - Optional configuration (baseUrl, headers, userAgent)
+* @returns Promise that resolves with the auth token
+* @throws {ApiError} If the signup fails (e.g., email already exists)
+*
+* @example
+* ```typescript
+* import { signup } from "@nvisy/sdk/auth";
+* import { Nvisy } from "@nvisy/sdk";
+*
+* const token = await signup({
+*   name: "John Doe",
+*   email: "john@example.com",
+*   password: "secure-password",
+* });
+*
+* const nvisy = new Nvisy({ apiToken: token.accessToken });
+* ```
+*/
+async function signup(details, config) {
+	const { data } = await createAuthClient(config).POST("/auth/signup/", { body: details });
+	return data;
+}
+
+//#endregion
+export { login, signup };
+//# sourceMappingURL=index.js.map

package/dist/auth/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../src/auth/password.ts"],"sourcesContent":["/**\n * @fileoverview Standalone password-based authentication functions.\n *\n * This module provides functions for login and signup that don't require\n * an existing API token. Use these to obtain an auth token, then create\n * an authenticated {@link Client} instance.\n *\n * @module auth/password\n *\n * @example\n * ```typescript\n * import { login, signup } from \"@nvisy/sdk/auth\";\n * import { Nvisy } from \"@nvisy/sdk\";\n *\n * // Login to get a token\n * const token = await login({ email: \"user@example.com\", password: \"...\" });\n *\n * // Create authenticated client\n * const nvisy = new Nvisy({ apiToken: token.accessToken });\n * ```\n */\n\nimport createClient from \"openapi-fetch\";\nimport type { AuthConfig } from \"@/auth/config.js\";\nimport { DEFAULTS } from \"@/config.js\";\nimport type { AuthToken, Login, Signup } from \"@/datatypes/index.js\";\nimport { errorMiddleware } from \"@/middleware/index.js\";\nimport type { paths } from \"@/schema/api.js\";\n\n/**\n * Creates an unauthenticated API client for auth operations.\n *\n * @param config - Optional configuration options\n * @returns A configured openapi-fetch client without authentication\n * @internal\n */\nfunction createAuthClient(config?: AuthConfig) {\n\tconst headers: Record<string, string> = {\n\t\t\"Content-Type\": \"application/json\",\n\t\t\"User-Agent\": config?.userAgent ?? DEFAULTS.USER_AGENT,\n\t\t...config?.headers,\n\t};\n\n\tconst client = createClient<paths>({\n\t\tbaseUrl: config?.baseUrl ?? DEFAULTS.BASE_URL,\n\t\theaders,\n\t});\n\n\tclient.use(errorMiddleware);\n\treturn client;\n}\n\n/**\n * Login with email and password to obtain an auth token.\n *\n * This is a standalone function that doesn't require an existing {@link Client}\n * instance. Use the returned token to create an authenticated client.\n *\n * @param credentials - Login credentials (email and password)\n * @param config - Optional configuration (baseUrl, headers, userAgent)\n * @returns Promise that resolves with the auth token\n * @throws {ApiError} If the credentials are invalid or the request fails\n *\n * @example\n * ```typescript\n * import { login } from \"@nvisy/sdk/auth\";\n * import { Nvisy } from \"@nvisy/sdk\";\n *\n * const token = await login({\n *   email: \"user@example.com\",\n *   password: \"your-password\",\n * });\n *\n * const nvisy = new Nvisy({ apiToken: token.accessToken });\n * ```\n */\nexport async function login(\n\tcredentials: Login,\n\tconfig?: AuthConfig,\n): Promise<AuthToken> {\n\tconst client = createAuthClient(config);\n\tconst { data } = await client.POST(\"/auth/login/\", {\n\t\tbody: credentials,\n\t});\n\treturn data!;\n}\n\n/**\n * Sign up a new account to obtain an auth token.\n *\n * This is a standalone function that doesn't require an existing {@link Client}\n * instance. Use the returned token to create an authenticated client.\n *\n * @param details - Signup details (name, email, password, etc.)\n * @param config - Optional configuration (baseUrl, headers, userAgent)\n * @returns Promise that resolves with the auth token\n * @throws {ApiError} If the signup fails (e.g., email already exists)\n *\n * @example\n * ```typescript\n * import { signup } from \"@nvisy/sdk/auth\";\n * import { Nvisy } from \"@nvisy/sdk\";\n *\n * const token = await signup({\n *   name: \"John Doe\",\n *   email: \"john@example.com\",\n *   password: \"secure-password\",\n * });\n *\n * const nvisy = new Nvisy({ apiToken: token.accessToken });\n * ```\n */\nexport async function signup(\n\tdetails: Signup,\n\tconfig?: AuthConfig,\n): Promise<AuthToken> {\n\tconst client = createAuthClient(config);\n\tconst { data } = await client.POST(\"/auth/signup/\", {\n\t\tbody: details,\n\t});\n\treturn data!;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCA,SAAS,iBAAiB,QAAqB;CAC9C,MAAM,UAAkC;EACvC,gBAAgB;EAChB,cAAc,QAAQ,aAAa,SAAS;EAC5C,GAAG,QAAQ;CACZ;CAEA,MAAM,SAAS,aAAoB;EAClC,SAAS,QAAQ,WAAW,SAAS;EACrC;CACD,CAAC;CAED,OAAO,IAAI,eAAe;CAC1B,OAAO;AACR;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,eAAsB,MACrB,aACA,QACqB;CAErB,MAAM,EAAE,SAAS,MADF,iBAAiB,MACJ,CAAC,CAAC,KAAK,gBAAgB,EAClD,MAAM,YACP,CAAC;CACD,OAAO;AACR;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,eAAsB,OACrB,SACA,QACqB;CAErB,MAAM,EAAE,SAAS,MADF,iBAAiB,MACJ,CAAC,CAAC,KAAK,iBAAiB,EACnD,MAAM,QACP,CAAC;CACD,OAAO;AACR"}