cspell-io 6.5.0 → 6.6.0

package/dist/CSpellIO.d.ts

@@ -1,11 +1,13 @@
-import { BufferEncoding } from './models/BufferEncoding';
+/// <reference types="node" />
 import type { Stats } from './models';
+import { BufferEncoding } from './models/BufferEncoding';
+import type { TextFileResource } from './models/FileResource';
 export interface CSpellIO {
-    readFile(uriOrFilename: string, encoding?: BufferEncoding): Promise<string>;
-    readFileSync(uriOrFilename: string, encoding?: BufferEncoding): string;
-    writeFile(uriOrFilename: string, content: string): Promise<void>;
-    getStat(uriOrFilename: string): Promise<Stats>;
-    getStatSync(uriOrFilename: string): Stats;
+    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;
     compareStats(left: Stats, right: Stats): number;
 }
 //# sourceMappingURL=CSpellIO.d.ts.map

package/dist/CSpellIONode.d.ts

@@ -1,15 +1,18 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { ServiceBus } from '@cspell/cspell-service-bus';
 import { CSpellIO } from './CSpellIO';
-import { Stats } from './models/Stats';
+import type { TextFileResource } from './models/FileResource';
+import type { Stats } from './models/Stats';
 export declare class CSpellIONode implements CSpellIO {
     readonly serviceBus: ServiceBus;
     constructor(serviceBus?: ServiceBus);
-    readFile(uriOrFilename: string, encoding?: BufferEncoding): Promise<string>;
-    readFileSync(uriOrFilename: string, encoding?: BufferEncoding): string;
-    writeFile(uriOrFilename: string, content: string): Promise<void>;
-    getStat(uriOrFilename: string): Promise<Stats>;
-    getStatSync(uriOrFilename: string): Stats;
+    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;
     compareStats(left: Stats, right: Stats): number;
 }
+export declare function getDefaultCSpellIO(): CSpellIO;
 //# sourceMappingURL=CSpellIONode.d.ts.map

package/dist/CSpellIONode.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CSpellIONode = void 0;
+exports.getDefaultCSpellIO = exports.CSpellIONode = void 0;
 const cspell_service_bus_1 = require("@cspell/cspell-service-bus");
 const stat_1 = require("./common/stat");
 const ErrorNotImplemented_1 = require("./errors/ErrorNotImplemented");
 const file_1 = require("./handlers/node/file");
 const util_1 = require("./node/file/util");
 const requests_1 = require("./requests");
