cybertoken 1.0.6 → 2.0.0

package/README.md

@@ -1,6 +1,6 @@
 # cybertoken [![CI](https://github.com/nikeee/cybertoken/actions/workflows/CI.yaml/badge.svg)](https://github.com/nikeee/cybertoken/actions/workflows/CI.yaml) [![CD](https://github.com/nikeee/cybertoken/actions/workflows/CD.yaml/badge.svg)](https://github.com/nikeee/cybertoken/actions/workflows/CI.yaml) [![npm badge](https://img.shields.io/npm/v/cybertoken)](https://www.npmjs.com/package/cybertoken)
 
-A token format inspired by the GitHub's new API token format. Think of it as a standardized password format with some handy properties. Intended for API token and password generation.
+A token format inspired by GitHub's new API token format. Think of it as a standardized password format with some handy properties. Intended for API token and password generation.
 
 ## What is this?
 

package/built/index.js

@@ -1,8 +1,7 @@
-var _a;
 import crc32 from "./crc32.js";
 import { base62, version } from "./constants.js";
 import { getTokenPattern, parseTokenData } from "./parse.js";
-const cryptoServices = (_a = globalThis.crypto) !== null && _a !== void 0 ? _a : require("node:crypto").webcrypto;
+const cryptoServices = globalThis.crypto;
 export function createTokenGenerator(options) {
     var _a;
     if (!options.prefixWithoutUnderscore) {

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "cybertoken",
-  "version": "1.0.6",
+  "version": "2.0.0",
   "description": "A token format for APIs inspired by the GitHub's API token format.",
   "author": "Niklas Mollenhauer",
   "license": "ISC",
   "type": "module",
   "main": "built/index.js",
   "bin": "built/cli.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nikeee/cybertoken.git"
+  },
   "scripts": {
     "compile": "tsc",
     "clean": "rimraf built",
@@ -27,9 +31,12 @@
     "base-x": "^4.0.0"
   },
   "devDependencies": {
-    "@vitest/coverage-c8": "^0.26.3",
-    "rimraf": "^3.0.2",
-    "typedoc": "^0.23.23",
-    "vitest": "^0.26.3"
+    "@vitest/coverage-v8": "^0.34.6",
+    "rimraf": "^5.0.5",
+    "typedoc": "^0.25.1",
+    "vitest": "^0.34.6"
+  },
+  "engines": {
+    "node": ">=20.0.0"
   }
 }

package/built/index.test.js

