sf-intelligence 0.1.12 → 0.1.13

package/LICENSE

@@ -12,23 +12,30 @@ furnished to do so, subject to the following conditions:
 1. The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.
 
-2. COMMONS CLAUSE (Restriction on Commercial Use)
-   The licensor hereby grants you permission to use the Software for
-   non-commercial purposes only.
+2. COMMONS CLAUSE LICENSE CONDITION v1.0
 
-   "Commercial use" means any use of the Software where the primary purpose is
-   to generate revenue or commercial advantage, including but not limited to:
+   The Software is provided to you by the Licensor under the MIT License above,
+   subject to the following condition.
 
-   - Offering the Software or any derivative works as a service or product
-   - Bundling the Software with a commercial offering
-   - Using the Software to create a competing intelligence platform
-   - Reselling access to the Software or its output
-   - Using the Software as part of a paid consulting engagement
+   Without limiting other conditions in the License, the grant of rights under
+   the License will not include, and the License does not grant to you, the
+   right to Sell the Software.
 
-   If you wish to use this Software for commercial purposes, you must obtain a
-   commercial license. Contact: pranav.sfintelligence@gmail.com
+   For purposes of the foregoing, "Sell" means practicing any or all of the
+   rights granted to you under the License to provide to third parties, for a
+   fee or other consideration (including without limitation fees for hosting or
+   consulting/support services related to the Software), a product or service
+   whose value derives, entirely or substantially, from the functionality of
+   the Software. Any license notice or attribution required by the License must
+   also include this Commons Clause License Condition notice.
 
-3. For non-commercial use, attribution is appreciated but not required.
+   Software: sf-intelligence
+   License: MIT
+   Licensor: sf-intelligence contributors
+
+   For a license to Sell the Software, contact: pranav.sfintelligence@gmail.com
+
+3. Attribution is appreciated but not required.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

package/demo-source/main/default/approvalProcesses/Project__c.Discount_Approval.approvalProcess-meta.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApprovalProcess xmlns="http://soap.sforce.com/2006/04/metadata">
+    <active>true</active>
+    <allowRecall>true</allowRecall>
+    <allowedSubmitters>
+        <type>owner</type>
+    </allowedSubmitters>
+    <approvalStep>
+        <name>step_1_manager</name>
+        <label>Manager Approval</label>
+        <assignedApprover>
+            <approver>
+                <type>userHierarchyField</type>
+            </approver>
+            <whenMultipleApprovers>FirstResponse</whenMultipleApprovers>
+        </assignedApprover>
+        <allowDelegate>false</allowDelegate>
+    </approvalStep>
+    <description>High-value Projects (Contract Value over 50,000) require manager approval before proceeding.</description>
+    <enableMobileDeviceAccess>false</enableMobileDeviceAccess>
+    <entryCriteria>
+        <criteriaItems>
+            <field>Project__c.Contract_Value__c</field>
+            <operation>greaterThan</operation>
+            <value>50000</value>
+        </criteriaItems>
+    </entryCriteria>
+    <label>Discount Approval</label>
+    <recordEditability>AdminOnly</recordEditability>
+    <showApprovalHistory>true</showApprovalHistory>
+</ApprovalProcess>

package/demo-source/main/default/classes/IncentiveBatch.cls