+let defaultCSpellIONode = undefined;
 class CSpellIONode {
     constructor(serviceBus = new cspell_service_bus_1.ServiceBus()) {
         this.serviceBus = serviceBus;
@@ -60,4 +61,12 @@ exports.CSpellIONode = CSpellIONode;
 function genError(err, alt) {
     return err || new ErrorNotImplemented_1.ErrorNotImplemented(alt);
 }
+function getDefaultCSpellIO() {
+    if (defaultCSpellIONode)
+        return defaultCSpellIONode;
+    const cspellIO = new CSpellIONode();
+    defaultCSpellIONode = cspellIO;
+    return cspellIO;
+}
+exports.getDefaultCSpellIO = getDefaultCSpellIO;
 //# sourceMappingURL=CSpellIONode.js.map

package/dist/CSpellIOWeb.d.ts

@@ -1,11 +1,13 @@
+/// <reference types="node" />
 import { CSpellIO } from './CSpellIO';
-import { Stats } from './models/Stats';
+import type { Stats } from './models/Stats';
+import type { TextFileResource } from './models/FileResource';
 export declare class CSpellIOWeb implements CSpellIO {
-    readFile(_uriOrFilename: string): Promise<string>;
-    readFileSync(_uriOrFilename: string): string;
-    writeFile(_uriOrFilename: string, _content: string): Promise<void>;
-    getStat(_uriOrFilename: string): Promise<Stats>;
-    getStatSync(_uriOrFilename: string): Stats;
+    readFile(_uriOrFilename: string | URL): Promise<TextFileResource>;
+    readFileSync(_uriOrFilename: string | URL): TextFileResource;
+    writeFile(_uriOrFilename: string | URL, _content: string): Promise<void>;
+    getStat(_uriOrFilename: string | URL): Promise<Stats>;
+    getStatSync(_uriOrFilename: string | URL): Stats;
     compareStats(left: Stats, right: Stats): number;
 }
 //# sourceMappingURL=CSpellIOWeb.d.ts.map

package/dist/file/file.d.ts

@@ -0,0 +1,6 @@
+import type { getStat as GetStatFn, getStatSync as GetStatSyncFn, readFile as ReadFileFn, readFileSync as ReadFileSyncFn } from '../node/file';
+export declare const readFile: typeof ReadFileFn;
+export declare const readFileSync: typeof ReadFileSyncFn;
+export declare const getStat: typeof GetStatFn;
+export declare const getStatSync: typeof GetStatSyncFn;
+//# sourceMappingURL=file.d.ts.map

package/dist/file/file.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStatSync = exports.getStat = exports.readFileSync = exports.readFile = void 0;
+const CSpellIONode_1 = require("../CSpellIONode");
+const errors_1 = require("../errors");
+const readFile = function (filename, encoding) {
+    return (0, CSpellIONode_1.getDefaultCSpellIO)()
+        .readFile(filename, encoding)
+        .then((fr) => fr.content);
+};
+exports.readFile = readFile;
+const readFileSync = function (filename, encoding) {
+    return (0, CSpellIONode_1.getDefaultCSpellIO)().readFileSync(filename, encoding).content;
+};
+exports.readFileSync = readFileSync;
+const getStat = function (filenameOrUri) {
+    return (0, CSpellIONode_1.getDefaultCSpellIO)()
+        .getStat(filenameOrUri)
+        .catch((e) => (0, errors_1.toError)(e));
+};
+exports.getStat = getStat;
+const getStatSync = function (filenameOrUri) {
+    try {
+        return (0, CSpellIONode_1.getDefaultCSpellIO)().getStatSync(filenameOrUri);
+    }
+    catch (e) {
+        return (0, errors_1.toError)(e);
+    }
+};
+exports.getStatSync = getStatSync;
+//# sourceMappingURL=file.js.map

package/dist/file/index.d.ts

@@ -1,4 +1,3 @@
-export { readFile, readFileSync } from './../node/file';
 export { writeToFile, writeToFileIterable, writeToFileIterableP } from './../node/file';
-export { getStat, getStatSync } from './../node/file';
+export { getStat, getStatSync, readFile, readFileSync } from './file';
 //# sourceMappingURL=index.d.ts.map

package/dist/file/index.js

@@ -1,14 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStatSync = exports.getStat = exports.writeToFileIterableP = exports.writeToFileIterable = exports.writeToFile = exports.readFileSync = exports.readFile = void 0;
+exports.readFileSync = exports.readFile = exports.getStatSync = exports.getStat = exports.writeToFileIterableP = exports.writeToFileIterable = exports.writeToFile = void 0;
 var file_1 = require("./../node/file");
-Object.defineProperty(exports, "readFile", { enumerable: true, get: function () { return file_1.readFile; } });
-Object.defineProperty(exports, "readFileSync", { enumerable: true, get: function () { return file_1.readFileSync; } });
-var file_2 = require("./../node/file");
-Object.defineProperty(exports, "writeToFile", { enumerable: true, get: function () { return file_2.writeToFile; } });
-Object.defineProperty(exports, "writeToFileIterable", { enumerable: true, get: function () { return file_2.writeToFileIterable; } });
-Object.defineProperty(exports, "writeToFileIterableP", { enumerable: true, get: function () { return file_2.writeToFileIterableP; } });
-var file_3 = require("./../node/file");
-Object.defineProperty(exports, "getStat", { enumerable: true, get: function () { return file_3.getStat; } });
-Object.defineProperty(exports, "getStatSync", { enumerable: true, get: function () { return file_3.getStatSync; } });
+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 file_2 = require("./file");
+Object.defineProperty(exports, "getStat", { enumerable: true, get: function () { return file_2.getStat; } });
+Object.defineProperty(exports, "getStatSync", { enumerable: true, get: function () { return file_2.getStatSync; } });
+Object.defineProperty(exports, "readFile", { enumerable: true, get: function () { return file_2.readFile; } });
+Object.defineProperty(exports, "readFileSync", { enumerable: true, get: function () { return file_2.readFileSync; } });
 //# sourceMappingURL=index.js.map

package/dist/handlers/node/file.js

@@ -9,58 +9,92 @@ const assert_1 = __importDefault(require("assert"));
 const fs_1 = require("fs");
 const zlib_1 = require("zlib");
 const errors_1 = require("../../errors");
+const dataUrl_1 = require("../../node/dataUrl");
 const fetch_1 = require("../../node/file/fetch");
 const stat_1 = require("../../node/file/stat");
 const requests_1 = require("../../requests");
+const url_1 = require("url");
 const isGzFileRegExp = /\.gz($|[?#])/;
 function isGzFile(url) {
     return isGzFileRegExp.test(url.pathname);
 }
+/*
+ * NOTE: fileURLToPath is used because of yarn bug https://github.com/yarnpkg/berry/issues/899
+ */
 /**
  * Handle Binary File Reads
  */
-const handleRequestFsReadBinaryFile = (0, cspell_service_bus_1.createRequestHandler)(requests_1.RequestFsReadBinaryFile, ({ params }) => (0, cspell_service_bus_1.createResponse)(fs_1.promises.readFile(params.url)), undefined, 'Node: Read Binary File.');
+const handleRequestFsReadBinaryFile = requests_1.RequestFsReadBinaryFile.createRequestHandler(({ params }) => (0, cspell_service_bus_1.createResponse)(fs_1.promises.readFile((0, url_1.fileURLToPath)(params.url)).then((content) => ({ url: params.url, content }))), undefined, 'Node: Read Binary File.');
 /**
  * Handle Binary File Sync Reads
  */
-const handleRequestFsReadBinaryFileSync = (0, cspell_service_bus_1.createRequestHandler)(requests_1.RequestFsReadBinaryFileSync, ({ params }) => (0, cspell_service_bus_1.createResponse)((0, fs_1.readFileSync)(params.url)), undefined, 'Node: Sync Read Binary File.');
+const handleRequestFsReadBinaryFileSync = requests_1.RequestFsReadBinaryFileSync.createRequestHandler(({ params }) => (0, cspell_service_bus_1.createResponse)({ url: params.url, content: (0, fs_1.readFileSync)((0, url_1.fileURLToPath)(params.url)) }), undefined, 'Node: Sync Read Binary File.');
 /**
  * Handle UTF-8 Text File Reads
  */
-const handleRequestFsReadFile = (0, cspell_service_bus_1.createRequestHandler)(requests_1.RequestFsReadFile, (req, _, dispatcher) => {
+const handleRequestFsReadFile = requests_1.RequestFsReadFile.createRequestHandler((req, _, dispatcher) => {
     const { url, encoding } = req.params;
     const res = dispatcher.dispatch(requests_1.RequestFsReadBinaryFile.create({ url }));
     if (!(0, cspell_service_bus_1.isServiceResponseSuccess)(res)) {
         (0, assert_1.default)((0, cspell_service_bus_1.isServiceResponseFailure)(res));
         return (0, cspell_service_bus_1.createResponseFail)(req, res.error);
     }
-    return (0, cspell_service_bus_1.createResponse)(res.value.then((buf) => bufferToText(buf, encoding)));
+    return (0, cspell_service_bus_1.createResponse)(res.value.then((res) => ({
+        url,
+        content: bufferToText(res.content, encoding),
+        baseFilename: res.baseFilename,
+    })));
 }, undefined, 'Node: Read Text File.');
 /**
  * Handle UTF-8 Text File Reads
  */
-const handleRequestFsReadFileSync = (0, cspell_service_bus_1.createRequestHandler)(requests_1.RequestFsReadFileSync, (req, _, dispatcher) => {
+const handleRequestFsReadFileSync = requests_1.RequestFsReadFileSync.createRequestHandler((req, _, dispatcher) => {
     const { url, encoding } = req.params;
     const res = dispatcher.dispatch(requests_1.RequestFsReadBinaryFileSync.create({ url }));
     if (!(0, cspell_service_bus_1.isServiceResponseSuccess)(res)) {
         (0, assert_1.default)((0, cspell_service_bus_1.isServiceResponseFailure)(res));
         return (0, cspell_service_bus_1.createResponseFail)(req, res.error);
     }
-    return (0, cspell_service_bus_1.createResponse)(bufferToText(res.value, encoding));
+    return (0, cspell_service_bus_1.createResponse)({
+        ...res.value,
+        content: bufferToText(res.value.content, encoding),
+    });
 }, undefined, 'Node: Sync Read Text File.');
 /**
  * Handle deflating gzip data
  */
-const handleRequestZlibInflate = (0, cspell_service_bus_1.createRequestHandler)(requests_1.RequestZlibInflate, ({ params }) => (0, cspell_service_bus_1.createResponse)((0, zlib_1.gunzipSync)(params.data).toString('utf-8')), undefined, 'Node: gz deflate.');
+const handleRequestZlibInflate = requests_1.RequestZlibInflate.createRequestHandler(({ params }) => (0, cspell_service_bus_1.createResponse)((0, zlib_1.gunzipSync)(params.data).toString('utf-8')), undefined, 'Node: gz deflate.');
 const supportedFetchProtocols = { 'http:': true, 'https:': true };
 /**
- * Handle reading gzip'ed text files.
+ * Handle fetching a file from http
  */
-const handleRequestFsReadBinaryFileHttp = (0, cspell_service_bus_1.createRequestHandler)(requests_1.RequestFsReadBinaryFile, (req, next) => {
+const handleRequestFsReadBinaryFileHttp = requests_1.RequestFsReadBinaryFile.createRequestHandler((req, next) => {
     const { url } = req.params;
     if (!(url.protocol in supportedFetchProtocols))
         return next(req);
-    return (0, cspell_service_bus_1.createResponse)((0, fetch_1.fetchURL)(url));
+    return (0, cspell_service_bus_1.createResponse)((0, fetch_1.fetchURL)(url).then((content) => ({ url, content })));
+}, undefined, 'Node: Read Http(s) file.');
+/**
+ * Handle decoding a data url
+ */
+const handleRequestFsReadBinaryFileSyncData = requests_1.RequestFsReadBinaryFileSync.createRequestHandler((req, next) => {
+    const { url } = req.params;
+    if (url.protocol !== 'data:')
+        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.');
+/**
+ * Handle decoding a data url
+ */
+const handleRequestFsReadBinaryFileData = requests_1.RequestFsReadBinaryFile.createRequestHandler((req, next, dispatcher) => {
+    const { url } = req.params;
+    if (url.protocol !== 'data:')
+        return next(req);
+    const res = dispatcher.dispatch(requests_1.RequestFsReadBinaryFileSync.create(req.params));
+    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.');
 function bufferToText(buf, encoding) {
     return buf[0] === 0x1f && buf[1] === 0x8b ? bufferToText((0, zlib_1.gunzipSync)(buf), encoding) : buf.toString(encoding);
@@ -68,14 +102,14 @@ function bufferToText(buf, encoding) {
 /**
  * Handle fs:stat
  */
-const handleRequestFsStat = (0, cspell_service_bus_1.createRequestHandler)(requests_1.RequestFsStat, ({ params }) => (0, cspell_service_bus_1.createResponse)(fs_1.promises.stat(params.url)), undefined, 'Node: fs.stat.');
+const handleRequestFsStat = requests_1.RequestFsStat.createRequestHandler(({ params }) => (0, cspell_service_bus_1.createResponse)(fs_1.promises.stat((0, url_1.fileURLToPath)(params.url))), undefined, 'Node: fs.stat.');
 /**
  * Handle fs:statSync
  */
-const handleRequestFsStatSync = (0, cspell_service_bus_1.createRequestHandler)(requests_1.RequestFsStatSync, (req) => {
+const handleRequestFsStatSync = requests_1.RequestFsStatSync.createRequestHandler((req) => {
     const { params } = req;
     try {
-        return (0, cspell_service_bus_1.createResponse)((0, fs_1.statSync)(params.url));
+        return (0, cspell_service_bus_1.createResponse)((0, fs_1.statSync)((0, url_1.fileURLToPath)(params.url)));
     }
     catch (e) {
         return (0, cspell_service_bus_1.createResponseFail)(req, (0, errors_1.toError)(e));
@@ -84,7 +118,7 @@ const handleRequestFsStatSync = (0, cspell_service_bus_1.createRequestHandler)(r
 /**
  * Handle deflating gzip data
  */
-const handleRequestFsStatHttp = (0, cspell_service_bus_1.createRequestHandler)(requests_1.RequestFsStat, (req, next) => {
+const handleRequestFsStatHttp = requests_1.RequestFsStat.createRequestHandler((req, next) => {
     const { url } = req.params;
     if (!(url.protocol in supportedFetchProtocols))
         return next(req);
@@ -93,11 +127,11 @@ const handleRequestFsStatHttp = (0, cspell_service_bus_1.createRequestHandler)(r
 /**
  * Handle fs:writeFile
  */
-const handleRequestFsWriteFile = (0, cspell_service_bus_1.createRequestHandler)(requests_1.RequestFsWriteFile, ({ params }) => (0, cspell_service_bus_1.createResponse)(fs_1.promises.writeFile(params.url, params.content)), undefined, 'Node: fs.writeFile');
+const handleRequestFsWriteFile = requests_1.RequestFsWriteFile.createRequestHandler(({ params }) => (0, cspell_service_bus_1.createResponse)(fs_1.promises.writeFile(params.url, params.content)), undefined, 'Node: fs.writeFile');
 /**
  * Handle fs:writeFile compressed
  */
-const handleRequestFsWriteFileGz = (0, cspell_service_bus_1.createRequestHandler)(requests_1.RequestFsWriteFile, (req, next) => {
+const handleRequestFsWriteFileGz = requests_1.RequestFsWriteFile.createRequestHandler((req, next) => {
     const { url, content } = req.params;
     if (!isGzFile(url))
         return next(req);
@@ -114,6 +148,8 @@ function registerHandlers(serviceBus) {
         handleRequestFsReadBinaryFile,
         handleRequestFsReadBinaryFileSync,
         handleRequestFsReadBinaryFileHttp,
+        handleRequestFsReadBinaryFileData,
+        handleRequestFsReadBinaryFileSyncData,
         handleRequestFsReadFile,
         handleRequestFsReadFileSync,
         handleRequestZlibInflate,

package/dist/models/BufferEncoding.d.ts

@@ -1,2 +1,2 @@
-export declare type BufferEncoding = 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'base64url' | 'latin1' | 'hex';
+export declare type BufferEncoding = 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'base64url' | 'binary' | 'latin1' | 'hex';
 //# sourceMappingURL=BufferEncoding.d.ts.map

package/dist/models/FileResource.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="node" />
+/// <reference types="node" />
+export interface FileResource {
+    /**
+     * The URL of the File
+     */
+    url: URL;
+    /**
+     * The contents of the file
+     */
+    content: string | Buffer;
+    /**
+     * The filename of the file if known.
+     * Useful for `data:` urls.
+     */
+    baseFilename?: string | undefined;
+}
+export interface TextFileResource extends FileResource {
+    content: string;
+}
+export interface BinaryFileResource extends FileResource {
+    content: Buffer;
+}
+//# sourceMappingURL=FileResource.d.ts.map

package/dist/models/FileResource.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=FileResource.js.map

package/dist/node/dataUrl.d.ts

@@ -18,5 +18,11 @@ export interface DecodedDataUrl {
     encoding?: string | undefined;
     attributes: Map<string, string>;
 }
-export declare function decodeDataUrl(url: string): DecodedDataUrl;
+export declare function decodeDataUrl(url: string | URL): DecodedDataUrl;
+export declare function encodeDataUrlFromFile(path: string | URL, mediaType?: string, attributes?: Iterable<readonly [string, string]> | undefined): Promise<string>;
+export interface GuessMimeTypeResult {
+    mimeType: string;
+    encoding?: 'utf-8' | undefined;
+}
+export declare function guessMimeType(filename: string): GuessMimeTypeResult | undefined;
 //# sourceMappingURL=dataUrl.d.ts.map

package/dist/node/dataUrl.js

@@ -1,6 +1,32 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.decodeDataUrl = exports.toDataUrl = exports.encodeDataUrl = void 0;
+exports.guessMimeType = exports.encodeDataUrlFromFile = exports.decodeDataUrl = exports.toDataUrl = exports.encodeDataUrl = void 0;
+const fsPath = __importStar(require("path"));
+const util_1 = require("./file/util");
+const fs_1 = require("fs");
 /**
  * Generates a string of the following format:
  *
@@ -40,6 +66,7 @@ function encodeAttributes(attributes) {
 }
 const dataUrlRegExHead = /^data:(?<mediaType>[^;,]*)(?<attributes>(?:;[^=]+=[^;,]*)*)(?<base64>;base64)?$/;
 function decodeDataUrl(url) {
+    url = url.toString();
     const [head, encodedData] = url.split(',', 2);
     if (!head || encodedData === undefined)
         throw Error('Not a data url');
@@ -59,4 +86,31 @@ function decodeDataUrl(url) {
     return { mediaType, data, encoding, attributes };
 }
 exports.decodeDataUrl = decodeDataUrl;
+async function encodeDataUrlFromFile(path, mediaType, attributes) {
+    const url = (0, util_1.toURL)(path);
+    const filename = fsPath.basename(url.pathname);
+    const guess = guessMimeType(filename);
+    mediaType = mediaType || guess?.mimeType || 'text/plain';
+    const _attributes = new Map(attributes || []);
+    filename && _attributes.set('filename', filename);
+    const content = guess?.encoding ? await fs_1.promises.readFile(url, guess?.encoding) : await fs_1.promises.readFile(url);
+    return encodeDataUrl(content, mediaType, _attributes);
+}
+exports.encodeDataUrlFromFile = encodeDataUrlFromFile;
+function guessMimeType(filename) {
+    if (filename.endsWith('.trie'))
+        return { mimeType: 'application/vnd.cspell.dictionary+trie', encoding: 'utf-8' };
+    if (filename.endsWith('.trie.gz'))
+        return { mimeType: 'application/vnd.cspell.dictionary+trie.gz' };
+    if (filename.endsWith('.txt'))
+        return { mimeType: 'text/plain', encoding: 'utf-8' };
+    if (filename.endsWith('.gz'))
+        return { mimeType: 'application/gzip' };
+    if (filename.endsWith('.json'))
+        return { mimeType: 'application/json', encoding: 'utf-8' };
+    if (filename.endsWith('.yaml') || filename.endsWith('.yml'))
+        return { mimeType: 'application/x-yaml', encoding: 'utf-8' };
+    return undefined;
+}
+exports.guessMimeType = guessMimeType;
 //# sourceMappingURL=dataUrl.js.map

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

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-/// <reference types="node" />
+import type { BufferEncoding } from '../../models/BufferEncoding';
 export declare function readFile(filename: string | URL, encoding?: BufferEncoding): Promise<string>;
 export declare function readFileSync(filename: string, encoding?: BufferEncoding): string;
 //# sourceMappingURL=fileReader.d.ts.map

package/dist/node/file/util.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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}:\/\//i;
+const isURLRegExp = /^(\w{2,64}:\/\/|data:)/i;
 const supportedProtocols = { 'file:': true, 'http:': true, 'https:': true };
 function isZipped(filename) {
     const path = typeof filename === 'string' ? filename : filename.pathname;

package/dist/requests/RequestFsReadBinaryFile.d.ts

@@ -1,9 +1,12 @@
 /// <reference types="node" />
-/// <reference types="node" />
+import { ServiceRequestFactoryRequestType } from '@cspell/cspell-service-bus';
+import type { BinaryFileResource } from '../models/FileResource';
 interface RequestParams {
     readonly url: URL;
 }
-export declare const RequestFsReadBinaryFile: import("@cspell/cspell-service-bus/request").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:readBinaryFile", RequestParams, Promise<Buffer>>, RequestParams, "fs:readBinaryFile">;
-export declare const RequestFsReadBinaryFileSync: import("@cspell/cspell-service-bus/request").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:readBinaryFileSync", RequestParams, Buffer>, RequestParams, "fs:readBinaryFileSync">;
+export declare const RequestFsReadBinaryFile: import("@cspell/cspell-service-bus/ServiceRequestFactory").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:readBinaryFile", RequestParams, Promise<BinaryFileResource>>, RequestParams, "fs:readBinaryFile">;
+export declare type RequestFsReadBinaryFile = ServiceRequestFactoryRequestType<typeof RequestFsReadBinaryFile>;
+export declare const RequestFsReadBinaryFileSync: import("@cspell/cspell-service-bus/ServiceRequestFactory").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:readBinaryFileSync", RequestParams, BinaryFileResource>, RequestParams, "fs:readBinaryFileSync">;
+export declare type RequestFsReadBinaryFileSync = ServiceRequestFactoryRequestType<typeof RequestFsReadBinaryFileSync>;
 export {};
 //# sourceMappingURL=RequestFsReadBinaryFile.d.ts.map

package/dist/requests/RequestFsReadFile.d.ts

@@ -1,9 +1,12 @@
 /// <reference types="node" />
 /// <reference types="node" />
+import { ServiceRequestFactoryRequestType } from '@cspell/cspell-service-bus';
+import type { TextFileResource } from '../models/FileResource';
 interface RequestParams {
     readonly url: URL;
     readonly encoding: BufferEncoding;
 }
-export declare const RequestFsReadFile: import("@cspell/cspell-service-bus/request").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:readFile", RequestParams, Promise<string>>, RequestParams, "fs:readFile">;
+export declare const RequestFsReadFile: import("@cspell/cspell-service-bus/ServiceRequestFactory").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:readFile", RequestParams, Promise<TextFileResource>>, RequestParams, "fs:readFile">;
+export declare type RequestFsReadFile = ServiceRequestFactoryRequestType<typeof RequestFsReadFile>;
 export {};
 //# sourceMappingURL=RequestFsReadFile.d.ts.map

package/dist/requests/RequestFsReadFileSync.d.ts

@@ -1,9 +1,12 @@
 /// <reference types="node" />
 /// <reference types="node" />
+import { ServiceRequestFactoryRequestType } from '@cspell/cspell-service-bus';
+import type { TextFileResource } from '../models/FileResource';
 interface RequestParams {
     readonly url: URL;
     readonly encoding: BufferEncoding;
 }
-export declare const RequestFsReadFileSync: import("@cspell/cspell-service-bus/request").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:readFileSync", RequestParams, string>, RequestParams, "fs:readFileSync">;
+export declare const RequestFsReadFileSync: import("@cspell/cspell-service-bus/ServiceRequestFactory").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:readFileSync", RequestParams, TextFileResource>, RequestParams, "fs:readFileSync">;
+export declare type RequestFsReadFileSync = ServiceRequestFactoryRequestType<typeof RequestFsReadFileSync>;
 export {};
 //# sourceMappingURL=RequestFsReadFileSync.d.ts.map

package/dist/requests/RequestFsStat.d.ts

@@ -1,9 +1,12 @@
 /// <reference types="node" />
+import { ServiceRequestFactoryRequestType } from '@cspell/cspell-service-bus';
 import { Stats } from '../models';
 interface RequestStatParams {
     readonly url: URL;
 }
-export declare const RequestFsStat: import("@cspell/cspell-service-bus/request").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:stat", RequestStatParams, Promise<Stats>>, RequestStatParams, "fs:stat">;
-export declare const RequestFsStatSync: import("@cspell/cspell-service-bus/request").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:statSync", RequestStatParams, Stats>, RequestStatParams, "fs:statSync">;
+export declare const RequestFsStat: import("@cspell/cspell-service-bus/ServiceRequestFactory").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:stat", RequestStatParams, Promise<Stats>>, RequestStatParams, "fs:stat">;
+export declare type RequestFsStat = ServiceRequestFactoryRequestType<typeof RequestFsStat>;
+export declare const RequestFsStatSync: import("@cspell/cspell-service-bus/ServiceRequestFactory").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:statSync", RequestStatParams, Stats>, RequestStatParams, "fs:statSync">;
+export declare type RequestFsStatSync = ServiceRequestFactoryRequestType<typeof RequestFsStatSync>;
 export {};
 //# sourceMappingURL=RequestFsStat.d.ts.map

package/dist/requests/RequestFsWriteFile.d.ts

@@ -1,8 +1,10 @@
 /// <reference types="node" />
+import { ServiceRequestFactoryRequestType } from '@cspell/cspell-service-bus';
 interface RequestParams {
     readonly url: URL;
     readonly content: string;
 }
-export declare const RequestFsWriteFile: import("@cspell/cspell-service-bus/request").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:writeFile", RequestParams, Promise<void>>, RequestParams, "fs:writeFile">;
+export declare const RequestFsWriteFile: import("@cspell/cspell-service-bus/ServiceRequestFactory").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:writeFile", RequestParams, Promise<void>>, RequestParams, "fs:writeFile">;
+export declare type RequestFsWriteFile = ServiceRequestFactoryRequestType<typeof RequestFsWriteFile>;
 export {};
 //# sourceMappingURL=RequestFsWriteFile.d.ts.map

package/dist/requests/RequestZlibInflate.d.ts

@@ -1,7 +1,9 @@
 /// <reference types="node" />
+import { ServiceRequestFactoryRequestType } from '@cspell/cspell-service-bus';
 interface RequestParams {
     readonly data: Buffer;
 }
-export declare const RequestZlibInflate: import("@cspell/cspell-service-bus/request").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"zlib:inflate", RequestParams, string>, RequestParams, "zlib:inflate">;
+export declare const RequestZlibInflate: import("@cspell/cspell-service-bus/ServiceRequestFactory").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"zlib:inflate", RequestParams, string>, RequestParams, "zlib:inflate">;
+export declare type RequestZlibInflate = ServiceRequestFactoryRequestType<typeof RequestZlibInflate>;
 export {};
 //# sourceMappingURL=RequestZlibInflate.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-io",
-  "version": "6.5.0",
+  "version": "6.6.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.1",
+    "@types/node": "^18.6.4",
     "fs-extra": "^10.1.0",
     "jest": "^28.1.3",
     "lorem-ipsum": "^2.0.8",
     "rimraf": "^3.0.2"
   },
   "dependencies": {
-    "@cspell/cspell-service-bus": "^6.5.0",
+    "@cspell/cspell-service-bus": "^6.6.0",
     "@types/node-fetch": "^2.6.2",
     "node-fetch": "^2.6.7"
   },
-  "gitHead": "65c80b01e17bb0d74b57ef8b29309684a8588e27"
+  "gitHead": "673377e6b8b79834d018f9b4d02aef90406b7a29"
 }