@checkdigit/hash 1.0.0 → 2.0.0-PR.14-7f35

package/LICENSE.txt

@@ -1,7 +1,7 @@
 
 The MIT License
 
-Copyright (c) 2021 Check Digit, LLC
+Copyright (c) 2021-2023 Check Digit, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -9,7 +9,6 @@ Hash is a small function for Check Digit services to create a UUID derived from
 ```
 $ npm install @checkdigit/hash
 ```
- 
 
 ### Use
 

package/package.json

@@ -1,57 +1 @@
-{
-  "name": "@checkdigit/hash",
-  "version": "1.0.0",
-  "description": "Hash is a small function for Check Digit services to create a uuid derived from a hash generated from a given value.",
-  "typings": "./dist/index.d.ts",
-  "main": "./dist/index.js",
-  "prettier": "@checkdigit/prettier-config",
-  "engines": {
-    "node": ">=12.18",
-    "npm": ">=6.14"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/checkdigit/hash.git"
-  },
-  "author": "Check Digit, LLC",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/checkdigit/hash/issues"
-  },
-  "homepage": "https://github.com/checkdigit/hash#readme",
-  "devDependencies": {
-    "@checkdigit/eslint-config": "3.4.2",
-    "@checkdigit/prettier-config": "^1.0.2",
-    "@checkdigit/publish": "^1.0.18",
-    "@checkdigit/typescript-config": "^1.0.5",
-    "@types/jest": "^26.0.21",
-    "@types/uuid": "^8.3.0",
-    "eslint": "^7.22.0",
-    "jest": "^26.6.3",
-    "prettier": "^2.2.1",
-    "rimraf": "^3.0.2",
-    "ts-jest": "^26.5.4",
-    "typescript": "^4.2.3",
-    "uuid": "^8.3.2"
-  },
-  "jest": {
-    "collectCoverage": true,
-    "preset": "ts-jest",
-    "testPathIgnorePatterns": [
-      "<rootDir>/build/",
-      "<rootDir>/node_modules/"
-    ]
-  },
-  "scripts": {
-    "prepublishOnly": "publish",
-    "postpublish": "rimraf dist .npmignore",
-    "preversion": "npm test",
-    "postversion": "git push && git push --tags",
-    "lint": "eslint -f unix 'src/**/*.ts'",
-    "lint:fix": "eslint -f unix 'src/**/*.ts' --fix",
-    "prettier": "prettier --list-different 'src/**/*.ts'",
-    "prettier:fix": "prettier --write 'src/**/*.ts'",
-    "test": "tsc --noEmit && jest && npm run prettier && npm run lint"
-  },
-  "dependencies": {}
-}
+{"name":"@checkdigit/hash","version":"2.0.0-PR.14-7f35","description":"Hash is a small function for Check Digit services to create a uuid derived from a hash generated from a given value.","typings":"./dist/index.d.ts","main":"./dist/index.js","files":["index.js","/src/"],"prettier":"@checkdigit/prettier-config","engines":{"node":">=16"},"repository":{"type":"git","url":"git+https://github.com/checkdigit/hash.git"},"author":"Check Digit, LLC","license":"MIT","bugs":{"url":"https://github.com/checkdigit/hash/issues"},"homepage":"https://github.com/checkdigit/hash#readme","devDependencies":{"@checkdigit/eslint-config":"^7.8.0","@checkdigit/jest-config":"^2.2.1","@checkdigit/prettier-config":"^3.4.0","@checkdigit/typescript-config":"^3.4.0","@types/uuid":"^9.0.1","rimraf":"^5.0.1","uuid":"^9.0.0"},"eslintConfig":{"extends":["@checkdigit/eslint-config"]},"jest":{"preset":"@checkdigit/jest-config"},"scripts":{"prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","lint:fix":"eslint -f unix --ext .ts,.mts src --fix","lint":"eslint -f unix --ext .ts,.mts src","test":"npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style","ci:compile":"tsc --noEmit","ci:test":"jest --coverage=false","ci:coverage":"jest --coverage=true","ci:lint":"npm run lint","ci:style":"npm run prettier"}}

package/src/hash.ts

@@ -0,0 +1,22 @@
+// hash.ts
+
+/*
+ * Copyright (c) 2021-2023 Check Digit, LLC
+ *
+ * This code is licensed under the MIT license (see LICENSE.txt for details).
+ */
+
+import { createHash } from 'node:crypto';
+
+import uuidV5 from './uuid-v5';
+
+// eslint-disable-next-line @checkdigit/no-uuid
+export const HASH_NAMESPACE = 'f25d4515-fea7-44c7-8baf-f3ca50865e66';
+
+/**
+ * @param value - a string to be hashed and converted into a derived uuid
+ */
+
+export default function (value: string): string {
+  return uuidV5(createHash('sha512').update(value).digest('base64'), HASH_NAMESPACE);
+}

package/src/index.ts

@@ -0,0 +1,10 @@
+// index.ts
+
+/*
+ * Copyright (c) 2021-2023 Check Digit, LLC
+ *
+ * This code is licensed under the MIT license (see LICENSE.txt for details).
+ */
+
+export { default } from './hash';
+export { default as hash, HASH_NAMESPACE } from './hash';

