@ds-sfdc/sfparty 1.0.0-0 → 1.1.0

package/src/meta/yargs.js

@@ -0,0 +1,75 @@
+const options = {
+    type: {
+        demand: false,
+        alias: 'type',
+        description: 'type of metadata to $1',
+        demandOption: false,
+        type: 'string',
+    },
+    format: {
+        demand: true,
+        alias: 'format',
+        default: 'yaml',
+        description: 'type of output',
+        demandOption: true,
+        type: 'string',
+    },
+    name: {
+        alias: 'n',
+        description: 'name of metadata file to $1',
+        demandOption: false,
+        type: 'string',
+    },
+    source: {
+        demand: false,
+        alias: 's',
+        description: 'package directory path specified in sfdx-project.json',
+        type: 'string',
+    },
+    target: {
+        demand: false,
+        alias: 't',
+        description: 'target path to directory to create yaml/json files',
+        type: 'string',
+    }
+}
+
+function getOptions(type) {
+    let optionObj = {... options}
+    Object.keys(optionObj).forEach(key => {
+        Object.keys(optionObj[key]).forEach(subKey => {
+            if (typeof optionObj[key][subKey] == 'string') {
+                optionObj[key][subKey] = optionObj[key][subKey].replaceAll('$1', type)
+            }
+        })
+    })
+
+    return optionObj
+}
+
+export const splitOptions = getOptions('split')
+export const combineOptions = getOptions('combine')
+
+const examples = [
+    ['$0 $1'],
+    ['$0 $1 --type=profile'],
+    ['$0 $1 --type="profile,label"'],
+    ['$0 $1 --type=permset --name="Permission Set Name"'],
+    ['--source=packageDir --target=dir/dir'],
+    ['name portion of file: [name].profile-meta.xml'],
+    ['Example: --name="Admin" for Admin.profile-meta.xml'],
+    ['\nCommands not supporting name or all parameters:'],
+    ['$0 $1 --type=label'],
+]
+
+function getExamples(type) {
+    let exArr = [...examples]
+    exArr.forEach(arrItem => {
+        arrItem[0] = arrItem[0].replaceAll('$1', type)
+    })
+
+    return exArr
+}
+
+export const splitExamples = getExamples('split')
+export const combineExamples = getExamples('combine')

package/src/party/combine.js

@@ -8,6 +8,12 @@ import * as xml2js from 'xml2js'
 import * as fileUtils from '../lib/fileUtils.js'
 
 const spinner = cliSpinners['dots']
