cspell-io 6.6.1 → 6.7.0

package/dist/CSpellIO.d.ts

@@ -2,12 +2,69 @@
 import type { Stats } from './models';
 import { BufferEncoding } from './models/BufferEncoding';
 import type { TextFileResource } from './models/FileResource';
+export declare type UrlOrFilename = string | URL;
 export interface CSpellIO {
-    readFile(uriOrFilename: string | URL, encoding?: BufferEncoding): Promise<TextFileResource>;
-    readFileSync(uriOrFilename: string | URL, encoding?: BufferEncoding): TextFileResource;
-    writeFile(uriOrFilename: string | URL, content: string): Promise<void>;
-    getStat(uriOrFilename: string | URL): Promise<Stats>;
-    getStatSync(uriOrFilename: string | URL): Stats;
+    /**
+     * Read a file
+     * @param uriOrFilename - uri of the file to read
+     * @param encoding - optional encoding.
+     * @returns A TextFileResource.
+     */
+    readFile(uriOrFilename: UrlOrFilename, encoding?: BufferEncoding): Promise<TextFileResource>;
+    /**
+     * Read a file in Sync mode.
+     * Note: `http` requests will fail.
+     * @param uriOrFilename - uri of the file to read
+     * @param encoding - optional encoding.
+     * @returns A TextFileResource.
+     */
+    readFileSync(uriOrFilename: UrlOrFilename, encoding?: BufferEncoding): TextFileResource;
+    /**
+     * Write content to a file using utf-8 encoding.
+     * It will fail to write to non-file uris.
+     * @param uriOrFilename - uri
+     * @param content - string to write.
+     */
+    writeFile(uriOrFilename: UrlOrFilename, content: string): Promise<void>;
+    /**
+     * Get Stats on a uri.
+     * @param uriOrFilename - uri to fetch stats on
+     * @returns Stats if successful.
+     */
+    getStat(uriOrFilename: UrlOrFilename): Promise<Stats>;
+    /**
+     * Get Stats on a uri.
+     * @param uriOrFilename - uri to fetch stats on
+     * @returns Stats if successful, otherwise it throws an error.
+     */
+    getStatSync(uriOrFilename: UrlOrFilename): Stats;
+    /**
+     * Compare two Stats.
+     * @param left - left stat
+     * @param right - right stat
+     * @returns 0 if they are equal and non-zero if they are not.
+     */
     compareStats(left: Stats, right: Stats): number;
+    /**
+     * Convert a string to a URL
+     * @param uriOrFilename - string or URL to convert.
+     *   If it is a URL, then it is just returned as is.
+     */
+    toURL(uriOrFilename: UrlOrFilename): URL;
+    /**
+     * Try to determine the base name of a URL.
+     *
+     * Note: this handles `data:` URLs with `filename` attribute:
+     *
+     * Example: `data:text/plain;charset=utf8;filename=hello.txt,Hello` would have a filename of `hello.txt`
+     * @param uriOrFilename - string or URL to extract the basename from.
+     */
+    uriBasename(uriOrFilename: UrlOrFilename): string;
+    /**
+     * Try to determine the directory URL of the uri.
+     *
+     * @param uriOrFilename - string or URL to extract the basename from.
+     */
+    uriDirname(uriOrFilename: UrlOrFilename): URL;
 }
 //# sourceMappingURL=CSpellIO.d.ts.map

package/dist/CSpellIONode.d.ts

@@ -13,6 +13,9 @@ export declare class CSpellIONode implements CSpellIO {
     getStat(uriOrFilename: string | URL): Promise<Stats>;
     getStatSync(uriOrFilename: string | URL): Stats;
     compareStats(left: Stats, right: Stats): number;
+    toURL(uriOrFilename: string | URL): URL;
+    uriBasename(uriOrFilename: string | URL): string;
+    uriDirname(uriOrFilename: string | URL): URL;
 }
 export declare function getDefaultCSpellIO(): CSpellIO;
 //# sourceMappingURL=CSpellIONode.d.ts.map

package/dist/CSpellIONode.js