@@ -0,0 +1,54 @@
+/**
+ * Batch job that reconciles incentives against their parent projects.
+ *
+ * NOTE: This class intentionally contains anti-patterns for the
+ * sf-intelligence demo (governor_limit_risks + find_hardcoded_values):
+ *   - a SOQL query INSIDE a for-loop, and
+ *   - a hardcoded 15-char Salesforce Id literal.
+ * Do not copy this style into real code.
+ */
+public with sharing class IncentiveBatch implements Database.Batchable<SObject> {
+
+    // Hardcoded record Id literal (intentional anti-pattern for the demo).
+    private static final Id FALLBACK_PROJECT_ID = 'a01000000000001';
+
+    public Database.QueryLocator start(Database.BatchableContext bc) {
+        return Database.getQueryLocator([
+            SELECT Id, Project__c, Amount__c, Approved__c, Type__c
+            FROM Incentive__c
+            WHERE Approved__c = true
+        ]);
+    }
+
+    public void execute(Database.BatchableContext bc, List<Incentive__c> scope) {
+        List<Project__c> toUpdate = new List<Project__c>();
+
+        for (Incentive__c inc : scope) {
+            // INTENTIONAL: SOQL query inside a for-loop (governor-limit risk).
+            List<Project__c> projects = [
+                SELECT Id, Contract_Value__c, Status__c
+                FROM Project__c
+                WHERE Id = :inc.Project__c
+                LIMIT 1
+            ];
+
+            Project__c proj;
+            if (projects.isEmpty()) {
+                // Fall back to the hardcoded Id (intentional anti-pattern).
+                proj = new Project__c(Id = FALLBACK_PROJECT_ID);
+            } else {
+                proj = projects[0];
+            }
+
+            toUpdate.add(proj);
+        }
+
+        if (!toUpdate.isEmpty()) {
+            update toUpdate;
+        }
+    }
+
+    public void finish(Database.BatchableContext bc) {
+        System.debug(LoggingLevel.INFO, 'IncentiveBatch finished.');
+    }
+}

package/demo-source/main/default/classes/IncentiveBatch.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>61.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

package/demo-source/main/default/classes/PaymentService.cls

@@ -0,0 +1,44 @@
+/**
+ * Applies payments against invoices. Updates the invoice's running paid total
+ * (Invoice__c.Total_Paid__c is a roll-up of Payment__c.Amount__c) and marks the
+ * invoice Paid when fully covered.
+ */
+public with sharing class PaymentService {
+
+    /**
+     * Apply a payment to an invoice.
+     *
+     * @param invoiceId the invoice receiving the payment
+     * @param amount    the payment amount (Payment__c.Amount__c)
+     * @param method    the payment method picklist value
+     * @return the inserted Payment__c record
+     */
+    public static Payment__c applyPayment(Id invoiceId, Decimal amount, String method) {
+        Invoice__c invoice = [
+            SELECT Id, Amount__c, Total_Paid__c, Status__c
+            FROM Invoice__c
+            WHERE Id = :invoiceId
+            LIMIT 1
+        ];
+
+        Payment__c payment = new Payment__c(
+            Invoice__c = invoiceId,
+            Amount__c = amount,
+            Payment_Date__c = Date.today(),
+            Method__c = method
+        );
+        insert payment;
+
+        // Total_Paid__c is maintained by the roll-up, but we read it here to
+        // decide whether the invoice is now fully paid.
+        Decimal priorPaid = invoice.Total_Paid__c == null ? 0 : invoice.Total_Paid__c;
+        Decimal newPaid = priorPaid + amount;
+
+        if (invoice.Amount__c != null && newPaid >= invoice.Amount__c) {
+            invoice.Status__c = 'Paid';
+            update invoice;
+        }
+
+        return payment;
+    }
+}

package/demo-source/main/default/classes/PaymentService.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>61.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

package/demo-source/main/default/classes/PaymentServiceTest.cls

@@ -0,0 +1,57 @@
+/**
+ * Tests for PaymentService.
+ *
+ * NOTE: This test INTENTIONALLY contains NO assertions (no System.assert*)
+ * for the sf-intelligence meaningful_test_audit demo. It runs the code path
+ * and "passes" without verifying any outcome. Do not copy this style into
+ * real code.
+ */
+@isTest
+private class PaymentServiceTest {
+
+    @isTest
+    static void applyPaymentRuns() {
+        Project__c proj = new Project__c(
+            Status__c = 'Installing',
+            Contract_Value__c = 30000
+        );
+        insert proj;
+
+        Invoice__c invoice = new Invoice__c(
+            Project__c = proj.Id,
+            Amount__c = 1000,
+            Due_Date__c = Date.today().addDays(30),
+            Status__c = 'Sent'
+        );
+        insert invoice;
+
+        Test.startTest();
+        PaymentService.applyPayment(invoice.Id, 1000, 'ACH');
+        Test.stopTest();
+
+        // No assertions here on purpose (meaningful_test_audit demo).
+    }
+
+    @isTest
+    static void applyPartialPaymentRuns() {
+        Project__c proj = new Project__c(
+            Status__c = 'Installing',
+            Contract_Value__c = 30000
+        );
+        insert proj;
+
+        Invoice__c invoice = new Invoice__c(
+            Project__c = proj.Id,
+            Amount__c = 2000,
+            Due_Date__c = Date.today().addDays(30),
+            Status__c = 'Sent'
+        );
+        insert invoice;
+
+        Test.startTest();
+        PaymentService.applyPayment(invoice.Id, 500, 'Card');
+        Test.stopTest();
+
+        // Still no assertions (deliberate).
+    }
+}

