@nvisy/sdk 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -8,20 +8,38 @@ and this project adheres to
 
 ## [Unreleased]
 
+## [0.2.0] - Unreleased
+
 ### Added
 
+- Generated OpenAPI schema types for type-safe API calls
+- `Client.withApiToken()` method to create a new client with a different token
+- Error middleware for automatic API error handling
+- Full API coverage with services for all endpoints
+- Comprehensive JSDoc documentation for all public APIs
+
 ### Changed
 
-### Fixed
+- Client now requires `apiToken` in configuration
+- Refactored all services to use `openapi-fetch` for type-safe API calls
+- Improved error handling with `ApiError`
+- Services now throw `ApiError` automatically via middleware
+- Datatypes now re-export schema types with convenient aliases
+- Services are created on-demand via Client getters
 
 ### Removed
 
+- `ClientBuilder` class and `Client.builder()` method
+- `Client.fromEnvironment()` method
+- 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
 
 ### Added
 
 - Initial release of the Nvisy SDK
-- `Client` class for interacting with the Nvisy document redaction API
+- `Client` class for interacting with the Nvisy document processing API
 - `ClientBuilder` class for fluent configuration building
 - Comprehensive error handling with `ClientError` and other error classes
 - Configuration management with environment variable support
@@ -45,5 +63,6 @@ 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/compare/v0.1.0...HEAD
-[0.1.0]: https://github.com/nvisycom/sdk/releases/tag/v0.1.0
+[Unreleased]: https://github.com/nvisycom/sdk-ts/compare/v0.2.0...HEAD
+[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/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Nvisy Redaction Software
+Copyright (c) 2025 Nvisy Software
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,19 +1,15 @@
-# JavaScript & TypeScript SDK
+# Nvisy.com SDK for TypeScript/JavaScript
 
 [![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/build.yml?branch=main&color=000000&style=flat-square)](https://github.com/nvisycom/sdk/actions/workflows/build.yml)
-[![node](https://img.shields.io/badge/node-%3E%3D20.0.0-000000?style=flat-square&logo=node.js&logoColor=white)](https://nodejs.org/)
-[![typescript](https://img.shields.io/badge/TypeScript-5.9+-000000?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+[![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)
 
-Official JavaScript & TypeScript SDK for the Nvisy document redaction platform.
+Official TypeScript SDK for the Nvisy AI-powered document processing platform. Transform documents into usable data and apply intelligent edits with ease.
 
 ## Features
 
-- Modern ES2022+ JavaScript with native private fields
+- Modern ES2022+ JavaScript target
 - Full TypeScript support with strict typing
-- Flexible configuration with constructor or builder pattern
 - Built-in environment variable support
-- Automatic retry logic with smart error handling
 - Individual module exports for optimal bundling
 
 ## Installation
@@ -24,71 +20,34 @@ npm install @nvisy/sdk
 
 ## Usage
 
-### Direct Configuration
+### Basic Usage
 
-Create a client by passing configuration options directly to the constructor:
+Create a client with your API token:
 
 ```typescript
 import { Client } from "@nvisy/sdk";
 
-const client = new Client({
-  apiKey: "your-api-key", // Required: 10+ chars, alphanumeric with _ and -
-  baseUrl: "https://api.nvisy.com", // Optional: API endpoint (default shown)
-  timeout: 30000, // Optional: 1000-300000ms (default: 30000)
-  maxRetries: 3, // Optional: 0-5 attempts (default: 3)
-  headers: { // Optional: custom headers
-    "X-Custom-Header": "value",
-  },
-});
-```
+const client = new Client({ apiToken: "your-api-token" });
 
-### Builder Pattern
-
-Use the fluent builder API for more readable configuration:
-
-```typescript
-import { Client } from "@nvisy/sdk";
-
-const client = Client.builder()
-  .withApiKey("your-api-key") // Required: 10+ chars, alphanumeric with _ and -
-  .withBaseUrl("https://api.nvisy.com") // Optional: API endpoint (default shown)
-  .withTimeout(60000) // Optional: 1000-300000ms (default: 30000)
-  .withMaxRetries(5) // Optional: 0-5 attempts (default: 3)
-  .withHeader("X-Custom-Header", "value") // Optional: single custom header
-  .withHeaders({ "X-Another": "header" }) // Optional: multiple custom headers
-  .build();
+const account = await client.account.get();
+const projects = await client.projects.list();
 ```
 
-### From Environment Variables
-
-Load configuration from environment variables:
+### Configuration Options
 
 ```typescript
-import { Client, ClientBuilder } from "@nvisy/sdk";
-
-// Using builder pattern from environment (allows additional configuration)
-const client = ClientBuilder.fromEnvironment()
-  .withTimeout(60000) // Override or add to env config
-  .build();
+import { Client } from "@nvisy/sdk";
 
-// Or using Client directly
-const client = Client.fromEnvironment();
+const client = new Client({
+  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
+    "X-Custom-Header": "value",
+  },
+});
 ```
 
-Set these environment variables:
-
-| Variable            | Description                      | Required |
-| ------------------- | -------------------------------- | -------- |
-| `NVISY_API_KEY`     | API key for authentication       | Yes      |
-| `NVISY_BASE_URL`    | Custom API endpoint URL          | No       |
-| `NVISY_TIMEOUT`     | Request timeout in milliseconds  | No       |
-| `NVISY_MAX_RETRIES` | Maximum number of retry attempts | No       |
-
-## Requirements
-
-- Node.js 20.0.0 or higher
-- TypeScript 5.9.0 or higher (for development)
-
 ## Changelog
 
 See [CHANGELOG.md](CHANGELOG.md) for release notes and version history.
@@ -104,5 +63,5 @@ MIT License - see [LICENSE.txt](LICENSE.txt) for details.
 ## Support
 
 - Documentation: [docs.nvisy.com](https://docs.nvisy.com)
-- Issues: [GitHub Issues](https://github.com/nvisycom/sdk/issues)
+- Issues: [GitHub Issues](https://github.com/nvisycom/sdk-ts/issues)
 - Email: [support@nvisy.com](mailto:support@nvisy.com)