Merge pull request #494 from uploadcare/feature/document-info

feat(rest-client): add Document Info endpoint

packages/rest-client/src/api/conversion/conversionInfo.test.ts

@@ -0,0 +1,22 @@
+import { describe, it } from '@jest/globals'
+
+import 'jest-extended'
+import { DOCUMENT_UUID } from '../../../test/fixtures'
+import { testSettings } from '../../../test/helpers'
+import { conversionInfo } from './conversionInfo'
+
+describe('conversionInfo', () => {
+  it('should work with txt document', async () => {
+    const { error, format } = await conversionInfo(
+      { uuid: DOCUMENT_UUID },
+      testSettings
+    )
+
+    expect(error).toBeNull()
+    expect(format.name).toEqual('txt')
+    expect(format.conversionFormats).toBeArray()
+    expect(format.conversionFormats.map<string>(({ name }) => name)).toContain(
+      'pdf'
+    )
+  })
+})

packages/rest-client/src/api/conversion/conversionInfo.ts

@@ -0,0 +1,31 @@
+import { ApiRequestSettings, makeApiRequest } from '../../makeApiRequest'
+import { handleApiRequest } from '../handleApiRequest'
+
+export type ConversionInfoOptions = {
+  uuid: string
+}
+
+export type ConversionInfoResponse = {
+  error: string | null
+  format: {
+    name: string
+    conversionFormats: {
+      name: string
+    }[]
+  }
+  convertedGroups: Record<string, string>
+}
+
+export async function conversionInfo(
+  options: ConversionInfoOptions,
+  userSettings: ApiRequestSettings
+): Promise<ConversionInfoResponse> {
+  const apiRequest = await makeApiRequest(
+    {
+      method: 'GET',
+      path: `/convert/document/${options.uuid}/`
+    },
+    userSettings
+  )
+  return handleApiRequest({ apiRequest, okCodes: [200] })
+}

packages/rest-client/src/index.ts

@@ -197,6 +197,11 @@ export {
 
 /** Low-level Conversion API */
 export { convert } from './api/conversion/convert'
+export {
+  conversionInfo,
+  ConversionInfoOptions,
+  ConversionInfoResponse
+} from './api/conversion/conversionInfo'
 export { conversionJobStatus } from './api/conversion/conversionJobStatus'
 
 /** Low-level Addons API */