@ptolemy2002/js-math-utils 1.0.0

package/README.md

@@ -0,0 +1,56 @@
+# JS Math Utils
+This library contains mathematical utilities for JavaScript development.
+
+The functions are not exported as default, so you can import them in one of the following ways:
+```
+// ES6
+import { functionName } from '@ptolemy2002/js-math-utils';
+// CommonJS
+const { functionName } = require('@ptolemy2002/js-math-utils');
+```
+
+## Functions
+The following functions are available in the library:
+
+### clamp
+#### Description
+Clamps a number between a minimum and maximum value.
+
+#### Parameters
+- `value` (Number): The value to be clamped.
+- `min` (Number): The minimum value.
+- `max` (Number): The maximum value.
+
+#### Returns
+Number - The clamped value.
+
+### wrapNumber
+#### Description
+Wraps a number between a minimum and maximum value, non-inclusive on the maximum side (so `min - 1` gets converted to `max - 1` and `max` gets converted to `min`).
+
+#### Parameters
+- `n` (Number): The number to be wrapped.
+- `min` (Number): The minimum value.
+- `max` (Number): The maximum value.
+
+#### Returns
+Number - The wrapped value.
+
+## Meta
+This is a React Library Created by Ptolemy2002's [cra-template-react-library](https://www.npmjs.com/package/@ptolemy2002/cra-template-react-library) template in combination with [create-react-app](https://www.npmjs.com/package/create-react-app). It contains methods of building and publishing your library to npm.
+For now, the library makes use of React 18 and does not use TypeScript.
+
+## Commands
+The following commands exist in the project:
+
+- `npm run uninstall` - Uninstalls all dependencies for the library
+- `npm run reinstall` - Uninstalls and then Reinstalls all dependencies for the library
+- `npm run example-uninstall` - Uninstalls all dependencies for the example app
+- `npm run example-install` - Installs all dependencies for the example app
+- `npm run example-reinstall` - Uninstalls and then Reinstalls all dependencies for the example app
+- `npm run example-start` - Starts the example app after building the library
+- `npm run build` - Builds the library
+- `npm run release` - Publishes the library to npm without changing the version
+- `npm run release-patch` - Publishes the library to npm with a patch version bump
+- `npm run release-minor` - Publishes the library to npm with a minor version bump
+- `npm run release-major` - Publishes the library to npm with a major version bump

package/index.js

@@ -0,0 +1,35 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.js
+var src_exports = {};
+__export(src_exports, {
+  clamp: () => clamp,
+  wrapNumber: () => wrapNumber
+});
+module.exports = __toCommonJS(src_exports);
+var import_js_utils = require("@ptolemy2002/js-utils");
+function clamp(value, min, max) {
+  if (!(0, import_js_utils.isNullOrUndefined)(min) && value < min) return min;
+  if (!(0, import_js_utils.isNullOrUndefined)(max) && value > max) return max;
+  return value;
+}
+function wrapNumber(n, min, max) {
+  const range = max - min;
+  return n >= min ? min + (n - min) % range : max + (n - min) % range;
+}

package/package.json

@@ -0,0 +1,35 @@
+{
+    "name": "@ptolemy2002/js-math-utils",
+    "version": "1.0.0",
+    "main": "index.js",
+    "files": [
+        "index.js"
+    ],
+    "scripts": {
+        "build": "esbuild src/index.js --bundle --format=cjs --outfile=index.js --external:@ptolemy2002/js-utils",
+        "postinstall": "npx typesync",
+        "uninstall": "bash ./scripts/uninstall.sh",
+        "reinstall": "bash ./scripts/reinstall.sh",
+        "example-uninstall": "bash ./scripts/example-uninstall.sh",
+        "example-install": "bash ./scripts/example-install.sh",
+        "example-reinstall": "bash ./scripts/example-reinstall.sh",
+        "example-start": "bash ./scripts/example-start.sh",
+        "release": "bash ./scripts/release.sh",
+        "release-patch": "bash ./scripts/release.sh patch",
+        "release-minor": "bash ./scripts/release.sh minor",
+        "release-major": "bash ./scripts/release.sh major"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Ptolemy2002/js-math-utils",
+        "directory": "lib"
+    },
+    "description": "Example of a React library",
+    "license": "ISC",
+    "peerDependencies": {
+        "@ptolemy2002/js-utils": "^1.0.1"
+    },
+    "devDependencies": {
+        "esbuild": "^0.23.0"
+    }
+}