@statewalker/webrun-files 0.1.0

package/dist/index.min.js

@@ -0,0 +1,2 @@
+// @statewalker/webrun-files v0.1.0 https://github.com/statewalker/webrun-files Copyright 2023 Mikhail Kotelnikov
+function t(t){const e=t.split("/").filter((t=>!!t&&"."!==t));return 0===e.length&&e.push(""),e.unshift(""),e.join("/")}function e(){throw new Error("Not implemented.")}class i{constructor(t){this.options=t||{}}async*list(t,i={}){yield e()}async stats(t){return e()}async remove(t){return e()}async write(t,i){return e()}async*read(t,i){yield e()}async copy(t,e,i={}){const n=async(t,e,i)=>{e=`${e}${i.path.substring(t.length)}`;const n=this.read(i);return await this.write(e,n)},s=void 0===i.recursive||!!i.recursive,o=await this.stats(t);if("directory"===o.kind)for await(const o of this.list(t,{...i,recursive:s}))"directory"!==o.kind&&await n(t,e,o);else await n(t,e,o);return!0}async move(t,e,i={}){return!!await this.copy(t,e,i)&&(await this.remove(t),!0)}normalizePath(e){return t("object"==typeof e?e.path:e+"")}}const n=[{extensions:["aac"],mime:"audio/aac",description:"AAC audio"},{extensions:["abw"],mime:"application/x-abiword",description:"AbiWord document"},{extensions:["arc"],mime:"application/x-freearc",description:"Archive document (multiple files embedded)"},{extensions:["avi"],mime:"video/x-msvideo",description:"AVI: Audio Video Interleave"},{extensions:["azw"],mime:"application/vnd.amazon.ebook",description:"Amazon Kindle eBook format"},{extensions:["bin"],mime:"application/octet-stream",description:"Any kind of binary data"},{extensions:["bmp"],mime:"image/bmp",description:"Windows OS/2 Bitmap Graphics"},{extensions:["bz"],mime:"application/x-bzip",description:"BZip archive"},{extensions:["bz2"],mime:"application/x-bzip2",description:"BZip2 archive"},{extensions:["csh"],mime:"application/x-csh",description:"C-Shell script"},{extensions:["css"],mime:"text/css",description:"Cascading Style Sheets (CSS)"},{extensions:["csv"],mime:"text/csv",description:"Comma-separated values (CSV)"},{extensions:["doc"],mime:"application/msword",description:"Microsoft Word"},{extensions:["docx"],mime:"application/vnd.openxmlformats-officedocument.wordprocessingml.document",description:"Microsoft Word (OpenXML)"},{extensions:["eot"],mime:"application/vnd.ms-fontobject",description:"MS Embedded OpenType fonts"},{extensions:["epub"],mime:"application/epub+zip",description:"Electronic publication (EPUB)"},{extensions:["gz"],mime:"application/gzip",description:"GZip Compressed Archive"},{extensions:["gif"],mime:"image/gif",description:"Graphics Interchange Format (GIF)"},{extensions:["htm","html"],mime:"text/html",description:"HyperText Markup Language (HTML)"},{extensions:["ico"],mime:"image/vnd.microsoft.icon",description:"Icon format"},{extensions:["ics"],mime:"text/calendar",description:"iCalendar format"},{extensions:["jar"],mime:"application/java-archive",description:"Java Archive (JAR)"},{extensions:["jpg","jpeg"],mime:"image/jpeg",description:"JPEG images"},{extensions:["js"],mime:"text/javascript",description:"JavaScript per the following specifications: https://html.spec.whatwg.org/multipage/#scriptingLanguages, https://html.spec.whatwg.org/multipage/#dependencies:willful-violation, https://datatracker.ietf.org/doc/draft-ietf-dispatch-javascript-mjs/"},{extensions:["json"],mime:"application/json",description:"JSON format"},{extensions:["jsonld"],mime:"application/ld+json",description:"JSON-LD format"},{extensions:["mid","midi"],mime:"application/ld+json",description:"Musical Instrument Digital Interface (MIDI)\taudio/midi audio/x-midi"},{extensions:["mjs"],mime:"text/javascript",description:"JavaScript module"},{extensions:["mp3"],mime:"audio/mpeg",description:"MP3 audio"},{extensions:["md"],mime:"text/markdown",description:"Markdown"},{extensions:["mpeg"],mime:"video/mpeg",description:"MPEG Video"},{extensions:["mpkg"],mime:"application/vnd.apple.installer+xml",description:"Apple Installer Package"},{extensions:["odp"],mime:"application/vnd.oasis.opendocument.presentation",description:"OpenDocument presentation document"},{extensions:["ods"],mime:"application/vnd.oasis.opendocument.spreadsheet",description:"OpenDocument spreadsheet document"},{extensions:["odt"],mime:"application/vnd.oasis.opendocument.text",description:"OpenDocument text document"},{extensions:["oga"],mime:"audio/ogg",description:"OGG audio"},{extensions:["ogv"],mime:"video/ogg",description:"OGG video"},{extensions:["ogx"],mime:"application/ogg",description:"OGG"},{extensions:["opus"],mime:"audio/opus",description:"Opus audio"},{extensions:["otf"],mime:"font/otf",description:"OpenType font"},{extensions:["png"],mime:"image/png",description:"Portable Network Graphics"},{extensions:["pdf"],mime:"application/pdf",description:"Adobe Portable Document Format (PDF)"},{extensions:["php"],mime:"application/x-httpd-php",description:"Hypertext Preprocessor (Personal Home Page)"},{extensions:["ppt"],mime:"application/vnd.ms-powerpoint",description:"Microsoft PowerPoint"},{extensions:["pptx"],mime:"application/vnd.openxmlformats-officedocument.presentationml.presentation",description:"Microsoft PowerPoint (OpenXML)"},{extensions:["rar"],mime:"application/vnd.rar",description:"RAR archive"},{extensions:["rtf"],mime:"application/rtf",description:"Rich Text Format (RTF)"},{extensions:["sh"],mime:"application/x-sh",description:"Bourne shell script"},{extensions:["svg"],mime:"image/svg+xml",description:"Scalable Vector Graphics (SVG)"},{extensions:["swf"],mime:"application/x-shockwave-flash",description:"Small web format (SWF) or Adobe Flash document"},{extensions:["tar"],mime:"application/x-tar",description:"Tape Archive (TAR)"},{extensions:["tif","tiff"],mime:"image/tiff",description:"Tagged Image File Format (TIFF)"},{extensions:["ttf"],mime:"font/ttf",description:"TrueType Font"},{extensions:["txt"],mime:"text/plain",description:"Text, (generally ASCII or ISO 8859-n)"},{extensions:["vsd"],mime:"application/vnd.visio",description:"Microsoft Visio"},{extensions:["wav"],mime:"audio/wav",description:"Waveform Audio Format"},{extensions:["weba"],mime:"audio/webm",description:"WEBM audio"},{extensions:["webm"],mime:"video/webm",description:"WEBM video"},{extensions:["webp"],mime:"image/webp",description:"WEBP image"},{extensions:["woff"],mime:"font/woff",description:"Web Open Font Format (WOFF)"},{extensions:["woff2"],mime:"font/woff2",description:"Web Open Font Format (WOFF)"},{extensions:["xhtml"],mime:"application/xhtml+xml",description:"XHTML"},{extensions:["xls"],mime:"application/vnd.ms-excel",description:"Microsoft Excel"},{extensions:["xlsx"],mime:"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",description:"Microsoft Excel (OpenXML)"},{extensions:["xml"],mime:"application/xml",description:"XML; application/xml - if not readable from casual users (RFC 3023, section 3); text/xml - if readable from casual users (RFC 3023, section 3)"},{extensions:["xul"],mime:"application/vnd.mozilla.xul+xml",description:"XUL"},{extensions:["zip"],mime:"application/zip",description:"ZIP archive"},{extensions:["3gp"],mime:"video/3gpp",description:"3GPP audio/video container"},{extensions:["3g2"],mime:"video/3gpp2",description:"3GPP2 audio/video container; audio/3gpp if it doesn't contain video; audio/3gpp2 if it doesn't contain video"},{extensions:["7z"],mime:"application/x-7z-compressed",description:"7-zip archive"},{extensions:["jsx"],mime:"text/jsx",description:"JavaScript Syntax Extension / JavaScript XML format"},{extensions:["ts"],mime:"text/ts",description:"TypeScript format"},{extensions:["tsx"],mime:"text/tsx",description:"TypeScript Syntax Extension / TypeScript XML format"}],s=n.reduce(((t,e)=>(t[e.mime]=e.description,t)),{}),o=n.reduce(((t,e)=>{for(const i of e.extensions)t[i]=e.mime;return t}),{}),a=n.reduce(((t,e)=>(t[e.mime]=e.extensions,t)),{});function r(t){const e=t=t||"",i=(t=(t=t.split("?").shift()).split("/").pop()).split(".").pop();let n=o[i];return n||(n=e.match(/api\.observablehq\.com/)||e.match(/\.ojs$/)?"application/javascript-observable":"application/binary"),n}class c extends i{constructor(t){super(t),this.index={"/":{kind:"directory",path:"/",name:""}}}async*list(t,{recursive:e=!1}={}){await this._init();const i=this.normalizePath(t),n=this._getPaths();for(const t of n){if(0!==t.indexOf(i)||t===i)continue;const n=t.substring(i.length+1).split("/");(e||1===n.length)&&(yield this._getFileInfo(t))}}async stats(t){await this._init();const e=this.normalizePath(t);return this._getFileInfo(e)}async remove(t){await this._init();const e=await this.stats(t);if(!e)return!1;for await(const{path:t}of this.list(e,{recursive:!0}))"/"!==t&&delete this.index[t];delete this.index[e.path]}async write(t,e){await this._init(),await this._doWrite(t,e)}async*read(t){await this._init();const e=this.normalizePath(t),i=this.index[e];if(!i||"file"!==i.kind)return;const n=i.content;yield*n}async _init(){return this._initPromise=this._initPromise||Promise.resolve().then((()=>this._addEntries(this.options.files)))}async _doWrite(t,e){const i=this.normalizePath(t).split("/").filter((t=>!!t)),n=[""];let s;for(let t=0;t<i.length;t++){const e=i[t];n.push(e);const o=n.join("/");s=this.index[o]=this.index[o]||{path:o,name:e,kind:"directory"}}s.kind="file",s.content=[],s.type=r(s.path),s.size=0,s.lastModified=Date.now(),"function"==typeof e&&(e=e());for await(let t of e)t=new Uint8Array(t),s.content.push(t),s.size+=t.length}async _addEntries(t={}){for(let[e,i]of Object.entries(t))"string"==typeof i?i=[(new TextEncoder).encode(i)]:i instanceof Uint8Array&&(i=[i]),await this._doWrite(e,i)}_getPaths(){return this._getIndexPaths(this.index)}_getIndexPaths(t){return Object.keys(t).sort((function(t,e){return t>e?1:t<e?-1:0}))}_getFileInfo(t){const e=this.index[t];if(!e)return null;const i={...e};return delete i.content,i}}class p extends i{constructor(t){if(super(t),!this.fs)throw new Error("File System is not defined.");if(!this.rootDir)throw new Error("Root directory is not defined.")}get rootDirSegments(){return this._rootDirSegments||(this._rootDirSegments=this._toPathSegments(this.options.rootDir||"./")),this._rootDirSegments}get rootDir(){return this._rootDir||(this._rootDir=this.rootDirSegments.join("/")),this._rootDir}get fs(){return this.options.fs}async _init(){return this._initialized=this._initialized||(async()=>{const t=this.rootDir;return await l(this.fs,t)})()}async*list(t,{recursive:e=!1}={}){await this._init();const i=this._expandPath(t),n=await this._stats(i);if(n&&"directory"===n.kind)for await(let t of f(this.fs,i,e))yield this._getFileInfo(t.path,t.stat)}async stats(t){await this._init();const e=this._expandPath(t);return this._stats(e)}async remove(t){await this._init();const e=this._expandPath(t);return await h(this.fs,e)}async write(t,e){await this._init();const i=this._expandPath(t),n=d(i);let s;await this.fs.mkdir(n,{recursive:!0});try{s=await this.fs.open(i,"w"),"function"==typeof e&&(e=e()),await s.writeFile(e)}finally{s&&await s.close()}}async*read(t,{start:e=0,bufferSize:i=8192}={}){await this._init();const n=this._expandPath(t);let s;try{s=await this.fs.open(n,"r");const t=0;for(let n=e,o=0;;n+=o){const e=new Uint8ClampedArray(i),a=await s.read(e,t,i,n);if(o=a.bytesRead,0===o)break;yield o<i?a.buffer.slice(0,o):a.buffer}}finally{s&&await s.close()}}async _stats(t){try{const e=await this.fs.stat(t);return this._getFileInfo(t,e)}catch(t){if("ENOENT"!==t.code)throw t;return null}}_getFileInfo(t,e){const i=this._toPathSegments(t).slice(this.rootDirSegments.length);i.unshift("");const n=i[i.length-1];let s={path:t=i.join("/"),name:n,kind:""};return e.isFile()?(s.size=e.size||0,s.type=r(t),s.kind="file",s.lastModified=new Date(e.mtime).getTime()):s.kind="directory",s}_toPathSegments(t){return(t=this.normalizePath(t)).split("/")}_expandPath(t){const e="object"==typeof t?t.path:t+"",i=this._toPathSegments(e).filter((t=>!!t));return i.unshift(...this.rootDirSegments),i.join("/")}}function d(t){const e=t.split("/");return e.pop(),e.join("/")}function m(...t){let e=t.map((t=>t.split("/"))).reduce(((t,e)=>(t.push(...e),t)),[]);const i=e.shift();return e=e.filter((t=>!!t&&"."!==t)),e.unshift(i),e.join("/")}async function l(t,e){try{const i=await t.stat(e);if(i&&i.isDirectory())return!0}catch(t){}const i=d(e);return e!==i&&(await l(t,i),await t.mkdir(e,{recursive:!0}),!0)}async function h(t,e){try{if((await t.stat(e)).isDirectory()){for await(let i of f(t,e,!1))await h(t,i.path);await t.rmdir(e)}else await t.unlink(e)}catch(t){if("ENOENT"!==t.code)throw t}}async function*f(t,e,i){try{if((await t.stat(e)).isDirectory()){const n=await t.readdir(e);for(const s of n.sort()){const n=m(e,s);let o=await t.stat(n);yield{path:n,stat:o},i&&o.isDirectory()&&(yield*f(t,n,!0))}}}catch(t){if("ENOENT"!==t.code)throw t}}class u extends i{constructor(t){if(super(t),!this.rootHandler)throw new Error("Root directory handler is not defined")}get rootHandler(){return this.options.rootHandler}async*list(t,{recursive:e=!1}={}){const i=this._getPathSegments(t),n=await this._getHandler(i,!1),s=this;"directory"===n.kind&&(yield*async function*t(e,i,n){for await(const o of i.values())yield await s._getFileInfo([...e,o.name],o),n&&"directory"==o.kind&&(yield*t([...e,o.name],o,n))}(i,n,e))}async stats(t){const e=this._getPathSegments(t),i=await this._getHandler(e,!1);return i?await this._getFileInfo(e,i):null}async remove(t){let e=this._getPathSegments(t);const i=e.pop(),n=await this._getHandler(e,!1),s=[];if(i)s.push(i);else for await(const t of n.values())s.push(t.name);for(const t of s)await n.removeEntry(t,{recursive:!0});return!0}async write(t,e){const i=this._getPathSegments(t),n=await this._getFileHandler(i),s=await n.createWritable();try{"function"==typeof e&&(e=e());for await(let t of e)await s.write(t.buffer?t.buffer:t)}finally{await s.close()}}async*read(t){const e=this._getPathSegments(t),i=await this._getFileHandler(e,!1);if(!i)return;const n=(await i.getFile()).stream().getReader();try{let t;for(;(t=await n.read())&&!t.done;)yield t.value}finally{n.cancel&&n.cancel()}}async _getHandler(t,e=!1){let i;try{i=await this._getFileHandler(t,e)}catch(n){try{i=await this._getDirectoryHandler(t,e)}catch(t){}}return i}async _getDirectoryHandler(t,e=!0){t=[...t];let i=this.rootHandler;for(let n of t)i=await i.getDirectoryHandle(n,{create:e});return i}async _getFileHandler(t,e=!0){const i=(t=[...t]).pop();let n=this.rootHandler;for(let e of t)n=await n.getDirectoryHandle(e,{create:!0});return await n.getFileHandle(i,{create:e})}async _getFileInfo(t,e){const i=(t=[...t])[t.length-1];t.unshift("");const n=t.join("/"),s={kind:"",path:n,name:i};if("directory"===e.kind)s.kind="directory";else{s.kind="file";const t=await e.getFile();s.size=t.size,s.type=r(n),s.lastModified=t.lastModified}return s}_getPathSegments(t){return("object"==typeof t?t.path:t+"").split("/").filter((t=>!!t))}}function x({filesApi:t,log:e=console.log,wrapper:i={}}){return["list","stats","remove","write","read","copy","move"].reduce(((i,n)=>{const s=t[n].bind(t);return i[n]=(...i)=>{let o={method:n,stage:"enter",args:i};try{return e(o),o.result=s.call(t,...i)}catch(t){o.error=t}finally{o.stage="exit",e(o)}},i}),i)}async function w({handlerKey:t="root-dir",readwrite:e=!0,index:i={},get:n=(async t=>i[t]),set:s=(async(t,e)=>i[t]=e),del:o=(async t=>delete i[t])}={}){let a=await n(t);if(a||(a=await window.showDirectoryPicker(),await s(t,a)),!await async function(t,e){const i={};e&&(i.mode="readwrite");let n=!1;"granted"===await t.queryPermission(i)&&(n=!0);n||"granted"!==await t.requestPermission(i)||(n=!0);return n}(a,e))throw new Error("Access was not granted");if(!await async function(t){let e=!1;try{if("file"===t.kind)await t.getFile();else for await(let e of t.values())break;e=!0}catch(i){console.log(i,t),e=!1}return e}(a))throw await o(t),new Error("Can not access to the folder. Please try again.");return new u({rootHandler:a})}export{u as BrowserFilesApi,i as FilesApi,c as MemFilesApi,p as NodeFilesApi,x as addFilesApiLogger,o as extensionToMimeType,r as getMimeType,a as mimeTypeToExtensions,n as mimeTypes,s as mimeTypesDescriptions,t as normalizePath,w as openBrowserFilesApi};

