@vizhub/viz-utils 1.3.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -36,6 +36,16 @@ import { generateVizFileId } from "@vizhub/viz-utils";
36
36
  const newFileId = generateVizFileId(); // e.g. "550e8400"
37
37
  ```
38
38
 
39
+ #### `generateRunId(): string`
40
+
41
+ Generates a unique RunId (an 8-character hexadecimal string) for a run within a visualization, for use as the `vizContent.runId` property.
42
+
43
+ ```typescript
44
+ import { generateRunId } from "@vizhub/viz-utils";
45
+
46
+ const newRunId = generateRunId(); // e.g. "550e8400"
47
+ ```
48
+
39
49
  ### Validation
40
50
 
41
51
  #### `isVizId(str: string): boolean`
@@ -53,6 +63,31 @@ isVizId("12345678901234567890123456789012"); // true if valid
53
63
  isVizId("invalid-id"); // false
54
64
  ```
55
65
 
66
+ #### `isImageFileName(fileName: string): boolean`
67
+
68
+ Checks if a file name has an image file extension. Returns `true` if the file name has a supported image extension, `false` otherwise.
69
+
70
+ Supported image extensions:
71
+
72
+ - png, jpg, jpeg, gif, bmp, svg, webp (case-insensitive)
73
+
74
+ Returns `false` if:
75
+
76
+ - The fileName is not a string
77
+ - The fileName is empty or only whitespace
78
+ - The fileName doesn't have a valid image extension
79
+ - The fileName doesn't have at least one character before the extension
80
+
81
+ ```typescript
82
+ import { isImageFileName } from "@vizhub/viz-utils";
83
+
84
+ isImageFileName("photo.png"); // true
85
+ isImageFileName("image.JPG"); // true (case-insensitive)
86
+ isImageFileName("data.csv"); // false
87
+ isImageFileName(""); // false
88
+ isImageFileName(".png"); // false (no filename before extension)
89
+ ```
90
+
56
91
  ### Time Utilities
57
92
 
58
93
  #### `dateToTimestamp(date: Date): VizTimestamp`
@@ -99,6 +134,27 @@ if (htmlContent) {
99
134
  }
