node-pkware 2.0.0 → 3.0.0

package/types/explode.d.ts

@@ -1,56 +0,0 @@
-import ExpandingBuffer from './helpers/ExpandingBuffer'
-import { Callback, Config, Handler, PrivateState } from './helpers/Shared'
-import { CompressionType, DictionarySizeBits, PKDCL_STREAM_END, PKDCL_OK, LITERAL_STREAM_ABORTED } from './constants'
-
-export function readHeader(buffer: Buffer): {
-  compressionType: CompressionType
-  dictionarySizeBits: DictionarySizeBits
-}
-
-type PrivateExplodeState = {
-  _backup: {
-    extraBits: number
-    bitBuffer: Buffer
-  }
-  needMoreInput: boolean
-  isFirstChunk: boolean
-  extraBits: number
-  bitBuffer: Buffer
-  chBitsAsc: number[] // DecodeLit and GenAscTabs uses this
-  lengthCodes: number[]
-  distPosCodes: number[]
-  inputBuffer: ExpandingBuffer
-  outputBuffer: ExpandingBuffer
-  onInputFinished(callback: Callback): void
-  backup(): void
-  restore(): void
-  stats: {
-    chunkCounter: number
-  }
-  compressionType: CompressionType
-  dictionarySizeBits: DictionarySizeBits
-  dictionarySizeMask: number
-  asciiTable2C34: number[]
-  asciiTable2D34: number[]
-  asciiTable2E34: number[]
-  asciiTable2EB4: number[]
-}
-
-/**
- * Decompresses stream
- * @returns a function, that you can use as a `transform._transform` method.
- */
-export function explode(config?: Config): PrivateState<PrivateExplodeState> & Handler
-export function createPATIterator(limit: number, stepper: number): (n: number) => false | [number, number]
-export function populateAsciiTable(value: number, index: number, bits: number, limit: number): number[]
-export function generateAsciiTables(): {
-  asciiTable2C34: number[]
-  asciiTable2D34: number[]
-  asciiTable2E34: number[]
-  asciiTable2EB4: number[]
-}
-export function processChunkData(state: PrivateExplodeState, verbose?: boolean): void
-export function wasteBits(state: PrivateExplodeState, numberOfBits: number): typeof PKDCL_STREAM_END | typeof PKDCL_OK
-export function decodeNextLiteral(state: PrivateExplodeState): typeof LITERAL_STREAM_ABORTED | number
-export function decodeDistance(state: PrivateExplodeState, repeatLength: number): number
-export function generateDecodeTables(startIndexes: number[], lengthBits: number[]): number[]

package/types/helpers/ExpandingBuffer.d.ts

@@ -1,25 +0,0 @@
-export = ExpandingBuffer
-declare class ExpandingBuffer {
-  constructor(numberOfBytes?: number)
-  _heap: Buffer
-  _startIndex: number
-  _endIndex: number
-  _backup: {
-    _startIndex: number
-    _endIndex: number
-  }
-  _getActualData(offset?: number): Buffer
-  size(): number
-  isEmpty(): boolean
-  heapSize(): number
-  append(buffer: Buffer): void
-  read(offset?: number, limit?: number): number | Buffer
-  flushStart(numberOfBytes: number): void
-  flushEnd(numberOfBytes: number): void
-  dropStart(numberOfBytes: number): void
-  dropEnd(numberOfBytes: number): void
-  getHeap(): Buffer
-  clear(): void
-  _saveIndices(): void
-  _restoreIndices(): void
-}

package/types/helpers/Shared.d.ts

@@ -1,46 +0,0 @@
-/**
- * Shared type signatures used throughout the library.
- */
-
-/**
- * A traditional "nodeback<Buffer>" callback type.
- * @param error The error, if any.
- * @param data The data, if any.
- */
-export type Callback = (error: Error | null, chunk: Buffer) => void
-
-/**
- * Handler for one chunk of bytes
- * @param chunk The chunk of bytes
- * @param encoding The encoding of the chunk (not used)
- * @param callback The callback to call when done
- */
-export type Handler = (chunk: Buffer, encoding: unknown, callback: Callback) => void
-
-/**
- * How the implode & explode functions store their internal state.
- */
-export type PrivateState<T> = { _state: T }
-
-/**
- * Configuration options for the implode & explode functions.
- */
-export type Config = {
-  /**
-   * Whether the code should display extra messages on the console or not
-   * @default false
-   */
-  verbose?: boolean
-  /**
-   * The starting size of the input buffer, may expand later as needed.
-   * Not having to expand may have performance impact.
-   * @default 0
-   */
-  inputBufferSize?: number
-  /**
-   * The starting size of the output buffer, may expand later as needed.
-   * Not having to expand may have performance impact.
-   * @default 0
-   */
-  outputBufferSize?: number
-}

