@cantoo/fontkit 2.0.8 → 2.0.9

package/dist/main.d.ts

@@ -138,16 +138,15 @@ export interface VariationAxisInfo {
   max: number;
 }
 
-/** Font subset writer. */
+/** Font subset writer (sync encode only in @cantoo/fontkit). */
 export interface Subset {
   includeGlyph(glyph: Glyph | number): number;
-  encodeStream(): unknown;
-  encode(cb?: (err: Error | null, data?: Uint8Array) => void): Promise<Uint8Array> | void;
+  /** Encode the subset as a font buffer (synchronous). */
+  encode(): Uint8Array;
 }
 
 /**
- * An opened font (or a font selected from a collection).
- * Matches the public surface of TTFFont / WOFF / WOFF2 / etc.
+ * An opened single font face (TTF / OTF / WOFF / WOFF2).
  */
 export interface Font {
   type: string;
@@ -193,14 +192,20 @@ export interface Font {
   getGlyph(glyph: number, characters?: number[]): Glyph | null;
   createSubset(): Subset;
   getVariation(variation: string | Record<string, number> | number[]): Font;
-  getFont?(
-    postscriptName: string | Uint8Array | Record<string, number>
-  ): Font | null | undefined;
+}
+
+/**
+ * A TrueType Collection (TTC) or Mac DFont container.
+ */
+export interface FontCollection {
+  type: 'TTC' | 'DFont' | string;
+  readonly fonts: Font[];
+  getFont(postscriptName: string | Uint8Array): Font | null;
 }
 
 /** Constructible font format registered with registerFormat(). */
 export interface FontFormat {
-  new (stream: unknown, variationCoords?: number[] | null): Font;
+  new (stream: unknown, variationCoords?: number[] | null): Font | FontCollection;
   probe(buffer: ArrayBufferView): boolean;
 }
 
@@ -208,23 +213,29 @@ export declare let logErrors: boolean;
 export declare let defaultLanguage: string;
 
 export declare function registerFormat(format: FontFormat): void;
+export declare function setDefaultLanguage(lang?: string): void;
+
+/** Open a font or collection from a buffer (no face selected). */
+export declare function create(buffer: ArrayBufferView): Font | FontCollection;
+/** Open a buffer and select a face by PostScript name. */
 export declare function create(
   buffer: ArrayBufferView,
-  postscriptName?: string | Uint8Array
-): Font | null | undefined;
-export declare function setDefaultLanguage(lang?: string): void;
+  postscriptName: string | Uint8Array
+): Font | null;
 
 /** Node-only: open a font file asynchronously. */
+export declare function open(filename: string | import('fs').PathLike): Promise<Font | FontCollection>;
 export declare function open(
   filename: string | import('fs').PathLike,
-  postscriptName?: string | Uint8Array
-): Promise<Font | null | undefined>;
+  postscriptName: string | Uint8Array
+): Promise<Font | null>;
 
 /** Node-only: open a font file synchronously. */
+export declare function openSync(filename: string | import('fs').PathLike): Font | FontCollection;
 export declare function openSync(
   filename: string | import('fs').PathLike,
-  postscriptName?: string | Uint8Array
-): Font | null | undefined;
+  postscriptName: string | Uint8Array
+): Font | null;
 
 declare const fontkit: {
   logErrors: boolean;

package/dist/module.d.ts

@@ -138,16 +138,15 @@ export interface VariationAxisInfo {
   max: number;
 }
 
-/** Font subset writer. */
+/** Font subset writer (sync encode only in @cantoo/fontkit). */
 export interface Subset {
   includeGlyph(glyph: Glyph | number): number;
-  encodeStream(): unknown;
-  encode(cb?: (err: Error | null, data?: Uint8Array) => void): Promise<Uint8Array> | void;
+  /** Encode the subset as a font buffer (synchronous). */
+  encode(): Uint8Array;
 }
 
 /**
- * An opened font (or a font selected from a collection).
- * Matches the public surface of TTFFont / WOFF / WOFF2 / etc.
+ * An opened single font face (TTF / OTF / WOFF / WOFF2).
  */
 export interface Font {
   type: string;
@@ -193,14 +192,20 @@ export interface Font {
   getGlyph(glyph: number, characters?: number[]): Glyph | null;
   createSubset(): Subset;
   getVariation(variation: string | Record<string, number> | number[]): Font;
-  getFont?(
-    postscriptName: string | Uint8Array | Record<string, number>
-  ): Font | null | undefined;
+}
+
+/**
+ * A TrueType Collection (TTC) or Mac DFont container.
+ */
+export interface FontCollection {
+  type: 'TTC' | 'DFont' | string;
+  readonly fonts: Font[];
+  getFont(postscriptName: string | Uint8Array): Font | null;
 }
 
 /** Constructible font format registered with registerFormat(). */
 export interface FontFormat {
-  new (stream: unknown, variationCoords?: number[] | null): Font;
+  new (stream: unknown, variationCoords?: number[] | null): Font | FontCollection;
   probe(buffer: ArrayBufferView): boolean;
 }
 
@@ -208,23 +213,29 @@ export declare let logErrors: boolean;
 export declare let defaultLanguage: string;
 
 export declare function registerFormat(format: FontFormat): void;
+export declare function setDefaultLanguage(lang?: string): void;
+
+/** Open a font or collection from a buffer (no face selected). */
+export declare function create(buffer: ArrayBufferView): Font | FontCollection;
+/** Open a buffer and select a face by PostScript name. */
 export declare function create(
   buffer: ArrayBufferView,
-  postscriptName?: string | Uint8Array
-): Font | null | undefined;
-export declare function setDefaultLanguage(lang?: string): void;
+  postscriptName: string | Uint8Array
+): Font | null;
 
 /** Node-only: open a font file asynchronously. */
+export declare function open(filename: string | import('fs').PathLike): Promise<Font | FontCollection>;
 export declare function open(
   filename: string | import('fs').PathLike,
-  postscriptName?: string | Uint8Array
-): Promise<Font | null | undefined>;
+  postscriptName: string | Uint8Array
+): Promise<Font | null>;
 
 /** Node-only: open a font file synchronously. */
+export declare function openSync(filename: string | import('fs').PathLike): Font | FontCollection;
 export declare function openSync(
   filename: string | import('fs').PathLike,
-  postscriptName?: string | Uint8Array
-): Font | null | undefined;
+  postscriptName: string | Uint8Array
+): Font | null;
 
 declare const fontkit: {
   logErrors: boolean;

package/dist/module.mjs

@@ -33,6 +33,24 @@ var defaultLanguage = "en";
 function setDefaultLanguage(lang = "en") {
   defaultLanguage = lang;
 }
+var fontkit = {
+  get logErrors() {
+    return logErrors;
+  },
+  set logErrors(value) {
+    logErrors = value;
+  },
+  get defaultLanguage() {
+    return defaultLanguage;
+  },
+  set defaultLanguage(value) {
+    defaultLanguage = value;
+  },
+  registerFormat,
+  create,
+  setDefaultLanguage
+};
+var base_default = fontkit;
 
 // src/decorators.js
 function cache(target, key, descriptor) {
@@ -16967,8 +16985,12 @@ registerFormat(WOFFFont);
 registerFormat(WOFF2Font);
 registerFormat(TrueTypeCollection);
 registerFormat(DFont);
+base_default.open = open;
+base_default.openSync = openSync;
+var node_default = base_default;
 export {
   create,
+  node_default as default,
   defaultLanguage,
   logErrors,
   open,