@capsizecss/metrics 1.1.0 → 1.1.1

package/CHANGELOG.md

@@ -0,0 +1,163 @@
+# @capsizecss/metrics
+
+## 1.1.1
+
+### Patch Changes
+
+- [#133](https://github.com/seek-oss/capsize/pull/133) [`87286bb`](https://github.com/seek-oss/capsize/commit/87286bbef42fd7bfba63d4b8f8ee467f0c8965d5) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - Ensure metrics files are published to npm
+
+## 1.1.0
+
+### Minor Changes
+
+- [#129](https://github.com/seek-oss/capsize/pull/129) [`9507530`](https://github.com/seek-oss/capsize/commit/950753056d5cb6a5c1cb87572470507ceb9a4b0a) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - **fontFamilyToCamelCase**: Expose utility to convert family name to import name
+
+  A helper function to support tooling that needs to convert the font family name to the correct casing for the relevant metrics import.
+
+  ```ts
+  import { fontFamilyToCamelCase } from '@capsizecss/metrics';
+
+  const familyName = fontFamilyToCamelCase('--apple-system'); // => `appleSystem`
+  const metrics = await import(`@capsizecss/metrics/${familyName}`);
+  ```
+
+- [#129](https://github.com/seek-oss/capsize/pull/129) [`9507530`](https://github.com/seek-oss/capsize/commit/950753056d5cb6a5c1cb87572470507ceb9a4b0a) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - **entireMetricsCollection**: Expose all metrics indexed by family name
+
+  Provides the entire metrics collection as a JSON object, keyed by font family name.
+
+  ***
+
+  **⚠️ CAUTION: Importing this will result in a _large JSON structure_ being pulled into your project!**
+
+  **It is not recommended to use this client side.**
+
+  ***
+
+  ```ts
+  import { entireMetricsCollection } from '@capsizecss/metrics/entireMetricsCollection';
+
+  const metrics = entireMetricsCollection['arial'];
+  ```
+
+## 1.0.1
+
+### Patch Changes
+
+- [#126](https://github.com/seek-oss/capsize/pull/126) [`eb59cde`](https://github.com/seek-oss/capsize/commit/eb59cde65705913ab83abd929ab956403efc881b) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - oxygen: Refine missing metrics
+
+  Refines the missing `capHeight` and `xHeight` metrics to align with anchor co-ordinates of relevant glyphs — `H` for capHeight and `x` for xHeight. Previously these values where subjectively observed using the Capsize website.
+
+- [#126](https://github.com/seek-oss/capsize/pull/126) [`eb59cde`](https://github.com/seek-oss/capsize/commit/eb59cde65705913ab83abd929ab956403efc881b) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - Add more system fonts
+
+  Expands the metrics library to include more system fonts. Fonts added are:
+
+  - `Tahoma`
+  - `Lucida Grande`
+  - `Verdana`
+  - `Trebuchet MS`
+  - `Georgia`
+  - `Courier New`
+  - `Brush Script`
+
+  The library now support all the [Best Web Safe Fonts](https://www.w3schools.com/cssref/css_websafe_fonts.php).
+
+## 1.0.0
+
+### Major Changes
+
+- [#125](https://github.com/seek-oss/capsize/pull/125) [`5d77f47`](https://github.com/seek-oss/capsize/commit/5d77f4758c32de8703f4869ff7b10cbf0b97af51) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - metrics, unpack: Cut v1 release
+
+  No actual breaking change here, but cutting the v1 release to mark the packages moving out of experimental phase.
+
+### Minor Changes
+
+- [#122](https://github.com/seek-oss/capsize/pull/122) [`8a15c86`](https://github.com/seek-oss/capsize/commit/8a15c8647bb12c85853c6807c1edc9d82a79e6dc) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - Update Google Fonts
+
+- [#122](https://github.com/seek-oss/capsize/pull/122) [`8a15c86`](https://github.com/seek-oss/capsize/commit/8a15c8647bb12c85853c6807c1edc9d82a79e6dc) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - Calculate and expose `xWidthAvg`, the average width of lowercase characters.
+
+- [#122](https://github.com/seek-oss/capsize/pull/122) [`8a15c86`](https://github.com/seek-oss/capsize/commit/8a15c8647bb12c85853c6807c1edc9d82a79e6dc) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - Add `category` field to describe the style of the font, e.g. “serif”, “sans-serif” etc.
+
+  Exposes the `category` field captured by Google Fonts, manually populating it for system fonts.
+
+## 0.4.0
+
+### Minor Changes
+
+- [#112](https://github.com/seek-oss/capsize/pull/112) [`0066a20`](https://github.com/seek-oss/capsize/commit/0066a209e7746c16a7a9e7433820bd57c39ba43f) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - Update Google Fonts to latest
+
+- [#110](https://github.com/seek-oss/capsize/pull/110) [`404de74`](https://github.com/seek-oss/capsize/commit/404de74384f5c81b77bb8bc5335aa4859554ea07) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - Add `timesNewRoman` metrics
+
+  Provides metrics for the built in system font `Times New Roman`.
+  Can be used by importing as `@capsizecss/metrics/timesNewRoman`.
+
+## 0.3.0
+
+### Minor Changes
+
+- [#88](https://github.com/seek-oss/capsize/pull/88) [`7500f2a`](https://github.com/seek-oss/capsize/commit/7500f2a4e5b2efd59e8238ffcd24f80ca670405c) Thanks [@michaeltaranto](https://github.com/michaeltaranto)! - Update Google Fonts to latest
+
+## 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)! - 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)! - 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/aBeeZee.d.ts

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

package/aBeeZee.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'ABeeZee',
+  category: 'sans-serif',
+  capHeight: 700,
+  ascent: 920,
+  descent: -262,
+  lineGap: 0,
+  unitsPerEm: 1000,
+  xHeight: 520,
+  xWidthAvg: 480
+};

package/abel.d.ts

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

package/abel.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'Abel',
+  category: 'sans-serif',
+  capHeight: 1434,
+  ascent: 2006,
+  descent: -604,
+  lineGap: 0,
+  unitsPerEm: 2048,
+  xHeight: 1044,
+  xWidthAvg: 780
+};

package/abhayaLibre.d.ts

@@ -0,0 +1,13 @@
+declare module '@capsizecss/metrics/abhayaLibre' {
+  interface AbhayaLibreMetrics {
+    familyName: string;
+    category: string;
+    ascent: number;
+    descent: number;
+    lineGap: number;
+    unitsPerEm: number;
+    xWidthAvg: number;
+  }
+  export const fontMetrics: AbhayaLibreMetrics;
+  export default fontMetrics;
+}

package/abhayaLibre.js

@@ -0,0 +1,9 @@
+module.exports = {
+  familyName: 'Abhaya Libre',
+  category: 'serif',
+  ascent: 860,
+  descent: -348,
+  lineGap: 0,
+  unitsPerEm: 1024,
+  xWidthAvg: 414
+};

package/aboreto.d.ts

@@ -0,0 +1,15 @@
+declare module '@capsizecss/metrics/aboreto' {
+  interface AboretoMetrics {
+    familyName: string;
+    category: string;
+    capHeight: number;
+    ascent: number;
+    descent: number;
+    lineGap: number;
+    unitsPerEm: number;
+    xHeight: number;
+    xWidthAvg: number;
+  }
+  export const fontMetrics: AboretoMetrics;
+  export default fontMetrics;
+}

package/aboreto.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'Aboreto',
+  category: 'display',
+  capHeight: 700,
+  ascent: 930,
+  descent: -230,
+  lineGap: 0,
+  unitsPerEm: 1000,
+  xHeight: 700,
+  xWidthAvg: 592
+};

package/abrilFatface.d.ts

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

package/abrilFatface.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'Abril Fatface',
+  category: 'display',
+  capHeight: 700,
+  ascent: 1058,
+  descent: -291,
+  lineGap: 0,
+  unitsPerEm: 1000,
+  xHeight: 476,
+  xWidthAvg: 455
+};

package/abyssinicaSIL.d.ts

@@ -0,0 +1,15 @@
+declare module '@capsizecss/metrics/abyssinicaSIL' {
+  interface AbyssinicaSILMetrics {
+    familyName: string;
+    category: string;
+    capHeight: number;
+    ascent: number;
+    descent: number;
+    lineGap: number;
+    unitsPerEm: number;
+    xHeight: number;
+    xWidthAvg: number;
+  }
+  export const fontMetrics: AbyssinicaSILMetrics;
+  export default fontMetrics;
+}

package/abyssinicaSIL.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'Abyssinica SIL',
+  category: 'serif',
+  capHeight: 1108,
+  ascent: 2034,
+  descent: -682,
+  lineGap: 0,
+  unitsPerEm: 2048,
+  xHeight: 983,
+  xWidthAvg: 973
+};

package/aclonica.d.ts

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

package/aclonica.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'Aclonica',
+  category: 'sans-serif',
+  capHeight: 1440,
+  ascent: 1687,
+  descent: -533,
+  lineGap: 101,
+  unitsPerEm: 2048,
+  xHeight: 1155,
+  xWidthAvg: 1125
+};

package/acme.d.ts

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

package/acme.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'Acme',
+  category: 'sans-serif',
+  capHeight: 695,
+  ascent: 959,
+  descent: -307,
+  lineGap: 0,
+  unitsPerEm: 1000,
+  xHeight: 107,
+  xWidthAvg: 388
+};

package/actor.d.ts

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

package/actor.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'Actor',
+  category: 'sans-serif',
+  capHeight: 682,
+  ascent: 941,
+  descent: -262,
+  lineGap: 0,
+  unitsPerEm: 1000,
+  xHeight: 503,
+  xWidthAvg: 424
+};

package/adamina.d.ts

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

package/adamina.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'Adamina',
+  category: 'serif',
+  capHeight: 796,
+  ascent: 1072,
+  descent: -290,
+  lineGap: 0,
+  unitsPerEm: 1000,
+  xHeight: 534,
+  xWidthAvg: 471
+};

package/adventPro.d.ts

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

package/adventPro.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'Advent Pro',
+  category: 'sans-serif',
+  capHeight: 700,
+  ascent: 964,
+  descent: -232,
+  lineGap: 0,
+  unitsPerEm: 1000,
+  xHeight: 501,
+  xWidthAvg: 368
+};

package/aguafinaScript.d.ts

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

package/aguafinaScript.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'Aguafina Script',
+  category: 'handwriting',
+  capHeight: 780,
+  ascent: 966,
+  descent: -581,
+  lineGap: 0,
+  unitsPerEm: 1000,
+  xHeight: 356,
+  xWidthAvg: 287
+};

package/akayaKanadaka.d.ts

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

package/akayaKanadaka.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'Akaya Kanadaka',
+  category: 'display',
+  capHeight: 634,
+  ascent: 920,
+  descent: -276,
+  lineGap: 0,
+  unitsPerEm: 1000,
+  xHeight: 396,
+  xWidthAvg: 406
+};

package/akayaTelivigala.d.ts

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

package/akayaTelivigala.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'Akaya Telivigala',
+  category: 'display',
+  capHeight: 613,
+  ascent: 920,
+  descent: -276,
+  lineGap: 0,
+  unitsPerEm: 1000,
+  xHeight: 450,
+  xWidthAvg: 409
+};

