@vizhub/viz-utils 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 VizHub
+
+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,2 @@
+# viz-utils
+Utility functions for use across VizHub packages

package/dist/generateVizFileId.d.ts

@@ -0,0 +1,2 @@
+import type { VizFileId } from "@vizhub/viz-types";
+export declare const generateVizFileId: () => VizFileId;

package/dist/generateVizFileId.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateVizFileId = void 0;
+var generateVizId_1 = require("./generateVizId");
+// Generates a file id
+var generateVizFileId = function () {
+    return (0, generateVizId_1.generateVizId)().substring(0, 8);
+};
+exports.generateVizFileId = generateVizFileId;

package/dist/generateVizFileId.test.d.ts

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

package/dist/generateVizFileId.test.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var vitest_1 = require("vitest");
+var generateVizFileId_1 = require("./generateVizFileId");
+(0, vitest_1.describe)('generateVizFileId', function () {
+    (0, vitest_1.it)('should generate a string of length 8', function () {
+        var fileId = (0, generateVizFileId_1.generateVizFileId)();
+        (0, vitest_1.expect)(fileId.length).toBe(8);
+    });
+    (0, vitest_1.it)('should generate a string with only hexadecimal characters', function () {
+        var fileId = (0, generateVizFileId_1.generateVizFileId)();
+        (0, vitest_1.expect)(/^[0-9a-f]{8}$/i.test(fileId)).toBe(true);
+    });
+    (0, vitest_1.it)('should generate unique file IDs', function () {
+        var fileIds = new Set();
+        for (var i = 0; i < 100; i++) {
+            fileIds.add((0, generateVizFileId_1.generateVizFileId)());
+        }
+        (0, vitest_1.expect)(fileIds.size).toBe(100);
+    });
+});

package/dist/generateVizId.d.ts

@@ -0,0 +1,2 @@
+import type { VizId } from "@vizhub/viz-types";
+export declare const generateVizId: () => VizId;

package/dist/generateVizId.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateVizId = void 0;
+// Generates a UUID v4 string without dashes,
+// without any dependencies on Node packages.
+// For use in the browser for generating entity ids.
+// See also interactors/generateId for the server-side version.
+// Code by ChatGPT, Feb 2024
+var generateVizId = function () {
+    return "xxxxxxxxxxxx4xxxyxxxxxxxxxxxxxxx".replace(/[xy]/g, function (c) {
+        return ((c === "x" ? Math.random() * 16 : (Math.random() * 4) | 8) | 0).toString(16);
+    });
+};
+exports.generateVizId = generateVizId;

package/dist/generateVizId.test.d.ts

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

package/dist/generateVizId.test.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var vitest_1 = require("vitest");
+var generateVizId_1 = require("./generateVizId");
+var isVizId_1 = require("./isVizId");
+(0, vitest_1.describe)('generateVizId', function () {
+    (0, vitest_1.it)('should generate a valid VizId', function () {
+        var id = (0, generateVizId_1.generateVizId)();
+        (0, vitest_1.expect)((0, isVizId_1.isVizId)(id)).toBe(true);
+    });
+    (0, vitest_1.it)('should generate a string of length 32', function () {
+        var id = (0, generateVizId_1.generateVizId)();
+        (0, vitest_1.expect)(id.length).toBe(32);
+    });
+    (0, vitest_1.it)('should generate a string with only hexadecimal characters', function () {
+        var id = (0, generateVizId_1.generateVizId)();
+        (0, vitest_1.expect)(/^[0-9a-f]{32}$/i.test(id)).toBe(true);
+    });
+    (0, vitest_1.it)('should generate a string with "4" as the 13th character', function () {
+        var id = (0, generateVizId_1.generateVizId)();
+        (0, vitest_1.expect)(id[12]).toBe('4');
+    });
+    (0, vitest_1.it)('should generate unique IDs', function () {
+        var ids = new Set();
+        for (var i = 0; i < 100; i++) {
+            ids.add((0, generateVizId_1.generateVizId)());
+        }
+        (0, vitest_1.expect)(ids.size).toBe(100);
+    });
+});

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { isVizId } from './isVizId';
+export { generateVizId } from './generateVizId';
+export { generateVizFileId } from './generateVizFileId';

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateVizFileId = exports.generateVizId = exports.isVizId = void 0;
+// Re-export all utility functions
+var isVizId_1 = require("./isVizId");
+Object.defineProperty(exports, "isVizId", { enumerable: true, get: function () { return isVizId_1.isVizId; } });
+var generateVizId_1 = require("./generateVizId");
+Object.defineProperty(exports, "generateVizId", { enumerable: true, get: function () { return generateVizId_1.generateVizId; } });
+var generateVizFileId_1 = require("./generateVizFileId");
+Object.defineProperty(exports, "generateVizFileId", { enumerable: true, get: function () { return generateVizFileId_1.generateVizFileId; } });

