woff2-decode 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jeremy Tribby, Countertype LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/LICENSE_THIRD_PARTY

@@ -0,0 +1,121 @@
+Test Fixtures
+=============
+
+The font files in test/fixtures/ are from the woff2-encoder project:
+https://github.com/itskyedo/woff2-encoder
+
+Copyright (c) 2023-PRESENT Kyedo
+Licensed under the MIT License
+
+The fonts themselves appear to be Inter, copyright The Inter Project Authors
+(https://github.com/rsms/inter), licensed under the SIL Open Font License 1.1
+
+---
+
+MIT License (woff2-encoder)
+---------------------------
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/README.md

@@ -0,0 +1,53 @@
+# woff2-decode
+
+A pure TypeScript WOFF2 decoder
+
+## Installation
+
+```bash
+npm install woff2-decode
+```
+
+## Usage
+
+```typescript
+import { decode } from 'woff2-decode'
+
+const woff2Data = await fetch('/font.woff2').then(r => r.arrayBuffer())
+const ttfData = decode(woff2Data)
+
+// ttfData is a Uint8Array containing the decoded TTF/OTF
+```
+
+The decoder handles both single fonts and TrueType Collections (TTC). For collections, the output is a valid TTC file
+
+## Performance
+
+Benchmarks on an M1 Mac, Node 20. In Node, native Brotli (via zlib) is used automatically. The pure JS fallback is for browsers
+
+| File | Size | Native | Pure JS |
+|------|------|--------|---------|
+| enc-otf.woff2 | 107 KB | 1.7 ms | 5.1 ms |
+| enc-ttf.woff2 | 98 KB | 4.0 ms | 7.1 ms |
+| enc-var-ttf.woff2 | 318 KB | 6.8 ms | 15.1 ms |
+
+CFF fonts decode faster because they skip the glyf/loca transform
+
+## What Gets Decoded
+
+WOFF2 is not just compressed font data. The spec defines transforms for certain tables:
+
+- **glyf/loca**: Point coordinates are delta-encoded with a variable-length triplet scheme. Reconstructing these is the bulk of the decoder logic
+- **hmtx**: Left side bearings can be stripped and reconstructed from glyph bounding boxes
+
+Tables without transforms (including CFF, CFF2, and everything else) pass through after Brotli decompression
+
+## API
+
+```typescript
+function decode(data: ArrayBuffer | Uint8Array): Uint8Array
+```
+
+Throws if the input is not valid WOFF2 or if decompression fails
+
+MIT, maintained by [@jpt](https://github.com/jpt)

package/dist/brotli.d.ts

@@ -0,0 +1,5 @@
+export declare function decompress(data: Uint8Array): Uint8Array;
+export declare function decompressNative(data: Uint8Array): Uint8Array;
+export declare function decompressPure(data: Uint8Array): Uint8Array;
+export declare const hasNative: boolean;
+//# sourceMappingURL=brotli.d.ts.map

package/dist/brotli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"brotli.d.ts","sourceRoot":"","sources":["../src/brotli.ts"],"names":[],"mappings":"AAiCA,wBAAgB,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU,CAKvD;AAGD,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU,CAK7D;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU,CAE3D;AAED,eAAO,MAAM,SAAS,SAAwB,CAAC"}

package/dist/buffer.d.ts

@@ -0,0 +1,20 @@
+export declare class Buffer {
+    private view;
+    private pos;
+    constructor(data: ArrayBuffer | Uint8Array, offset?: number, length?: number);
+    get offset(): number;
+    get length(): number;
+    get remaining(): number;
+    get buffer(): DataView;
+    skip(n: number): boolean;
+    seek(offset: number): boolean;
+    readU8(): number | null;
+    readU16(): number | null;
+    readS16(): number | null;
+    readU32(): number | null;
+    readS32(): number | null;
+    readBytes(n: number): Uint8Array | null;
+    peekU8(offset?: number): number | null;
+    subarray(offset: number, length: number): Uint8Array | null;
+}
+//# sourceMappingURL=buffer.d.ts.map

package/dist/buffer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buffer.d.ts","sourceRoot":"","sources":["../src/buffer.ts"],"names":[],"mappings":"AACA,qBAAa,MAAM;IACjB,OAAO,CAAC,IAAI,CAAW;IACvB,OAAO,CAAC,GAAG,CAAa;gBAEZ,IAAI,EAAE,WAAW,GAAG,UAAU,EAAE,MAAM,GAAE,MAAU,EAAE,MAAM,CAAC,EAAE,MAAM;IAU/E,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,IAAI,MAAM,IAAI,QAAQ,CAErB;IAED,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO;IAQxB,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAQ7B,MAAM,IAAI,MAAM,GAAG,IAAI;IAKvB,OAAO,IAAI,MAAM,GAAG,IAAI;IAOxB,OAAO,IAAI,MAAM,GAAG,IAAI;IAOxB,OAAO,IAAI,MAAM,GAAG,IAAI;IAOxB,OAAO,IAAI,MAAM,GAAG,IAAI;IAOxB,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;IAOvC,MAAM,CAAC,MAAM,GAAE,MAAU,GAAG,MAAM,GAAG,IAAI;IAMzC,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;CAM5D"}

package/dist/decode.d.ts

@@ -0,0 +1,5 @@
+export interface DecodeOptions {
+    forcePureBrotli?: boolean;
+}
+export declare function decode(data: ArrayBuffer | Uint8Array, options?: DecodeOptions): Uint8Array;
+//# sourceMappingURL=decode.d.ts.map

package/dist/decode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decode.d.ts","sourceRoot":"","sources":["../src/decode.ts"],"names":[],"mappings":"AAyDA,MAAM,WAAW,aAAa;IAC5B,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAGD,wBAAgB,MAAM,CAAC,IAAI,EAAE,WAAW,GAAG,UAAU,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,UAAU,CA6D1F"}