@react-pdf/stylesheet 4.1.9 → 4.2.1

package/lib/{index.cjs.js → index.cjs}

@@ -3,8 +3,8 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var fns = require('@react-pdf/fns');
-var parse$1 = require('postcss-value-parser/lib/parse');
-var parseUnit = require('postcss-value-parser/lib/unit');
+var parse$1 = require('postcss-value-parser/lib/parse.js');
+var parseUnit = require('postcss-value-parser/lib/unit.js');
 var hlsToHex = require('hsl-to-hex');
 var colorString = require('color-string');
 var _extends = require('@babel/runtime/helpers/extends');
@@ -23,8 +23,14 @@ var matchMedia__default = /*#__PURE__*/_interopDefaultLegacy(matchMedia);
 
 // TODO: change flex defaults to [0, 1, 'auto'] as in spec in next major release
 var flexDefaults = [1, 1, 0];
+/**
+ * @type {(number | 'auto')[]}
+ */
 var flexAuto = [1, 1, 'auto'];
 var expandFlex = function expandFlex(key, value) {
+  /**
+   * @type {(number | 'auto')[]}
+   */
   var defaults = flexDefaults;
   var matches = [];
   if (value === 'auto') {
@@ -47,6 +53,13 @@ var BOX_MODEL_UNITS = 'px,in,mm,cm,pt,%,vw,vh';
 var logError = function logError(style, value) {
   console.error("\n    @react-pdf/stylesheet parsing error:\n\n    " + style + ": " + value + ",\n    " + ' '.repeat(style.length + 2) + "^\n    Unsupported " + style + " value format\n  ");
 };
+
+/**
+ * @param {Object} options
+ * @param {Function} [options.expandsTo]
+ * @param {number} [options.maxValues]
+ * @param {boolean} [options.autoSupported]
+ */
 var expandBoxModel = function expandBoxModel(_temp) {
   var _ref = _temp === void 0 ? {} : _temp,
     expandsTo = _ref.expandsTo,
@@ -326,9 +339,9 @@ var shorthands = {
 /**
  * Transforms style key-value
  *
- * @param {String} key style key
- * @param {String} value style value
- * @returns {String | Number} transformed style values
+ * @param {string} key style key
+ * @param {string} value style value
+ * @returns {string | Number} transformed style values
  */
 var expandStyle = function expandStyle(key, value) {
   var _ref;
@@ -338,8 +351,8 @@ var expandStyle = function expandStyle(key, value) {
 /**
  * Expand the shorthand properties.
  *
- * @param { Object } style object
- * @returns { Object } expanded style object
+ * @param {Object} style object
+ * @returns {Object} expanded style object
  */
 var expand = function expand(style) {
   if (!style) return style;
@@ -362,8 +375,9 @@ var expand = function expand(style) {
 /**
  * Remove nil values from array
  *
- * @param {Array} array
- * @returns {Array} array without nils
+ * @template T
+ * @param {(T | null | undefined)[]} array
+ * @returns {T[]} array without nils
  */
 var compact = function compact(array) {
   return array.filter(Boolean);
@@ -372,7 +386,7 @@ var compact = function compact(array) {
 /**
  * Merges style objects array
  *
- * @param {Array} style objects array
+ * @param {Object[]} styles style objects array
  * @returns {Object} merged style object
  */
 var mergeStyles = function mergeStyles(styles) {
@@ -390,21 +404,21 @@ var mergeStyles = function mergeStyles(styles) {
 /**
  * Flattens an array of style objects, into one aggregated style object.
  *
- * @param {Array} style objects array
- * @returns {Object} flatted style object
+ * @param {Object[]} styles style objects array
+ * @returns {Object} flattened style object
  */
 var flatten = fns.compose(mergeStyles, compact, fns.castArray);
 
 /**
  * Parses scalar value in value and unit pairs
  *
- * @param {String} scalar value
+ * @param {string} value scalar value
  * @returns {Object} parsed value
  */
 var parseValue = function parseValue(value) {
   var match = /^(-?\d*\.?\d+)(in|mm|cm|pt|vh|vw|px)?$/g.exec(value);
   return match ? {
-    value: parseFloat(match[1], 10),
+    value: parseFloat(match[1]),
     unit: match[2] || 'pt'
   } : {
     value: value,
@@ -416,7 +430,7 @@ var parseValue = function parseValue(value) {
  * Transform given scalar value
  *
  * @param {Object} container
- * @param {String} styles value
+ * @param {string} value styles value
  * @returns {Object} transformed value
  */
 var transformUnit = function transformUnit(container, value) {
@@ -450,7 +464,7 @@ var isHsl = function isHsl(value) {
 /**
  * Transform rgb color to hexa
  *
- * @param {String} styles value
+ * @param {string} value styles value
  * @returns {Object} transformed value
  */
 var parseRgb = function parseRgb(value) {
@@ -461,7 +475,7 @@ var parseRgb = function parseRgb(value) {
 /**
  * Transform Hsl color to hexa
  *
- * @param {String} styles value
+ * @param {string} value styles value
  * @returns {Object} transformed value
  */
 var parseHsl = function parseHsl(value) {
@@ -473,7 +487,7 @@ var parseHsl = function parseHsl(value) {
 /**
  * Transform given color to hexa
  *
- * @param {String} styles value
+ * @param {string} value styles value
  * @returns {Object} transformed value
  */
 var transformColor = function transformColor(value) {
@@ -648,7 +662,7 @@ var matchNumber = function matchNumber(value) {
 };
 var castFloat = function castFloat(value) {
   if (typeof value !== 'string') return value;
-  if (matchNumber(value)) return parseFloat(value, 10);
+  if (matchNumber(value)) return parseFloat(value);
   return value;
 };
 
@@ -688,11 +702,17 @@ var transformStyle = function transformStyle(key, value, container) {
   return transformColor(transformUnit(container, castFloat(result)));
 };
 
+/**
+ * @typedef {Function} Transform
+ * @param {Object} style styles object
+ * @returns {Object} transformed styles
+ */
+
 /**
  * Transform styles values
  *
- * @param {Object} styles object
- * @returns {Object} transformed styles
+ * @param {Object} container
+ * @returns {Transform} transform function
  */
 var transform = function transform(container) {
   return function (style) {

package/lib/{index.es.js → index.js}

@@ -1,6 +1,6 @@
 import { compose, castArray } from '@react-pdf/fns';
-import parse$1 from 'postcss-value-parser/lib/parse';
-import parseUnit from 'postcss-value-parser/lib/unit';
+import parse$1 from 'postcss-value-parser/lib/parse.js';
+import parseUnit from 'postcss-value-parser/lib/unit.js';
 import hlsToHex from 'hsl-to-hex';
 import colorString from 'color-string';
 import _extends from '@babel/runtime/helpers/extends';
@@ -10,8 +10,14 @@ import matchMedia from 'media-engine';
 
 // TODO: change flex defaults to [0, 1, 'auto'] as in spec in next major release
 var flexDefaults = [1, 1, 0];
+/**
+ * @type {(number | 'auto')[]}
+ */
 var flexAuto = [1, 1, 'auto'];
 var expandFlex = function expandFlex(key, value) {
+  /**
+   * @type {(number | 'auto')[]}
+   */
   var defaults = flexDefaults;
   var matches = [];
   if (value === 'auto') {
@@ -34,6 +40,13 @@ var BOX_MODEL_UNITS = 'px,in,mm,cm,pt,%,vw,vh';
 var logError = function logError(style, value) {
   console.error("\n    @react-pdf/stylesheet parsing error:\n\n    " + style + ": " + value + ",\n    " + ' '.repeat(style.length + 2) + "^\n    Unsupported " + style + " value format\n  ");
 };
+
+/**
+ * @param {Object} options
+ * @param {Function} [options.expandsTo]
+ * @param {number} [options.maxValues]
+ * @param {boolean} [options.autoSupported]
+ */
 var expandBoxModel = function expandBoxModel(_temp) {
   var _ref = _temp === void 0 ? {} : _temp,
     expandsTo = _ref.expandsTo,
@@ -313,9 +326,9 @@ var shorthands = {
 /**
  * Transforms style key-value
  *
- * @param {String} key style key
- * @param {String} value style value
- * @returns {String | Number} transformed style values
+ * @param {string} key style key
+ * @param {string} value style value
+ * @returns {string | Number} transformed style values
  */
 var expandStyle = function expandStyle(key, value) {
   var _ref;
@@ -325,8 +338,8 @@ var expandStyle = function expandStyle(key, value) {
 /**
  * Expand the shorthand properties.
  *
- * @param { Object } style object
- * @returns { Object } expanded style object
+ * @param {Object} style object
+ * @returns {Object} expanded style object
  */
 var expand = function expand(style) {
   if (!style) return style;
@@ -349,8 +362,9 @@ var expand = function expand(style) {
 /**
  * Remove nil values from array
  *
- * @param {Array} array
- * @returns {Array} array without nils
+ * @template T
+ * @param {(T | null | undefined)[]} array
+ * @returns {T[]} array without nils
  */
 var compact = function compact(array) {
   return array.filter(Boolean);
@@ -359,7 +373,7 @@ var compact = function compact(array) {
 /**
  * Merges style objects array
  *
- * @param {Array} style objects array
+ * @param {Object[]} styles style objects array
  * @returns {Object} merged style object
  */
 var mergeStyles = function mergeStyles(styles) {
@@ -377,21 +391,21 @@ var mergeStyles = function mergeStyles(styles) {
 /**
  * Flattens an array of style objects, into one aggregated style object.
  *
- * @param {Array} style objects array
- * @returns {Object} flatted style object
+ * @param {Object[]} styles style objects array
+ * @returns {Object} flattened style object
  */
 var flatten = compose(mergeStyles, compact, castArray);
 
 /**
  * Parses scalar value in value and unit pairs
  *
- * @param {String} scalar value
+ * @param {string} value scalar value
  * @returns {Object} parsed value
  */
 var parseValue = function parseValue(value) {
   var match = /^(-?\d*\.?\d+)(in|mm|cm|pt|vh|vw|px)?$/g.exec(value);
   return match ? {
-    value: parseFloat(match[1], 10),
+    value: parseFloat(match[1]),
     unit: match[2] || 'pt'
   } : {
     value: value,
@@ -403,7 +417,7 @@ var parseValue = function parseValue(value) {
  * Transform given scalar value
  *
  * @param {Object} container
- * @param {String} styles value
+ * @param {string} value styles value
  * @returns {Object} transformed value
  */
 var transformUnit = function transformUnit(container, value) {
@@ -437,7 +451,7 @@ var isHsl = function isHsl(value) {
 /**
  * Transform rgb color to hexa
  *
- * @param {String} styles value
+ * @param {string} value styles value
  * @returns {Object} transformed value
  */
 var parseRgb = function parseRgb(value) {
@@ -448,7 +462,7 @@ var parseRgb = function parseRgb(value) {
 /**
  * Transform Hsl color to hexa
  *
- * @param {String} styles value
+ * @param {string} value styles value
  * @returns {Object} transformed value
  */
 var parseHsl = function parseHsl(value) {
@@ -460,7 +474,7 @@ var parseHsl = function parseHsl(value) {
 /**
  * Transform given color to hexa
  *
- * @param {String} styles value
+ * @param {string} value styles value
  * @returns {Object} transformed value
  */
 var transformColor = function transformColor(value) {
@@ -635,7 +649,7 @@ var matchNumber = function matchNumber(value) {
 };
 var castFloat = function castFloat(value) {
   if (typeof value !== 'string') return value;
-  if (matchNumber(value)) return parseFloat(value, 10);
+  if (matchNumber(value)) return parseFloat(value);
   return value;
 };
 
@@ -675,11 +689,17 @@ var transformStyle = function transformStyle(key, value, container) {
   return transformColor(transformUnit(container, castFloat(result)));
 };
 
+/**
+ * @typedef {Function} Transform
+ * @param {Object} style styles object
+ * @returns {Object} transformed styles
+ */
+
 /**
  * Transform styles values
  *
- * @param {Object} styles object
- * @returns {Object} transformed styles
+ * @param {Object} container
+ * @returns {Transform} transform function
  */
 var transform = function transform(container) {
   return function (style) {

package/package.json

@@ -1,27 +1,35 @@
 {
   "name": "@react-pdf/stylesheet",
-  "version": "4.1.9",
+  "version": "4.2.1",
   "license": "MIT",
   "description": "A styles engine for Node and the browser",
   "author": "Diego Muracciole <diegomuracciole@gmail.com>",
   "homepage": "https://github.com/diegomura/react-pdf#readme",
-  "main": "lib/index.cjs.js",
-  "module": "lib/index.es.js",
+  "type": "module",
+  "main": "./lib/index.cjs",
+  "module": "./lib/index.js",
+  "exports": {
+    ".": {
+      "import": "./lib/index.js",
+      "require": "./lib/index.cjs",
+      "default": "./lib/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/diegomura/react-pdf.git",
     "directory": "packages/stylesheet"
   },
   "scripts": {
-    "test": "jest",
+    "test": "NODE_OPTIONS=\"--experimental-vm-modules\" jest",
     "build": "rimraf ./lib && rollup -c",
     "watch": "rimraf ./lib && rollup -c -w"
   },
   "dependencies": {
     "@babel/runtime": "^7.20.13",
-    "@react-pdf/fns": "2.0.1",
-    "@react-pdf/types": "^2.3.5",
-    "color-string": "^1.5.3",
+    "@react-pdf/fns": "2.1.0",
+    "@react-pdf/types": "^2.3.6",
+    "color-string": "^1.9.1",
     "hsl-to-hex": "^1.0.0",
     "media-engine": "^1.0.3",
     "postcss-value-parser": "^4.1.0"