@yozz.app/imap 0.1.1 → 0.1.2

package/README.md

@@ -8,8 +8,9 @@ pnpm add @yozz.app/imap
 
 ## The seam
 
-`@yozz.app/imap` speaks IMAP over any `ByteDuplex` (`{ read(): Promise<Uint8Array | null>; write(bytes): Promise<void> }`)
-from `@yozz.app/tls`. It knows protocol lines, `{n}` literals, command state, and RFC 2047 header
+`@yozz.app/imap` speaks IMAP over any `ByteDuplex` (`{ read(): Promise<Uint8Array | null>; write(bytes): Promise<void> }`),
+a type it declares itself; a `@yozz.app/tls` connection satisfies it, and so does anything else with
+those two methods. The package has no runtime dependencies. It knows protocol lines, `{n}` literals, command state, and RFC 2047 header
 decoding. It **never knows** TLS records, certificates, session keys, or vault storage.
 
 In the browser, the duplex wraps `@yozz.app/tls` over the production WebSocket relay. In tests, it

package/dist/index.d.mts

@@ -1,5 +1,3 @@
-import { ByteDuplex } from "@yozz.app/tls";
-
 //#region src/tokenizer.d.ts
 /**
  * Hand-written tokenizer over byte offsets for IMAP4rev2/rev1 stream.
@@ -194,6 +192,17 @@ type ImapResponse = ImapTagged | {
 } | ImapContinuation;
 declare const parseResponse: (tokens: readonly ImapToken[]) => ImapResult<ImapResponse>;
 //#endregion
+//#region src/transport.d.ts
+/**
+ * What this client needs from a transport: bytes in, bytes out. Declared here rather than
+ * imported from `@yozz.app/tls` so the package has no runtime dependency at all; it is the same
+ * two-method shape, so a `TlsConnection` satisfies it structurally.
+ */
+type ByteDuplex = {
+  readonly read: () => Promise<Uint8Array | null>;
+  readonly write: (bytes: Uint8Array) => Promise<void>;
+};
+//#endregion
 //#region src/client.d.ts
 type ImapMessageSummary = {
   readonly seq: number;
@@ -282,4 +291,4 @@ declare const createImapClient: (transport: ByteDuplex, options?: ImapClientOpti
  */
 declare const decodeRfc2047: (header: string) => string;
 //#endregion
-export { DEFAULT_MAX_LITERAL_BYTES, type ImapAddress, type ImapClient, type ImapClientOptions, type ImapContinuation, type ImapEnvelope, type ImapFailure, type ImapFetchItem, type ImapIdle, type ImapMailbox, type ImapMessageSummary, type ImapResponse, type ImapResponseCode, type ImapResult, type ImapSelected, type ImapTagged, type ImapToken, type ImapUntagged, createImapClient, decodeRfc2047, parseResponse };
+export { type ByteDuplex, DEFAULT_MAX_LITERAL_BYTES, type ImapAddress, type ImapClient, type ImapClientOptions, type ImapContinuation, type ImapEnvelope, type ImapFailure, type ImapFetchItem, type ImapIdle, type ImapMailbox, type ImapMessageSummary, type ImapResponse, type ImapResponseCode, type ImapResult, type ImapSelected, type ImapTagged, type ImapToken, type ImapUntagged, createImapClient, decodeRfc2047, parseResponse };

package/dist/index.mjs

@@ -1392,6 +1392,16 @@ const tokenizeLogicalLine = (line) => {
 //#endregion
 //#region src/client.ts
 /**
+* IMAP client state machine over ByteDuplex.
+*
+* Invariants:
+* - One IMAP connection object per device (no connection pool).
+* - Transport is ByteDuplex from @yozz.app/tls.
+* - Parsing is total: parser never throws, returns typed ImapFailure and closes.
+* - Commands are serialised: one in-flight command at a time, queued in order (no pipelining in this slice).
+* - Greeting is captured immediately upon creation.
+*/
+/**
 * The msg-ids out of a `HEADER.FIELDS (REFERENCES)` section: the header unfolded, then every
 * `<...>` in order. A truncated or absent header is simply fewer ids.
 */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yozz.app/imap",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Transport-agnostic IMAP4rev2/rev1 client core: literals, total parsing, RFC 2047, SASL PLAIN/LOGIN, IDLE, UID MOVE.",
   "license": "MIT",
   "homepage": "https://github.com/fishballapp/yozz",
@@ -28,13 +28,11 @@
   "publishConfig": {
     "access": "public"
   },
-  "dependencies": {
-    "@yozz.app/tls": "0.1.1"
-  },
   "devDependencies": {
     "@types/node": "^24.0.0",
     "tsdown": "^0.22.3",
-    "@yozz.app/x509": "0.1.1"
+    "@yozz.app/tls": "0.1.2",
+    "@yozz.app/x509": "0.1.2"
   },
   "scripts": {
     "build": "tsdown src/index.ts --format esm --dts",