feat(PR-40): forms.copy (#102)

New method to retrieve form, sanitize the payload and create a new one.

Author: mathio

README.md

@@ -177,6 +177,11 @@ Each one of them encapsulates the operations related to it (like listing, updati
 
 - Deletes a typeform by UID
 
+#### `forms.copy({ uid, workspaceUrl })`
+
+- Copies an existing typeform with UID
+- `workspaceUrl` (optional) The URL of a workspace to copy the typeform into.
+
 #### `forms.messages.get({ uid })`
 
 - Get custom messages of the typeform with the given UID

src/forms.ts

@@ -1,5 +1,6 @@
 import { Typeform } from './typeform-types'
 import { autoPageItems } from './auto-page-items'
+import { removeFormKeys } from './utils'
 
 export class Forms {
   private _messages: FormMessages
@@ -86,6 +87,22 @@ export class Forms {
       data,
     })
   }
+
+  public async copy(args: {
+    uid: string
+    workspaceHref: string
+  }): Promise<Typeform.Form> {
+    const { uid, workspaceHref } = args
+    const input = await this.get({ uid })
+
+    const data = removeFormKeys(input) as Typeform.Form
+
+    if (workspaceHref) {
+      data.workspace = { href: workspaceHref }
+    }
+
+    return this.create({ data })
+  }
 }
 
 class FormMessages {

src/utils.ts

@@ -21,3 +21,27 @@ export const isMemberPropValid = (members: string | string[]): boolean => {
 // https://www.typeform.com/developers/get-started/#rate-limits
 export const rateLimit = () =>
   new Promise((resolve) => setTimeout(resolve, 500))
+
+export const removeFormKeys = (
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  input: any,
+  removeKeys: string[] = ['id', 'integrations']
+): unknown => {
+  if (Array.isArray(input)) {
+    return input.map((item) => removeFormKeys(item))
+  } else if (typeof input === 'object') {
+    return Object.keys(input).reduce(
+      (obj, key) => ({
+        ...obj,
+        ...(removeKeys.includes(key)
+          ? {}
+          : key === 'application'
+          ? { application: removeFormKeys(input[key], ['installation_id']) }
+          : { [key]: removeFormKeys(input[key]) }),
+      }),
+      {}
+    )
+  } else {
+    return input
+  }
+}

tests/unit/forms.test.ts

@@ -2,6 +2,7 @@ import { axios } from '../common'
 import { clientConstructor } from '../../src/create-client'
 import { API_BASE_URL } from '../../src/constants'
 import { Forms } from '../../src/forms'
+import * as utils from '../../src/utils'
 
 beforeEach(() => {
   axios.reset()
@@ -118,6 +119,40 @@ test('create form has the correct path and method ', async () => {
   expect(axios.history.post[0].url).toBe(`${API_BASE_URL}/forms`)
 })
 
+test('copy form retrieves form and creates form with correct payload', async () => {
+  const uid = 'foo'
+  const workspaceHref = 'http://localhost/workspace/bar'
+  const formDefinition = {
+    id: uid,
+    title: 'hola',
+    fields: [
+      { id: '1', title: 'foo', description: 'foobar' },
+      { id: '2', title: 'bar', supersized: true },
+    ],
+  }
+  const getSpy = jest
+    .spyOn(formsRequest, 'get')
+    .mockImplementationOnce(() => Promise.resolve(formDefinition))
+  const removeFormKeysSpy = jest.spyOn(utils, 'removeFormKeys')
+  const createSpy = jest.spyOn(formsRequest, 'create')
+  await formsRequest.copy({
+    uid,
+    workspaceHref,
+  })
+  expect(getSpy).toHaveBeenCalledWith({ uid })
+  expect(removeFormKeysSpy).toHaveBeenCalledWith(formDefinition)
+  expect(createSpy).toHaveBeenCalledWith({
+    data: {
+      title: 'hola',
+      fields: [
+        { title: 'foo', description: 'foobar' },
+        { title: 'bar', supersized: true },
+      ],
+      workspace: { href: workspaceHref },
+    },
+  })
+})
+
 test('get messages has the correct path and method ', async () => {
   await formsRequest.messages.get({ uid: 'abc123' })
 

tests/unit/utils.test.ts

@@ -0,0 +1,71 @@
+import { isMemberPropValid, removeFormKeys } from '../../src/utils'
+
+describe('#utils', () => {
+  describe('#isMemberPropValid', () => {
+    test.each(['1', 'foobar', [], ['foo', 'bar'], [1, 2, 3]])(
+      '%p should return truthy',
+      (value) => {
+        expect(isMemberPropValid(value as string)).toBeTruthy()
+      }
+    )
+
+    test.each(['', 1, null, undefined, true, false, {}, { foo: 1 }])(
+      '%p should return falsy',
+      (value) => {
+        expect(isMemberPropValid(value as string)).toBeFalsy()
+      }
+    )
+  })
+
+  describe('#removeFormKeys', () => {
+    it('should remove unwanted keys from the form object', () => {
+      expect(
+        removeFormKeys({
+          id: 'foo',
+          title: 'foobar',
+          items: [
+            { id: 1, title: 'one' },
+            {
+              id: 2,
+              title: 'two',
+              application: { id: 'a', installation_id: 'b', value: 'c' },
+            },
+            {
+              id: 3,
+              title: 'three',
+              values: ['foo', 'bar'],
+              settings: { id: 33, value: false },
+              integrations: [5, 6, 7],
+            },
+          ],
+          integrations: { foo: 'bar' },
+          application: { id: 11, installation_id: 22 },
+          settings: { id: 'bar', enabled: true },
+          links: [
+            'http://example.com',
+            'http://localhost',
+            { id: 'foo', url: 'http://foo' },
+          ],
+        })
+      ).toEqual({
+        title: 'foobar',
+        items: [
+          { title: 'one' },
+          { title: 'two', application: { id: 'a', value: 'c' } },
+          {
+            title: 'three',
+            values: ['foo', 'bar'],
+            settings: { value: false },
+          },
+        ],
+        application: { id: 11 },
+        settings: { enabled: true },
+        links: [
+          'http://example.com',
+          'http://localhost',
+          { url: 'http://foo' },
+        ],
+      })
+    })
+  })
+})