test-fns 1.4.2 → 1.5.0

package/dist/genTestUuid.d.ts

@@ -0,0 +1,11 @@
+/**
+ * generates a random uuid namespaced for tests, pattern `beef****-****-****-****-********beef`
+ *
+ * usecase
+ * - produces a uuid that can be clearly identified as one produced for tests
+ */
+export declare const genTestUuid: () => string;
+/**
+ * decides whether a uuid is namespaced for tests
+ */
+export declare const isTestUuid: (userUuid: string) => boolean;

package/dist/genTestUuid.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTestUuid = exports.genTestUuid = void 0;
+const uuid_1 = require("uuid");
+/**
+ * generates a random uuid namespaced for tests, pattern `beef****-****-****-****-********beef`
+ *
+ * usecase
+ * - produces a uuid that can be clearly identified as one produced for tests
+ */
+const genTestUuid = () => {
+    return ['beef', (0, uuid_1.v4)().slice(4, -4), 'beef'].join('');
+};
+exports.genTestUuid = genTestUuid;
+/**
+ * decides whether a uuid is namespaced for tests
+ */
+const isTestUuid = (userUuid) => /^beef.{4}-.{4}-.{4}-.{4}-.{8}beef$/.test(userUuid);
+exports.isTestUuid = isTestUuid;
+//# sourceMappingURL=genTestUuid.js.map

package/dist/genTestUuid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"genTestUuid.js","sourceRoot":"","sources":["../src/genTestUuid.ts"],"names":[],"mappings":";;;AAAA,+BAAkC;AAElC;;;;;GAKG;AACI,MAAM,WAAW,GAAG,GAAW,EAAE;IACtC,OAAO,CAAC,MAAM,EAAE,IAAA,SAAI,GAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACxD,CAAC,CAAC;AAFW,QAAA,WAAW,eAEtB;AAEF;;GAEG;AACI,MAAM,UAAU,GAAG,CAAC,QAAgB,EAAW,EAAE,CACtD,oCAAoC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AADzC,QAAA,UAAU,cAC+B"}

package/dist/genTestUuid.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/genTestUuid.test.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const genTestUuid_1 = require("./genTestUuid");
+describe('genTestUuid', () => {
+    it('should generate a uuid', () => {
+        const uuid = (0, genTestUuid_1.genTestUuid)();
+        expect(uuid).toBeTruthy();
+    });
+    it('should generate a uuid that is namespaced for testing by whodis', () => {
+        const uuid = (0, genTestUuid_1.genTestUuid)();
+        expect(uuid).toMatch(/^beef.*-.*-.*-.*-.*beef$/);
+        expect((0, genTestUuid_1.isTestUuid)(uuid)).toEqual(true);
+    });
+    it('should generate a uuid that is different every time', () => {
+        const uuid1 = (0, genTestUuid_1.genTestUuid)();
+        const uuid2 = (0, genTestUuid_1.genTestUuid)();
+        expect(uuid1).not.toEqual(uuid2);
+    });
+});
+//# sourceMappingURL=genTestUuid.test.js.map

package/dist/genTestUuid.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"genTestUuid.test.js","sourceRoot":"","sources":["../src/genTestUuid.test.ts"],"names":[],"mappings":";;AAAA,+CAAwD;AAExD,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;QAChC,MAAM,IAAI,GAAG,IAAA,yBAAW,GAAE,CAAC;QAC3B,MAAM,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;IAC5B,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,IAAI,GAAG,IAAA,yBAAW,GAAE,CAAC;QAC3B,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;QACjD,MAAM,CAAC,IAAA,wBAAU,EAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,KAAK,GAAG,IAAA,yBAAW,GAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,IAAA,yBAAW,GAAE,CAAC;QAC5B,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export { given, when, then } from './givenWhenThen';
+export { genTestUuid } from './genTestUuid';
 export { getError } from '@ehmpathy/error-fns';

package/dist/index.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getError = exports.then = exports.when = exports.given = void 0;
+exports.getError = exports.genTestUuid = exports.then = exports.when = exports.given = void 0;
 var givenWhenThen_1 = require("./givenWhenThen");
 Object.defineProperty(exports, "given", { enumerable: true, get: function () { return givenWhenThen_1.given; } });
 Object.defineProperty(exports, "when", { enumerable: true, get: function () { return givenWhenThen_1.when; } });
 Object.defineProperty(exports, "then", { enumerable: true, get: function () { return givenWhenThen_1.then; } });
+var genTestUuid_1 = require("./genTestUuid");
+Object.defineProperty(exports, "genTestUuid", { enumerable: true, get: function () { return genTestUuid_1.genTestUuid; } });
 // forward the getError method since it is almost always needed with tests
 var error_fns_1 = require("@ehmpathy/error-fns");
 Object.defineProperty(exports, "getError", { enumerable: true, get: function () { return error_fns_1.getError; } });

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iDAAoD;AAA3C,sGAAA,KAAK,OAAA;AAAE,qGAAA,IAAI,OAAA;AAAE,qGAAA,IAAI,OAAA;AAE1B,0EAA0E;AAC1E,iDAA+C;AAAtC,qGAAA,QAAQ,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iDAAoD;AAA3C,sGAAA,KAAK,OAAA;AAAE,qGAAA,IAAI,OAAA;AAAE,qGAAA,IAAI,OAAA;AAC1B,6CAA4C;AAAnC,0GAAA,WAAW,OAAA;AAEpB,0EAA0E;AAC1E,iDAA+C;AAAtC,qGAAA,QAAQ,OAAA"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "test-fns",
   "author": "ehmpathy",
   "description": "write usecase driven tests systematically for simpler, safer, and more readable code",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "repository": "ehmpathy/test-fns",
   "homepage": "https://github.com/ehmpathy/test-fns",
   "keywords": [
@@ -54,6 +54,7 @@
     "@trivago/prettier-plugin-sort-imports": "2.0.4",
     "@tsconfig/node-lts-strictest": "18.12.1",
     "@types/jest": "29.2.4",
+    "@types/uuid": "10.0.0",
     "@typescript-eslint/eslint-plugin": "5.46.1",
     "@typescript-eslint/parser": "5.46.1",
     "core-js": "3.26.1",
@@ -80,6 +81,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@ehmpathy/error-fns": "1.3.1"
+    "@ehmpathy/error-fns": "1.3.1",
+    "uuid": "10.0.0"
   }
 }