@zukhruf/fs 0.3.25 → 0.3.26

package/README.md

@@ -66,9 +66,8 @@ await createExclusive(join('/var/lib/app/locks', `${name}.lock`), 'pid 4242');
 ```
 
 - A key that fits gets its URI encoding, with each `.` as `%2E`. Thus a name is never `.` or `..`. The name of `job.lock` is `job%2Elock`, so it is never the name of `job` plus the suffix `.lock`.
+- The encoding also encodes each uppercase letter. The names of `Sync`, `sync` and `SYNC` are `%53ync`, `sync` and `%53%59%4E%43`. APFS and NTFS compare file names without case. On these file systems too, each key gets its own file, as on Linux.
 - A key that does not fit, or that is not well-formed Unicode, gets a hashed name: the first 32 characters of its encoding, `%%`, and the SHA-256 of its UTF-16 code units in hex. A hashed name has at most 98 characters. An encoding never holds `%%`, so a hashed name is never the name of a key that fits.
-- The rule does not change between versions. Processes of two versions find the same file for a key.
-- On a case-insensitive file system, keys that differ only by case get one file.
 
 ## Try again while Windows refuses a file for a moment
 

package/dist/safe-file-name.d.ts

@@ -1,17 +1,18 @@
 /**
  * Maps any key to a single path segment that still fits a file name after the
- * caller adds up to `longestSuffix` characters. Encoding every dot means a key
- * can never be `.` or `..`, and suffixes such as `.lock` can never collide with
- * a key. On a case-insensitive file system, keys that differ only by case share
- * a name and so one file. A lock file then guards more keys than it must, but
- * never fewer.
+ * caller adds up to `longestSuffix` characters. The name is the URI encoding of
+ * the key, with each dot and each uppercase letter encoded too. A name thus has
+ * no dot: a key can never be `.` or `..`, and a suffix such as `.lock` can never
+ * make the name of another key. A name is ASCII, and it has no uppercase letter
+ * outside an escape, whose hex digits are always uppercase. Thus two keys never
+ * get names that are equal without case. APFS and NTFS compare file names
+ * without case, and there too each key gets its own file, as on Linux.
  *
  * A key whose encoding does not fit, or that is not well-formed Unicode and so
  * has no encoding, gets the start of its encoding, `%%`, and the SHA-256 of its
- * UTF-16 code units. A key that fits keeps the name earlier versions gave it, so
- * processes of two versions share its file. No encoding contains `%%`, so the
- * two kinds of name never meet; the digest is hex, whose one case cannot fold
- * two digests into one name; and the code units keep lone surrogates apart.
+ * UTF-16 code units. No encoding contains `%%`, so the two kinds of name never
+ * meet; the digest is lowercase hex, so case cannot fold two digests into one
+ * name; and the code units keep lone surrogates apart.
  */
 export declare function safeFileName(key: string, longestSuffix: number): string;
 //# sourceMappingURL=safe-file-name.d.ts.map

package/dist/safe-file-name.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"safe-file-name.d.ts","sourceRoot":"","sources":["../src/safe-file-name.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM,CAYvE"}
+{"version":3,"file":"safe-file-name.d.ts","sourceRoot":"","sources":["../src/safe-file-name.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM,CAYvE"}

package/dist/safe-file-name.js

@@ -5,18 +5,19 @@ const longestFileName = 255;
 const visibleStart = 32;
 /**
  * Maps any key to a single path segment that still fits a file name after the
- * caller adds up to `longestSuffix` characters. Encoding every dot means a key
- * can never be `.` or `..`, and suffixes such as `.lock` can never collide with
- * a key. On a case-insensitive file system, keys that differ only by case share
- * a name and so one file. A lock file then guards more keys than it must, but
- * never fewer.
+ * caller adds up to `longestSuffix` characters. The name is the URI encoding of
+ * the key, with each dot and each uppercase letter encoded too. A name thus has
+ * no dot: a key can never be `.` or `..`, and a suffix such as `.lock` can never
+ * make the name of another key. A name is ASCII, and it has no uppercase letter
+ * outside an escape, whose hex digits are always uppercase. Thus two keys never
+ * get names that are equal without case. APFS and NTFS compare file names
+ * without case, and there too each key gets its own file, as on Linux.
  *
  * A key whose encoding does not fit, or that is not well-formed Unicode and so
  * has no encoding, gets the start of its encoding, `%%`, and the SHA-256 of its
- * UTF-16 code units. A key that fits keeps the name earlier versions gave it, so
- * processes of two versions share its file. No encoding contains `%%`, so the
- * two kinds of name never meet; the digest is hex, whose one case cannot fold
- * two digests into one name; and the code units keep lone surrogates apart.
+ * UTF-16 code units. No encoding contains `%%`, so the two kinds of name never
+ * meet; the digest is lowercase hex, so case cannot fold two digests into one
+ * name; and the code units keep lone surrogates apart.
  */
 export function safeFileName(key, longestSuffix) {
     if (key.isWellFormed()) {
@@ -33,6 +34,8 @@ export function safeFileName(key, longestSuffix) {
     return `${start}%%${digest}`;
 }
 function encode(key) {
-    return encodeURIComponent(key).replaceAll('.', '%2E');
+    return encodeURIComponent(key).replaceAll(/%[0-9A-F]{2}|[.A-Z]/g, (match) => match.length === 1
+        ? `%${match.charCodeAt(0).toString(16).toUpperCase()}`
+        : match);
 }
 //# sourceMappingURL=safe-file-name.js.map

package/dist/safe-file-name.js.map

@@ -1 +1 @@
-{"version":3,"file":"safe-file-name.js","sourceRoot":"","sources":["../src/safe-file-name.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,oEAAoE;AACpE,MAAM,eAAe,GAAG,GAAG,CAAC;AAE5B,2EAA2E;AAC3E,MAAM,YAAY,GAAG,EAAE,CAAC;AAExB;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW,EAAE,aAAqB;IAC7D,IAAI,GAAG,CAAC,YAAY,EAAE,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,OAAO,CAAC,MAAM,GAAG,aAAa,IAAI,eAAe;YAAE,OAAO,OAAO,CAAC;IACxE,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC;SACrC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC;SACtB,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IAC9B,MAAM,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC;SAChC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;SACnC,MAAM,CAAC,KAAK,CAAC,CAAC;IACjB,OAAO,GAAG,KAAK,KAAK,MAAM,EAAE,CAAC;AAC/B,CAAC;AAED,SAAS,MAAM,CAAC,GAAW;IACzB,OAAO,kBAAkB,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACxD,CAAC"}
+{"version":3,"file":"safe-file-name.js","sourceRoot":"","sources":["../src/safe-file-name.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,oEAAoE;AACpE,MAAM,eAAe,GAAG,GAAG,CAAC;AAE5B,2EAA2E;AAC3E,MAAM,YAAY,GAAG,EAAE,CAAC;AAExB;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW,EAAE,aAAqB;IAC7D,IAAI,GAAG,CAAC,YAAY,EAAE,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,OAAO,CAAC,MAAM,GAAG,aAAa,IAAI,eAAe;YAAE,OAAO,OAAO,CAAC;IACxE,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC;SACrC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC;SACtB,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IAC9B,MAAM,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC;SAChC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;SACnC,MAAM,CAAC,KAAK,CAAC,CAAC;IACjB,OAAO,GAAG,KAAK,KAAK,MAAM,EAAE,CAAC;AAC/B,CAAC;AAED,SAAS,MAAM,CAAC,GAAW;IACzB,OAAO,kBAAkB,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,sBAAsB,EAAE,CAAC,KAAK,EAAE,EAAE,CAC1E,KAAK,CAAC,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,EAAE;QACtD,CAAC,CAAC,KAAK,CACV,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zukhruf/fs",
-  "version": "0.3.25",
+  "version": "0.3.26",
   "description": "File writes that a reader never sees half done: replace a file in one step, with or without a sync to the disk, or create it only when it is absent. A lock on a file that the kernel frees when its holder dies. Also retries the short refusals of Windows, and names a file after any key.",
   "license": "MIT",
   "repository": {