@withstudiocms/internal_helpers 0.1.0-beta.1 → 0.1.0-beta.2

package/README.md

@@ -1,5 +1,7 @@
 # @withstudiocms/internal_helpers
 
+[![codecov](https://codecov.io/github/withstudiocms/studiocms/graph/badge.svg?token=RN8LT1O5E2&component=withstudiocms_internal_helpers)](https://codecov.io/github/withstudiocms/studiocms)
+
 Internal helpers and utilities for the @withstudiocms eco-system.
 
 ## License

package/dist/astro-integration/getLatestVersion.d.ts

@@ -1,12 +1,21 @@
+import fs from 'node:fs';
 import type { AstroIntegrationLogger } from 'astro';
+interface FileIO {
+    readFileSync: typeof fs.readFileSync;
+    writeFileSync: typeof fs.writeFileSync;
+}
 /**
  * Fetches the latest version of a given npm package from the npm registry.
  *
  * @param packageName - The name of the npm package to fetch the latest version for.
  * @param logger - An instance of `AstroIntegrationLogger` used to log errors if the fetch fails.
+ * @param cacheJsonFile - File URL for dev-mode cache (optional).
+ * @param isDevMode - When true, uses/updates a 1h TTL cache in `cacheJsonFile`.
+ * @param io - Optional file IO overrides for testing.
  * @returns A promise that resolves to the latest version of the package as a string,
  *          or `null` if an error occurs during the fetch process.
  *
  * @throws Will throw an error if the HTTP response from the npm registry is not successful.
  */
-export declare function getLatestVersion(packageName: string, logger: AstroIntegrationLogger, cacheJsonFile: URL | undefined, isDevMode: boolean): Promise<string | null>;
+export declare function getLatestVersion(packageName: string, logger: AstroIntegrationLogger, cacheJsonFile: URL | undefined, isDevMode: boolean, io?: FileIO): Promise<string | null>;
+export {};

package/dist/astro-integration/getLatestVersion.js

@@ -1,29 +1,41 @@
 import fs from "node:fs";
 import { jsonParse } from "../utils/jsonUtils.js";
-async function getLatestVersion(packageName, logger, cacheJsonFile, isDevMode) {
+async function getLatestVersion(packageName, logger, cacheJsonFile, isDevMode, io = fs) {
   let cacheData = {};
   if (isDevMode && cacheJsonFile) {
-    const file = fs.readFileSync(cacheJsonFile, { encoding: "utf-8" });
-    cacheData = jsonParse(file);
+    try {
+      const file = io.readFileSync(cacheJsonFile, { encoding: "utf-8" });
+      cacheData = jsonParse(file) ?? {};
+    } catch (err) {
+      if (!err?.code?.includes("ENOENT")) {
+        logger?.warn?.(`Ignoring cache read error for ${cacheJsonFile}: ${err.message}`);
+      }
+    }
     if (cacheData.latestVersionCheck?.lastChecked && new Date(cacheData.latestVersionCheck.lastChecked).getTime() > new Date(Date.now() - 60 * 60 * 1e3).getTime()) {
       return cacheData.latestVersionCheck.version;
     }
   }
   try {
-    const response = await fetch(`https://registry.npmjs.org/${packageName}/latest`);
+    const ac = new AbortController();
+    const t = setTimeout(() => ac.abort(), 5e3);
+    const response = await fetch(`https://registry.npmjs.org/${packageName}/latest`, {
+      signal: ac.signal
+    });
+    clearTimeout(t);
     if (!response.ok) {
-      throw new Error(`Failed to fetch package info: ${response.statusText}`);
+      logger.warn(`Failed to fetch package info from registry.npmjs.org: ${response.statusText}`);
+      return null;
     }
     const data = await response.json();
     if (isDevMode && cacheJsonFile) {
       const updatedCacheData = {
         ...cacheData,
         latestVersionCheck: {
-          lastChecked: /* @__PURE__ */ new Date(),
+          lastChecked: (/* @__PURE__ */ new Date()).toISOString(),
           version: data.version
         }
       };
-      fs.writeFileSync(cacheJsonFile, JSON.stringify(updatedCacheData, null, 2), "utf-8");
+      io.writeFileSync(cacheJsonFile, JSON.stringify(updatedCacheData, null, 2), "utf-8");
     }
     return data.version;
   } catch (error) {

package/dist/utils/jsonUtils.d.ts

@@ -10,4 +10,4 @@ export declare function jsonParse<T extends object>(text: string): T;
 /**
  * Reads a JSON file and parses it into an object of type T.
  */
-export declare function readJson<T extends object>(path: string | URL): T;
+export declare function readJson<T extends object>(path: string | URL, readFileSync?: (path: string | URL, encoding: BufferEncoding) => string): T;

package/dist/utils/jsonUtils.js

@@ -2,8 +2,9 @@ import fs from "node:fs";
 function jsonParse(text) {
   return JSON.parse(text);
 }
-function readJson(path) {
-  return jsonParse(fs.readFileSync(path, "utf-8"));
+function readJson(path, readFileSync = fs.readFileSync) {
+  const content = readFileSync(path, "utf-8");
+  return jsonParse(content);
 }
 export {
   jsonParse,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@withstudiocms/internal_helpers",
-  "version": "0.1.0-beta.1",
+  "version": "0.1.0-beta.2",
   "description": "Internal helper utilities for StudioCMS",
   "author": {
     "name": "withstudiocms",
@@ -75,7 +75,7 @@
   "scripts": {
     "build": "buildkit build 'src/**/*.{ts,astro,css,json,png}'",
     "dev": "buildkit dev 'src/**/*.{ts,astro,css,json,png}'",
-    "test": "buildkit test 'test/**/*.test.js'",
+    "test": "vitest",
     "typecheck": "tspc -p tsconfig.tspc.json"
   }
 }