@capsizecss/metrics 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,8 +1,67 @@
 # @capsizecss/metrics
 
-## 0.1.0
+## 0.2.0
+
 ### Minor Changes
 
+- [#80](https://github.com/seek-oss/capsize/pull/80) [`578682b`](https://github.com/seek-oss/capsize/commit/578682bd99cd965f34a4a0b20445087fdd1396c8) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - Expose `xHeight` metadata when available
+
+* [#80](https://github.com/seek-oss/capsize/pull/80) [`578682b`](https://github.com/seek-oss/capsize/commit/578682bd99cd965f34a4a0b20445087fdd1396c8) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - metrics: Ensure generated types reflect extracted metadata
+
+  The constructed types will now align with the metadata available from the font itself. This will ensure that TypeScript consumers receieve build time feedback for incomplete metrics, allowing manual overrides to complete the required FontMetric data.
+
+  ### Example
+
+  When the font metadata does not include a `capHeight`:
+
+  ```js
+  {
+    familyName: 'My Incomplete Font',
+    ascent: 860,
+    descent: -348,
+    lineGap: 0,
+    unitsPerEm: 1024
+  }
+  ```
+
+  TypeScript will now error when providing the metrics, rather than accepting them and rendering incorrectly.
+
+  ```ts
+  import myIncompleteFontMetrics from '@capsizecss/metrics/myIncompleteFont';
+  import { createStyleObject } from '@capsizecss/core';
+
+  createStyleObject({
+    fontSize: 16,
+    leading: 24,
+    // Errors with incomplete metrics, missing `capHeight`
+    fontMetrics: myIncompleteFontMetrics,
+  });
+  ```
 
+  This allows consumers to resolve missing values and complete the contract.
+
+  ```ts
+  createStyleObject({
+    fontSize: 16,
+    leading: 24,
+    // Error can be resolved by providing a manual override
+    fontMetrics: {
+      ...myIncompleteFontMetrics,
+      capHeight: 594,
+    },
+  });
+  ```
+
+  ### Resolving missing data
+
+  Resolving manual overrides can be done via the [Capsize website](https://seek-oss.github.io/capsize/). After selecting or uploading the font, use the `Edit` button at the end of `Step 1`.
+
+### Patch Changes
+
+- [#80](https://github.com/seek-oss/capsize/pull/80) [`578682b`](https://github.com/seek-oss/capsize/commit/578682bd99cd965f34a4a0b20445087fdd1396c8) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - metrics: Update Google Fonts to latest
+
+## 0.1.0
+
+### Minor Changes
 
 - [#48](https://github.com/seek-oss/capsize/pull/48) [`55251eb`](https://github.com/seek-oss/capsize/commit/55251ebe3ee668e8955485ab5474438fc3177b1b) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - Initial release

package/README.md

@@ -39,16 +39,17 @@ const capsizeStyles = createStyleObject({
 
 ## Font metrics
 
-The font metrics object returned contains the following properties:
-
-| Property   | Type   | Description                                      |
-| ---------- | ------ | ------------------------------------------------ |
-| familyName | string | Font family name as authored by font creator     |
-| capHeight  | number | The height of capital letters above the baseline |
-| ascent     | number | The height of the ascenders above baseline       |
-| descent    | number | The descent of the descenders below baseline     |
-| lineGap    | number | The amount of space included between lines       |
-| unitsPerEm | number | The size of the font’s internal coordinate grid  |
+The font metrics object returned contains the following properties if available:
+
+| Property   | Type   | Description                                         |
+| ---------- | ------ | --------------------------------------------------- |
+| familyName | string | Font family name as authored by font creator        |
+| capHeight  | number | The height of capital letters above the baseline    |
+| ascent     | number | The height of the ascenders above baseline          |
+| descent    | number | The descent of the descenders below baseline        |
+| lineGap    | number | The amount of space included between lines          |
+| unitsPerEm | number | The size of the font’s internal coordinate grid     |
+| xHeight    | number | The height of lower case letters above the baseline |
 
 ## Thanks
 

package/aBeeZee.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/aBeeZee' {
-  interface FontMetrics {
+  interface ABeeZeeMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: ABeeZeeMetrics;
   export default fontMetrics;
 }

package/aBeeZee.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 920,
   descent: -262,
   lineGap: 0,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 520
 };

package/abel.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/abel' {
-  interface FontMetrics {
+  interface AbelMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AbelMetrics;
   export default fontMetrics;
 }

package/abel.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 2006,
   descent: -604,
   lineGap: 0,
-  unitsPerEm: 2048
+  unitsPerEm: 2048,
+  xHeight: 1044
 };

package/abhayaLibre.d.ts

@@ -1,12 +1,11 @@
 declare module '@capsizecss/metrics/abhayaLibre' {
-  interface FontMetrics {
+  interface AbhayaLibreMetrics {
     familyName: string;
-    capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AbhayaLibreMetrics;
   export default fontMetrics;
 }

package/abrilFatface.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/abrilFatface' {
-  interface FontMetrics {
+  interface AbrilFatfaceMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AbrilFatfaceMetrics;
   export default fontMetrics;
 }

package/abrilFatface.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 1058,
   descent: -291,
   lineGap: 0,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 476
 };

package/aclonica.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/aclonica' {
-  interface FontMetrics {
+  interface AclonicaMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AclonicaMetrics;
   export default fontMetrics;
 }

package/aclonica.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 1687,
   descent: -533,
   lineGap: 101,
-  unitsPerEm: 2048
+  unitsPerEm: 2048,
+  xHeight: 1155
 };

package/acme.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/acme' {
-  interface FontMetrics {
+  interface AcmeMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AcmeMetrics;
   export default fontMetrics;
 }

package/acme.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 959,
   descent: -307,
   lineGap: 0,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 107
 };

package/actor.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/actor' {
-  interface FontMetrics {
+  interface ActorMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: ActorMetrics;
   export default fontMetrics;
 }

package/actor.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 941,
   descent: -262,
   lineGap: 0,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 503
 };

package/adamina.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/adamina' {
-  interface FontMetrics {
+  interface AdaminaMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AdaminaMetrics;
   export default fontMetrics;
 }

package/adamina.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 1072,
   descent: -290,
   lineGap: 0,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 534
 };

package/adventPro.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/adventPro' {
-  interface FontMetrics {
+  interface AdventProMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AdventProMetrics;
   export default fontMetrics;
 }

package/adventPro.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 964,
   descent: -232,
   lineGap: 0,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 501
 };

package/aguafinaScript.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/aguafinaScript' {
-  interface FontMetrics {
+  interface AguafinaScriptMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AguafinaScriptMetrics;
   export default fontMetrics;
 }

package/aguafinaScript.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 966,
   descent: -581,
   lineGap: 0,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 356
 };

