feat(NOJIRA-123): Patch type improvements (#118)

* feat(types): tighten definition for PATCH operations * fix(types): forms.update type for patch operations
Typeform · Feb 19, 2024 · 2a92dc5 · 2a92dc5
1 parent efc8e11
commit 2a92dc5
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 12 deletions.
diff --git a/src/forms.ts b/src/forms.ts
@@ -73,11 +73,23 @@ export class Forms {
     return request(page, pageSize)
   }
 
-  public update(args: {
+  public update<T extends boolean>(args: {
     uid: string
-    override?: boolean
-    data: Typeform.Form
-  }): Promise<Typeform.Form> {
+    override?: T
+    data: T extends true
+      ? Typeform.Form
+      : Typeform.API.PATCH<
+          | '/settings/facebook_pixel'
+          | '/settings/google_analytics'
+          | '/settings/google_tag_manager'
+          | '/settings/is_public'
+          | '/settings/meta'
+          | '/cui_settings'
+          | '/theme'
+          | '/title'
+          | '/workspace'
+        >[]
+  }): Promise<T extends true ? Typeform.Form : null> {
     const { uid, override, data } = args
     const methodType = override ? 'put' : 'patch'
 

diff --git a/src/typeform-types.ts b/src/typeform-types.ts
@@ -113,9 +113,9 @@ export namespace Typeform {
         items: Workspace[]
       }
     }
-    export interface PATCH {
-      op: string
-      path: string
+    export interface PATCH<T extends string> {
+      op: 'add' | 'remove' | 'replace'
+      path: T
       value: any
     }
   }

diff --git a/src/utils.ts b/src/utils.ts
@@ -2,8 +2,8 @@ import { Typeform } from './typeform-types'
 
 export const createMemberPatchQuery = (
   members: string[],
-  operation: string
-): Typeform.API.PATCH[] => {
+  operation: Typeform.API.PATCH<'/members'>['op']
+): Typeform.API.PATCH<'/members'>[] => {
   return members.map((member) => ({
     op: operation,
     path: '/members',

diff --git a/src/workspaces.ts b/src/workspaces.ts
@@ -93,7 +93,7 @@ export class Workspaces {
 
   public update(args: {
     id: string
-    data: Typeform.API.PATCH[]
+    data: Typeform.API.PATCH<'/name' | '/members'>[]
   }): Promise<null> {
     const { id, data } = args
 
@@ -109,9 +109,9 @@ export class Workspaces {
 }
 
 const addOrRemoveMembers = (
-  operation: string,
+  operation: Typeform.API.PATCH<'/members'>['op'],
   members: string | string[]
-): Typeform.API.PATCH[] => {
+): Typeform.API.PATCH<'/members'>[] => {
   if (!isMemberPropValid(members)) {
     throw new Error(`No member(s) provided`)
   }