@jrrembert/luhnjs 0.0.1-rc1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 J. Ryan Rembert
+
+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 @@
+# luhnjs

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { generate, validate } from './src/luhn';

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validate = exports.generate = void 0;
+var luhn_1 = require("./src/luhn");
+Object.defineProperty(exports, "generate", { enumerable: true, get: function () { return luhn_1.generate; } });
+Object.defineProperty(exports, "validate", { enumerable: true, get: function () { return luhn_1.validate; } });

package/dist/src/luhn.d.ts

@@ -0,0 +1,20 @@
+declare class GenerateOptions {
+    checkSumOnly: boolean;
+    constructor();
+}
+/**
+   * Return value with checksum calculated using Luhn algorithm
+   *
+   * @param value value to check
+   * @param options.checkSumOnly determine if value + checksum, or only checksum should be returned
+   * @returns
+   */
+export declare function generate(value: string, options?: GenerateOptions): string;
+/**
+   * Determine if the Luhn checksum for a given number is correct
+   *
+   * @param value number containing a Luhn checksum
+   * @returns
+   */
+export declare function validate(value: string): boolean;
+export {};

package/dist/src/luhn.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validate = exports.generate = void 0;
+class GenerateOptions {
+    constructor() {
+        this.checkSumOnly = false;
+    }
+}
+/**
+   * Verify string is correct length and can be converted to a number
+   *
+   * @param value potential value
+   */
+function handleErrors(value) {
+    if (!value.length) {
+        throw new Error('string cannot be empty');
+    }
+    if (isNaN(+value)) {
+        throw new Error('string must be convertible to a number');
+    }
+}
+/**
+   * Generate a checksum using Luhn algorithm
+   *
+   * @param value value to check
+   */
+function generateCheckSum(value) {
+    // convert to array
+    const toArray = Array.from(value);
+    // if double is `true`, multiply digit by 2
+    let double = true;
+    // starting from right, iterate through each value multiplying every 2nd digit by 2
+    const sum = toArray.reduceRight((prev, current) => {
+        if (double) {
+            double = false;
+            const temp = parseInt(current) * 2;
+            // if value is greater than or equal to 10, sum each digit of value ie. if value is 15, use 1 + 5 to get value
+            if (temp >= 10) {
+                return prev + Array.from(temp.toString()).reduce((prev, current) => {
+                    return prev + parseInt(current);
+                }, 0);
+            }
+            return prev + parseInt(current) * 2;
+        }
+        double = true;
+        return prev + parseInt(current);
+    }, 0);
+    return (10 - (sum % 10)) % 10;
+}
+/**
+   * Return value with checksum calculated using Luhn algorithm
+   *
+   * @param value value to check
+   * @param options.checkSumOnly determine if value + checksum, or only checksum should be returned
+   * @returns
+   */
+function generate(value, options) {
+    handleErrors(value);
+    const checkSum = generateCheckSum(value).toString();
+    return (options === null || options === void 0 ? void 0 : options.checkSumOnly) ? checkSum : value.concat(checkSum);
+}
+exports.generate = generate;
+/**
+   * Determine if the Luhn checksum for a given number is correct
+   *
+   * @param value number containing a Luhn checksum
+   * @returns
+   */
+function validate(value) {
+    handleErrors(value);
+    if (value.length === 1) {
+        throw new Error('string must be longer than 1 character');
+    }
+    const valueWithoutCheckSum = value.substring(0, value.length - 1);
+    return value === generate(valueWithoutCheckSum);
+}
+exports.validate = validate;

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@jrrembert/luhnjs",
+  "version": "0.0.1-rc1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "repository": "https://github.com/jrrembert/luhnjs.git",
+  "license": "MIT",
+  "private": false,
+  "scripts": {
+    "build": "tsc && node dist/index.js",
+    "lint": "eslint .",
+    "test": "jest"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.2.3",
+    "@typescript-eslint/eslint-plugin": "^5.44.0",
+    "@typescript-eslint/parser": "^5.44.0",
+    "eslint": "^8.28.0",
+    "jest": "^29.3.1",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.3"
+  }
+}