IndexedDB fixes and rename

Author: mrfrase3

.github/workflows/publish.yml

@@ -0,0 +1,20 @@
+name: Publish Package to npmjs
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+          scope: '@duinoapp'
+      - run: yarn
+      - run: yarn build
+      - run: yarn publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

src/adaptors/fsa-api/index.ts

@@ -7,9 +7,9 @@
 import { BaseAdaptor, BaseAdaptorOptions } from '../../base';
 import { FileStat, PathMap } from '../../definitions';
 
-const INDEXDB_VERSION = 0;
-const INDEXDB_DEFAULT_DB = 'files-multitool';
-const INDEXDB_DEFAULT_STORE = '~~fsa-api~~';
+const INDEXEDDB_VERSION = 0;
+const INDEXEDDB_DEFAULT_DB = 'files-multitool';
+const INDEXEDDB_DEFAULT_STORE = '~~fsa-api~~';
 
 export interface FSAAdaptorOptions extends BaseAdaptorOptions {
   db?: string;
@@ -129,7 +129,7 @@ export class FSAAdaptor extends BaseAdaptor {
 
   async init(): Promise<void> {
     const db = await new Promise((resolve, reject) => {
-      const request = window.indexedDB.open(this.options.db || INDEXDB_DEFAULT_DB, INDEXDB_VERSION);
+      const request = window.indexedDB.open(this.options.db || INDEXEDDB_DEFAULT_DB, INDEXEDDB_VERSION);
       request.onerror = (event) => {
         reject(event);
       };
@@ -138,7 +138,7 @@ export class FSAAdaptor extends BaseAdaptor {
       };
       request.onupgradeneeded = (event) => {
         const db = (event.target as any).result as IDBDatabase;
-        const store = db.createObjectStore(this.options.store || INDEXDB_DEFAULT_STORE, { keyPath: 'path' });
+        const store = db.createObjectStore(this.options.store || INDEXEDDB_DEFAULT_STORE, { keyPath: 'path' });
 
         store.createIndex('ref', 'ref', { unique: true });
 
@@ -147,8 +147,8 @@ export class FSAAdaptor extends BaseAdaptor {
     }) as IDBDatabase;
 
     const store = db
-      .transaction(this.options.store || INDEXDB_DEFAULT_STORE, 'readwrite')
-      .objectStore(this.options.store || INDEXDB_DEFAULT_STORE);
+      .transaction(this.options.store || INDEXEDDB_DEFAULT_STORE, 'readwrite')
+      .objectStore(this.options.store || INDEXEDDB_DEFAULT_STORE);
 
     let handle = await this._getHandleFromDB(store);
 
@@ -177,11 +177,13 @@ export class FSAAdaptor extends BaseAdaptor {
     this.root = handle;
 
     db.close();
+    return super.init();
   }
 
   async destroy(): Promise<void> {
     this.root = null;
     this._purgeCache();
+    return super.destroy();
   }
 
   async _getParentHandle(path: string, create?: boolean): Promise<FileSystemDirectoryHandle> {

src/adaptors/indexdb/index.ts src/adaptors/indexed-db/index.tssrc/adaptors/indexdb/index.ts renamed to src/adaptors/indexed-db/index.ts

@@ -1,21 +1,28 @@
 import { BaseAdaptor, BaseAdaptorOptions } from '../../base';
 import { FileStat, PathMap } from '../../definitions';
 
-const INDEXDB_VERSION = 1;
-// const INDEXDB_DEFAULT_DB = 'files-multitool';
-const INDEXDB_DEFAULT_STORE = 'files';
+const INDEXEDDB_VERSION = 1;
+// const INDEXEDDB_DEFAULT_DB = 'files-multitool';
+const INDEXEDDB_DEFAULT_STORE = 'files';
 
-export interface IndexDBAdaptorOptions extends BaseAdaptorOptions {
+export interface IndexedDBAdaptorOptions extends BaseAdaptorOptions {
   db?: string;
 }
 
-interface IndexDBFileStat extends FileStat {
+interface IndexedDBFileStat extends FileStat {
   content?: string;
   deletedAt?: Date;
 }
 
-export class IndexDBAdaptor extends BaseAdaptor {
-  declare options: IndexDBAdaptorOptions;
+const joinPath = (path: string, fileName: string) => {
+  return [
+    path.replace(/\/$/, ''),
+    fileName.replace(/^\//, ''),
+  ].filter(v => v).join('/');
+}
+
+export class IndexedDBAdaptor extends BaseAdaptor {
+  declare options: IndexedDBAdaptorOptions;
   db = null as IDBDatabase | null;
   indexedDB = null as IDBFactory | null;
 
@@ -30,7 +37,7 @@ export class IndexDBAdaptor extends BaseAdaptor {
   async init(): Promise<void> {
     this.indexedDB = window.indexedDB;
     this.db = await new Promise((resolve, reject) => {
-      const request = this.indexedDB!.open(this.ref, INDEXDB_VERSION);
+      const request = this.indexedDB!.open(this.ref, INDEXEDDB_VERSION);
       request.onerror = (event) => {
         reject(event);
       };
@@ -39,7 +46,7 @@ export class IndexDBAdaptor extends BaseAdaptor {
       };
       request.onupgradeneeded = (event) => {
         const db = (event.target as any).result as IDBDatabase;
-        const store = db.createObjectStore(INDEXDB_DEFAULT_STORE, { keyPath: 'path' });
+        const store = db.createObjectStore(INDEXEDDB_DEFAULT_STORE, { keyPath: 'path' });
 
         store.createIndex('path', 'path', { unique: true });
         store.createIndex('isDirectory', 'isDirectory', { unique: false });
@@ -55,24 +62,24 @@ export class IndexDBAdaptor extends BaseAdaptor {
     }) as IDBDatabase;
 
     this.db.addEventListener('close', () => {
+      super.destroy();
       this.db = null;
     });
+
+    return super.init();
   }
 
   destroy(): Promise<void> {
-    return new Promise((resolve) => {
-      if (this.db) {
-        this.db.addEventListener('close', () => {
-          resolve();
-        });
-        this.db.close();
-      }
-    });
+    if (this.db) {
+      this.db.close();
+      this.db = null;
+    }
+    return super.destroy();
   }
 
   // internal helper methods
 
-  _convertFileStat(stat: IndexDBFileStat): FileStat {
+  _convertFileStat(stat: IndexedDBFileStat): FileStat {
     const clonedStat = { ...stat };
     delete clonedStat.content;
     delete clonedStat.deletedAt;
@@ -84,19 +91,19 @@ export class IndexDBAdaptor extends BaseAdaptor {
       throw new Error('Adaptor is not initialized.');
     }
     return this.db!
-      .transaction(INDEXDB_DEFAULT_STORE, 'readwrite')
-      .objectStore(INDEXDB_DEFAULT_STORE);
+      .transaction(INDEXEDDB_DEFAULT_STORE, 'readwrite')
+      .objectStore(INDEXEDDB_DEFAULT_STORE);
   }
 
-  _getItem(path: string): Promise<IndexDBFileStat | null> {
+  _getItem(path: string): Promise<IndexedDBFileStat | null> {
     const store = this._getStore();
     const request = store.get(path);
     return new Promise((resolve, reject) => {
       request.onerror = (event) => {
         reject(request.error);
       };
       request.onsuccess = (event) => {
-        resolve((request.result || null) as IndexDBFileStat | null);
+        resolve((request.result || null) as IndexedDBFileStat | null);
       };
     });
   }
@@ -114,7 +121,7 @@ export class IndexDBAdaptor extends BaseAdaptor {
     });
   }
 
-  async _putItem(stat: IndexDBFileStat): Promise<IndexDBFileStat> {
+  async _putItem(stat: IndexedDBFileStat): Promise<IndexedDBFileStat> {
     let writeStat = stat;
     const existing = await this._getItem(stat.path);
     if (existing && existing.deletedAt) {
@@ -137,7 +144,7 @@ export class IndexDBAdaptor extends BaseAdaptor {
     });
   }
 
-  _listItems(path: string): Promise<IndexDBFileStat[]> {
+  _listItems(path: string): Promise<IndexedDBFileStat[]> {
     const store = this._getStore();
     const index = store.index('parentPath');
     const request = index.getAll(path);
@@ -146,7 +153,7 @@ export class IndexDBAdaptor extends BaseAdaptor {
         reject(request.error);
       };
       request.onsuccess = (event) => {
-        resolve((request.result || []) as IndexDBFileStat[]);
+        resolve((request.result || []) as IndexedDBFileStat[]);
       };
     });
   }
@@ -210,7 +217,6 @@ export class IndexDBAdaptor extends BaseAdaptor {
     for (let i = 0; i < parts.length; i++) {
       const partPath = parts.slice(0, i + 1).join('/');
       const stat = await this._getItem(partPath);
-      console.log('mkdir', path, stat);
       if (!stat || stat.deletedAt) {
         await this._putItem({
           path: partPath,
@@ -234,7 +240,7 @@ export class IndexDBAdaptor extends BaseAdaptor {
     const items = await this._listItems(path);
     for (const item of items) {
       if (item.deletedAt) continue;
-      const itemPath = `${path}/${item.path.split('/').pop()}`;
+      const itemPath = joinPath(path, item.path.split('/').pop() as string);
       if (item.isDirectory) {
         await this.rmdir(itemPath);
       } else {
@@ -255,7 +261,7 @@ export class IndexDBAdaptor extends BaseAdaptor {
     const fileName = newFileName || stat.path.split('/').pop()!;
     await this._putItem({
       ...stat,
-      path: [targetPath, fileName].join('/'),
+      path: joinPath(targetPath, fileName),
       parentPath: targetPath,
     });
   }
@@ -269,9 +275,10 @@ export class IndexDBAdaptor extends BaseAdaptor {
     await this.mkdir(newPath);
     for (const item of items) {
       if (item.deletedAt) continue;
-      const itemPath = `${path}/${item.path.split('/').pop()}`;
+      const itemPath = joinPath(path, item.path.split('/').pop() as string);
       if (item.isDirectory && recursive) {
-        await this._copyDirectory(itemPath, `${newPath}/${item.path.split('/').pop()}`, recursive);
+        const newItemPath = joinPath(newPath, item.path.split('/').pop() as string);
+        await this._copyDirectory(itemPath, newItemPath, recursive);
       } else if (item.isFile) {
         await this._copyFile(itemPath, newPath);
       }

src/adaptors/memory/index.ts

@@ -24,11 +24,12 @@ export class MemoryAdaptor extends BaseAdaptor {
   }
 
   async init(): Promise<void> {
-    this.isInitialized = true;
+    return super.init();
   }
 
   async destroy(): Promise<void> {
-    this.isInitialized = false;
+    this.files = {};
+    return super.destroy();
   }
 
   _toStat(file: MemoryFile): FileStat {

src/base.ts

@@ -21,9 +21,6 @@ export abstract class BaseAdaptor {
   get isInitialized(): boolean {
     return this._isInitialized;
   }
-  set isInitialized(value: boolean) {
-    this._isInitialized = value;
-  }
 
   /**
    * Check if the adaptor is supported in the current environment.
@@ -71,7 +68,7 @@ export abstract class BaseAdaptor {
    * @returns {Promise<void>}
   */
   async init(): Promise<void> {
-    this.isInitialized = true;
+    this._isInitialized = true;
   }
 
   /**
@@ -81,7 +78,7 @@ export abstract class BaseAdaptor {
    * It wont delete the files, just the connection to the file system/database.
   */
   async destroy(): Promise<void> {
-    this.isInitialized = false;
+    this._isInitialized = false;
   }
 
   /**

src/index.ts

@@ -3,14 +3,14 @@ import { FileStat, PathMap, PathDump } from './definitions';
 import { BaseAdaptor, BaseAdaptorOptions } from './base';
 
 import { FSAAdaptor, FSAAdaptorOptions } from './adaptors/fsa-api';
-import { IndexDBAdaptor, IndexDBAdaptorOptions } from './adaptors/indexdb';
+import { IndexedDBAdaptor, IndexedDBAdaptorOptions } from './adaptors/indexed-db';
 import { MemoryAdaptor, MemoryAdaptorOptions } from './adaptors/memory';
 
 export { FileStat, PathMap, PathDump };
 
 export enum FilesMultitoolType {
   FSA_API = 'fsa-api',
-  INDEXDB = 'indexdb',
+  INDEXEDDB = 'indexed-db',
   MEMORY = 'memory',
 }
 
@@ -36,7 +36,7 @@ export interface FilesMultitoolPrettyTypes {
  * @property {FileStat} [oldStat] - The old stats of the file or directory if it was renamed.
  * @property {'added' | 'deleted' | 'modified' | 'renamed'} action - The action that occurred.
  */
-interface FilesMultitoolChangeEvent {
+export interface FilesMultitoolChangeEvent {
   path: string;
   stat: FileStat;
   oldPath?: string;
@@ -59,7 +59,7 @@ interface FilesMultitoolEvents {
   'paths-changed': (paths: string[], changes: FilesMultitoolChangeEvent[]) => void;
 }
 
-export interface FilesMultitoolOptions extends BaseAdaptorOptions, FSAAdaptorOptions, IndexDBAdaptorOptions, MemoryAdaptorOptions {
+export interface FilesMultitoolOptions extends BaseAdaptorOptions, FSAAdaptorOptions, IndexedDBAdaptorOptions, MemoryAdaptorOptions {
 }
 
 
@@ -95,8 +95,8 @@ export default class FilesMultitool extends TypedEmitter<FilesMultitoolEvents>{
       case FilesMultitoolType.FSA_API:
         this.adaptor = new FSAAdaptor(ref, options as FSAAdaptorOptions);
         break;
-      case FilesMultitoolType.INDEXDB:
-        this.adaptor = new IndexDBAdaptor(ref, options as IndexDBAdaptorOptions);
+      case FilesMultitoolType.INDEXEDDB:
+        this.adaptor = new IndexedDBAdaptor(ref, options as IndexedDBAdaptorOptions);
         break;
       case FilesMultitoolType.MEMORY:
         this.adaptor = new MemoryAdaptor(ref, options as MemoryAdaptorOptions);
@@ -147,8 +147,8 @@ export default class FilesMultitool extends TypedEmitter<FilesMultitoolEvents>{
     switch (type) {
       case FilesMultitoolType.FSA_API:
         return FSAAdaptor.isSupported();
-      case FilesMultitoolType.INDEXDB:
-        return IndexDBAdaptor.isSupported();
+      case FilesMultitoolType.INDEXEDDB:
+        return IndexedDBAdaptor.isSupported();
       case FilesMultitoolType.MEMORY:
         return MemoryAdaptor.isSupported();
       default:
@@ -173,7 +173,7 @@ export default class FilesMultitool extends TypedEmitter<FilesMultitoolEvents>{
       {
         technology: 'IndexedDB',
         text: 'Local Browser Storage',
-        value: FilesMultitoolType.INDEXDB,
+        value: FilesMultitoolType.INDEXEDDB,
       },
       ...(includeMemory ? [{
         technology: 'Memory',
@@ -234,6 +234,7 @@ export default class FilesMultitool extends TypedEmitter<FilesMultitoolEvents>{
     const map = {} as PathMap;
     const root = await this.adaptor.list(path);
     for (const [key, value] of Object.entries(root)) {
+      if (key === path) continue;
       map[key] = value;
       if (value.isDirectory && recursive) {
         const children = await this.list(value.path, recursive);
@@ -279,7 +280,6 @@ export default class FilesMultitool extends TypedEmitter<FilesMultitoolEvents>{
     if (stat?.isDirectory) throw new Error('Cannot write to a directory.');
     const parentPath = path.split('/').slice(0, -1).join('/').replace(/(^\/)|(\/$)/g, '');
     if (parentPath) await this.adaptor.mkdir(parentPath);
-    console.log('writing file', path, parentPath, stat, await this.adaptor.stat(parentPath));
     if (typeof content === 'string') {
       content = Buffer.from(content, encoding);
     }
@@ -485,9 +485,10 @@ export default class FilesMultitool extends TypedEmitter<FilesMultitoolEvents>{
     if (sourceStat.isDirectory) sourceChildren = await this.list(source, true);
     await this.adaptor.move(source, destination);
     destinationStat = await this.adaptor.stat(destination);
+    if (!destinationStat) throw new Error('Something went wrong. New destination was not found.');
     let destinationChildren: PathMap = {};
     if (sourceStat.isDirectory) destinationChildren = await this.list(destination, true);
-    this._massEmit('renamed', destination, destinationStat!, destinationChildren, source, sourceStat, sourceChildren);
+    this._massEmit('renamed', destination, destinationStat, destinationChildren, source, sourceStat, sourceChildren);
   }
 
   /**