@react-fabric/utilities 1.0.0-beta.6 → 1.0.0-beta.61

package/dist/cjs/_lonlat.js

@@ -0,0 +1,102 @@
+'use strict';
+
+var _slicedToArray = require('@babel/runtime/helpers/slicedToArray');
+var _isType = require('./_isType.js');
+
+var getLatitudeLongitude = function getLatitudeLongitude(lonLat) {
+  var _convertLatLng = convertLatLng(lonLat),
+    _convertLatLng2 = _slicedToArray(_convertLatLng, 2),
+    lon = _convertLatLng2[0],
+    lat = _convertLatLng2[1];
+  return {
+    latitude: lat,
+    longitude: lon
+  };
+};
+
+/**
+ * Convert various formats of longitude and latitude to a tuple of [lon, lat].
+ * This function supports:
+ * - Arrays with two or three elements (e.g., [lon, lat] or [lon, lat, alt])
+ * - Objects with properties `lng`, `lat`, `lon`, or `longitude` and `latitude`
+ * - Strings in the format "lat,lon"
+ * The function will return a tuple of numbers [lon, lat].
+ *
+ * @param {LngLatLike} lonLat - The input longitude and latitude in various formats.
+ * @returns { [lon: number, lat: number] } A tuple of [lon, lat] where lon and lat are numbers.
+ * @throws Error if the input is not a valid format.
+ */
+var convertLatLng = function convertLatLng(lonLat) {
+  if (_isType.isEmpty(lonLat)) {
+    throw Error("Invalid geo coordinates");
+  }
+  if (_isType.isArray(lonLat) && lonLat.length === 2 || _isType.isArray(lonLat) && lonLat.length === 3) {
+    return [Number(lonLat[0]), Number(lonLat[1])];
+  }
+  if (_isType.isObject(lonLat)) {
+    if ("longitude" in lonLat) {
+      return [lonLat.longitude, lonLat.latitude];
+    }
+    return ["lon" in lonLat ? lonLat.lon : lonLat.lng, lonLat.lat];
+  }
+  if (_isType.isString(lonLat)) {
+    var _lonLat$split = lonLat.split(","),
+      _lonLat$split2 = _slicedToArray(_lonLat$split, 2),
+      _lat = _lonLat$split2[0],
+      _lon = _lonLat$split2[1];
+    if (!isNaN(+_lat) && !isNaN(+_lon)) return [+_lon, +_lat];
+  }
+  throw Error("Invalid geo coordinates");
+};
+
+/**
+ * Convert a coordinate to Degrees, Minutes, Seconds (DMS) format.
+ * This function takes a coordinate and returns a string in the format "degrees˚minutes'seconds" with direction (N/S or E/W).
+ * It handles both latitude and longitude coordinates.
+ * This function assumes that the input coordinate is in decimal degrees format.
+ * It converts the coordinate to DMS format by calculating the degrees, minutes, and seconds,
+ * and then formatting the result as a string.
+ *
+ * @param {number} coord - The coordinate to convert.
+ * @param {boolean} isLat - Whether the coordinate is latitude (default is false for longitude).
+ * @returns {string} A string representation of the coordinate in DMS format.
+ */
+var convertToDMS = function convertToDMS(coord) {
+  var isLat = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+  var degree = Math.floor(Math.abs(coord));
+  var hour = (Math.abs(coord) - degree) * 60;
+  var minute = (hour - Math.floor(hour)) * 60;
+  return "".concat(degree, "\u02DA").concat(Math.floor(hour), "'").concat(minute.toFixed(2), "\"").concat(coord < 0 ? isLat ? "S" : "W" : isLat ? "N" : "E");
+};
+
+/**
+ * Convert a latitude and longitude to a human-readable text format.
+ * This function takes a latitude and longitude in various formats and
+ * returns a string in the format "degrees˚minutes'seconds" with direction (N/S, E/W).
+ *
+ * This function supports:
+ *
+ * - Objects with properties `lng`, `lat`, `lon`, or `longitude` and `latitude`
+ * - Arrays with two or three elements (e.g., [lon, lat] or [lon, lat, alt])
+ * - Strings in the format "lat,lon"
+ *
+ * @param {LngLatLike} latlon - The latitude and longitude in various formats.
+ * @returns {string} A string representation of the location in DMS format.
+ *
+ * @example
+ * ```jsx
+ * const location = getLocationAsText({ lat: 40.7128, lng: -74.0060 });
+ * console.log(location); // "40˚42'51.36"N, 74˚0'21.60"W"
+ * ```
+ */
+var getLocationAsText = function getLocationAsText(latlon) {
+  var _convertLatLng3 = convertLatLng(latlon),
+    _convertLatLng4 = _slicedToArray(_convertLatLng3, 2),
+    lon = _convertLatLng4[0],
+    lat = _convertLatLng4[1];
+  return "".concat(convertToDMS(lat, true), ", ").concat(convertToDMS(lon));
+};
+
+exports.convertLatLng = convertLatLng;
+exports.getLatitudeLongitude = getLatitudeLongitude;
+exports.getLocationAsText = getLocationAsText;

