feat: migrate plugin functions to nest

Signed-off-by: mertmit <mertmit99@gmail.com>

packages/nocodb-nest/src/plugins/backblaze/Backblaze.ts

@@ -7,6 +7,7 @@ import {
   waitForStreamClose,
 } from '../../utils/pluginUtils';
 import type { IStorageAdapterV2, XcFile } from 'nc-plugin';
+import type { Readable } from 'stream';
 
 export default class Backblaze implements IStorageAdapterV2 {
   private s3Client: AWS.S3;
@@ -78,6 +79,21 @@ export default class Backblaze implements IStorageAdapterV2 {
     });
   }
 
+  // TODO - implement
+  fileCreateByStream(_key: string, _stream: Readable): Promise<void> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  fileReadByStream(_key: string): Promise<Readable> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  getDirectoryList(_path: string): Promise<string[]> {
+    return Promise.resolve(undefined);
+  }
+
   patchRegion(region: string): string {
     // in v0.0.1, we constructed the endpoint with `region = s3.us-west-001`
     // in v0.0.2, `region` would be `us-west-001`

packages/nocodb-nest/src/plugins/gcs/Gcs.ts

@@ -7,6 +7,7 @@ import {
   waitForStreamClose,
 } from '../../utils/pluginUtils';
 import type { IStorageAdapterV2, XcFile } from 'nc-plugin';
+import type { Readable } from 'stream';
 import type { StorageOptions } from '@google-cloud/storage';
 
 export default class Gcs implements IStorageAdapterV2 {
@@ -126,4 +127,19 @@ export default class Gcs implements IStorageAdapterV2 {
       );
     });
   }
+
+  // TODO - implement
+  fileCreateByStream(_key: string, _stream: Readable): Promise<void> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  fileReadByStream(_key: string): Promise<Readable> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  getDirectoryList(_path: string): Promise<string[]> {
+    return Promise.resolve(undefined);
+  }
 }

packages/nocodb-nest/src/plugins/linode/LinodeObjectStorage.ts

@@ -7,6 +7,7 @@ import {
   waitForStreamClose,
 } from '../../utils/pluginUtils';
 import type { IStorageAdapterV2, XcFile } from 'nc-plugin';
+import type { Readable } from 'stream';
 
 export default class LinodeObjectStorage implements IStorageAdapterV2 {
   private s3Client: AWS.S3;
@@ -78,6 +79,21 @@ export default class LinodeObjectStorage implements IStorageAdapterV2 {
     });
   }
 
+  // TODO - implement
+  fileCreateByStream(_key: string, _stream: Readable): Promise<void> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  fileReadByStream(_key: string): Promise<Readable> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  getDirectoryList(_path: string): Promise<string[]> {
+    return Promise.resolve(undefined);
+  }
+
   public async fileDelete(_path: string): Promise<any> {
     return Promise.resolve(undefined);
   }

packages/nocodb-nest/src/plugins/mino/Minio.ts

@@ -7,6 +7,7 @@ import {
   waitForStreamClose,
 } from '../../utils/pluginUtils';
 import type { IStorageAdapterV2, XcFile } from 'nc-plugin';
+import type { Readable } from 'stream';
 
 export default class Minio implements IStorageAdapterV2 {
   private minioClient: MinioClient;
@@ -131,4 +132,19 @@ export default class Minio implements IStorageAdapterV2 {
       );
     });
   }
+
+  // TODO - implement
+  fileCreateByStream(_key: string, _stream: Readable): Promise<void> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  fileReadByStream(_key: string): Promise<Readable> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  getDirectoryList(_path: string): Promise<string[]> {
+    return Promise.resolve(undefined);
+  }
 }

packages/nocodb-nest/src/plugins/ovhCloud/OvhCloud.ts

@@ -7,6 +7,7 @@ import {
   waitForStreamClose,
 } from '../../utils/pluginUtils';
 import type { IStorageAdapterV2, XcFile } from 'nc-plugin';
+import type { Readable } from 'stream';
 
 export default class OvhCloud implements IStorageAdapterV2 {
   private s3Client: AWS.S3;
@@ -78,6 +79,21 @@ export default class OvhCloud implements IStorageAdapterV2 {
     });
   }
 
+  // TODO - implement
+  fileCreateByStream(_key: string, _stream: Readable): Promise<void> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  fileReadByStream(_key: string): Promise<Readable> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  getDirectoryList(_path: string): Promise<string[]> {
+    return Promise.resolve(undefined);
+  }
+
   public async fileDelete(_path: string): Promise<any> {
     return Promise.resolve(undefined);
   }

packages/nocodb-nest/src/plugins/s3/S3.ts

@@ -7,6 +7,7 @@ import {
   waitForStreamClose,
 } from '../../utils/pluginUtils';
 import type { IStorageAdapterV2, XcFile } from 'nc-plugin';
+import type { Readable } from 'stream';
 
 export default class S3 implements IStorageAdapterV2 {
   private s3Client: AWS.S3;
@@ -77,6 +78,21 @@ export default class S3 implements IStorageAdapterV2 {
     });
   }
 
+  // TODO - implement
+  fileCreateByStream(_key: string, _stream: Readable): Promise<void> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  fileReadByStream(_key: string): Promise<Readable> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  getDirectoryList(_path: string): Promise<string[]> {
+    return Promise.resolve(undefined);
+  }
+
   public async fileDelete(_path: string): Promise<any> {
     return Promise.resolve(undefined);
   }