package/index.js

@@ -0,0 +1 @@
+export * from './src/index.js';

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@statewalker/webrun-files",
+  "version": "0.1.0",
+  "description": "Basic files API",
+  "keywords": [],
+  "homepage": "https://github.com/statewalker/webrun-files",
+  "author": {
+    "name": "Mikhail Kotelnikov",
+    "email": "mikhail.kotelnikov@gmail.com"
+  },
+  "license": "MIT",
+  "type": "module",
+  "files": [
+    "dist/**/package.json",
+    "dist/**/*.js",
+    "src/**/*.js",
+    "index.js"
+  ],
+  "module": "src/index.js",
+  "main": "src/index.js",
+  "jsdelivr": "dist/index.js",
+  "unpkg": "dist/index.js",
+  "exports": {
+    "umd": "./dist/index-umd.min.js",
+    "default": "./src/index.js"
+  },
+  "devDependencies": {
+    "@statewalker/rollup": "^0.1.6",
+    "@statewalker/webrun-files-tests": "https://github.com/statewalker/webrun-files-test",
+    "eslint": "^8",
+    "expect.js": "^0.3",
+    "mocha": "^10",
+    "rollup": "^3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:statewalker/webrun-files.git"
+  },
+  "scripts": {
+    "eslint": "eslint src",
+    "rollup": "rollup -c",
+    "test": "mocha -R spec ./test/index.js",
+    "prepublishOnly": "rm -rf dist && yarn test && yarn rollup"
+  },
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/BrowserFilesApi.js

