@pernod-ricard-global-cms/jsutils 1.2.1 → 1.4.2

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,34 @@
+# This workflow will run tests using node and then publish a package to NPM when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+    branches: 
+      - master 
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 15
+      - run: npm ci
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/jsutils.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-undef */
 /* eslint-disable consistent-return */
 /* eslint-disable no-console */
-function getPosition( element ) {
+export function getPosition( element ) {
 	const scrollElementTag = document.scrollingElement.tagName;
 	let xPosition = 0;
 	let yPosition = 0;
@@ -18,7 +18,7 @@ function getPosition( element ) {
 	return { x: xPosition, y: yPosition };
 }
 
-function toggleClassByValidity( input, button ) {
+export function toggleClassByValidity( input, button ) {
 	input.addEventListener( 'input', () => {
 		if ( input.validity.valid && input.value ) {
 			if ( ! button.classList.contains( 'valid' ) ) {
@@ -34,7 +34,7 @@ function toggleClassByValidity( input, button ) {
 	} );
 }
 
-function inCriticalCssConfig( assetKey ) {
+export function inCriticalCssConfig( assetKey ) {
 	if (
 		globalThis.criticalConfig &&
 		globalThis.criticalConfig.indexOf( assetKey ) === -1
@@ -44,7 +44,7 @@ function inCriticalCssConfig( assetKey ) {
 	return true;
 }
 
-function loadCss( assetKey, options = { css: true } ) {
+export function loadCss( assetKey, options = { css: true } ) {
 	const promise = new Promise( ( resolve ) => {
 		if ( options.css === true && ! inCriticalCssConfig( assetKey ) ) {
 			import(
@@ -57,7 +57,7 @@ function loadCss( assetKey, options = { css: true } ) {
 	return promise;
 }
 
-function checkDevice() {
+export function checkDevice() {
 	try {
 		const deviceAgent = navigator.userAgent.toLowerCase();
 		const htmlElement = document.querySelector( 'html' );
@@ -112,7 +112,7 @@ function checkDevice() {
 	}
 }
 
-async function waitForLoad( img, delayedFunction ) {
+export async function waitForLoad( img, delayedFunction ) {
 	const loaded = new Promise( ( resolve ) => {
 		if ( img.complete ) {
 			if ( typeof delayedFunction === 'function' ) {
@@ -136,7 +136,7 @@ async function waitForLoad( img, delayedFunction ) {
 	return loaded;
 }
 
-async function supportsWebp() {
+export async function supportsWebp() {
 	// eslint-disable-next-line no-restricted-globals
 	if ( ! self.createImageBitmap ) return false;
 	const webpData =
@@ -154,7 +154,7 @@ async function supportsWebp() {
 // 	return false;
 // } )();
 
-function footerIntersection( entries, element ) {
+export function footerIntersection( entries, element ) {
 	entries.forEach( ( entry ) => {
 		if ( element ) {
 			if ( entry.isIntersecting ) {
@@ -167,10 +167,10 @@ function footerIntersection( entries, element ) {
 	} );
 }
 
-function getSwiperAssets() {
+export function getSwiperAssets() {
 	const getSwiperJs = () =>
 		import(
-			/* webpackChunkName: 'swiper' */ '../../swiper/swiper-bundle'
+			/* webpackChunkName: 'swiper' */ '../../swiper/swiper-bundle.js'
 		);
 
 	const getSwiperCss = () =>
@@ -187,26 +187,26 @@ function getSwiperAssets() {
 	return promisedJs;
 }
 
-function getJquery() {
+export function getJquery() {
 	if ( ! window.jQuery ) {
 		const importCode = () =>
 			import(
-				/* webpackChunkName: 'jquery' */ '../../jquery/dist/jquery.min'
+				/* webpackChunkName: 'jquery' */ '../../jquery/dist/jquery.min.js'
 			);
 		return importCode();
 	}
 	return Promise.resolve();
 }
 
-function getGsap() {
+export function getGsap() {
 	const gsapCore = () =>
-		import( '../../gsap/dist/gsap.min' ).then( ( gsapObj ) => {
+		import( '../../gsap/dist/gsap.min.js' ).then( ( gsapObj ) => {
 			const { gsap } = gsapObj;
 			return gsap;
 		} );
 
 	const gsapPlugin = () =>
-		import( '../../gsap/dist/ScrollTrigger.min' ).then(
+		import( '../../gsap/dist/ScrollTrigger.min.js' ).then(
 			( scrollObj ) => {
 				const ScrollTrigger = scrollObj;
 				return ScrollTrigger;
@@ -221,19 +221,19 @@ function getGsap() {
 	return prom;
 }
 
-function isTablet( userAgent ) {
+export function isTablet( userAgent ) {
 	return /(ipad|tablet|(android(?!.*mobile))|(windows(?!.*phone)(.*touch))|kindle|playbook|silk|(puffin(?!.*(IP|AP|WP))))/.test(
 		userAgent.toLowerCase()
 	);
 }
 
-function mobileCheck () {
+export function mobileCheck () {
 	let check = false;
 	(function(a){if(/(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino/i.test(a)||/1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i.test(a.substr(0,4))) check = true;})(navigator.userAgent||navigator.vendor||window.opera);
 	return check;
   };
 
-function resizeDebouncer( debouncedFunction, time = 250 ) {
+export function resizeDebouncer( debouncedFunction, time = 250 ) {
 	let resizeTimer;
 	window.addEventListener( 'resize', () => {
 		clearTimeout( resizeTimer );
@@ -242,7 +242,8 @@ function resizeDebouncer( debouncedFunction, time = 250 ) {
 		}, time );
 	} );
 }
-function eventListenerDebouncer(
+
+export function eventListenerDebouncer(
 	element,
 	eventType,
 	debouncedFunction,
@@ -257,7 +258,7 @@ function eventListenerDebouncer(
 	} );
 }
 
-function injectYouTubeIframeScript() {
+export function injectYouTubeIframeScript() {
 	const prom = new Promise( ( resolve ) => {
 		if ( globalThis.YT ) {
 			return resolve();
@@ -285,7 +286,8 @@ function injectYouTubeIframeScript() {
 
 	return prom;
 }
-function fallbackCopyToClipboard( text ) {
+
+export function fallbackCopyToClipboard( text ) {
 	const textArea = document.createElement( 'textarea' );
 	textArea.value = text;
 
@@ -309,7 +311,7 @@ function fallbackCopyToClipboard( text ) {
 	document.body.removeChild( textArea );
 }
 
-function copyToClipboard() {
+export function copyToClipboard() {
 	const copyLinks = document.querySelectorAll( '.copy-to-clipboard' );
 	let timeout;
 	copyLinks.forEach( ( link ) => {
@@ -347,16 +349,25 @@ function copyToClipboard() {
 	} );
 }
 
-
-function isInViewport(element) {
-    var position = element.getBoundingClientRect();
+/**
+ * Checks whether an element is visible in the viewport.
+ * @param {string} element - The dom element to look for.
+ * @returns {boolean} True if visible and false if not.
+ */
+export function isInViewport(element) {
+    const position = element.getBoundingClientRect();
     return ( position.top >= 0 && position.bottom <= window.innerHeight ) || ( position.top < window.innerHeight && position.bottom >= 0 );
 }
 
 /* eslint-disable-next-line */
 const emailRegex = /^[-!#$%&'*+\/0-9=?A-Z^_a-z`{|}~](\.?[-!#$%&'*+\/0-9=?A-Z^_a-z`{|}~])*@[a-zA-Z0-9](-*\.?[a-zA-Z0-9])*\.[a-zA-Z](-?[a-zA-Z0-9])+$/;
 
-const isEmailValid = ( email ) => {
+/**
+ * Checks to make sure a passed string has a valid email address structure and characters.
+ * @param {string} email - The email address as a string.
+ * @returns {boolean} True if valid and false if not.
+ */
+export function isEmailValid( email ) {
 	return emailRegex.test( email );
 };
 

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@pernod-ricard-global-cms/jsutils",
-  "version": "1.2.1",
+  "version": "1.4.2",
   "description": "Handy collection of Javascript utility functions",
+  "type": "module",
   "main": "jsutils.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jasmine"
   },
   "repository": {
     "type": "git",
@@ -20,5 +21,8 @@
     "gsap": "^3.7.1",
     "jquery": "^3.6.0",
     "swiper": "^6.8.3"
+  },
+  "devDependencies": {
+    "jasmine": "^3.9.0"
   }
 }

package/spec/isEmailValid.spec.js

@@ -0,0 +1,10 @@
+import jsutils from "../jsutils.js";
+
+describe("A suite", function() {
+  it("fails on a string of letters", function() {
+    expect(jsutils.isEmailValid('jkahdb')).toBe(false);
+  });
+  it("passes with mixed case letters and numbers", function() {
+    expect(jsutils.isEmailValid('aS93scFFx@jKoO0908ahdb.com')).toBe(true);
+  });
+});

package/spec/isInViewport.spec.js

@@ -0,0 +1,7 @@
+import jsutils from "../jsutils.js";
+
+describe("A suite", function() {
+  it("passes as element is in the viewport", function() {
+
+  });
+});

package/spec/support/jasmine.json

@@ -0,0 +1,12 @@
+{
+  "spec_dir": "spec",
+  "spec_files": [
+    "**/*[sS]pec.?(m)js"
+  ],
+  "helpers": [
+    "helpers/**/*.?(m)js"
+  ],
+  "jsLoader": "import",
+  "stopSpecOnExpectationFailure": false,
+  "random": true
+}