@ds-sfdc/sfparty 0.0.0 → 1.0.0

package/.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx commitlint --edit $1

package/commitlint.config.cjs

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };

package/package.json

@@ -1,21 +1,22 @@
 {
   "name": "@ds-sfdc/sfparty",
-  "version": "0.0.0",
-  "description": "Split Salesforce metadata XML file into YAML (or JSON) parts, and combine back to XML",
+  "version": "1.0.0",
+  "description": "Salesforce metadata XML splitter for CI/CD",
   "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/TimPaulaskasDS/sfparty.git"
   },
   "bin": {
-    "sfparty": "index.js"
+    "sfparty": "src/index.js"
   },
-  "main": "index.js",
+  "main": "src/index.js",
   "scripts": {
-    "test": "mocha 'tests/**/*.js' --recursive--reporter spec"
+    "test": "mocha 'tests/**/*.js' --recursive--reporter spec",
+    "postinstall": "husky install"
   },
   "keywords": [
-    "xml,split,combine,yaml,json"
+    "salesforce,metadata,xml,split,yaml,json"
   ],
   "author": "Tim Paulaskas",
   "license": "BSD-3-Clause",
@@ -32,6 +33,9 @@
     "yargs": "^17.6.2"
   },
   "devDependencies": {
+    "@commitlint/cli": "^17.4.0",
+    "@commitlint/config-conventional": "^17.4.0",
+    "husky": "^8.0.3",
     "mocha": "^10.2.0",
     "nodemon": "^2.0.20",
     "should": "^7.1.0"
@@ -44,7 +48,6 @@
   },
   "homepage": "https://github.com/TimPaulaskasDS/sfparty#readme",
   "directories": {
-    "example": "examples",
     "lib": "lib",
     "test": "tests"
   }

package/{index.js → src/index.js}

@@ -8,15 +8,13 @@ import winston from 'winston'
 import chalk from 'chalk'
 import convertHrtime from 'convert-hrtime'
 import * as fileUtils from './lib/fileUtils.js'
-import * as profileSplit from './lib/profile/split.js'
-import * as profileCombine from './lib/profile/combine.js'
-import * as permSetSplit from './lib/permset/split.js'
-import * as permSetCombine from './lib/permset/combine.js'
-import * as labelSplit from './lib/label/split.js'
-import * as labelCombine from './lib/label/combine.js'
-import * as workflowSplit from './lib/workflow/split.js'
-import * as workflowCombine from './lib/workflow/combine.js'
-import * as workflowDefinition from './lib/workflow/definition.js'
+import * as pkgObj from '../package.json'  assert { type: "json" }
+import * as metadataSplit from './party/split.js'
+import * as metadataCombine from './party/combine.js'
+import * as labelDefinition from './meta/CustomLabels.js'
+import * as profileDefinition from './meta/Profiles.js'
+import * as permsetDefinition from './meta/PermissionSets.js'
+import * as workflowDefinition from './meta/Workflows.js'
 
 const startTime = process.hrtime.bigint()
 