package/demo-source/main/default/classes/PaymentServiceTest.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>61.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

package/demo-source/main/default/classes/ProjectTriggerHandler.cls

@@ -0,0 +1,60 @@
+/**
+ * Handler for ProjectTrigger. Derives Risk_Score__c on Project__c from the
+ * project's Status__c and Contract_Value__c, and propagates status changes.
+ */
+public with sharing class ProjectTriggerHandler {
+
+    /**
+     * Before insert/update: derive a 0-100 risk score for each project.
+     * Higher contract values and unstarted/cancelled statuses raise risk.
+     */
+    public static void handleBeforeSave(List<Project__c> projects) {
+        for (Project__c proj : projects) {
+            proj.Risk_Score__c = computeRiskScore(proj);
+        }
+    }
+
+    /**
+     * After update: when a project is moved to Cancelled, log the change.
+     * Kept simple for the demo; no DML on related records here.
+     */
+    public static void handleAfterUpdate(List<Project__c> projects, Map<Id, Project__c> oldMap) {
+        for (Project__c proj : projects) {
+            Project__c prior = oldMap.get(proj.Id);
+            if (prior != null && prior.Status__c != proj.Status__c && proj.Status__c == 'Cancelled') {
+                System.debug(LoggingLevel.INFO, 'Project ' + proj.Id + ' moved to Cancelled');
+            }
+        }
+    }
+
+    /**
+     * Risk model: base on status, then scale by contract value.
+     */
+    private static Decimal computeRiskScore(Project__c proj) {
+        Decimal score = 0;
+        String status = proj.Status__c;
+        if (status == 'Draft') {
+            score = 40;
+        } else if (status == 'Approved' || status == 'Permitting') {
+            score = 25;
+        } else if (status == 'Installing') {
+            score = 15;
+        } else if (status == 'Complete') {
+            score = 5;
+        } else if (status == 'Cancelled') {
+            score = 80;
+        }
+
+        Decimal value = proj.Contract_Value__c == null ? 0 : proj.Contract_Value__c;
+        if (value > 100000) {
+            score += 20;
+        } else if (value > 50000) {
+            score += 10;
+        }
+
+        if (score > 100) {
+            score = 100;
+        }
+        return score;
+    }
+}

package/demo-source/main/default/classes/ProjectTriggerHandler.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>61.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

package/demo-source/main/default/classes/ProjectTriggerHandlerTest.cls