package/akayaKanadaka.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/akayaKanadaka' {
-  interface FontMetrics {
+  interface AkayaKanadakaMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AkayaKanadakaMetrics;
   export default fontMetrics;
 }

package/akayaKanadaka.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 920,
   descent: -276,
   lineGap: 0,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 396
 };

package/akayaTelivigala.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/akayaTelivigala' {
-  interface FontMetrics {
+  interface AkayaTelivigalaMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AkayaTelivigalaMetrics;
   export default fontMetrics;
 }

package/akayaTelivigala.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 920,
   descent: -276,
   lineGap: 0,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 450
 };

package/akronim.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/akronim' {
-  interface FontMetrics {
+  interface AkronimMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AkronimMetrics;
   export default fontMetrics;
 }

package/akronim.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 785,
   descent: -314,
   lineGap: 43,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 486
 };

package/aladin.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/aladin' {
-  interface FontMetrics {
+  interface AladinMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AladinMetrics;
   export default fontMetrics;
 }

package/aladin.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 905,
   descent: -321,
   lineGap: 0,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 337
 };

package/alata.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/alata' {
-  interface FontMetrics {
+  interface AlataMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AlataMetrics;
   export default fontMetrics;
 }

package/alata.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 1100,
   descent: -280,
   lineGap: 0,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 459
 };

package/alatsi.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/alatsi' {
-  interface FontMetrics {
+  interface AlatsiMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AlatsiMetrics;
   export default fontMetrics;
 }

package/alatsi.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 2000,
   descent: -560,
   lineGap: 0,
-  unitsPerEm: 2000
+  unitsPerEm: 2000,
+  xHeight: 996
 };

package/aldrich.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/aldrich' {
-  interface FontMetrics {
+  interface AldrichMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AldrichMetrics;
   export default fontMetrics;
 }

package/aldrich.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 1475,
   descent: -430,
   lineGap: 98,
-  unitsPerEm: 2048
+  unitsPerEm: 2048,
+  xHeight: 1065
 };

package/alef.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/alef' {
-  interface FontMetrics {
+  interface AlefMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AlefMetrics;
   export default fontMetrics;
 }

package/alef.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 2067,
   descent: -722,
   lineGap: 0,
-  unitsPerEm: 2048
+  unitsPerEm: 2048,
+  xHeight: 1040
 };

package/alegreya.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/alegreya' {
-  interface FontMetrics {
+  interface AlegreyaMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AlegreyaMetrics;
   export default fontMetrics;
 }

package/alegreya.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 1016,
   descent: -345,
   lineGap: 0,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 452
 };

package/alegreyaSC.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/alegreyaSC' {
-  interface FontMetrics {
+  interface AlegreyaSCMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AlegreyaSCMetrics;
   export default fontMetrics;
 }

package/alegreyaSC.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 1016,
   descent: -345,
   lineGap: 0,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 452
 };

package/alegreyaSans.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/alegreyaSans' {
-  interface FontMetrics {
+  interface AlegreyaSansMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AlegreyaSansMetrics;
   export default fontMetrics;
 }

package/alegreyaSans.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 900,
   descent: -300,
   lineGap: 0,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 458
 };

package/alegreyaSansSC.d.ts

@@ -1,12 +1,13 @@
 declare module '@capsizecss/metrics/alegreyaSansSC' {
-  interface FontMetrics {
+  interface AlegreyaSansSCMetrics {
     familyName: string;
     capHeight: number;
     ascent: number;
     descent: number;
     lineGap: number;
     unitsPerEm: number;
+    xHeight: number;
   }
-  export const fontMetrics: FontMetrics;
+  export const fontMetrics: AlegreyaSansSCMetrics;
   export default fontMetrics;
 }

package/alegreyaSansSC.js

@@ -4,5 +4,6 @@ module.exports = {
   ascent: 900,
   descent: -300,
   lineGap: 0,
-  unitsPerEm: 1000
+  unitsPerEm: 1000,
+  xHeight: 458
 };