@@ -24,7 +22,7 @@ const startTime = process.hrtime.bigint()
 global.logger = winston.createLogger({
     levels: winston.config.syslog.levels,
     format: winston.format.cli(),
-    defaultMeta: { service: 'dstools', method: 'profile' },
+    defaultMeta: { service: 'sfparty' },
     transports: [
         new winston.transports.Console(),
     ],
@@ -36,11 +34,38 @@ global.processed = {
     current: 1,
 }
 
-global.statusLevel = {
+global.icons = {
     "warn": '🔕',
     "success": chalk.greenBright('✔'),
     "fail": '❗',
-    "working": '⏳'
+    "working": '⏳',
+    "party": '🎉',
+}
+
+const typeArray = [
+    'label',
+    'profile',
+    'permset',
+    'workflow',
+]
+
+const metaTypes = {
+    label: {
+        type: labelDefinition.metadataDefinition.filetype,
+        definition: labelDefinition.metadataDefinition,
+    },
+    profile: {
+        type: profileDefinition.metadataDefinition.filetype,
+        definition: profileDefinition.metadataDefinition,
+    },
+    permset: {
+        type: permsetDefinition.metadataDefinition.filetype,
+        definition: permsetDefinition.metadataDefinition,
+    },
+    workflow: {
+        type: workflowDefinition.metadataDefinition.filetype,
+        definition: workflowDefinition.metadataDefinition,
+    },
 }
 
 function getRootPath(packageDir) {
@@ -70,9 +95,30 @@ function getRootPath(packageDir) {
 
     return defaultDir
 }
-
 let errorMessage = chalk.red('Please specify the action of ' + chalk.whiteBright.bgRedBright('split') + ' or ' + chalk.whiteBright.bgRedBright('combine') + '.')
 
+displayHeader() // display header mast
+
+function displayHeader() {
+    const table = {
+        topLeft: '╭',
+        topRight: '╮',
+        bottomLeft: '╰',
+        bottomRight: '╯',
+        horizontal: '─',
+        vertical: '│',
+    }
+    let versionString = `sfparty v${pkgObj.default.version}${(process.stdout.columns > pkgObj.default.description.length + 15) ? ' - ' + pkgObj.default.description : ''}`
+    let titleMessage = `${global.icons.party} ${chalk.yellowBright(versionString)} ${global.icons.party}`
+    titleMessage = titleMessage.padEnd((process.stdout.columns / 2) + versionString.length / 1.65)
+    titleMessage = titleMessage.padStart(process.stdout.columns)
+    titleMessage = chalk.blackBright(table.vertical) + '  ' + titleMessage + '      ' + chalk.blackBright(table.vertical)
+    console.log(`${chalk.blackBright(table.topLeft + table.horizontal.repeat(process.stdout.columns - 2) + table.topRight)}`)
+    console.log(titleMessage)
+    console.log(`${chalk.blackBright(table.bottomLeft + table.horizontal.repeat(process.stdout.columns - 2) + table.bottomRight)}`)
+    console.log()
+}
+
 yargs(hideBin(process.argv))
     .alias('h', 'help')
     .command({
@@ -131,7 +177,7 @@ yargs(hideBin(process.argv))
                         type: 'string',
                     }
                 })
-                .choices('type', ['label', 'permset', 'profile', 'workflow'])
+                .choices('type', typeArray)
                 .choices('format', ['json', 'yaml'])
                 .check((argv, options) => {
                     const name = argv.name
@@ -157,31 +203,15 @@ yargs(hideBin(process.argv))
                 })
         },
         handler: (argv) => {
-            let metaExtension
+            if (!typeArray.includes(argv.type)) {
+                global.logger.error('Metadata type not supported: ' + type)
+                process.exit(1)
+            }
             const fileList = []
-            let type = argv.type
+            const typeObj = metaTypes[argv.type]
+            const type = typeObj.type
+            const metaExtension = `.${type}-meta.xml`
             global.format = argv.format
-            switch (type) {
-                case 'profile':
-                    type = 'profiles'
-                    metaExtension = '.profile-meta.xml'
-                    break
-                case 'permset':
-                    type = 'permissionsets'
-                    metaExtension = '.permissionset-meta.xml'
-                    break
-                case 'label':
-                    type = 'labels'
-                    metaExtension = '.labels-meta.xml'
-                    break
-                case 'workflow':
-                    type = 'workflows'
-                    metaExtension = '.workflow-meta.xml'
-                    break
-                default:
-                    global.logger.error('Metadata type not supported: ' + type)
-                    process.exit(1)
-            }
 
             let sourceDir = argv.source || ''
             let targetDir = argv.target || ''
@@ -189,14 +219,14 @@ yargs(hideBin(process.argv))
             let all = argv.all
             let packageDir = getRootPath(sourceDir)
 
-            if (type == 'labels') {
-                name = 'CustomLabels'
+            if (type == metaTypes.label.type) {
+                name = metaTypes.label.definition.root
             }
-            sourceDir = path.join(global.__basedir, packageDir, 'main', 'default', type)
+            sourceDir = path.join(global.__basedir, packageDir, 'main', 'default', typeObj.definition.directory)
             if (targetDir == '') {
-                targetDir = path.join(global.__basedir, packageDir + '-party', 'main', 'default', type)
+                targetDir = path.join(global.__basedir, packageDir + '-party', 'main', 'default', typeObj.definition.directory)
             } else {
-                targetDir = path.join(targetDir, 'main', 'default', type)
+                targetDir = path.join(targetDir, 'main', 'default', typeObj.definition.directory)
             }
             let metaDirPath = sourceDir
             console.log(`${chalk.bgBlackBright('Source path:')} ${sourceDir}`)
@@ -227,70 +257,27 @@ yargs(hideBin(process.argv))
             console.log()
             const promList = []
             fileList.forEach(metaFile => {
-                switch (type) {
-                    case 'profiles':
-                        const profile = new profileSplit.Profile({
-                            sourceDir: sourceDir,
-                            targetDir: targetDir,
-                            metaFilePath: path.join(sourceDir, metaFile),
-                            sequence: promList.length + 1,
-                        })
-                        const profProm = profile.split()
-                        promList.push(profProm)
-                        profProm.then(() => {
-                            global.processed.current++
-                        })
-                        break
-                    case 'permissionsets':
-                        const permSet = new permSetSplit.Permset({
-                            sourceDir: sourceDir,
-                            targetDir: targetDir,
-                            metaFilePath: path.join(sourceDir, metaFile),
-                            sequence: promList.length + 1,
-                        })
-                        const permProm = permSet.split()
-                        promList.push(permProm)
-                        permProm.then(() => {
-                            global.processed.current++
-                        })
-                        break
-                    case 'labels':
-                        const label = new labelSplit.CustomLabel({
-                            sourceDir: sourceDir,
-                            targetDir: targetDir,
-                            metaFilePath: path.join(sourceDir, metaFile),
-                            sequence: promList.length + 1,
-                        })
-                        const labelProm = label.split()
-                        promList.push(labelProm)
-                        labelProm.then(() => {
-                            global.processed.current++
-                        })
-                        break
-                    case 'workflows':
-                        const workflow = new workflowSplit.Split({
-                            metadataDefinition: workflowDefinition.metadataDefinition,
-                            sourceDir: sourceDir,
-                            targetDir: targetDir,
-                            metaFilePath: path.join(sourceDir, metaFile),
-                            sequence: promList.length + 1,
-                        })
-                        const workflowProm = workflow.split()
-                        promList.push(workflowProm)
-                        workflowProm.then((resolve, reject) => {
-                            if (resolve == false) {
-                                global.processed.errors++
-                                global.processed.current--
-                            } else {
-                                global.processed.current++
-                            }
-                        })
-                        break
-                }
+                const metadataItem = new metadataSplit.Split({
+                    metadataDefinition: typeObj.definition,
+                    sourceDir: sourceDir,
+                    targetDir: targetDir,
+                    metaFilePath: path.join(sourceDir, metaFile),
+                    sequence: promList.length + 1,
+                })
+                const metadataItemProm = metadataItem.split()
+                promList.push(metadataItemProm)
+                metadataItemProm.then((resolve, reject) => {
+                    if (resolve == false) {
+                        global.processed.errors++
+                        global.processed.current--
+                    } else {
+                        global.processed.current++
+                    }
+                })
             })
             Promise.allSettled(promList).then((results) => {
-                let message = `Split ${chalk.bgBlackBright(global.processed.current)} file(s) ${(global.processed.errors > 0) ? 'with ' + chalk.bgBlackBright.red(global.processed.errors) + ' error(s) ' : ''}in `
-                displayMessage(startTime, message)
+                let message = `Split ${chalk.bgBlackBright((global.processed.current > promList.length) ? promList.length : global.processed.current)} file(s) ${(global.processed.errors > 0) ? 'with ' + chalk.bgBlackBright.red(global.processed.errors) + ' error(s) ' : ''}in `
+                displayMessageAndDuration(startTime, message)
             })
         }
     })
@@ -349,7 +336,7 @@ yargs(hideBin(process.argv))
                         type: 'string',
                     }
                 })
