[Storage] Add methods to pin and unpin an upload (#166)

spheronFdn · Oct 16, 2023 · ed73a48 · ed73a48
1 parent ce1c097
commit ed73a48
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 9 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@spheron/core",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "Shared core package for all sdk packages",
   "keywords": [
     "Storage",

diff --git a/packages/core/src/spheron-api/index.ts b/packages/core/src/spheron-api/index.ts
@@ -1253,6 +1253,20 @@ class SpheronApi {
     return upload;
   }
 
+  async pinUpload(uploadId: string): Promise<Upload> {
+    const { upload } = await this.sendApiRequest<{
+      upload: Upload;
+    }>(HttpMethods.PATCH, `/v1/upload/${uploadId}/pin`);
+    return upload;
+  }
+
+  async unpinUpload(uploadId: string): Promise<Upload> {
+    const { upload } = await this.sendApiRequest<{
+      upload: Upload;
+    }>(HttpMethods.PATCH, `/v1/upload/${uploadId}/unpin`);
+    return upload;
+  }
+
   //#region Upload API
 
   private async sendApiRequest<T>(

diff --git a/packages/storage/README.md b/packages/storage/README.md
@@ -14,7 +14,7 @@
 
 <p align="center">  
   <a href="https://www.npmjs.com/package/@spheron/storage" target="_blank" rel="noreferrer">
-    <img src="https://img.shields.io/static/v1?label=npm&message=v2.0.2&color=green" />
+    <img src="https://img.shields.io/static/v1?label=npm&message=v2.0.3&color=green" />
   </a>
   <a href="https://github.com/spheronFdn/sdk/blob/main/LICENSE" target="_blank" rel="noreferrer">
     <img src="https://img.shields.io/static/v1?label=license&message=Apache%202.0&color=red" />

diff --git a/packages/storage/package.json b/packages/storage/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@spheron/storage",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Typescript library for uploading files or directory to  IPFS, Filecoin or Arweave via Spheron",
   "keywords": [
     "Storage",
@@ -35,7 +35,7 @@
     "dist/"
   ],
   "dependencies": {
-    "@spheron/core": "2.0.3",
+    "@spheron/core": "2.0.4",
     "@spheron/encryption": "1.0.0",
     "form-data": "^4.0.0",
     "multiformats": "^9.9.0"

diff --git a/packages/storage/src/bucket-manager/index.ts b/packages/storage/src/bucket-manager/index.ts
@@ -162,6 +162,16 @@ class BucketManager {
     return this.mapCoreUpload(upload);
   }
 
+  async pinUpload(uploadId: string): Promise<Upload> {
+    const upload = await this.spheronApi.pinUpload(uploadId);
+    return this.mapCoreUpload(upload);
+  }
+
+  async unpinUpload(uploadId: string): Promise<Upload> {
+    const upload = await this.spheronApi.unpinUpload(uploadId);
+    return this.mapCoreUpload(upload);
+  }
+
   async getBucketIpnsRecords(bucketId: string): Promise<IpnsRecord[]> {
     const { ipnsRecords } = await this.spheronApi.getBucketIpnsRecords(
       bucketId

diff --git a/packages/storage/src/index.ts b/packages/storage/src/index.ts
@@ -506,6 +506,18 @@ export class SpheronClient extends ScopeExtractor {
     return await this.bucketManager.getUpload(uploadId);
   }
 
+  async pinUpload(uploadId: string): Promise<Upload> {
+    await this.validateStorageOrganizationType();
+
+    return await this.bucketManager.pinUpload(uploadId);
+  }
+
+  async unpinUpload(uploadId: string): Promise<Upload> {
+    await this.validateStorageOrganizationType();
+
+    return await this.bucketManager.unpinUpload(uploadId);
+  }
+
   async getOrganizationUsage(organizationId: string): Promise<UsageWithLimits> {
     await this.validateStorageOrganizationType();
 
@@ -597,7 +609,7 @@ export class SpheronClient extends ScopeExtractor {
   }
 
   async migrateStaticSiteOrgToStorage(
-    webappOrganizationId: string,
+    staticSiteOrganizationId: string,
     storageOrganizationId: string
   ): Promise<{
     numberOfBuckets: number;
@@ -606,7 +618,7 @@ export class SpheronClient extends ScopeExtractor {
     await this.validateStorageOrganizationType();
 
     return await this.spheronApi.migrateStaticSiteOrgToStorage(
-      webappOrganizationId,
+      staticSiteOrganizationId,
       storageOrganizationId
     );
   }