Merge pull request #479 from uploadcare/chore/fix-docs

chore: fix typedoc

package.json

@@ -61,7 +61,7 @@
     "ts-jest": "29.0.5",
     "ts-node": "^10.9.1",
     "tslib": "^2.4.0",
-    "typedoc": "^0.23.28",
+    "typedoc": "^0.24.6",
     "typescript": "^5.0.2"
   }
 }

packages/api-client-utils/src/index.ts

@@ -15,6 +15,7 @@ export { ContentInfo } from './types/ContentInfo'
 export { ImageInfo } from './types/ImageInfo'
 export { Metadata } from './types/Metadata'
 export { VideoInfo } from './types/VideoInfo'
+export { StoreValue } from './types/StoreValue'
 export { onCancel } from './onCancel'
 export { CancelError } from './CancelError'
 export { poll } from './poll'

packages/api-client-utils/src/types/StoreValue.ts

@@ -0,0 +1 @@
+export type StoreValue = 'auto' | boolean

packages/rest-client/src/index.ts

@@ -27,7 +27,7 @@ export { Problems } from './types/Problems'
 export { ServerErrorResponse } from './types/ServerErrorResponse'
 export { Webhook } from './types/Webhook'
 export { WebhookEvent } from './types/WebhookEvent'
-export { StoreValue } from './types/StoreValue'
+export { StoreValue } from '@uploadcare/api-client-utils'
 export { Paginatable } from './types/Paginatable'
 export { Md5Function } from './lib/md5/Md5Function'
 export { ConversionOptions } from './types/ConversionOptions'

packages/rest-client/src/tools/storeValueToString.ts

@@ -1,4 +1,4 @@
-import { StoreValue } from '../types/StoreValue'
+import { StoreValue } from '@uploadcare/api-client-utils'
 import { RestClientError } from './RestClientError'
 
 export const storeValueToString = (store?: StoreValue): string | undefined => {

packages/rest-client/src/types/ConversionOptions.ts

@@ -1,5 +1,5 @@
 import { ConversionType } from './ConversionType'
-import { StoreValue } from './StoreValue'
+import { StoreValue } from '@uploadcare/api-client-utils'
 import { ValueOf } from './ValueOf'
 
 export type ConversionOptions<T extends ValueOf<typeof ConversionType>> = {

packages/upload-client/src/api/base.ts

@@ -1,7 +1,8 @@
 import {
   camelizeKeys,
   CustomUserAgent,
-  Metadata
+  Metadata,
+  StoreValue
 } from '@uploadcare/api-client-utils'
 import { defaultSettings } from '../defaultSettings'
 import request from '../request/request.node'
@@ -16,7 +17,7 @@ import { FailedResponse } from '../request/types'
 import { getContentType } from '../tools/getContentType'
 import { getFileName } from '../tools/getFileName'
 import { getStoreValue } from '../tools/getStoreValue'
-import { StoreValue, SupportedFileInput } from '../types'
+import { SupportedFileInput } from '../types'
 import { ProgressCallback, Uuid } from './types'
 
 export type BaseResponse = {

packages/upload-client/src/api/fromUrl.ts

@@ -3,7 +3,8 @@ import { FailedResponse } from '../request/types'
 import {
   CustomUserAgent,
   camelizeKeys,
-  Metadata
+  Metadata,
+  StoreValue
 } from '@uploadcare/api-client-utils'
 
 import request from '../request/request.node'
@@ -14,7 +15,6 @@ 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',

packages/upload-client/src/api/multipartStart.ts

@@ -3,7 +3,8 @@ import { Uuid } from './types'
 import {
   CustomUserAgent,
   camelizeKeys,
-  Metadata
+  Metadata,
+  StoreValue
 } from '@uploadcare/api-client-utils'
 
 import request from '../request/request.node'
@@ -18,7 +19,6 @@ 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

packages/upload-client/src/index.ts

@@ -87,7 +87,8 @@ export { Settings, SupportedFileInput as SupportedFileInput } from './types'
 export {
   NodeFile as NodeFile,
   BrowserFile as BrowserFile,
-  ReactNativeAsset
+  ReactNativeAsset,
+  Sliceable
 } from './types'
 export {
   FileInfo,

packages/upload-client/src/tools/getStoreValue.ts

@@ -1,4 +1,4 @@
-import { StoreValue } from '../types'
+import { StoreValue } from '@uploadcare/api-client-utils'
 
 export function getStoreValue(store?: StoreValue): 'auto' | '0' | '1' {
   if (typeof store === 'undefined' || store === 'auto') {

packages/upload-client/src/types.ts

@@ -1,6 +1,4 @@
-import { CustomUserAgent } from '@uploadcare/api-client-utils'
-
-export type StoreValue = 'auto' | boolean
+import { CustomUserAgent, StoreValue } from '@uploadcare/api-client-utils'
 
 export interface DefaultSettings {
   baseCDN: string

packages/upload-client/src/uploadFile/uploadDirect.ts

@@ -2,9 +2,13 @@ import base from '../api/base'
 import { isReadyPoll } from '../tools/isReadyPoll'
 import { UploadcareFile } from '../tools/UploadcareFile'
 
-import { CustomUserAgent, Metadata } from '@uploadcare/api-client-utils'
+import {
+  CustomUserAgent,
+  Metadata,
+  StoreValue
+} from '@uploadcare/api-client-utils'
 import { ProgressCallback } from '../api/types'
-import { StoreValue, SupportedFileInput } from '../types'
+import { SupportedFileInput } from '../types'
 
 export type DirectOptions = {
   publicKey: string

packages/upload-client/src/uploadFile/uploadFile.ts

@@ -10,9 +10,10 @@ import { getFileSize } from '../tools/getFileSize'
 import { isFileData } from '../tools/isFileData'
 import { isMultipart } from '../tools/isMultipart'
 import { UploadcareFile } from '../tools/UploadcareFile'
-import { StoreValue, SupportedFileInput } from '../types'
+import { SupportedFileInput } from '../types'
 import { isUrl, isUuid } from './types'
 import { uploadMultipart } from './uploadMultipart'
+import { StoreValue } from '@uploadcare/api-client-utils'
 
 export type FileFromOptions = {
   publicKey: string

packages/upload-client/src/uploadFile/uploadMultipart.ts

@@ -1,4 +1,8 @@
-import { CustomUserAgent, Metadata } from '@uploadcare/api-client-utils'
+import {
+  CustomUserAgent,
+  Metadata,
+  StoreValue
+} from '@uploadcare/api-client-utils'
 import multipartComplete from '../api/multipartComplete'
 import multipartStart from '../api/multipartStart'
 import multipartUpload, {
@@ -19,7 +23,7 @@ import {
 import { getContentType } from '../tools/getContentType'
 import { getFileName } from '../tools/getFileName'
 import { getFileSize } from '../tools/getFileSize'
-import { StoreValue, SupportedFileInput } from '../types'
+import { SupportedFileInput } from '../types'
 
 export type MultipartOptions = {
   publicKey: string

tsconfig.typedoc.json

@@ -1,4 +1,4 @@
 {
   "extends": "./tsconfig.json",
-  "exclude": ["node_modules", "**/*.test.ts"],
+  "exclude": ["node_modules", "**/*.test.ts", "**/test/_**"],
 }