Refactor module structures and consolidate exports for clarity

.changeset/mighty-snails-report.md

@@ -0,0 +1,5 @@
+---
+"@hsblabs/web-stream-extras": patch
+---
+
+refactor: consolidate shared module exports and reorganize internal file structure

.vscode/settings.json

@@ -3,6 +3,7 @@
 	"editor.formatOnSave": true,
 	"editor.codeActionsOnSave": {
 		"source.fixAll.biome": "explicit",
-		"source.organizeImports.biome": "explicit"
+		"source.organizeImports.biome": "explicit",
+		"source.organizeImports": "never"
 	}
 }

package.json

@@ -26,12 +26,12 @@
 	],
 	"exports": {
 		".": "./dist/index.js",
-		"./base64": "./dist/base64.js",
-		"./cobs": "./dist/cobs.js",
-		"./encryption": "./dist/encryption.js",
-		"./jsonl": "./dist/jsonl.js",
-		"./png": "./dist/png.js",
-		"./text": "./dist/text.js",
+		"./base64": "./dist/base64/index.js",
+		"./cobs": "./dist/cobs/index.js",
+		"./encryption": "./dist/encryption/index.js",
+		"./jsonl": "./dist/jsonl/index.js",
+		"./png": "./dist/png/index.js",
+		"./text": "./dist/text/index.js",
 		"./package.json": "./package.json"
 	},
 	"types": "./dist/index.d.ts",

src/base64.test.ts → src/base64/index.test.ts

@@ -1,18 +1,18 @@
 import { describe, expect, it } from "vitest";