package/types/helpers/functions.d.ts

@@ -1,15 +0,0 @@
-export function isNumber(x: any): boolean
-export function isString(x: any): boolean
-export function isFunction(x: any): boolean
-export function noop(): void
-export function isPlainObject(x: any): boolean
-export function isBetween(min: number, max: number, num: number): boolean
-export function nBitsOfOnes(numberOfBits: number): number
-export function maskBits(numberOfBits: number, number: number): number
-export function getLowestNBits(numberOfBits: number, number: number): number
-export function isFullHexString(str: string): boolean
-export function toHex(num: number, digits?: number, withoutPrefix?: boolean): string
-export function mergeSparseArrays<T>(a: T[], b: T[]): T[]
-export function parseNumberString(n: string, defaultValue?: number): number
-export function getPackageVersion(): Promise<string>
-export function fileExists(filename: string): Promise<boolean>

package/types/helpers/testing.d.ts

@@ -1,6 +0,0 @@
-import { Handler } from './Shared'
-
-export function isClass(obj: any): obj is Object
-export function buffersShouldEqual(expected: Buffer, result: Buffer, offset?: number, displayAsHex?: boolean): void
-export function bufferToString(buffer: Buffer, limit?: number): string
-export function transformToABC(): Handler

package/types/implode.d.ts

@@ -1,63 +0,0 @@
-import { CompressionType, DictionarySizeBits } from './constants'
-import ExpandingBuffer from './helpers/ExpandingBuffer'
-import { Callback, Config, Handler, PrivateState } from './helpers/Shared'
-
-type PrivateExplodeState = {
-  _backup: {
-    extraBits: number
-    bitBuffer: Buffer
-  }
-  needMoreInput: boolean
-  isFirstChunk: boolean
-  extraBits: number
-  bitBuffer: Buffer
-  chBitsAsc: number[] // DecodeLit and GenAscTabs uses this
-  lengthCodes: number[]
-  distPosCodes: number[]
-  nChBits: number[]
-  nChCodes: number[]
-  inputBuffer: ExpandingBuffer
-  outputBuffer: ExpandingBuffer
-  onInputFinished(callback: Callback): void
-  backup(): void
-  restore(): void
-  stats: {
-    chunkCounter: number
-  }
-  compressionType: CompressionType
-  dictionarySizeBits: DictionarySizeBits
-  dictionarySizeMask: number
-  asciiTable2C34: number[]
-  asciiTable2D34: number[]
-  asciiTable2E34: number[]
-  asciiTable2EB4: number[]
-}
-
-export function setup(state: PrivateExplodeState): void
-export function outputBits(state: PrivateExplodeState, nBits: number, bitBuffer: number): void
-export function getSizeOfMatching(inputBytes: number[], a: number, b: number): number
-export function findRepetitions(
-  inputBytes: number[],
-  endOfLastMatch: number,
-  cursor: number,
-): { size: number; distance: number }
-export function isRepetitionFlushable(
-  size: number,
-  distance: number,
-  startIndex: number,
-  inputBufferSize: number,
-): boolean | null
-export function processChunkData(state: PrivateExplodeState, verbose?: boolean): void
-
-/**
- * Compresses stream
- * @param compressionType one of `constants.CompressionType`
- * @param dictionarySizeBits one of `constants.DictionarySizeBits`
- * @param config `Config` object
- * @return a function, that you can use as a transform._transform method
- */
-export function implode(
-  compressionType: CompressionType,
-  dictionarySizeBits: DictionarySizeBits,
-  config?: Config,
-): PrivateState<PrivateExplodeState> & Handler

package/types/index.d.ts

@@ -1,8 +0,0 @@
-export { implode } from './implode'
-export { implode as compress } from './implode'
-export { explode } from './explode'
-export { explode as decompress } from './explode'
-
-export * as constants from './constants'
-export * as errors from './errors'
-export * as stream from './helpers/stream'