@@ -0,0 +1,80 @@
+/**
+ * Tests for ProjectTriggerHandler. This is a REAL test: it exercises the
+ * risk-score derivation and asserts the expected outcomes (System.assert*).
+ */
+@isTest
+private class ProjectTriggerHandlerTest {
+
+    @isTest
+    static void draftHighValueProjectGetsElevatedRisk() {
+        Project__c proj = new Project__c(
+            Status__c = 'Draft',
+            Contract_Value__c = 120000
+        );
+
+        Test.startTest();
+        insert proj;
+        Test.stopTest();
+
+        Project__c reloaded = [
+            SELECT Id, Risk_Score__c
+            FROM Project__c
+            WHERE Id = :proj.Id
+            LIMIT 1
+        ];
+
+        // Draft (40) + value > 100000 (20) = 60.
+        System.assertEquals(60, reloaded.Risk_Score__c,
+            'Draft high-value project should score 60');
+    }
+
+    @isTest
+    static void completeLowValueProjectGetsLowRisk() {
+        Project__c proj = new Project__c(
+            Status__c = 'Complete',
+            Contract_Value__c = 10000,
+            Permit_Approved__c = true
+        );
+
+        Test.startTest();
+        insert proj;
+        Test.stopTest();
+
+        Project__c reloaded = [
+            SELECT Id, Risk_Score__c, Status__c
+            FROM Project__c
+            WHERE Id = :proj.Id
+            LIMIT 1
+        ];
+
+        System.assertEquals('Complete', reloaded.Status__c,
+            'Status should persist as Complete');
+        System.assert(reloaded.Risk_Score__c < 20,
+            'Complete low-value project should score under 20');
+    }
+
+    @isTest
+    static void cancelledProjectGetsHighRisk() {
+        Project__c proj = new Project__c(
+            Status__c = 'Draft',
+            Contract_Value__c = 5000
+        );
+        insert proj;
+
+        proj.Status__c = 'Cancelled';
+
+        Test.startTest();
+        update proj;
+        Test.stopTest();
+
+        Project__c reloaded = [
+            SELECT Id, Risk_Score__c
+            FROM Project__c
+            WHERE Id = :proj.Id
+            LIMIT 1
+        ];
+
+        System.assert(reloaded.Risk_Score__c >= 80,
+            'Cancelled project should score at least 80');
+    }
+}

package/demo-source/main/default/classes/ProjectTriggerHandlerTest.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>61.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

package/demo-source/main/default/flows/Installation_On_Complete.flow-meta.xml

@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>61.0</apiVersion>
+    <description>When an Installation is Completed, log an Inspection Service Visit and mark the parent Project Complete.</description>
+    <label>Installation On Complete</label>
+    <processType>AutoLaunchedFlow</processType>
+    <status>Active</status>
+    <interviewLabel>Installation On Complete {!$Flow.CurrentDateTime}</interviewLabel>
+    <environments>Default</environments>
+    <start>
+        <locationX>176</locationX>
+        <locationY>0</locationY>
+        <connector>
+            <targetReference>Create_Service_Visit</targetReference>
+        </connector>
+        <object>Installation__c</object>
+        <recordTriggerType>CreateAndUpdate</recordTriggerType>
+        <triggerType>RecordAfterSave</triggerType>
+        <filterLogic>and</filterLogic>
+        <filters>
+            <field>Status__c</field>
+            <operator>EqualTo</operator>
+            <value>
+                <stringValue>Completed</stringValue>
+            </value>
+        </filters>
+    </start>
+    <recordCreates>
+        <name>Create_Service_Visit</name>
+        <label>Create Service Visit</label>
+        <locationX>176</locationX>
+        <locationY>134</locationY>
+        <connector>
+            <targetReference>Update_Parent_Project</targetReference>
+        </connector>
+        <inputAssignments>
+            <field>Installation__c</field>
+            <value>
+                <elementReference>$Record.Id</elementReference>
+            </value>
+        </inputAssignments>
+        <inputAssignments>
+            <field>Reason__c</field>
+            <value>
+                <stringValue>Inspection</stringValue>
+            </value>
+        </inputAssignments>
+        <object>Service_Visit__c</object>
+        <storeOutputAutomatically>true</storeOutputAutomatically>
+    </recordCreates>
+    <recordUpdates>
+        <name>Update_Parent_Project</name>
+        <label>Update Parent Project</label>
+        <locationX>176</locationX>
+        <locationY>254</locationY>
+        <filterLogic>and</filterLogic>
+        <filters>
+            <field>Id</field>
+            <operator>EqualTo</operator>
+            <value>
+                <elementReference>$Record.Project__c</elementReference>
+            </value>
+        </filters>
+        <inputAssignments>
+            <field>Status__c</field>
+            <value>
+                <stringValue>Complete</stringValue>
+            </value>
+        </inputAssignments>
+        <object>Project__c</object>
+    </recordUpdates>
+</Flow>