packages/nocodb-nest/src/plugins/scaleway/ScalewayObjectStorage.ts

@@ -7,6 +7,7 @@ import {
   waitForStreamClose,
 } from '../../utils/pluginUtils';
 import type { IStorageAdapterV2, XcFile } from 'nc-plugin';
+import type { Readable } from 'stream';
 
 export default class ScalewayObjectStorage implements IStorageAdapterV2 {
   private s3Client: AWS.S3;
@@ -127,4 +128,19 @@ export default class ScalewayObjectStorage implements IStorageAdapterV2 {
       );
     });
   }
+
+  // TODO - implement
+  fileCreateByStream(_key: string, _stream: Readable): Promise<void> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  fileReadByStream(_key: string): Promise<Readable> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  getDirectoryList(_path: string): Promise<string[]> {
+    return Promise.resolve(undefined);
+  }
 }

packages/nocodb-nest/src/plugins/spaces/Spaces.ts

@@ -7,6 +7,7 @@ import {
   waitForStreamClose,
 } from '../../utils/pluginUtils';
 import type { IStorageAdapterV2, XcFile } from 'nc-plugin';
+import type { Readable } from 'stream';
 
 export default class Spaces implements IStorageAdapterV2 {
   private s3Client: AWS.S3;
@@ -78,6 +79,21 @@ export default class Spaces implements IStorageAdapterV2 {
     });
   }
 
+  // TODO - implement
+  fileCreateByStream(_key: string, _stream: Readable): Promise<void> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  fileReadByStream(_key: string): Promise<Readable> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  getDirectoryList(_path: string): Promise<string[]> {
+    return Promise.resolve(undefined);
+  }
+
   public async fileDelete(_path: string): Promise<any> {
     return Promise.resolve(undefined);
   }

packages/nocodb-nest/src/plugins/storage/Local.ts

@@ -5,6 +5,7 @@ import mkdirp from 'mkdirp';
 import axios from 'axios';
 import NcConfigFactory from '../../utils/NcConfigFactory';
 import type { IStorageAdapterV2, XcFile } from 'nc-plugin';
+import type { Readable } from 'stream';
 
 export default class Local implements IStorageAdapterV2 {
   constructor() {}
@@ -65,6 +66,38 @@ export default class Local implements IStorageAdapterV2 {
     });
   }
 
+  public async fileCreateByStream(
+    key: string,
+    stream: Readable,
+  ): Promise<void> {
+    return new Promise((resolve, reject) => {
+      const destPath = path.join(
+        NcConfigFactory.getToolDir(),
+        ...key.split('/'),
+      );
+      try {
+        mkdirp(path.dirname(destPath)).then(() => {
+          const writableStream = fs.createWriteStream(destPath);
+          writableStream.on('finish', () => resolve());
+          writableStream.on('error', (err) => reject(err));
+          stream.pipe(writableStream);
+        });
+      } catch (e) {
+        throw e;
+      }
+    });
+  }
+
+  public async fileReadByStream(key: string): Promise<Readable> {
+    const srcPath = path.join(NcConfigFactory.getToolDir(), ...key.split('/'));
+    return fs.createReadStream(srcPath, { encoding: 'utf8' });
+  }
+
+  public async getDirectoryList(key: string): Promise<string[]> {
+    const destDir = path.join(NcConfigFactory.getToolDir(), ...key.split('/'));
+    return fs.promises.readdir(destDir);
+  }
+
   // todo: implement
   fileDelete(_path: string): Promise<any> {
     return Promise.resolve(undefined);

packages/nocodb-nest/src/plugins/upcloud/UpoCloud.ts

@@ -7,6 +7,7 @@ import {
   waitForStreamClose,
 } from '../../utils/pluginUtils';
 import type { IStorageAdapterV2, XcFile } from 'nc-plugin';
+import type { Readable } from 'stream';
 
 export default class UpoCloud implements IStorageAdapterV2 {
   private s3Client: AWS.S3;
@@ -78,6 +79,21 @@ export default class UpoCloud implements IStorageAdapterV2 {
     });
   }
 
+  // TODO - implement
+  fileCreateByStream(_key: string, _stream: Readable): Promise<void> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  fileReadByStream(_key: string): Promise<Readable> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  getDirectoryList(_path: string): Promise<string[]> {
+    return Promise.resolve(undefined);
+  }
+
   public async fileDelete(_path: string): Promise<any> {
     return Promise.resolve(undefined);
   }

packages/nocodb-nest/src/plugins/vultr/Vultr.ts

@@ -7,6 +7,7 @@ import {
   waitForStreamClose,
 } from '../../utils/pluginUtils';
 import type { IStorageAdapterV2, XcFile } from 'nc-plugin';
+import type { Readable } from 'stream';
 
 export default class Vultr implements IStorageAdapterV2 {
   private s3Client: AWS.S3;
@@ -78,6 +79,21 @@ export default class Vultr implements IStorageAdapterV2 {
     });
   }
 
+  // TODO - implement
+  fileCreateByStream(_key: string, _stream: Readable): Promise<void> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  fileReadByStream(_key: string): Promise<Readable> {
+    return Promise.resolve(undefined);
+  }
+
+  // TODO - implement
+  getDirectoryList(_path: string): Promise<string[]> {
+    return Promise.resolve(undefined);
+  }
+
   public async fileDelete(_path: string): Promise<any> {
     return Promise.resolve(undefined);
   }