@checkdigit/hash 0.0.2 → 1.0.0-PR.14-e694

package/LICENSE.txt

@@ -0,0 +1,22 @@
+
+The MIT License
+
+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
+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

@@ -1,5 +1,7 @@
 # Hash
 
+Copyright (c) 2021 [Check Digit, LLC](https://checkdigit.com)
+
 Hash is a small function for Check Digit services to create a UUID derived from a hash generated from a given value.
 
 ### Install
@@ -7,7 +9,6 @@ Hash is a small function for Check Digit services to create a UUID derived from
 ```
 $ npm install @checkdigit/hash
 ```
- 
 
 ### Use
 
@@ -17,5 +18,6 @@ import { hash } from '@checkdigit/hash';
 const derivedUUID = hash('some value');
 ```
 
-Check Digit: https://checkdigit.com
-    
+## License
+
+MIT

package/package.json

@@ -1,59 +1 @@
-{
-  "name": "@checkdigit/hash",
-  "version": "0.0.2",
-  "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": "UNLICENSED",
-  "bugs": {
-    "url": "https://github.com/checkdigit/hash/issues"
-  },
-  "homepage": "https://github.com/checkdigit/hash#readme",
-  "devDependencies": {
-    "@checkdigit/eslint-config": "3.3.5",
-    "@checkdigit/prettier-config": "^1.0.1",
-    "@checkdigit/publish": "^1.0.14",
-    "@checkdigit/typescript": "^3.9.3",
-    "@types/jest": "^26.0.0",
-    "@types/uuid": "^8.3.0",
-    "eslint": "^7.3.0",
-    "jest": "^26.0.1",
-    "prettier": "^2.0.5",
-    "rimraf": "^3.0.2",
-    "ts-jest": "^26.1.1",
-    "ts-node": "^8.10.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": "jest && npm run lint && npm run prettier"
-  },
-  "dependencies": {
-    "crypto": "^1.0.1",
-    "uuid": "^8.3.0"
-  }
-}
+{"name":"@checkdigit/hash","version":"1.0.0-PR.14-e694","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/dist/hash.d.ts

@@ -1,4 +0,0 @@
-/**
- * @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 +0,0 @@
-export { default as hash } from './hash';

package/dist/index.js

@@ -1 +0,0 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("crypto"),r=require("uuid");exports.hash=function(t){return r.v5(e.createHash("sha512").update(t).digest("base64"),"f25d4515-fea7-44c7-8baf-f3ca50865e66")};