castled-js-sdk 0.0.1 → 0.0.2

package/sanity-suite/src/testBookSuites/alias.js

@@ -0,0 +1,287 @@
+import alias1ExpectedData from '../../__mocks__/alias1.json';
+import alias2ExpectedData from '../../__mocks__/alias2.json';
+import alias5ExpectedData from '../../__mocks__/alias5.json';
+import alias6ExpectedData from '../../__mocks__/alias6.json';
+
+const aliasMethodSuite = {
+  id: 'aliasMethod',
+  name: 'Alias',
+  description: 'Alias Method: hightouchevents.alias(to, from, [apiOptions], [callback]);',
+  testCases: [
+    {
+      id: 'alias1',
+      description: 'Call with all arguments and all primitives in traits and apiOptions',
+      inputData: [
+        [
+          'customUserID',
+          {
+            name: 'John Doe',
+            title: 'CEO',
+            email: 'name.surname@domain.com',
+            company: 'Company123',
+            phone: '123-456-7890',
+            rating: 'Hot',
+            dob: new Date(Date.UTC(1990, 0, 12)),
+            address: [
+              {
+                city: 'Austin',
+                postalCode: 12345,
+                country: 'US',
+                street: 'Sample Address',
+                state: 'TX',
+                label: 'Home',
+                defaultAddress: true,
+              },
+              {
+                city: 'Houston',
+                postalCode: 345678,
+                country: 'US',
+                street: 'Sample Address 2',
+                state: 'TX',
+                label: 'Office',
+                defaultAddress: false,
+              },
+              {
+                city: 'Dallas',
+                postalCode: 987654,
+                country: 'US',
+                street: 'Sample Address 3',
+                state: 'TX',
+                label: 'Toms place',
+                defaultAddress: false,
+              },
+            ],
+          },
+        ],
+        [
+          'newCustomUserID',
+          'customUserID',
+          {
+            key1: [1, 2, 3, 4],
+            key2: 'sample text',
+            key3: false,
+            key4: 9087654,
+            key5: {
+              key6: 'sample text 2',
+              key7: [
+                {
+                  color: '#3456789',
+                  name: null,
+                },
+                {
+                  color: '#3456767',
+                  name: 'Red',
+                },
+              ],
+            },
+            key8: null,
+            key9: undefined,
+            externalIds: [
+              {
+                id: 'some_external_id_1',
+                type: 'brazeExternalId',
+              },
+            ],
+            device: {
+              id: 'sdfghj567-cghj5678-fghjvbn888',
+            },
+            library: {
+              name: 'Random JavaScript SDK',
+              version: '2.22.0',
+            },
+            context: {
+              metaData: {
+                appVersion: '2.8.0',
+                appId: '1hKOmRA4GRlm',
+                release_stage: 'Production',
+              },
+            },
+            integrations: {
+              All: false,
+              'Google Analytics': true,
+              Amplitude: true,
+            },
+            anonymousId: 'sample anonymousId',
+            originalTimestamp: '2023-01-13T08:13:58.548Z',
+            channel: 'random',
+          },
+        ],
+      ],
+      expectedResult: alias1ExpectedData,
+      triggerHandler: ['identify', 'alias'],
+    },
+    {
+      id: 'alias2',
+      description: 'Call with to and from as arguments',
+      inputData: ['newCustomUserID', 'customUserID'],
+      expectedResult: alias2ExpectedData,
+      triggerHandler: 'alias',
+    },
+    {
+      id: 'alias3',
+      description: 'Call with to and from and null apiOption as arguments',
+      inputData: ['newCustomUserID', 'customUserID', null],
+      expectedResult: alias2ExpectedData,
+      triggerHandler: 'alias',
+    },
+    {
+      id: 'alias4',
+      description: 'Call with to as argument',
+      inputData: ['newCustomUserID'],
+      expectedResult: alias2ExpectedData,
+      triggerHandler: 'alias',
+    },
+    {
+      id: 'alias5',
+      description: 'Call with no argument when userId exists in storage',
+      inputData: [
+        [
+          'customUserID',
+          {
+            name: 'John Doe',
+            title: 'CEO',
+            email: 'name.surname@domain.com',
+            company: 'Company123',
+            phone: '123-456-7890',
+            rating: 'Hot',
+            dob: new Date(Date.UTC(1990, 0, 12)),
+            address: [
+              {
+                city: 'Austin',
+                postalCode: 12345,
+                country: 'US',
+                street: 'Sample Address',
+                state: 'TX',
+                label: 'Home',
+                defaultAddress: true,
+              },
+              {
+                city: 'Houston',
+                postalCode: 345678,
+                country: 'US',
+                street: 'Sample Address 2',
+                state: 'TX',
+                label: 'Office',
+                defaultAddress: false,
+              },
+              {
+                city: 'Dallas',
+                postalCode: 987654,
+                country: 'US',
+                street: 'Sample Address 3',
+                state: 'TX',
+                label: 'Toms place',
+                defaultAddress: false,
+              },
+            ],
+          },
+        ],
+        [],
+      ],
+      expectedResult: alias5ExpectedData,
+      triggerHandler: ['identify', 'alias'],
+    },
+    {
+      id: 'alias6',
+      description: 'Call with only apiOptions arguments',
+      inputData: [
+        [
+          'customUserID',
+          {
+            name: 'John Doe',
+            title: 'CEO',
+            email: 'name.surname@domain.com',
+            company: 'Company123',
+            phone: '123-456-7890',
+            rating: 'Hot',
+            dob: new Date(Date.UTC(1990, 0, 12)),
+            address: [
+              {
+                city: 'Austin',
+                postalCode: 12345,
+                country: 'US',
+                street: 'Sample Address',
+                state: 'TX',
+                label: 'Home',
+                defaultAddress: true,
+              },
+              {
+                city: 'Houston',
+                postalCode: 345678,
+                country: 'US',
+                street: 'Sample Address 2',
+                state: 'TX',
+                label: 'Office',
+                defaultAddress: false,
+              },
+              {
+                city: 'Dallas',
+                postalCode: 987654,
+                country: 'US',
+                street: 'Sample Address 3',
+                state: 'TX',
+                label: 'Toms place',
+                defaultAddress: false,
+              },
+            ],
+          },
+        ],
+        [
+          {
+            key1: [1, 2, 3, 4],
+            key2: 'sample text',
+            key3: false,
+            key4: 9087654,
+            key5: {
+              key6: 'sample text 2',
+              key7: [
+                {
+                  color: '#3456789',
+                  name: null,
+                },
+                {
+                  color: '#3456767',
+                  name: 'Red',
+                },
+              ],
+            },
+            key8: null,
+            key9: undefined,
+            externalIds: [
+              {
+                id: 'some_external_id_1',
+                type: 'brazeExternalId',
+              },
+            ],
+            device: {
+              id: 'sdfghj567-cghj5678-fghjvbn888',
+            },
+            library: {
+              name: 'Random JavaScript SDK',
+              version: '2.22.0',
+            },
+            context: {
+              metaData: {
+                appVersion: '2.8.0',
+                appId: '1hKOmRA4GRlm',
+                release_stage: 'Production',
+              },
+            },
+            integrations: {
+              All: false,
+              'Google Analytics': true,
+              Amplitude: true,
+            },
+            anonymousId: 'sample anonymousId',
+            originalTimestamp: '2023-01-13T08:13:58.548Z',
+            channel: 'random',
+          },
+        ],
+      ],
+      expectedResult: alias6ExpectedData,
+      triggerHandler: ['identify', 'alias'],
+    },
+  ],
+};
+
+export { aliasMethodSuite };

