encoding-sleuth v0.1.6

encoding-sleuth

Analyse an array of bytes into spans of

• 7-bit clean (ASCII)
• UTF8 (with validity checks)
• unknown (bytes that are neither ASCII or part of a UTF8 sequence)

Installation

Using npm:

$ npm install encoding-sleuth

Usage

const EncodingSleuth = require("encoding-sleuth");
const fs = require("fs");

const mystery = fs.readFileSync("suspect.txt");
const es = new EncodingSleuth();
for (const span of es.analyse(mystery)) {
  console.log(span.enc, span.flags, span.pos, span.length);
}

Overview

encoding-sleuth parses a Uint8Array (or node Buffer) of bytes and splits them into spans that contain runs of

• 7-bit clean bytes (0x00 - 0x7f) which encode identically in both UTF8 and ASCII
• bytes that contain correctly encoded UTF8 characters
• bytes that can't be interpreted as either of the above

It can be used to

• validate encoding
• guess the encoding of arbitrary bytes
• automatically fix the encoding (with some extra code that you write)

API

Create a new EncodingSleuth like this:

const es = new EncodingSleuth(options);

options is an optional object with the following default values:

{
  checkUTF8Illegal: true,
  checkUTF8Replacement: true,
  checkUTF8Specials: true,
  checkUTF8Bom: true,
  checkUTF8MaxCodePoint: true,
  checkUTF8NonCanonicalEncoding: true,
  checkUTF8: true,
}

Each option enables a check that is performed on every decoded UTF8 code point:

• checkUTF8Illegal: flag code points between 0xd800 and 0xdfff as illegal
• checkUTF8Replacement: flag the UTF8 replacement character (xfffd) as replacement
• checkUTF8Specials: flag code points between 0xfff0 and 0xffff as special
• checkUTF8Bom: flag the UTF8 BOM (0xfeff) as bom
• checkUTF8MaxCodePoint: flag code points >= 0x110000 as aboveMax. Can be true, false or a number - in which case it will be used as the upper limit instead of 0x110000
• checkUTF8NonCanonicalEncoding: flag unnecessary long encodings as nonCanonical
• checkUTF8: set false to disable all UTF8 checks.

By default all checks are enabled.

Having created an EncodingSleuth instance use it to analyse some bytes:

const es = new EncodingSleuth();
const mystery = fs.readFileSync("suspect.txt");

for (const span of es.analyse(mystery)) {
  console.log(span.enc, span.flags, span.pos, span.length);
}

analyse returns an iterator which can consumed in a variety of ways:

// in a loop
for (const span of es.analyse(mystery)) {
  console.log(span.enc, span.flags, span.pos, span.length);
}

// or grab it all into an Array
const spans = Array.from(es.analyse(mystery));

// etc

Each span is an object like this:

{
  enc: "utf8",    // "utf8", "7bit" or "unknown"
  pos: 0,         // offset of this span in original byte array
  length: 18,     // length in bytes of this span
  flags: "",      // utf8 only, see below
  f: {},          // object version of flags: true for each set flag
  cp: [...],      // array of decoded code points in this span
  buf: Uint8Array // portion of the buffer subtended by this span
}

A span describes a contious run of bytes. Each span has a pos where it starts in the original bytes, a length indicating how many bytes it covers and a buf containing the actual bytes for this span. The returned spans are contiguous and don't overlap; joining their buf fields would yield the original input.

The enc field describes the encoding of this span of bytes:

• 7bit: a run of bytes between 0x00 and 0x7F inclusive
• utf8: a run of syntactically valid UTF8 encodings
• unknown: any bytes that are neither 7bit or utf8

For utf8 the cp array contains a list of decoded UTF8 code points. For 7bit or unknown it contains the byte values within this span.

UTF8

Syntactically valid UTF8 takes one of the following forms:

The single byte form (0x00 - 0x7F) is 7 bit safe, synonymous with ASCII and is identified as 7bit.

The other forms are identified by EncodingSleuth as utf8. They allow any code point between 0x80 an 0x7fffffff to be encoded.

Span flags

Each returned span has flags and f fields but they are only populated for utf8 sequences. With all checks enabled (see constructor above) the following flags may be set for each utf8 span:

• flag code points between 0xd800 and 0xdfff as 'illegal'; these are surrogates that shouldn't appear in valid utf8
• flag the UTF8 replacement character (xfffd) as 'replacement'; often used to represent invalid characters
• flag code points between 0xfff0 and 0xffff as 'special'
• flag the UTF8 BOM (0xfeff) as 'bom'
• flag code points >= 0x110000 as 'aboveMax'
• flag unnecessary long encodings as 'nonCanonical'

Generally speaking the presence of any of these flags is likely to indicate a problem with the input data; the precise interpretation depends on your use case.

Non-canonical UTF8

nonCanonical UTF8 sequences are syntactically valid UTF8 that use more bytes than necessary to encode a particular code point. Any code point between 0x00 and 0x80000000 can be encoded using the 6 byte form but, in practice, valid UTF8 will use the shortest possible encoding so nonCanonical may indicate that the bytes being analysed are not "normal" UTF8.

During parsing by analyse a new span is returned each time the enc or flags fields change; runs of bytes with the same encoding and flags are merged and returned as a single span. There's a very slight speed-up from turning off tests that you're not interested in but the main reason to disable checks is to simplify processing of the returned spans. Generally it's fine to use the defaults.