chore: limited variable types (#692)

Co-authored-by: Lucas da Costa <[email protected]>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Vitor Capretz <[email protected]>
Co-authored-by: Gabriel Miranda <[email protected]>
Co-authored-by: Ty Mick <[email protected]>
Co-authored-by: Isabella Aquino <[email protected]>
Co-authored-by: Alexandre Cisneiros <[email protected]>
Co-authored-by: Carolina de Moraes Josephik <[email protected]>
Co-authored-by: Carolina de Moraes Josephik <[email protected]>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: Vitor Capretz <[email protected]>
Co-authored-by: Cassio Zen <[email protected]>
Co-authored-by: Bu Kinoshita <[email protected]>
Co-authored-by: Zeno Rocha <[email protected]>

Author: 13 people

src/templates/interfaces/create-template-options.interface.ts

@@ -1,11 +1,7 @@
 import type { PostOptions } from '../../common/interfaces';
 import type { RequireAtLeastOne } from '../../common/interfaces/require-at-least-one';
 import type { ErrorResponse } from '../../interfaces';
-import type {
-  Template,
-  TemplateVariable,
-  TemplateVariableListFallbackType,
-} from './template';
+import type { Template, TemplateVariable } from './template';
 
 type TemplateContentCreationOptions = RequireAtLeastOne<{
   html: string;
@@ -22,18 +18,6 @@ type TemplateVariableCreationOptions = Pick<TemplateVariable, 'key' | 'type'> &
         type: 'number';
         fallbackValue?: number | null;
       }
-    | {
-        type: 'boolean';
-        fallbackValue?: boolean | null;
-      }
-    | {
-        type: 'object';
-        fallbackValue: Record<string, unknown>;
-      }
-    | {
-        type: 'list';
-        fallbackValue: TemplateVariableListFallbackType;
-      }
   );
 
 type TemplateOptionalFieldsForCreation = Partial<

src/templates/interfaces/template.ts

@@ -16,22 +16,10 @@ export interface Template {
   current_version_id: string;
 }
 
-export type TemplateVariableListFallbackType =
-  | string[]
-  | number[]
-  | boolean[]
-  | Record<string, unknown>[];
-
 export interface TemplateVariable {
   key: string;
-  fallback_value:
-    | string
-    | number
-    | boolean
-    | Record<string, unknown>
-    | TemplateVariableListFallbackType
-    | null;
-  type: 'string' | 'number' | 'boolean' | 'object' | 'list';
+  fallback_value: string | number | null;
+  type: 'string' | 'number';
   created_at: string;
   updated_at: string;
 }

src/templates/interfaces/update-template.interface.ts

@@ -1,9 +1,5 @@
 import type { ErrorResponse } from '../../interfaces';
-import type {
-  Template,
-  TemplateVariable,
-  TemplateVariableListFallbackType,
-} from './template';
+import type { Template, TemplateVariable } from './template';
 
 type TemplateVariableUpdateOptions = Pick<TemplateVariable, 'key' | 'type'> &
   (
@@ -15,18 +11,6 @@ type TemplateVariableUpdateOptions = Pick<TemplateVariable, 'key' | 'type'> &
         type: 'number';
         fallbackValue?: number | null;
       }
-    | {
-        type: 'boolean';
-        fallbackValue?: boolean | null;
-      }
-    | {
-        type: 'object';
-        fallbackValue: Record<string, unknown>;
-      }
-    | {
-        type: 'list';
-        fallbackValue: TemplateVariableListFallbackType;
-      }
   );
 
 export interface UpdateTemplateOptions

src/templates/templates.spec.ts

@@ -264,61 +264,6 @@ describe('Templates', () => {
         'Failed to render React component. Make sure to install `@react-email/render`',
       );
     });