package/sanity-suite/src/testBookSuites/group.js

@@ -0,0 +1,240 @@
+import group1ExpectedData from '../../__mocks__/group1.json';
+import group2ExpectedData from '../../__mocks__/group2.json';
+import group4ExpectedData from '../../__mocks__/group4.json';
+import group5ExpectedData from '../../__mocks__/group5.json';
+import group6ExpectedData from '../../__mocks__/group6.json';
+
+const groupMethodSuite = {
+  id: 'groupMethod',
+  name: 'Group',
+  description: 'Group Method: hightouchevents.group(groupId, [traits], [apiOptions], [callback]);',
+  testCases: [
+    {
+      id: 'group1',
+      description: 'Call with all arguments and all primitives in traits and apiOptions',
+      inputData: [
+        [true],
+        [
+          'customGroupID',
+          {
+            groupName: 'Anime fan club',
+            email: 'name.surname@domain.com',
+            company: 'Company123',
+            phone: '123-456-7890',
+            rating: 'Hot',
+            city: 'San Antonio',
+            postalCode: 890465,
+            country: 'US',
+            street: 'Sample Address',
+            state: 'TX',
+            label: 'club office',
+            defaultAddress: true,
+            temp1: null,
+            temp2: undefined,
+            temp3: [1, 2, 3],
+            temp4: {
+              selectedType: 'hard copy',
+              typesAvailable: ['kindle edition', 'audio book', 'hard copy', null],
+            },
+          },
+          {
+            key1: [1, 2, 3, 4],
+            key2: 'sample text',
+            key3: false,
+            key4: 9087654,
+            key5: {
+              key6: 'sample text 2',
+              key7: [
+                {
+                  color: '#3456789',
+                  name: null,
+                },
+                {
+                  color: '#3456767',
+                  name: 'Red',
+                },
+              ],
+            },
+            key8: null,
+            key9: undefined,
+            externalIds: [
+              {
+                id: 'some_external_id_1',
+                type: 'brazeExternalId',
+              },
+            ],
+            device: {
+              id: 'sdfghj567-cghj5678-fghjvbn888',
+            },
+            library: {
+              name: 'Random JavaScript SDK',
+              version: '2.22.0',
+            },
+            context: {
+              metaData: {
+                appVersion: '2.8.0',
+                appId: '1hKOmRA4GRlm',
+                release_stage: 'Production',
+              },
+            },
+            integrations: {
+              All: false,
+              'Google Analytics': true,
+              Amplitude: true,
+            },
+            anonymousId: 'sample anonymousId',
+            originalTimestamp: '2023-01-13T08:13:58.548Z',
+            channel: 'random',
+          },
+        ],
+      ],
+      expectedResult: group1ExpectedData,
+      triggerHandler: ['reset', 'group'],
+    },
+    {
+      id: 'group2',
+      description: 'Call with groupId, groupTraits as arguments',
+      inputData: [
+        [true],
+        [
+          'customGroupID',
+          {
+            groupName: 'Anime fan club',
+            email: 'name.surname@domain.com',
+            company: 'Company123',
+            phone: '123-456-7890',
+            rating: 'Hot',
+            city: 'San Antonio',
+            postalCode: 890465,
+            country: 'US',
+            street: 'Sample Address',
+            state: 'TX',
+            label: 'club office',
+            defaultAddress: true,
+            temp1: null,
+            temp2: undefined,
+            temp3: [1, 2, 3],
+            temp4: {
+              selectedType: 'hard copy',
+              typesAvailable: ['kindle edition', 'audio book', 'hard copy', null],
+            },
+          },
+        ],
+      ],
+      expectedResult: group2ExpectedData,
+      triggerHandler: ['reset', 'group'],
+    },
+    {
+      id: 'group3',
+      description: 'Call with groupId, groupTraits and null apiOptions as arguments',
+      inputData: [
+        [true],
+        [
+          'customGroupID',
+          {
+            groupName: 'Anime fan club',
+            email: 'name.surname@domain.com',
+            company: 'Company123',
+            phone: '123-456-7890',
+            rating: 'Hot',
+            city: 'San Antonio',
+            postalCode: 890465,
+            country: 'US',
+            street: 'Sample Address',
+            state: 'TX',
+            label: 'club office',
+            defaultAddress: true,
+            temp1: null,
+            temp2: undefined,
+            temp3: [1, 2, 3],
+            temp4: {
+              selectedType: 'hard copy',
+              typesAvailable: ['kindle edition', 'audio book', 'hard copy', null],
+            },
+          },
+          null,
+        ],
+      ],
+      expectedResult: group2ExpectedData,
+      triggerHandler: ['reset', 'group'],
+    },
+    {
+      id: 'group4',
+      description: 'Call with groupId, null groupTraits and apiOptions as arguments',
+      inputData: [
+        [true],
+        [
+          'customGroupID',
+          null,
+          {
+            key1: [1, 2, 3, 4],
+            key2: 'sample text',
+            key3: false,
+            key4: 9087654,
+            key5: {
+              key6: 'sample text 2',
+              key7: [
+                {
+                  color: '#3456789',
+                  name: null,
+                },
+                {
+                  color: '#3456767',
+                  name: 'Red',
+                },
+              ],
+            },
+            key8: null,
+            key9: undefined,
+            externalIds: [
+              {
+                id: 'some_external_id_1',
+                type: 'brazeExternalId',
+              },
+            ],
+            device: {
+              id: 'sdfghj567-cghj5678-fghjvbn888',
+            },
+            library: {
+              name: 'Random JavaScript SDK',
+              version: '2.22.0',
+            },
+            context: {
+              metaData: {
+                appVersion: '2.8.0',
+                appId: '1hKOmRA4GRlm',
+                release_stage: 'Production',
+              },
+            },
+            integrations: {
+              All: false,
+              'Google Analytics': true,
+              Amplitude: true,
+            },
+            anonymousId: 'sample anonymousId',
+            originalTimestamp: '2023-01-13T08:13:58.548Z',
+            channel: 'random',
+          },
+        ],
+      ],
+      expectedResult: group4ExpectedData,
+      triggerHandler: ['reset', 'group'],
+    },
+    {
+      id: 'group5',
+      description: 'Call with groupId as argument',
+      inputData: [[true], ['customGroupID']],
+      expectedResult: group5ExpectedData,
+      triggerHandler: ['reset', 'group'],
+    },
+    {
+      id: 'group6',
+      description: 'Call with only callback as argument',
+      inputData: [[true], []],
+      expectedResult: group6ExpectedData,
+      triggerHandler: ['reset', 'group'],
+    },
+  ],
+};
+
+export { groupMethodSuite };