+import {
+	binaryToString,
+	readAllBytes,
+	readAllChunks,
+	readableFromChunks,
+	stringToBinary,
+} from "../shared";
 import {
 	Base64DecodeStream,
 	Base64EncodeStream,
 	decodeBase64Stream,
 	decodeBase64UrlStream,
 	encodeBase64Stream,
 	encodeBase64UrlStream,
-} from "./base64";
-import {
-	binaryToString,
-	readAllBytes,
-	readAllChunks,
-	readableFromChunks,
-	stringToBinary,
 } from "./index";
 
 describe("base64", () => {

src/cobs.test.ts → src/cobs/index.test.ts

@@ -1,14 +1,14 @@
 import { describe, expect, it } from "vitest";
-import * as cobsApi from "./cobs";
+import { readAllBytes, readAllChunks, readableFromChunks } from "../shared";
+import * as cobsApi from "./index";
 import {
 	createCOBSDecoderStream,
 	createCOBSEncoderStream,
 	decodeCOBSFrame,
 	encodeCOBSFrame,
 	readCOBS,
 	writeCOBS,
-} from "./cobs";
-import { readAllBytes, readAllChunks, readableFromChunks } from "./readable";
+} from "./index";
 
 describe("cobs public API", () => {
 	it("exports the supported cobs helpers", () => {

src/encryption.test.ts → src/encryption/index.test.ts

@@ -1,18 +1,18 @@
 import { describe, expect, it } from "vitest";
-import {
-	DecryptionStream,
-	decryptStream,
-	EncryptionStream,
-	encryptStream,
-	webCryptoStream,
-} from "./encryption";
-import { HEADER_SIZE, TAG_LENGTH } from "./encryption/constants";
 import {
 	binaryToString,
 	randomBytes,
 	readAllBytes,
 	readableFromChunks,
 	stringToBinary,
+} from "../shared";
+import { HEADER_SIZE, TAG_LENGTH } from "./constants";
+import {
+	DecryptionStream,
+	decryptStream,
+	EncryptionStream,
+	encryptStream,
+	webCryptoStream,
 } from "./index";
 
 const TEST_RECORD_SIZE = 64;

src/encryption/public.ts → src/encryption/index.ts

@@ -2,9 +2,9 @@ import { toArrayBuffer } from "../shared/array-buffer";
 import { decodeBase64Url, encodeBase64Url } from "../shared/base64url";
 import { randomBytes } from "../shared/binary";
 import { throwError } from "../shared/error";
+import type { BinaryReadableStream } from "../shared/stream";
+import { ByteTransformStream } from "../shared/stream";
 import { concatU8Arrays, toU8Array } from "../shared/uint8array";
-import type { BinaryReadableStream } from "../stream-types";
-import { ByteTransformStream } from "../transform-stream";
 import {
 	AES_GCM_BIT_LENGTH,
 	ALGORITHM_AES_GCM,

src/index.ts

@@ -1,6 +1,17 @@
-export { readAllBytes, readAllChunks, readableFromChunks } from "./readable";
+export * from "./base64";
+export * from "./byte-queue";
+export * from "./cobs";
+export * from "./encryption";
+export * from "./jsonl";
+export * from "./png";
 export {
 	binaryToString,
 	randomBytes,
 	stringToBinary,
 } from "./shared/binary";
+export {
+	readAllBytes,
+	readAllChunks,
+	readableFromChunks,
+} from "./shared/readable";
+export * from "./text";

src/jsonl.test.ts → src/jsonl/index.test.ts

@@ -5,7 +5,7 @@ import {
 	readAllChunks,
 	readableFromChunks,
 	stringToBinary,
-} from "./index";
+} from "../shared";
 import {
 	encodeJSONLStream,
 	JSONLEncodeStream,
@@ -14,7 +14,7 @@ import {
 	JSONLStringifyStream,
 	parseJSONLStream,
 	stringifyJSONLStream,
-} from "./jsonl";
+} from "./index";
 
 type Event = {
 	id: string;

src/png/framing.ts

@@ -1,4 +1,4 @@
-import { decodeCOBSFrame, encodeCOBSFrame } from "../cobs/public";
+import { decodeCOBSFrame, encodeCOBSFrame } from "../cobs";
 import { throwError } from "../shared/error";
 import { concatU8Arrays } from "../shared/uint8array";
 import {

src/png.test.ts → src/png/index.test.ts

@@ -1,14 +1,14 @@
 import { describe, expect, it } from "vitest";
-import { decodeCOBSFrame, encodeCOBSFrame } from "./cobs";
-import * as pngApi from "./png";
+import { decodeCOBSFrame, encodeCOBSFrame } from "../cobs";
+import { readAllBytes, readableFromChunks } from "../shared";
 import {
 	PNG_INTERNAL_TEXT_CHUNK_KEYWORD,
 	PNG_PAYLOAD_MAGIC,
 	PNG_PAYLOAD_SEGMENT_DATA_MAX_LENGTH,
 	PNG_PAYLOAD_VERSION,
 	PNG_SIGNATURE,
-} from "./png/constants";
-import { crc32 } from "./png/crc32";
+} from "./constants";
+import { crc32 } from "./crc32";
 import {
 	createChunk,
 	createPayloadDataSegment,
@@ -18,13 +18,13 @@ import {
 	isInternalTextChunk,
 	parsePayloadSegment,
 	parsePNGBytes,
-} from "./png/framing";
+} from "./framing";
+import * as pngApi from "./index";
 import {
 	createPNGTextChunkWriter,
 	extractPNGTextChunk,
 	streamPNGTextChunk,
-} from "./png/public";
-import { readAllBytes, readableFromChunks } from "./readable";
+} from "./index";
 
 const MINIMAL_PNG = concatBytes(
 	PNG_SIGNATURE,

src/png/transformers.ts

@@ -1,6 +1,7 @@
 import { type ByteQueue, createByteQueue } from "../byte-queue";
 import { throwError } from "../shared/error";
 import { concatU8Arrays } from "../shared/uint8array";
+import type { PNGTextChunkWriteOptions, PNGTextChunkWriter } from ".";
 import {
 	PNG_IEND_CHUNK_TYPE,
 	PNG_PAYLOAD_SEGMENT_DATA_MAX_LENGTH,
@@ -18,7 +19,6 @@ import {
 	parsePNGChunk,
 	parsePNGChunkHeader,
 } from "./framing";
-import type { PNGTextChunkWriteOptions, PNGTextChunkWriter } from "./public";
 
 interface Deferred<T> {
 	promise: Promise<T>;

src/shared/index.ts

@@ -0,0 +1,13 @@
+export { toArrayBuffer } from "./array-buffer";
+
+export {
+	binaryToString,
+	randomBytes,
+	stringToBinary,
+} from "./binary";
+
+export {
+	readAllBytes,
+	readAllChunks,
+	readableFromChunks,
+} from "./readable";