@citruslime/utils 0.0.1-beta.1

package/dist/citrus-lime-utils.es.js

@@ -0,0 +1,107 @@
+function generateStringId() {
+  return Math.random().toString(36).slice(2, 8);
+}
+function nameOf(name) {
+  return name;
+}
+function compareByProperty(firstValue, secondValue, property) {
+  return firstValue[property] < secondValue[property] ? -1 : firstValue[property] > secondValue[property] ? 1 : 0;
+}
+function getParamsByName(stringToSearch, paramToFind) {
+  let valueToReturn = "";
+  const urlToSearch = decodeURIComponent(stringToSearch);
+  const regexS = "[\\?&]" + paramToFind + "=([^&#]*)";
+  const regex = new RegExp(regexS);
+  const results = regex.exec(urlToSearch);
+  if (results && results[1]) {
+    valueToReturn = decodeURIComponent(results[1].replace(/\+/g, " "));
+  }
+  return valueToReturn;
+}
+String.prototype.similarity = function(comparisonString) {
+  let similarityToReturn = 0;
+  let longerString = this.toLowerCase();
+  let shorterString = comparisonString.toLowerCase();
+  if (longerString < shorterString) {
+    const temp = shorterString;
+    shorterString = longerString;
+    longerString = temp;
+  }
+  const longerLength = longerString.length;
+  if (longerLength === 0) {
+    similarityToReturn = 100;
+  } else {
+    similarityToReturn = Math.round((longerLength - levenshtein(longerString, shorterString)) / longerLength * 100);
+  }
+  return similarityToReturn;
+};
+String.prototype.trimChar = function(character) {
+  return this.trimStartChar(character).trimEndChar(character);
+};
+String.prototype.trimStartChar = function(character) {
+  return character !== "" && this.startsWith(character) ? this.slice(1) : this;
+};
+String.prototype.trimEndChar = function(character) {
+  return character !== "" && this.endsWith(character) ? this.slice(0, -1) : this;
+};
+String.prototype.trimToLength = function(length, addEllipsis = false) {
+  const trimLength = this.length < length ? this.length : length;
+  return addEllipsis && trimLength >= 4 && trimLength < this.length ? `${this.slice(0, Math.max(trimLength - 3, 1))}...` : this.slice(0, Math.max(trimLength, 1));
+};
+String.prototype.removeWhitespace = function() {
+  return this.replace(/\s/g, "");
+};
+String.prototype.removeNonAlphanumeric = function() {
+  return this.replace(/[^a-zA-Z0-9]/g, "");
+};
+String.prototype.removeNonAlphabetic = function() {
+  return this.replace(/[^a-zA-Z]/g, "");
+};
+String.prototype.removeNonNumeric = function() {
+  return this.replace(/[^0-9]/g, "");
+};
+String.prototype.replacePlaceholders = function(...args) {
+  let i = 0;
+  return this.replace(/{\d+}/g, () => typeof args[i] !== "undefined" ? args[i++] : "");
+};
+String.prototype.toDateFromTime = function() {
+  return new Date(`${new Date().toISOString().substr(0, 11)}${this}`);
+};
+function levenshtein(firstString, secondString) {
+  if (firstString.length === 0) {
+    return secondString.length;
+  }
+  if (secondString.length === 0) {
+    return firstString.length;
+  }
+  if (firstString.length > secondString.length) {
+    const tmp = firstString;
+    firstString = secondString;
+    secondString = tmp;
+  }
+  const row = new Int8Array(firstString.length + 1);
+  for (let i = 0; i <= firstString.length; i++) {
+    row[i] = i;
+  }
+  let temp;
+  for (let i = 1; i <= secondString.length; i++) {
+    let prev = i;
+    const previousChar = secondString[i - 1];
+    for (let j = 1; j <= firstString.length; j++) {
+      if (previousChar === firstString[j - 1]) {
+        temp = row[j - 1];
+      } else {
+        const a = prev + 1;
+        const b = row[j] + 1;
+        const c = a - (a - b & b - a >> 7);
+        const d = row[j - 1] + 1;
+        temp = c - (c - d & d - c >> 7);
+      }
+      row[j - 1] = prev;
+      prev = temp;
+    }
+    row[firstString.length] = prev;
+  }
+  return row[firstString.length];
+}
+export { compareByProperty, generateStringId, getParamsByName, nameOf };

package/dist/citrus-lime-utils.umd.js

