Merge pull request apex-enterprise-patterns#11 from OrtooApps/feature…

…/more-core-lwc-work

Feature/more core lwc work

.editorconfig

@@ -0,0 +1,6 @@
+root = true
+
+# Exists only to define tab spacing in github pull request rendering
+[*]
+indent_style = tab
+indent_size = 4

framework/default/ortoo-core/default/classes/utils/DateTimeUtils.cls

@@ -0,0 +1,18 @@
+/**
+ * Utility class that provides extra capabilities related to DateTime
+ *
+ * @group Utils
+ */
+public inherited sharing class DateTimeUtils
+{
+	/**
+	 * Returns the current Epoch Time, in seconds
+	 *
+	 * @return	Long	The current Epoch Time, in seconds
+	 */
+	public static Long getEpochTime()
+	{
+		Long millisecondsNow = Datetime.now().getTime();
+		return millisecondsNow / 1000;
+	}
+}

framework/default/ortoo-core/default/classes/utils/DateTimeUtils.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>52.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

framework/default/ortoo-core/default/classes/utils/tests/DateTimeUtilsTest.cls

@@ -0,0 +1,18 @@
+@isTest
+public with sharing class DateTimeUtilsTest
+{
+    @isTest
+    private static void getEpochTime_whenCalled_returnsEpochInSeconds() // NOPMD: Test method name format
+    {
+        Test.startTest();
+            Long got = DateTimeUtils.getEpochTime();
+        Test.stopTest();
+
+        Integer e9  = Integer.valueOf( got / 1000000000 ); // if you divide the epoch seconds by 10^9, you should get 1 if the date is later than 9th September 2001
+        Integer e10 = Integer.valueOf( ( got / 1000000000 ) / 10 ); // if you divide the epoch seconds by 10^10, you should get < 1 if the date is earlier than 20th November 2286
+                                                                    // need to do it in two steps becayse 10^10 is not a valid integer
+
+        System.assert( e9 > 0, 'getEpochTime, when called, will return the epoch time in seconds - being greater than 10^9' );
+        System.assertEquals( 0, e10, 'getEpochTime, when called, will return the epoch time in seconds - being less than 10^10' );
+    }
+}

framework/default/ortoo-core/default/classes/utils/tests/DateTimeUtilsTest.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>52.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

framework/default/ortoo-core/default/lwc/message/__tests__/message.test.js

