@vpmedia/simplify 1.0.0

package/CHANGES.md

@@ -0,0 +1,8 @@
+# Release notes
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## 1.0.0
+
+- Initial release

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Richard Davey, Photon Storm Ltd.
+Copyright (c) 2022-present Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
+
+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.

package/README.md

@@ -0,0 +1,10 @@
+# @vpmedia/simplify
+
+[![npm version](https://badge.fury.io/js/@vpmedia%2Fsimplify.svg?v=1.0.0)](https://badge.fury.io/js/@vpmedia%2Fsimplify)
+[![Node.js CI](https://github.com/vpmedia/simplify/actions/workflows/node.js.yml/badge.svg)](https://github.com/vpmedia/simplify/actions/workflows/node.js.yml)
+
+@vpmedia/simplify TBD
+
+## Getting started
+
+    $ npm install --save @vpmedia/simplify

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@vpmedia/simplify",
+  "version": "1.0.0",
+  "description": "@vpmedia/simplify",
+  "author": "Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)",
+  "license": "MIT",
+  "homepage": "https://github.com/vpmedia/simplify#readme",
+  "bugs": {
+    "url": "https://github.com/vpmedia/simplify/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vpmedia/simplify.git"
+  },
+  "keywords": [
+    "utils"
+  ],
+  "main": "./src/index.js",
+  "types": "./types/index.d.ts",
+  "type": "module",
+  "devDependencies": {
+    "@babel/preset-env": "^7.23.2",
+    "@jest/globals": "^29.7.0",
+    "@types/jest": "^29.5.6",
+    "eslint": "^8.51.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-jest": "^27.4.2",
+    "eslint-plugin-jsdoc": "^46.8.2",
+    "eslint-plugin-prettier": "^5.0.1",
+    "husky": "^8.0.3",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "lint-staged": "^15.0.1",
+    "prettier": "^3.0.3",
+    "typescript": "^5.2.2"
+  },
+  "scripts": {
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests",
+    "lint": "eslint --fix \"**/*.{js,jsx}\"",
+    "typecheck": "tsc",
+    "format": "prettier --write \"**/*.{css,js,jsx,json,md}\"",
+    "prepare": "husky install",
+    "lint-staged": "lint-staged"
+  },
+  "browserslist": [
+    "> 1%",
+    "not dead",
+    "not op_mini all"
+  ],
+  "engines": {
+    "npm": ">=8.0.0",
+    "node": ">=18.0.0"
+  }
+}

package/src/index.js

@@ -0,0 +1,8 @@
+// core
+import { capitalize } from './util/capitalize.js';
+import { getRandomInt } from './util/getRandomInt.js';
+import { getURLParam } from './util/getURLParam.js';
+import { sanitizeURLParam } from './util/sanitizeURLParam.js';
+import { underscoreToCamelcase } from './util/underscoreToCamelCase.js';
+// exports
+export { capitalize, getRandomInt, getURLParam, sanitizeURLParam, underscoreToCamelcase };

package/src/util/capitalize.js

@@ -0,0 +1,12 @@
+/**
+ * Capitalize a string.
+ * @param {string} value - Ther input string.
+ * @returns {string} TBD.
+ */
+export function capitalize(value) {
+  if (!value || value.length === 0) {
+    return value;
+  }
+  const normValue = value.toLowerCase();
+  return normValue.charAt(0).toUpperCase() + normValue.slice(1);
+}

package/src/util/capitalize.test.js

@@ -0,0 +1,6 @@
+import { capitalize } from './capitalize.js';
+
+test('Tests capitalize first letter', () => {
+  expect(capitalize('test')).toBe('Test');
+  expect(capitalize(null)).toBe(null);
+});

package/src/util/getRandomInt.js

@@ -0,0 +1,9 @@
+/**
+ * Returns random integer in range.
+ * @param {number} min - Min value.
+ * @param {number} max - Max value.
+ * @returns {number} Random integer in given range.
+ */
+export function getRandomInt(min, max) {
+  return Math.floor(Math.random() * (max - min + 1)) + min;
+}

package/src/util/getRandomInt.test.js

@@ -0,0 +1,5 @@
+import { getRandomInt } from './getRandomInt.js';
+
+test('TBD', () => {
+  expect(getRandomInt(1, 1)).toBe(1);
+});

package/src/util/getURLParam.js

@@ -0,0 +1,21 @@
+import { sanitizeURLParam } from './sanitizeURLParam.js';
+
+const urlSearchParams = new URLSearchParams(window.location.search);
+
+/**
+ * TBD.
+ * @param {string} key - TBD.
+ * @param {*} defaultValue - TBD.
+ * @param {boolean} isSanitize - TBD.
+ * @returns {string} TBD.
+ */
+export function getURLParam(key, defaultValue = null, isSanitize = true) {
+  const paramValue = urlSearchParams.get(key);
+  if (paramValue === null || paramValue === undefined) {
+    return defaultValue;
+  }
+  if (isSanitize) {
+    return sanitizeURLParam(paramValue);
+  }
+  return paramValue;
+}

package/src/util/sanitizeURLParam.js

@@ -0,0 +1,11 @@
+/**
+ * Sanitizes URL parameters allowing only alpha-numeric characters and dash.
+ * @param {string} input - The input string to be sanitized.
+ * @returns {string} The sanitized output string.
+ */
+export function sanitizeURLParam(input) {
+  if (!input) {
+    return input;
+  }
+  return input.replace(/[^a-zA-Z0-9-_]/gi, '');
+}

package/src/util/sanitizeURLParam.test.js

@@ -0,0 +1,6 @@
+import { sanitizeURLParam } from './sanitizeURLParam.js';
+
+test('Tests URL parameter sanitizer', () => {
+  expect(sanitizeURLParam('abc<>-123[]{}-()A_BC')).toBe('abc-123-A_BC');
+  expect(sanitizeURLParam(null)).toBe(null);
+});

package/src/util/underscoreToCamelCase.js

@@ -0,0 +1,10 @@
+/**
+ * Converts underscore case string to camel case.
+ * @param {string} value - The input string in underscore case.
+ * @returns {string} The output string in camel case.
+ */
+export function underscoreToCamelcase(value) {
+  return value.replace(/(_\w)/g, function (m) {
+    return m[1].toUpperCase();
+  });
+}

package/src/util/underscoreToCamelCase.test.js

@@ -0,0 +1,7 @@
+import { underscoreToCamelcase } from './underscoreToCamelCase.js';
+
+test('TBD', () => {
+  expect(underscoreToCamelcase('test')).toBe('test');
+  expect(underscoreToCamelcase('test_variable')).toBe('testVariable');
+  expect(underscoreToCamelcase('test_variable_name')).toBe('testVariableName');
+});

package/typedefs/global.d.ts

@@ -0,0 +1,5 @@
+declare global {
+  interface Window {}
+}
+
+export {};

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export { capitalize };
+import { capitalize } from './util/capitalize.js';
+//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":";2BAC2B,sBAAsB"}

package/types/util/capitalize.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Capitalize a string.
+ * @param {string} value - Ther input string.
+ * @returns {string} TBD.
+ */
+export function capitalize(value: string): string;
+//# sourceMappingURL=capitalize.d.ts.map

package/types/util/capitalize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capitalize.d.ts","sourceRoot":"","sources":["../../src/util/capitalize.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,kCAHW,MAAM,GACJ,MAAM,CAQlB"}

package/types/util/getRandomInt.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns random integer in range.
+ * @param {number} min - Min value.
+ * @param {number} max - Max value.
+ * @returns {number} Random integer in given range.
+ */
+export function getRandomInt(min: number, max: number): number;
+//# sourceMappingURL=getRandomInt.d.ts.map

package/types/util/getRandomInt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getRandomInt.d.ts","sourceRoot":"","sources":["../../src/util/getRandomInt.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,kCAJW,MAAM,OACN,MAAM,GACJ,MAAM,CAIlB"}

package/types/util/getURLParam.d.ts

@@ -0,0 +1,9 @@
+/**
+ * TBD.
+ * @param {string} key - TBD.
+ * @param {*} defaultValue - TBD.
+ * @param {boolean} isSanitize - TBD.
+ * @returns {string} TBD.
+ */
+export function getURLParam(key: string, defaultValue?: any, isSanitize?: boolean): string;
+//# sourceMappingURL=getURLParam.d.ts.map

package/types/util/getURLParam.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getURLParam.d.ts","sourceRoot":"","sources":["../../src/util/getURLParam.js"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,iCALW,MAAM,mCAEN,OAAO,GACL,MAAM,CAWlB"}

package/types/util/sanitizeURLParam.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Sanitizes URL parameters allowing only alpha-numeric characters and dash.
+ * @param {string} input - The input string to be sanitized.
+ * @returns {string} The sanitized output string.
+ */
+export function sanitizeURLParam(input: string): string;
+//# sourceMappingURL=sanitizeURLParam.d.ts.map

package/types/util/sanitizeURLParam.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sanitizeURLParam.d.ts","sourceRoot":"","sources":["../../src/util/sanitizeURLParam.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wCAHW,MAAM,GACJ,MAAM,CAOlB"}

package/types/util/underscoreToCamelCase.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Converts underscore case string to camel case.
+ * @param {string} value - The input string in underscore case.
+ * @returns {string} The output string in camel case.
+ */
+export function underscoreToCamelcase(value: string): string;
+//# sourceMappingURL=underscoreToCamelCase.d.ts.map

package/types/util/underscoreToCamelCase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"underscoreToCamelCase.d.ts","sourceRoot":"","sources":["../../src/util/underscoreToCamelCase.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,6CAHW,MAAM,GACJ,MAAM,CAMlB"}