-
-    it('creates a template with object and list variable types', async () => {
-      const payload: CreateTemplateOptions = {
-        name: 'Complex Variables Template',
-        html: '<h1>Welcome {{{userProfile.name}}}!</h1><p>Your tags: {{{tags}}}</p>',
-        variables: [
-          {
-            key: 'userProfile',
-            type: 'object',
-            fallbackValue: { name: 'John', age: 30 },
-          },
-          {
-            key: 'tags',
-            type: 'list',
-            fallbackValue: ['premium', 'vip'],
-          },
-          {
-            key: 'scores',
-            type: 'list',
-            fallbackValue: [95, 87, 92],
-          },
-          {
-            key: 'flags',
-            type: 'list',
-            fallbackValue: [true, false, true],
-          },
-          {
-            key: 'items',
-            type: 'list',
-            fallbackValue: [{ id: 1 }, { id: 2 }],
-          },
-        ],
-      };
-      const response: CreateTemplateResponseSuccess = {
-        object: 'template',
-        id: 'fd61172c-cafc-40f5-b049-b45947779a29',
-      };
-
-      mockSuccessResponse(response, {
-        headers: { Authorization: `Bearer ${TEST_API_KEY}` },
-      });
-
-      const resend = new Resend(TEST_API_KEY);
-      await expect(
-        resend.templates.create(payload),
-      ).resolves.toMatchInlineSnapshot(`
-        {
-          "data": {
-            "id": "fd61172c-cafc-40f5-b049-b45947779a29",
-            "object": "template",
-          },
-          "error": null,
-        }
-      `);
-    });
   });
 
   describe('remove', () => {
@@ -541,65 +486,6 @@ describe('Templates', () => {
         }
       `);
     });
-
-    it('updates a template with object and list variable types', async () => {
-      const id = 'fd61172c-cafc-40f5-b049-b45947779a29';
-      const payload: UpdateTemplateOptions = {
-        name: 'Updated Complex Variables Template',
-        html: '<h1>Updated Welcome {{{config.theme}}}!</h1><p>Permissions: {{{permissions}}}</p>',
-        variables: [
-          {
-            key: 'config',
-            type: 'object',
-            fallbackValue: { theme: 'dark', lang: 'en' },
-          },
-          {
-            key: 'permissions',
-            type: 'list',
-            fallbackValue: ['read', 'write'],
-          },
-          {
-            key: 'counts',
-            type: 'list',
-            fallbackValue: [10, 20, 30],
-          },
-          {
-            key: 'enabled',
-            type: 'list',
-            fallbackValue: [true, false],
-          },
-          {
-            key: 'metadata',
-            type: 'list',
-            fallbackValue: [{ key: 'a' }, { key: 'b' }],
-          },
-        ],
-      };
-      const response = {
-        object: 'template',
-        id,
-      };
-
-      mockSuccessResponse(response, {
-        headers: {
-          Authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
-        },
-      });
-
-      const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
-
-      await expect(
-        resend.templates.update(id, payload),
-      ).resolves.toMatchInlineSnapshot(`
-        {
-          "data": {
-            "id": "fd61172c-cafc-40f5-b049-b45947779a29",
-            "object": "template",
-          },
-          "error": null,
-        }
-      `);
-    });
   });
 
   describe('get', () => {
@@ -1015,20 +901,33 @@ describe('Templates', () => {
 
       const resend = new Resend(TEST_API_KEY);
 
+      // Test before and limit together
       await resend.templates.list({
         before: 'cursor1',
+        limit: 25,
+      });
+
+      // Verify before and limit pagination parameters are included
+      const [firstUrl] = fetchMock.mock.calls[0];
+      const firstParsedUrl = new URL(firstUrl as string);
+
+      expect(firstParsedUrl.pathname).toBe('/templates');
+      expect(firstParsedUrl.searchParams.get('before')).toBe('cursor1');
+      expect(firstParsedUrl.searchParams.get('limit')).toBe('25');
+
+      // Test after and limit together
+      await resend.templates.list({
         after: 'cursor2',
         limit: 25,
       });
 
-      // Verify all pagination parameters are included
-      const [url] = fetchMock.mock.calls[0];
-      const parsedUrl = new URL(url as string);
+      // Verify after and limit pagination parameters are included
+      const [secondUrl] = fetchMock.mock.calls[1];
+      const secondParsedUrl = new URL(secondUrl as string);
 
-      expect(parsedUrl.pathname).toBe('/templates');
-      expect(parsedUrl.searchParams.get('before')).toBe('cursor1');
-      expect(parsedUrl.searchParams.get('after')).toBe('cursor2');
-      expect(parsedUrl.searchParams.get('limit')).toBe('25');
+      expect(secondParsedUrl.pathname).toBe('/templates');
+      expect(secondParsedUrl.searchParams.get('after')).toBe('cursor2');
+      expect(secondParsedUrl.searchParams.get('limit')).toBe('25');
     });
   });
 });