@ds-sfdc/sfparty 0.0.0 → 1.0.0-0

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: {

package/{lib/profile/definition.js → src/meta/Profiles.js}

@@ -1,10 +1,14 @@
-export const profileDefinition = {
+export const metadataDefinition = {
     metaUrl: 'https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm',
+    directory: 'profiles',
+    filetype: 'profile',
+    root: 'Profile',
     main: [
+        'fullName',
         'custom',
         'description',
-        'fullName',
         'userLicense',
+        '$',
     ],
     singleFiles: [
         'applicationVisibilities',
@@ -29,8 +33,10 @@ export const profileDefinition = {
         'objectPermissions',
         'recordTypeVisibilities',
     ],
-    ignore: [
-        '$',
+    splitObjects: [
+        'fieldPermissions',
+        'objectPermissions',
+        'recordTypeVisibilities',
     ],
     sortKeys: {
         'applicationVisibilities': 'application',
@@ -51,5 +57,26 @@ export const profileDefinition = {
         'recordTypeVisibilities': 'recordType',
         'tabVisibilities': 'tab',
         'userPermissions': 'name',        
-    }
+    },
+    keyOrder: {
+        applicationVisibilities: ['application', 'visible'],
+        categoryGroupVisibilities: ['dataCategoryGroup'], // TODO
+        classAccesses: ['apexClass', 'enabled'],
+        customMetadataTypeAccesses: ['name', 'enabled'],
+        customPermissions: ['name', 'enabled'],
+        customSettingAccesses: ['name', 'enabled'],
+        externalDataSourceAccesses: ['externalDataSource', 'enabled'],
+        fieldPermissions: ['field', 'editable', 'readable'],
+        flowAccesses: ['flow', 'enabled'],
+        layoutAssignments: ['layout'], // TODO
+        loginFlows: ['friendlyName'], // TODO
+        loginIpRanges: ['startAddress'], // TODO
+        objectPermissions: ['object', 'allowCreate', 'allowRead', 'allowEdit', 'allowDelete', 'viewAllRecords', 'modifyAllRecords'],
+        pageAccesses: ['apexPage', 'enabled'],
+        profileActionOverrides: ['pageOrSobjectType'], // TODO
+        recordTypeVisibilities: ['recordType', 'visible'],
+        tabVisibilities: ['tab', 'visibility'],
+        userPermissions: ['name', 'enabled'],
+    },
+    xmlFirst: 'fullName'
 }

package/{lib/workflow/definition.js → src/meta/Workflows.js}

@@ -1,5 +1,6 @@
 export const metadataDefinition = {
     metaUrl: 'https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_workflow.htm',
+    directory: 'workflows',
     filetype: 'workflow',
     root: 'Workflow',
     main: [

package/{lib/workflow → src/party}/combine.js

@@ -3,8 +3,9 @@ import logUpdate from 'log-update'
 import chalk from 'chalk'
 import convertHrtime from 'convert-hrtime'
 import cliSpinners from 'cli-spinners'
+import os from 'node:os'
 import * as xml2js from 'xml2js'
-import * as fileUtils from '../fileUtils.js'
+import * as fileUtils from '../lib/fileUtils.js'
 
 const spinner = cliSpinners['dots']
 
@@ -73,18 +74,18 @@ export class Combine {
         return new Promise((resolve, reject) => {
             const that = this
             if (!fileUtils.directoryExists(that.sourceDir)) reject(`Path does not exist: ${that.sourceDir}`)
+            let types = ['directories', 'singleFiles', 'main']
+            types.forEach(type => {
+                if (that.metadataDefinition[type] !== undefined) {
+                    that.#types = that.#types.concat(that.metadataDefinition[type])
+                }
+            })
 
-            if (that.metadataDefinition.directories !== undefined) {
-                that.#types = that.#types.concat(that.metadataDefinition.directories)
-            }
-            if (that.metadataDefinition.singleFiles !== undefined) {
-                that.#types = that.#types.concat(that.metadataDefinition.singleFiles)
-            }
-            if (that.metadataDefinition.main !== undefined) {
-                that.#types = that.#types.concat(that.metadataDefinition.main)
-            }
             that.#types.sort((a, b) => {
                 if (a == '$') return -1
+                if (that.metadataDefinition.xmlFirst !== undefined) {
+                    if (a == that.metadataDefinition.xmlFirst) return -1
+                }
                 if (a < b) return -1
                 if (a > b) return 1
                 return 0
@@ -110,7 +111,7 @@ export class Combine {
                     .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.statusLevel.working} `)
+                    .replace('[%4]', `${global.icons.working} `)
                     .replace('[%5]', `${that.#fileName.shortName} `)
                 )
 
@@ -121,9 +122,12 @@ export class Combine {
                         shortName: 'Main',
                         fullName: path.join(that.sourceDir, that.metaDir, `main.${global.format}`),
                     }
-                    processFile(that, key, fileObj)
+                    processFile(that, key, fileObj, 'main')
+                    if (that.#json.$ === undefined) {
+                        that.#json.$ = { xmlns: 'https://soap.sforce.com/2006/04/metadata' }
+                    }
                 } else if (that.metadataDefinition.singleFiles.includes(key)) {
-                    // TODO process single file
+                    processSingleFile(that, key)
                 } else if (that.metadataDefinition.directories.includes(key)) {
                     processDirectory(that, key)
                 } else {
@@ -132,6 +136,15 @@ export class Combine {
             })
         }
 
+        function processSingleFile(that, key) {
+            const fileObj = {
+                shortName: key,
+                fullName: path.join(that.sourceDir, that.metaDir, key + `.${global.format}`),
+            }
+            processFile(that, key, fileObj)
+
+        }
+
         function processDirectory(that, key) {
             // Process the directory sourceDir/metaDir/key
             const currentDir = path.join(that.sourceDir, that.metaDir, key)
@@ -147,7 +160,7 @@ export class Combine {
                         .replace('[%1]', that.sequence.toString().padStart(global.processed.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.statusLevel.working} `)
+                        .replace('[%4]', `${global.icons.working} `)
                         .replace('[%5]', `${that.#fileName.shortName} `)
                     )
 
@@ -162,38 +175,88 @@ export class Combine {
             return true
         }
 
-        function processFile(that, key, fileObj = undefined) {
+        function processFile(that, key, fileObj = undefined, rootKey = undefined) {
             if (
                 fileObj === undefined ||
                 typeof fileObj != 'object' ||
                 fileObj.shortName === undefined ||
                 fileObj.fullName === undefined
             ) {
-                that.#errorMessage += `\n${global.statusLevel.warn} Invalid file information passed ${chalk.redBright(fileObj)}`
+                that.#errorMessage += `\n${global.icons.warn} Invalid file information passed ${chalk.redBright(fileObj)}`
                 return false
             }
 
-            if (fileUtils.fileExists(fileObj.fullName)) {
-                let result = fileUtils.readPartFile(fileObj.fullName)
-                result = sortAndArrange(that, result, key)
-                if (Array.isArray(that.#json[key])) {
-                    that.#json[key].push(result[key])
-                } else {
-                    that.#json[key] = result[key][key][key]
+            if (!fileUtils.fileExists(fileObj.fullName)) {
+                return
+            }
+
+            let result = fileUtils.readPartFile(fileObj.fullName)
+
+            // if split by object we need to add object back to values
+            if (that.metadataDefinition.splitObjects !== undefined && that.metadataDefinition.splitObjects.includes(key)) {
+                result = hydrateObject(that, result, key, fileObj)
+            }
+            result = sortAndArrange(that, result, key)
+
+            if (Array.isArray(that.#json[key])) {
+                try {
+                    if (Array.isArray(result[key])) {
+                        result[key].forEach(arrItem => {
+                            that.#json[key].push(arrItem)
+                        })                          
+                    } else {
+                        that.#json[key].push(result[key])
+                    }
+                } catch (error) {
+                    throw error
+                }
+            } else {
+                try {
+                    that.#json[key] = (rootKey !== undefined) ? result[rootKey][key] : result[key]
+                } catch (error) {
+                    let test = { key: key, rootKey: rootKey, json: result }
+                    throw error
                 }
             }
 
-            updateFileStats(that, fileUtils.fileInfo(fileObj.fullName).stats)
+            updateFileStats(that, fileObj.fullName, fileUtils.fileInfo(fileObj.fullName).stats)
             // genericXML(that, key, fileObj.fullName)
         }
 
-        function updateFileStats(that, stats) {
-            if (that.#fileStats.atime === undefined || stats.atime > that.#fileStats.atime) {
-                that.#fileStats.atime = stats.atime
+        function hydrateObject(that, json, key, fileObj) {
+            const sortKey = that.metadataDefinition.sortKeys[key]
+            let object = json.object
+
+            try {
+                json[key].forEach((arrItem) => {
+                    arrItem[sortKey] = `${object}.${arrItem[sortKey]}`.replace('.undefined', '')
+
+                    // add object key if previously existed
+                    if (that.metadataDefinition.keyOrder[key] !== undefined && that.metadataDefinition.keyOrder[key].includes('order')) {
+                        arrItem.object = object
+                    }
+                })
+
+                // delete object key that we added to the part file
+                delete json.object
+            } catch (error) {
+                throw error
             }
 
-            if (that.#fileStats.mtime === undefined || stats.mtime > that.#fileStats.mtime) {
-                that.#fileStats.mtime = stats.mtime
+            return json
+        }
+
+        function updateFileStats(that, fileName, stats) {
+            try {
+                if (that.#fileStats.atime === undefined || stats.atime > that.#fileStats.atime) {
+                    that.#fileStats.atime = stats.atime
+                }
+
+                if (that.#fileStats.mtime === undefined || stats.mtime > that.#fileStats.mtime) {
+                    that.#fileStats.mtime = stats.mtime
+                }
+            } catch (error) {
+                throw error
             }
         }
 
@@ -226,7 +289,7 @@ export class Combine {
         function finishMessage(that) {
             let executionTime = getTimeDiff(BigInt(that.#startTime))
             let durationMessage = `${executionTime.seconds}.${executionTime.milliseconds}s`
-            let stateIcon = (that.#errorMessage == '') ? global.statusLevel.success : global.statusLevel.fail
+            let stateIcon = (that.#errorMessage == '') ? global.icons.success : global.icons.fail
 
             logUpdate(that.#spinnerMessage
                 .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
@@ -250,7 +313,7 @@ export class Combine {
 }
 
 function sortJSON(json, key) {
-    if (Array.isArray(json)) {
+    if (Array.isArray(json) && key !== undefined) {
         json.sort((a, b) => {
             if (a[key] < b[key]) return -1
             if (a[key] > b[key]) return 1
@@ -263,15 +326,17 @@ function sortJSON(json, key) {
 function sortAndArrange(that, json, key = undefined, topLevel = true) {
     // sort and order keys
     const sortKey = that.metadataDefinition.sortKeys[key]
-    let jsonResult = {}
+
     json = arrangeKeys(that, json, key)
     json = sortJSON(json, sortKey)
 
     Object.keys(json).forEach((subKey, index, thisObj) => {
         if (typeof json[subKey] == 'object') {
             if (!Array.isArray(json[subKey])) {
-                // call recursively on object
-                json[subKey] = sortAndArrange(that, json[subKey], subKey)
+                if (Object.keys(json[subKey]).length > 1) {
+                    // call recursively on object
+                    json[subKey] = sortAndArrange(that, json[subKey], subKey, false)
+                }
             } else {
                 // iterate array for objects
                 json[subKey].forEach((arrItem, index) => {
@@ -284,14 +349,7 @@ function sortAndArrange(that, json, key = undefined, topLevel = true) {
         }
     })
 
-    // we need to include the key into the json for the top-level only
-    if (topLevel) {
-        jsonResult[key] = json
-    } else {
-        jsonResult = json
-    }
-
-    return jsonResult
+    return json
 }
 
 function arrangeKeys(that, json, key = undefined) {