@fleekhq/space-client - npm Package Compare versions

Comparing version 1.1.7 to 1.1.8

dist/client.d.ts

 import grpcWeb, { ClientReadableStream } from 'grpc-web';
 import { SpaceApiClient } from './definitions/SpaceServiceClientPb';
-import { OpenFilePayload, CreateBucketPayload, AddItemsPayload, CreateFolderPayload, BackupKeysByPassphrasePayload, RecoverKeysByPassphrasePayload, ToggleFusePayload, GetFuseDriveStatusPayload, ListDirectoriesPayload, ListDirectoryPayload, ToggleBucketBackupPayload, ShareBucketPayload, JoinBucketPayload, ReadNotificationPayload, GetNotificationsPayload, RestoreKeyPairViaMnemonicPayload, GetSharedWithMeFilesPayload, ShareFilesViaPublicKeyPayload, GeneratePublicFileLinkPayload, TestKeysPassphrasePayload, SetNotificationsLastSeenAtPayload, HandleFilesInvitationPayload, OpenPublicFilePayload, SearchFilesPayload, InitializeMasterAppPayload, GetSharedByMeFilesPayload } from './types';
-import { TextileEventResponse, ListDirectoriesResponse, ToggleBucketBackupResponse, OpenFileResponse, CreateBucketResponse, AddItemsResponse, CreateFolderResponse, BackupKeysByPassphraseResponse, RecoverKeysByPassphraseResponse, FuseDriveResponse, FileEventResponse, ListBucketsResponse, ListDirectoryResponse, ShareBucketResponse, JoinBucketResponse, GetPublicKeyResponse, NotificationEventResponse, ReadNotificationResponse, GetNotificationsResponse, HandleFilesInvitationResponse, DeleteKeyPairResponse, GetUsageInfoResponse, GetStoredMnemonicResponse, RestoreKeyPairViaMnemonicResponse, GetSharedWithMeFilesResponse, ShareFilesViaPublicKeyResponse, GetAPISessionTokensResponse, GetRecentlySharedWithResponse, GeneratePublicFileLinkResponse, TestKeysPassphraseResponse, SetNotificationsLastSeenAtResponse, GenerateKeyPairResponse, OpenPublicFileResponse, SearchFilesResponse, InitializeMasterAppTokenResponse, GetSharedByMeFilesResponse } from './definitions/space_pb';
+import { OpenFilePayload, CreateBucketPayload, AddItemsPayload, CreateFolderPayload, RemoveDirOrFilePayload, BackupKeysByPassphrasePayload, RecoverKeysByPassphrasePayload, ToggleFusePayload, GetFuseDriveStatusPayload, ListDirectoriesPayload, ListDirectoryPayload, ToggleBucketBackupPayload, ShareBucketPayload, JoinBucketPayload, ReadNotificationPayload, GetNotificationsPayload, RestoreKeyPairViaMnemonicPayload, GetSharedWithMeFilesPayload, ShareFilesViaPublicKeyPayload, GeneratePublicFileLinkPayload, TestKeysPassphrasePayload, SetNotificationsLastSeenAtPayload, HandleFilesInvitationPayload, OpenPublicFilePayload, SearchFilesPayload, InitializeMasterAppPayload, GetSharedByMeFilesPayload } from './types';
+import { TextileEventResponse, ListDirectoriesResponse, ToggleBucketBackupResponse, OpenFileResponse, CreateBucketResponse, AddItemsResponse, CreateFolderResponse, RemoveDirOrFileResponse, BackupKeysByPassphraseResponse, RecoverKeysByPassphraseResponse, FuseDriveResponse, FileEventResponse, ListBucketsResponse, ListDirectoryResponse, ShareBucketResponse, JoinBucketResponse, GetPublicKeyResponse, NotificationEventResponse, ReadNotificationResponse, GetNotificationsResponse, HandleFilesInvitationResponse, DeleteKeyPairResponse, GetUsageInfoResponse, GetStoredMnemonicResponse, RestoreKeyPairViaMnemonicResponse, GetSharedWithMeFilesResponse, ShareFilesViaPublicKeyResponse, GetAPISessionTokensResponse, GetRecentlySharedWithResponse, GeneratePublicFileLinkResponse, TestKeysPassphraseResponse, SetNotificationsLastSeenAtResponse, GenerateKeyPairResponse, OpenPublicFileResponse, SearchFilesResponse, InitializeMasterAppTokenResponse, GetSharedByMeFilesResponse } from './definitions/space_pb';
 export interface SpaceClientOpts {
@@ -23,2 +23,3 @@ url: string;
     createFolder(payload: CreateFolderPayload, metadata?: grpcWeb.Metadata): Promise<CreateFolderResponse>;
+    removeDirOrFile(payload: RemoveDirOrFilePayload, metadata?: grpcWeb.Metadata): Promise<RemoveDirOrFileResponse>;
     backupKeysByPassphrase(payload: BackupKeysByPassphrasePayload, metadata?: grpcWeb.Metadata): Promise<BackupKeysByPassphraseResponse>;
@@ -25,0 +26,0 @@ recoverKeysByPassphrase(payload: RecoverKeysByPassphrasePayload, metadata?: grpcWeb.Metadata): Promise<RecoverKeysByPassphraseResponse>;

dist/client.js

@@ -120,2 +120,18 @@ "use strict";
     }
