zerosurge 13.1.0 → 15.0.0

package/README.md

@@ -3,7 +3,7 @@
 
 <sup><sub><i>(i apologize for the terrible logo.)</i></sub></sup>
 
-> The fastest zero utility library on the internet.
+> The best zero utility library on the internet.
 
 Tired of painstakingly trying to find the character 0 on your keyboard and then pushing the button, or don't remember how to use the number zero in JavaScript? Well, this library is the new way to zero. ZeroSurge.js is the future!
 
@@ -34,6 +34,7 @@ $ pnpm add zerosurge
 This enum defines the calculation methods available for the `returnZero` function in the library:
 - **CreashaksOrganzine**: Method 1 for zero calculation. This uses the string "creashaks organzine" and uses the Minecraft seed input algorithm to make the number zero from it.
 - **NumberPrototypeValue**: Method 2 for zero calculation. This uses the `Number` class prototype to return zero.
+- **RandomNumberSelfSubtraction**: Method 3 for zero calculation. This subtracts a random number by itself.
 
 ### Functions
 
@@ -78,8 +79,4 @@ When `loggingEnabled` is set to `true`, the library will log relevant messages t
 ## Contributing
 Contributions welcome. You can contribute by opening a pull request or issue at our github repository.
 
-## License
-Zerosurge is licensed under the 10xGPWTHPL License. See the [LICENSE](LICENSE) file for more details.
-
-## made with HEAVY BLACK HEART U+2764 ❤❤❤❤
-## 10xGPWTHPL Licensed
+## made with HEAVY BLACK HEART U+2764 ❤❤❤❤

package/index.test.js

@@ -1,4 +1,4 @@
-const { ZeroCalculationMethod, isZero, returnZero } = require(".")
+const { ZeroCalculationMethod, isZero, returnZero } = require("./src/index")
 const kleur = require("kleur")
 const attempt = require("attempt-statement")
 const assert = require("assert-fn")
