feat(upload-client): accept auto as store value (#460)

uploadcare · Jan 20, 2023 · e140644 · e140644
1 parent f52f26f
commit e140644
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 13 deletions.
diff --git a/packages/upload-client/src/api/base.ts b/packages/upload-client/src/api/base.ts
@@ -16,7 +16,7 @@ import { FailedResponse } from '../request/types'
 import { getContentType } from '../tools/getContentType'
 import { getFileName } from '../tools/getFileName'
 import { getStoreValue } from '../tools/getStoreValue'
-import { SupportedFileInput } from '../types'
+import { StoreValue, SupportedFileInput } from '../types'
 import { ProgressCallback, Uuid } from './types'
 
 export type BaseResponse = {
@@ -32,7 +32,7 @@ export type BaseOptions = {
   baseURL?: string
   secureSignature?: string
   secureExpire?: string
-  store?: boolean
+  store?: StoreValue
   contentType?: string
 
   signal?: AbortSignal

diff --git a/packages/upload-client/src/api/fromUrl.ts b/packages/upload-client/src/api/fromUrl.ts
@@ -14,6 +14,7 @@ import { getUserAgent } from '../tools/getUserAgent'
 import { UploadClientError } from '../tools/errors'
 import { retryIfFailed } from '../tools/retryIfFailed'
 import { getStoreValue } from '../tools/getStoreValue'
+import { StoreValue } from '../types'
 
 export enum TypeEnum {
   Token = 'token',
@@ -57,7 +58,7 @@ export type FromUrlOptions = {
   publicKey: string
 
   baseURL?: string
-  store?: boolean
+  store?: StoreValue
   fileName?: string
   checkForUrlDuplicates?: boolean
   saveUrlForRecurrentUploads?: boolean

diff --git a/packages/upload-client/src/api/multipartStart.ts b/packages/upload-client/src/api/multipartStart.ts
@@ -18,6 +18,7 @@ import { getUserAgent } from '../tools/getUserAgent'
 import { retryIfFailed } from '../tools/retryIfFailed'
 import { UploadClientError } from '../tools/errors'
 import { getStoreValue } from '../tools/getStoreValue'
+import { StoreValue } from '../types'
 
 export type MultipartStartOptions = {
   publicKey: string
@@ -26,7 +27,7 @@ export type MultipartStartOptions = {
   baseURL?: string
   secureSignature?: string
   secureExpire?: string
-  store?: boolean
+  store?: StoreValue
   multipartChunkSize?: number
   signal?: AbortSignal
   source?: string

diff --git a/packages/upload-client/src/tools/getStoreValue.ts b/packages/upload-client/src/tools/getStoreValue.ts
@@ -1,3 +1,8 @@
-export function getStoreValue(store?: 'auto' | boolean): 'auto' | '0' | '1' {
-  return typeof store === 'undefined' ? 'auto' : store ? '1' : '0'
+import { StoreValue } from '../types'
+
+export function getStoreValue(store?: StoreValue): 'auto' | '0' | '1' {
+  if (typeof store === 'undefined' || store === 'auto') {
+    return 'auto'
+  }
+  return store ? '1' : '0'
 }
diff --git a/packages/upload-client/src/types.ts b/packages/upload-client/src/types.ts
@@ -1,5 +1,7 @@
 import { CustomUserAgent } from '@uploadcare/api-client-utils'
 
+export type StoreValue = 'auto' | boolean
+
 export interface DefaultSettings {
   baseCDN: string
   baseURL: string
@@ -18,7 +20,7 @@ export interface Settings extends Partial<DefaultSettings> {
   publicKey: string
   fileName?: string
   contentType?: string
-  store?: boolean
+  store?: StoreValue
   secureSignature?: string
   secureExpire?: string
   integration?: string

diff --git a/packages/upload-client/src/uploadFile/uploadDirect.ts b/packages/upload-client/src/uploadFile/uploadDirect.ts
@@ -4,7 +4,7 @@ import { UploadcareFile } from '../tools/UploadcareFile'
 
 import { CustomUserAgent, Metadata } from '@uploadcare/api-client-utils'
 import { ProgressCallback } from '../api/types'
-import { SupportedFileInput } from '../types'
+import { StoreValue, SupportedFileInput } from '../types'
 
 export type DirectOptions = {
   publicKey: string
@@ -13,7 +13,7 @@ export type DirectOptions = {
   baseURL?: string
   secureSignature?: string
   secureExpire?: string
-  store?: boolean
+  store?: StoreValue
   contentType?: string
 
   signal?: AbortSignal

diff --git a/packages/upload-client/src/uploadFile/uploadFile.ts b/packages/upload-client/src/uploadFile/uploadFile.ts
@@ -10,7 +10,7 @@ import { getFileSize } from '../tools/getFileSize'
 import { isFileData } from '../tools/isFileData'
 import { isMultipart } from '../tools/isMultipart'
 import { UploadcareFile } from '../tools/UploadcareFile'
-import { SupportedFileInput } from '../types'
+import { StoreValue, SupportedFileInput } from '../types'
 import { isUrl, isUuid } from './types'
 import { uploadMultipart } from './uploadMultipart'
 
@@ -21,7 +21,7 @@ export type FileFromOptions = {
   baseURL?: string
   secureSignature?: string
   secureExpire?: string
-  store?: boolean
+  store?: StoreValue
 
   signal?: AbortSignal
   onProgress?: ProgressCallback

diff --git a/packages/upload-client/src/uploadFile/uploadMultipart.ts b/packages/upload-client/src/uploadFile/uploadMultipart.ts
@@ -19,7 +19,7 @@ import {
 import { getContentType } from '../tools/getContentType'
 import { getFileName } from '../tools/getFileName'
 import { getFileSize } from '../tools/getFileSize'
-import { SupportedFileInput } from '../types'
+import { StoreValue, SupportedFileInput } from '../types'
 
 export type MultipartOptions = {
   publicKey: string
@@ -30,7 +30,7 @@ export type MultipartOptions = {
   baseURL?: string
   secureSignature?: string
   secureExpire?: string
-  store?: boolean
+  store?: StoreValue
   signal?: AbortSignal
   onProgress?: ProgressCallback<ComputableProgressInfo>
   source?: string

diff --git a/packages/upload-client/test/tools/getStoreValue.test.ts b/packages/upload-client/test/tools/getStoreValue.test.ts
@@ -5,6 +5,10 @@ describe('getStoreValue', () => {
     expect(getStoreValue()).toEqual('auto')
   })
 
+  it('should return auto if store is auto', () => {
+    expect(getStoreValue('auto')).toEqual('auto')
+  })
+
   it('should return `1` if store is true', () => {
     expect(getStoreValue(true)).toEqual('1')
   })