100
135
  ```
101
136
 
137
+ #### `getFileId(content: VizContent, fileName: string): VizFileId | null`
138
+
139
+ Gets the file ID of a file with the given name from a VizContent object.
140
+ Returns null if:
141
+
142
+ - The file is not found
143
+ - The content is undefined
144
+ - The content has no files property
145
+
146
+ If multiple files with the same name exist, returns the ID of the first matching file.
147
+
148
+ ```typescript
149
+ import { getFileId } from "@vizhub/viz-utils";
150
+
151
+ const fileId = getFileId(vizContent, "index.html");
152
+ if (fileId) {
153
+ // Use the file ID to reference the file
154
+ console.log(`File ID: ${fileId}`); // e.g. "File ID: 550e8400"
155
+ }
156
+ ```
157
+
102
158
  #### `vizFilesToFileCollection(files?: VizFiles): Record<string, string>`
103
159
 
104
160
  Converts VizFiles (keyed by file ID) to a simpler file collection format (keyed by filename).
@@ -0,0 +1,2 @@
1
+ export declare const generateRunId: () => import("@vizhub/viz-types").VizFileId;
2
+ //# sourceMappingURL=generateRunId.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generateRunId.d.ts","sourceRoot":"","sources":["../src/generateRunId.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,aAAa,6CAAoB,CAAC"}
@@ -0,0 +1,3 @@
1
+ import { VizContent, VizFileId } from "@vizhub/viz-types";
2
+ export declare const getFileId: (content: VizContent, fileName: string) => VizFileId | null;
3
+ //# sourceMappingURL=getFileId.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getFileId.d.ts","sourceRoot":"","sources":["../src/getFileId.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAI1D,eAAO,MAAM,SAAS,GACpB,SAAS,UAAU,EACnB,UAAU,MAAM,KACf,SAAS,GAAG,IAUd,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=getFileId.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getFileId.test.d.ts","sourceRoot":"","sources":["../src/getFileId.test.ts"],"names":[],"mappings":""}
@@ -1 +1 @@
1
- {"version":3,"file":"getFileText.d.ts","sourceRoot":"","sources":["../src/getFileText.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAI/C,eAAO,MAAM,WAAW,GACtB,SAAS,UAAU,EACnB,UAAU,MAAM,KACf,MAAM,GAAG,IAUX,CAAC"}
1
+ {"version":3,"file":"getFileText.d.ts","sourceRoot":"","sources":["../src/getFileText.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAK/C,eAAO,MAAM,WAAW,GACtB,SAAS,UAAU,EACnB,UAAU,MAAM,KACf,MAAM,GAAG,IAMX,CAAC"}
package/dist/index.cjs CHANGED
@@ -1,2 +1,2 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const l=e=>e.length!==32||!/^[0-9a-f]{32}$/i.test(e)?!1:e[12]==="4",s=()=>typeof globalThis.crypto<"u"?globalThis.crypto:require("node:crypto").webcrypto,a=s(),r=()=>{const e=new Uint8Array(16);return a.getRandomValues(e),e[6]=e[6]&15|64,e[8]=e[8]&63|128,Array.from(e,t=>t.toString(16).padStart(2,"0")).join("")},n=()=>r().substring(0,8),f=(e,t)=>{if(e&&e.files)for(const i of Object.keys(e.files)){const o=e.files[i];if(o.name===t)return o.text}return null},u=e=>{const t={};if(!e)return t;for(const i of Object.values(e))t[i.name]=i.text;return t},c=e=>Object.entries(e).reduce((t,[i,o])=>(t[n()]={name:i,text:o},t),{}),d=e=>Math.floor(e.getTime()/1e3),g=e=>new Date(e*1e3);exports.dateToTimestamp=d;exports.fileCollectionToVizFiles=c;exports.generateVizFileId=n;exports.generateVizId=r;exports.getFileText=f;exports.isVizId=l;exports.timestampToDate=g;exports.vizFilesToFileCollection=u;
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const l=e=>e.length!==32||!/^[0-9a-f]{32}$/i.test(e)?!1:e[12]==="4",a=e=>!e||typeof e!="string"||e.trim()===""?!1:/^.+\.(png|jpg|jpeg|gif|bmp|svg|webp)$/i.test(e),u=()=>typeof globalThis.crypto<"u"?globalThis.crypto:require("node:crypto").webcrypto,f=u(),n=()=>{const e=new Uint8Array(16);return f.getRandomValues(e),e[6]=e[6]&15|64,e[8]=e[8]&63|128,Array.from(e,t=>t.toString(16).padStart(2,"0")).join("")},r=()=>n().substring(0,8),g=r,s=(e,t)=>{if(e&&e.files){for(const i of Object.keys(e.files))if(e.files[i].name===t)return i}return null},c=(e,t)=>{const i=s(e,t);return i&&e&&e.files?e.files[i].text:null},d=e=>{const t={};if(!e)return t;for(const i of Object.values(e))t[i.name]=i.text;return t},p=e=>Object.entries(e).reduce((t,[i,o])=>(t[r()]={name:i,text:o},t),{}),m=e=>Math.floor(e.getTime()/1e3),T=e=>new Date(e*1e3);exports.dateToTimestamp=m;exports.fileCollectionToVizFiles=p;exports.generateRunId=g;exports.generateVizFileId=r;exports.generateVizId=n;exports.getFileId=s;exports.getFileText=c;exports.isImageFileName=a;exports.isVizId=l;exports.timestampToDate=T;exports.vizFilesToFileCollection=d;
2
2
  //# sourceMappingURL=index.cjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs","sources":["../src/isVizId.ts","../src/generateVizId.ts","../src/generateVizFileId.ts","../src/getFileText.ts","../src/vizFilesToFileCollection.ts","../src/fileCollectionToVizFiles.ts","../src/dateToTimestamp.ts","../src/timestampToDate.ts"],"sourcesContent":["import type { VizId } from \"@vizhub/viz-types\";\n\n// Checks if a string was generated by `generateId` from interactors.\nexport const isVizId = (str: string): boolean => {\n // First check if the length is exactly 32 characters\n if (str.length !== 32) {\n return false;\n }\n\n // Regular expression for a 32-character hexadecimal string\n let uuidV4NoDashRegex = /^[0-9a-f]{32}$/i;\n\n // Check if the string matches the regular expression\n if (!uuidV4NoDashRegex.test(str)) {\n return false;\n }\n\n // Check if the 13th character is '4' (indicating UUID v4)\n // and the 17th character is one of '8', '9', 'a', 'b' (indicating the variant)\n return (\n str[12] === \"4\"\n // &&\n // ['8', '9', 'a', 'b'].includes(str[16].toLowerCase())\n );\n};\n","import type { VizId } from \"@vizhub/viz-types\";\n\n// Resolve a Web‑Crypto‑compatible `crypto` object.\n// • Browsers & Node 19 + → globalThis.crypto\n// • Anything else (rare) → use node:crypto's webcrypto\nconst getCryptoObj = (): Crypto => {\n if (typeof globalThis.crypto !== \"undefined\") {\n return globalThis.crypto as Crypto;\n }\n // Use require instead of import to avoid top-level await\n // This will only run in Node.js environments\n return require(\"node:crypto\").webcrypto as Crypto;\n};\n\nconst cryptoObj = getCryptoObj();\n\n/**\n * Generates a dash‑free RFC 4122‑compliant UUID v4 (32 hex chars).\n * Works in all evergreen browsers and Node 19 + without extra deps.\n */\nexport const generateVizId = (): VizId => {\n const bytes = new Uint8Array(16);\n cryptoObj.getRandomValues(bytes);\n\n // RFC 4122: set version (4) and variant (10xx)\n bytes[6] = (bytes[6] & 0x0f) | 0x40;\n bytes[8] = (bytes[8] & 0x3f) | 0x80;\n\n return Array.from(bytes, (b) => b.toString(16).padStart(2, \"0\")).join(\n \"\",\n ) as VizId;\n};\n","import type { VizFileId } from \"@vizhub/viz-types\";\nimport { generateVizId } from \"./generateVizId\";\n\n// Generates a file id\nexport const generateVizFileId = (): VizFileId =>\n generateVizId().substring(0, 8);\n","import { VizContent } from \"@vizhub/viz-types\";\n\n// Gets the text content of a file with the given name.\n// Returns null if not found.\nexport const getFileText = (\n content: VizContent,\n fileName: string,\n): string | null => {\n if (content && content.files) {\n for (const fileId of Object.keys(content.files)) {\n const file = content.files[fileId];\n if (file.name === fileName) {\n return file.text;\n }\n }\n }\n return null;\n};\n","import type { VizFiles, FileCollection } from \"@vizhub/viz-types\";\n\n/**\n * Converts VizContent to FileCollection format.\n */\nexport const vizFilesToFileCollection = (files?: VizFiles): FileCollection => {\n const fileCollection: FileCollection = {};\n\n // Return empty object if files is undefined\n if (!files) {\n return fileCollection;\n }\n\n // Convert each VizFile to the FileCollection format\n for (const file of Object.values(files)) {\n fileCollection[file.name] = file.text;\n }\n\n return fileCollection;\n};\n","import { FileCollection, VizFiles } from \"@vizhub/viz-types\";\nimport { generateVizFileId } from \"./generateVizFileId\";\n\nexport const fileCollectionToVizFiles = (files: FileCollection): VizFiles => {\n return Object.entries(files).reduce((acc, [name, text]) => {\n acc[generateVizFileId()] = { name, text };\n return acc;\n }, {} as VizFiles);\n};\n","import type { VizTimestamp } from \"@vizhub/viz-types\";\n\nexport const dateToTimestamp = (date: Date): VizTimestamp =>\n Math.floor(date.getTime() / 1000);\n","import type { VizTimestamp } from \"@vizhub/viz-types\";\n\nexport const timestampToDate = (timestamp: VizTimestamp): Date =>\n new Date(timestamp * 1000);\n"],"names":["isVizId","str","getCryptoObj","cryptoObj","generateVizId","bytes","b","generateVizFileId","getFileText","content","fileName","fileId","file","vizFilesToFileCollection","files","fileCollection","fileCollectionToVizFiles","acc","name","text","dateToTimestamp","date","timestampToDate","timestamp"],"mappings":"gFAGO,MAAMA,EAAWC,GAElBA,EAAI,SAAW,IAQf,CAHoB,kBAGD,KAAKA,CAAG,EACtB,GAMPA,EAAI,EAAE,IAAM,ICfVC,EAAe,IACf,OAAO,WAAW,OAAW,IACxB,WAAW,OAIb,QAAQ,aAAa,EAAE,UAG1BC,EAAYD,EAAA,EAMLE,EAAgB,IAAa,CACxC,MAAMC,EAAQ,IAAI,WAAW,EAAE,EAC/B,OAAAF,EAAU,gBAAgBE,CAAK,EAG/BA,EAAM,CAAC,EAAKA,EAAM,CAAC,EAAI,GAAQ,GAC/BA,EAAM,CAAC,EAAKA,EAAM,CAAC,EAAI,GAAQ,IAExB,MAAM,KAAKA,EAAQC,GAAMA,EAAE,SAAS,EAAE,EAAE,SAAS,EAAG,GAAG,CAAC,EAAE,KAC/D,EAAA,CAEJ,EC3BaC,EAAoB,IAC/BH,EAAA,EAAgB,UAAU,EAAG,CAAC,ECDnBI,EAAc,CACzBC,EACAC,IACkB,CAClB,GAAID,GAAWA,EAAQ,MACrB,UAAWE,KAAU,OAAO,KAAKF,EAAQ,KAAK,EAAG,CAC/C,MAAMG,EAAOH,EAAQ,MAAME,CAAM,EACjC,GAAIC,EAAK,OAASF,EAChB,OAAOE,EAAK,IAEhB,CAEF,OAAO,IACT,ECZaC,EAA4BC,GAAqC,CAC5E,MAAMC,EAAiC,CAAA,EAGvC,GAAI,CAACD,EACH,OAAOC,EAIT,UAAWH,KAAQ,OAAO,OAAOE,CAAK,EACpCC,EAAeH,EAAK,IAAI,EAAIA,EAAK,KAGnC,OAAOG,CACT,EChBaC,EAA4BF,GAChC,OAAO,QAAQA,CAAK,EAAE,OAAO,CAACG,EAAK,CAACC,EAAMC,CAAI,KACnDF,EAAIV,EAAA,CAAmB,EAAI,CAAE,KAAAW,EAAM,KAAAC,CAAA,EAC5BF,GACN,CAAA,CAAc,ECLNG,EAAmBC,GAC9B,KAAK,MAAMA,EAAK,QAAA,EAAY,GAAI,ECDrBC,EAAmBC,GAC9B,IAAI,KAAKA,EAAY,GAAI"}
1
+ {"version":3,"file":"index.cjs","sources":["../src/isVizId.ts","../src/isImageFileName.ts","../src/generateVizId.ts","../src/generateVizFileId.ts","../src/generateRunId.ts","../src/getFileId.ts","../src/getFileText.ts","../src/vizFilesToFileCollection.ts","../src/fileCollectionToVizFiles.ts","../src/dateToTimestamp.ts","../src/timestampToDate.ts"],"sourcesContent":["import type { VizId } from \"@vizhub/viz-types\";\n\n// Checks if a string was generated by `generateId` from interactors.\nexport const isVizId = (str: string): boolean => {\n // First check if the length is exactly 32 characters\n if (str.length !== 32) {\n return false;\n }\n\n // Regular expression for a 32-character hexadecimal string\n let uuidV4NoDashRegex = /^[0-9a-f]{32}$/i;\n\n // Check if the string matches the regular expression\n if (!uuidV4NoDashRegex.test(str)) {\n return false;\n }\n\n // Check if the 13th character is '4' (indicating UUID v4)\n // and the 17th character is one of '8', '9', 'a', 'b' (indicating the variant)\n return (\n str[12] === \"4\"\n // &&\n // ['8', '9', 'a', 'b'].includes(str[16].toLowerCase())\n );\n};\n","// Check if a file name has an image file extension\nexport const isImageFileName = (fileName: string): boolean => {\n if (!fileName || typeof fileName !== \"string\" || fileName.trim() === \"\") {\n return false;\n }\n\n // Check if it's an image file based on extension\n // Also ensure there's at least one character before the dot\n return /^.+\\.(png|jpg|jpeg|gif|bmp|svg|webp)$/i.test(fileName);\n};\n","import type { VizId } from \"@vizhub/viz-types\";\n\n// Resolve a Web‑Crypto‑compatible `crypto` object.\n// • Browsers & Node 19 + → globalThis.crypto\n// • Anything else (rare) → use node:crypto's webcrypto\nconst getCryptoObj = (): Crypto => {\n if (typeof globalThis.crypto !== \"undefined\") {\n return globalThis.crypto as Crypto;\n }\n // Use require instead of import to avoid top-level await\n // This will only run in Node.js environments\n return require(\"node:crypto\").webcrypto as Crypto;\n};\n\nconst cryptoObj = getCryptoObj();\n\n/**\n * Generates a dash‑free RFC 4122‑compliant UUID v4 (32 hex chars).\n * Works in all evergreen browsers and Node 19 + without extra deps.\n */\nexport const generateVizId = (): VizId => {\n const bytes = new Uint8Array(16);\n cryptoObj.getRandomValues(bytes);\n\n // RFC 4122: set version (4) and variant (10xx)\n bytes[6] = (bytes[6] & 0x0f) | 0x40;\n bytes[8] = (bytes[8] & 0x3f) | 0x80;\n\n return Array.from(bytes, (b) => b.toString(16).padStart(2, \"0\")).join(\n \"\",\n ) as VizId;\n};\n","import type { VizFileId } from \"@vizhub/viz-types\";\nimport { generateVizId } from \"./generateVizId\";\n\n// Generates a file id\nexport const generateVizFileId = (): VizFileId =>\n generateVizId().substring(0, 8);\n","import { generateVizFileId } from \"./generateVizFileId\";\nexport const generateRunId = generateVizFileId;\n","import { VizContent, VizFileId } from \"@vizhub/viz-types\";\n\n// Gets the file id of a file with the given name.\n// Returns null if not found.\nexport const getFileId = (\n content: VizContent,\n fileName: string,\n): VizFileId | null => {\n if (content && content.files) {\n for (const fileId of Object.keys(content.files)) {\n const file = content.files[fileId];\n if (file.name === fileName) {\n return fileId;\n }\n }\n }\n return null;\n};\n","import { VizContent } from \"@vizhub/viz-types\";\nimport { getFileId } from \"./getFileId\";\n\n// Gets the text content of a file with the given name.\n// Returns null if not found.\nexport const getFileText = (\n content: VizContent,\n fileName: string,\n): string | null => {\n const fileId = getFileId(content, fileName);\n if (fileId && content && content.files) {\n return content.files[fileId].text;\n }\n return null;\n};\n","import type { VizFiles, FileCollection } from \"@vizhub/viz-types\";\n\n/**\n * Converts VizContent to FileCollection format.\n */\nexport const vizFilesToFileCollection = (files?: VizFiles): FileCollection => {\n const fileCollection: FileCollection = {};\n\n // Return empty object if files is undefined\n if (!files) {\n return fileCollection;\n }\n\n // Convert each VizFile to the FileCollection format\n for (const file of Object.values(files)) {\n fileCollection[file.name] = file.text;\n }\n\n return fileCollection;\n};\n","import { FileCollection, VizFiles } from \"@vizhub/viz-types\";\nimport { generateVizFileId } from \"./generateVizFileId\";\n\nexport const fileCollectionToVizFiles = (files: FileCollection): VizFiles => {\n return Object.entries(files).reduce((acc, [name, text]) => {\n acc[generateVizFileId()] = { name, text };\n return acc;\n }, {} as VizFiles);\n};\n","import type { VizTimestamp } from \"@vizhub/viz-types\";\n\nexport const dateToTimestamp = (date: Date): VizTimestamp =>\n Math.floor(date.getTime() / 1000);\n","import type { VizTimestamp } from \"@vizhub/viz-types\";\n\nexport const timestampToDate = (timestamp: VizTimestamp): Date =>\n new Date(timestamp * 1000);\n"],"names":["isVizId","str","isImageFileName","fileName","getCryptoObj","cryptoObj","generateVizId","bytes","b","generateVizFileId","generateRunId","getFileId","content","fileId","getFileText","vizFilesToFileCollection","files","fileCollection","file","fileCollectionToVizFiles","acc","name","text","dateToTimestamp","date","timestampToDate","timestamp"],"mappings":"gFAGO,MAAMA,EAAWC,GAElBA,EAAI,SAAW,IAQf,CAHoB,kBAGD,KAAKA,CAAG,EACtB,GAMPA,EAAI,EAAE,IAAM,ICnBHC,EAAmBC,GAC1B,CAACA,GAAY,OAAOA,GAAa,UAAYA,EAAS,KAAA,IAAW,GAC5D,GAKF,yCAAyC,KAAKA,CAAQ,ECHzDC,EAAe,IACf,OAAO,WAAW,OAAW,IACxB,WAAW,OAIb,QAAQ,aAAa,EAAE,UAG1BC,EAAYD,EAAA,EAMLE,EAAgB,IAAa,CACxC,MAAMC,EAAQ,IAAI,WAAW,EAAE,EAC/B,OAAAF,EAAU,gBAAgBE,CAAK,EAG/BA,EAAM,CAAC,EAAKA,EAAM,CAAC,EAAI,GAAQ,GAC/BA,EAAM,CAAC,EAAKA,EAAM,CAAC,EAAI,GAAQ,IAExB,MAAM,KAAKA,EAAQC,GAAMA,EAAE,SAAS,EAAE,EAAE,SAAS,EAAG,GAAG,CAAC,EAAE,KAC/D,EAAA,CAEJ,EC3BaC,EAAoB,IAC/BH,EAAA,EAAgB,UAAU,EAAG,CAAC,ECJnBI,EAAgBD,ECGhBE,EAAY,CACvBC,EACAT,IACqB,CACrB,GAAIS,GAAWA,EAAQ,OACrB,UAAWC,KAAU,OAAO,KAAKD,EAAQ,KAAK,EAE5C,GADaA,EAAQ,MAAMC,CAAM,EACxB,OAASV,EAChB,OAAOU,EAIb,OAAO,IACT,ECZaC,EAAc,CACzBF,EACAT,IACkB,CAClB,MAAMU,EAASF,EAAUC,EAAST,CAAQ,EAC1C,OAAIU,GAAUD,GAAWA,EAAQ,MACxBA,EAAQ,MAAMC,CAAM,EAAE,KAExB,IACT,ECTaE,EAA4BC,GAAqC,CAC5E,MAAMC,EAAiC,CAAA,EAGvC,GAAI,CAACD,EACH,OAAOC,EAIT,UAAWC,KAAQ,OAAO,OAAOF,CAAK,EACpCC,EAAeC,EAAK,IAAI,EAAIA,EAAK,KAGnC,OAAOD,CACT,EChBaE,EAA4BH,GAChC,OAAO,QAAQA,CAAK,EAAE,OAAO,CAACI,EAAK,CAACC,EAAMC,CAAI,KACnDF,EAAIX,EAAA,CAAmB,EAAI,CAAE,KAAAY,EAAM,KAAAC,CAAA,EAC5BF,GACN,CAAA,CAAc,ECLNG,EAAmBC,GAC9B,KAAK,MAAMA,EAAK,QAAA,EAAY,GAAI,ECDrBC,EAAmBC,GAC9B,IAAI,KAAKA,EAAY,GAAI"}
package/dist/index.d.ts CHANGED
@@ -1,6 +1,9 @@
1
1
  export { isVizId } from "./isVizId";
2
+ export { isImageFileName } from "./isImageFileName";
2
3
  export { generateVizId } from "./generateVizId";
3
4
  export { generateVizFileId } from "./generateVizFileId";
5
+ export { generateRunId } from "./generateRunId";
6
+ export { getFileId } from "./getFileId";
4
7
  export { getFileText } from "./getFileText";
5
8
  export { vizFilesToFileCollection } from "./vizFilesToFileCollection";
6
9
  export { fileCollectionToVizFiles } from "./fileCollectionToVizFiles";
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC"}
package/dist/index.js CHANGED
@@ -1,32 +1,37 @@
1
- const f = (e) => e.length !== 32 || !/^[0-9a-f]{32}$/i.test(e) ? !1 : e[12] === "4", i = () => typeof globalThis.crypto < "u" ? globalThis.crypto : require("node:crypto").webcrypto, n = i(), s = () => {
1
+ const u = (e) => e.length !== 32 || !/^[0-9a-f]{32}$/i.test(e) ? !1 : e[12] === "4", a = (e) => !e || typeof e != "string" || e.trim() === "" ? !1 : /^.+\.(png|jpg|jpeg|gif|bmp|svg|webp)$/i.test(e), o = () => typeof globalThis.crypto < "u" ? globalThis.crypto : require("node:crypto").webcrypto, s = o(), l = () => {
2
2
  const e = new Uint8Array(16);
3
- return n.getRandomValues(e), e[6] = e[6] & 15 | 64, e[8] = e[8] & 63 | 128, Array.from(e, (t) => t.toString(16).padStart(2, "0")).join(
3
+ return s.getRandomValues(e), e[6] = e[6] & 15 | 64, e[8] = e[8] & 63 | 128, Array.from(e, (t) => t.toString(16).padStart(2, "0")).join(
4
4
  ""
5
5
  );
6
- }, l = () => s().substring(0, 8), a = (e, t) => {
7
- if (e && e.files)
8
- for (const r of Object.keys(e.files)) {
9
- const o = e.files[r];
10
- if (o.name === t)
11
- return o.text;
12
- }
6
+ }, n = () => l().substring(0, 8), c = n, f = (e, t) => {
7
+ if (e && e.files) {
8
+ for (const r of Object.keys(e.files))
9
+ if (e.files[r].name === t)
10
+ return r;
11
+ }
13
12
  return null;
14
- }, u = (e) => {
13
+ }, g = (e, t) => {
14
+ const r = f(e, t);
15
+ return r && e && e.files ? e.files[r].text : null;
16
+ }, p = (e) => {
15
17
  const t = {};
16
18
  if (!e)
17
19
  return t;
18
20
  for (const r of Object.values(e))
19
21
  t[r.name] = r.text;
20
22
  return t;
21
- }, c = (e) => Object.entries(e).reduce((t, [r, o]) => (t[l()] = { name: r, text: o }, t), {}), g = (e) => Math.floor(e.getTime() / 1e3), d = (e) => new Date(e * 1e3);
23
+ }, d = (e) => Object.entries(e).reduce((t, [r, i]) => (t[n()] = { name: r, text: i }, t), {}), b = (e) => Math.floor(e.getTime() / 1e3), y = (e) => new Date(e * 1e3);
22
24
  export {
23
- g as dateToTimestamp,
24
- c as fileCollectionToVizFiles,
25
- l as generateVizFileId,
26
- s as generateVizId,
27
- a as getFileText,
28
- f as isVizId,
29
- d as timestampToDate,
30
- u as vizFilesToFileCollection
25
+ b as dateToTimestamp,
26
+ d as fileCollectionToVizFiles,
27
+ c as generateRunId,
28
+ n as generateVizFileId,
29
+ l as generateVizId,
30
+ f as getFileId,
31
+ g as getFileText,
32
+ a as isImageFileName,
33
+ u as isVizId,
34
+ y as timestampToDate,
35
+ p as vizFilesToFileCollection
31
36
  };
32
37
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sources":["../src/isVizId.ts","../src/generateVizId.ts","../src/generateVizFileId.ts","../src/getFileText.ts","../src/vizFilesToFileCollection.ts","../src/fileCollectionToVizFiles.ts","../src/dateToTimestamp.ts","../src/timestampToDate.ts"],"sourcesContent":["import type { VizId } from \"@vizhub/viz-types\";\n\n// Checks if a string was generated by `generateId` from interactors.\nexport const isVizId = (str: string): boolean => {\n // First check if the length is exactly 32 characters\n if (str.length !== 32) {\n return false;\n }\n\n // Regular expression for a 32-character hexadecimal string\n let uuidV4NoDashRegex = /^[0-9a-f]{32}$/i;\n\n // Check if the string matches the regular expression\n if (!uuidV4NoDashRegex.test(str)) {\n return false;\n }\n\n // Check if the 13th character is '4' (indicating UUID v4)\n // and the 17th character is one of '8', '9', 'a', 'b' (indicating the variant)\n return (\n str[12] === \"4\"\n // &&\n // ['8', '9', 'a', 'b'].includes(str[16].toLowerCase())\n );\n};\n","import type { VizId } from \"@vizhub/viz-types\";\n\n// Resolve a Web‑Crypto‑compatible `crypto` object.\n// • Browsers & Node 19 + → globalThis.crypto\n// • Anything else (rare) → use node:crypto's webcrypto\nconst getCryptoObj = (): Crypto => {\n if (typeof globalThis.crypto !== \"undefined\") {\n return globalThis.crypto as Crypto;\n }\n // Use require instead of import to avoid top-level await\n // This will only run in Node.js environments\n return require(\"node:crypto\").webcrypto as Crypto;\n};\n\nconst cryptoObj = getCryptoObj();\n\n/**\n * Generates a dash‑free RFC 4122‑compliant UUID v4 (32 hex chars).\n * Works in all evergreen browsers and Node 19 + without extra deps.\n */\nexport const generateVizId = (): VizId => {\n const bytes = new Uint8Array(16);\n cryptoObj.getRandomValues(bytes);\n\n // RFC 4122: set version (4) and variant (10xx)\n bytes[6] = (bytes[6] & 0x0f) | 0x40;\n bytes[8] = (bytes[8] & 0x3f) | 0x80;\n\n return Array.from(bytes, (b) => b.toString(16).padStart(2, \"0\")).join(\n \"\",\n ) as VizId;\n};\n","import type { VizFileId } from \"@vizhub/viz-types\";\nimport { generateVizId } from \"./generateVizId\";\n\n// Generates a file id\nexport const generateVizFileId = (): VizFileId =>\n generateVizId().substring(0, 8);\n","import { VizContent } from \"@vizhub/viz-types\";\n\n// Gets the text content of a file with the given name.\n// Returns null if not found.\nexport const getFileText = (\n content: VizContent,\n fileName: string,\n): string | null => {\n if (content && content.files) {\n for (const fileId of Object.keys(content.files)) {\n const file = content.files[fileId];\n if (file.name === fileName) {\n return file.text;\n }\n }\n }\n return null;\n};\n","import type { VizFiles, FileCollection } from \"@vizhub/viz-types\";\n\n/**\n * Converts VizContent to FileCollection format.\n */\nexport const vizFilesToFileCollection = (files?: VizFiles): FileCollection => {\n const fileCollection: FileCollection = {};\n\n // Return empty object if files is undefined\n if (!files) {\n return fileCollection;\n }\n\n // Convert each VizFile to the FileCollection format\n for (const file of Object.values(files)) {\n fileCollection[file.name] = file.text;\n }\n\n return fileCollection;\n};\n","import { FileCollection, VizFiles } from \"@vizhub/viz-types\";\nimport { generateVizFileId } from \"./generateVizFileId\";\n\nexport const fileCollectionToVizFiles = (files: FileCollection): VizFiles => {\n return Object.entries(files).reduce((acc, [name, text]) => {\n acc[generateVizFileId()] = { name, text };\n return acc;\n }, {} as VizFiles);\n};\n","import type { VizTimestamp } from \"@vizhub/viz-types\";\n\nexport const dateToTimestamp = (date: Date): VizTimestamp =>\n Math.floor(date.getTime() / 1000);\n","import type { VizTimestamp } from \"@vizhub/viz-types\";\n\nexport const timestampToDate = (timestamp: VizTimestamp): Date =>\n new Date(timestamp * 1000);\n"],"names":["isVizId","str","getCryptoObj","cryptoObj","generateVizId","bytes","b","generateVizFileId","getFileText","content","fileName","fileId","file","vizFilesToFileCollection","files","fileCollection","fileCollectionToVizFiles","acc","name","text","dateToTimestamp","date","timestampToDate","timestamp"],"mappings":"AAGO,MAAMA,IAAU,CAACC,MAElBA,EAAI,WAAW,MAQf,CAHoB,kBAGD,KAAKA,CAAG,IACtB,KAMPA,EAAI,EAAE,MAAM,KCfVC,IAAe,MACf,OAAO,WAAW,SAAW,MACxB,WAAW,SAIb,QAAQ,aAAa,EAAE,WAG1BC,IAAYD,EAAA,GAMLE,IAAgB,MAAa;AACxC,QAAMC,IAAQ,IAAI,WAAW,EAAE;AAC/B,SAAAF,EAAU,gBAAgBE,CAAK,GAG/BA,EAAM,CAAC,IAAKA,EAAM,CAAC,IAAI,KAAQ,IAC/BA,EAAM,CAAC,IAAKA,EAAM,CAAC,IAAI,KAAQ,KAExB,MAAM,KAAKA,GAAO,CAACC,MAAMA,EAAE,SAAS,EAAE,EAAE,SAAS,GAAG,GAAG,CAAC,EAAE;AAAA,IAC/D;AAAA,EAAA;AAEJ,GC3BaC,IAAoB,MAC/BH,EAAA,EAAgB,UAAU,GAAG,CAAC,GCDnBI,IAAc,CACzBC,GACAC,MACkB;AAClB,MAAID,KAAWA,EAAQ;AACrB,eAAWE,KAAU,OAAO,KAAKF,EAAQ,KAAK,GAAG;AAC/C,YAAMG,IAAOH,EAAQ,MAAME,CAAM;AACjC,UAAIC,EAAK,SAASF;AAChB,eAAOE,EAAK;AAAA,IAEhB;AAEF,SAAO;AACT,GCZaC,IAA2B,CAACC,MAAqC;AAC5E,QAAMC,IAAiC,CAAA;AAGvC,MAAI,CAACD;AACH,WAAOC;AAIT,aAAWH,KAAQ,OAAO,OAAOE,CAAK;AACpC,IAAAC,EAAeH,EAAK,IAAI,IAAIA,EAAK;AAGnC,SAAOG;AACT,GChBaC,IAA2B,CAACF,MAChC,OAAO,QAAQA,CAAK,EAAE,OAAO,CAACG,GAAK,CAACC,GAAMC,CAAI,OACnDF,EAAIV,EAAA,CAAmB,IAAI,EAAE,MAAAW,GAAM,MAAAC,EAAA,GAC5BF,IACN,CAAA,CAAc,GCLNG,IAAkB,CAACC,MAC9B,KAAK,MAAMA,EAAK,QAAA,IAAY,GAAI,GCDrBC,IAAkB,CAACC,MAC9B,IAAI,KAAKA,IAAY,GAAI;"}
1
+ {"version":3,"file":"index.js","sources":["../src/isVizId.ts","../src/isImageFileName.ts","../src/generateVizId.ts","../src/generateVizFileId.ts","../src/generateRunId.ts","../src/getFileId.ts","../src/getFileText.ts","../src/vizFilesToFileCollection.ts","../src/fileCollectionToVizFiles.ts","../src/dateToTimestamp.ts","../src/timestampToDate.ts"],"sourcesContent":["import type { VizId } from \"@vizhub/viz-types\";\n\n// Checks if a string was generated by `generateId` from interactors.\nexport const isVizId = (str: string): boolean => {\n // First check if the length is exactly 32 characters\n if (str.length !== 32) {\n return false;\n }\n\n // Regular expression for a 32-character hexadecimal string\n let uuidV4NoDashRegex = /^[0-9a-f]{32}$/i;\n\n // Check if the string matches the regular expression\n if (!uuidV4NoDashRegex.test(str)) {\n return false;\n }\n\n // Check if the 13th character is '4' (indicating UUID v4)\n // and the 17th character is one of '8', '9', 'a', 'b' (indicating the variant)\n return (\n str[12] === \"4\"\n // &&\n // ['8', '9', 'a', 'b'].includes(str[16].toLowerCase())\n );\n};\n","// Check if a file name has an image file extension\nexport const isImageFileName = (fileName: string): boolean => {\n if (!fileName || typeof fileName !== \"string\" || fileName.trim() === \"\") {\n return false;\n }\n\n // Check if it's an image file based on extension\n // Also ensure there's at least one character before the dot\n return /^.+\\.(png|jpg|jpeg|gif|bmp|svg|webp)$/i.test(fileName);\n};\n","import type { VizId } from \"@vizhub/viz-types\";\n\n// Resolve a Web‑Crypto‑compatible `crypto` object.\n// • Browsers & Node 19 + → globalThis.crypto\n// • Anything else (rare) → use node:crypto's webcrypto\nconst getCryptoObj = (): Crypto => {\n if (typeof globalThis.crypto !== \"undefined\") {\n return globalThis.crypto as Crypto;\n }\n // Use require instead of import to avoid top-level await\n // This will only run in Node.js environments\n return require(\"node:crypto\").webcrypto as Crypto;\n};\n\nconst cryptoObj = getCryptoObj();\n\n/**\n * Generates a dash‑free RFC 4122‑compliant UUID v4 (32 hex chars).\n * Works in all evergreen browsers and Node 19 + without extra deps.\n */\nexport const generateVizId = (): VizId => {\n const bytes = new Uint8Array(16);\n cryptoObj.getRandomValues(bytes);\n\n // RFC 4122: set version (4) and variant (10xx)\n bytes[6] = (bytes[6] & 0x0f) | 0x40;\n bytes[8] = (bytes[8] & 0x3f) | 0x80;\n\n return Array.from(bytes, (b) => b.toString(16).padStart(2, \"0\")).join(\n \"\",\n ) as VizId;\n};\n","import type { VizFileId } from \"@vizhub/viz-types\";\nimport { generateVizId } from \"./generateVizId\";\n\n// Generates a file id\nexport const generateVizFileId = (): VizFileId =>\n generateVizId().substring(0, 8);\n","import { generateVizFileId } from \"./generateVizFileId\";\nexport const generateRunId = generateVizFileId;\n","import { VizContent, VizFileId } from \"@vizhub/viz-types\";\n\n// Gets the file id of a file with the given name.\n// Returns null if not found.\nexport const getFileId = (\n content: VizContent,\n fileName: string,\n): VizFileId | null => {\n if (content && content.files) {\n for (const fileId of Object.keys(content.files)) {\n const file = content.files[fileId];\n if (file.name === fileName) {\n return fileId;\n }\n }\n }\n return null;\n};\n","import { VizContent } from \"@vizhub/viz-types\";\nimport { getFileId } from \"./getFileId\";\n\n// Gets the text content of a file with the given name.\n// Returns null if not found.\nexport const getFileText = (\n content: VizContent,\n fileName: string,\n): string | null => {\n const fileId = getFileId(content, fileName);\n if (fileId && content && content.files) {\n return content.files[fileId].text;\n }\n return null;\n};\n","import type { VizFiles, FileCollection } from \"@vizhub/viz-types\";\n\n/**\n * Converts VizContent to FileCollection format.\n */\nexport const vizFilesToFileCollection = (files?: VizFiles): FileCollection => {\n const fileCollection: FileCollection = {};\n\n // Return empty object if files is undefined\n if (!files) {\n return fileCollection;\n }\n\n // Convert each VizFile to the FileCollection format\n for (const file of Object.values(files)) {\n fileCollection[file.name] = file.text;\n }\n\n return fileCollection;\n};\n","import { FileCollection, VizFiles } from \"@vizhub/viz-types\";\nimport { generateVizFileId } from \"./generateVizFileId\";\n\nexport const fileCollectionToVizFiles = (files: FileCollection): VizFiles => {\n return Object.entries(files).reduce((acc, [name, text]) => {\n acc[generateVizFileId()] = { name, text };\n return acc;\n }, {} as VizFiles);\n};\n","import type { VizTimestamp } from \"@vizhub/viz-types\";\n\nexport const dateToTimestamp = (date: Date): VizTimestamp =>\n Math.floor(date.getTime() / 1000);\n","import type { VizTimestamp } from \"@vizhub/viz-types\";\n\nexport const timestampToDate = (timestamp: VizTimestamp): Date =>\n new Date(timestamp * 1000);\n"],"names":["isVizId","str","isImageFileName","fileName","getCryptoObj","cryptoObj","generateVizId","bytes","b","generateVizFileId","generateRunId","getFileId","content","fileId","getFileText","vizFilesToFileCollection","files","fileCollection","file","fileCollectionToVizFiles","acc","name","text","dateToTimestamp","date","timestampToDate","timestamp"],"mappings":"AAGO,MAAMA,IAAU,CAACC,MAElBA,EAAI,WAAW,MAQf,CAHoB,kBAGD,KAAKA,CAAG,IACtB,KAMPA,EAAI,EAAE,MAAM,KCnBHC,IAAkB,CAACC,MAC1B,CAACA,KAAY,OAAOA,KAAa,YAAYA,EAAS,KAAA,MAAW,KAC5D,KAKF,yCAAyC,KAAKA,CAAQ,GCHzDC,IAAe,MACf,OAAO,WAAW,SAAW,MACxB,WAAW,SAIb,QAAQ,aAAa,EAAE,WAG1BC,IAAYD,EAAA,GAMLE,IAAgB,MAAa;AACxC,QAAMC,IAAQ,IAAI,WAAW,EAAE;AAC/B,SAAAF,EAAU,gBAAgBE,CAAK,GAG/BA,EAAM,CAAC,IAAKA,EAAM,CAAC,IAAI,KAAQ,IAC/BA,EAAM,CAAC,IAAKA,EAAM,CAAC,IAAI,KAAQ,KAExB,MAAM,KAAKA,GAAO,CAACC,MAAMA,EAAE,SAAS,EAAE,EAAE,SAAS,GAAG,GAAG,CAAC,EAAE;AAAA,IAC/D;AAAA,EAAA;AAEJ,GC3BaC,IAAoB,MAC/BH,EAAA,EAAgB,UAAU,GAAG,CAAC,GCJnBI,IAAgBD,GCGhBE,IAAY,CACvBC,GACAT,MACqB;AACrB,MAAIS,KAAWA,EAAQ;AACrB,eAAWC,KAAU,OAAO,KAAKD,EAAQ,KAAK;AAE5C,UADaA,EAAQ,MAAMC,CAAM,EACxB,SAASV;AAChB,eAAOU;AAAA;AAIb,SAAO;AACT,GCZaC,IAAc,CACzBF,GACAT,MACkB;AAClB,QAAMU,IAASF,EAAUC,GAAST,CAAQ;AAC1C,SAAIU,KAAUD,KAAWA,EAAQ,QACxBA,EAAQ,MAAMC,CAAM,EAAE,OAExB;AACT,GCTaE,IAA2B,CAACC,MAAqC;AAC5E,QAAMC,IAAiC,CAAA;AAGvC,MAAI,CAACD;AACH,WAAOC;AAIT,aAAWC,KAAQ,OAAO,OAAOF,CAAK;AACpC,IAAAC,EAAeC,EAAK,IAAI,IAAIA,EAAK;AAGnC,SAAOD;AACT,GChBaE,IAA2B,CAACH,MAChC,OAAO,QAAQA,CAAK,EAAE,OAAO,CAACI,GAAK,CAACC,GAAMC,CAAI,OACnDF,EAAIX,EAAA,CAAmB,IAAI,EAAE,MAAAY,GAAM,MAAAC,EAAA,GAC5BF,IACN,CAAA,CAAc,GCLNG,IAAkB,CAACC,MAC9B,KAAK,MAAMA,EAAK,QAAA,IAAY,GAAI,GCDrBC,IAAkB,CAACC,MAC9B,IAAI,KAAKA,IAAY,GAAI;"}
@@ -0,0 +1,2 @@
1
+ export declare const isImageFileName: (fileName: string) => boolean;
2
+ //# sourceMappingURL=isImageFileName.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"isImageFileName.d.ts","sourceRoot":"","sources":["../src/isImageFileName.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,eAAe,GAAI,UAAU,MAAM,KAAG,OAQlD,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=isImageFileName.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"isImageFileName.test.d.ts","sourceRoot":"","sources":["../src/isImageFileName.test.ts"],"names":[],"mappings":""}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vizhub/viz-utils",
3
- "version": "1.3.0",
3
+ "version": "1.5.0",
4
4
  "description": "Utility functions for use across VizHub packages.",
5
5
  "main": "./dist/index.cjs",
6
6
  "module": "./dist/index.js",
@@ -36,14 +36,14 @@
36
36
  },
37
37
  "homepage": "https://github.com/vizhub-core/viz-utils#readme",
38
38
  "dependencies": {
39
- "@vizhub/viz-types": "^0.2.0"
39
+ "@vizhub/viz-types": "^0.4.0"
40
40
  },
41
41
  "devDependencies": {
42
- "@types/node": "^24.0.14",
43
- "npm-check-updates": "^18.0.1",
42
+ "@types/node": "^24.3.0",
43
+ "npm-check-updates": "^18.0.2",
44
44
  "prettier": "^3.6.2",
45
- "typescript": "^5.8.3",
46
- "vite": "^7.0.5",
45
+ "typescript": "^5.9.2",
46
+ "vite": "^7.1.2",
47
47
  "vitest": "^3.2.4"
48
48
  },
49
49
  "publishConfig": {