Merge pull request #236 from VinceFINET/helium

Helium

Author: VinceFINET

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Vincent FINET
+Copyright (c) 2022 Salesforce Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

build/bin/OrgCheck_SR.zip

@@ -1,5 +1,32 @@
 #/bin/bash
 
+
+### --------------------------------------------------------------------------------------------
+### Dependency and other checkings
+### --------------------------------------------------------------------------------------------
+which uglifyjs 1>/dev/null; if [ $? -ne 0 ]; then 
+    echo 'Uglifyjs is not installed. You can install it via $ npm install uglify-js -g'; 
+    exit 1; 
+fi
+which tidy 1>/dev/null; if [ $? -ne 0 ]; then 
+    echo 'Tidy is not installed. You can install it via $ brew tidy'; 
+    exit 1; 
+fi
+if [ $(sfdx force:auth:list --json | wc -l) -le 4 ]; then 
+    echo "There is no Salesforce Org authentified with sfdx yet. Please register one with (for example) $ sfdx force:auth:web:login"; 
+    exit 2; 
+fi
+if [ $(sfdx config:get defaultusername --json | grep 'value' | wc -l) -eq 0 ]; then 
+    echo "There is no Salesforce Default Username defined with sfdx yet. Please register one with $ sfdx config:set defaultusername=<username>"; 
+    exit 3; 
+fi
+
+
+
+### --------------------------------------------------------------------------------------------
+### Argument for this script checkings
+### --------------------------------------------------------------------------------------------
+
 UGLIFY_MODE="$1"
 UGLIFY_MODE_ON="on"
 UGLIFY_MODE_OFF="off"
@@ -12,89 +39,77 @@ else
 fi
 echo ""
 
-### -----------------------
-### JAVASCRIPT PART
-### -----------------------
 
-for f in build/src/javascript/orgcheck/OrgCheck.*.js; do
+
+### --------------------------------------------------------------------------------------------
+### Javascript and static resource build
+### --------------------------------------------------------------------------------------------
+
+echo "Javascript build..."
+for f in build/src/javascript/orgcheck/OrgCheck.*.js build/src/javascript/orgcheck/OrgCheck.js; do
+    echo " - $f"
     if [ "${UGLIFY_MODE}" == "${UGLIFY_MODE_ON}" ]; then
         uglifyjs --ie --webkit --v8 "${f}" -o /tmp/$(basename $f);
     else
         cat "${f}" > /tmp/$(basename $f);
     fi
 done