package/src/uuid-v5.ts

@@ -0,0 +1,77 @@
+// uuid-v5.ts
+
+/*
+ * Copyright (c) 2021 Check Digit, LLC
+ *
+ * This code is derived from https://github.com/uuidjs/uuid,
+ * licensed under the MIT license (see below for details).
+ *
+ * Copyright (c) 2010-2020 Robert Kieffer and other contributors
+ *
+ * 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.
+ */
+
+import { createHash } from 'node:crypto';
+
+/* eslint-disable no-bitwise,no-magic-numbers */
+function parse(namespace: string) {
+  let value;
+  const intArray = new Uint8Array(16);
+
+  // Parse ########-....-....-....-............
+  intArray[0] = (value = Number.parseInt(namespace.slice(0, 8), 16)) >>> 24;
+  intArray[1] = (value >>> 16) & 0xff;
+  intArray[2] = (value >>> 8) & 0xff;
+  intArray[3] = value & 0xff;
+
+  // Parse ........-####-....-....-............
+  intArray[4] = (value = Number.parseInt(namespace.slice(9, 13), 16)) >>> 8;
+  intArray[5] = value & 0xff;
+
+  // Parse ........-....-####-....-............
+  intArray[6] = (value = Number.parseInt(namespace.slice(14, 18), 16)) >>> 8;
+  intArray[7] = value & 0xff;
+
+  // Parse ........-....-....-####-............
+  intArray[8] = (value = Number.parseInt(namespace.slice(19, 23), 16)) >>> 8;
+  intArray[9] = value & 0xff;
+
+  // Parse ........-....-....-....-############
+  // (Use "/" to avoid 32-bit truncation when bit-shifting high-order bytes)
+  intArray[10] = ((value = Number.parseInt(namespace.slice(24, 36), 16)) / 0x1_00_00_00_00_00) & 0xff;
+  intArray[11] = (value / 0x1_00_00_00_00) & 0xff;
+  intArray[12] = (value >>> 24) & 0xff;
+  intArray[13] = (value >>> 16) & 0xff;
+  intArray[14] = (value >>> 8) & 0xff;
+  intArray[15] = value & 0xff;
+
+  return intArray;
+}
+
+export default function (value: string, namespace: string): string {
+  const buffer = createHash('sha1').update(parse(namespace)).update(value).digest();
+  // note that undefined is treated as 0 by the & operator
+  buffer[6] = ((buffer[6] ?? 0) & 0x0f) | 0x50;
+  buffer[8] = ((buffer[8] ?? 0) & 0x3f) | 0x80;
+  const hex = buffer.toString('hex', 0, 16);
+  return [hex.slice(0, 8), hex.slice(8, 12), hex.slice(12, 16), hex.slice(16, 20), hex.slice(20, 32)]
+    .join('-')
+    .toLowerCase();
+}
+/* eslint-enable no-bitwise,no-magic-numbers */

package/.github/workflows/codeql-analysis.yml

@@ -1,67 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ master ]
-  schedule:
-    - cron: '21 12 * * 4'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'javascript' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
-        # Learn more:
-        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
-
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1

package/dist/hash.d.ts

@@ -1,5 +0,0 @@
-export declare const HASH_NAMESPACE = "f25d4515-fea7-44c7-8baf-f3ca50865e66";
-/**
- * @param value - a string to be hashed and converted into a derived uuid
- */
-export default function (value: string): string;

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-export { default } from './hash';
-export { default as hash, HASH_NAMESPACE } from './hash';

package/dist/index.js

@@ -1 +0,0 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("crypto");function t(t,s){const r=e.createHash("sha1").update(function(e){let t;const s=new Uint8Array(16);return s[0]=(t=parseInt(e.slice(0,8),16))>>>24,s[1]=t>>>16&255,s[2]=t>>>8&255,s[3]=255&t,s[4]=(t=parseInt(e.slice(9,13),16))>>>8,s[5]=255&t,s[6]=(t=parseInt(e.slice(14,18),16))>>>8,s[7]=255&t,s[8]=(t=parseInt(e.slice(19,23),16))>>>8,s[9]=255&t,s[10]=(t=parseInt(e.slice(24,36),16))/1099511627776&255,s[11]=t/4294967296&255,s[12]=t>>>24&255,s[13]=t>>>16&255,s[14]=t>>>8&255,s[15]=255&t,s}(s)).update(t).digest();r[6]=15&r[6]|80,r[8]=63&r[8]|128;const a=r.toString("hex",0,16);return[a.substring(0,8),a.substring(8,12),a.substring(12,16),a.substring(16,20),a.substring(20,32)].join("-").toLowerCase()}function s(s){return t(e.createHash("sha512").update(s).digest("base64"),"f25d4515-fea7-44c7-8baf-f3ca50865e66")}exports.HASH_NAMESPACE="f25d4515-fea7-44c7-8baf-f3ca50865e66",exports.default=s,exports.hash=s;

package/dist/uuidV5.d.ts

@@ -1 +0,0 @@
-export default function (value: string, namespace: string): string;