+const processed = {
+    total: 0,
+    errors: 0,
+    current: 0,
+    type: undefined,
+}
 
 export class Combine {
     #type = undefined
@@ -33,6 +39,7 @@ export class Combine {
         this.targetDir = config.targetDir
         this.metaDir = config.metaDir
         this.sequence = config.sequence
+        this.total = config.total
     }
 
     get metadataDefinition() {
@@ -102,13 +109,19 @@ export class Combine {
         })
 
         function getXML(that) {
+            if (processed.type != that.#root) {
+                processed.current = 0
+                processed.type = that.#root
+            }
+            processed.current++
+
             that.#startTime = process.hrtime.bigint()
-            that.#spinnerMessage = `[%1] of ${global.processed.total} - ${that.#root}: [%4]${chalk.yellowBright('[%5]')}[%2][%3]`
+            that.#spinnerMessage = `[%1] of ${that.total} - ${that.#root}: [%4]${chalk.yellowBright('[%5]')}[%2][%3]`
 
             that.#types.forEach(key => {
                 // display message
                 logUpdate(that.#spinnerMessage
-                    .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
+                    .replace('[%1]', that.sequence.toString().padStart(that.total.toString().length, ' '))
                     .replace('[%2]', `\n${chalk.magentaBright(nextFrame(that))} ${key}`)
                     .replace('[%3]', `${that.#errorMessage}`)
                     .replace('[%4]', `${global.icons.working} `)
@@ -157,7 +170,7 @@ export class Combine {
                 // iterate over fileList
                 fileList.forEach((file, index) => {
                     logUpdate(that.#spinnerMessage
-                        .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
+                        .replace('[%1]', that.sequence.toString().padStart(that.total.toString().length, ' '))
                         .replace('[%2]', `\n${chalk.magentaBright(nextFrame(that))} ${key} - ${index + 1} of ${fileList.length} - ${chalk.magentaBright(file)}`)
                         .replace('[%3]', `${that.#errorMessage}`)
                         .replace('[%4]', `${global.icons.working} `)
@@ -292,7 +305,7 @@ export class Combine {
             let stateIcon = (that.#errorMessage == '') ? global.icons.success : global.icons.fail
 
             logUpdate(that.#spinnerMessage
-                .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
+                .replace('[%1]', that.sequence.toString().padStart(that.total.toString().length, ' '))
                 .replace('[%2]', `. Processed in ${durationMessage}.`)
                 .replace('[%3]', `${that.#errorMessage}`)
                 .replace('[%4]', `${stateIcon} `)

package/src/party/split.js

@@ -12,6 +12,12 @@ import cliSpinners from 'cli-spinners'
 import * as fileUtils from '../lib/fileUtils.js'
 
 const spinner = cliSpinners['dots']
+const processed = {
+    total: 0,
+    errors: 0,
+    current: 0,
+    type: undefined,
+}
 
 export class Split {
     #type = undefined
@@ -33,6 +39,7 @@ export class Split {
         this.targetDir = config.targetDir
         this.metaFilePath = config.metaFilePath
         this.sequence = config.sequence
+        this.total = config.total
     }
 
     get metadataDefinition() {
@@ -117,13 +124,18 @@ export class Split {
         })
 
         function processJSON(that, json, baseDir) {
-            that.#spinnerMessage = `[%1] of ${global.processed.total} - Workflow: [%4]${chalk.yellowBright(that.#fileName.shortName)}[%2][%3]`
+            that.#spinnerMessage = `[%1] of ${that.total} - ${that.#root}: [%4]${chalk.yellowBright(that.#fileName.shortName)}[%2][%3]`
 
             let targetDir = baseDir
+            if (processed.type != that.#root) {
+                processed.current = 0
+                processed.type = that.#root
+            }
+            processed.current++
             Object.keys(json).forEach(key => {
-                that.sequence = global.processed.current
+                that.sequence = processed.current
                 logUpdate(that.#spinnerMessage
-                    .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
+                    .replace('[%1]', that.sequence.toString().padStart(that.total.toString().length, ' '))
                     .replace('[%2]', `\n${chalk.magentaBright(nextFrame(that))} ${key}`)
                     .replace('[%3]', `${that.#errorMessage}`)
                     .replace('[%4]', `${global.icons.working} `)
@@ -157,9 +169,9 @@ export class Split {
             }
             mainInfo.main.name = that.#fileName.shortName
             that.metadataDefinition.main.forEach(key => {
-                that.sequence = global.processed.current
+                that.sequence = processed.current
                 logUpdate(that.#spinnerMessage
-                    .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
+                    .replace('[%1]', that.sequence.toString().padStart(that.total.toString().length, ' '))
                     .replace('[%2]', `\n${chalk.magentaBright(nextFrame(that))} ${key}`)
                     .replace('[%3]', `${that.#errorMessage}`)
                     .replace('[%4]', `${global.icons.working} `)
@@ -182,7 +194,7 @@ export class Split {
             let durationMessage = `${executionTime.seconds}.${executionTime.milliseconds}s`
             let stateIcon = (that.#errorMessage == '') ? global.icons.success : global.icons.fail
             logUpdate(that.#spinnerMessage
-                .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
+                .replace('[%1]', that.sequence.toString().padStart(that.total.toString().length, ' '))
                 .replace('[%2]', `. Processed in ${durationMessage}.`)
                 .replace('[%3]', `${that.#errorMessage}`)
                 .replace('[%4]', `${stateIcon} `)

package/src/lib/permset/combine.js

@@ -1,286 +0,0 @@
-import path from 'path'
-import os from 'os'
-import { readFileSync, writeFileSync, utimesSync } from 'fs'
-import logUpdate from 'log-update'
-import chalk from 'chalk'
-import convertHrtime from 'convert-hrtime'
-import cliSpinners from 'cli-spinners'
-import * as fileUtils from '../fileUtils.js'
-import { permsetDefinition } from '../../meta/PermissionSets.js'
-import * as xml2js from 'xml2js'
-import * as yaml from 'js-yaml'
-
-const spinner = cliSpinners['dots']
-
-export class Permset {
-    #xml = ''
-    #types = []
-    #spinnerMessage = ''
-    #index = 0
-    #startTime = 0
-    #fileName = ''
-    #errorMessage = ''
-    #fileStats
-
-    constructor(config) {
-        this.sourceDir = config.sourceDir
-        this.targetDir = config.targetDir
-        this.metaDir = config.metaDir
-        this.sequence = config.sequence
-    }
-
-    combine() {
-        return new Promise((resolve, reject) => {
-            const that = this
-            if (!fileUtils.directoryExists(path.join(that.sourceDir, that.metaDir))) reject(that.metaDir)
-
-            that.metaDir = fileUtils.getDirectories(that.sourceDir).find(element => element.toLowerCase() == that.metaDir.toLowerCase())
-
-            that.#xml = `<?xml version="1.0" encoding="UTF-8"?>${os.EOL}`
-            that.#xml += `<PermissionSet xmlns="https://soap.sforce.com/2006/04/metadata">${os.EOL}`
-
-            permsetDefinition.main.forEach(key => { that.#types.push(key) })
-            permsetDefinition.singleFiles.forEach(key => { that.#types.push(key) })
-            permsetDefinition.directories.forEach(key => { that.#types.push(key) })
-            that.#types.sort()
-
-            setFileName(that)
-            processPermSet(that)
-
-            saveXML(that)
-            resolve(that.metaDir)
-        })
-
-        function setFileName(that) {
-            const fileName = path.join(that.sourceDir, that.metaDir, `main.${global.format}`)
-            if (fileUtils.fileExists(fileName)) {
-                const data = readFileSync(fileName, { encoding: 'utf8', flag: 'r' })
-                const result = (global.format == 'yaml') ? yaml.load(data) : JSON.parse(data)
-                that.#fileStats = fileUtils.fileInfo(fileName).stats
-                that.#fileName = path.join(that.targetDir, result.name + '.permissionset-meta.xml')
-            }
-        }
-
-        function processPermSet(that) {
-            that.#startTime = process.hrtime.bigint()
-            that.#spinnerMessage = `[%1] of ${global.processed.total} - Permission Set: [%4]${chalk.yellowBright(that.metaDir)}[%2][%3]`
-            logUpdate(that.#spinnerMessage
-                .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
-                .replace('[%2]', '')
-                .replace('[%3]', '')
-                .replace('[%4]', '')
-            )
-
-            that.#types.forEach(key => {
-                let myLocation
-                if (permsetDefinition.main.includes(key)) {
-                    myLocation = 'main'
-                } else if (permsetDefinition.directories.includes(key)) {
-                    myLocation = 'directory'
-                } else if (permsetDefinition.singleFiles.includes(key)) {
-                    myLocation = 'file'
-                }
-                logUpdate(that.#spinnerMessage
-                    .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
-                    .replace('[%2]', `\n${chalk.magentaBright(nextFrame(that))} ${key}`)
-                    .replace('[%3]', `${that.#errorMessage}`)
-                    .replace('[%4]', `${global.icons.working} `)
-                )
-
-                switch (myLocation) {
-                    case 'main':
-                        processMain(that, key)
-                        break
-                    case 'file':
-                        processFile(that, key)
-                        break
-                    case 'directory':
-                        processDirectory(that, key)
-                        break
-                }
-            })
-        }
-
-        function processMain(that, key) {
-            const fileName = path.join(that.sourceDir, that.metaDir, `main.${global.format}`)
-            if (fileUtils.fileExists(fileName)) {
-                const data = readFileSync(fileName, { encoding: 'utf8', flag: 'r' })
-                const result = (global.format == 'yaml') ? yaml.load(data) : JSON.parse(data)
-                if (result[key] !== undefined) that.#xml += `\t<${key}>${result[key]}</${key}>${os.EOL}`
-            }
-        }
-
-        function processFile(that, key) {
-            const fileName = path.join(that.sourceDir, that.metaDir, `${key}.${global.format}`)
-            if (fileUtils.fileExists(fileName)) {
-                if (permsetDefinition.singleFiles.includes(key)) {
-                    genericXML(that, key)
-                } else {
-                    that.#errorMessage += `\n${global.icons.warn} Not processed: ${key}`
-                }
-            }
-        }
-
-        function processDirectory(that, key) {
-            switch (key) {
-                case 'objectPermissions':
-                    objectPermissions(that, key)
-                    break
-                default:
-                    if (permsetDefinition.directories.includes(key)) {
-                        genericDirectoryXML(that, key)
-                        break
-                    } else {
-                        that.#errorMessage += `\n${global.icons.warn} Not processed: ${key}`
-                    }
-            }
-
-        }
-
-        function getTimeDiff(startTime, endTime = process.hrtime.bigint()) {
-            const diff = BigInt(endTime) - BigInt(startTime)
-            let executionTime = convertHrtime(diff)
-            executionTime.seconds = Math.round(executionTime.seconds)
-            executionTime.milliseconds = Math.round(executionTime.milliseconds / 1000)
-            if (executionTime.milliseconds == 0 && executionTime.nanoseconds > 0) executionTime.milliseconds = 1
-            return executionTime
-        }
-
-        function saveXML(that) {
-            fileUtils.createDirectory(that.targetDir)
-            that.#xml += '</PermissionSet>\n'
-            writeFileSync(that.#fileName, that.#xml)
-            utimesSync(that.#fileName, that.#fileStats.atime, that.#fileStats.mtime)
-
-            let executionTime = getTimeDiff(BigInt(that.#startTime))
-            let durationMessage = `${executionTime.seconds}.${executionTime.milliseconds}s`
-            let stateIcon = (that.#errorMessage == '') ? global.icons.success : global.icons.fail
-            logUpdate(that.#spinnerMessage
-                .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
-                .replace('[%2]', `. Processed in ${durationMessage}.`)
-                .replace('[%3]', `${that.#errorMessage}`)
-                .replace('[%4]', `${stateIcon} `)
-            )
-            logUpdate.done()
-
-        }
-
-        function nextFrame(that) {
-            return spinner.frames[that.#index = ++that.#index % spinner.frames.length]
-        }
-
-        function genericXML(that, key) {
-            const fileName = path.join(that.sourceDir, that.metaDir, `${key}.${global.format}`)
-            const builder = new xml2js.Builder({ cdata: false, headless: true, rootName: key })
-
-            if (fileUtils.fileExists(fileName)) {
-                const data = readFileSync(fileName, { encoding: 'utf8', flag: 'r' })
-                const result = (global.format == 'yaml') ? yaml.load(data) : JSON.parse(data)
-                result[key] = sortJSONKeys(sortJSON(result[key], permsetDefinition.sortKeys[key]))
-                result[key].forEach(element => {
-                    that.#xml += `\t<${key}>${os.EOL}`
-                    Object.keys(element).forEach(tag => {
-                        let xml
-                        try {
-                            xml = builder.buildObject(element[tag]).replace(`<${key}>`, '').replace(`</${key}>`, '')
-                            that.#xml += `\t\t<${tag}>${xml}</${tag}>${os.EOL}`                           
-                        } catch (error) {
-                            global.logger.error(error)
-                        }
-                    })
-                    that.#xml += `\t</${key}>${os.EOL}`
-                })
-            }
-        }
-
-        function genericDirectoryXML(that, key) {
-            let dirPath = path.join(that.sourceDir, that.metaDir, key)
-            if (!fileUtils.directoryExists(dirPath)) return
-
-            let fileList = fileUtils.getFiles(dirPath, `.${global.format}`).sort()
-            fileList.forEach(fileName => {
-                const data = readFileSync(path.join(dirPath, fileName), { encoding: 'utf8', flag: 'r' })
-                const result = (global.format == 'yaml') ? yaml.load(data) : JSON.parse(data)
-                const object = result.object
-                result[key] = sortJSONKeys(sortJSON(result[key], permsetDefinition.sortKeys[key]))
-                result[key].forEach(element => {
-                    that.#xml += `\t<${key}>${os.EOL}`
-                    Object.keys(element).forEach(tag => {
-                        if (tag == permsetDefinition.sortKeys[key] && object) {
-                            that.#xml += `\t\t<${tag}>${object}.${element[tag]}</${tag}>${os.EOL}`
-                        } else {
-                            that.#xml += `\t\t<${tag}>${element[tag]}</${tag}>${os.EOL}`
-                        }
-                    })
-                    that.#xml += `\t</${key}>${os.EOL}`
-                })
-            })
-        }
-
-        function objectPermissions(that, key) {
-            let dirPath = path.join(that.sourceDir, that.metaDir, key)
-            if (!fileUtils.directoryExists(dirPath)) return
-
-            let fileList = fileUtils.getFiles(dirPath, `.${global.format}`).sort((a, b) => a.localeCompare(b))
-            fileList.forEach(fileName => {
-                const data = readFileSync(path.join(dirPath, fileName), { encoding: 'utf8', flag: 'r' })
-                const result = (global.format == 'yaml') ? yaml.load(data) : JSON.parse(data)
-                result[key]['object'] = result.object
-                result[key] = sortJSONKeys(result[key])
-                that.#xml += `\t<${key}>${os.EOL}`
-                Object.keys(result[key]).forEach(element => {
-                    that.#xml += `\t\t<${element}>${result[key][element]}</${element}>${os.EOL}`
-                })
-                that.#xml += `\t</${key}>${os.EOL}`
-            })
-        }
-        // end of functions
-        // end of combine
-    }
-
-    // end of class
-}
-
-function sortJSON(json, key) {
-    if (Array.isArray(json)) {
-        json.sort((a, b) => {
-            if (a[key] < b[key]) return -1
-            if (a[key] > b[key]) return 1
-            return 0
-        })
-    }
-    return json
-}
-
-function sortJSONKeys(json) {
-    // sort json keys alphabetically
-    if (Array.isArray(json)) {
-        json.forEach(function (part, index) {
-            this[index] = Object.keys(this[index])
-                .sort((a, b) => {
-                    if (a < b) return -1
-                    if (a > b) return 1
-                    return 0
-                })
-                .reduce((accumulator, key) => {
-                    accumulator[key] = this[index][key]
-
-                    return accumulator
-                }, {})
-        }, json)
-
-    } else {
-        json = Object.keys(json)
-            .sort((a, b) => {
-                if (a < b) return -1
-                if (a > b) return 1
-                return 0
-            })
-            .reduce((accumulator, key) => {
-                accumulator[key] = json[key]
-
-                return accumulator
-            }, {})
-    }
-    return json
-}