-for f in build/src/javascript/orgcheck/OrgCheck.js; do
-    if [ "${UGLIFY_MODE}" == "${UGLIFY_MODE_ON}" ]; then
-        uglifyjs --ie --webkit --v8 "${f}" -o /tmp/$(basename $f)
-    else
-        cat "${f}" > /tmp/$(basename $f);
-    fi
-done
 
 rm -Rf build/tmp/*
 rm -Rf build/bin/*
 mkdir build/tmp/js
 mkdir build/tmp/img
 
+echo " >> into one unique js file"
 (
-    for f in build/src/javascript/orgcheck/OrgCheck.js; do
-        cat /tmp/$(basename $f)
-    done
-    for f in build/src/javascript/orgcheck/OrgCheck.*.js; do
+    for f in build/src/javascript/orgcheck/OrgCheck.js build/src/javascript/orgcheck/OrgCheck.*.js; do
         cat /tmp/$(basename $f)
     done
 ) > build/tmp/js/orgcheck.js
+echo ""
 
 cp build/src/javascript/d3/d3.js build/tmp/js/d3.js
 cp build/src/javascript/jsforce/jsforce.js build/tmp/js/jsforce.js
 cp build/src/logos/Logo.svg build/tmp/img
 cp build/src/logos/Mascot.svg build/tmp/img
 cp build/src/logos/Mascot+Animated.svg build/tmp/img
 
+echo "Making a unique zip file"
 (
     cd build/tmp
     zip -9 ../bin/OrgCheck_SR.zip -r ./*
 )
+echo ""
 
+echo "Transfering the zip into the Salesforce App project"
 cp build/bin/OrgCheck_SR.zip force-app/main/default/staticresources/OrgCheck_SR.resource
+echo ""
 
 
-## https://codeinthehole.com/tips/tips-for-using-a-git-pre-commit-hook/
-## ln -s ../../pre-commit.sh .git/hooks/pre-commit
-
-##### ln -s ./javascript/build/build-js.sh .git/hooks/pre-commit 
-
-
+### --------------------------------------------------------------------------------------------
+### Custom Labels and Translations build
+### --------------------------------------------------------------------------------------------
 
-### -----------------------
-### LABELS PART
-### -----------------------
+echo "Custom labels and translations..."
 
+echo " - transfering custom labels (in English) into the Salesforce App project"
 cat build/src/labels/CustomLabels-copyandpasted.txt \
     | sed -e 's/""/"/g' -e 's/^"//' -e 's/"$//' \
     > force-app/main/default/labels/CustomLabels.labels-meta.xml
 
-
-
-### -----------------------
-### TRANSLATIONS PART
-### -----------------------
-
+echo " - transfering French translations into the Salesforce App project"
 cat build/src/labels/Translation-FR-copyandpasted.txt \
     | sed -e 's/""/"/g' -e 's/^"//' -e 's/"$//' \
     > force-app/main/default/translations/fr.translation-meta.xml
 
+echo " - transfering Japanese translations into the Salesforce App project"
 cat build/src/labels/Translation-JP-copyandpasted.txt \
     | sed -e 's/""/"/g' -e 's/^"//' -e 's/"$//' \
     > force-app/main/default/translations/ja.translation-meta.xml
 
+echo ""
 
-
-
-
-### -----------------------
-### Generate the TEST page
-### -----------------------
+echo "Checking if custom labels and translation are correct (the syntax!)"
 (
     echo '<!DOCTYPE html>';
     echo '<html>';
@@ -137,15 +152,23 @@ cat build/src/labels/Translation-JP-copyandpasted.txt \
     done
     echo '  </body>';
     echo '</html>';
-) > /tmp/testAll.txt
-tidy /tmp/testAll.txt 2>&1 | grep 'Warning' | grep -v 'character code' | sort -t' ' -k2,2n > /tmp/testWarnings
-if [ $(cat /tmp/testWarnings | wc -l | tr -d ' ') -ne 0 ]; then
+) > /tmp/testAll.html
+tidy /tmp/testAll.html 2>/tmp/testAll.err 1>/dev/null 
+cat /tmp/testAll.err | grep -e ' - Warning: ' | grep -v 'character code' | sort -t' ' -k2,2n > /tmp/testWarnings.err
+rm /tmp/testAll.html
+rm /tmp/testAll.err
+if [ $(cat /tmp/testWarnings.err | wc -l | tr -d ' ') -ne 0 ]; then
     echo "WARNINGS:"
-    cat /tmp/testWarnings
+    cat /tmp/testWarnings.err
+    rm /tmp/testWarnings.err
+    exit 100;
 fi
+rm /tmp/testWarnings.err
+echo "OK"
+echo ""
 
-
-### -----------------------
-### PUSH INTO DEV ORG
-### -----------------------
-### sfdx force:source:deploy -m StaticResource:OrgCheck_OrgCheck_SR,CustomLabels,Translations  1>/dev/null
+### --------------------------------------------------------------------------------------------
+### If everything is OK push the resulting built items into dev org
+### --------------------------------------------------------------------------------------------
+echo "Deploying to default org (username=$(sfdx config:get defaultusername --json | grep value | cut -d'"' -f4))"
+sfdx force:source:deploy -m StaticResource,CustomLabels,Translations  1>/dev/null

build/build.sh

@@ -32,7 +32,7 @@ List of usefull commands for packaging
 ============================================================
 sfdx force:package:version:list --targetdevhubusername vfinet.devhub@salesforce.com 
 sfdx force:package:version:create --targetdevhubusername vfinet.devhub@salesforce.com --package OrgCheck --definitionfile config/project-scratch-def.json --installationkeybypass --codecoverage --wait 10
-sfdx force:package:version:promote --targetdevhubusername vfinet.devhub@salesforce.com --package OrgCheck@2.1.2-0
+sfdx force:package:version:promote --targetdevhubusername vfinet.devhub@salesforce.com --package OrgCheck@2.4.1-0
 
 
 

build/package.readme

@@ -0,0 +1,13 @@
+Copyright 2010-2021 Mike Bostock
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.

build/src/javascript/d3/d3.LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2011 Shinichi Tomita <shinichi.tomita@gmail.com>;
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

build/src/javascript/jsforce/jsforceLICENSE

@@ -44,7 +44,7 @@ OrgCheck.Cache = {
         const SECTION = configuration.section;
 
         /**
-        * Method to clear all OrgCheck cached items
+        * Method to clear all Org Check cached items
         */
         this.clearAll = function () {
             let keys_to_remove = private_get_keys();
@@ -54,7 +54,7 @@ OrgCheck.Cache = {
         };
 
         /**
-        * Method to clear one OrgCheck cached item
+        * Method to clear one Org Check cached item
         * @param key in cache (without the prefix) to use
         * @return the previous value that has been deleted
         */
@@ -144,12 +144,38 @@ OrgCheck.Cache = {
             }
         };
 
+        /**
+        * Method to get a property of an item from the cache
+        * @param key in cache (without the prefix) to use
+        * @param propertyKey the key of the property within the value in cache
+        * @param defaultPropertyValue if the cache is not present or the property is not set, return that value
+        * @return the value for this property
+        */
+         this.getItemProperty = function (key, propertyKey, defaultPropertyValue) {
+            const value = private_get_item(key) || {};
+            const propertyValue = value[propertyKey];
+            if (propertyValue === undefined) return defaultPropertyValue;
+            return propertyValue;
+        };
+
+        /**
+        * Method to set a property of an item from the cache
+        * @param key in cache (without the prefix) to use
+        * @param propertyKey the key of the property within the value in cache
+        * @param propertyValue the value for this property
+        */
+         this.setItemProperty = function (key, propertyKey, propertyValue) {
+            const value = private_get_item(key) || {};
+            value[propertyKey] = propertyValue;
+            private_set_item(key, value);
+        };
+
         /**
         * Log actions from the cache
         * @param e Error
         */
         function private_log_error(e) {
-            console.error("[OrgCheck:Cache]", { error: e });
+            console.error("[Org Check:Cache]", { error: e });
         }
 
         /**
@@ -161,8 +187,8 @@ OrgCheck.Cache = {
         }
 
         /**
-        * Returns all the OrgCheck keys in cache
-        * @return All the keys of the OrgCheck cache for the given section
+        * Returns all the Org Check keys in cache
+        * @return All the keys of the Org Check cache for the given section
         */
         function private_get_keys() {
             const prefix = private_generate_prefix();
@@ -219,7 +245,7 @@ OrgCheck.Cache = {
         }
 
         /**
-        * Private method to clear one OrgCheck cached item
+        * Private method to clear one Org Check cached item
         * @param key in cache (without the prefix) to use
         * @return the previous value that has been deleted
         */