@@ -56,6 +56,15 @@ class CSpellIONode {
     compareStats(left, right) {
         return (0, stat_1.compareStats)(left, right);
     }
+    toURL(uriOrFilename) {
+        return (0, util_1.toURL)(uriOrFilename);
+    }
+    uriBasename(uriOrFilename) {
+        return (0, util_1.urlBasename)(uriOrFilename);
+    }
+    uriDirname(uriOrFilename) {
+        return (0, util_1.urlDirname)(uriOrFilename);
+    }
 }
 exports.CSpellIONode = CSpellIONode;
 function genError(err, alt) {

package/dist/CSpellIOWeb.d.ts

@@ -9,5 +9,8 @@ export declare class CSpellIOWeb implements CSpellIO {
     getStat(_uriOrFilename: string | URL): Promise<Stats>;
     getStatSync(_uriOrFilename: string | URL): Stats;
     compareStats(left: Stats, right: Stats): number;
+    toURL(_uriOrFilename: string | URL): URL;
+    uriBasename(_uriOrFilename: string | URL): string;
+    uriDirname(_uriOrFilename: string | URL): URL;
 }
 //# sourceMappingURL=CSpellIOWeb.d.ts.map

package/dist/CSpellIOWeb.js

@@ -22,6 +22,15 @@ class CSpellIOWeb {
     compareStats(left, right) {
         return (0, stat_1.compareStats)(left, right);
     }
+    toURL(_uriOrFilename) {
+        throw new ErrorNotImplemented_1.ErrorNotImplemented('toURL');
+    }
+    uriBasename(_uriOrFilename) {
+        throw new ErrorNotImplemented_1.ErrorNotImplemented('uriBasename');
+    }
+    uriDirname(_uriOrFilename) {
+        throw new ErrorNotImplemented_1.ErrorNotImplemented('uriDirname');
+    }
 }
 exports.CSpellIOWeb = CSpellIOWeb;
 //# sourceMappingURL=CSpellIOWeb.js.map

package/dist/file/file.js

@@ -14,9 +14,7 @@ const readFileSync = function (filename, encoding) {
 };
 exports.readFileSync = readFileSync;
 const getStat = function (filenameOrUri) {
-    return (0, CSpellIONode_1.getDefaultCSpellIO)()
-        .getStat(filenameOrUri)
-        .catch((e) => (0, errors_1.toError)(e));
+    return (0, CSpellIONode_1.getDefaultCSpellIO)().getStat(filenameOrUri).catch(errors_1.toError);
 };
 exports.getStat = getStat;
 const getStatSync = function (filenameOrUri) {

package/dist/handlers/node/file.js

@@ -83,7 +83,7 @@ const handleRequestFsReadBinaryFileSyncData = requests_1.RequestFsReadBinaryFile
         return next(req);
     const data = (0, dataUrl_1.decodeDataUrl)(url);
     return (0, cspell_service_bus_1.createResponse)({ url, content: data.data, baseFilename: data.attributes.get('filename') });
-}, undefined, 'Node: Read Http(s) file.');
+}, undefined, 'Node: Read data: urls.');
 /**
  * Handle decoding a data url
  */
@@ -95,7 +95,7 @@ const handleRequestFsReadBinaryFileData = requests_1.RequestFsReadBinaryFile.cre
     if (!(0, cspell_service_bus_1.isServiceResponseSuccess)(res))
         return res;
     return (0, cspell_service_bus_1.createResponse)(Promise.resolve(res.value));
-}, undefined, 'Node: Read Http(s) file.');
+}, undefined, 'Node: Read data: urls.');
 function bufferToText(buf, encoding) {
     return buf[0] === 0x1f && buf[1] === 0x8b ? bufferToText((0, zlib_1.gunzipSync)(buf), encoding) : buf.toString(encoding);
 }

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export { toArray as asyncIterableToArray } from './async/asyncIterable';
-export { getStat, getStatSync, readFile, readFileSync, writeToFile, writeToFileIterable, writeToFileIterableP, } from './file';
-export type { Stats } from './models/Stats';
 export type { CSpellIO } from './CSpellIO';
 export { CSpellIONode } from './CSpellIONode';
+export { getStat, getStatSync, readFile, readFileSync, writeToFile, writeToFileIterable, writeToFileIterableP, } from './file';
+export type { Stats } from './models/Stats';
 export { encodeDataUrl, toDataUrl } from './node/dataUrl';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toDataUrl = exports.encodeDataUrl = exports.CSpellIONode = exports.writeToFileIterableP = exports.writeToFileIterable = exports.writeToFile = exports.readFileSync = exports.readFile = exports.getStatSync = exports.getStat = exports.asyncIterableToArray = void 0;
+exports.toDataUrl = exports.encodeDataUrl = exports.writeToFileIterableP = exports.writeToFileIterable = exports.writeToFile = exports.readFileSync = exports.readFile = exports.getStatSync = exports.getStat = exports.CSpellIONode = exports.asyncIterableToArray = void 0;
 var asyncIterable_1 = require("./async/asyncIterable");
 Object.defineProperty(exports, "asyncIterableToArray", { enumerable: true, get: function () { return asyncIterable_1.toArray; } });
+var CSpellIONode_1 = require("./CSpellIONode");
+Object.defineProperty(exports, "CSpellIONode", { enumerable: true, get: function () { return CSpellIONode_1.CSpellIONode; } });
 var file_1 = require("./file");
 Object.defineProperty(exports, "getStat", { enumerable: true, get: function () { return file_1.getStat; } });
 Object.defineProperty(exports, "getStatSync", { enumerable: true, get: function () { return file_1.getStatSync; } });
