@bobfrankston/iflow-direct 0.1.56 → 0.1.57

package/README.md

@@ -11,19 +11,25 @@ and the desktop/browser architecture diagram.
 
 ```bash
 npm install @bobfrankston/iflow-direct
-# desktop TCP transport:
-npm install @bobfrankston/tcp-transport
+# desktop (Node) TCP transport implementation:
+npm install @bobfrankston/node-tcp-transport
 ```
 
-## Quick start (desktop)
+`@bobfrankston/tcp-transport` is the *interface* package (`TcpTransport` is a
+type, plus the browser/Android `BridgeTcpTransport`); the class you instantiate
+in Node is `NodeTcpTransport` from `@bobfrankston/node-tcp-transport`
+(node:net/tls). `@bobfrankston/iflow-node` is a back-compat shim re-exporting
+it as `NodeTransport` — new code should not use it.
+
+## Quick start (Node)
 
 ```typescript
 import { NativeImapClient } from "@bobfrankston/iflow-direct";
-import { TcpTransport } from "@bobfrankston/tcp-transport";
+import { NodeTcpTransport } from "@bobfrankston/node-tcp-transport";
 
 const client = new NativeImapClient(
     { server: "imap.example.com", port: 993, username: "me", password: "..." },
-    () => new TcpTransport(),
+    () => new NodeTcpTransport(),
 );
 await client.connect();
 await client.select("INBOX");
@@ -31,6 +37,23 @@ const msgs = await client.fetchMessages("1:50", { source: false });
 await client.logout();
 ```
 
+For OAuth (Gmail, Office 365), omit `password` and supply a `tokenProvider` —
+an async function returning a current access token; the client calls it at
+authentication time, so refresh logic lives in the provider:
+
+```typescript
+const client = new NativeImapClient(
+    {
+        server: "imap.gmail.com", port: 993, username: "me@gmail.com",
+        tokenProvider: async () => myOauth.getFreshAccessToken(),
+    },
+    () => new NodeTcpTransport(),
+);
+```
+
+(mailx pairs this with `@bobfrankston/oauthsupport`, but any source of a valid
+token works.)
+
 For the legacy API shape (`getFolderList`, etc.) use `CompatImapClient` from the
 same package.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bobfrankston/iflow-direct",
-  "version": "0.1.56",
+  "version": "0.1.57",
   "description": "Direct IMAP client — transport-agnostic, no Node.js dependencies, browser-ready",
   "main": "index.js",
   "types": "index.ts",
@@ -19,7 +19,7 @@
   "author": "Bob Frankston",
   "license": "ISC",
   "dependencies": {
-    "@bobfrankston/tcp-transport": "^0.1.7"
+    "@bobfrankston/tcp-transport": "^0.1.8"
   },
   "exports": {
     ".": {
@@ -50,7 +50,7 @@
   },
   ".transformedSnapshot": {
     "dependencies": {
-      "@bobfrankston/tcp-transport": "^0.1.7"
+      "@bobfrankston/tcp-transport": "^0.1.8"
     }
   }
 }