-                .choices('type', ['label', 'permset', 'profile', 'workflow'])
+                .choices('type', typeArray)
                 .choices('format', ['json', 'yaml'])
                 .check((argv, options) => {
                     const name = argv.name
@@ -375,26 +362,14 @@ yargs(hideBin(process.argv))
                 })
         },
         handler: (argv) => {
+            if (!typeArray.includes(argv.type)) {
+                global.logger.error('Metadata type not supported: ' + type)
+                process.exit(1)
+            }
             let processList = []
             global.format = argv.format
-            let type = argv.type
-            switch (type) {
-                case 'profile':
-                    type = 'profiles'
-                    break
-                case 'permset':
-                    type = 'permissionsets'
-                    break
-                case 'label':
-                    type = 'labels'
-                    break
-                case 'workflow':
-                    type = 'workflows'
-                    break
-                default:
-                    global.logger.error('Metadata type not supported: ' + type)
-                    process.exit(1)
-            }
+            const typeObj = metaTypes[argv.type]
+            const type = typeObj.type
 
             let sourceDir = argv.source || ''
             let targetDir = argv.target || ''
@@ -402,19 +377,19 @@ yargs(hideBin(process.argv))
             let all = argv.all
             let packageDir = getRootPath(sourceDir)
 
-            sourceDir = path.join(global.__basedir, packageDir + '-party', 'main', 'default', type)
+            sourceDir = path.join(global.__basedir, packageDir + '-party', 'main', 'default', typeObj.definition.directory)
             if (targetDir == '') {
-                targetDir = path.join(global.__basedir, packageDir, 'main', 'default', type)
+                targetDir = path.join(global.__basedir, packageDir, 'main', 'default', typeObj.definition.directory)
             } else {
-                targetDir = path.join(targetDir, 'main', 'default', type)
+                targetDir = path.join(targetDir, 'main', 'default', typeObj.definition.directory)
             }
 
             console.log(`${chalk.bgBlackBright('Source path:')} ${sourceDir}`)
             console.log(`${chalk.bgBlackBright('Target path:')} ${targetDir}`)
             console.log()
 
-            if (type == 'labels') {
-                processList = fileUtils.getFiles(sourceDir, `.${global.format}`)
+            if (type == metaTypes.label.type) {
+                processList.push(metaTypes.label.definition.root)
             } else if (!all) {
                 let metaDirPath = path.join(sourceDir, name)
                 if (!fileUtils.directoryExists(metaDirPath)) {
@@ -431,69 +406,33 @@ yargs(hideBin(process.argv))
             console.log()
 
             const promList = []
-            if (type != 'labels') {
-                processList.forEach(metaDir => {
-                    if (type == 'profiles') {
-                        const profile = new profileCombine.Profile({
-                            sourceDir: sourceDir,
-                            targetDir: targetDir,
-                            metaDir: metaDir,
-                            sequence: promList.length + 1,
-                        })
-                        const profProm = profile.combine()
-                        promList.push(profProm)
-                        profProm.then(() => {
-                            global.processed.current++
-                        })
-                    } else if (type == 'permissionsets') {
-                        const permSet = new permSetCombine.Permset({
-                            sourceDir: sourceDir,
-                            targetDir: targetDir,
-                            metaDir: metaDir,
-                            sequence: promList.length + 1,
-                        })
-                        const permProm = permSet.combine()
-                        promList.push(permProm)
-                        permProm.then(() => {
-                            global.processed.current++
-                        })
-                    } else if (type == 'workflows') {
-                        const workflow = new workflowCombine.Combine({
-                            metadataDefinition: workflowDefinition.metadataDefinition,
-                            sourceDir: sourceDir,
-                            targetDir: targetDir,
-                            metaDir: metaDir,
-                            sequence: promList.length + 1,
-                        })
-                        const workflowProm = workflow.combine()
-                        promList.push(workflowProm)
-                        workflowProm.then((resolve, reject) => {
-                            global.processed.current++
-                        })
-                    }
-                })
-            } else if (type == 'labels') {
-                const label = new labelCombine.CustomLabel({
+            processList.forEach(metaDir => {
+                const metadataItem = new metadataCombine.Combine({
+                    metadataDefinition: typeObj.definition,
                     sourceDir: sourceDir,
                     targetDir: targetDir,
-                    metaDir: sourceDir, // use sourceDir
-                    processList: processList,
+                    metaDir: metaDir,
+                    sequence: promList.length + 1,
                 })
-                const labelProm = label.combine()
-                promList.push(labelProm)
-                labelProm.then(() => {
+                const metadataItemProm = metadataItem.combine()
+                promList.push(metadataItemProm)
+                metadataItemProm.then((resolve, reject) => {
                     global.processed.current++
                 })
+            })
 
-            }
-
-            Promise.allSettled(promList).then(([result]) => {
-                if (result !== undefined && result.status == 'fulfilled') {
-                    let message = `Combined ${chalk.bgBlackBright(global.processed.total)} file(s) in `
-                    displayMessage(startTime, message)
-                } else {
-                    global.logger.error((result !== undefined) ? result.reason : 'metadata error')
-                }
+            Promise.allSettled(promList).then((results) => {
+                let successes = 0
+                let errors = 0
+                results.forEach(result => {
+                    if (result.value == true) {
+                        successes++
+                    } else if (result.value == false) {
+                        errors++
+                    }
+                })
+                let message = `Combined ${chalk.bgBlackBright(successes)} file(s) ${(errors > 0) ? 'with ' + chalk.bgBlackBright(errors) + 'error(s) ' : ''}in `
+                displayMessageAndDuration(startTime, message)
             })
         }
     })
@@ -508,7 +447,7 @@ yargs(hideBin(process.argv))
     .argv
     .parse
 
-function displayMessage(startTime, message) {
+function displayMessageAndDuration(startTime, message) {
     const diff = process.hrtime.bigint() - BigInt(startTime)
     let durationMessage
     let executionTime = convertHrtime(diff);

package/{lib → src/lib}/fileUtils.js

@@ -37,23 +37,31 @@ export function deleteDirectory(dirPath, recursive = false) {
 
 export function getFiles(dirPath, filter = undefined) {
     const filesList = []
-    fs.readdirSync(dirPath).forEach(file => {
-        if (!filter) {
-            filesList.push(file)
-        } else {
-            if (file.endsWith(filter)) {
+    if (directoryExists(dirPath)) {
+        fs.readdirSync(dirPath).forEach(file => {
+            if (!filter) {
                 filesList.push(file)
+            } else {
+                if (file.endsWith(filter)) {
+                    filesList.push(file)
+                }
             }
-        }
-    })
-    filesList.sort()
-    return filesList
+        })
+        filesList.sort()
+        return filesList
+    } else {
+        return []
+    }
 }
 
 export function getDirectories(dirPath) {
-    return fs.readdirSync(dirPath, { withFileTypes: true })
+    if (directoryExists(dirPath)) {
+        return fs.readdirSync(dirPath, { withFileTypes: true })
         .filter(dirent => dirent.isDirectory())
         .map(dirent => dirent.name)
+    } else {
+        return []
+    }
 }
 
 export function deleteFile(filePath) {

package/{lib/label/definition.js → src/meta/CustomLabels.js}

@@ -1,5 +1,13 @@
-export const labelDefinition = {
+export const metadataDefinition = {
     metaUrl: 'https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customlabels.htm',
+    directory: 'labels',
+    filetype: 'labels',
+    root: 'CustomLabels',
+    main: [
+        '$',
+    ],
+    singleFiles: [
+    ],
     directories: [
         'labels',
     ],
@@ -9,4 +17,7 @@ export const labelDefinition = {
     keyOrder: {
         labels: ['fullName', 'shortDescription', 'categories', 'protected', 'language', 'value'],
     },
+    xmlOrder: {
+        labels: ['fullName'],
+    }
 }

package/{lib/permset/definition.js → src/meta/PermissionSets.js}

@@ -1,43 +1,41 @@
-export const permsetDefinition = {
+export const metadataDefinition = {
     metaUrl: 'https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_permissionset.htm',
+    directory: 'permissionsets',
+    filetype: 'permissionset',
+    root: 'PermissionSet',
     main: [
         'label',
         'description',
         'custom',
         'hasActivationRequired',
         'license',
-        'userLicense', // Replaced by license 
+        'userLicense', // Replaced by license
+        '$',
     ],
     singleFiles: [
         'applicationVisibilities',
-        // 'categoryGroupVisibilities', // PROFILE ONLY
         'classAccesses',
         'customMetadataTypeAccesses',
         'customPermissions',
         'customSettingAccesses',
         'externalDataSourceAccesses',
         'flowAccesses',
-        // 'layoutAssignments', // PROFILE ONLY
-        // 'loginHours', // PROFILE ONLY
-        // 'loginIpRanges', // PROFILE ONLY
         'pageAccesses',
-        // 'profileActionOverrides', // PROFILE ONLY
         'tabSettings',
-        // 'tabVisibilities', // PROFILE ONLY
         'userPermissions',
     ],
     directories: [
         'fieldPermissions',
-        // 'loginFlows', // PROFILE ONLY
         'objectPermissions',
         'recordTypeVisibilities',
     ],
-    ignore: [
-        '$',
+    splitObjects: [
+        'fieldPermissions',
+        'objectPermissions',
+        'recordTypeVisibilities',
     ],
     sortKeys: {
         'applicationVisibilities': 'application',
-        // 'categoryGroupVisibilities': 'dataCategoryGroup', // PROFILE ONLY
         'classAccesses': 'apexClass',
         'customMetadataTypeAccesses': 'name',
         'customPermissions': 'name',
@@ -45,15 +43,10 @@ export const permsetDefinition = {
         'externalDataSourceAccesses': 'externalDataSource',
         'fieldPermissions': 'field',
         'flowAccesses': 'flow',
-        // 'layoutAssignments': 'layout', // PROFILE ONLY
-        // 'loginFlows': 'friendlyName', // PROFILE ONLY
-        // 'loginIpRanges': 'startAddress', // PROFILE ONLY
         'objectPermissions': 'object',
         'pageAccesses': 'apexPage',
-        // 'profileActionOverrides': 'pageOrSobjectType', // PROFILE ONLY
         'recordTypeVisibilities': 'recordType',
         'tabSettings': 'tab',
-        // 'tabVisibilities': 'tab', // PROFILE ONLY
         'userPermissions': 'name',        
     },
     keyOrder: {