@quantidia/sdk 1.0.8 → 1.0.9

package/CHANGELOG.md

@@ -7,6 +7,16 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ---
 
+## [1.0.8] - 2026-06-11
+
+### Fixed
+- `./ui` export path corrected from `dist/ui.mjs` → `dist/ui.js` so `import from "@quantidia/sdk/ui"` resolves correctly in Vite, webpack and other bundlers
+
+### Added
+- NPM / ES Module documentation in README
+
+---
+
 ## [1.0.7] - 2026-06-10
 
 ### Changed

package/README.md

@@ -138,14 +138,172 @@ await SDK.openSigningWithLogin({
 
 ## NPM / ES Module
 
-> 📖 Full NPM and ES Module documentation is in progress.
+### Installation
 
 ```bash
 npm install @quantidia/sdk
 ```
 
-```ts
-import { init, openSigningWithLogin, addDocuments, clearDocuments } from "@quantidia/sdk/ui";
+### Imports
+
+The package ships two entry points:
+
+| Entry point | Contents |
+|---|---|
+| `@quantidia/sdk` | OpenAPI REST client (generated) |
+| `@quantidia/sdk/ui` | Signing UI — `init`, `openSigningWithLogin`, `addDocuments`, `clearDocuments`, `close`, `listSignedDocuments`, `getSignedDocumentBytes` |
+
+```js
+import {
+  init,
+  addDocuments,
+  clearDocuments,
+  openSigningWithLogin,
+} from "@quantidia/sdk/ui";
+```
+
+TypeScript types are included — no `@types` package needed.
+
+---
+
+### 1. Initialize
+
+Call `init()` once, before any other function. The same options apply as in the CDN version.
+
+```js
+init({
+  baseUrl: "https://your-backend.example.com/integration",
+  apiBase: "https://your-backend.example.com",
+  view: "full",        // "full" | "restricted" | "gateway"
+  forceNexu: false,
+  nexuUrl: "https://localhost:9895/rest/certificates",
+  nexuSignUrl: "https://localhost:9895/rest/sign",
+});
+```
+
+| Option | Type | Required | Description |
+|---|---|---|---|
+| `baseUrl` | `string` | Yes | Base URL of the signing integration endpoint |
+| `apiBase` | `string` | Yes | Base URL of the API (without path) |
+| `view` | `string` | No | Signing UI view mode (`"full"` default) |
+| `forceNexu` | `boolean` | No | Always use Nexu for local certificate signing |
+| `nexuUrl` | `string` | No | Nexu certificates endpoint |
+| `nexuSignUrl` | `string` | No | Nexu sign endpoint |
+
+---
+
+### 2. Load documents
+
+```js
+// From a file input element
+fileInput.addEventListener("change", async (e) => {
+  const files = Array.from(e.target.files);
+
+  clearDocuments();
+  const docIds = await addDocuments(files);
+
+  console.log("Loaded doc IDs:", docIds);
+});
+```
+
+```js
+// From a URL
+async function fileFromUrl(url, filename) {
+  const res = await fetch(url);
+  const blob = await res.blob();
+  return new File([blob], filename, { type: "application/pdf" });
+}
+
+const file = await fileFromUrl("/documents/contract.pdf", "contract.pdf");
+clearDocuments();
+const docIds = await addDocuments([file]);
+```
+
+`addDocuments(files: File[])` returns `Promise<string[]>` — the list of document IDs to pass to the signing call.
+
+---
+
+### 3. Open the signing modal
+
+#### With username and password
+
+```js
+try {
+  const result = await openSigningWithLogin({
+    authLogin: {
+      authReference: {
+        environmentId: "your-environment-id",
+        userId: "external-user-id",        
+        subscriptionId: "subscription-id", 
+        companyId: "company-id",           
+      },
+      authLogin: {
+        username: "user@example.com",
+        password: "userpassword",
+      },
+    },
+    headersOverride: {
+      apiKey: "your-api-key",
+      acceptLanguage: "es-AR",
+    },
+    docId: docIds[0],
+    docIds,
+  });
+
+  console.log("Signed:", result);
+} catch (err) {
+  console.error("Signing failed or cancelled:", err.message);
+}
+```
+
+#### With an access token
+
+```js
+const result = await openSigningWithLogin({
+  authLogin: {
+    authReference: {
+      environmentId: "your-environment-id",
+    },
+    authLogin: {
+      accessToken: "eyJhbGci...",
+    },
+  },
+  headersOverride: {
+    apiKey: "your-api-key",
+  },
+  docId: docIds[0],
+  docIds,
+});
+```
+
+`openSigningWithLogin` returns a `Promise` that resolves when the user completes signing and rejects if the user cancels or an error occurs.
+
+---
+
+### Bundler notes
+
+**Vite / webpack / Rollup** — no special configuration needed from `@quantidia/sdk ≥ 1.0.8`.
+
+If you are pinned to an older version (`< 1.0.8`), add a manual alias in `vite.config.js` to work around an incorrect exports path in those releases:
+
+```js
+// vite.config.js  (only needed for @quantidia/sdk < 1.0.8)
+import { defineConfig } from "vite";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+export default defineConfig({
+  resolve: {
+    alias: {
+      "@quantidia/sdk/ui": path.resolve(
+        __dirname,
+        "node_modules/@quantidia/sdk/dist/ui.js"
+      ),
+    },
+  },
+});
 ```
 
 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quantidia/sdk",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Quantidia SDK for digital signature integrations (Fortify, Nexu, cloud signing)",
   "type": "module",
   "main": "./dist/quantidia-sdk.cjs",