+    removeDirOrFile(payload, metadata = {}) {
+        return new Promise((resolve, reject) => {
+            const request = new space_pb_1.RemoveDirOrFileRequest();
+            const path = payload.path.replace(/^\//, '');
+            const bucket = payload.bucket === '' ? null : payload.bucket;
+            request.setPath(path);
+            request.setBucket(bucket || this.defaultBucket);
+            this.instance.removeDirOrFile(request, metadata, (err, res) => {
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                resolve(res);
+            });
+        });
+    }
     backupKeysByPassphrase(payload, metadata = {}) {
@@ -122,0 +138,0 @@ return new Promise((resolve, reject) => {

dist/esm/client.js

 import { Empty } from 'google-protobuf/google/protobuf/empty_pb';
 import { SpaceApiClient } from './definitions/SpaceServiceClientPb';
-import { ListDirectoriesRequest, ToggleBucketBackupRequest, OpenFileRequest, CreateBucketRequest, AddItemsRequest, CreateFolderRequest, BackupKeysByPassphraseRequest, RecoverKeysByPassphraseRequest, ToggleFuseRequest, ListBucketsRequest, ListDirectoryRequest, ShareBucketRequest, JoinBucketRequest, ThreadInfo, GetPublicKeyRequest, ReadNotificationRequest, GetNotificationsRequest, HandleFilesInvitationRequest, DeleteKeyPairRequest, DeleteAccountRequest, GetUsageInfoRequest, GetStoredMnemonicRequest, RestoreKeyPairViaMnemonicRequest, GetSharedWithMeFilesRequest, ShareFilesViaPublicKeyRequest, GetAPISessionTokensRequest, GetRecentlySharedWithRequest, GeneratePublicFileLinkRequest, TestKeysPassphraseRequest, SetNotificationsLastSeenAtRequest, GenerateKeyPairRequest, FullPath, OpenPublicFileRequest, SearchFilesRequest, InitializeMasterAppTokenRequest, GetSharedByMeFilesRequest, } from './definitions/space_pb';
+import { ListDirectoriesRequest, ToggleBucketBackupRequest, OpenFileRequest, CreateBucketRequest, AddItemsRequest, CreateFolderRequest, RemoveDirOrFileRequest, BackupKeysByPassphraseRequest, RecoverKeysByPassphraseRequest, ToggleFuseRequest, ListBucketsRequest, ListDirectoryRequest, ShareBucketRequest, JoinBucketRequest, ThreadInfo, GetPublicKeyRequest, ReadNotificationRequest, GetNotificationsRequest, HandleFilesInvitationRequest, DeleteKeyPairRequest, DeleteAccountRequest, GetUsageInfoRequest, GetStoredMnemonicRequest, RestoreKeyPairViaMnemonicRequest, GetSharedWithMeFilesRequest, ShareFilesViaPublicKeyRequest, GetAPISessionTokensRequest, GetRecentlySharedWithRequest, GeneratePublicFileLinkRequest, TestKeysPassphraseRequest, SetNotificationsLastSeenAtRequest, GenerateKeyPairRequest, FullPath, OpenPublicFileRequest, SearchFilesRequest, InitializeMasterAppTokenRequest, GetSharedByMeFilesRequest, } from './definitions/space_pb';
 var DEFAULT_BUCKET = 'personal';
@@ -132,2 +132,20 @@ var SpaceClient = /** @class */ (function () {
     };
+    SpaceClient.prototype.removeDirOrFile = function (payload, metadata) {
+        var _this = this;
+        if (metadata === void 0) { metadata = {}; }
+        return new Promise(function (resolve, reject) {
+            var request = new RemoveDirOrFileRequest();
+            var path = payload.path.replace(/^\//, '');
+            var bucket = payload.bucket === '' ? null : payload.bucket;
+            request.setPath(path);
+            request.setBucket(bucket || _this.defaultBucket);
+            _this.instance.removeDirOrFile(request, metadata, function (err, res) {
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                resolve(res);
+            });
+        });
+    };
     SpaceClient.prototype.backupKeysByPassphrase = function (payload, metadata) {
@@ -134,0 +152,0 @@ var _this = this;

dist/types.d.ts

@@ -22,2 +22,6 @@ export interface ListDirectoryPayload {
 }
+export interface RemoveDirOrFilePayload {
+    path: string;
+    bucket?: string;
+}
 export interface BackupKeysByPassphrasePayload {
@@ -24,0 +28,0 @@ uuid: string;

package.json

 {
   "name": "@fleekhq/space-client",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "main": "dist/index.js",
@@ -5,0 +5,0 @@ "module": "dist/esm/index.js",

README.md

@@ -407,2 +407,24 @@ ![Publish Action Status](https://github.com/FleekHQ/space-client/workflows/Publish/badge.svg?branch=master)
 
+#### .removeDirOrFile({ path: string, bucket?: string })
+
+Removes a file or a folder and its content. 
+If you don't specify the `bucket` property, `client.defaultBucket` value is going to be used instead.
+
+```js
+  client
+    .removeDirOrFile({ path: '/', bucket: 'my-bucket' })
+    .then(() => {
+      console.log('Deleted file or folder');
+    })
+    .catch((err) => {
+      console.error(err);
+    });
+
+  /* Or using Async/Await */
+
+  const asyncFunc = async () => {
+    await client.removeDirOrFile({ path: '/', bucket: 'my-bucket' });
+  };
+```
+
 #### `[WIP]` <em>.toggleBucketBackup({ bucket: string, backup: boolean }) </em>
@@ -409,0 +431,0 @@

src/__tests__/client-calls.ts

@@ -17,2 +17,3 @@ // We disable the type checking because it interferes with jest's mocking function
   createFolder: jest.fn(),
+  removeDirOrFile: jest.fn(),
   createUsernameAndEmail: jest.fn(),
@@ -121,2 +122,11 @@ getIdentityByUsername: jest.fn(),
 
+it('removeDirOrFile makes the right requests', async () => {
+  client.removeDirOrFile({
+    bucket: 'my-bucket',
+    path: '/',
+  });
+
+  expect(client.instance.removeDirOrFile).toHaveBeenCalledTimes(1);
+});
+
 it('backupKeysByPassphrase makes the right requests', async () => {
@@ -123,0 +133,0 @@ client.backupKeysByPassphrase({

src/client.ts

@@ -10,2 +10,3 @@ import grpcWeb, { ClientReadableStream } from 'grpc-web';
   CreateFolderPayload,
+  RemoveDirOrFilePayload,
   BackupKeysByPassphrasePayload,
@@ -49,2 +50,4 @@ RecoverKeysByPassphrasePayload,
   CreateFolderResponse,
+  RemoveDirOrFileResponse,
+  RemoveDirOrFileRequest,
   BackupKeysByPassphraseRequest,
@@ -326,2 +329,29 @@ BackupKeysByPassphraseResponse,
 
+  removeDirOrFile(
+    payload: RemoveDirOrFilePayload,
+    metadata: grpcWeb.Metadata = {},
+  ): Promise<RemoveDirOrFileResponse> {
+    return new Promise((resolve, reject) => {
+      const request = new RemoveDirOrFileRequest();
+      const path = payload.path.replace(/^\//, '');
+
+      const bucket = payload.bucket === '' ? null : payload.bucket;
+
+      request.setPath(path);
+      request.setBucket(bucket || this.defaultBucket);
+
+      this.instance.removeDirOrFile(
+        request,
+        metadata,
+        (err: grpcWeb.Error, res: RemoveDirOrFileResponse) => {
+          if (err) {
+            reject(err);
+            return;
+          }
+          resolve(res);
+        },
+      );
+    });
+  }
+
   backupKeysByPassphrase(
@@ -328,0 +358,0 @@ payload: BackupKeysByPassphrasePayload,

src/types.ts

@@ -27,2 +27,7 @@ export interface ListDirectoryPayload {
 
+export interface RemoveDirOrFilePayload {
+  path: string;
+  bucket?: string;
+}
+
 export interface BackupKeysByPassphrasePayload {
@@ -29,0 +34,0 @@ uuid: string;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2801169

increased by0.17%

Lines of code

52440

increased by0.15%

Number of lines in readme file

1504

increased by1.48%

No dependency changes