@jsenv/filesystem 4.1.9 → 4.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/filesystem",
-  "version": "4.1.9",
+  "version": "4.2.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -18,20 +18,19 @@
   "type": "module",
   "exports": {
     ".": {
-      "import": "./main.js"
+      "import": "./src/main.js"
     },
     "./*": "./*"
   },
   "files": [
-    "/src/",
-    "/main.js"
+    "/src/"
   ],
   "scripts": {
     "test": "node --conditions=development ./scripts/test.mjs"
   },
   "dependencies": {
     "@jsenv/urls": "1.2.8",
-    "@jsenv/url-meta": "7.0.2",
+    "@jsenv/url-meta": "7.1.0",
     "@jsenv/abort": "4.2.4"
   }
 }

package/src/assertDirectoryPresence.js

@@ -1,5 +1,6 @@
 import { urlToFileSystemPath } from "@jsenv/urls"
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 import { statsToType } from "./internal/statsToType.js"
 import { readEntryStat } from "./readEntryStat.js"
 

package/src/assertFilePresence.js

@@ -1,5 +1,6 @@
 import { urlToFileSystemPath } from "@jsenv/urls"
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 import { statsToType } from "./internal/statsToType.js"
 import { readEntryStat } from "./readEntryStat.js"
 

package/src/collectDirectoryMatchReport.js

@@ -2,7 +2,7 @@ import { Abort } from "@jsenv/abort"
 
 import { URL_META } from "@jsenv/url-meta"
 import { urlToRelativeUrl } from "@jsenv/urls"
-import { assertAndNormalizeDirectoryUrl } from "./assertAndNormalizeDirectoryUrl.js"
+import { assertAndNormalizeDirectoryUrl } from "./directory_url_validation.js"
 import { readDirectory } from "./readDirectory.js"
 import { readEntryStat } from "./readEntryStat.js"
 import { comparePathnames } from "./comparePathnames.js"

package/src/collectFiles.js

@@ -2,7 +2,7 @@ import { Abort } from "@jsenv/abort"
 import { URL_META } from "@jsenv/url-meta"
 import { urlToRelativeUrl } from "@jsenv/urls"
 
-import { assertAndNormalizeDirectoryUrl } from "./assertAndNormalizeDirectoryUrl.js"
+import { assertAndNormalizeDirectoryUrl } from "./directory_url_validation.js"
 import { readDirectory } from "./readDirectory.js"
 import { readEntryStat } from "./readEntryStat.js"
 import { comparePathnames } from "./comparePathnames.js"

package/src/copyDirectoryContent.js

@@ -1,7 +1,7 @@
 import { Abort } from "@jsenv/abort"
 import { urlToFileSystemPath, resolveUrl } from "@jsenv/urls"
 
-import { assertAndNormalizeDirectoryUrl } from "./assertAndNormalizeDirectoryUrl.js"
+import { assertAndNormalizeDirectoryUrl } from "./directory_url_validation.js"
 import { readEntryStat } from "./readEntryStat.js"
 import { readSymbolicLink } from "./readSymbolicLink.js"
 import { readDirectory } from "./readDirectory.js"

package/src/copyEntry.js

