Skip to content

[MOB-11649] updated embedded message class #670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 24 commits into
base: evan/feature/embedded
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
1c56ff1
feat: adds button class and associated classes
Jun 9, 2025
4578c01
feat: adds unit tests
Jun 9, 2025
57f48a3
feat: adds elements class and associated classes
Jun 9, 2025
a3397a4
feat: adds unit tests
Jun 9, 2025
79e7225
feat: adds message class and unit tests
Jun 9, 2025
27af816
Merge branch 'evan/embedded-message-class' into evan/MOB-11550-iterab…
evantk91 Jun 24, 2025
12ac9b6
Merge pull request #655 from Iterable/evan/MOB-11550-iterable-embedde…
evantk91 Jun 24, 2025
80d7981
feat: adds labels for dict
Jun 24, 2025
aa2be62
Merge branch 'evan/embedded-message-class' into evan/MOB-11550-iterab…
evantk91 Jun 24, 2025
d6b0a0a
Merge pull request #667 from Iterable/evan/MOB-11550-iterable-embedde…
evantk91 Jun 24, 2025
a292556
Merge branch 'evan/embedded-message-class' into evan/MOB-11551-iterab…
evantk91 Jun 24, 2025
58fe64e
chore: adds comments to props
Jun 24, 2025
2b2899c
Merge pull request #656 from Iterable/evan/MOB-11551-iterable-embedde…
evantk91 Jun 24, 2025
3a486d6
Merge branch 'evan/embedded-message-class' into evan/MOB-7936-iterabl…
evantk91 Jun 24, 2025
84e6a68
chore: adds comments to props
Jun 25, 2025
8df97eb
Merge pull request #657 from Iterable/evan/MOB-7936-iterable-embedded…
evantk91 Jun 25, 2025
cad9c3e
feat: merges action into button
Jun 26, 2025
5f51526
feat: updates IterableEmbeddedMessageText class
Jun 26, 2025
7c2c8aa
feat: converts IterableEmbeddedMessageElements constructor
Jun 26, 2025
3c0e01d
feat: removes default action class
Jun 26, 2025
56b33b0
feat: converts IterableEmbeddedMessage constructor
Jun 26, 2025
1db3333
feat: converts IterableEmbeddedMessage constructor
Jun 26, 2025
2b627f3
feat: removes embedded metadata class
Jun 26, 2025
6701a64
feat: combines message and elements in one class
Jun 27, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
163 changes: 163 additions & 0 deletions src/__tests__/IterableEmbeddedMessage.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
import { IterableEmbeddedMessage } from '../embedded/classes/IterableEmbeddedMessage';

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Error loading TSDoc config file:
Error encountered for /home/runner/work/react-native-sdk/tsdoc.json:
Unable to resolve "extends" reference to "typedoc/tsdoc.json": Cannot find module 'typedoc/tsdoc.json' from '/home/runner/work/react-native-sdk'
[eslint:tsdoc/syntax]

import { IterableEmbeddedMessageMetadata } from '../embedded/classes/IterableEmbeddedMessageMetadata';
import { IterableEmbeddedMessageElements } from '../embedded/classes/IterableEmbeddedMessageElements';
import { Iterable } from '../core/classes/Iterable';

