roxify 1.5.3 → 1.5.4

package/dist/minpng.d.ts

@@ -1,4 +1,18 @@
+/**
+ * Encode a buffer of raw RGB data into a minimal PNG (MinPNG format).
+ *
+ * @param rgb - Buffer of RGB data.
+ * @param width - Image width.
+ * @param height - Image height.
+ * @returns Promise resolving to a PNG Buffer.
+ */
 export declare function encodeMinPng(rgb: Buffer, width: number, height: number): Promise<Buffer>;
+/**
+ * Decode a minimal PNG (MinPNG) buffer into raw RGB data and dimensions.
+ *
+ * @param pngBuf - Buffer containing a MinPNG image.
+ * @returns Promise resolving to an object with buf, width, and height, or null if invalid.
+ */
 export declare function decodeMinPng(pngBuf: Buffer): Promise<{
     buf: Buffer;
     width: number;

package/dist/minpng.js

@@ -51,6 +51,14 @@ function zigzagOrderIndices(width, height) {
     }
     return indices;
 }
+/**
+ * Encode a buffer of raw RGB data into a minimal PNG (MinPNG format).
+ *
+ * @param rgb - Buffer of RGB data.
+ * @param width - Image width.
+ * @param height - Image height.
+ * @returns Promise resolving to a PNG Buffer.
+ */
 export async function encodeMinPng(rgb, width, height) {
     const w = width, h = height;
     const idx = (x, y) => (y * w + x) * 3;
@@ -177,6 +185,12 @@ export async function encodeMinPng(rgb, width, height) {
     }
     return Buffer.concat(output);
 }
+/**
+ * Decode a minimal PNG (MinPNG) buffer into raw RGB data and dimensions.
+ *
+ * @param pngBuf - Buffer containing a MinPNG image.
+ * @returns Promise resolving to an object with buf, width, and height, or null if invalid.
+ */
 export async function decodeMinPng(pngBuf) {
     const rawData = native.sharpToRaw(pngBuf);
     const data = rawData.pixels;

package/dist/utils/decoder.d.ts

@@ -1,2 +1,17 @@
 import { DecodeOptions, DecodeResult } from './types.js';
+/**
+ * Decode a ROX PNG or buffer into the original binary payload or files list.
+ *
+ * @param input - Buffer or path to a PNG file.
+ * @param opts - Optional decode options.
+ * @returns A Promise resolving to DecodeResult ({ buf, meta } or { files }).
+ *
+ * @example
+ * ```js
+ * import { decodePngToBinary } from 'roxify';
+ * const png = fs.readFileSync('out.png');
+ * const res = await decodePngToBinary(png);
+ * console.log(res.meta?.name, res.buf.toString('utf8'));
+ * ```
+ */
 export declare function decodePngToBinary(input: Buffer | string, opts?: DecodeOptions): Promise<DecodeResult>;

package/dist/utils/decoder.js

@@ -58,6 +58,21 @@ function convertToPng(buf, format) {
         catch (e) { }
     }
 }