@@ -0,0 +1,164 @@
+import FilesApi from "./FilesApi.js";
+import getMimeType from "./getMimeType.js";
+
+export default class BrowserFilesApi extends FilesApi {
+  constructor(options) {
+    super(options);
+    if (!this.rootHandler) {
+      throw new Error("Root directory handler is not defined");
+    }
+  }
+
+  get rootHandler() {
+    return this.options.rootHandler;
+  }
+
+  async *list(file, { recursive = false } = {}) {
+    const segments = this._getPathSegments(file);
+    const handle = await this._getHandler(segments, false);
+    const that = this;
+    if (handle.kind === "directory") {
+      yield* listChildren(segments, handle, recursive);
+    }
+
+    async function* listChildren(segments, dirHandle, recursive) {
+      for await (const handle of dirHandle.values()) {
+        yield await that._getFileInfo([...segments, handle.name], handle);
+        if (recursive && handle.kind == "directory") {
+          yield* listChildren(
+            [...segments, handle.name],
+            handle,
+            recursive,
+          );
+        }
+      }
+    }
+  }
+
+  async stats(file) {
+    const segments = this._getPathSegments(file);
+    const handle = await this._getHandler(segments, false);
+    return handle ? await this._getFileInfo(segments, handle) : null;
+  }
+
+  async remove(file) {
+    let segments = this._getPathSegments(file);
+    const name = segments.pop();
+    const parentHandle = await this._getHandler(segments, false);
+    const toRemove = [];
+    if (name) {
+      toRemove.push(name);
+    } else {
+      for await (const childHandle of parentHandle.values()) {
+        toRemove.push(childHandle.name);
+      }
+    }
+    for (const name of toRemove) {
+      await parentHandle.removeEntry(name, { recursive: true });
+    }
+    return true;
+  }
+
+  async write(file, content) {
+    const segments = this._getPathSegments(file);
+    const fileHandle = await this._getFileHandler(segments);
+    const writable = await fileHandle.createWritable(); // Write the contents of the file to the stream.
+    try {
+      if (typeof content === "function") content = content();
+      for await (let block of content) {
+        await writable.write(block.buffer ? block.buffer : block); // Close the file and write the contents to disk.
+      }
+    } finally {
+      await writable.close();
+    }
+  }
+
+  async *read(file /* { start = 0, bufferSize = 1024 * 8 } = {} */) {
+    const segments = this._getPathSegments(file);
+    const fileHandle = await this._getFileHandler(segments, false);
+    if (!fileHandle) return;
+    const fileData = await fileHandle.getFile();
+    const stream = fileData.stream();
+    const reader = stream.getReader();
+    try {
+      let chunk;
+      while ((chunk = await reader.read()) && !chunk.done) {
+        yield chunk.value;
+      }
+    } finally {
+      reader.cancel && reader.cancel();
+      // stream.cancel && stream.cancel();
+    }
+  }
+
+  // TODO:
+  // async copy(fromPath, toPath, options = {}) { ... }
+
+  // TODO:
+  // async move(fromPath, toPath, options = {}) { ... }
+
+  async _getHandler(segments, create = false) {
+    let handle;
+    try {
+      handle = await this._getFileHandler(segments, create);
+    } catch (e) {
+      try {
+        handle = await this._getDirectoryHandler(segments, create);
+      } catch (e) {
+        // Just ignore it
+      }
+    }
+    return handle;
+  }
+
+  async _getDirectoryHandler(segments, create = true) {
+    segments = [...segments];
+    let dirHandle = this.rootHandler;
+    for (let directoryName of segments) {
+      dirHandle = await dirHandle.getDirectoryHandle(directoryName, { create });
+    }
+    return dirHandle;
+  }
+
+  async _getFileHandler(segments, create = true) {
+    segments = [...segments];
+    const filename = segments.pop();
+    let dirHandle = this.rootHandler;
+    for (let directoryName of segments) {
+      dirHandle = await dirHandle.getDirectoryHandle(directoryName, {
+        create: true,
+      });
+    }
+    const fileHandler = await dirHandle.getFileHandle(filename, { create });
+    return fileHandler;
+  }
+
+  async _getFileInfo(segments, handle) {
+    segments = [...segments];
+    const name = segments[segments.length - 1];
+    segments.unshift("");
+    const path = segments.join("/");
+    const info = {
+      kind: "",
+      path,
+      name,
+    };
+    if (handle.kind === "directory") {
+      info.kind = "directory";
+    } else {
+      info.kind = "file";
+      const file = await handle.getFile();
+      info.size = file.size;
+      info.type = getMimeType(path);
+      info.lastModified = file.lastModified;
+    }
+    return info;
+  }
+
+  _getPathSegments(file) {
+    let filePath = typeof file === "object" ? file.path : file + "";
+    // filePath = this.normalizePath(filePath);
+    const segments = filePath.split("/").filter((s) => !!s);
+    return segments;
+  }
+}

