chore(sdk): Updates readme and fixes typedoc (#453)

Author: dmihalcik-virtru

lib/README.md

@@ -1,52 +1,59 @@
 # An OpenTDF Library for Browser Applications
 
-This project presents client code to write and read a OpenTDF data formats.
-This included NanoTDF, Dataset TDF, and ZTDF.
+This project presents client code to write and read a OpenTDF data formats. This included NanoTDF
+and collections and Base TDF3.
 
 ## Usage
 
 ### NanoTDF
 
 ```typescript
-  const oidcCredentials: RefreshTokenCredentials = {
-    clientId: keycloakClientId,
-    exchange: 'refresh',
-    refreshToken: refreshToken,
-    oidcOrigin: keycloakUrl,
-  }
-  const authProvider = await AuthProviders.refreshAuthProvider(oidcCredentials);
-  const client = new NanoTDFClient({authProvider, kasEndpoint});
-  const cipherText = await client.encrypt(plainText);
-  const clearText = await client.decrypt(cipherText);
+import { type Chunker, OpenTDF } from '@opentdf/sdk';
+
+const oidcCredentials: RefreshTokenCredentials = {
+  clientId: keycloakClientId,
+  exchange: 'refresh',
+  refreshToken: refreshToken,
+  oidcOrigin: keycloakUrl,
+};
+const authProvider = await AuthProviders.refreshAuthProvider(oidcCredentials);
+const client = new OpenTDF({
+  authProvider,
+  defaultCreateOptions: {
+    defaultKASEndpoint: kasEndpoint, // Server used for Key Access Control
+  },
+  dpopKeys: authProvider.getSigningKey(),
+});
+const cipherText = await client.createNanoTDF({
+  source: { type: 'stream', location: source },
+});
+
+const clearText = await client.read({ type: 'stream', location: cipherText });
 ```
 
 ### ZTDF
 
 ```typescript
-  const client = new TDF3Client({
-    clientId: "tdf-client",
-    kasEndpoint: 'http://localhost/kas',
-    refreshToken: 'token', // Here is only difference in usage, browser build needs oidc tocken
-    oidcOrigin: 'http://localhost/oidc',
-  });
-  const source = new ReadableStream({
-    pull(controller) {
-      controller.enqueue(new TextEncoder().encode(string));
-      controller.close();
-    },
-  });
-  const ciphertextStream = await client.encrypt({ offline: true, source });
-  // Optionally: Save ciphertextStream to file or remote here.
-  // For demo purposes, we pipe to decrypt.
-  const plaintextStream = await client.decrypt({
-    source: { type: 'stream', location: ciphertextStream }
-  });
-  const plaintext = await plaintextStream.toString(); // could be also ct.toFile('img.jpg');
-  console.log(`deciphered text :${plaintext}`);
+import { type Chunker, OpenTDF } from '@opentdf/sdk';
+
+const oidcCredentials: RefreshTokenCredentials = {
+  clientId: keycloakClientId,
+  exchange: 'refresh',
+  refreshToken: refreshToken,
+  oidcOrigin: keycloakUrl,
+};
+const authProvider = await AuthProviders.refreshAuthProvider(oidcCredentials);
+const client = new OpenTDF({
+  authProvider,
+  defaultCreateOptions: {
+    defaultKASEndpoint: kasEndpoint, // Server used for Key Access Control
+  },
+  dpopKeys: authProvider.getSigningKey(),
+});
+const cipherText = await client.createZTDF({
+  source: { type: 'stream', location: source },
+  autoconfigure: false,
+});
+
+const clearText = await client.read({ type: 'stream', location: cipherText });
 ```
-
-## Upgrading from 1.x
-
-- The 'RemoteStorage' features have been moved into a separate library, @opentdf/remote-storage.
-- We have replaced all usages of node's `Buffer` with the web-friendlier `UInt8Array`.
-  You will most likely see this in the return types of some functions.

lib/package-lock.json

@@ -117,6 +117,7 @@
     "process": "^0.11.10",
     "sinon": "~19.0.2",
     "tsconfig-paths": "^4.2.0",
+    "typedoc": "^0.27.9",
     "typescript": "^5.7.3",
     "typescript-eslint": "^8.24.1",
     "webpack": "^5.98.0",