+/**
+ * Decode a ROX PNG or buffer into the original binary payload or files list.
+ *
+ * @param input - Buffer or path to a PNG file.
+ * @param opts - Optional decode options.
+ * @returns A Promise resolving to DecodeResult ({ buf, meta } or { files }).
+ *
+ * @example
+ * ```js
+ * import { decodePngToBinary } from 'roxify';
+ * const png = fs.readFileSync('out.png');
+ * const res = await decodePngToBinary(png);
+ * console.log(res.meta?.name, res.buf.toString('utf8'));
+ * ```
+ */
 export async function decodePngToBinary(input, opts = {}) {
     let pngBuf;
     if (Buffer.isBuffer(input)) {
@@ -347,11 +362,17 @@ export async function decodePngToBinary(input, opts = {}) {
             logicalData = rawRGB;
         }
         else {
-            console.log('DEBUG: about to call cropAndReconstitute, debugDir=', opts.debugDir);
+            if (process.env.ROX_DEBUG || opts.debugDir) {
+                console.log('DEBUG: about to call cropAndReconstitute, debugDir=', opts.debugDir);
+            }
             const reconstructed = await cropAndReconstitute(processedBuf, opts.debugDir);
-            console.log('DEBUG: cropAndReconstitute returned, reconstructed len=', reconstructed.length);
+            if (process.env.ROX_DEBUG || opts.debugDir) {
+                console.log('DEBUG: cropAndReconstitute returned, reconstructed len=', reconstructed.length);
+            }
             const rawData = native.sharpToRaw(reconstructed);
-            console.log('DEBUG: rawData from reconstructed:', rawData.width, 'x', rawData.height, 'pixels=', Math.floor(rawData.pixels.length / 3));
+            if (process.env.ROX_DEBUG || opts.debugDir) {
+                console.log('DEBUG: rawData from reconstructed:', rawData.width, 'x', rawData.height, 'pixels=', Math.floor(rawData.pixels.length / 3));
+            }
             logicalWidth = rawData.width;
             logicalHeight = rawData.height;
             logicalData = Buffer.from(rawData.pixels);

package/dist/utils/encoder.d.ts

@@ -1,2 +1,23 @@
 import { EncodeOptions } from './types.js';
+/**
+ * Encode a buffer or array of buffers into a PNG image (ROX format).
+ *
+ * @param input - The buffer or array of buffers to encode.
+ * @param opts - Optional encoding options.
+ * @returns A Promise that resolves to a PNG Buffer containing the encoded data.
+ *
+ * @example
+ * ```js
+ * import { encodeBinaryToPng } from 'roxify';
+ *
+ * const png = await encodeBinaryToPng(Buffer.from('hello'), {
+ *   mode: 'screenshot',
+ *   name: 'hello.txt',
+ *   compressionLevel: 19,
+ *   outputFormat: 'png',
+ * });
+ *
+ * // write to disk using fs.writeFileSync('out.png', png)
+ * ```
+ */
 export declare function encodeBinaryToPng(input: Buffer | Buffer[], opts?: EncodeOptions): Promise<Buffer>;

package/dist/utils/encoder.js

@@ -6,6 +6,27 @@ import { crc32 } from './crc.js';
 import { colorsToBytes } from './helpers.js';
 import { native } from './native.js';
 import { parallelZstdCompress } from './zstd.js';
+/**
+ * Encode a buffer or array of buffers into a PNG image (ROX format).
+ *
+ * @param input - The buffer or array of buffers to encode.
+ * @param opts - Optional encoding options.
+ * @returns A Promise that resolves to a PNG Buffer containing the encoded data.
+ *
+ * @example
+ * ```js
+ * import { encodeBinaryToPng } from 'roxify';
+ *
+ * const png = await encodeBinaryToPng(Buffer.from('hello'), {
+ *   mode: 'screenshot',
+ *   name: 'hello.txt',
+ *   compressionLevel: 19,
+ *   outputFormat: 'png',
+ * });
+ *
+ * // write to disk using fs.writeFileSync('out.png', png)
+ * ```
+ */
 export async function encodeBinaryToPng(input, opts = {}) {
     let progressBar = null;
     if (opts.showProgress) {

package/dist/utils/inspection.d.ts

@@ -1,8 +1,17 @@
 /**
- * List files in a Rox PNG archive without decoding the full payload.
- * Returns the file list if available, otherwise null.
- * @param pngBuf - PNG data
- * @public
+ * List files stored inside a ROX PNG without fully extracting it.
+ * Returns `null` if no file list could be found.
+ *
+ * @param pngBuf - Buffer containing a PNG file.
+ * @param opts - Options to include sizes.
+ * @returns Promise resolving to an array of file names or objects with sizes.
+ *
+ * @example
+ * ```js
+ * import { listFilesInPng } from 'roxify';
+ * const files = await listFilesInPng(fs.readFileSync('out.png'), { includeSizes: true });
+ * console.log(files);
+ * ```
  */
 export declare function listFilesInPng(pngBuf: Buffer, opts?: {
     includeSizes?: boolean;
@@ -11,7 +20,16 @@ export declare function listFilesInPng(pngBuf: Buffer, opts?: {
     size: number;
 }[] | null>;
 /**
- * Detect if a PNG/ROX buffer contains an encrypted payload (requires passphrase)
- * Returns true if encryption flag indicates AES or XOR.
+ * Check if a PNG contains an encrypted payload requiring a passphrase.
+ *
+ * @param pngBuf - Buffer containing a PNG file.
+ * @returns Promise resolving to `true` if the PNG requires a passphrase.
+ *
+ * @example
+ * ```js
+ * import { hasPassphraseInPng } from 'roxify';
+ * const needPass = await hasPassphraseInPng(fs.readFileSync('out.png'));
+ * console.log('needs passphrase?', needPass);
+ * ```
  */
 export declare function hasPassphraseInPng(pngBuf: Buffer): Promise<boolean>;

package/dist/utils/inspection.js

@@ -6,10 +6,19 @@ import { PassphraseRequiredError } from './errors.js';
 import { native } from './native.js';
 import { cropAndReconstitute } from './reconstitution.js';
 /**
- * List files in a Rox PNG archive without decoding the full payload.
- * Returns the file list if available, otherwise null.
- * @param pngBuf - PNG data
- * @public
+ * List files stored inside a ROX PNG without fully extracting it.
+ * Returns `null` if no file list could be found.
+ *
+ * @param pngBuf - Buffer containing a PNG file.
+ * @param opts - Options to include sizes.
+ * @returns Promise resolving to an array of file names or objects with sizes.
+ *
+ * @example
+ * ```js
+ * import { listFilesInPng } from 'roxify';
+ * const files = await listFilesInPng(fs.readFileSync('out.png'), { includeSizes: true });
+ * console.log(files);
+ * ```
  */
 export async function listFilesInPng(pngBuf, opts = {}) {
     try {
@@ -412,8 +421,17 @@ async function getFileSizesFromPng(pngBuf) {
     return null;
 }
 /**
- * Detect if a PNG/ROX buffer contains an encrypted payload (requires passphrase)
- * Returns true if encryption flag indicates AES or XOR.
+ * Check if a PNG contains an encrypted payload requiring a passphrase.
+ *
+ * @param pngBuf - Buffer containing a PNG file.
+ * @returns Promise resolving to `true` if the PNG requires a passphrase.
+ *
+ * @example
+ * ```js
+ * import { hasPassphraseInPng } from 'roxify';
+ * const needPass = await hasPassphraseInPng(fs.readFileSync('out.png'));
+ * console.log('needs passphrase?', needPass);
+ * ```
  */
 export async function hasPassphraseInPng(pngBuf) {
     try {

package/dist/utils/reconstitution.d.ts

@@ -1 +1,8 @@
+/**
+ * Reconstitute a PNG buffer by cropping and reconstructing the image.
+ *
+ * @param input - Buffer containing the PNG image.
+ * @param debugDir - Optional directory to write debug images.
+ * @returns Promise resolving to the reconstituted PNG buffer.
+ */
 export declare function cropAndReconstitute(input: Buffer, debugDir?: string): Promise<Buffer>;

package/dist/utils/reconstitution.js

@@ -1,6 +1,13 @@
 import { writeFileSync } from 'fs';
 import { join } from 'path';
 import { native } from './native.js';
+/**
+ * Reconstitute a PNG buffer by cropping and reconstructing the image.
+ *
+ * @param input - Buffer containing the PNG image.
+ * @param debugDir - Optional directory to write debug images.
+ * @returns Promise resolving to the reconstituted PNG buffer.
+ */
 export async function cropAndReconstitute(input, debugDir) {
     const out = Buffer.from(native.cropAndReconstitute(input));
     if (debugDir) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "roxify",
-  "version": "1.5.3",
+  "version": "1.5.4",
   "description": "Ultra-lightweight PNG steganography with native Rust acceleration. Encode binary data into PNG images with zstd compression.",
   "type": "module",
   "main": "dist/index.js",
@@ -27,8 +27,9 @@
     "build:native:windows": "cargo build --release --lib --target x86_64-pc-windows-msvc && cp target/x86_64-pc-windows-msvc/release/roxify_native.dll libroxify_native-x86_64-pc-windows-msvc.dll",
     "build:cli": "cargo build --release --bin roxify_native && cp target/release/roxify_native dist/roxify-cli",
     "build:all": "npm run build:native && npm run build && npm run build:cli",
+    "build:cross": "node scripts/build-all-platforms.js && npm run build && npm run build:cli",
     "postbuild:native": "node scripts/copy-native.js",
-    "prepublishOnly": "npm run build:all",
+    "prepublishOnly": "npm run build:cross",
     "test": "npm run build && node test/run-all-tests.js",
     "cli": "node dist/cli.js"
   },