@@ -0,0 +1 @@
+(function(o,u){typeof exports=="object"&&typeof module!="undefined"?u(exports):typeof define=="function"&&define.amd?define(["exports"],u):(o=typeof globalThis!="undefined"?globalThis:o||self,u(o.CitrusLimeUtils={}))})(this,function(o){"use strict";function u(){return Math.random().toString(36).slice(2,8)}function g(e){return e}function f(e,n,t){return e[t]<n[t]?-1:e[t]>n[t]?1:0}function y(e,n){let t="";const i=decodeURIComponent(e),r="[\\?&]"+n+"=([^&#]*)",s=new RegExp(r).exec(i);return s&&s[1]&&(t=decodeURIComponent(s[1].replace(/\+/g," "))),t}String.prototype.similarity=function(e){let n=0,t=this.toLowerCase(),i=e.toLowerCase();if(t<i){const l=i;i=t,t=l}const r=t.length;return r===0?n=100:n=Math.round((r-d(t,i))/r*100),n},String.prototype.trimChar=function(e){return this.trimStartChar(e).trimEndChar(e)},String.prototype.trimStartChar=function(e){return e!==""&&this.startsWith(e)?this.slice(1):this},String.prototype.trimEndChar=function(e){return e!==""&&this.endsWith(e)?this.slice(0,-1):this},String.prototype.trimToLength=function(e,n=!1){const t=this.length<e?this.length:e;return n&&t>=4&&t<this.length?`${this.slice(0,Math.max(t-3,1))}...`:this.slice(0,Math.max(t,1))},String.prototype.removeWhitespace=function(){return this.replace(/\s/g,"")},String.prototype.removeNonAlphanumeric=function(){return this.replace(/[^a-zA-Z0-9]/g,"")},String.prototype.removeNonAlphabetic=function(){return this.replace(/[^a-zA-Z]/g,"")},String.prototype.removeNonNumeric=function(){return this.replace(/[^0-9]/g,"")},String.prototype.replacePlaceholders=function(...e){let n=0;return this.replace(/{\d+}/g,()=>typeof e[n]!="undefined"?e[n++]:"")},String.prototype.toDateFromTime=function(){return new Date(`${new Date().toISOString().substr(0,11)}${this}`)};function d(e,n){if(e.length===0)return n.length;if(n.length===0)return e.length;if(e.length>n.length){const r=e;e=n,n=r}const t=new Int8Array(e.length+1);for(let r=0;r<=e.length;r++)t[r]=r;let i;for(let r=1;r<=n.length;r++){let l=r;const s=n[r-1];for(let h=1;h<=e.length;h++){if(s===e[h-1])i=t[h-1];else{const a=l+1,p=t[h]+1,c=a-(a-p&p-a>>7),m=t[h-1]+1;i=c-(c-m&m-c>>7)}t[h-1]=l,l=i}t[e.length]=l}return t[e.length]}o.compareByProperty=f,o.generateStringId=u,o.getParamsByName=y,o.nameOf=g,Object.defineProperty(o,"__esModule",{value:!0}),o[Symbol.toStringTag]="Module"});

package/dist/main.d.ts

@@ -0,0 +1 @@
+export * from './utils';

package/dist/utils/extensions/string/index.d.ts

@@ -0,0 +1,18 @@
+declare global {
+    interface String {
+        similarity(comparisonString: string): number;
+        trimChar(character: string): string;
+        trimStartChar(character: string): string;
+        trimEndChar(character: string): string;
+        trimToLength(length: number, addEllipsis?: boolean): string;
+        firstCharToUpperCase(locale?: string | string[]): string;
+        firstCharToLowerCase(locale?: string | string[]): string;
+        removeWhitespace(): string;
+        removeNonAlphanumeric(): string;
+        removeNonAlphabetic(): string;
+        removeNonNumeric(): string;
+        replacePlaceholders(...args: string[]): string;
+        toDateFromTime(): Date;
+    }
+}
+export {} from './prototypes';

package/dist/utils/id.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Generates a random string ID.
+ *
+ * @returns The created string ID.
+ */
+export declare function generateStringId(): string;

package/dist/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from './id';
+export * from './name-of';
+export * from './sort';
+export * from './url-params';
+export {} from './extensions/string';

package/dist/utils/name-of.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Wrapper to safely guarantee a string is the name of a property of an object.
+ *
+ * @param name The key of the provided type.
+ * @returns The provided key, if it belongs to the specified type.
+ */
+export declare function nameOf<T>(name: Extract<keyof T, string>): keyof T;

package/dist/utils/sort.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Compares the two provided objects by the value of their specified property.
+ *
+ * @param firstValue The first object to compare.
+ * @param secondValue The second object to compare.
+ * @param property The property, of the two objects, to compare.
+ * @returns 0, if equal; 1, if the first is greater; -1, if the second is greater.
+ */
+export declare function compareByProperty<T>(firstValue: T, secondValue: T, property: keyof T): -1 | 0 | 1;

package/dist/utils/url-params.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Searches the provided URL to for a specific parameter; returns it, if found.
+ *
+ * @param stringToSearch Encoded URL to search in.
+ * @param paramToFind Parameter to find.
+ * @returns The param, if found, or an empty string.
+ */
+export declare function getParamsByName(stringToSearch: string, paramToFind: string): string;

package/package.json

@@ -0,0 +1,33 @@
+{
+    "name": "@citruslime/utils",
+    "version": "0.0.1-beta.1",
+    "author": {
+        "name": "Citrus-Lime Ltd",
+        "url": "https://citruslime.com"
+    },
+    "license": "MIT",
+    "homepage": "https://uilibrary.citruslime.com/",
+    "publishConfig": {
+        "access": "public"
+    },
+    "files": [
+        "dist"
+    ],
+    "main": "dist/citrus-lime-utils.umd.js",
+    "module": "dist/citrus-lime-utils.es.js",
+    "types": "dist/main.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/citrus-lime-utils.es.js",
+            "require": "./dist/citrus-lime-utils.umd.js"
+        }
+    },
+    "scripts": {
+        "build": "vite build && copyfiles -u 2 \"dist/src/**/*\" dist && del-cli dist/src"
+    },
+    "devDependencies": {
+        "copyfiles": "^2.4.1",
+        "del-cli": "^4.0.1",
+        "vite-plugin-dts": "^0.9.4"
+    }
+}