@mysf/plugin-sf-data-export 1.0.0

package/lib/commands/data/gitDifferencePlugin.js

@@ -0,0 +1,67 @@
+import { simpleGit } from 'simple-git';
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@mysf/plugin-sf-data-export', 'export');
+export class GitDifferencePlugin extends SfCommand {
+    // 1. Inherit default flags (json, loglevel, etc.) by extending SfCommand
+    static summary = messages.getMessage('gitDiffSummary');
+    static examples = messages.getMessages('examples');
+    // Custom flags stay here
+    static flags = {
+        'base-sha': Flags.string({
+            char: 'b',
+            summary: messages.getMessage('flags.base-sha.summary'),
+            default: 'HEAD~1',
+        }),
+    };
+    // Explicit accessibility modifier (private) for ESLint
+    git;
+    // Explicit accessibility modifier (public) for ESLint
+    // You must include these arguments to satisfy the SfCommand signature
+    constructor(argv, config) {
+        super(argv, config); // The required super call
+        this.git = simpleGit();
+    }
+    /*
+     * Detects filenames changed between two points in Git history.
+     * @param baseSha The starting commit (defaults to previous commit)
+     * @returns Array of modified filenames
+     */
+    async getChangedFiles(baseSha = 'HEAD~1') {
+        try {
+            const isRepo = await this.git.checkIsRepo();
+            if (!isRepo) {
+                throw new Error('Current directory is not a git repository');
+            }
+            // --name-only returns just the paths of the files
+            const diffString = await this.git.diff(['--name-only', baseSha, 'HEAD']);
+            // Filter out empty strings from the resulting array
+            return diffString.split('\n').filter(Boolean);
+        }
+        catch (err) {
+            const message = err instanceof Error ? err.message : String(err);
+            throw new Error(`Git Detection Failed: ${message}`);
+        }
+    }
+    async run() {
+        const { flags } = await this.parse(GitDifferencePlugin);
+        this.spinner.start('Analyzing git diff');
+        try {
+            const changedFiles = await this.getChangedFiles(flags['base-sha']);
+            this.spinner.stop();
+            if (changedFiles.length === 0) {
+                this.log('No files changed.');
+            }
+            else {
+                this.log('Changed files:');
+                changedFiles.forEach((f) => this.log(` - ${f}`));
+            }
+        }
+        catch (err) {
+            this.spinner.stop('Error');
+            this.error(err instanceof Error ? err.message : String(err));
+        }
+    }
+}
+//# sourceMappingURL=gitDifferencePlugin.js.map

package/lib/commands/data/restExport.js

