type API methods and integrate robot types #206

some types are still todo

Author: mifi

examples/convert_to_webp.js

@@ -17,7 +17,7 @@ const filePath = process.argv[2]
 
 ;(async () => {
   try {
-    const opts = {
+    const status = await transloadit.createAssembly({
       files: {
         file1: filePath,
       },
@@ -33,9 +33,7 @@ const filePath = process.argv[2]
         },
       },
       waitForCompletion: true,
-    }
-
-    const status = await transloadit.createAssembly(opts)
+    })
     console.log('Your WebP file:', status.results.webp[0].url)
   } catch (err) {
     console.error('createAssembly failed', err)

examples/credentials.js

@@ -17,6 +17,9 @@ const transloadit = new Transloadit({
 const firstName = 'myProductionS3'
 const secondName = 'myStagingS3'
 
+/**
+ * @type {import('transloadit').CreateTemplateCredentialParams}
+ */
 const credentialParams = {
   name: firstName,
   type: 's3',

examples/face_detect_download.js

@@ -13,6 +13,7 @@
 const got = require('got')
 const { createWriteStream } = require('fs')
 const { Transloadit } = require('transloadit')
+const assert = require('assert')
 
 const transloadit = new Transloadit({
   authKey: /** @type {string} */ (process.env.TRANSLOADIT_KEY),
@@ -23,7 +24,7 @@ const filePath = process.argv[2]
 
 ;(async () => {
   try {
-    const opts = {
+    const status = await transloadit.createAssembly({
       files: {
         file1: filePath,
       },
@@ -40,14 +41,14 @@ const filePath = process.argv[2]
         },
       },
       waitForCompletion: true,
-    }
-
-    const status = await transloadit.createAssembly(opts)
+    })
 
     // Now save the file
     const outPath = './output-face.jpg'
     const stream = createWriteStream(outPath)
-    await got.default.stream(status.results.facesDetected[0].url).pipe(stream)
+    const { url } = status.results.facesDetected[0]
+    assert(url != null)
+    await got.default.stream(url).pipe(stream)
     console.log('Your cropped face has been saved to', outPath)
   } catch (err) {
     console.error('createAssembly failed', err)

examples/rasterize_svg_to_png.js

@@ -17,7 +17,7 @@ const filePath = process.argv[2]
 
 ;(async () => {
   try {
-    const opts = {
+    const status = await transloadit.createAssembly({
       files: {
         file1: filePath,
       },
@@ -31,9 +31,7 @@ const filePath = process.argv[2]
         },
       },
       waitForCompletion: true,
-    }
-
-    const status = await transloadit.createAssembly(opts)
+    })
     console.log('Your PNG file:', status.results.png[0].url)
   } catch (err) {
     console.error('createAssembly failed', err)

examples/resize_an_image.js

@@ -17,7 +17,7 @@ const filePath = process.argv[2]
 
 ;(async () => {
   try {
-    const opts = {
+    const status = await transloadit.createAssembly({
       files: {
         file1: filePath,
       },
@@ -34,9 +34,7 @@ const filePath = process.argv[2]
         },
       },
       waitForCompletion: true,
-    }
-
-    const status = await transloadit.createAssembly(opts)
+    })
     console.log('Your resized image:', status.results.resize[0].url)
   } catch (err) {
     console.error('createAssembly failed', err)

examples/template_api.js

@@ -13,6 +13,7 @@ const transloadit = new Transloadit({
   authSecret: /** @type {string} */ (process.env.TRANSLOADIT_SECRET),
 })
 
+/** @type {import('transloadit').TemplateContent} */
 const template = {
   steps: {
     encode: {
@@ -22,7 +23,7 @@ const template = {
     },
     thumbnail: {
       use: 'encode',
-      robot: '/video/thumbnails',
+      robot: '/video/thumbs',
     },
   },
 }

src/PaginationStream.ts

@@ -1,8 +1,14 @@
 import { Readable } from 'stream'
-import { PaginationList } from './Transloadit'
+import { PaginationList, PaginationListWithCount } from './apiTypes'
 
 // eslint-disable-next-line no-unused-vars
-type FetchPage<T> = (pageno: number) => PaginationList<T> | PromiseLike<PaginationList<T>>
+type FetchPage<T> = (
+  pageno: number
+) =>
+  | PaginationList<T>
+  | PromiseLike<PaginationList<T>>
+  | PaginationListWithCount<T>
+  | PromiseLike<PaginationListWithCount<T>>
 
 export default class PaginationStream<T> extends Readable {
   private _fetchPage: FetchPage<T>
@@ -33,8 +39,10 @@ export default class PaginationStream<T> extends Readable {
     }
 
     try {
-      const { count, items } = await this._fetchPage(++this._pageno)
-      this._nitems = count
+      const { items, ...rest } = await this._fetchPage(++this._pageno)
+      if ('count' in rest) {
+        this._nitems = rest.count
+      }
 
       this._items = Array.from(items)
       this._items.reverse()