@@ -11,7 +11,7 @@ import {
 import { urlTargetsSameFileSystemPath } from "./internal/urlTargetsSameFileSystemPath.js"
 import { statsToType } from "./internal/statsToType.js"
 import { binaryFlagsToPermissions } from "./internal/permissions.js"
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 import { writeDirectory } from "./writeDirectory.js"
 import { readEntryStat } from "./readEntryStat.js"
 import { ensureParentDirectories } from "./ensureParentDirectories.js"

package/src/directory_url_validation.js

@@ -0,0 +1,52 @@
+import {
+  fileSystemPathToUrl,
+  isFileSystemPath,
+  ensurePathnameTrailingSlash,
+} from "@jsenv/urls"
+
+export const validateDirectoryUrl = (value) => {
+  let urlString
+
+  if (value instanceof URL) {
+    urlString = value.href
+  } else if (typeof value === "string") {
+    if (isFileSystemPath(value)) {
+      urlString = fileSystemPathToUrl(value)
+    } else {
+      try {
+        urlString = String(new URL(value))
+      } catch (e) {
+        return {
+          valid: false,
+          value,
+          message: `must be a valid url`,
+        }
+      }
+    }
+  } else {
+    return {
+      valid: false,
+      value,
+      message: `must be a string or an url`,
+    }
+  }
+  if (!urlString.startsWith("file://")) {
+    return {
+      valid: false,
+      value,
+      message: 'must start with "file://"',
+    }
+  }
+  return {
+    valid: true,
+    value: ensurePathnameTrailingSlash(urlString),
+  }
+}
+
+export const assertAndNormalizeDirectoryUrl = (directoryUrl) => {
+  const { valid, message, value } = validateDirectoryUrl(directoryUrl)
+  if (!valid) {
+    throw new TypeError(`directoryUrl ${message}, got ${value}`)
+  }
+  return value
+}

package/src/ensureEmptyDirectory.js

@@ -1,5 +1,6 @@
 import { urlToFileSystemPath } from "@jsenv/urls"
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 import { statsToType } from "./internal/statsToType.js"
 import { writeDirectory } from "./writeDirectory.js"
 import { readEntryStat } from "./readEntryStat.js"

package/src/ensureParentDirectories.js

@@ -1,7 +1,7 @@
 import { dirname } from "node:path"
 import { urlToFileSystemPath } from "@jsenv/urls"
 
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 import { writeDirectory } from "./writeDirectory.js"
 
 export const ensureParentDirectories = async (destination) => {

package/src/file_url_validation.js

@@ -0,0 +1,50 @@
+import { fileSystemPathToUrl, isFileSystemPath } from "@jsenv/urls"
+
+export const validateFileUrl = (value, baseUrl) => {
+  let urlString
+
+  if (value instanceof URL) {
+    urlString = value.href
+  } else if (typeof value === "string") {
+    if (isFileSystemPath(value)) {
+      urlString = fileSystemPathToUrl(value)
+    } else {
+      try {
+        urlString = String(new URL(value, baseUrl))
+      } catch (e) {
+        return {
+          valid: false,
+          value,
+          message: "must be a valid url",
+        }
+      }
+    }
+  } else {
+    return {
+      valid: false,
+      value,
+      message: "must be a string or an url",
+    }
+  }
+
+  if (!urlString.startsWith("file://")) {
+    return {
+      valid: false,
+      value,
+      message: 'must start with "file://"',
+    }
+  }
+
+  return {
+    valid: true,
+    value: urlString,
+  }
+}
+
+export const assertAndNormalizeFileUrl = (fileUrl, baseUrl) => {
+  const { valid, message, value } = validateFileUrl(fileUrl, baseUrl)
+  if (!valid) {
+    throw new TypeError(`fileUrl ${message}, got ${fileUrl}`)
+  }
+  return value
+}

package/src/grantPermissionsOnEntry.js

@@ -1,4 +1,4 @@
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 import { readEntryPermissions } from "./readEntryPermissions.js"
 import { writeEntryPermissions } from "./writeEntryPermissions.js"
 

package/src/main.js

@@ -0,0 +1,41 @@
+export {
+  validateDirectoryUrl,
+  assertAndNormalizeDirectoryUrl,
+} from "./directory_url_validation.js"
+export {
+  validateFileUrl,
+  assertAndNormalizeFileUrl,
+} from "./file_url_validation.js"
+export { assertDirectoryPresence } from "./assertDirectoryPresence.js"
+export { assertFilePresence } from "./assertFilePresence.js"
+export { bufferToEtag } from "./bufferToEtag.js"
+export { collectDirectoryMatchReport } from "./collectDirectoryMatchReport.js"
+export { collectFiles } from "./collectFiles.js"
+export { comparePathnames } from "./comparePathnames.js"
+export { ensureEmptyDirectory } from "./ensureEmptyDirectory.js"
+export { ensureParentDirectories } from "./ensureParentDirectories.js"
+export { ensureWindowsDriveLetter } from "./ensureWindowsDriveLetter.js"
+export { copyEntry } from "./copyEntry.js"
+export { copyDirectoryContent } from "./copyDirectoryContent.js"
+export { getRealFileSystemUrlSync } from "./getRealFileSystemUrlSync.js"
+export { grantPermissionsOnEntry } from "./grantPermissionsOnEntry.js"
+export { listFilesMatching } from "./listFilesMatching.js"
+export { moveDirectoryContent } from "./moveDirectoryContent.js"
+export { moveEntry } from "./moveEntry.js"
+export { readDirectory } from "./readDirectory.js"
+export { readFile } from "./readFile.js"
+export { readFileSync } from "./readFileSync.js"
+export { readEntryModificationTime } from "./readEntryModificationTime.js"
+export { readEntryPermissions } from "./readEntryPermissions.js"
+export { readEntryStat } from "./readEntryStat.js"
+export { readSymbolicLink } from "./readSymbolicLink.js"
+export { registerDirectoryLifecycle } from "./registerDirectoryLifecycle.js"
+export { registerFileLifecycle } from "./registerFileLifecycle.js"
+export { removeEntry } from "./removeEntry.js"
+export { testEntryPermissions } from "./testEntryPermissions.js"
+export { writeDirectory } from "./writeDirectory.js"
+export { writeFile } from "./writeFile.js"
+export { writeFileSync } from "./writeFileSync.js"
+export { writeEntryModificationTime } from "./writeEntryModificationTime.js"
+export { writeEntryPermissions } from "./writeEntryPermissions.js"
+export { writeSymbolicLink } from "./writeSymbolicLink.js"

package/src/moveDirectoryContent.js

@@ -1,7 +1,7 @@
 import { Abort } from "@jsenv/abort"
 import { urlToFileSystemPath, resolveUrl } from "@jsenv/urls"
 
-import { assertAndNormalizeDirectoryUrl } from "./assertAndNormalizeDirectoryUrl.js"
+import { assertAndNormalizeDirectoryUrl } from "./directory_url_validation.js"
 import { readEntryStat } from "./readEntryStat.js"
 import { readSymbolicLink } from "./readSymbolicLink.js"
 import { readDirectory } from "./readDirectory.js"

package/src/moveEntry.js

@@ -4,7 +4,7 @@ import { urlToFileSystemPath, resolveUrl } from "@jsenv/urls"
 
 import { urlTargetsSameFileSystemPath } from "./internal/urlTargetsSameFileSystemPath.js"
 import { statsToType } from "./internal/statsToType.js"
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 import { ensureParentDirectories } from "./ensureParentDirectories.js"
 import { removeEntry } from "./removeEntry.js"
 import { copyEntry } from "./copyEntry.js"

package/src/readDirectory.js

@@ -1,5 +1,5 @@
 import { readdir } from "node:fs"
-import { assertAndNormalizeDirectoryUrl } from "./assertAndNormalizeDirectoryUrl.js"
+import { assertAndNormalizeDirectoryUrl } from "./directory_url_validation.js"
 
 export const readDirectory = async (url, { emfileMaxWait = 1000 } = {}) => {
   const directoryUrl = assertAndNormalizeDirectoryUrl(url)

package/src/readEntryPermissions.js

@@ -7,7 +7,7 @@ import { promises } from "node:fs"
 import { urlToFileSystemPath } from "@jsenv/urls"
 
 import { binaryFlagsToPermissions } from "./internal/permissions.js"
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 
 const { stat } = promises
 

package/src/readEntryStat.js

@@ -6,7 +6,7 @@
 import { lstat, stat } from "node:fs"
 import { urlToFileSystemPath } from "@jsenv/urls"
 
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 import { writeEntryPermissions } from "./writeEntryPermissions.js"
 
 const isWindows = process.platform === "win32"

package/src/readFile.js

@@ -1,6 +1,6 @@
 import { readFile as readFileNode } from "node:fs"
 
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 
 export const readFile = async (value, { as = "buffer" } = {}) => {
   const fileUrl = assertAndNormalizeFileUrl(value)

package/src/readFileSync.js

@@ -1,6 +1,6 @@
 import { readFileSync as readFileSyncNode } from "node:fs"
 
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 
 export const readFileSync = (value, { as = "buffer" } = {}) => {
   const fileUrl = assertAndNormalizeFileUrl(value)

package/src/readSymbolicLink.js

@@ -6,7 +6,7 @@
 import { readlink } from "node:fs"
 import { isFileSystemPath, fileSystemPathToUrl } from "@jsenv/urls"
 
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 
 export const readSymbolicLink = (url) => {
   const symbolicLinkUrl = assertAndNormalizeFileUrl(url)

package/src/registerDirectoryLifecycle.js

@@ -2,7 +2,7 @@ import { readdirSync, statSync } from "node:fs"
 import { URL_META } from "@jsenv/url-meta"
 import { urlToFileSystemPath, urlToRelativeUrl } from "@jsenv/urls"
 
-import { assertAndNormalizeDirectoryUrl } from "./assertAndNormalizeDirectoryUrl.js"
+import { assertAndNormalizeDirectoryUrl } from "./directory_url_validation.js"
 import { statsToType } from "./internal/statsToType.js"
 import { guardTooFastSecondCallPerFile } from "./internal/guard_second_call.js"
 import { createWatcher } from "./internal/createWatcher.js"

package/src/registerFileLifecycle.js

@@ -2,7 +2,7 @@ import { statSync } from "node:fs"
 import { dirname, basename } from "node:path"
 import { urlToFileSystemPath } from "@jsenv/urls"
 
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 import { guardTooFastSecondCall } from "./internal/guard_second_call.js"
 import { statsToType } from "./internal/statsToType.js"
 import { createWatcher } from "./internal/createWatcher.js"

package/src/removeEntry.js

@@ -6,7 +6,7 @@ import {
   resolveUrl,
 } from "@jsenv/urls"
 
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 import { readEntryStat } from "./readEntryStat.js"
 import { readDirectory } from "./readDirectory.js"
 

package/src/testEntryPermissions.js

@@ -1,6 +1,6 @@
 import { promises, constants } from "node:fs"
 
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 
 const { access } = promises
 const {

package/src/writeDirectory.js

@@ -1,7 +1,7 @@
 import { promises } from "node:fs"
 import { urlToFileSystemPath } from "@jsenv/urls"
 
-import { assertAndNormalizeDirectoryUrl } from "./assertAndNormalizeDirectoryUrl.js"
+import { assertAndNormalizeDirectoryUrl } from "./directory_url_validation.js"
 import { statsToType } from "./internal/statsToType.js"
 import { readEntryStat } from "./readEntryStat.js"
 

package/src/writeEntryModificationTime.js

@@ -1,6 +1,6 @@
 import { utimes } from "node:fs"
 
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 
 export const writeEntryModificationTime = (source, mtime) => {
   const sourceUrl = assertAndNormalizeFileUrl(source)

package/src/writeEntryPermissions.js

@@ -1,7 +1,7 @@
 import { chmod } from "node:fs"
 
 import { permissionsToBinaryFlags } from "./internal/permissions.js"
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 
 export const writeEntryPermissions = async (source, permissions) => {
   const sourceUrl = assertAndNormalizeFileUrl(source)

package/src/writeFile.js

@@ -1,6 +1,6 @@
 import { writeFile as writeFileNode } from "node:fs"
 
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 import { ensureParentDirectories } from "./ensureParentDirectories.js"
 
 export const writeFile = async (destination, content = "") => {

package/src/writeFileSync.js

@@ -1,6 +1,6 @@
 import { writeFileSync as writeFileSyncNode, mkdirSync } from "node:fs"
 
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 
 export const writeFileSync = (destination, content = "") => {
   const destinationUrl = assertAndNormalizeFileUrl(destination)

package/src/writeSymbolicLink.js

@@ -6,7 +6,7 @@ import {
   isFileSystemPath,
 } from "@jsenv/urls"
 
-import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
+import { assertAndNormalizeFileUrl } from "./file_url_validation.js"
 import { ensureParentDirectories } from "./ensureParentDirectories.js"
 import { readEntryStat } from "./readEntryStat.js"
 import { readSymbolicLink } from "./readSymbolicLink.js"

package/main.js

@@ -1,35 +0,0 @@
-export { assertAndNormalizeDirectoryUrl } from "./src/assertAndNormalizeDirectoryUrl.js"
-export { assertAndNormalizeFileUrl } from "./src/assertAndNormalizeFileUrl.js"
-export { assertDirectoryPresence } from "./src/assertDirectoryPresence.js"
-export { assertFilePresence } from "./src/assertFilePresence.js"
-export { bufferToEtag } from "./src/bufferToEtag.js"
-export { collectDirectoryMatchReport } from "./src/collectDirectoryMatchReport.js"
-export { collectFiles } from "./src/collectFiles.js"
-export { comparePathnames } from "./src/comparePathnames.js"
-export { ensureEmptyDirectory } from "./src/ensureEmptyDirectory.js"
-export { ensureParentDirectories } from "./src/ensureParentDirectories.js"
-export { ensureWindowsDriveLetter } from "./src/ensureWindowsDriveLetter.js"
-export { copyEntry } from "./src/copyEntry.js"
-export { copyDirectoryContent } from "./src/copyDirectoryContent.js"
-export { getRealFileSystemUrlSync } from "./src/getRealFileSystemUrlSync.js"
-export { grantPermissionsOnEntry } from "./src/grantPermissionsOnEntry.js"
-export { listFilesMatching } from "./src/listFilesMatching.js"
-export { moveDirectoryContent } from "./src/moveDirectoryContent.js"
-export { moveEntry } from "./src/moveEntry.js"
-export { readDirectory } from "./src/readDirectory.js"
-export { readFile } from "./src/readFile.js"
-export { readFileSync } from "./src/readFileSync.js"
-export { readEntryModificationTime } from "./src/readEntryModificationTime.js"
-export { readEntryPermissions } from "./src/readEntryPermissions.js"
-export { readEntryStat } from "./src/readEntryStat.js"
-export { readSymbolicLink } from "./src/readSymbolicLink.js"
-export { registerDirectoryLifecycle } from "./src/registerDirectoryLifecycle.js"
-export { registerFileLifecycle } from "./src/registerFileLifecycle.js"
-export { removeEntry } from "./src/removeEntry.js"
-export { testEntryPermissions } from "./src/testEntryPermissions.js"
-export { writeDirectory } from "./src/writeDirectory.js"
-export { writeFile } from "./src/writeFile.js"
-export { writeFileSync } from "./src/writeFileSync.js"
-export { writeEntryModificationTime } from "./src/writeEntryModificationTime.js"
-export { writeEntryPermissions } from "./src/writeEntryPermissions.js"
-export { writeSymbolicLink } from "./src/writeSymbolicLink.js"

package/src/assertAndNormalizeDirectoryUrl.js

@@ -1,35 +0,0 @@
-import {
-  fileSystemPathToUrl,
-  isFileSystemPath,
-  ensurePathnameTrailingSlash,
-} from "@jsenv/urls"
-
-export const assertAndNormalizeDirectoryUrl = (value) => {
-  let urlString
-
-  if (value instanceof URL) {
-    urlString = value.href
-  } else if (typeof value === "string") {
-    if (isFileSystemPath(value)) {
-      urlString = fileSystemPathToUrl(value)
-    } else {
-      try {
-        urlString = String(new URL(value))
-      } catch (e) {
-        throw new TypeError(
-          `directoryUrl must be a valid url, received ${value}`,
-        )
-      }
-    }
-  } else {
-    throw new TypeError(
-      `directoryUrl must be a string or an url, received ${value}`,
-    )
-  }
-
-  if (!urlString.startsWith("file://")) {
-    throw new Error(`directoryUrl must starts with file://, received ${value}`)
-  }
-
-  return ensurePathnameTrailingSlash(urlString)
-}

package/src/assertAndNormalizeFileUrl.js

@@ -1,27 +0,0 @@
-import { fileSystemPathToUrl, isFileSystemPath } from "@jsenv/urls"
-
-export const assertAndNormalizeFileUrl = (value, baseUrl) => {
-  let urlString
-
-  if (value instanceof URL) {
-    urlString = value.href
-  } else if (typeof value === "string") {
-    if (isFileSystemPath(value)) {
-      urlString = fileSystemPathToUrl(value)
-    } else {
-      try {
-        urlString = String(new URL(value, baseUrl))
-      } catch (e) {
-        throw new TypeError(`fileUrl must be a valid url, received ${value}`)
-      }
-    }
-  } else {
-    throw new TypeError(`fileUrl must be a string or an url, received ${value}`)
-  }
-
-  if (!urlString.startsWith("file://")) {
-    throw new Error(`fileUrl must starts with file://, received ${value}`)
-  }
-
-  return urlString
-}