@hkdigital/lib-core 0.4.55 → 0.4.57

package/dist/util/checksum/bufferCrc32.js

@@ -0,0 +1,69 @@
+/**
+ * Standard buffer CRC32 calculation
+ *
+ * Implements IEEE 802.3 CRC32 over entire buffer.
+ * Compatible with ZIP, PNG, and other standard formats.
+ */
+
+import { getCrcTable, CRC32 } from './crcTables.js';
+
+/**
+ * Calculate standard CRC32 for buffer
+ *
+ * @param {ArrayBuffer|DataView|Uint8Array} buffer - Buffer to checksum
+ * @param {number} [byteOffset=0] - Start offset in buffer
+ * @param {number} [byteLength] - Number of bytes to process
+ * @param {import('./crcTables.js').CrcVariant} [variant=CRC32] - CRC variant
+ *
+ * @returns {number} Unsigned 32-bit CRC32 value
+ */
+export function bufferToCrc32(buffer, byteOffset = 0, byteLength, variant = CRC32) {
+  const table = getCrcTable(variant);
+  
+  /** @type {DataView} */
+  const dataView = createDataView(buffer, byteOffset, byteLength);
+
+  /** @type {number} */
+  let crc = 0 ^ (-1);
+
+  for (let j = 0; j < dataView.byteLength; j = j + 1) {
+    crc = (crc >>> 8) ^ table[(crc ^ dataView.getUint8(j)) & 0xFF];
+  }
+
+  return (crc ^ (-1)) >>> 0;
+}
+
+/* ------------------------------------------------------- Internal functions */
+
+/**
+ * Create DataView from various buffer types
+ *
+ * @param {ArrayBuffer|DataView|Uint8Array} buffer - Input buffer
+ * @param {number} [byteOffset=0] - Start offset
+ * @param {number} [byteLength] - Length to use
+ *
+ * @returns {DataView} DataView for the buffer
+ */
+function createDataView(buffer, byteOffset = 0, byteLength) {
+  if (buffer instanceof DataView) {
+    return new DataView(
+      buffer.buffer, 
+      buffer.byteOffset + byteOffset,
+      byteLength ?? (buffer.byteLength - byteOffset)
+    );
+  }
+
+  if (buffer instanceof ArrayBuffer) {
+    return new DataView(buffer, byteOffset, byteLength);
+  }
+
+  if (buffer instanceof Uint8Array) {
+    return new DataView(
+      buffer.buffer,
+      buffer.byteOffset + byteOffset,
+      byteLength ?? (buffer.byteLength - byteOffset)
+    );
+  }
+
+  throw new Error('Unsupported buffer type');
+}

package/dist/util/checksum/crcTables.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Get CRC lookup table for specified variant
+ *
+ * @param {CrcVariant} [variant=CRC32] - CRC variant
+ *
+ * @returns {CrcTable} The CRC lookup table
+ */
+export function getCrcTable(variant?: CrcVariant): CrcTable;
+/**
+ * Shared CRC table generation and constants
+ */
+/**
+ * @typedef {import('./typedef').CrcVariant} CrcVariant
+ * Valid CRC32 variant types
+ */
+/**
+ * @typedef {import('./typedef').CrcTable} CrcTable
+ * Lookup table for CRC calculations - array of 256 numbers
+ */
+/** @type {CrcVariant} */
+export const CRC32: CrcVariant;
+/** @type {CrcVariant} */
+export const CRC32C: CrcVariant;
+/**
+ * Valid CRC32 variant types
+ */
+export type CrcVariant = import("./typedef").CrcVariant;
+/**
+ * Lookup table for CRC calculations - array of 256 numbers
+ */
+export type CrcTable = import("./typedef").CrcTable;

package/dist/util/checksum/crcTables.js

@@ -0,0 +1,79 @@
+/**
+ * Shared CRC table generation and constants
+ */
+
+/**
+ * @typedef {import('./typedef').CrcVariant} CrcVariant
+ * Valid CRC32 variant types
+ */
+
+/**
+ * @typedef {import('./typedef').CrcTable} CrcTable
+ * Lookup table for CRC calculations - array of 256 numbers
+ */
+
+/* ---------------------------------------------------------------- Constants */
+
+/** @type {CrcVariant} */
+export const CRC32 = 'crc32';
+
+/** @type {CrcVariant} */
+export const CRC32C = 'crc32c';
+
+/** @type {Record<CrcVariant, number>} */
+const START_POLYNOMIALS = {
+  [CRC32]: 0xEDB88320,
+  [CRC32C]: 0x82f63b78
+};
+
+/** @type {Record<CrcVariant, CrcTable>} */
+// @ts-ignore
+const crcTables = {};
+
+/* ---------------------------------------------------------------- Functions */
+
+/**
+ * Get CRC lookup table for specified variant
+ *
+ * @param {CrcVariant} [variant=CRC32] - CRC variant
+ *
+ * @returns {CrcTable} The CRC lookup table
+ */
+export function getCrcTable(variant = CRC32) {
+  return crcTables[variant] || (crcTables[variant] = makeCRCTable(variant));
+}
+
+/* ---------------------------------------------------------------- Internals */
+
+/**
+ * Create CRC lookup table for specified variant
+ *
+ * @param {CrcVariant} variant - CRC variant to create table for
+ *
+ * @returns {CrcTable} The generated CRC lookup table
+ */
+function makeCRCTable(variant) {
+  /** @type {number} */
+  let c;
+  
+  /** @type {CrcTable} */
+  const crcTable = [];
+
+  /** @type {number} */
+  const startPolynomial = START_POLYNOMIALS[variant];
+
+  if (!startPolynomial) {
+    throw new Error(`Invalid variant [${variant}]`);
+  }
+
+  for (let n = 0; n < 256; n = n + 1) {
+    c = n;
+
+    for (let k = 0; k < 8; k = k + 1) {
+      c = ((c & 1) ? (startPolynomial ^ (c >>> 1)) : (c >>> 1));
+    }
+    crcTable[n] = c;
+  }
+
+  return crcTable;
+}