package/akronim.d.ts

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

package/akronim.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'Akronim',
+  category: 'display',
+  capHeight: 730,
+  ascent: 785,
+  descent: -314,
+  lineGap: 43,
+  unitsPerEm: 1000,
+  xHeight: 486,
+  xWidthAvg: 327
+};

package/akshar.d.ts

@@ -0,0 +1,15 @@
+declare module '@capsizecss/metrics/akshar' {
+  interface AksharMetrics {
+    familyName: string;
+    category: string;
+    capHeight: number;
+    ascent: number;
+    descent: number;
+    lineGap: number;
+    unitsPerEm: number;
+    xHeight: number;
+    xWidthAvg: number;
+  }
+  export const fontMetrics: AksharMetrics;
+  export default fontMetrics;
+}

package/akshar.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'Akshar',
+  category: 'sans-serif',
+  capHeight: 700,
+  ascent: 990,
+  descent: -390,
+  lineGap: 0,
+  unitsPerEm: 1000,
+  xHeight: 500,
+  xWidthAvg: 382
+};

package/aladin.d.ts

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

package/aladin.js

@@ -0,0 +1,11 @@
+module.exports = {
+  familyName: 'Aladin',
+  category: 'handwriting',
+  capHeight: 387,
+  ascent: 905,
+  descent: -321,
+  lineGap: 0,
+  unitsPerEm: 1000,
+  xHeight: 337,
+  xWidthAvg: 328
+};

package/alata.d.ts

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