@capsizecss/metrics 1.0.1 → 1.1.1

package/CHANGELOG.md

@@ -1,5 +1,44 @@
 # @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

package/README.md

@@ -56,6 +56,37 @@ The font metrics object returned contains the following properties if available:
 [character frequencies]: https://en.wikipedia.org/wiki/Letter_frequency#Relative_frequencies_of_letters_in_other_languages
 [xavgcharwidth]: https://learn.microsoft.com/en-us/typography/opentype/spec/os2#xavgcharwidth
 
+## Supporting APIs
+
+### `fontFamilyToCamelCase`
+
+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}`);
+```
+
+### `entireMetricsCollection`
+
+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'];
+```
+
 ## Thanks
 
 - [SEEK](https://www.seek.com.au) for giving us the space to do interesting work.

package/dist/capsizecss-metrics.browser.cjs.js

@@ -0,0 +1,24 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * Converts the font family name to the correct casing for the relevant metrics import.
+ *
+ * ---
+ * Example usage:
+ *
+ * ```ts
+ * import { fontFamilyToCamelCase } from '@capsizecss/metrics';
+ *
+ * const familyName = fontFamilyToCamelCase('--apple-system'); // => `appleSystem`
+ * const metrics = await import(`@capsizecss/metrics/${familyName}`);
+ * ```
+ * ---
+ */
+
+function fontFamilyToCamelCase(str) {
+  return str.split(/[\s|-]/).filter(Boolean).map((s, i) => "".concat(s.charAt(0)[i > 0 ? 'toUpperCase' : 'toLowerCase']()).concat(s.slice(1))).join('');
+}
+
+exports.fontFamilyToCamelCase = fontFamilyToCamelCase;

package/dist/capsizecss-metrics.browser.esm.js

@@ -0,0 +1,20 @@
+/**
+ * Converts the font family name to the correct casing for the relevant metrics import.
+ *
+ * ---
+ * Example usage:
+ *
+ * ```ts
+ * import { fontFamilyToCamelCase } from '@capsizecss/metrics';
+ *
+ * const familyName = fontFamilyToCamelCase('--apple-system'); // => `appleSystem`
+ * const metrics = await import(`@capsizecss/metrics/${familyName}`);
+ * ```
+ * ---
+ */
+
+function fontFamilyToCamelCase(str) {
+  return str.split(/[\s|-]/).filter(Boolean).map((s, i) => "".concat(s.charAt(0)[i > 0 ? 'toUpperCase' : 'toLowerCase']()).concat(s.slice(1))).join('');
+}
+
+export { fontFamilyToCamelCase };

package/dist/capsizecss-metrics.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./declarations/src/index";

package/dist/capsizecss-metrics.cjs.dev.js

@@ -0,0 +1,24 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * Converts the font family name to the correct casing for the relevant metrics import.
+ *
+ * ---
+ * Example usage:
+ *
+ * ```ts
+ * import { fontFamilyToCamelCase } from '@capsizecss/metrics';
+ *
+ * const familyName = fontFamilyToCamelCase('--apple-system'); // => `appleSystem`
+ * const metrics = await import(`@capsizecss/metrics/${familyName}`);
+ * ```
+ * ---
+ */
+
+function fontFamilyToCamelCase(str) {
+  return str.split(/[\s|-]/).filter(Boolean).map((s, i) => "".concat(s.charAt(0)[i > 0 ? 'toUpperCase' : 'toLowerCase']()).concat(s.slice(1))).join('');
+}
+
+exports.fontFamilyToCamelCase = fontFamilyToCamelCase;

package/dist/capsizecss-metrics.cjs.js

@@ -0,0 +1,7 @@
+'use strict';
+
+if (process.env.NODE_ENV === "production") {
+  module.exports = require("./capsizecss-metrics.cjs.prod.js");
+} else {
+  module.exports = require("./capsizecss-metrics.cjs.dev.js");
+}

package/dist/capsizecss-metrics.cjs.prod.js

@@ -0,0 +1,24 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * Converts the font family name to the correct casing for the relevant metrics import.
+ *
+ * ---
+ * Example usage:
+ *
+ * ```ts
+ * import { fontFamilyToCamelCase } from '@capsizecss/metrics';
+ *
+ * const familyName = fontFamilyToCamelCase('--apple-system'); // => `appleSystem`
+ * const metrics = await import(`@capsizecss/metrics/${familyName}`);
+ * ```
+ * ---
+ */
+
+function fontFamilyToCamelCase(str) {
+  return str.split(/[\s|-]/).filter(Boolean).map((s, i) => "".concat(s.charAt(0)[i > 0 ? 'toUpperCase' : 'toLowerCase']()).concat(s.slice(1))).join('');
+}
+
+exports.fontFamilyToCamelCase = fontFamilyToCamelCase;

package/dist/capsizecss-metrics.esm.js

@@ -0,0 +1,20 @@
+/**
+ * Converts the font family name to the correct casing for the relevant metrics import.
+ *
+ * ---
+ * Example usage:
+ *
+ * ```ts
+ * import { fontFamilyToCamelCase } from '@capsizecss/metrics';
+ *
+ * const familyName = fontFamilyToCamelCase('--apple-system'); // => `appleSystem`
+ * const metrics = await import(`@capsizecss/metrics/${familyName}`);
+ * ```
+ * ---
+ */
+
+function fontFamilyToCamelCase(str) {
+  return str.split(/[\s|-]/).filter(Boolean).map((s, i) => "".concat(s.charAt(0)[i > 0 ? 'toUpperCase' : 'toLowerCase']()).concat(s.slice(1))).join('');
+}
+
+export { fontFamilyToCamelCase };