@@ -0,0 +1,59 @@
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+// Load messages for help text
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@mysf/plugin-sf-data-export', 'export');
+export default class RestExport extends SfCommand {
+    // Enables the use of --target-org
+    static requiresOrg = true;
+    static summary = messages.getMessage('restExportSummary');
+    static examples = messages.getMessages('restExportExamples');
+    static flags = {
+        'target-org': Flags.requiredOrg({
+            char: 'o',
+            summary: messages.getMessage('flags.target-org.summary'),
+            required: true,
+        }),
+        output: Flags.string({
+            char: 'f',
+            summary: messages.getMessage('flags.output.summary'),
+            default: './data/restExport.json',
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(RestExport);
+        // EXPLICIT ACCESS: Access the org via the parsed flags
+        // This is often more stable in the latest SF CLI versions
+        const org = flags['target-org'];
+        if (!org) {
+            throw new Error('Could not find the target org.');
+        }
+        const conn = org.getConnection('60.0');
+        this.spinner.start('Calling Apex REST Export Resource');
+        try {
+            // 1. Hit the custom endpoint you created in Org A
+            const result = await conn.request({
+                method: 'GET',
+                url: '/services/apexrest/DataExport/',
+            });
+            // 2. Prepare the directory
+            const filePath = path.resolve(flags['output']);
+            const directory = path.dirname(filePath);
+            if (!fs.existsSync(directory)) {
+                fs.mkdirSync(directory, { recursive: true });
+            }
+            // 3. Write the JSON data to disk
+            fs.writeFileSync(filePath, JSON.stringify(result, null, 2), 'utf8');
+            this.spinner.stop('Done');
+            this.log(`\nSUCCESS: Data written to ${filePath}`);
+        }
+        catch (err) {
+            this.spinner.stop('Failed');
+            const errorMessage = err instanceof Error ? err.message : String(err);
+            this.error(`REST Call Failed: ${errorMessage}`);
+        }
+    }
+}
+//# sourceMappingURL=restExport.js.map

package/lib/commands/data/restImport.js

@@ -0,0 +1,54 @@
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+// Load messages for help text
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@mysf/plugin-sf-data-export', 'export');
+export default class RestImport extends SfCommand {
+    // Enables the use of --target-org
+    static requiresOrg = true;
+    static summary = messages.getMessage('restImportSummary');
+    static examples = messages.getMessages('restImportExamples');
+    static flags = {
+        'target-org': Flags.requiredOrg({
+            char: 'o',
+            summary: messages.getMessage('flags.target-org.summary'),
+            required: true,
+        }),
+        'input-file': Flags.string({
+            char: 'f',
+            summary: messages.getMessage('flags.input-file.summary'),
+            default: './data/restExport.json',
+        }),
+    };
+    async run() {
+        try {
+            const { flags } = await this.parse(RestImport);
+            const org = flags['target-org'];
+            if (!org) {
+                throw new Error('Could not find the target org.');
+            }
+            const conn = org.getConnection('60.0');
+            // 1. Read the JSON file from your local data folder
+            const data = fs.readFileSync(path.resolve(flags['input-file']), 'utf8');
+            // 2. POST the data to Org B's Apex REST endpoint
+            const result = await conn.request({
+                method: 'POST',
+                url: '/services/apexrest/DataImport/',
+                body: data,
+                headers: {
+                    'Content-Type': 'application/json',
+                    Accept: 'text/plain',
+                },
+            });
+            this.log('Data successfully pushed to Org B');
+            this.log(`Response from Salesforce: ${result}`);
+            // this.styledJSON(result);
+        }
+        catch (err) {
+            this.error(err instanceof Error ? err.message : String(err));
+        }
+    }
+}
+//# sourceMappingURL=restImport.js.map

package/lib/index.js

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2026, Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export default {};
+//# sourceMappingURL=index.js.map

package/messages/export.json

@@ -0,0 +1,37 @@
+{
+  "summary": "Export data from an org in JSON format.",
+  "bulkSummary": "Export all fields from a specific object.",
+  "objectCompareSummary": "Compare fields of an object between two orgs.",
+  "callApexClassSummary": "Calling a specific method of the Apex class present in the target org.",
+  "gitDiffSummary": "Detects changed files using Git",
+  "restExportSummary": "Exports data from Org A via Apex REST for Git versioning.",
+  "restImportSummary": "Import data to the Org B via Apex REST for Git versioning.",
+
+  "examples": [
+    "sf data export --soql \"SELECT Name FROM Account\" --target-org my-org",
+    "sf data export --soql \"SELECT Id, Status FROM Case\" --output results.json"
+  ],
+
+  "bulkExamples": [
+    "sf data bulk --object Account --target-org my-org",
+    "sf data bulk --object Contact --target-org my-org"
+  ],
+
+  "compareExamples": ["sf data compare --object Account --source-org \"DevOrg\" --target-org \"ProdOrg\""],
+
+  "restExportExamples": [
+    "sf data restExport --target-org OrgA",
+    "sf data restExport --target-org OrgA --output ./custom/path.json"
+  ],
+
+  "restImportExamples": ["sf data restImport --target-org OrgB --input-file ./data/contact.json"],
+
+  "flags.base-sha.summary": "The commit SHA to compare against",
+  "flags.object.summary": "The API name of the object.",
+  "flags.soql.summary": "The SOQL query to execute.",
+  "flags.output.summary": "The file path to save the results.",
+  "flags.input-file.summary": "The file path to be taken as an input for the import.",
+  "flags.source-org.summary": "The first org (Source)",
+  "flags.target-org.summary": "The second org (Target)",
+  "success": "Successfully exported %s records to %s."
+}