fix: go back to storageType to avoid breaking the api

README.md

@@ -873,7 +873,7 @@ const { name: fileName, data: fileBuffer } = await akord.stack.getVersion(stackI
 Get stack file uri by index, return the latest file uri by default
 
 - `stackId` (`string`, required)
-- `type` (`StorageClass`, optional) - storage type, default to arweave
+- `type` (`StorageType`, optional) - storage type, default to arweave
 - `index` (`number`, optional) - file version index, default to latest
 - returns `Promise<string>` - Promise with stack file uri
 

src/__tests__/stack.test.ts

@@ -2,7 +2,7 @@ import { Akord } from "../index";
 import faker from '@faker-js/faker';
 import { initInstance, testDataPath, vaultCreate } from './common';
 import { email, password } from './data/test-credentials';
-import { StorageClass } from "../types/file";
+import { StorageType } from "../types/file";
 import { NodeJs } from "../types/file-like";
 import { getTxData } from "../arweave";
 import { firstFileName, secondFileName, arweaveImportFileTx } from './data/content';
@@ -62,7 +62,7 @@ export const stackCreate = async (vaultId: string) => {
   expect(stack.versions.length).toEqual(1);
   expect(stack.versions[0].name).toEqual(firstFileName);
 
-  const binary = await akord.file.get(stack.getUri(StorageClass.S3, 0), vaultId);
+  const binary = await akord.file.get(stack.getUri(StorageType.S3, 0), vaultId);
   expect(binary).toEqual(await file.arrayBuffer());
   return stackId;
 }

src/api/akord-api.ts

@@ -11,11 +11,11 @@ import { Transaction } from "../types/transaction";
 import { Paginated } from "../types/paginated";
 import { ListOptions, VaultApiGetOptions } from "../types/query-options";
 import { User, UserPublicInfo } from "../types/user";
-import { FileDownloadOptions, FileUploadOptions, StorageClass } from "../types/file";
+import { FileDownloadOptions, FileUploadOptions, StorageType } from "../types/file";
 import { EncryptionMetadata } from "../types/encryption";
 
 export const defaultFileUploadOptions = {
-  storage: StorageClass.ARWEAVE,
+  storage: StorageType.ARWEAVE,
   public: false
 };
 

src/api/api-client.ts

@@ -10,7 +10,7 @@ import { throwError } from "../errors/error";
 import { BadRequest } from "../errors/bad-request";
 import { NotFound } from "../errors/not-found";
 import { User, UserPublicInfo } from "../types/user";
-import { StorageClass } from "../types/file";
+import { StorageType } from "../types/file";
 
 export class ApiClient {
   private _storageurl: string;
@@ -32,7 +32,7 @@ export class ApiClient {
   private _input: ContractInput;
   private _vaultId: string;
   private _cacheOnly: boolean;
-  private _storage: StorageClass;
+  private _storage: StorageType;
   private _numberOfChunks: number;
 
   constructor() { }
@@ -59,7 +59,7 @@ export class ApiClient {
     return this;
   }
 
-  storage(storage: StorageClass): ApiClient {
+  storage(storage: StorageType): ApiClient {
     this._storage = storage;
     return this;
   }

src/core/file.ts

@@ -4,7 +4,7 @@ import { base64ToArray, digestRaw, signHash } from "@akord/crypto";
 import { Logger } from "../logger";
 import { ApiClient } from "../api/api-client";
 import { v4 as uuid } from "uuid";
-import { DownloadOptions, FileDownloadOptions, FileUploadOptions, FileUploadResult, Hooks, StorageClass } from "../types/file";
+import { DownloadOptions, FileDownloadOptions, FileUploadOptions, FileUploadResult, Hooks, StorageType } from "../types/file";
 import { FileLike } from "../types/file-like";
 import { Blob } from "buffer";
 import { Tag, Tags } from "../types/contract";
@@ -133,7 +133,7 @@ class FileService extends Service {
       .data(processedData)
       .tags(tags.concat(encryptionTags))
       .public(this.isPublic)
-      .storage(StorageClass.S3)
+      .storage(StorageType.S3)
       .uploadFile()
     resourceUri.push(`arweave:${fileTxId}`);
     return { file, resourceUri };
@@ -260,7 +260,7 @@ class FileService extends Service {
       .data(chunk.processedData)
       .tags(tags.concat(chunk.encryptionTags))
       .public(this.isPublic)
-      .storage(StorageClass.S3)
+      .storage(StorageType.S3)
       .progressHook(options.progressHook, chunkNumber * this.chunkSize, resourceSize)
       .cancelHook(options.cancelHook)
       .uploadFile()

src/core/service.ts

@@ -26,7 +26,7 @@ import { EncryptedPayload } from "@akord/crypto/lib/types";
 import { IncorrectEncryptionKey } from "../errors/incorrect-encryption-key";
 import { ProfileDetails } from "../types/profile-details";
 import { ListOptions } from "../types/query-options";
-import { StorageClass } from "../types/file";
+import { StorageType } from "../types/file";
 import { EncryptionMetadata } from "../types/encryption";
 
 export const STATE_CONTENT_TYPE = "application/json";
@@ -251,7 +251,7 @@ class Service {
 
   protected async processAvatar(avatar: ArrayBuffer, cacheOnly?: boolean): Promise<string[]> {
     const { processedData, encryptionTags } = await this.processWriteRaw(avatar);
-    const storage = cacheOnly ? StorageClass.S3 : StorageClass.ARWEAVE;
+    const storage = cacheOnly ? StorageType.S3 : StorageType.ARWEAVE;
     return this.api.uploadFile(processedData, encryptionTags, { storage, public: false });
   }
 

src/core/stack.ts

@@ -1,7 +1,7 @@
 import { NodeService } from "./node";
 import { actionRefs, functions, objectType } from "../constants";
 import { FileService } from "./file";
-import { FileUploadOptions, FileVersion, StorageClass } from "../types/file";
+import { FileUploadOptions, FileVersion, StorageType } from "../types/file";
 import { FileLike } from "../types/file-like";
 import { nodeType, NodeCreateOptions } from "../types/node";
 import { Stack, StackCreateOptions, StackCreateResult, StackUpdateResult } from "../types/stack";
@@ -22,7 +22,7 @@ class StackService extends NodeService<Stack> {
     Promise<StackCreateResult> {
     await this.setVaultContext(vaultId);
     const optionsFromVault = {
-      storage: this.vault.cacheOnly ? StorageClass.S3 : StorageClass.ARWEAVE
+      storage: this.vault.cacheOnly ? StorageType.S3 : StorageType.ARWEAVE
     }
     const createOptions = {
       ...this.defaultCreateOptions,
@@ -84,7 +84,7 @@ class StackService extends NodeService<Stack> {
     this.setActionRef(actionRefs.STACK_UPLOAD_REVISION);
 
     const optionsFromVault = {
-      storage: this.object.__cacheOnly__ ? StorageClass.S3 : StorageClass.ARWEAVE
+      storage: this.object.__cacheOnly__ ? StorageType.S3 : StorageType.ARWEAVE
     }
 
     const uploadOptions = {
@@ -110,7 +110,7 @@ class StackService extends NodeService<Stack> {
     const version = stack.getVersion(index);
     await this.setVaultContext(stack.vaultId);
     this.setVaultContextForFile();
-    const { fileData, metadata } = await this.api.downloadFile(version.getUri(StorageClass.S3), { public: this.isPublic });
+    const { fileData, metadata } = await this.api.downloadFile(version.getUri(StorageType.S3), { public: this.isPublic });
     const data = await this.processReadRaw(fileData, metadata);
     const name = await this.processReadString(version.name);
     return { name, data };
@@ -119,11 +119,11 @@ class StackService extends NodeService<Stack> {
   /**
    * Get stack file uri by index, return the latest file uri by default
    * @param  {string} stackId
-   * @param  {StorageClass} [type] storage type, default to arweave
+   * @param  {StorageType} [type] storage type, default to arweave
    * @param  {number} [index] file version index, default to latest
    * @returns Promise with stack file uri
    */
-  public async getUri(stackId: string, type: StorageClass = StorageClass.ARWEAVE, index?: number): Promise<string> {
+  public async getUri(stackId: string, type: StorageType = StorageType.ARWEAVE, index?: number): Promise<string> {
     const stack = new Stack(await this.api.getNode<Stack>(stackId, objectType.STACK, this.vaultId), null);
     return stack.getUri(type, index);
   }

src/types/file.ts

@@ -26,7 +26,7 @@ export class FileVersion extends Encryptable implements Version {
     this.status = fileVersionProto.status;
   }
 
-  getUri(type: StorageClass): string {
+  getUri(type: StorageType): string {
     const resourceUri = this.resourceUri
       ?.find(uri => uri.startsWith(type))
       ?.replace(type + ":", "");
@@ -52,7 +52,7 @@ export type Hooks = {
 
 export type FileUploadOptions = Hooks & {
   public?: boolean,
-  storage?: StorageClass,
+  storage?: StorageType,
   arweaveTags?: Tags
 }
 
@@ -64,7 +64,7 @@ export type FileDownloadOptions = Hooks & {
   resourceSize?: number
 }
 
-export enum StorageClass {
+export enum StorageType {
   ARWEAVE = "arweave",
   S3 = "s3"
 }

src/types/stack.ts

@@ -1,6 +1,6 @@
 import { encrypted, EncryptedKeys } from "@akord/crypto";
 import { Node, NodeCreateOptions } from "./node";
-import { FileUploadOptions, FileVersion, StorageClass } from "./file";
+import { FileUploadOptions, FileVersion, StorageType } from "./file";
 
 export class Stack extends Node {
   @encrypted() name: string;
@@ -12,7 +12,7 @@ export class Stack extends Node {
     this.versions = (nodeLike.versions || []).map((version: FileVersion) => new FileVersion(version, keys));
   }
 
-  getUri(type: StorageClass = StorageClass.ARWEAVE, index?: number): string {
+  getUri(type: StorageType = StorageType.ARWEAVE, index?: number): string {
     const version = this.getVersion(index);
     return version.getUri(type);
   }