describe('IterableEmbeddedMessage', () => {
it('should create an instance with all properties', () => {
Iterable.logger.log('iterableEmbeddedMessage_fromDict_all_properties');

const dict = {
metadata: {
messageId: 'msg-123',
placementId: 1,
campaignId: 456,
isProof: false,
},
elements: {
title: 'Awesome Title',
body: 'Radical Body Text',
mediaUrl: 'https://example.com/image.jpg',
mediaUrlCaption: 'Check out this sick image!',
defaultAction: {
type: 'openUrl',
data: 'https://example.com',
},
buttons: [
{
id: 'button-1',
title: 'Click Me!',
action: {
type: 'openUrl',
data: 'https://example.com/button1',
},
},
],
text: [
{
id: 'text-1',
text: 'Some cool text',
type: 'body',
},
],
},
payload: {
customKey: 'customValue',
anotherKey: 123,
},
};

const message = IterableEmbeddedMessage.fromDict(dict);

expect(message).toBeInstanceOf(IterableEmbeddedMessage);

// Check metadata
expect(message.metadata).toBeInstanceOf(IterableEmbeddedMessageMetadata);
expect(message.metadata.messageId).toBe('msg-123');
expect(message.metadata.placementId).toBe(1);
expect(message.metadata.campaignId).toBe(456);
expect(message.metadata.isProof).toBe(false);

// Check elements
expect(message.elements).toBeInstanceOf(IterableEmbeddedMessageElements);
expect(message.elements?.title).toBe('Awesome Title');
expect(message.elements?.body).toBe('Radical Body Text');
expect(message.elements?.mediaUrl).toBe('https://example.com/image.jpg');
expect(message.elements?.mediaUrlCaption).toBe(
'Check out this sick image!'
);

// Check payload
expect(message.payload).toEqual({
customKey: 'customValue',
anotherKey: 123,
});
});

it('should create an instance with only required metadata', () => {
Iterable.logger.log('iterableEmbeddedMessage_fromDict_required_only');

const dict = {
metadata: {
messageId: 'msg-123',
placementId: 1,
isProof: false,
},
};

const message = IterableEmbeddedMessage.fromDict(dict);

expect(message).toBeInstanceOf(IterableEmbeddedMessage);
expect(message.metadata).toBeInstanceOf(IterableEmbeddedMessageMetadata);
expect(message.metadata.messageId).toBe('msg-123');
expect(message.metadata.placementId).toBe(1);
expect(message.metadata.campaignId).toBeUndefined();
expect(message.metadata.isProof).toBe(false);
expect(message.elements).toBeUndefined();
expect(message.payload).toBeUndefined();
});

it('should throw an error if metadata is missing', () => {
Iterable.logger.log('iterableEmbeddedMessage_fromDict_missing_metadata');

const dict = {
elements: {
title: 'Some Title',
body: 'Some Body',
},
};

expect(() => IterableEmbeddedMessage.fromDict(dict)).toThrow(
'metadata is required'
);
});

it('should create an instance with elements but no payload', () => {
Iterable.logger.log('iterableEmbeddedMessage_fromDict_elements_only');

const dict = {
metadata: {
messageId: 'msg-123',
placementId: 1,
isProof: false,
},
elements: {
title: 'Elements Only',
body: 'No payload here',
},
};

const message = IterableEmbeddedMessage.fromDict(dict);

expect(message).toBeInstanceOf(IterableEmbeddedMessage);
expect(message.metadata).toBeInstanceOf(IterableEmbeddedMessageMetadata);
expect(message.elements).toBeInstanceOf(IterableEmbeddedMessageElements);
expect(message.elements?.title).toBe('Elements Only');
expect(message.elements?.body).toBe('No payload here');
expect(message.payload).toBeUndefined();
});

it('should create an instance with payload but no elements', () => {
Iterable.logger.log('iterableEmbeddedMessage_fromDict_payload_only');

const dict = {
metadata: {
messageId: 'msg-123',
placementId: 1,
isProof: false,
},
payload: {
someData: 'someValue',
},
};

const message = IterableEmbeddedMessage.fromDict(dict);

expect(message).toBeInstanceOf(IterableEmbeddedMessage);
expect(message.metadata).toBeInstanceOf(IterableEmbeddedMessageMetadata);
expect(message.elements).toBeUndefined();
expect(message.payload).toEqual({
someData: 'someValue',
});
});
});
40 changes: 40 additions & 0 deletions src/__tests__/IterableEmbeddedMessageDefaultAction.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import { IterableEmbeddedMessageDefaultAction } from '../embedded/classes/IterableEmbeddedMessageDefaultAction';
import { Iterable } from '../core/classes/Iterable';

describe('IterableEmbeddedMessageDefaultAction', () => {
it('should create an instance with the correct properties', () => {
Iterable.logger.log(
'iterableEmbeddedMessageDefaultAction_fromDict_valid_dictionary'
);

const dict = { type: 'openUrl', data: 'https://example.com' };
const action = IterableEmbeddedMessageDefaultAction.fromDict(dict);
expect(action).toBeInstanceOf(IterableEmbeddedMessageDefaultAction);
expect(action.type).toBe('openUrl');
expect(action.data).toBe('https://example.com');
});

it('should create an instance from a dictionary with data omitted', () => {
Iterable.logger.log(
'iterableEmbeddedMessageDefaultAction_fromDict_valid_dictionary_with_data_omitted'
);

const dict = { type: 'action://join', data: '' };
const action = IterableEmbeddedMessageDefaultAction.fromDict(dict);
expect(action).toBeInstanceOf(IterableEmbeddedMessageDefaultAction);
expect(action.type).toBe('action://join');
expect(action.data).toBe('');
});

it('should throw an error if type is missing in fromDict', () => {
Iterable.logger.log(
'iterableEmbeddedMessageDefaultAction_fromDict_invalid_dictionary_missing_type'
);

const dict = { data: 'foo' };

expect(() => IterableEmbeddedMessageDefaultAction.fromDict(dict)).toThrow(
'type is required'
);
});
});
Loading