Alexandro.Net

Version 1.0.2

@stackline/cfb

Read and write compound files and ZIP containers with the SheetJS CFB API and bounded FAT traversal

Installation

npm install @stackline/cfb@1.0.2

Node.js: >=20.19.0. Read the compatibility and maintenance notes before migrating.

Usage and API

@stackline/cfb

Read and write compound files and ZIP containers with the SheetJS CFB API and bounded FAT traversal.

npm version license GitHub repository

Documentation | npm | Issues | Repository

Package version: 1.0.1

Why this package?

An independent Apache-2.0 maintenance fork of cfb@1.2.2.

npm install @stackline/cfb

const CFB = require('@stackline/cfb');

Version 1.0.0 preserves the upstream API and rejects cyclic FAT chains instead of hanging while parsing a damaged compound file (upstream issue SheetJS/js-cfb#11). The declared checksum runtime dependencies were unused because the implementation already embeds its checksum code; this package has no runtime dependencies.

Node.js 20.19 or newer is the supported development/runtime target. npm test builds the CommonJS/browser artifacts, runs the upstream API suite against three pinned public fixtures, and checks corrupted input and archive round trips. This selected fixture set is not the full upstream document corpus.

The original source and attribution are retained below.

Pure JS implementation of various container file formats, including ZIP and CFB.

Compatibility

Item Value
Package @stackline/cfb@1.0.1
Supported Node.js >=20.19.0
Module entry ./cfb (CommonJS)
Runtime dependencies 0 direct dependencies
Types types

Installation

npm install @stackline/cfb

In the browser:

<script src="dist/cfb.min.js" type="text/javascript"></script>

With npm:

$ npm install @stackline/cfb

The xlscfb.js file is designed to be embedded in js-xlsx

Usage

const CFB = require('@stackline/cfb');
const archive = CFB.utils.cfb_new();
CFB.utils.cfb_add(archive, 'hello.txt', Buffer.from('Hello'));
const bytes = CFB.write(archive, { type: 'buffer', fileType: 'zip' });

Library Usage

In node:

var CFB = require('@stackline/cfb');

For example, to get the Workbook content from an Excel 2003 XLS file:

var cfb = CFB.read(filename, {type: 'file'});
var workbook = CFB.find(cfb, 'Workbook');
var data = workbook.content;

Security

The parser rejects cyclic FAT chains instead of looping indefinitely. See the security policy for supported reporting and parser limitations.

See the security policy.

API Surface

Command-Line Utility Usage

The cfb-cli module ships with a CLI tool for manipulating and inspecting supported files.

JS API

TypeScript definitions are maintained in types/index.d.ts.

The CFB object exposes the following methods and properties:

CFB.parse(blob) takes a nodejs Buffer or an array of bytes and returns an parsed representation of the data.

CFB.read(blob, opts) wraps parse.

CFB.find(cfb, path) performs a case-insensitive match for the path (or file name, if there are no slashes) and returns an entry object or null if not found.

CFB.write(cfb, opts) generates a file based on the container.

CFB.writeFile(cfb, filename, opts) creates a file with the specified name.

Parse Options

CFB.read takes an options argument. opts.type controls the behavior:

type expected input
"base64" string: Base64 encoding of the file
"binary" string: binary string (byte n is data.charCodeAt(n))
"buffer" nodejs Buffer
"file" string: path of file that will be read (nodejs only)
(default) buffer or array of 8-bit unsigned int (byte n is data[n])

Write Options

CFB.write and CFB.writeFile take options argument.

opts.type controls the behavior:

type output
"base64" string: Base64 encoding of the file
"binary" string: binary string (byte n is data.charCodeAt(n))
"buffer" nodejs Buffer
"file" string: path of file that will be created (nodejs only)
(default) buffer if available, array of 8-bit unsigned int otherwise

opts.fileType controls the output file type:

fileType output
'cfb' (default) CFB container
'zip' ZIP file
'mad' MIME aggregate document

opts.compression enables DEFLATE compression for ZIP file type.

Utility Functions

The utility functions are available in the CFB.utils object. Functions that accept a name argument strictly deal with absolute file names:

By default, the library uses a pure JS inflate/deflate implementation. NodeJS zlib.InflateRaw exposes the number of bytes read in versions after 8.11.0. If a supplied zlib does not support the required features, a warning will be displayed in the console and the pure JS fallback will be used.

Container Object Description

The objects returned by parse and read have the following properties:

interface CFBEntry {
  name: string; /** Case-sensitive internal name */
  type: number; /** 1 = dir, 2 = file, 5 = root ; see [MS-CFB] 2.6.1 */
  content: Buffer | number[] | Uint8Array; /** Raw Content */
  ct?: Date; /** Creation Time */
  mt?: Date; /** Modification Time */
  ctype?: String; /** Content-Type (for MAD) */
}

References

Local Development

Clone the repository and run the following commands from its root:

npm ci
npm run build
npm test

Consumer Smoke Test

npm run test:package packs the library and exercises an isolated consumer using the repository fixture.

Release Checklist

  1. Update the package version, lockfile, generated version fields, and changelog together.
  2. Run the development checks above and audit both npm audit and npm audit --omit=dev.
  3. Use the GitHub publish workflow with its Prod environment to publish the exact CI tarball.
  4. Verify public npm bytes, package identity, provenance, and the immutable GitHub release evidence.

Community and Support

Report reproducible package issues in the issue tracker. Use the security policy for security reports.

License

Apache-2.0. Original copyright notices and upstream attribution are retained.

Please consult the attached LICENSE file for details. All rights not explicitly granted by the Apache 2.0 License are reserved by the Original Author.

Release changes

Changelog

1.0.2 - 2026-09-28

1.0.1 (2026-09-28)

1.0.0

Upstream history

CHANGELOG

This log is intended to keep track of backwards-incompatible changes, including but not limited to API changes and file location changes. Minor behavioral changes may not be included if they are not expected to break existing code.

1.2.1 (2021-09-06)

1.2.0 (2020-07-09)

1.1.0 (2018-09-04)

1.0.6 (2018-04-09)

1.0.0 (2017-11-05)

0.14.0 (2017-11-04)

Release files and references

Package bytes, npm provenance and the immutable GitHub release were verified for this version. Security checks describe the reviewed release; documented compatibility risks and upstream reports are not blanket claims of resolution.