@serwist/utils 10.0.0-preview.3 → 10.0.0-preview.4

package/dist/index.node.d.ts

@@ -1,4 +1,7 @@
-export { createLogger } from "./node/log.js";
+export { errors } from "./node/errors.js";
+export { getFileHash, getFileSize, getCompositeDetails } from "./node/fs.js";
+export { getStringHash, getStringDetails } from "./node/hash.js";
 export type { LogType, LogLevel, LoggerOptions, Logger } from "./node/log.js";
+export { createLogger } from "./node/log.js";
 export { resolveEntry } from "./node/paths.js";
 //# sourceMappingURL=index.node.d.ts.map

package/dist/index.node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.node.d.ts","sourceRoot":"","sources":["../src/index.node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.node.d.ts","sourceRoot":"","sources":["../src/index.node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACjE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/index.node.js

@@ -1,8 +1,140 @@
+import { oneLine } from 'common-tags';
+import crypto from 'node:crypto';
 import fs, { readFileSync } from 'node:fs';
 import { createRequire } from 'node:module';
 import { red, yellow, cyan } from 'kolorist';
 import path from 'node:path';
 
+const errors = {
+    "unable-to-get-rootdir": "Unable to get the root directory of your web app.",
+    "no-extension": oneLine`Unable to detect a usable extension for a file in your web
+    app directory.`,
+    "invalid-file-manifest-name": oneLine`The File Manifest Name must have at least one
+    character.`,
+    "unable-to-get-file-manifest-name": "Unable to get a file manifest name.",
+    "invalid-sw-dest": `The 'swDest' value must be a valid path.`,
+    "unable-to-get-sw-name": "Unable to get a service worker file name.",
+    "unable-to-get-save-config": oneLine`An error occurred when asking to save details
+    in a config file.`,
+    "unable-to-get-file-hash": oneLine`An error occurred when attempting to create a
+    file hash.`,
+    "unable-to-get-file-size": oneLine`An error occurred when attempting to get a file
+    size.`,
+    "unable-to-glob-files": "An error occurred when globbing for files.",
+    "unable-to-make-manifest-directory": oneLine`Unable to make output directory for
+    file manifest.`,
+    "read-manifest-template-failure": "Unable to read template for file manifest",
+    "populating-manifest-tmpl-failed": oneLine`An error occurred when populating the
+    file manifest template.`,
+    "manifest-file-write-failure": "Unable to write the file manifest.",
+    "unable-to-make-sw-directory": oneLine`Unable to make the directories to output
+    the service worker path.`,
+    "sw-write-failure": "Unable to write the service worker file.",
+    "sw-write-failure-directory": oneLine`Unable to write the service worker file;
+    'swDest' should be a full path to the file, not a path to a directory.`,
+    "unable-to-copy-serwist-libraries": oneLine`One or more of the Serwist libraries
+    could not be copied over to the destination directory: `,
+    "invalid-glob-directory": oneLine`The supplied globDirectory must be a path as a
+    string.`,
+    "invalid-dont-cache-bust": oneLine`The supplied 'dontCacheBustURLsMatching'
+    parameter must be a RegExp.`,
+    "invalid-exclude-files": "The excluded files should be an array of strings.",
+    "invalid-get-manifest-entries-input": oneLine`The input to
+    'getFileManifestEntries()' must be an object.`,
+    "invalid-manifest-path": oneLine`The supplied manifest path is not a string with
+    at least one character.`,
+    "invalid-manifest-entries": oneLine`The manifest entries must be an array of
+    strings or JavaScript objects containing a url parameter.`,
+    "invalid-manifest-format": oneLine`The value of the 'format' option passed to
+    generateFileManifest() must be either 'iife' (the default) or 'es'.`,
+    "invalid-static-file-globs": oneLine`The 'globPatterns' value must be an array
+    of strings.`,
+    "invalid-templated-urls": oneLine`The 'templatedURLs' value should be an object
+    that maps URLs to either a string, or to an array of glob patterns.`,
+    "templated-url-matches-glob": oneLine`One of the 'templatedURLs' URLs is already
+    being tracked via 'globPatterns': `,
+    "invalid-glob-ignores": oneLine`The 'globIgnores' parameter must be an array of
+    glob pattern strings.`,
+    "manifest-entry-bad-url": oneLine`The generated manifest contains an entry without
+    a URL string. This is likely an error with @serwist/build.`,
+    "modify-url-prefix-bad-prefixes": oneLine`The 'modifyURLPrefix' parameter must be
+    an object with string key value pairs.`,
+    "invalid-inject-manifest-arg": oneLine`The input to 'injectManifest()' must be an
+    object.`,
+    "injection-point-not-found": oneLine`Unable to find a place to inject the manifest.
+    Please ensure that your service worker file contains the following: `,
+    "multiple-injection-points": oneLine`Please ensure that your 'swSrc' file contains
+    only one match for the following: `,
+    "useless-glob-pattern": oneLine`One of the glob patterns doesn't match any files.
+    Please remove or fix the following: `,
+    "bad-template-urls-asset": oneLine`There was an issue using one of the provided
+    'templatedURLs'.`,
+    "invalid-generate-file-manifest-arg": oneLine`The input to generateFileManifest()
+    must be an Object.`,
+    "invalid-sw-src": `The 'swSrc' file can't be read.`,
+    "same-src-and-dest": oneLine`Unable to find a place to inject the manifest. This is
+    likely because swSrc and swDest are configured to the same file.
+    Please ensure that your swSrc file contains the following:`,
+    "no-module-name": oneLine`You must provide a moduleName parameter when calling
+    getModuleURL().`,
+    "bad-manifest-transforms-return-value": oneLine`The return value from a
+    manifestTransform should be an object with 'manifest' and optionally
+    'warnings' properties.`,
+    "string-entry-warning": oneLine`Some items were passed to additionalPrecacheEntries
+    without revisioning info. This is generally NOT safe. Learn more at
+    https://bit.ly/wb-precache.`,
+    "cant-find-sourcemap": oneLine`The swSrc file refers to a sourcemap that can't be
+    opened:`,
+    "manifest-transforms": oneLine`When using manifestTransforms, you must provide
+    an array of functions.`
+};
+
+const getStringHash = (input)=>{
+    const md5 = crypto.createHash("md5");
+    md5.update(input);
+    return md5.digest("hex");
+};
+const getStringDetails = (url, str)=>({
+        file: url,
+        hash: getStringHash(str),
+        size: str.length
+    });
+
+const getFileHash = (file)=>{
+    try {
+        return getStringHash(fs.readFileSync(file));
+    } catch (err) {
+        throw new Error(`${errors["unable-to-get-file-hash"]} '${err instanceof Error && err.message ? err.message : ""}'`);
+    }
+};
+const getFileSize = (file)=>{
+    try {
+        const stat = fs.statSync(file);
+        if (!stat.isFile()) {
+            return null;
+        }
+        return stat.size;
+    } catch (err) {
+        throw new Error(`${errors["unable-to-get-file-size"]} '${err instanceof Error && err.message ? err.message : ""}'`);
+    }
+};
+const getCompositeDetails = (compositeURL, dependencyDetails)=>{
+    let totalSize = 0;
+    let compositeHash = "";
+    for (const fileDetails of dependencyDetails){
+        totalSize += fileDetails.size;
+        compositeHash += fileDetails.hash === null ? "" : fileDetails.hash;
+    }
+    const md5 = crypto.createHash("md5");
+    md5.update(compositeHash);
+    const hashOfHashes = md5.digest("hex");
+    return {
+        file: compositeURL,
+        hash: hashOfHashes,
+        size: totalSize
+    };
+};
+
 const LogLevels = {
     silent: 0,
     error: 1,
@@ -67,4 +199,4 @@ const resolveEntry = (entry)=>{
     return null;
 };
 
-export { createLogger, resolveEntry };
+export { createLogger, errors, getCompositeDetails, getFileHash, getFileSize, getStringDetails, getStringHash, resolveEntry };

package/dist/node/errors.d.ts

@@ -0,0 +1,47 @@
+export declare const errors: {
+    "unable-to-get-rootdir": string;
+    "no-extension": string;
+    "invalid-file-manifest-name": string;
+    "unable-to-get-file-manifest-name": string;
+    "invalid-sw-dest": string;
+    "unable-to-get-sw-name": string;
+    "unable-to-get-save-config": string;
+    "unable-to-get-file-hash": string;
+    "unable-to-get-file-size": string;
+    "unable-to-glob-files": string;
+    "unable-to-make-manifest-directory": string;
+    "read-manifest-template-failure": string;
+    "populating-manifest-tmpl-failed": string;
+    "manifest-file-write-failure": string;
+    "unable-to-make-sw-directory": string;
+    "sw-write-failure": string;
+    "sw-write-failure-directory": string;
+    "unable-to-copy-serwist-libraries": string;
+    "invalid-glob-directory": string;
+    "invalid-dont-cache-bust": string;
+    "invalid-exclude-files": string;
+    "invalid-get-manifest-entries-input": string;
+    "invalid-manifest-path": string;
+    "invalid-manifest-entries": string;
+    "invalid-manifest-format": string;
+    "invalid-static-file-globs": string;
+    "invalid-templated-urls": string;
+    "templated-url-matches-glob": string;
+    "invalid-glob-ignores": string;
+    "manifest-entry-bad-url": string;
+    "modify-url-prefix-bad-prefixes": string;
+    "invalid-inject-manifest-arg": string;
+    "injection-point-not-found": string;
+    "multiple-injection-points": string;
+    "useless-glob-pattern": string;
+    "bad-template-urls-asset": string;
+    "invalid-generate-file-manifest-arg": string;
+    "invalid-sw-src": string;
+    "same-src-and-dest": string;
+    "no-module-name": string;
+    "bad-manifest-transforms-return-value": string;
+    "string-entry-warning": string;
+    "cant-find-sourcemap": string;
+    "manifest-transforms": string;
+};
+//# sourceMappingURL=errors.d.ts.map

package/dist/node/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/node/errors.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkFlB,CAAC"}

package/dist/node/fs.d.ts

@@ -0,0 +1,6 @@
+import fs from "node:fs";
+import type { FileDetails } from "../types.js";
+export declare const getFileHash: (file: fs.PathOrFileDescriptor) => string;
+export declare const getFileSize: (file: string) => number | null;
+export declare const getCompositeDetails: (compositeURL: string, dependencyDetails: FileDetails[]) => FileDetails;
+//# sourceMappingURL=fs.d.ts.map

package/dist/node/fs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../../src/node/fs.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,SAAS,CAAC;AAGzB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,eAAO,MAAM,WAAW,GAAI,MAAM,EAAE,CAAC,oBAAoB,WAMxD,CAAC;AAEF,eAAO,MAAM,WAAW,GAAI,MAAM,MAAM,KAAG,MAAM,GAAG,IAUnD,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAAI,cAAc,MAAM,EAAE,mBAAmB,WAAW,EAAE,KAAG,WAkB5F,CAAC"}

package/dist/node/hash.d.ts

@@ -0,0 +1,5 @@
+import crypto from "node:crypto";
+import type { FileDetails } from "../types.js";
+export declare const getStringHash: (input: crypto.BinaryLike) => string;
+export declare const getStringDetails: (url: string, str: string) => FileDetails;
+//# sourceMappingURL=hash.d.ts.map

package/dist/node/hash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash.d.ts","sourceRoot":"","sources":["../../src/node/hash.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,CAAC,UAAU,KAAG,MAIxD,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAI,KAAK,MAAM,EAAE,KAAK,MAAM,KAAG,WAI1D,CAAC"}

package/dist/types.d.ts

@@ -51,4 +51,9 @@ export type Optional<T, U extends keyof T> = Omit<T, U> & Partial<Pick<T, U>>;
 export type Prettify<T> = {
     [K in keyof T]: T[K];
 } & {};
+export interface FileDetails {
+    file: string;
+    hash: string | null;
+    size: number;
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAErE;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAE9E;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACrB,GAAG,EAAE,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAErE;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAE9E;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACrB,GAAG,EAAE,CAAC;AAEP,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/utils",
-  "version": "10.0.0-preview.3",
+  "version": "10.0.0-preview.4",
   "type": "module",
   "description": "This module contains internal utilities used by Serwist packages.",
   "files": [
@@ -39,12 +39,14 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
+    "common-tags": "1.8.2",
     "kolorist": "1.8.0"
   },
   "devDependencies": {
+    "@types/common-tags": "1.8.4",
     "rollup": "4.40.0",
     "typescript": "5.8.3",
-    "@serwist/configs": "10.0.0-preview.3"
+    "@serwist/configs": "10.0.0-preview.4"
   },
   "scripts": {
     "build": "rimraf dist && NODE_ENV=production rollup --config rollup.config.js",

package/src/index.node.ts

@@ -1,3 +1,6 @@
-export { createLogger } from "./node/log.js";
+export { errors } from "./node/errors.js";
+export { getFileHash, getFileSize, getCompositeDetails } from "./node/fs.js";
+export { getStringHash, getStringDetails } from "./node/hash.js";
 export type { LogType, LogLevel, LoggerOptions, Logger } from "./node/log.js";
+export { createLogger } from "./node/log.js";
 export { resolveEntry } from "./node/paths.js";

package/src/node/errors.ts

@@ -0,0 +1,92 @@
+/*
+  Copyright 2018 Google LLC
+
+  Use of this source code is governed by an MIT-style
+  license that can be found in the LICENSE file or at
+  https://opensource.org/licenses/MIT.
+*/
+import { oneLine as ol } from "common-tags";
+
+export const errors = {
+  "unable-to-get-rootdir": "Unable to get the root directory of your web app.",
+  "no-extension": ol`Unable to detect a usable extension for a file in your web
+    app directory.`,
+  "invalid-file-manifest-name": ol`The File Manifest Name must have at least one
+    character.`,
+  "unable-to-get-file-manifest-name": "Unable to get a file manifest name.",
+  "invalid-sw-dest": `The 'swDest' value must be a valid path.`,
+  "unable-to-get-sw-name": "Unable to get a service worker file name.",
+  "unable-to-get-save-config": ol`An error occurred when asking to save details
+    in a config file.`,
+  "unable-to-get-file-hash": ol`An error occurred when attempting to create a
+    file hash.`,
+  "unable-to-get-file-size": ol`An error occurred when attempting to get a file
+    size.`,
+  "unable-to-glob-files": "An error occurred when globbing for files.",
+  "unable-to-make-manifest-directory": ol`Unable to make output directory for
+    file manifest.`,
+  "read-manifest-template-failure": "Unable to read template for file manifest",
+  "populating-manifest-tmpl-failed": ol`An error occurred when populating the
+    file manifest template.`,
+  "manifest-file-write-failure": "Unable to write the file manifest.",
+  "unable-to-make-sw-directory": ol`Unable to make the directories to output
+    the service worker path.`,
+  "sw-write-failure": "Unable to write the service worker file.",
+  "sw-write-failure-directory": ol`Unable to write the service worker file;
+    'swDest' should be a full path to the file, not a path to a directory.`,
+  "unable-to-copy-serwist-libraries": ol`One or more of the Serwist libraries
+    could not be copied over to the destination directory: `,
+  "invalid-glob-directory": ol`The supplied globDirectory must be a path as a
+    string.`,
+  "invalid-dont-cache-bust": ol`The supplied 'dontCacheBustURLsMatching'
+    parameter must be a RegExp.`,
+  "invalid-exclude-files": "The excluded files should be an array of strings.",
+  "invalid-get-manifest-entries-input": ol`The input to
+    'getFileManifestEntries()' must be an object.`,
+  "invalid-manifest-path": ol`The supplied manifest path is not a string with
+    at least one character.`,
+  "invalid-manifest-entries": ol`The manifest entries must be an array of
+    strings or JavaScript objects containing a url parameter.`,
+  "invalid-manifest-format": ol`The value of the 'format' option passed to
+    generateFileManifest() must be either 'iife' (the default) or 'es'.`,
+  "invalid-static-file-globs": ol`The 'globPatterns' value must be an array
+    of strings.`,
+  "invalid-templated-urls": ol`The 'templatedURLs' value should be an object
+    that maps URLs to either a string, or to an array of glob patterns.`,
+  "templated-url-matches-glob": ol`One of the 'templatedURLs' URLs is already
+    being tracked via 'globPatterns': `,
+  "invalid-glob-ignores": ol`The 'globIgnores' parameter must be an array of
+    glob pattern strings.`,
+  "manifest-entry-bad-url": ol`The generated manifest contains an entry without
+    a URL string. This is likely an error with @serwist/build.`,
+  "modify-url-prefix-bad-prefixes": ol`The 'modifyURLPrefix' parameter must be
+    an object with string key value pairs.`,
+  "invalid-inject-manifest-arg": ol`The input to 'injectManifest()' must be an
+    object.`,
+  "injection-point-not-found": ol`Unable to find a place to inject the manifest.
+    Please ensure that your service worker file contains the following: `,
+  "multiple-injection-points": ol`Please ensure that your 'swSrc' file contains
+    only one match for the following: `,
+  "useless-glob-pattern": ol`One of the glob patterns doesn't match any files.
+    Please remove or fix the following: `,
+  "bad-template-urls-asset": ol`There was an issue using one of the provided
+    'templatedURLs'.`,
+  "invalid-generate-file-manifest-arg": ol`The input to generateFileManifest()
+    must be an Object.`,
+  "invalid-sw-src": `The 'swSrc' file can't be read.`,
+  "same-src-and-dest": ol`Unable to find a place to inject the manifest. This is
+    likely because swSrc and swDest are configured to the same file.
+    Please ensure that your swSrc file contains the following:`,
+  "no-module-name": ol`You must provide a moduleName parameter when calling
+    getModuleURL().`,
+  "bad-manifest-transforms-return-value": ol`The return value from a
+    manifestTransform should be an object with 'manifest' and optionally
+    'warnings' properties.`,
+  "string-entry-warning": ol`Some items were passed to additionalPrecacheEntries
+    without revisioning info. This is generally NOT safe. Learn more at
+    https://bit.ly/wb-precache.`,
+  "cant-find-sourcemap": ol`The swSrc file refers to a sourcemap that can't be
+    opened:`,
+  "manifest-transforms": ol`When using manifestTransforms, you must provide
+    an array of functions.`,
+};

package/src/node/fs.ts

@@ -0,0 +1,45 @@
+import crypto from "node:crypto";
+import fs from "node:fs";
+import { getStringHash } from "./hash.js";
+import { errors } from "./errors.js";
+import type { FileDetails } from "../types.js";
+
+export const getFileHash = (file: fs.PathOrFileDescriptor) => {
+  try {
+    return getStringHash(fs.readFileSync(file));
+  } catch (err) {
+    throw new Error(`${errors["unable-to-get-file-hash"]} '${err instanceof Error && err.message ? err.message : ""}'`);
+  }
+};
+
+export const getFileSize = (file: string): number | null => {
+  try {
+    const stat = fs.statSync(file);
+    if (!stat.isFile()) {
+      return null;
+    }
+    return stat.size;
+  } catch (err) {
+    throw new Error(`${errors["unable-to-get-file-size"]} '${err instanceof Error && err.message ? err.message : ""}'`);
+  }
+};
+
+export const getCompositeDetails = (compositeURL: string, dependencyDetails: FileDetails[]): FileDetails => {
+  let totalSize = 0;
+  let compositeHash = "";
+
+  for (const fileDetails of dependencyDetails) {
+    totalSize += fileDetails.size;
+    compositeHash += fileDetails.hash === null ? "" : fileDetails.hash;
+  }
+
+  const md5 = crypto.createHash("md5");
+  md5.update(compositeHash);
+  const hashOfHashes = md5.digest("hex");
+
+  return {
+    file: compositeURL,
+    hash: hashOfHashes,
+    size: totalSize,
+  };
+};

package/src/node/hash.ts

@@ -0,0 +1,14 @@
+import crypto from "node:crypto";
+import type { FileDetails } from "../types.js";
+
+export const getStringHash = (input: crypto.BinaryLike): string => {
+  const md5 = crypto.createHash("md5");
+  md5.update(input);
+  return md5.digest("hex");
+};
+
+export const getStringDetails = (url: string, str: string): FileDetails => ({
+  file: url,
+  hash: getStringHash(str),
+  size: str.length,
+});

package/src/types.ts

@@ -53,3 +53,9 @@ export type Optional<T, U extends keyof T> = Omit<T, U> & Partial<Pick<T, U>>;
 export type Prettify<T> = {
   [K in keyof T]: T[K];
 } & {};
+
+export interface FileDetails {
+  file: string;
+  hash: string | null;
+  size: number;
+}