package/dist/isVizId.d.ts

@@ -0,0 +1 @@
+export declare const isVizId: (str: string) => boolean;

package/dist/isVizId.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isVizId = void 0;
+// Checks if a string was generated by `generateId` from interactors.
+var isVizId = function (str) {
+    // First check if the length is exactly 32 characters
+    if (str.length !== 32) {
+        return false;
+    }
+    // Regular expression for a 32-character hexadecimal string
+    var uuidV4NoDashRegex = /^[0-9a-f]{32}$/i;
+    // Check if the string matches the regular expression
+    if (!uuidV4NoDashRegex.test(str)) {
+        return false;
+    }
+    // Check if the 13th character is '4' (indicating UUID v4)
+    // and the 17th character is one of '8', '9', 'a', 'b' (indicating the variant)
+    return (str[12] === "4"
+    // &&
+    // ['8', '9', 'a', 'b'].includes(str[16].toLowerCase())
+    );
+};
+exports.isVizId = isVizId;

package/dist/isVizId.test.d.ts

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

package/dist/isVizId.test.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var vitest_1 = require("vitest");
+var isVizId_1 = require("./isVizId");
+(0, vitest_1.describe)('isVizId', function () {
+    (0, vitest_1.it)('should return true for valid VizId', function () {
+        // Valid VizId with '4' as the 13th character
+        var validId = '12345678901234567890123456789012';
+        var validIdWith4 = validId.substring(0, 12) + '4' + validId.substring(13);
+        (0, vitest_1.expect)((0, isVizId_1.isVizId)(validIdWith4)).toBe(true);
+    });
+    (0, vitest_1.it)('should return false for strings that are not 32 characters', function () {
+        (0, vitest_1.expect)((0, isVizId_1.isVizId)('123')).toBe(false);
+        (0, vitest_1.expect)((0, isVizId_1.isVizId)('12345678901234567890123456789012345')).toBe(false);
+    });
+    (0, vitest_1.it)('should return false for strings with non-hex characters', function () {
+        (0, vitest_1.expect)((0, isVizId_1.isVizId)('1234567890123g5678901234567890123')).toBe(false);
+        (0, vitest_1.expect)((0, isVizId_1.isVizId)('12345678901234567890123456789012!')).toBe(false);
+    });
+    (0, vitest_1.it)('should return false if the 13th character is not "4"', function () {
+        var validId = '12345678901234567890123456789012';
+        var invalidIdWith5 = validId.substring(0, 12) + '5' + validId.substring(13);
+        (0, vitest_1.expect)((0, isVizId_1.isVizId)(invalidIdWith5)).toBe(false);
+    });
+});

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@vizhub/viz-utils",
+  "version": "0.0.1",
+  "description": "Utility functions for use across VizHub packages.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prettier": "prettier {*.*,**/*.*} --write",
+    "prepublishOnly": "npm run build",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/vizhub-core/viz-utils.git"
+  },
+  "keywords": [
+    "Viz"
+  ],
+  "author": "Curran Kelleher",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/vizhub-core/viz-utils/issues"
+  },
+  "homepage": "https://github.com/vizhub-core/viz-utils#readme",
+  "dependencies": {
+    "@vizhub/viz-types": "^0.0.2"
+  },
+  "devDependencies": {
+    "vitest": "^3.0.9"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ]
+}