package/src/FilesApi.js

@@ -0,0 +1,133 @@
+import normalizePath from "./normalizePath.js";
+import notImplemented from "./notImplemented.js";
+
+/*
+ * FileInfo
+ * - `kind` - (`file`|`directory`) kind of the returned entity
+ * - `name` - the local name of this file entry (the last segment of the path)
+ * - `path` - path to the file from the root of the "file system"
+ * - `type` - an optional mime type of the file content; it is not defined for directories
+ * - `size` - size of the file (only for files)
+ * - `lastModified` - modification time as a long integer
+ */
+
+/**
+ * This is a common interface providing access to methods dealing with files.
+ */
+export default class FilesApi {
+  constructor(options) {
+    this.options = options || {};
+  }
+
+  /**
+   * Returns an async generator providing information about files (FileInfo[]).
+   * Paths corresponding to directories has the "/" trailing symbol.
+   * @param {Object|String} file path to the folder or an object returned by the `list` or `info` methods
+   * @param {Object} options optional parameters
+   * @param {Boolean} options.recursive this flag defines if the returned generator
+   * should give access to all child directories and files or just direct children
+   * @return {AsyncGenerator<FileInfo>} generator returning information about
+   * individual file entries
+   */
+  async *list(file, options = {}) {
+    yield notImplemented(file, options);
+  }
+
+  /**
+   * Returns information about an individual file.
+   * @param {Object|String} file path to the file or an object returned by
+   * the `list` or `info` methods
+   * @return {FileInfo} information about the file corresponding to the specified
+   * path or null if there is no such a file
+   */
+  async stats(file) {
+    return notImplemented(file);
+  }
+
+  /**
+   * Removes file or folder corresponding to the specified path.
+   * All children of this entry will be removed as well.
+   * @param {Object|String} file path to the file to remove or an object
+   * returned by the `list` or `info` methods
+   * @return {Boolean} return true if the file was removed
+   */
+  async remove(file) {
+    return notImplemented(file);
+  }
+
+  /**
+   * Creates and returns a write stream for the file with the specified path.
+   * @param {Object|String} file path to the file or an object returned by
+   * the `list` or `info` methods
+   * @param {AsyncGenerator|AsyncIterator} content async generator function providing the binary
+   * file content to store
+   * @return {any} result of the action execution
+   */
+  async write(file, content) {
+    return notImplemented(file, content);
+  }
+
+  /**
+   * Creates an returns an AsyncIterator returning byte blocks with the file content.
+   * @param {Object|String} file path to the file or an object returned by
+   * the `list` or `info` methods
+   * @param {object} options read parameters
+   * @param {number} options.start starting read position; default value is 0
+   * @param {number} options.bufferSize the optional size of returned chunks buffers
+   */
+  async *read(file, options) {
+    yield notImplemented(file, options);
+  }
+
+  /**
+   * Copies a file from one path to another.
+   * @param {String} fromPath path to the source file
+   * @param {String} toPath path to the target file
+   * @param {Object} options additional options
+   * @param {Store} options.recursive if this flag is true then subfolders are also copied
+   * @param {Store} options.target optional target store where data should be copied
+   * @return {Boolean} if the file was successfully copied
+   */
+  async copy(source, target, options = {}) {
+    const doCopy = async (sourcePath, targetPath, sourceFile) => {
+      const suffix = sourceFile.path.substring(sourcePath.length);
+      targetPath = `${targetPath}${suffix}`;
+      const content = this.read(sourceFile);
+      return await this.write(targetPath, content);
+    };
+    const recursive = options.recursive === undefined || !!options.recursive;
+    const sourceFile = await this.stats(source);
+    if (sourceFile.kind === "directory") {
+      for await (const file of this.list(source, { ...options, recursive })) {
+        if (file.kind === "directory") continue;
+        await doCopy(source, target, file);
+      }
+    } else {
+      await doCopy(source, target, sourceFile);
+    }
+    return true;
+  }
+
+  /**
+   * Moves files from the initial position to the target path.
+   * The default implementation creates a new file copy in the new location
+   * and removes the old file.
+   *
+   * @param {String} fromPath path to the source file
+   * @param {String} toPath path to the target file
+   * @param {Object} options additional options
+   * @param {Store} options.target optional target store where data should be moved
+   * @return {Boolean} if the file was successfully moved
+   */
+  async move(fromPath, toPath, options = {}) {
+    if (!await this.copy(fromPath, toPath, options)) return false;
+    await this.remove(fromPath);
+    return true;
+  }
+
+  normalizePath(file) {
+    let filePath = typeof file === "object" ? file.path : file + "";
+    return normalizePath(filePath);
+  }
+}
+