package/demo-source/main/default/flows/Project_On_Approve.flow-meta.xml

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>61.0</apiVersion>
+    <description>When a Project is approved, create a Permit record (Submitted) linked back to the Project.</description>
+    <label>Project On Approve</label>
+    <processType>AutoLaunchedFlow</processType>
+    <status>Active</status>
+    <interviewLabel>Project On Approve {!$Flow.CurrentDateTime}</interviewLabel>
+    <environments>Default</environments>
+    <start>
+        <locationX>176</locationX>
+        <locationY>0</locationY>
+        <connector>
+            <targetReference>Create_Permit</targetReference>
+        </connector>
+        <object>Project__c</object>
+        <recordTriggerType>CreateAndUpdate</recordTriggerType>
+        <triggerType>RecordAfterSave</triggerType>
+        <filterLogic>and</filterLogic>
+        <filters>
+            <field>Status__c</field>
+            <operator>EqualTo</operator>
+            <value>
+                <stringValue>Approved</stringValue>
+            </value>
+        </filters>
+    </start>
+    <recordCreates>
+        <name>Create_Permit</name>
+        <label>Create Permit</label>
+        <locationX>176</locationX>
+        <locationY>134</locationY>
+        <inputAssignments>
+            <field>Project__c</field>
+            <value>
+                <elementReference>$Record.Id</elementReference>
+            </value>
+        </inputAssignments>
+        <inputAssignments>
+            <field>Status__c</field>
+            <value>
+                <stringValue>Submitted</stringValue>
+            </value>
+        </inputAssignments>
+        <object>Permit__c</object>
+        <storeOutputAutomatically>true</storeOutputAutomatically>
+    </recordCreates>
+</Flow>

package/demo-source/main/default/groups/Finance_Group.group-meta.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Group xmlns="http://soap.sforce.com/2006/04/metadata">
+    <name>Finance Group</name>
+    <doesIncludeBosses>false</doesIncludeBosses>
+    <doesSendEmailToMembers>false</doesSendEmailToMembers>
+    <description>Finance team members who handle invoices and payments.</description>
+</Group>

package/demo-source/main/default/groups/Ops_Group.group-meta.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Group xmlns="http://soap.sforce.com/2006/04/metadata">
+    <name>Ops Group</name>
+    <doesIncludeBosses>false</doesIncludeBosses>
+    <doesSendEmailToMembers>false</doesSendEmailToMembers>
+    <description>Operations team members who manage projects and installations.</description>
+</Group>

package/demo-source/main/default/layouts/Installation__c-Installation Layout.layout-meta.xml

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Layout xmlns="http://soap.sforce.com/2006/04/metadata">
+    <layoutSections>
+        <customLabel>false</customLabel>
+        <detailHeading>false</detailHeading>
+        <editHeading>true</editHeading>
+        <label>Information</label>
+        <layoutColumns>
+            <layoutItems>
+                <behavior>Required</behavior>
+                <field>Name</field>
+            </layoutItems>
+            <layoutItems>
+                <behavior>Edit</behavior>
+                <field>Project__c</field>
+            </layoutItems>
+            <layoutItems>
+                <behavior>Edit</behavior>
+                <field>Status__c</field>
+            </layoutItems>
+        </layoutColumns>
+        <layoutColumns>
+            <layoutItems>
+                <behavior>Edit</behavior>
+                <field>Install_Date__c</field>
+            </layoutItems>
+            <layoutItems>
+                <behavior>Edit</behavior>
+                <field>Crew_Lead__c</field>
+            </layoutItems>
+            <layoutItems>
+                <behavior>Edit</behavior>
+                <field>Panels_Installed__c</field>
+            </layoutItems>
+        </layoutColumns>
+        <style>TwoColumnsTopToBottom</style>
+    </layoutSections>
+    <showEmailCheckbox>false</showEmailCheckbox>
+    <showHighlightsPanel>true</showHighlightsPanel>
+    <showInteractionLogPanel>false</showInteractionLogPanel>
+    <showRunAssignmentRulesCheckbox>false</showRunAssignmentRulesCheckbox>
+    <showSubmitAndAttachButton>false</showSubmitAndAttachButton>
+</Layout>