package/dist/cjs/_mergeRefs.js

@@ -25,6 +25,17 @@
 
 /* istanbul ignore file */
 
+/**
+ * Merge multiple refs into a single ref callback.
+ * This function allows you to combine multiple refs (either callback refs or React refs)
+ * into a single ref callback that can be used in React components.
+ * This is particularly useful when you want to assign a single element to multiple refs,
+ * such as when using third-party libraries that require refs or when you want to share refs between components.
+ * The function iterates over the provided refs and assigns the element to each ref.
+ *
+ * @param {AnyObject[]} refs - An array of refs to merge.
+ * @returns {function} A function that takes an element and assigns it to all provided refs.
+ */
 var mergeRefs = function mergeRefs() {
   for (var _len = arguments.length, refs = new Array(_len), _key = 0; _key < _len; _key++) {
     refs[_key] = arguments[_key];

package/dist/cjs/_tokenize.js

@@ -27,10 +27,14 @@ var _isType = require('./_isType.js');
 
 
 /**
- * split text into array of tokens by word boundaries
- * @param str
- * @param keywords
- * @internal
+ * Tokenize a string based on provided keywords.
+ * This function splits the input string into tokens, where each token is an array containing
+ * the substring before the keyword and the keyword itself.
+ * If no keywords are provided, it returns the entire string as a single token.
+ *
+ * @param {string} str - The string to tokenize.
+ * @param {string | string[]} keywords - A string or an array of strings to use as keywords for tokenization.
+ * @returns {Array<[string, string]>} An array of tokens, where each token is an array of [substring, keyword].
  */
 var tokenize = function tokenize(str, keywords) {
   if (_isType.isEmpty(keywords)) {
@@ -56,6 +60,15 @@ var tokenize = function tokenize(str, keywords) {
   tokens.push([str.substring(lastIndex), ""]);
   return tokens;
 };
+
+/**
+ * Generate a token from a string.
+ * This function creates a token by taking the first letter of the first word and the first letter of the last word,
+ * or the first two letters of the first word if there is no last word.
+ *
+ * @param {string} str - The string to tokenize.
+ * @returns {string} A string token consisting of the first letters of the first and last words, or the first two letters of the first word.
+ */
 var iconToken = function iconToken(str) {
   var split = str.trim().split(" ");
   var first = split[0];

package/dist/cjs/getImageColorset.js

@@ -25,6 +25,21 @@
 
 /* istanbul ignore file */
 
+/**
+ * Get the color set of an image element.
+ * This function analyzes the pixel data of an image to determine if it is predominantly light or dark.
+ * It returns "light", "dark", or "light_transparent"/"dark_transparent" based on the pixel analysis.
+ * It uses a canvas to draw the image and extract pixel data for analysis.
+ * * The function calculates the brightness of each pixel using the formula:
+ *  brightness = 0.2126 * R + 0.7152 * G + 0.0722 * B
+ * * It counts the number of light and dark pixels, and determines the overall color set based on the ratio of light to dark pixels.
+ * * If the image has transparent pixels, it appends "_transparent" to the result.
+ * * This function is useful for determining the color scheme of an image, which can be helpful for UI design,
+ *   theming, and accessibility considerations.
+ *
+ * @param {HTMLImageElement} el - The HTMLImageElement to analyze.
+ * @returns {string} A string indicating the color set of the image.
+ */
 var getImageColorset = function getImageColorset(el) {
   // create canvas
   var canvas = document.createElement("canvas");
@@ -45,8 +60,8 @@ var getImageColorset = function getImageColorset(el) {
         transparent = true;
         continue;
       }
-      if (transparent && data[x - 1] === 1) {
-        continue;
+      if (data[x + 3] < 1) {
+        transparent = true;
       }
       r = data[x];
       g = data[x + 1];

package/dist/cjs/index.js

@@ -13,6 +13,7 @@ var _hash = require('./_hash.js');
 var _interpolate = require('./_interpolate.js');
 var _isEqual = require('./_isEqual.js');
 var _isType = require('./_isType.js');
+var _lonlat = require('./_lonlat.js');
 var _mergeRefs = require('./_mergeRefs.js');
 var _tokenize = require('./_tokenize.js');
 var getImageColorset = require('./getImageColorset.js');
@@ -95,6 +96,7 @@ exports.matchString = _isEqual.matchString;
 exports.isArray = _isType.isArray;
 exports.isBoolean = _isType.isBoolean;
 exports.isColor = _isType.isColor;
+exports.isDefined = _isType.isDefined;
 exports.isEmpty = _isType.isEmpty;
 exports.isFalse = _isType.isFalse;
 exports.isNil = _isType.isNil;
@@ -106,6 +108,9 @@ exports.isString = _isType.isString;
 exports.isSvgPath = _isType.isSvgPath;
 exports.isTrue = _isType.isTrue;
 exports.isUndefined = _isType.isUndefined;
+exports.convertLatLng = _lonlat.convertLatLng;
+exports.getLatitudeLongitude = _lonlat.getLatitudeLongitude;
+exports.getLocationAsText = _lonlat.getLocationAsText;
 exports.mergeRefs = _mergeRefs.mergeRefs;
 exports.iconToken = _tokenize.iconToken;
 exports.tokenize = _tokenize.tokenize;

package/dist/cjs/useLogger.js

@@ -207,7 +207,15 @@ var logger = function logger() {
 };
 
 /**
- * @internal
+ * useLogger is a custom hook that provides logging functionality.
+ * It allows you to log messages with different levels (log, debug, info, error, warning)
+ * and also provides a timer function to measure the duration of processes.
+ * The logs can include additional details such as the module name, process name, duration, and total time.
+ * It is designed to work in both Node.js and browser environments, adapting the log format accordingly.
+ * It uses ANSI escape codes for terminal colors in Node.js and CSS styles for console logs in the browser.
+ *
+ * @param mod - Optional module name to include in the log details.
+ * @returns An object with methods for logging messages and a timer function.
  */
 var useLogger = function useLogger(mod) {
   return {

package/dist/esm/_ascii.js

@@ -1,8 +1,31 @@
 'use client';
 
-import _slicedToArray from '@babel/runtime/helpers/slicedToArray';
 import { isEmpty } from './_isType.js';
 
+/*
+ * React Fabric
+ * @version: 1.0.0
+ *
+ *
+ * The MIT License (MIT)
+ * Copyright (c) 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+ * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+
 /** ***************** latin-ascii conversions *******************/
 var conversions = {
   AE: "Æ|Ǽ",
@@ -58,17 +81,19 @@ var conversions = {
 };
 
 /**
- * latin to ascii converter for convenient searching
- * @internal
+ * Converts a string to its ASCII representation by replacing
+ * special characters with their ASCII equivalents.
+ * This function is useful for normalizing strings for search or display purposes.
+ * It replaces characters like "Ä" with "Ae", "ß" with "ss", etc.
+ *
+ * @param {string} str - The input string to be converted.
+ * @returns {string} - The ASCII representation of the input string.
  */
 var ascii = function ascii(str) {
   if (isEmpty(str)) return "";
-  Object.entries(conversions).forEach(function (_ref) {
-    var _ref2 = _slicedToArray(_ref, 2),
-      a = _ref2[0],
-      l = _ref2[1];
-    var re = new RegExp(l, "g");
-    str = "".concat(str).replace(re, a);
+  Object.entries(conversions).forEach(function (entry) {
+    var re = new RegExp(entry[1], "g");
+    str = "".concat(str).replace(re, entry[0]);
   });
   return str;
 };

package/dist/esm/_boundingBox.js

@@ -18,8 +18,13 @@ var _getBox = function _getBox(box) {
 };
 
 /**
- * box "x,y,w,h" | [x,y,w,h]
- * returns canvas box [x,y,w,h]
+ * Get bounding box from a string or array.
+ * The box can be in the format "x,y,w,h" or [x,y,w,h].
+ * The box is adjusted to ensure that x and y are non-negative.
+ * The width and height are adjusted accordingly.
+ *
+ * @param box "x,y,w,h" | [x,y,w,h]
+ * @returns canvas box [x,y,w,h]
  */
 var getBox = function getBox() {
   var box = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "0,0,0,0";
@@ -37,8 +42,15 @@ var getBox = function getBox() {
 };
 
 /**
- * box "x1,y1,x2,y2" | [x1,y1,x2,y2]
- * returns canvas box [x,y,w,h]
+ * Get bounding box from a string or array.
+ * The box can be in the format "x1,y1,x2,y2" or [x1,y1,x2,y2].
+ * The box is adjusted to ensure that x1 and y1 are non-negative.
+ * The width and height are calculated as x2 - x1 and y2 - y1 respectively.
+ * If x1 or y1 are negative, they are set to 0 and the width and height are adjusted accordingly.
+ * This is useful for ensuring that the bounding box is always within the canvas area.
+ *
+ * @param box "x1,y1,x2,y2" | [x1,y1,x2,y2]
+ * @returns canvas box [x,y,w,h]
  */
 var getBoundingBox = function getBoundingBox() {
   var box = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "0,0,0,0";