@@ -0,0 +1,129 @@
+import { createElement } from 'lwc';
+import Message from 'c/message';
+
+const MESSAGE_SELECTOR = '[data-ortoo-elem-id="messagebox-message"]';
+const ICON_SELECTOR = '[data-ortoo-elem-id="messagebox-icon"]';
+const CONTAINER_SELECTOR = '[data-ortoo-elem-id="messagebox-container"]';
+
+describe('c-message', () => {
+
+    beforeEach(() => {
+        const element = createElement('c-message', {
+            is: Message
+        });
+        document.body.appendChild( element );
+    });
+
+    afterEach(() => {
+        // The jsdom instance is shared across test cases in a single file so reset the DOM
+        while (document.body.firstChild) {
+            document.body.removeChild(document.body.firstChild);
+        }
+    });
+
+    it( 'Will render the message given', () => {
+
+        const element = document.body.querySelector( 'c-message' );
+        element.message = 'the message';
+
+        return Promise.resolve()
+        .then( () =>
+            expect( element.shadowRoot.querySelector( MESSAGE_SELECTOR ).innerHTML ).toBe( 'the message' )
+        );
+    });
+
+    it( 'When no message is set, will not render anything', () => {
+
+        const element = document.body.querySelector( 'c-message' );
+
+        return Promise.resolve()
+        .then( () =>
+            expect( element.shadowRoot.querySelector( MESSAGE_SELECTOR ) ).toBe( null )
+        );
+    });
+
+    it( 'When message is set to an empty string, will not render anything', () => {
+
+        const element = document.body.querySelector( 'c-message' );
+        element.message = '';
+
+        return Promise.resolve()
+        .then( () =>
+            expect( element.shadowRoot.querySelector( MESSAGE_SELECTOR ) ).toBe( null )
+        );
+    });
+
+    it( 'When message is set to a blank string, will not render anything', () => {
+
+        const element = document.body.querySelector( 'c-message' );
+        element.message = '       ';
+
+        return Promise.resolve()
+        .then( () =>
+            expect( element.shadowRoot.querySelector( MESSAGE_SELECTOR ) ).toBe( null )
+        );
+    });
+
+    it( 'When message is set to a 0 string, will render it', () => {
+
+        const element = document.body.querySelector( 'c-message' );
+        element.message = '0';
+
+        return Promise.resolve()
+        .then( () =>
+            expect( element.shadowRoot.querySelector( MESSAGE_SELECTOR ).innerHTML ).toBe( '0' )
+        );
+    });
+
+    it( 'When variant is set to error, will set up an error message', () => {
+
+        const element = document.body.querySelector( 'c-message' );
+        element.message = 'unimportant';
+        element.variant = 'error';
+
+        return Promise.resolve()
+        .then( () => {
+            expect( element.shadowRoot.querySelector( ICON_SELECTOR ).iconName ).toBe( 'utility:error' )
+            expect( element.shadowRoot.querySelector( CONTAINER_SELECTOR ).className ).toContain( 'slds-theme--error' )
+        });
+    });
+
+    it( 'When variant is set to info, will set up an info message', () => {
+
+        const element = document.body.querySelector( 'c-message' );
+        element.message = 'unimportant';
+        element.variant = 'info';
+
+        return Promise.resolve()
+        .then( () => {
+            expect( element.shadowRoot.querySelector( ICON_SELECTOR ).iconName ).toBe( 'utility:info' )
+            expect( element.shadowRoot.querySelector( CONTAINER_SELECTOR ).className ).toContain( 'slds-theme--info' )
+        });
+    });
+
+    it( 'When variant is set to warning, will set up an warning message', () => {
+
+        const element = document.body.querySelector( 'c-message' );
+        element.message = 'unimportant';
+        element.variant = 'warning';
+
+        return Promise.resolve()
+        .then( () => {
+            expect( element.shadowRoot.querySelector( ICON_SELECTOR ).iconName ).toBe( 'utility:warning' )
+            expect( element.shadowRoot.querySelector( CONTAINER_SELECTOR ).className ).toContain( 'slds-theme--warning' )
+        });
+    });
+
+    it( 'When variant is set to success, will set up an success message', () => {
+
+        const element = document.body.querySelector( 'c-message' );
+        element.message = 'unimportant';
+        element.variant = 'success';
+
+        return Promise.resolve()
+        .then( () => {
+            expect( element.shadowRoot.querySelector( ICON_SELECTOR ).iconName ).toBe( 'utility:success' )
+            expect( element.shadowRoot.querySelector( CONTAINER_SELECTOR ).className ).toContain( 'slds-theme--success' )
+        });
+    });
+});

framework/default/ortoo-core/default/lwc/message/message.html

@@ -0,0 +1,13 @@
+<template>
+	<div class={topLevelClasses} role="alert" if:true={messagePopulated} data-ortoo-elem-id={containerId}>
+		<lightning-icon icon-name={iconName} size="small" variant="inverse" class="slds-m-right--small" data-ortoo-elem-id={iconId}></lightning-icon>
+
+		<div class="toastContent slds-notify__content">
+			<div class="slds-align-middle slds-hyphenate">
+				<span class="toastMessage slds-text-heading--small forceActionsText" data-ortoo-elem-id={messageId}>
+					{message}
+				</span>
+			</div>
+		</div>
+	</div>
+</template>

framework/default/ortoo-core/default/lwc/message/message.js

@@ -0,0 +1,50 @@
+import { LightningElement, api } from 'lwc';
+import configureElementIdGenerator from 'c/elementIdGenerator';
+
+export default class Message extends LightningElement {
+
+	@api message;
+	@api variant;
+
+    @api ortooElemIdPrefix = 'messagebox';
+
+    ortooIdConfiguration = {
+        messageId: 'message',
+		iconId: 'icon',
+		containerId: 'container',
+    }
+
+    connectedCallback() {
+        configureElementIdGenerator( this );
+    }
+
+	variantToClassMapping = {
+		error: 'slds-theme--error',
+		warning: 'slds-theme--warning',
+		info: 'slds-theme--info',
+		success: 'slds-theme--success',
+	}
+
+	variantToIconMapping = {
+		error: 'utility:error',
+		warning: 'utility:warning',
+		info: 'utility:info',
+		success: 'utility:success',
+	}
+
+	get messagePopulated() {
+		return ( this.message && !/^\s*$/.test( this.message ) );
+	}
+
+	get themeClass() {
+		return this.variantToClassMapping[ this.variant ];
+	}
+
+	get topLevelClasses() {
+		return this.themeClass+' slds-notify--toast slds-notify slds-notify--toast forceToastMessage';
+	}
+
+    get iconName() {
+        return this.variantToIconMapping[ this.variant ];
+    }
+}

framework/default/ortoo-core/default/lwc/message/message.js-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>52.0</apiVersion>
+    <isExposed>false</isExposed>
+</LightningComponentBundle>