@credentum/is-cusip 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Credentum
+
+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,54 @@
+# @credentum/is-cusip
+
+Zero-dependency CUSIP validator for JavaScript and TypeScript.
+
+Validates 9-character [CUSIP](https://en.wikipedia.org/wiki/CUSIP) identifiers used to identify North American financial securities. Uses the Modulus 10 Double Add Double check digit algorithm.
+
+## Install
+
+```bash
+npm install @credentum/is-cusip
+```
+
+## Usage
+
+```js
+const isCUSIP = require('@credentum/is-cusip');
+
+isCUSIP('037833100'); // true  — Apple Inc.
+isCUSIP('17275R102'); // true  — Cisco Systems
+isCUSIP('68389X106'); // false — bad check digit
+```
+
+### ESM
+
+```js
+import isCUSIP from '@credentum/is-cusip';
+// or
+import { isCUSIP, sanitizeCUSIP } from '@credentum/is-cusip';
+```
+
+### Sanitize before validating
+
+```js
+const { isCUSIP, sanitizeCUSIP } = require('@credentum/is-cusip');
+
+const raw = ' 037-833-100 ';
+isCUSIP(sanitizeCUSIP(raw)); // true
+```
+
+`sanitizeCUSIP` trims whitespace, removes dashes and spaces, and uppercases the input. It does not validate.
+
+## API
+
+### `isCUSIP(input: string): boolean`
+
+Returns `true` if the input is a valid 9-character CUSIP with a correct check digit.
+
+### `sanitizeCUSIP(input: string): string`
+
+Cleans raw input for validation. Trims, removes `-` and spaces, uppercases.
+
+## License
+
+MIT

package/index.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Validate a CUSIP identifier.
+ *
+ * CUSIP is a 9-character alphanumeric code identifying North American
+ * financial securities. The 9th character is a check digit computed
+ * using the Modulus 10 Double Add Double algorithm.
+ *
+ * @param input - The CUSIP string to validate.
+ * @returns True if the input is a valid CUSIP.
+ *
+ * @example
+ * ```ts
+ * import isCUSIP from '@credentum/is-cusip';
+ *
+ * isCUSIP('037833100'); // true  (Apple Inc.)
+ * isCUSIP('17275R102'); // true  (Cisco Systems)
+ * isCUSIP('INVALID01'); // false
+ * ```
+ */
+declare function isCUSIP(input: string): boolean;
+
+/**
+ * Sanitize a string for CUSIP validation.
+ *
+ * Trims whitespace, removes dashes and spaces, and uppercases.
+ * Does NOT validate — call isCUSIP() on the result.
+ *
+ * @param input - Raw input that might contain a CUSIP.
+ * @returns Cleaned string ready for isCUSIP() validation.
+ *
+ * @example
+ * ```ts
+ * import { sanitizeCUSIP, isCUSIP } from '@credentum/is-cusip';
+ *
+ * const raw = ' 037-833-100 ';
+ * isCUSIP(sanitizeCUSIP(raw)); // true
+ * ```
+ */
+declare function sanitizeCUSIP(input: string): string;
+
+export { isCUSIP, sanitizeCUSIP };
+export default isCUSIP;

package/index.js

@@ -0,0 +1,69 @@
+'use strict';
+
+/**
+ * CUSIP character value lookup.
+ * Digits 0-9 map to 0-9, letters A-Z map to 10-35,
+ * special characters: * = 36, @ = 37, # = 38.
+ */
+function charValue(c) {
+  var code = c.charCodeAt(0);
+  if (code >= 48 && code <= 57) return code - 48;       // '0'-'9'
+  if (code >= 65 && code <= 90) return code - 55;        // 'A'-'Z' -> 10-35
+  if (c === '*') return 36;
+  if (c === '@') return 37;
+  if (c === '#') return 38;
+  return -1;
+}
+
+/**
+ * Validate a CUSIP identifier.
+ *
+ * CUSIP is a 9-character alphanumeric code identifying North American
+ * financial securities. The 9th character is a check digit computed
+ * using the Modulus 10 Double Add Double algorithm.
+ *
+ * @param {string} input - The CUSIP string to validate.
+ * @returns {boolean} True if the input is a valid CUSIP.
+ */
+function isCUSIP(input) {
+  if (typeof input !== 'string') return false;
+  if (input.length !== 9) return false;
+
+  var sum = 0;
+  for (var i = 0; i < 8; i++) {
+    var v = charValue(input.charAt(i));
+    if (v < 0) return false;
+
+    // Double the value at even-indexed positions (0-based: positions 1,3,5,7)
+    if (i % 2 === 1) v = v * 2;
+
+    // Sum the digits: integer division by 10 + remainder
+    sum = sum + Math.floor(v / 10) + (v % 10);
+  }
+
+  var checkDigit = (10 - (sum % 10)) % 10;
+  var lastChar = charValue(input.charAt(8));
+  if (lastChar < 0) return false;
+
+  return lastChar === checkDigit;
+}
+
+/**
+ * Sanitize a string for CUSIP validation.
+ *
+ * Trims whitespace, removes common separators (dashes, spaces),
+ * and uppercases the input. Does NOT validate — call isCUSIP()
+ * on the result for validation.
+ *
+ * @param {string} input - Raw input that might contain a CUSIP.
+ * @returns {string} Cleaned string ready for isCUSIP() validation.
+ */
+function sanitizeCUSIP(input) {
+  if (typeof input !== 'string') return '';
+  return input.trim().replace(/[\s\-]/g, '').toUpperCase();
+}
+
+module.exports = isCUSIP;
+module.exports.isCUSIP = isCUSIP;
+module.exports.sanitizeCUSIP = sanitizeCUSIP;
+module.exports.default = isCUSIP;

package/index.mjs

@@ -0,0 +1,52 @@
+/**
+ * CUSIP character value lookup.
+ * Digits 0-9 map to 0-9, letters A-Z map to 10-35,
+ * special characters: * = 36, @ = 37, # = 38.
+ */
+function charValue(c) {
+  const code = c.charCodeAt(0);
+  if (code >= 48 && code <= 57) return code - 48;
+  if (code >= 65 && code <= 90) return code - 55;
+  if (c === '*') return 36;
+  if (c === '@') return 37;
+  if (c === '#') return 38;
+  return -1;
+}
+
+/**
+ * Validate a CUSIP identifier.
+ *
+ * @param {string} input - The CUSIP string to validate.
+ * @returns {boolean} True if the input is a valid CUSIP.
+ */
+export function isCUSIP(input) {
+  if (typeof input !== 'string') return false;
+  if (input.length !== 9) return false;
+
+  let sum = 0;
+  for (let i = 0; i < 8; i++) {
+    let v = charValue(input.charAt(i));
+    if (v < 0) return false;
+    if (i % 2 === 1) v = v * 2;
+    sum = sum + Math.floor(v / 10) + (v % 10);
+  }
+
+  const checkDigit = (10 - (sum % 10)) % 10;
+  const lastChar = charValue(input.charAt(8));
+  if (lastChar < 0) return false;
+
+  return lastChar === checkDigit;
+}
+
+/**
+ * Sanitize a string for CUSIP validation.
+ *
+ * @param {string} input - Raw input that might contain a CUSIP.
+ * @returns {string} Cleaned string ready for isCUSIP() validation.
+ */
+export function sanitizeCUSIP(input) {
+  if (typeof input !== 'string') return '';
+  return input.trim().replace(/[\s\-]/g, '').toUpperCase();
+}
+
+export default isCUSIP;

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@credentum/is-cusip",
+  "version": "1.0.0",
+  "description": "Zero-dependency CUSIP validator. Validates 9-character CUSIP identifiers using the Modulus 10 Double Add Double check digit algorithm.",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "require": "./index.js",
+      "import": "./index.mjs"
+    }
+  },
+  "files": [
+    "index.js",
+    "index.mjs",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "test": "node test.js"
+  },
+  "keywords": [
+    "cusip",
+    "is-cusip",
+    "validate-cusip",
+    "cusip-validator",
+    "financial",
+    "securities",
+    "check-digit",
+    "modulus-10",
+    "isin",
+    "sedol",
+    "figi"
+  ],
+  "author": "Credentum <hello@credentum.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/credentum/is-cusip"
+  },
+  "engines": {
+    "node": ">=12"
+  }
+}