🐛 Fix error with custom font name, test with read fonts

Setting a custom name on a font registration lead to an error in the
`FontStore`. This was caused by passing the custom name to fontkit's
`create` method which only supports this on certain font types.

This commit fixes the error and adds a test using real font files to
ensure the registration works in practice.

Author: ralfstx

src/font-store.test.ts

@@ -1,21 +1,52 @@
+import { readFile } from 'node:fs/promises';
+import { join } from 'node:path';
+
 import fontkit from '@pdf-lib/fontkit';
-import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
 
 import { FontStore } from './font-store.ts';
 import type { FontDef } from './fonts.ts';
 import { mkData } from './test/test-utils.ts';
 
-describe('font-store', () => {
+describe('FontStore', () => {
+  let normalFont: FontDef;
+  let italicFont: FontDef;
+  let obliqueFont: FontDef;
+  let boldFont: FontDef;
+  let italicBoldFont: FontDef;
+  let obliqueBoldFont: FontDef;
+  let otherFont: FontDef;
+
+  beforeEach(() => {
+    normalFont = fakeFontDef('Test');
+    italicFont = fakeFontDef('Test', { style: 'italic' });
+    obliqueFont = fakeFontDef('Test', { style: 'oblique' });
+    boldFont = fakeFontDef('Test', { weight: 700 });
+    italicBoldFont = fakeFontDef('Test', { style: 'italic', weight: 700 });
+    obliqueBoldFont = fakeFontDef('Test', { style: 'oblique', weight: 700 });
+    otherFont = fakeFontDef('Other');
+  });
+
   describe('selectFont', () => {
-    let normalFont: FontDef;
-    let italicFont: FontDef;
-    let obliqueFont: FontDef;
-    let boldFont: FontDef;
-    let italicBoldFont: FontDef;
-    let obliqueBoldFont: FontDef;
-    let otherFont: FontDef;
     let store: FontStore;
 
+    beforeEach(() => {
+      store = new FontStore([
+        normalFont,
+        italicFont,
+        obliqueFont,
+        boldFont,
+        italicBoldFont,
+        obliqueBoldFont,
+        otherFont,
+      ]);
+      vi.spyOn(fontkit, 'create').mockReturnValue({ fake: true } as any);
+    });
+
+    afterEach(() => {
+      vi.restoreAllMocks();
+    });
+
     beforeEach(() => {
       vi.spyOn(fontkit, 'create').mockReturnValue({ fake: true } as any);
       normalFont = fakeFontDef('Test');
@@ -56,7 +87,9 @@ describe('font-store', () => {
       await expect(store.selectFont({ fontFamily: 'Unknown' })).rejects.toThrow(
         expect.objectContaining({
           message: "Could not load font for 'Unknown', style=normal, weight=normal",
-          cause: new Error("No font defined for 'Unknown'"),
+          cause: new Error(
+            "No matching font found for family 'Unknown'. Registered families are: 'Test', 'Other'.",
+          ),
         }),
       );
     });
@@ -67,7 +100,7 @@ describe('font-store', () => {
       await expect(store.selectFont({ fontFamily: 'Test', fontStyle: 'italic' })).rejects.toThrow(
         expect.objectContaining({
           message: "Could not load font for 'Test', style=italic, weight=normal",
-          cause: new Error("No font defined for 'Test', style=italic"),
+          cause: new Error("No matching font found for 'Test', style=italic"),
         }),
       );
     });
@@ -139,7 +172,9 @@ describe('font-store', () => {
       await expect(store.selectFont({ fontFamily: 'foo' })).rejects.toThrow(
         expect.objectContaining({
           message: "Could not load font for 'foo', style=normal, weight=normal",
-          cause: new Error("No font defined for 'foo'"),
+          cause: new Error(
+            "No matching font found for family 'foo'. Registered families are: 'Test', 'Other'.",
+          ),
         }),
       );
     });
@@ -165,6 +200,46 @@ describe('font-store', () => {
       expect(font1).toBe(font2);
     });
   });
+
+  describe('registerFont', () => {
+    let store: FontStore;
+    let robotoRegular: Uint8Array;
+    let robotoLightItalic: Uint8Array;
+
+    beforeAll(async () => {
+      robotoRegular = await readFile(
+        join(__dirname, 'test/resources/fonts/roboto/Roboto-Regular.ttf'),
+      );
+      robotoLightItalic = await readFile(
+        join(__dirname, 'test/resources/fonts/roboto/Roboto-LightItalic.ttf'),
+      );
+    });
+
+    it('registers font with extracted config', async () => {
+      store = new FontStore();
+
+      store.registerFont(robotoRegular);
+      store.registerFont(robotoLightItalic);
+
+      const selected1 = await store.selectFont({ fontFamily: 'Roboto' });
+      const selected2 = await store.selectFont({ fontFamily: 'Roboto Light', fontStyle: 'italic' });
+      expect(selected1.data).toBe(robotoRegular);
+      expect(selected2.data).toBe(robotoLightItalic);
+    });
+
+    it('registers font with custom config', async () => {
+      store = new FontStore();
+
+      store.registerFont(robotoRegular, { name: 'Custom Name', weight: 'bold' });
+      store.registerFont(robotoLightItalic, { name: 'Custom Name', weight: 400, style: 'normal' });
+
+      const selected1 = await store.selectFont({ fontFamily: 'Custom Name' });
+      const selected2 = await store.selectFont({ fontFamily: 'Custom Name', fontWeight: 'bold' });
+
+      expect(selected1.data).toBe(robotoLightItalic);
+      expect(selected2.data).toBe(robotoRegular);
+    });
+  });
 });
 
 function fakeFontDef(family: string, options?: Partial<FontDef>): FontDef {

src/font-store.ts

@@ -16,7 +16,7 @@ export class FontStore {
   }
 
   registerFont(data: Uint8Array, config?: FontConfig): void {
-    const fkFont = fontkit.create(data, config?.name);
+    const fkFont = fontkit.create(data);
     const family = config?.name ?? fkFont.familyName ?? 'Unknown';
     const style = config?.style ?? extractStyle(fkFont);
     const weight = weightToNumber(config?.weight ?? extractWeight(fkFont));
@@ -63,7 +63,11 @@ function selectFont(fontDefs: FontDef[], selector: FontSelector): FontDef {
     ? fontDefs.filter((def) => def.family === selector.fontFamily)
     : fontDefs;
   if (!fontsWithMatchingFamily.length) {
-    throw new Error(`No font defined for '${selector.fontFamily}'`);
+    const uniqueFamilies = [...new Set(fontDefs.map((f) => f.family))];
+    throw new Error(
+      `No matching font found for family '${selector.fontFamily}'. ` +
+        `Registered families are: '${uniqueFamilies.join("', '")}'.`,
+    );
   }
   let fontsWithMatchingStyle = fontsWithMatchingFamily.filter(
     (def) => def.style === (selector.fontStyle ?? 'normal'),
@@ -78,13 +82,13 @@ function selectFont(fontDefs: FontDef[], selector: FontSelector): FontDef {
   if (!fontsWithMatchingStyle.length) {
     const { fontFamily: family, fontStyle: style } = selector;
     const selectorStr = `'${family}', style=${style ?? 'normal'}`;
-    throw new Error(`No font defined for ${selectorStr}`);
+    throw new Error(`No matching font found for ${selectorStr}`);
   }
   const selected = selectFontForWeight(fontsWithMatchingStyle, selector.fontWeight ?? 'normal');
   if (!selected) {
     const { fontFamily: family, fontStyle: style, fontWeight: weight } = selector;
     const selectorStr = `'${family}', style=${style ?? 'normal'}, weight=${weight ?? 'normal'}`;
-    throw new Error(`No font defined for ${selectorStr}`);
+    throw new Error(`No matching font found for ${selectorStr}`);
   }
   return selected;
 }

src/test/resources/fonts/roboto/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.