@nvisy/sdk 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -8,6 +8,38 @@ and this project adheres to
 
 ## [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
@@ -107,7 +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.3.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.
+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
-- Debug logging for development
-- 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,12 +22,21 @@ Official TypeScript SDK for the Nvisy AI-powered document processing platform.
 npm install @nvisy/sdk
 ```
 
-## Usage
+## Quick Start
 
 ```typescript
 import { Nvisy } from "@nvisy/sdk";
 
-const nvisy = new Nvisy({
+const client = new Nvisy({ apiToken: "your-api-token" });
+
+const account = await client.account.getAccount();
+const workspaces = await client.workspaces.listWorkspaces();
+```
+
+The client accepts additional options:
+
+```typescript
+const client = new Nvisy({
   apiToken: "your-api-token", // Required
   baseUrl: "https://api.nvisy.com", // Optional
   userAgent: "MyApp/1.0.0", // Optional
@@ -32,25 +45,35 @@ const nvisy = new Nvisy({
     "X-Custom-Header": "value",
   },
 });
-
-const account = await nvisy.account.getAccount();
-const workspaces = await nvisy.workspaces.listWorkspaces();
 ```
 
-## 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

@@ -1,15 +1,6 @@
-import { C as ClientConfig } from '../config-L7FKq_q5.js';
-import { L as Login, A as AuthToken, S as Signup } from '../auth-CncOz2vx.js';
-
-/**
- * @fileoverview Configuration types for standalone auth functions.
- *
- * This module provides configuration options for authentication operations
- * that don't require an existing API token.
- *
- * @module auth/config
- */
-
+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.
  *
@@ -27,29 +18,8 @@ import { L as Login, A as AuthToken, S as Signup } from '../auth-CncOz2vx.js';
  * ```
  */
 type AuthConfig = Omit<ClientConfig, "apiToken">;
-
-/**
- * @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 });
- * ```
- */
-
+//#endregion
+//#region src/auth/password.d.ts
 /**
  * Login with email and password to obtain an auth token.
  *
@@ -101,5 +71,6 @@ declare function login(credentials: Login, config?: AuthConfig): Promise<AuthTok
  * ```
  */
 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

@@ -1,184 +1,106 @@
-import createClient from 'openapi-fetch';
+import { i as DEFAULTS, t as errorMiddleware } from "../error-DmkKaDjI.js";
+import createClient from "openapi-fetch";
 
-// src/auth/password.ts
-
-// src/config.ts
-var VERSION = "0.3.0";
-var DEFAULTS = {
-  /**
-   * Default base URL for the Nvisy API.
-   */
-  BASE_URL: "https://api.nvisy.com",
-  /**
-   * Default user agent string.
-   */
-  USER_AGENT: `@nvisy/sdk v.${VERSION}`
-};
-
-// src/errors.ts
-var NvisyError = class extends Error {
-  /**
-   * The error class name.
-   */
-  name;
-  /**
-   * Creates a new NvisyError.
-   *
-   * @param message - The error message
-   */
-  constructor(message) {
-    super(message);
-    this.name = this.constructor.name;
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, this.constructor);
-    }
-  }
-};
-var NvisyApiError = class extends NvisyError {
-  /**
-   * The error type identifier (e.g., "ValidationError", "NotFoundError").
-   */
-  name;
-  /**
-   * Human-readable error message safe for display to end users.
-   */
-  message;
-  /**
-   * The resource type that the error relates to (e.g., "account", "project").
-   * May be null if the error is not resource-specific.
-   */
-  resource;
-  /**
-   * A helpful suggestion for resolving the error.
-   * May be null if no suggestion is available.
-   */
-  suggestion;
-  /**
-   * Field-specific validation errors.
-   * Present when the error is due to invalid input data.
-   */
-  validation;
-  /**
-   * HTTP status code of the response (e.g., 400, 404, 500).
-   */
-  statusCode;
-  /**
-   * Creates a new NvisyApiError from an API error response.
-   *
-   * @param response - The error response from the API
-   * @param statusCode - The HTTP status code of the response
-   */
-  constructor(response, statusCode) {
-    super(response.message);
-    this.name = response.name;
-    this.message = response.message;
-    this.resource = response.resource;
-    this.suggestion = response.suggestion;
-    this.validation = response.validation;
-    this.statusCode = statusCode;
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, this.constructor);
-    }
-  }
-  /**
-   * Checks if this is a client error (4xx status code).
-   *
-   * Client errors indicate problems with the request itself, such as
-   * invalid input, missing authentication, or accessing non-existent resources.
-   *
-   * @returns True if the status code is in the 4xx range
-   */
-  isClientError() {
-    return this.statusCode >= 400 && this.statusCode < 500;
-  }
-  /**
-   * Checks if this is a server error (5xx status code).
-   *
-   * Server errors indicate problems on the API side. These are typically
-   * transient and may succeed if retried.
-   *
-   * @returns True if the status code is in the 5xx range
-   */
-  isServerError() {
-    return this.statusCode >= 500;
-  }
-  /**
-   * Determines if this error is safe to retry.
-   *
-   * An error is considered retryable if it's a server error (5xx),
-   * a request timeout (408), or rate limiting (429).
-   *
-   * @returns True if the request may succeed on retry
-   */
-  isRetryable() {
-    return this.statusCode >= 500 || // Server errors
-    this.statusCode === 408 || // Request timeout
-    this.statusCode === 429;
-  }
-  /**
-   * Converts the error to a plain {@link ErrorResponse} object.
-   *
-   * Useful for serialization or logging.
-   *
-   * @returns A plain object representation of the error
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      resource: this.resource,
-      suggestion: this.suggestion,
-      validation: this.validation
-    };
-  }
-};
-
-// src/middleware/error.ts
-var errorMiddleware = {
-  async onResponse({ response }) {
-    if (!response.ok) {
-      const error = await response.clone().json();
-      throw new NvisyApiError(error, response.status);
-    }
-    return response;
-  },
-  onError({ error }) {
-    if (error instanceof Error) {
-      throw new NvisyError(error.message);
-    }
-    throw new NvisyError("An unknown network error occurred");
-  }
-};
-
-// src/auth/password.ts
+//#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;
+	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 client = createAuthClient(config);
-  const { data } = await client.POST("/auth/login", {
-    body: credentials
-  });
-  return data;
+	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 client = createAuthClient(config);
-  const { data } = await client.POST("/auth/signup", {
-    body: details
-  });
-  return data;
+	const { data } = await createAuthClient(config).POST("/auth/signup/", { body: details });
+	return data;
 }
 
+//#endregion
 export { login, signup };
-//# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/auth/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/config.ts","../../src/errors.ts","../../src/middleware/error.ts","../../src/auth/password.ts"],"names":[],"mappings":";;;;;AAcO,IAAM,OAAA,GAAU,OAAA;AA8DhB,IAAM,QAAA,GAAW;AAAA;AAAA;AAAA;AAAA,EAIvB,QAAA,EAAU,uBAAA;AAAA;AAAA;AAAA;AAAA,EAKV,UAAA,EAAY,gBAAgB,OAAO,CAAA;AACpC,CAAA;;;ACtDO,IAAM,UAAA,GAAN,cAAyB,KAAA,CAAM;AAAA;AAAA;AAAA;AAAA,EAIrB,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOhB,YAAY,OAAA,EAAiB;AAC5B,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,KAAK,WAAA,CAAY,IAAA;AAE7B,IAAA,IAAI,MAAM,iBAAA,EAAmB;AAC5B,MAAA,KAAA,CAAM,iBAAA,CAAkB,IAAA,EAAM,IAAA,CAAK,WAAW,CAAA;AAAA,IAC/C;AAAA,EACD;AACD,CAAA;AAwBO,IAAM,aAAA,GAAN,cAA4B,UAAA,CAAoC;AAAA;AAAA;AAAA;AAAA,EAItD,IAAA;AAAA;AAAA;AAAA;AAAA,EAKA,OAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,QAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAA;AAAA;AAAA;AAAA;AAAA,EAKA,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQhB,WAAA,CAAY,UAAyB,UAAA,EAAoB;AACxD,IAAA,KAAA,CAAM,SAAS,OAAO,CAAA;AACtB,IAAA,IAAA,CAAK,OAAO,QAAA,CAAS,IAAA;AACrB,IAAA,IAAA,CAAK,UAAU,QAAA,CAAS,OAAA;AACxB,IAAA,IAAA,CAAK,WAAW,QAAA,CAAS,QAAA;AACzB,IAAA,IAAA,CAAK,aAAa,QAAA,CAAS,UAAA;AAC3B,IAAA,IAAA,CAAK,aAAa,QAAA,CAAS,UAAA;AAC3B,IAAA,IAAA,CAAK,UAAA,GAAa,UAAA;AAElB,IAAA,IAAI,MAAM,iBAAA,EAAmB;AAC5B,MAAA,KAAA,CAAM,iBAAA,CAAkB,IAAA,EAAM,IAAA,CAAK,WAAW,CAAA;AAAA,IAC/C;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,aAAA,GAAyB;AACxB,IAAA,OAAO,IAAA,CAAK,UAAA,IAAc,GAAA,IAAO,IAAA,CAAK,UAAA,GAAa,GAAA;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,aAAA,GAAyB;AACxB,IAAA,OAAO,KAAK,UAAA,IAAc,GAAA;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,WAAA,GAAuB;AACtB,IAAA,OACC,KAAK,UAAA,IAAc,GAAA;AAAA,IACnB,KAAK,UAAA,KAAe,GAAA;AAAA,IACpB,KAAK,UAAA,KAAe,GAAA;AAAA,EAEtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAA,GAAwB;AACvB,IAAA,OAAO;AAAA,MACN,MAAM,IAAA,CAAK,IAAA;AAAA,MACX,SAAS,IAAA,CAAK,OAAA;AAAA,MACd,UAAU,IAAA,CAAK,QAAA;AAAA,MACf,YAAY,IAAA,CAAK,UAAA;AAAA,MACjB,YAAY,IAAA,CAAK;AAAA,KAClB;AAAA,EACD;AACD,CAAA;;;ACjLO,IAAM,eAAA,GAA8B;AAAA,EAC1C,MAAM,UAAA,CAAW,EAAE,QAAA,EAAS,EAAG;AAC9B,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AACjB,MAAA,MAAM,KAAA,GAAS,MAAM,QAAA,CAAS,KAAA,GAAQ,IAAA,EAAK;AAC3C,MAAA,MAAM,IAAI,aAAA,CAAc,KAAA,EAAO,QAAA,CAAS,MAAM,CAAA;AAAA,IAC/C;AACA,IAAA,OAAO,QAAA;AAAA,EACR,CAAA;AAAA,EAEA,OAAA,CAAQ,EAAE,KAAA,EAAM,EAAG;AAElB,IAAA,IAAI,iBAAiB,KAAA,EAAO;AAC3B,MAAA,MAAM,IAAI,UAAA,CAAW,KAAA,CAAM,OAAO,CAAA;AAAA,IACnC;AACA,IAAA,MAAM,IAAI,WAAW,mCAAmC,CAAA;AAAA,EACzD;AACD,CAAA;;;ACYA,SAAS,iBAAiB,MAAA,EAAqB;AAC9C,EAAA,MAAM,OAAA,GAAkC;AAAA,IACvC,cAAA,EAAgB,kBAAA;AAAA,IAChB,YAAA,EAAc,MAAA,EAAQ,SAAA,IAAa,QAAA,CAAS,UAAA;AAAA,IAC5C,GAAG,MAAA,EAAQ;AAAA,GACZ;AAEA,EAAA,MAAM,SAAS,YAAA,CAAoB;AAAA,IAClC,OAAA,EAAS,MAAA,EAAQ,OAAA,IAAW,QAAA,CAAS,QAAA;AAAA,IACrC;AAAA,GACA,CAAA;AAED,EAAA,MAAA,CAAO,IAAI,eAAe,CAAA;AAC1B,EAAA,OAAO,MAAA;AACR;AA0BA,eAAsB,KAAA,CACrB,aACA,MAAA,EACqB;AACrB,EAAA,MAAM,MAAA,GAAS,iBAAiB,MAAM,CAAA;AACtC,EAAA,MAAM,EAAE,IAAA,EAAK,GAAI,MAAM,MAAA,CAAO,KAAK,aAAA,EAAe;AAAA,IACjD,IAAA,EAAM;AAAA,GACN,CAAA;AACD,EAAA,OAAO,IAAA;AACR;AA2BA,eAAsB,MAAA,CACrB,SACA,MAAA,EACqB;AACrB,EAAA,MAAM,MAAA,GAAS,iBAAiB,MAAM,CAAA;AACtC,EAAA,MAAM,EAAE,IAAA,EAAK,GAAI,MAAM,MAAA,CAAO,KAAK,cAAA,EAAgB;AAAA,IAClD,IAAA,EAAM;AAAA,GACN,CAAA;AACD,EAAA,OAAO,IAAA;AACR","file":"index.js","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 * Current SDK version.\n *\n * Used in the default user agent string and for version tracking.\n */\nexport const VERSION = \"0.3.0\";\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\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","/**\n * @fileoverview Error types for the Nvisy SDK.\n *\n * This module defines the error hierarchy used throughout the SDK:\n * - {@link NvisyError} - Base error class for all SDK errors\n * - {@link NvisyApiError} - Errors returned by the Nvisy API (4xx/5xx responses)\n *\n * @module errors\n */\n\nimport type { ErrorResponse } from \"@/datatypes/index.js\";\n\n// Re-export ErrorResponse type for convenience\nexport type { ErrorResponse } from \"@/datatypes/index.js\";\n\n/**\n * Base error class for all Nvisy SDK errors.\n *\n * This class provides common functionality for all SDK errors.\n * It ensures proper error naming and stack traces.\n *\n * @example\n * ```typescript\n * try {\n *   const client = new Client({ apiToken: \"\" });\n * } catch (error) {\n *   if (error instanceof NvisyError) {\n *     console.log(\"SDK error:\", error.message);\n *   }\n * }\n * ```\n */\nexport class NvisyError extends Error {\n\t/**\n\t * The error class name.\n\t */\n\tpublic readonly name: string;\n\n\t/**\n\t * Creates a new NvisyError.\n\t *\n\t * @param message - The error message\n\t */\n\tconstructor(message: string) {\n\t\tsuper(message);\n\t\tthis.name = this.constructor.name;\n\n\t\tif (Error.captureStackTrace) {\n\t\t\tError.captureStackTrace(this, this.constructor);\n\t\t}\n\t}\n}\n\n/**\n * Error thrown when the Nvisy API returns an error response.\n *\n * This error class wraps the API's {@link ErrorResponse} format and adds\n * the HTTP status code. It provides helper methods to categorize errors\n * and determine if they are retryable.\n *\n * @example\n * ```typescript\n * try {\n *   await client.account.getAccount();\n * } catch (error) {\n *   if (error instanceof NvisyApiError) {\n *     console.log(`API Error: ${error.message}`);\n *     console.log(`Status: ${error.statusCode}`);\n *     if (error.isRetryable()) {\n *       // Implement retry logic\n *     }\n *   }\n * }\n * ```\n */\nexport class NvisyApiError extends NvisyError implements ErrorResponse {\n\t/**\n\t * The error type identifier (e.g., \"ValidationError\", \"NotFoundError\").\n\t */\n\tpublic readonly name: string;\n\n\t/**\n\t * Human-readable error message safe for display to end users.\n\t */\n\tpublic readonly message: string;\n\n\t/**\n\t * The resource type that the error relates to (e.g., \"account\", \"project\").\n\t * May be null if the error is not resource-specific.\n\t */\n\tpublic readonly resource?: string | null;\n\n\t/**\n\t * A helpful suggestion for resolving the error.\n\t * May be null if no suggestion is available.\n\t */\n\tpublic readonly suggestion?: string | null;\n\n\t/**\n\t * Field-specific validation errors.\n\t * Present when the error is due to invalid input data.\n\t */\n\tpublic readonly validation?: ErrorResponse[\"validation\"];\n\n\t/**\n\t * HTTP status code of the response (e.g., 400, 404, 500).\n\t */\n\tpublic readonly statusCode: number;\n\n\t/**\n\t * Creates a new NvisyApiError from an API error response.\n\t *\n\t * @param response - The error response from the API\n\t * @param statusCode - The HTTP status code of the response\n\t */\n\tconstructor(response: ErrorResponse, statusCode: number) {\n\t\tsuper(response.message);\n\t\tthis.name = response.name;\n\t\tthis.message = response.message;\n\t\tthis.resource = response.resource;\n\t\tthis.suggestion = response.suggestion;\n\t\tthis.validation = response.validation;\n\t\tthis.statusCode = statusCode;\n\n\t\tif (Error.captureStackTrace) {\n\t\t\tError.captureStackTrace(this, this.constructor);\n\t\t}\n\t}\n\n\t/**\n\t * Checks if this is a client error (4xx status code).\n\t *\n\t * Client errors indicate problems with the request itself, such as\n\t * invalid input, missing authentication, or accessing non-existent resources.\n\t *\n\t * @returns True if the status code is in the 4xx range\n\t */\n\tisClientError(): boolean {\n\t\treturn this.statusCode >= 400 && this.statusCode < 500;\n\t}\n\n\t/**\n\t * Checks if this is a server error (5xx status code).\n\t *\n\t * Server errors indicate problems on the API side. These are typically\n\t * transient and may succeed if retried.\n\t *\n\t * @returns True if the status code is in the 5xx range\n\t */\n\tisServerError(): boolean {\n\t\treturn this.statusCode >= 500;\n\t}\n\n\t/**\n\t * Determines if this error is safe to retry.\n\t *\n\t * An error is considered retryable if it's a server error (5xx),\n\t * a request timeout (408), or rate limiting (429).\n\t *\n\t * @returns True if the request may succeed on retry\n\t */\n\tisRetryable(): boolean {\n\t\treturn (\n\t\t\tthis.statusCode >= 500 || // Server errors\n\t\t\tthis.statusCode === 408 || // Request timeout\n\t\t\tthis.statusCode === 429 // Rate limited\n\t\t);\n\t}\n\n\t/**\n\t * Converts the error to a plain {@link ErrorResponse} object.\n\t *\n\t * Useful for serialization or logging.\n\t *\n\t * @returns A plain object representation of the error\n\t */\n\ttoJSON(): ErrorResponse {\n\t\treturn {\n\t\t\tname: this.name,\n\t\t\tmessage: this.message,\n\t\t\tresource: this.resource,\n\t\t\tsuggestion: this.suggestion,\n\t\t\tvalidation: this.validation,\n\t\t};\n\t}\n}\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","/**\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"]}
+{"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"}