package/dist/util/checksum/stringCrc32.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Calculate CRC32 hash for string input
+ *
+ * @param {string} str - String to calculate checksum for
+ * @param {import('./crcTables.js').CrcVariant} [variant=CRC32] - CRC variant
+ *
+ * @returns {number} Unsigned 32-bit CRC32 value
+ */
+export function stringToCrc32(str: string, variant?: import("./crcTables.js").CrcVariant): number;
+import { CRC32 } from './crcTables.js';
+import { CRC32C } from './crcTables.js';
+export { CRC32, CRC32C };

package/dist/util/checksum/stringCrc32.js

@@ -0,0 +1,33 @@
+/**
+ * String CRC32 calculation utility
+ *
+ * Calculates CRC32 checksums for strings using standard IEEE 802.3 algorithm.
+ * CRC32 is fast but not cryptographically secure.
+ */
+
+import { getCrcTable, CRC32, CRC32C } from './crcTables.js';
+
+/* ------------------------------------------------------------------ Exports */
+
+export { CRC32, CRC32C };
+
+/**
+ * Calculate CRC32 hash for string input
+ *
+ * @param {string} str - String to calculate checksum for
+ * @param {import('./crcTables.js').CrcVariant} [variant=CRC32] - CRC variant
+ *
+ * @returns {number} Unsigned 32-bit CRC32 value
+ */
+export function stringToCrc32(str, variant = CRC32) {
+  const table = getCrcTable(variant);
+
+  /** @type {number} */
+  let crc = 0 ^ (-1);
+
+  for (let j = 0; j < str.length; j = j + 1) {
+    crc = (crc >>> 8) ^ table[(crc ^ str.charCodeAt(j)) & 0xFF];
+  }
+
+  return (crc ^ (-1)) >>> 0;
+}

package/dist/util/checksum/typedef.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {};
+export default _default;
+/**
+ * Valid CRC32 variant types
+ */
+export type CrcVariant = "crc32" | "crc32c";
+/**
+ * Lookup table for CRC calculations - array of 256 numbers
+ */
+export type CrcTable = number[];

package/dist/util/checksum/typedef.js

@@ -0,0 +1,11 @@
+/**
+ * @typedef {'crc32'|'crc32c'} CrcVariant
+ * Valid CRC32 variant types
+ */
+
+/**
+ * @typedef {number[]} CrcTable
+ * Lookup table for CRC calculations - array of 256 numbers
+ */
+
+export default {};

package/dist/util/checksum.d.ts

@@ -0,0 +1,4 @@
+export { bufferToCrc32 } from "./checksum/bufferCrc32.js";
+export { getCrcTable } from "./checksum/crcTables.js";
+export { stringToCrc32, CRC32, CRC32C } from "./checksum/stringCrc32.js";
+export { bufferToBlockCrc32, blockCrc32Iterator, bufferChecksumEquals, optimalBlockSize } from "./checksum/blockCrc32.js";

package/dist/util/checksum.js

@@ -0,0 +1,23 @@
+/**
+ * Checksum utilities - CRC32 calculations
+ *
+ * Exports the main public-facing functions from the checksum module.
+ * Provides both standard IEEE 802.3 CRC32 and custom block-based processing.
+ */
+
+// String CRC32 calculations
+export { stringToCrc32, CRC32, CRC32C } from './checksum/stringCrc32.js';
+
+// Standard buffer CRC32 (IEEE 802.3 compatible)
+export { bufferToCrc32 } from './checksum/bufferCrc32.js';
+
+// Custom block-based CRC32 for large files
+export {
+  bufferToBlockCrc32,
+  blockCrc32Iterator,
+  bufferChecksumEquals,
+  optimalBlockSize
+} from './checksum/blockCrc32.js';
+
+// CRC table utilities (for advanced use)
+export { getCrcTable } from './checksum/crcTables.js';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hkdigital/lib-core",
-	"version": "0.4.55",
+	"version": "0.4.57",
 	"author": {
 		"name": "HKdigital",
 		"url": "https://hkdigital.nl"