@@ -9,7 +9,6 @@ const { immediateError, ErrorType } = require('immediate-error')
 const loggingEnabled = false
 
 attempt(() => {
-	assert(returnZero() === 0, "returnZero should return zero")
 	assert(
 		returnZero({ method: ZeroCalculationMethod.CreashaksOrganzine, loggingEnabled }) === 0,
 		"returnZero should return zero with creashaks organzine method"
@@ -18,6 +17,10 @@ attempt(() => {
 		returnZero({ method: ZeroCalculationMethod.NumberPrototypeValue, loggingEnabled }) === 0,
 		"returnZero should return zero with number prototype value method"
 	)
+	assert(
+		returnZero({ method: ZeroCalculationMethod.RandomNumberSelfSubtraction, loggingEnabled }) === 0,
+		"returnZero should return zero with number prototype value method"
+	)
 	assert(isZero(0, loggingEnabled) === true, "isZero should return true if the input is zero")
 	assert(isZero((Math.random() + 0.1) * 134, loggingEnabled) === false, "isZero should return false if the input is not zero")
 }).rescue((e) => {

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "zerosurge",
-  "version": "13.1.0",
+  "version": "15.0.0",
   "description": "The future is here.",
-  "main": "index.js",
+  "main": "src/index.js",
   "scripts": {
-    "test": "node index.test"
+    "test": "node index.test",
+    "build": "tsc"
   },
   "repository": {
     "type": "git",
@@ -108,42 +109,28 @@
     "95-keywords-is-alot"
   ],
   "author": "tj-commits <thefoxjones@gmail.com>",
-  "license": "10xGPWTHPL",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/10xEngineersQualityProgramming/ZeroSurge.js/issues"
   },
   "homepage": "https://github.com/10xEngineersQualityProgramming/ZeroSurge.js#readme",
   "dependencies": {
-    "@extremejs/utils": "^1.0.0-beta.22",
-    "@not-js/not": "^1.0.0",
-    "are-strictly-equal": "^1.0.0",
+    "betterloggingwithecho": "^1.0.0",
+    "chalk": "^4.1.2",
+    "immediate-error": "^6.2.0",
+    "minecraft-seed-input": "^1.0.0",
+    "random-number": "^0.0.9",
+    "string-creashaks-organzine": "^1.0.0"
+  },
+  "devDependencies": {
+    "@types/get-intrinsic": "^1.2.3",
+    "@types/node": "^24.10.0",
+    "@types/random-number": "^0.0.4",
     "assert-fn": "^1.0.1",
     "attempt-statement": "^1.1.0",
-    "deep-equal": "^2.2.3",
-    "exit": "^0.1.2",
-    "falsejs": "^1234.56.789",
-    "get-ecmascript-type-of": "^1.0.0",
-    "get-intrinsic": "^1.2.4",
-    "if": "^2.0.0",
-    "immediate-error": "^6.1.0",
-    "integer-value-positive-one": "^1.0.2",
-    "integer-value-positive-two": "^1.0.0",
-    "is-eq-ten-thousand": "^4324803849.34298304823.328712760",
-    "is-equal": "^1.7.0",
-    "is-equal-to": "^1.1.2",
-    "is-hundred": "^0.10.0",
-    "is-hundred-thousand": "^10000000000000.10000000000000.10000000000000",
-    "is-nil": "^1.0.1",
-    "is-one": "^1.0.0",
-    "is-ten": "^0.1.0",
-    "is-thousand": "^0.0.2",
-    "is-uneven": "^1.0.0",
     "kleur": "^4.1.5",
-    "lodash.sample": "^4.2.1",
     "logtoconsole": "^1.0.7",
-    "minecraft-seed-input": "^1.0.0",
-    "none": "^1.0.0",
     "noop10": "^1.0.3",
-    "string-creashaks-organzine": "^1.0.0"
+    "typescript": "^5.9.3"
   }
 }

package/src/index.d.ts

@@ -0,0 +1,13 @@
+export declare enum ZeroCalculationMethod {
+    CreashaksOrganzine = 0,
+    NumberPrototypeValue = 1,
+    RandomNumberSelfSubtraction = 2
+}
+type ReturnZeroOptions = {
+    method: ZeroCalculationMethod;
+    loggingEnabled: boolean;
+};
+export declare function returnZero(options: ReturnZeroOptions): 0 | undefined;
+export declare function isZero(value: any): boolean;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAOA,oBAAY,qBAAqB;IAC/B,kBAAkB,IAAA;IAClB,oBAAoB,IAAA;IACpB,2BAA2B,IAAA;CAC5B;AAeD,KAAK,iBAAiB,GAAG;IACvB,MAAM,EAAE,qBAAqB,CAAA;IAC7B,cAAc,EAAE,OAAO,CAAA;CACxB,CAAA;AACD,wBAAgB,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,CAAC,GAAG,SAAS,CA+BpE;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAG1C"}

package/src/index.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZeroCalculationMethod = void 0;
+exports.returnZero = returnZero;
+exports.isZero = isZero;
+const betterloggingwithecho_1 = __importDefault(require("betterloggingwithecho"));
+const chalk_1 = __importDefault(require("chalk"));
+const minecraft_seed_input_1 = __importDefault(require("minecraft-seed-input"));
+const string_creashaks_organzine_1 = __importDefault(require("string-creashaks-organzine"));
+const immediate_error_1 = require("immediate-error");
+const random_number_1 = __importDefault(require("random-number"));
+var ZeroCalculationMethod;
+(function (ZeroCalculationMethod) {
+    ZeroCalculationMethod[ZeroCalculationMethod["CreashaksOrganzine"] = 0] = "CreashaksOrganzine";
+    ZeroCalculationMethod[ZeroCalculationMethod["NumberPrototypeValue"] = 1] = "NumberPrototypeValue";
+    ZeroCalculationMethod[ZeroCalculationMethod["RandomNumberSelfSubtraction"] = 2] = "RandomNumberSelfSubtraction";
+})(ZeroCalculationMethod || (exports.ZeroCalculationMethod = ZeroCalculationMethod = {}));
+class Logger {
+    constructor(loggingEnabled) {
+        this.loggingEnabled = loggingEnabled;
+    }
+    log(message) {
+        if (this.loggingEnabled) {
+            (0, betterloggingwithecho_1.default)(message);
+        }
+    }
+}
+function returnZero(options) {
+    const logger = new Logger(options.loggingEnabled);
+    const method = options.method;
+    logger.log(chalk_1.default.cyan("[zerosurge] Beginning to calculate zero"));
+    switch (method) {
+        case ZeroCalculationMethod.CreashaksOrganzine: {
+            logger.log(chalk_1.default.cyan("[zerosurge] Using CreashaksOrganzine method"));
+            const result = (0, minecraft_seed_input_1.default)(string_creashaks_organzine_1.default);
+            logger.log(chalk_1.default.green("[zerosurge] Zero calculated succesfully"));
+            return result;
+        }
+        case ZeroCalculationMethod.NumberPrototypeValue: {
+            logger.log(chalk_1.default.cyan("[zerosurge] Using NumberPrototypeValue method"));
+            const result = Number.prototype.valueOf();
+            logger.log(chalk_1.default.green("[zerosurge] Zero calculated succesfully"));
+            return result;
+        }
+        case ZeroCalculationMethod.RandomNumberSelfSubtraction: {
+            logger.log(chalk_1.default.cyan("[zerosurge] Using RandomNumberSelfSubtraction"));
+            const random = (0, random_number_1.default)();
+            logger.log(chalk_1.default.cyan("[zerosurge] Generated random number " + random));
+            const result = random - random;
+            logger.log(chalk_1.default.green("[zerosurge] Zero calculated succesfully"));
+            return result;
+        }
+        default: {
+            (0, immediate_error_1.immediateError)(chalk_1.default.red("[zerosurge] Unknown or undefined method for calculating zero, exiting"), immediate_error_1.ErrorType.TypeError);
+        }
+    }
+}
+function isZero(value) {
+    // @ts-expect-error: It's falsy because we don't want to use false keyword in case it changes.
+    return value === returnZero({ method: ZeroCalculationMethod.CreashaksOrganzine, loggingEnabled: !!(void (/false/)) });
+}
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;;AA8BA,gCA+BC;AAED,wBAGC;AAlED,kFAAwC;AACxC,kDAAyB;AACzB,gFAAuC;AACvC,4FAA2D;AAC3D,qDAA2D;AAC3D,kEAA8B;AAE9B,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC/B,6FAAkB,CAAA;IAClB,iGAAoB,CAAA;IACpB,+GAA2B,CAAA;AAC7B,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC;AAED,MAAM,MAAM;IAEV,YAAY,cAAuB;QACjC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;IACtC,CAAC;IAED,GAAG,CAAC,OAAe;QACjB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAA,+BAAI,EAAC,OAAO,CAAC,CAAA;QACf,CAAC;IACH,CAAC;CACF;AAMD,SAAgB,UAAU,CAAC,OAA0B;IACnD,MAAM,MAAM,GAAW,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;IACzD,MAAM,MAAM,GAA0B,OAAO,CAAC,MAAM,CAAA;IAEpD,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC,CAAA;IAEjE,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,qBAAqB,CAAC,kBAAkB,CAAC,CAAC,CAAC;YAC9C,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC,CAAA;YACrE,MAAM,MAAM,GAAW,IAAA,8BAAI,EAAC,oCAAkB,CAAC,CAAA;YAC/C,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC,CAAA;YAClE,OAAO,MAAW,CAAA;QACpB,CAAC;QACD,KAAK,qBAAqB,CAAC,oBAAoB,CAAC,CAAC,CAAC;YAChD,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC,CAAA;YACvE,MAAM,MAAM,GAAW,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAA;YACjD,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC,CAAA;YAClE,OAAO,MAAW,CAAA;QACpB,CAAC;QACD,KAAK,qBAAqB,CAAC,2BAA2B,CAAC,CAAC,CAAC;YACvD,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC,CAAA;YACvE,MAAM,MAAM,GAAW,IAAA,uBAAE,GAAE,CAAA;YAC3B,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,sCAAsC,GAAG,MAAM,CAAC,CAAC,CAAA;YACvE,MAAM,MAAM,GAAW,MAAM,GAAG,MAAM,CAAA;YACtC,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC,CAAA;YAClE,OAAO,MAAW,CAAA;QACpB,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,IAAA,gCAAc,EAAC,eAAK,CAAC,GAAG,CAAC,uEAAuE,CAAC,EAAE,2BAAS,CAAC,SAAS,CAAC,CAAA;QACzH,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAgB,MAAM,CAAC,KAAU;IAC/B,8FAA8F;IAC9F,OAAO,KAAK,KAAK,UAAU,CAAC,EAAE,MAAM,EAAE,qBAAqB,CAAC,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,KAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAA;AACtH,CAAC"}

package/src/index.ts

@@ -0,0 +1,67 @@
+import echo from "betterloggingwithecho"
+import chalk from "chalk"
+import seed from "minecraft-seed-input"
+import creashaksOrganzine from "string-creashaks-organzine"
+import { immediateError, ErrorType } from "immediate-error"
+import rn from "random-number"
+
+export enum ZeroCalculationMethod {
+  CreashaksOrganzine,
+  NumberPrototypeValue,
+  RandomNumberSelfSubtraction
+}
+
+class Logger {
+  public loggingEnabled: boolean
+  constructor(loggingEnabled: boolean) {
+    this.loggingEnabled = loggingEnabled
+  }
+
+  log(message: string) {
+    if (this.loggingEnabled) {
+      echo(message)
+    }
+  }
+}
+
+type ReturnZeroOptions = {
+  method: ZeroCalculationMethod
+  loggingEnabled: boolean
+}
+export function returnZero(options: ReturnZeroOptions): 0 | undefined {
+  const logger: Logger = new Logger(options.loggingEnabled)
+  const method: ZeroCalculationMethod = options.method
+
+  logger.log(chalk.cyan("[zerosurge] Beginning to calculate zero"))
+
+  switch (method) {
+    case ZeroCalculationMethod.CreashaksOrganzine: {
+      logger.log(chalk.cyan("[zerosurge] Using CreashaksOrganzine method"))
+      const result: number = seed(creashaksOrganzine)
+      logger.log(chalk.green("[zerosurge] Zero calculated succesfully"))
+      return result as 0
+    }
+    case ZeroCalculationMethod.NumberPrototypeValue: {
+      logger.log(chalk.cyan("[zerosurge] Using NumberPrototypeValue method"))
+      const result: number = Number.prototype.valueOf()
+      logger.log(chalk.green("[zerosurge] Zero calculated succesfully"))
+      return result as 0
+    }
+    case ZeroCalculationMethod.RandomNumberSelfSubtraction: {
+      logger.log(chalk.cyan("[zerosurge] Using RandomNumberSelfSubtraction"))
+      const random: number = rn()
+      logger.log(chalk.cyan("[zerosurge] Generated random number " + random))
+      const result: number = random - random
+      logger.log(chalk.green("[zerosurge] Zero calculated succesfully"))
+      return result as 0
+    }
+    default: {
+      immediateError(chalk.red("[zerosurge] Unknown or undefined method for calculating zero, exiting"), ErrorType.TypeError)
+    }
+  }
+}
+
+export function isZero(value: any): boolean {
+  // @ts-expect-error: It's falsy because we don't want to use false keyword in case it changes.
+  return value === returnZero({ method: ZeroCalculationMethod.CreashaksOrganzine, loggingEnabled: !!(void(/false/)) })
+}

package/src/types/betterloggingwithecho.d.ts

@@ -0,0 +1,23 @@
+// This declares the module 'betterloggingwithecho'
+declare module 'betterloggingwithecho' {
+
+    interface EchoProperty {
+        /**
+         * Sets a custom function to handle the logging output.
+         * @param logFunction A function that takes any number of arguments and returns nothing.
+         */
+        setLogFunction(logFunction: (...args: any[]) => void): void;
+    }
+
+    interface EchoFunction extends EchoProperty {
+        /**
+         * Logs a string message to the console (or the custom log function, if set).
+         * @param message The string message to be logged.
+         */
+        (message: string): void;
+    }
+
+    // Export the combined type as the default export of the module
+    const echo: EchoFunction;
+    export default echo;
+}

package/src/types/minecraft-seed-input.d.ts

@@ -0,0 +1,11 @@
+declare module 'minecraft-seed-input' {
+
+    /**
+     * Generates a numerical Minecraft seed from a given input value.
+     * * @param input The value to be converted into a seed (can be a string, number, etc.).
+     * @returns The generated numerical seed (e.g., a 64-bit integer represented as a JavaScript number).
+     */
+    function seed(input: any): number;
+
+    export = seed;
+}

package/src/types/string-creashaks-organzine.d.ts

@@ -0,0 +1,9 @@
+declare module 'string-creashaks-organzine' {
+
+    /**
+     * The module directly exports the string "creashaks organzine".
+     */
+    const exportedString: "creashaks organzine";
+
+    export = exportedString;
+}

package/tsconfig.json

@@ -0,0 +1,45 @@
+{
+  // Visit https://aka.ms/tsconfig to read more about this file
+  "compilerOptions": {
+    // File Layout
+    // "rootDir": "./src",
+    // "outDir": "./dist",
+
+    // Environment Settings
+    // See also https://aka.ms/tsconfig/module
+    "module": "commonjs",
+    "target": "es2018",
+    "lib": ["esnext"],
+    "types": ["node"],
+    // For nodejs:
+    // "lib": ["esnext"],
+    // "types": ["node"],
+    // and npm install -D @types/node
+    "esModuleInterop": true,
+
+    // Other Outputs
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking Options
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+
+    // Style Options
+    // "noImplicitReturns": true,
+    // "noImplicitOverride": true,
+    // "noUnusedLocals": true,
+    // "noUnusedParameters": true,
+    // "noFallthroughCasesInSwitch": true,
+    // "noPropertyAccessFromIndexSignature": true,
+
+    // Recommended Options
+    "strict": true,
+    "jsx": "react-jsx","verbatimModuleSyntax": false, // <--- CHANGE THIS
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true,
+  }
+}

package/LICENSE

@@ -1,75 +0,0 @@
-
-        10X GIANT PENIS DO WHAT THE HECK YOU WANT TO PUBLIC LICENSE
-                   Version 20, October 2024
-
-10X Giant Penis Do What The Heck You Want To Public License (10xGPWTHPL)
-
-Copyright (C) 2024 tj-commits
-
-https://10xgpwthfpl.is-best.net
-
-                ▄▄██▄██▄▄
-              ▄█    █    █▄
-             ▄█           █▄
-             █             █
-            █               █
-            █               █
-            █               █
-            █               █
-             █▄     █     ▄█
-              █    ▄▄▄    █
-              █           █
-              █           █
-              █           █
-              █           █
-              █           █
-              █           █
-              █           █
-              █           █
-              █           █
-              █           █
-              █           █
-              █           █
-        ▄████▄█           █▄████▄
-      ▄█                         █▄
-     █                             █
-    █                               █
-    █                               █
-    █                               █
-    █             ▄▄█▄▄             █
-     █           █     █           █
-      █▄       ▄█       █▄       ▄█
-        █▄▄▄▄▄█           █▄▄▄▄▄█
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to do anything they want:
-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. THIS PROJECT IS PROBABLY 10X AND PROBABLY USES MANY GOOD PRACTICES WRITTEN BY
-10X ENGINEERS AS THEY USE THIS LICENSE. ALSO THIS PROJECT IS MADE WITH HEAVY BLACK HEART U+2764 ❤❤❤❤
-
-This is a permissive license.
-
-Everyone is permitted to copy and distribute verbatim or modified
-copies of this license document, and changing it is allowed as long
-as the name is changed. Yes. It is it. You can do it. DISTRIBUTE IT
-(the Software)  HOWEVER YOU WANT AS LONG AS THE NAME IS CHANGED FROM
-THE NAME OF THE ORIGINAL PROJECT (the Software) THAT THIS LICENSE
-(the License) IS LICENSING. DASS ALL. THAT'S THE RULE (the Terms).
-DO WHAT YOU WANT. UH HUH. DASS RIGHT. YOU HEARD ME.
-
-           10X GIANT PENIS DO WHAT THE HECK YOU WANT TO PUBLIC LICENSE
-
-Ok, the purpose of this license is simple
-and you just
-
-DO WANT THE HECK YOU WANT TO.
-
-10. You just, DO WHAT THE HECK YOU WANT TO 10XLY.
-    The 10xGPWTHPL.