@@ -11,8 +13,6 @@ Object.defineProperty(exports, "readFileSync", { enumerable: true, get: function
 Object.defineProperty(exports, "writeToFile", { enumerable: true, get: function () { return file_1.writeToFile; } });
 Object.defineProperty(exports, "writeToFileIterable", { enumerable: true, get: function () { return file_1.writeToFileIterable; } });
 Object.defineProperty(exports, "writeToFileIterableP", { enumerable: true, get: function () { return file_1.writeToFileIterableP; } });
-var CSpellIONode_1 = require("./CSpellIONode");
-Object.defineProperty(exports, "CSpellIONode", { enumerable: true, get: function () { return CSpellIONode_1.CSpellIONode; } });
 var dataUrl_1 = require("./node/dataUrl");
 Object.defineProperty(exports, "encodeDataUrl", { enumerable: true, get: function () { return dataUrl_1.encodeDataUrl; } });
 Object.defineProperty(exports, "toDataUrl", { enumerable: true, get: function () { return dataUrl_1.toDataUrl; } });

package/dist/node/file/util.d.ts

@@ -4,4 +4,7 @@ export declare function isUrlLike(filename: string | URL): boolean;
 export declare function isSupportedURL(url: URL): boolean;
 export declare function isFileURL(url: URL): boolean;
 export declare function toURL(filename: string | URL): URL;
+export declare function urlBasename(url: string | URL): string;
+export declare function urlDirname(url: string | URL): URL;
+export declare function basename(path: string): string;
 //# sourceMappingURL=util.d.ts.map

package/dist/node/file/util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toURL = exports.isFileURL = exports.isSupportedURL = exports.isUrlLike = exports.isZipped = void 0;
+exports.basename = exports.urlDirname = exports.urlBasename = exports.toURL = exports.isFileURL = exports.isSupportedURL = exports.isUrlLike = exports.isZipped = void 0;
 const url_1 = require("url");
 const isZippedRegExp = /\.gz($|[?#])/i;
 const isURLRegExp = /^(\w{2,64}:\/\/|data:)/i;
@@ -30,4 +30,40 @@ function toURL(filename) {
             : (0, url_1.pathToFileURL)(filename);
 }
 exports.toURL = toURL;
+const regMatchFilename = /filename=([^;,]*)/;
+function urlBasename(url) {
+    function guessDataUrlName(header) {
+        const filenameMatch = header.match(regMatchFilename);
+        if (filenameMatch)
+            return filenameMatch[1];
+        const mime = header.split(';', 1)[0];
+        return mime.replace(/\W/g, '.');
+    }
+    if (typeof url === 'string' && url.startsWith('data:')) {
+        return guessDataUrlName(url.split(',', 1)[0].split(':', 2)[1]);
+    }
+    url = toURL(url);
+    if (url.protocol === 'data:') {
+        return guessDataUrlName(url.pathname.split(',', 1)[0]);
+    }
+    return basename(url.pathname);
+}
+exports.urlBasename = urlBasename;
+function urlDirname(url) {
+    if (typeof url === 'string' && url.startsWith('data:')) {
+        return toURL('data:');
+    }
+    url = toURL(url);
+    if (url.protocol === 'data:') {
+        return toURL('data:');
+    }
+    return new URL(url.pathname.endsWith('/') ? '..' : '.', url);
+}
+exports.urlDirname = urlDirname;
+function basename(path) {
+    path = path.endsWith('/') ? path.slice(0, path.length - 1) : path;
+    const idx = path.lastIndexOf('/');
+    return idx >= 0 ? path.slice(idx + 1) || '' : path;
+}
+exports.basename = basename;
 //# sourceMappingURL=util.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-io",
-  "version": "6.6.1",
+  "version": "6.7.0",
   "description": "A library of useful I/O functions used across various cspell tools.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -39,16 +39,16 @@
   },
   "devDependencies": {
     "@types/fs-extra": "^9.0.13",
-    "@types/node": "^18.6.5",
+    "@types/node": "^18.7.6",
     "fs-extra": "^10.1.0",
     "jest": "^28.1.3",
     "lorem-ipsum": "^2.0.8",
     "rimraf": "^3.0.2"
   },
   "dependencies": {
-    "@cspell/cspell-service-bus": "^6.6.1",
+    "@cspell/cspell-service-bus": "^6.7.0",
     "@types/node-fetch": "^2.6.2",
     "node-fetch": "^2.6.7"
   },
-  "gitHead": "3c9c24d1cebd558ac3729d3fbf441e6ed751d8cf"
+  "gitHead": "3a7312a15d2df1507d9e01863ec5842f5a99e0cc"
 }