index.js

const rules = require('./defaultRules')
const getValue = require('./lib/getValue')

function dateCriteria(sobject) {
    return sobject !== "FieldPermissions" && sobject !== "FlexiPage" ? "LastModifiedDate" : "SystemModstamp"
}

function lastUser(sobject) {
    return sobject !== "FieldPermissions" && sobject !== "FlexiPage" ? ", LastModifiedBy.Name" : ""
}

function soqlFromRule(rule, date, toDate, limit = 200) {
    const fromDate = date ? date : '2024-06-15'
    const fromDateCriteria = `where ${dateCriteria(rule.sObject)} > ${fromDate}T00:00:00Z`
    const toDateCriteria = toDate ? ` and ${dateCriteria(rule.sObject)} < ${toDate}T00:00:00Z` :''
    const criteria = rule.when ? ` and ${rule.when}` : ''
    const query = `Select ${rule.field}${rule.relatedFields ?
        (', ' + rule.relatedFields.join(', ')) : ''}${rule.nameField && rule.nameField !== rule.field ? `, ${rule.nameField}` : ''} ${lastUser(rule.sObject)}, ${dateCriteria(rule.sObject)}
    from ${rule.sObject}
       ${fromDateCriteria} ${toDateCriteria}${criteria} 
       order by ${dateCriteria(rule.sObject)} desc limit ${limit}`

    return query
}

function ruleDetail(rule) {
    const regex = rule.regex ? `Regex: \`${rule.regex}\`    
`: ''
    const goodExample = rule.goodExample ? `#### Example
${rule.goodExample}  ` : ''
    return `## ${rule.message}
Field: \`${rule.computedField || rule.field}\`   
${regex}${goodExample}

`

    /**
     * ### Configuration to use
    \`\`\`json
    ${JSON.stringify(rule, null, 2)}
    \`\`\`
    
    ### SOQL Generated
    \`\`\`sql
    ${soqlFromRule(rule, '2024-01-01')}
    \`\`\`
     */
}


function getRules(sobject) {
    return rules.filter(rule => rule.sObject === sobject.attributes?.type)
        .filter(rule => sobject[rule.field] !== undefined)
}

function hasBestPractices(sobject) {
    const rules = getRules(sobject)
    return rules.length > 0
}

function passRule(sobject, rule) {
    const data = getValue(sobject, rule)
    if (rule.regex && data) {
        const pattern = new RegExp(rule.regex)
        if (Array.isArray(data)) {
            const subErrors = data.filter(el => !pattern.test(el?.name || ''))
            if (subErrors.length > 0) {
                return false
            }
        } else {
            if (typeof data === "string") {
                return pattern.test(data)
            }
            return pattern.test(data.toString())
        }
    } else if (rule.lessThan) {
        if (typeof data === 'number') {
            return data < rule.lessThan
        }
        return data === undefined || data === ''
    } else if (!data) {

        return false
    }
    // no specific rule, true if not undefined
    return true
}

function checkBestPractices(sobject) {
    const rules = getRules(sobject)
    const res = []
    rules.forEach(rule => {
        if (!passRule(sobject, rule)) {
            res.push({ name: rule.message })
        }
    })
    return res
}

module.exports = {
    rules,
    passRule,
    hasBestPractices,
    soqlFromRule,
    checkBestPractices,
    ruleDetail,
    getValue,
}