node-sass-json-functions 3.3.0 → 4.0.1

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 ## [Unreleased][]
 
+## [4.0.1][] - 2023-06-13
+
+### Fixed
+
+-   ES module import implementation
+
+## [4.0.0][] - 2023-05-01
+
+### Changed
+
+-   Use [new Sass API](https://sass-lang.com/documentation/js-api)
+
+### Removed
+
+-   **Node 10 support, lowest version is 12.22**
+-   **Legacy Sass support, lowest version is 1.45**
+-   Precision option; Dart Sass defaults to a sufficiently high precision for
+    all existing browsers
+
 ## [3.3.0][] - 2022-01-11
 
 ### Added
@@ -41,6 +60,13 @@
 
 <!-- prettier-ignore-end -->
 
-[unreleased]:
-	https://github.com/niksy/node-sass-json-functions/compare/v3.3.0...HEAD
+    https://github.com/niksy/node-sass-json-functions/compare/v3.3.0...HEAD
+
 [3.3.0]: https://github.com/niksy/node-sass-json-functions/tree/v3.3.0
+[Unreleased]:
+	https://github.com/niksy/node-sass-json-functions/compare/v4.0.1...HEAD
+[4.0.1]: https://github.com/niksy/node-sass-json-functions/tree/v4.0.1
+
+    https://github.com/niksy/node-sass-json-functions/compare/v4.0.0...HEAD
+
+[4.0.0]: https://github.com/niksy/node-sass-json-functions/tree/v4.0.0

package/README.md

@@ -13,18 +13,15 @@ npm install sass node-sass-json-functions --save
 ## Usage
 
 ```js
-import sass from 'sass';
+import * as sass from 'sass';
 import jsonFns from 'node-sass-json-functions';
 
-sass.render(
-	{
-		file: './index.scss',
+(async () => {
+	const result = await sass.compileAsync('./index.scss', {
 		functions: { ...jsonFns }
-	},
-	(err, res) => {
-		// ...
-	}
-);
+	});
+	// ...
+})();
 ```
 
 Module exports object with prepared functions `json-encode` and `json-decode`.
@@ -101,9 +98,9 @@ DEBUG: (foo: 1, bar: 2, 3, baz: 3 3 3, bad: (foo: 11, bar: 22, baz: 5, 4, 6, nul
 
 ## API
 
-### json-encode(data[, quotes, precision])
+### json-encode(data[, quotes])
 
-Returns: `sass.types.String`
+Returns: `sass.SassString`
 
 Encodes (`JSON.stringify`) data and returns [Sass string][sass-string]. By
 default, string is quoted with single quotes so that it can be easily used in
@@ -115,34 +112,27 @@ standard CSS values.
     alpha value, otherwise they are transformed to hex value (and it’s shorther
     version if possible)
 -   [Sass strings][sass-string] are transformed to strings
--   Sass numbers are transformed to numbers
--   Sass null values and anything unresolved is transformed to null values
+-   [Sass numbers][sass-number] are transformed to numbers
+-   [Sass booleans][sass-boolean] are transformed to booleans
+-   [Sass null][sass-null] values and anything unresolved is transformed to null
+    values
 
 #### data
 
-Type:
-`sass.types.Null|sass.types.Number|sass.types.String|sass.types.Boolean|sass.types.Color|sass.types.List|sass.types.Map`
+Type: `sass.Value`
 
 Data to encode (stringify).
 
 #### quotes
 
-Type: `sass.types.Boolean`  
-Default: `true`
+Type: `sass.SassBoolean`  
+Default: `sass.sassTrue`
 
 Should output string be quoted with single quotes.
 
-#### precision
-
-Type: `sass.types.Number`  
-Default: `5`
-
-Number of digits after the decimal.
+### json-decode(string)
 
-### json-decode(data)
-
-Returns:
-`sass.types.Null|sass.types.Number|sass.types.String|sass.types.Boolean|sass.types.Color|sass.types.List|sass.types.Map`
+Returns: `sass.Value`
 
 Decodes (`JSON.parse`) string and returns one of [available Sass
 types][sass-types].
@@ -154,12 +144,14 @@ types][sass-types].
 -   Strings are transformed to Sass numbers with units if they can be properly
     parsed with [parse-css-dimension][parse-css-dimension], otherwise they are
     transformed to [Sass strings][sass-string]
--   Numbers are transformed to Sass numbers
--   Null values and anything unresolved is transformed to Sass null values
+-   Numbers are transformed to [Sass numbers][sass-number]
+-   Booleans are transformed to [Sass booleans][sass-boolean]
+-   Null values and anything unresolved is transformed to [Sass null][sass-null]
+    values
 
-#### data
+#### string
 
-Type: `sass.types.String`
+Type: `sass.SassString`
 
 String to decode (parse).
 
@@ -172,11 +164,14 @@ MIT © [Ivan Nikolić](http://ivannikolic.com)
 [ci]: https://github.com/niksy/node-sass-json-functions/actions?query=workflow%3ACI
 [ci-img]: https://github.com/niksy/node-sass-json-functions/workflows/CI/badge.svg?branch=master
 [sass]: https://github.com/sass/dart-sass
-[sass-types]: https://github.com/sass/node-sass#functions--v300---experimental
-[sass-list]: http://sass-lang.com/documentation/file.SASS_REFERENCE.html#lists
-[sass-map]: http://sass-lang.com/documentation/file.SASS_REFERENCE.html#maps
-[sass-color]: http://sass-lang.com/documentation/file.SASS_REFERENCE.html#colors
-[sass-string]: http://sass-lang.com/documentation/file.SASS_REFERENCE.html#sass-script-strings
+[sass-types]: https://sass-lang.com/documentation/js-api/classes/Value
+[sass-list]: https://sass-lang.com/documentation/values/lists
+[sass-map]: https://sass-lang.com/documentation/values/maps
+[sass-color]: https://sass-lang.com/documentation/values/colors
+[sass-number]: https://sass-lang.com/documentation/values/numbers
+[sass-string]: https://sass-lang.com/documentation/values/strings
+[sass-null]: https://sass-lang.com/documentation/values/null
+[sass-boolean]: https://sass-lang.com/documentation/values/booleans
 [parse-color]: https://github.com/substack/parse-color
 [parse-css-dimension]: https://github.com/jedmao/parse-css-dimension
 

package/cjs/index.d.ts

@@ -5,10 +5,10 @@ export type JsonPrimitive = string | number | boolean | null;
 export type JsonObject = {
     [x: string]: JsonValue | undefined;
 };
-/** @type {{ 'json-encode($value, $quotes: true, $precision: 5)': typeof encode, 'json-decode($value)': typeof decode }} */
+/** @type {{ 'json-encode($data, $quotes: true)': typeof encode, 'json-decode($string)': typeof decode }} */
 declare const api: {
-    'json-encode($value, $quotes: true, $precision: 5)': typeof encode;
-    'json-decode($value)': typeof decode;
+    'json-encode($data, $quotes: true)': typeof encode;
+    'json-decode($string)': typeof decode;
 };
 /**
  * @typedef {JsonPrimitive | JsonObject | JsonArray} JsonValue
@@ -19,16 +19,20 @@ declare const api: {
 /**
  * Encodes (`JSON.stringify`) data and returns Sass string. By default, string is quoted with single quotes so that it can be easily used in standard CSS values.
  *
- * @param {sass.LegacyValue}   value     Data to encode (stringify).
- * @param {sass.types.Boolean} quotes    Should output string be quoted with single quotes.
- * @param {sass.types.Number}  precision Number of digits after the decimal.
+ * First argument:  `sass.Value` - Data to encode (stringify).
+ *
+ * Second argument: `sass.SassBoolean` - Should output string be quoted with single quotes.
+ *
+ * @param {sass.Value[]} encodeArguments
  */
-declare function encode(value: sass.LegacyValue, quotes: sass.types.Boolean, precision: sass.types.Number): sass.types.String;
+declare function encode(encodeArguments: sass.Value[]): sass.SassString;
 /**
  * Decodes (`JSON.parse`) string and returns one of available Sass types.
  *
- * @param {sass.types.String} value String to decode (parse).
+ * First argument: `sass.SassString` - String to decode (parse).
+ *
+ * @param {sass.Value[]} decodeArguments
  */
-declare function decode(value: sass.types.String): sass.types.Null | sass.types.Number | sass.types.String | sass.types.Color | sass.types.List | sass.types.Map | sass.types.Boolean<true> | sass.types.Boolean<false>;
-import sass from "sass";
+declare function decode(decodeArguments: sass.Value[]): sass.Value;
+import * as sass from "sass";
 //# sourceMappingURL=index.d.ts.map

package/cjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.js"],"names":[],"mappings":";wBAKa,aAAa,GAAG,UAAU,cAAY;wBACtC,SAAS,EAAE;4BACX,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI;;;;AAsC7C,2HAA2H;AAC3H,mBADW;IAAE,mDAAmD,EAAE,aAAa,CAAC;IAAC,qBAAqB,EAAE,aAAa,CAAA;CAAE,CAIrH;AA7CF;;;;;GAKG;AAEH;;;;;;GAMG;AACH,+BAJW,KAAK,WAAW,UAChB,KAAK,KAAK,QAAQ,aAClB,KAAK,KAAK,OAAO,qBAW3B;AAED;;;;GAIG;AACH,+BAFW,KAAK,KAAK,OAAO,wKAW3B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.js"],"names":[],"mappings":";wBAKa,aAAa,GAAG,UAAU,cAAY;wBACtC,SAAS,EAAE;4BACX,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI;;;;AA4C7C,4GAA4G;AAC5G,mBADW;IAAE,mCAAmC,EAAE,aAAa,CAAC;IAAC,sBAAsB,EAAE,aAAa,CAAA;CAAE,CAItG;AAnDF;;;;;GAKG;AAEH;;;;;;;;GAQG;AACH,yCAFW,KAAK,KAAK,EAAE,mBAWtB;AAED;;;;;;GAMG;AACH,yCAFW,KAAK,KAAK,EAAE,cAatB"}

package/cjs/index.js

@@ -1,28 +1,40 @@
 'use strict';
 
 var sass = require('sass');
-var round = require('round-to');
 var rgbHex = require('rgb-hex');
 var shortHexColor = require('shorten-css-hex');
 var isPlainObject = require('is-plain-obj');
 var parseColor = require('parse-color');
 var parseUnit = require('parse-css-dimension');
+var immutable = require('immutable');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
-var sass__default = /*#__PURE__*/_interopDefaultLegacy(sass);
-var round__default = /*#__PURE__*/_interopDefaultLegacy(round);
+function _interopNamespace(e) {
+	if (e && e.__esModule) return e;
+	var n = Object.create(null);
+	if (e) {
+		Object.keys(e).forEach(function (k) {
+			if (k !== 'default') {
+				var d = Object.getOwnPropertyDescriptor(e, k);
+				Object.defineProperty(n, k, d.get ? d : {
+					enumerable: true,
+					get: function () { return e[k]; }
+				});
+			}
+		});
+	}
+	n["default"] = e;
+	return Object.freeze(n);
+}
+
+var sass__namespace = /*#__PURE__*/_interopNamespace(sass);
 var rgbHex__default = /*#__PURE__*/_interopDefaultLegacy(rgbHex);
 var shortHexColor__default = /*#__PURE__*/_interopDefaultLegacy(shortHexColor);
 var isPlainObject__default = /*#__PURE__*/_interopDefaultLegacy(isPlainObject);
 var parseColor__default = /*#__PURE__*/_interopDefaultLegacy(parseColor);
 var parseUnit__default = /*#__PURE__*/_interopDefaultLegacy(parseUnit);
 
-/**
- * @typedef {object} Options
- * @property {number} precision Number of digits after the decimal.
- */
-
 /**
  * @typedef {import('../index').JsonValue} JsonValue
  * @typedef {import('../index').JsonObject} JsonObject
@@ -30,77 +42,73 @@ var parseUnit__default = /*#__PURE__*/_interopDefaultLegacy(parseUnit);
  */
 
 /**
- * @param {sass.LegacyValue|undefined} value
- * @param {Options}                    options
+ * @param {sass.Value|undefined} value
  */
-function getJsonValueFromSassValue(value, options) {
-	let resolvedValue;
-	if (value instanceof sass__default["default"].types.List) {
-		resolvedValue = listToArray(value, options);
-	} else if (value instanceof sass__default["default"].types.Map) {
-		resolvedValue = mapToObject(value, options);
-	} else if (value instanceof sass__default["default"].types.Color) {
-		/** @type {[number, number, number]} */
-		const rgbValue = [value.getR(), value.getG(), value.getB()];
-		const alphaValue = value.getA();
-		if (alphaValue === 1) {
-			resolvedValue = shortHexColor__default["default"](`#${rgbHex__default["default"].apply(null, rgbValue)}`);
-		} else {
-			resolvedValue = `rgba(${rgbValue.join(',')},${alphaValue})`;
-		}
-	} else if (value instanceof sass__default["default"].types.Number) {
-		if (value.getUnit() !== '') {
-			resolvedValue = String(
-				round__default["default"](Number(value.getValue()), options.precision) +
-					value.getUnit()
-			);
-		} else {
-			resolvedValue = round__default["default"](Number(value.getValue()), options.precision);
-		}
-	} else {
-		try {
-			if (typeof value !== 'undefined' && 'getValue' in value) {
-				resolvedValue = value.getValue();
-			} else {
-				resolvedValue = null;
-			}
-		} catch (error) {
-			resolvedValue = null;
-		}
-	}
-	return resolvedValue;
+function getJsonValueFromSassValue(value) {
+  let resolvedValue;
+  if (value instanceof sass__namespace.SassList) {
+    resolvedValue = listToArray(value);
+  } else if (value instanceof sass__namespace.SassMap) {
+    resolvedValue = mapToObject(value);
+  } else if (value instanceof sass__namespace.SassColor) {
+    /** @type {[number, number, number]} */
+    const rgbValue = [value.red, value.green, value.blue];
+    const alphaValue = value.alpha;
+    if (alphaValue === 1) {
+      resolvedValue = shortHexColor__default["default"](`#${rgbHex__default["default"].apply(null, rgbValue)}`);
+    } else {
+      resolvedValue = `rgba(${rgbValue.join(',')},${alphaValue})`;
+    }
+  } else if (value instanceof sass__namespace.SassNumber) {
+    if (value.hasUnits) {
+      resolvedValue = String(value.value) + value.numeratorUnits.last();
+    } else {
+      resolvedValue = Number(value.value);
+    }
+  } else if (value instanceof sass__namespace.SassString) {
+    resolvedValue = String(value.text);
+  } else if (value instanceof sass__namespace.SassBoolean) {
+    resolvedValue = Boolean(value.value);
+  } else {
+    resolvedValue = null;
+  }
+  return resolvedValue;
 }
 
 /**
- * @param {sass.types.List} list
- * @param {Options}         options
+ * @param {sass.SassList} list
  */
-function listToArray(list, options) {
-	const length = list.getLength();
-	/** @type {JsonArray} */
-	const data = [];
-	for (const index of Array.from({ length }).keys()) {
-		const value = getJsonValueFromSassValue(list.getValue(index), options);
-		data.push(value);
-	}
-	return data;
+function listToArray(list) {
+  const length = list.asList.size;
+  /** @type {JsonArray} */
+  const data = [];
+  for (const index of Array.from({
+    length
+  }).keys()) {
+    const value = getJsonValueFromSassValue(list.get(index));
+    data.push(value);
+  }
+  return data;
 }
 
 /**
- * @param {sass.types.Map} map
- * @param {Options}        options
+ * @param {sass.SassMap} map
  */
-function mapToObject(map, options) {
-	const length = map.getLength();
-	/** @type {JsonObject} */
-	const data = {};
-	for (const index of Array.from({ length }).keys()) {
-		// @ts-ignore
-		const key = String(map.getKey(index).getValue());
-		const value = getJsonValueFromSassValue(map.getValue(index), options);
-		data[key] = value;
-	}
-	return data;
+function mapToObject(map) {
+  const length = map.contents.size;
+  /** @type {JsonObject} */
+  const data = {};
+  for (const index of Array.from({
+    length
+  }).keys()) {
+    const resolvedValue = map.get(index);
+    if (typeof resolvedValue !== 'undefined') {
+      const key = String(resolvedValue.get(0));
+      const value = getJsonValueFromSassValue(resolvedValue.get(1));
+      data[key] = value;
+    }
+  }
+  return data;
 }
 
 /**
@@ -115,87 +123,92 @@ const unitTypes = ['length', 'angle', 'resolution', 'frequency', 'time'];
  * @param {string} value
  */
 function isColor(value) {
-	return typeof parseColor__default["default"](value).rgba !== 'undefined';
+  return typeof parseColor__default["default"](value).rgba !== 'undefined';
 }
 
 /**
  * @param {string} value
  */
 function parseValueToStringOrNumber(value) {
-	let resolvedValue;
-	try {
-		const { value: parsedValue, unit, type } = parseUnit__default["default"](value);
-		if (unitTypes.includes(type)) {
-			resolvedValue = new sass__default["default"].types.Number(parsedValue, unit);
-		} else if (type === 'percentage') {
-			resolvedValue = new sass__default["default"].types.Number(parsedValue, '%');
-		} else {
-			resolvedValue = new sass__default["default"].types.String(value);
-		}
-	} catch (error) {
-		resolvedValue = new sass__default["default"].types.String(value);
-	}
-	return resolvedValue;
+  let resolvedValue;
+  try {
+    const {
+      value: parsedValue,
+      unit,
+      type
+    } = parseUnit__default["default"](value);
+    if (unitTypes.includes(type)) {
+      resolvedValue = new sass__namespace.SassNumber(parsedValue, unit);
+    } else if (type === 'percentage') {
+      resolvedValue = new sass__namespace.SassNumber(parsedValue, '%');
+    } else {
+      resolvedValue = new sass__namespace.SassString(value);
+    }
+  } catch (error) {
+    resolvedValue = new sass__namespace.SassString(value);
+  }
+  return resolvedValue;
 }
 
 /**
  * @param {string} value
  */
 function parseValueToColor(value) {
-	const [r, g, b, a] = parseColor__default["default"](value).rgba;
-	return new sass__default["default"].types.Color(r, g, b, a);
+  const [red, green, blue, alpha] = parseColor__default["default"](value).rgba;
+  return new sass__namespace.SassColor({
+    red,
+    green,
+    blue,
+    alpha
+  });
 }
 
 /**
  * @param {JsonValue} value
  */
 function setJsonValueToSassValue(value) {
-	let resolvedValue;
-	if (Array.isArray(value)) {
-		resolvedValue = arrayToList(value);
-	} else if (isPlainObject__default["default"](value)) {
-		resolvedValue = objectToMap(value);
-	} else if (isColor(String(value))) {
-		resolvedValue = parseValueToColor(String(value));
-	} else if (typeof value === 'string') {
-		resolvedValue = parseValueToStringOrNumber(value);
-	} else if (typeof value === 'number') {
-		resolvedValue = new sass__default["default"].types.Number(value);
-	} else if (typeof value === 'boolean') {
-		resolvedValue = value
-			? sass__default["default"].types.Boolean.TRUE
-			: sass__default["default"].types.Boolean.FALSE;
-	} else {
-		resolvedValue = sass__default["default"].types.Null.NULL;
-	}
-	return resolvedValue;
+  let resolvedValue;
+  if (Array.isArray(value)) {
+    resolvedValue = arrayToList(value);
+  } else if (isPlainObject__default["default"](value)) {
+    resolvedValue = objectToMap(value);
+  } else if (isColor(String(value))) {
+    resolvedValue = parseValueToColor(String(value));
+  } else if (typeof value === 'string') {
+    resolvedValue = parseValueToStringOrNumber(value);
+  } else if (typeof value === 'number') {
+    resolvedValue = new sass__namespace.SassNumber(value);
+  } else if (typeof value === 'boolean') {
+    resolvedValue = value ? sass__namespace.sassTrue : sass__namespace.sassFalse;
+  } else {
+    resolvedValue = sass__namespace.sassNull;
+  }
+  return resolvedValue;
 }
 
 /**
  * @param {JsonArray} array
  */
 function arrayToList(array) {
-	const length = array.length;
-	const data = new sass__default["default"].types.List(length);
-	for (const [index, item] of array.entries()) {
-		data.setValue(index, setJsonValueToSassValue(item));
-	}
-	return data;
+  /** @type {sass.Value[]} */
+  const data = [];
+  for (const item of array) {
+    data.push(setJsonValueToSassValue(item));
+  }
+  return new sass__namespace.SassList(data);
 }
 
 /**
  * @param {JsonObject} object
  */
 function objectToMap(object) {
-	const length = Object.keys(object).length;
-	const data = new sass__default["default"].types.Map(length);
-	for (const [index, [property, value = null]] of Object.entries(
-		object
-	).entries()) {
-		data.setKey(index, setJsonValueToSassValue(property));
-		data.setValue(index, setJsonValueToSassValue(value));
-	}
-	return data;
+  /** @type {[sass.Value, sass.Value][]} */
+  const data = [];
+  for (const [property, value = null] of Object.entries(object)) {
+    data.push([setJsonValueToSassValue(property), setJsonValueToSassValue(value)]);
+  }
+  // eslint-disable-next-line new-cap
+  return new sass__namespace.SassMap(immutable.OrderedMap(data));
 }
 
 /**
@@ -208,41 +221,47 @@ function objectToMap(object) {
 /**
  * Encodes (`JSON.stringify`) data and returns Sass string. By default, string is quoted with single quotes so that it can be easily used in standard CSS values.
  *
- * @param {sass.LegacyValue}   value     Data to encode (stringify).
- * @param {sass.types.Boolean} quotes    Should output string be quoted with single quotes.
- * @param {sass.types.Number}  precision Number of digits after the decimal.
+ * First argument:  `sass.Value` - Data to encode (stringify).
+ *
+ * Second argument: `sass.SassBoolean` - Should output string be quoted with single quotes.
+ *
+ * @param {sass.Value[]} encodeArguments
  */
-function encode(value, quotes, precision) {
-	const shouldQuote = quotes.getValue();
-	let resolvedValue = JSON.stringify(
-		getJsonValueFromSassValue(value, { precision: precision.getValue() })
-	);
-	if (shouldQuote) {
-		resolvedValue = `'${resolvedValue}'`;
-	}
-	return new sass__default["default"].types.String(resolvedValue);
+function encode(encodeArguments) {
+  const [data, quotes_] = encodeArguments;
+  const quotes = quotes_.assertBoolean('quotes');
+  const shouldQuote = quotes.value;
+  let resolvedValue = JSON.stringify(getJsonValueFromSassValue(data));
+  if (shouldQuote) {
+    resolvedValue = `'${resolvedValue}'`;
+  }
+  return new sass__namespace.SassString(resolvedValue);
 }
 
 /**
  * Decodes (`JSON.parse`) string and returns one of available Sass types.
  *
- * @param {sass.types.String} value String to decode (parse).
+ * First argument: `sass.SassString` - String to decode (parse).
+ *
+ * @param {sass.Value[]} decodeArguments
  */
-function decode(value) {
-	/** @type {JsonValue?} */
-	let resolvedValue = {};
-	try {
-		resolvedValue = JSON.parse(value.getValue());
-	} catch (error) {
-		resolvedValue = null;
-	}
-	return setJsonValueToSassValue(resolvedValue);
+function decode(decodeArguments) {
+  const [string_] = decodeArguments;
+  const string = string_.assertString('string');
+  /** @type {JsonValue?} */
+  let resolvedValue = {};
+  try {
+    resolvedValue = JSON.parse(string.text);
+  } catch (error) {
+    resolvedValue = null;
+  }
+  return setJsonValueToSassValue(resolvedValue);
 }
 
-/** @type {{ 'json-encode($value, $quotes: true, $precision: 5)': typeof encode, 'json-decode($value)': typeof decode }} */
+/** @type {{ 'json-encode($data, $quotes: true)': typeof encode, 'json-decode($string)': typeof decode }} */
 const api = {
-	'json-encode($value, $quotes: true, $precision: 5)': encode,
-	'json-decode($value)': decode
+  'json-encode($data, $quotes: true)': encode,
+  'json-decode($string)': decode
 };
 
 module.exports = api;