package/src/MemFilesApi.js

@@ -0,0 +1,129 @@
+import FilesApi from "./FilesApi.js";
+import getMimeType from "./getMimeType.js";
+
+export default class MemFilesApi extends FilesApi {
+  constructor(options) {
+    super(options);
+    this.index = {
+      "/" : {
+        "kind": "directory",
+        "path": "/",
+        "name": ""
+      }
+    };
+  }
+
+  async *list(file, { recursive = false } = {}) {
+    await this._init();
+    const filePath = this.normalizePath(file);
+    const paths = this._getPaths();
+    for (const path of paths) {
+      if (path.indexOf(filePath) !== 0 || path === filePath) continue;
+      const suffix = path.substring(filePath.length + 1);
+      const segments = suffix.split("/");
+      if (recursive || segments.length === 1) {
+        yield this._getFileInfo(path);
+      }
+    }
+  }
+
+  async stats(file) {
+    await this._init();
+    const filePath = this.normalizePath(file);
+    return this._getFileInfo(filePath);
+  }
+
+  async remove(file) {
+    await this._init();
+    const fileInfo = await this.stats(file);
+    if (!fileInfo) return false;
+    for await (const { path } of this.list(fileInfo, { recursive: true })) {
+      if (path !== "/") delete this.index[path];
+    }
+    delete this.index[fileInfo.path];
+  }
+
+  async write(file, content) {
+    await this._init();
+    await this._doWrite(file, content);
+  }
+
+  async *read(file /* { start = 0, bufferSize = 1024 * 8 } = {} */) {
+    await this._init();
+    const filePath = this.normalizePath(file);
+    const fileInfo = this.index[filePath];
+    if (!fileInfo || fileInfo.kind !== "file") return ; // throw new Error("Not a file");
+    const content = fileInfo.content;
+    yield* content;
+  }
+
+  // TODO:
+  // async copy(fromPath, toPath, options = {}) { ... }
+
+  // TODO:
+  // async move(fromPath, toPath, options = {}) { ... }
+
+  async _init() {
+    return this._initPromise = this._initPromise ||
+      Promise.resolve().then(() => this._addEntries(this.options.files));
+  }
+
+  async _doWrite(file, content) {
+    const filePath = this.normalizePath(file);
+    const segments = filePath.split("/").filter((s) => !!s);
+    const pathSegments = [""];
+    let info;
+    for (let i = 0; i < segments.length; i++) {
+      const name = segments[i];
+      pathSegments.push(name);
+      const path = pathSegments.join("/");
+      info = this.index[path] = this.index[path] || {
+        path,
+        name,
+        kind: "directory",
+      };
+    }
+    info.kind = "file";
+    info.content = [];
+    info.type = getMimeType(info.path);
+    info.size = 0;
+    info.lastModified = Date.now();
+    if (typeof content === "function") content = content();
+    for await (let chunk of content) {
+      chunk = new Uint8Array(chunk);
+      info.content.push(chunk);
+      info.size += chunk.length;
+    }
+  }
+
+  async _addEntries(index = {}) {
+    for (let [path, content] of Object.entries(index)) {
+      if (typeof content === "string") {
+        content = [new TextEncoder().encode(content)];
+      } else if (content instanceof Uint8Array) {
+        content = [content];
+      }
+      await this._doWrite(path, content);
+    }
+  }
+
+  _getPaths() {
+    return this._getIndexPaths(this.index);
+  }
+
+  _getIndexPaths(index) {
+    return Object.keys(index).sort(compare);
+    function compare(a, b) {
+      return a > b ? 1 : a < b ? -1 : 0;
+    }
+  }
+
+  _getFileInfo(path) {
+    const fileInfo = this.index[path];
+    if (!fileInfo) return null;
+    const info = { ...fileInfo };
+    delete info.content;
+    return info;
+  }
+
+}