@@ -1,64 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { test, expect } from "vitest";
-import { createTokenGenerator } from "./index.js";
-test("Instance creation smoke test", () => {
-    createTokenGenerator({
-        prefixWithoutUnderscore: "test",
-    });
-});
-test("Instance creation expect prefix", () => {
-    expect(() => createTokenGenerator({})).toThrowError("The `prefixWithoutUnderscore` option is required and must not be an empty string.");
-});
-test("Instance creation expect proper byte count", () => {
-    expect(() => createTokenGenerator({
-        prefixWithoutUnderscore: "a",
-        entropyBytes: -1,
-    })).toThrowError("The token secret byte count (`entropyBytes`) must be greater than 20.");
-    expect(() => createTokenGenerator({
-        prefixWithoutUnderscore: "a",
-        entropyBytes: 0,
-    })).toThrowError("The token secret byte count (`entropyBytes`) must be greater than 20.");
-    expect(() => createTokenGenerator({
-        prefixWithoutUnderscore: "a",
-        entropyBytes: 19,
-    })).toThrowError("The token secret byte count (`entropyBytes`) must be greater than 20.");
-    expect(() => createTokenGenerator({
-        prefixWithoutUnderscore: "a",
-        entropyBytes: 20,
-    })).toThrowError("The token secret byte count (`entropyBytes`) must be greater than 20.");
-    createTokenGenerator({
-        prefixWithoutUnderscore: "a",
-        entropyBytes: 21,
-    });
-});
-test("Roundtrip syntax check", () => __awaiter(void 0, void 0, void 0, function* () {
-    const g = createTokenGenerator({ prefixWithoutUnderscore: "test" });
-    const token = yield g.generateToken();
-    expect(g.isTokenString(token)).toBe(true);
-}));
-test("Non-happy paths in isTokenString", () => __awaiter(void 0, void 0, void 0, function* () {
-    const g = createTokenGenerator({ prefixWithoutUnderscore: "test" });
-    expect(g.isTokenString()).toBe(false);
-    expect(g.isTokenString(null)).toBe(false);
-    expect(g.isTokenString(undefined)).toBe(false);
-    expect(g.isTokenString("")).toBe(false);
-    expect(g.isTokenString("a")).toBe(false);
-    expect(g.isTokenString("a_")).toBe(false);
-    expect(g.isTokenString("a_1234")).toBe(false);
-    expect(g.isTokenString("test_")).toBe(false);
-    expect(g.isTokenString("test_1234")).toBe(false);
-    expect(g.isTokenString("test_")).toBe(false);
-    expect(g.isTokenString("test_AAAABBBB")).toBe(false);
-    expect(g.isTokenString("test_R67NJs98Lvg5o42CanYRTirswpki3SAsJYbN")).toBe(false);
-    expect(g.isTokenString("test_R67NJs98Lvg5o42CanYRTirswpki3SAsJYbNiDwHd")).toBe(false);
-    expect(g.isTokenString("test_R67NJs98Lvg5o42CanYRTirswpki3SAsJYbNiDwHdKNhiyW")).toBe(false);
-    expect(g.isTokenString("test_R67NJs98Lvg5o42CanYRTirswpki3SAsJYbNiDwHdKNhiyw")).toBe(true);
-}));

package/built/parse.test.js

@@ -1,35 +0,0 @@
-import { test, expect } from "vitest";
-import { parseTokenData } from "./parse.js";
-test("Parse token contents", () => {
-    let contents;
-    contents = parseTokenData("test_R67NJs98Lvg5o42CanYRTirswpki3SAsJYbNiDwHd");
-    expect(contents).toBeUndefined();
-    contents = parseTokenData("test_");
-    expect(contents).toBeUndefined();
-    contents = parseTokenData("test_abc_def");
-    expect(contents).toBeUndefined();
-    contents = parseTokenData("test_R67NJs98Lvg5o42CanYRTirswpki3SAsJYbNiDwHdKNhiyw");
-    expect(contents).toEqual({
-        prefixWithoutUnderscore: "test",
-        actualChecksum: new Uint8Array([94, 199, 163, 74]),
-        isSyntacticallyValid: true,
-        secret: new Uint8Array([
-            100, 166, 3, 29, 89, 224, 104, 216, 82, 241, 34, 139, 193, 245, 62, 254,
-            71, 254, 26, 57, 131, 99, 11, 222, 170, 63, 150, 82, 53, 165,
-        ]),
-        suppliedChecksum: new Uint8Array([94, 199, 163, 74]),
-        version: 0,
-    });
-    contents = parseTokenData("randomToken_R67NJs98Lvg5o42CanYRTirswpki3SAsJYbNiDwHdKNhiyw");
-    expect(contents).toEqual({
-        prefixWithoutUnderscore: "randomToken",
-        actualChecksum: new Uint8Array([94, 199, 163, 74]),
-        isSyntacticallyValid: true,
-        secret: new Uint8Array([
-            100, 166, 3, 29, 89, 224, 104, 216, 82, 241, 34, 139, 193, 245, 62, 254,
-            71, 254, 26, 57, 131, 99, 11, 222, 170, 63, 150, 82, 53, 165,
-        ]),
-        suppliedChecksum: new Uint8Array([94, 199, 163, 74]),
-        version: 0,
-    });
-});