Jo tweaks

messages/deploy.md

@@ -12,14 +12,24 @@ Deploys an initialized and packaged Data Cloud code extension to a Salesforce or
 
   <%= config.bin %> data-code-extension %s deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./package --target-org myorg
 
-- Deploy with specific a CPU size:
+- Deploy with a specific CPU size:
 
   <%= config.bin %> data-code-extension %s deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./package --target-org myorg --cpu-size CPU_4XL
 
 - Deploy with network configuration for Jupyter notebooks:
 
   <%= config.bin %> data-code-extension %s deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./package --target-org myorg --network host
 
+# examples.function
+
+- Deploy a function package to the org with alias "myorg":
+
+  <%= config.bin %> data-code-extension function deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./package --target-org myorg --function-invoke-opt UnstructuredChunking
+
+- Deploy with a specific CPU size:
+
+  <%= config.bin %> data-code-extension function deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./package --target-org myorg --cpu-size CPU_4XL --function-invoke-opt UnstructuredChunking
+
 # info.checkingPython
 
 Checking Python version...

src/base/deployBase.ts

@@ -2,7 +2,7 @@ import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { Messages, Org } from '@salesforce/core';
 import { DatacodeBinaryExecutor, type DatacodeDeployExecutionResult } from '../utils/datacodeBinaryExecutor.js';
 import { checkEnvironment } from '../utils/environmentChecker.js';
-import { sharedBaseFlags, type SharedResultProps } from './types.js';
+import { type SharedResultProps } from './types.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'deploy');
@@ -27,8 +27,7 @@ export type DeployResult = SharedResultProps & {
 
 // eslint-disable-next-line sf-plugin/command-summary, sf-plugin/command-example
 export abstract class DeployBase<TFlags extends BaseDeployFlags = BaseDeployFlags> extends SfCommand<DeployResult> {
-  // Override baseFlags to hide global flags
-  public static readonly baseFlags = sharedBaseFlags;
+  public static enableJsonFlag = false;
 
   public static readonly flags = {
     name: Flags.string({
@@ -38,7 +37,6 @@ export abstract class DeployBase<TFlags extends BaseDeployFlags = BaseDeployFlag
       required: true,
     }),
     version: Flags.string({
-      char: 'v',
       summary: messages.getMessage('flags.version.summary'),
       description: messages.getMessage('flags.version.description'),
       required: true,

src/base/initBase.ts

@@ -2,7 +2,7 @@ import { SfCommand } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
 import { DatacodeBinaryExecutor, type DatacodeInitExecutionResult } from '../utils/datacodeBinaryExecutor.js';
 import { checkEnvironment } from '../utils/environmentChecker.js';
-import { sharedBaseFlags, type SharedResultProps } from './types.js';
+import { type SharedResultProps } from './types.js';
 
 export type BaseInitFlags = {
   'package-dir': string;
@@ -14,8 +14,7 @@ export type InitResult = SharedResultProps & {
 
 // eslint-disable-next-line sf-plugin/command-summary, sf-plugin/command-example
 export abstract class InitBase extends SfCommand<InitResult> {
-  // Override baseFlags to hide global flags
-  public static readonly baseFlags = sharedBaseFlags;
+  public static enableJsonFlag = false;
 
   public async run(): Promise<InitResult> {
     const { flags } = (await this.parse(this.constructor as typeof InitBase)) as unknown as { flags: BaseInitFlags };

src/base/runBase.ts

@@ -2,7 +2,7 @@ import { SfCommand } from '@salesforce/sf-plugins-core';
 import { Messages, Org } from '@salesforce/core';
 import { DatacodeBinaryExecutor, type DatacodeRunExecutionResult } from '../utils/datacodeBinaryExecutor.js';
 import { checkEnvironment } from '../utils/environmentChecker.js';
-import { sharedBaseFlags, type SharedResultProps } from './types.js';
+import { type SharedResultProps } from './types.js';
 
 export type BaseRunFlags = {
   entrypoint: string;
@@ -20,8 +20,7 @@ export type RunResult = SharedResultProps & {
 
 // eslint-disable-next-line sf-plugin/command-summary, sf-plugin/command-example
 export abstract class RunBase extends SfCommand<RunResult> {
-  // Override baseFlags to hide global flags
-  public static readonly baseFlags = sharedBaseFlags;
+  public static enableJsonFlag = false;
 
   public async run(): Promise<RunResult> {
     const { flags } = (await this.parse(this.constructor as typeof RunBase)) as unknown as { flags: BaseRunFlags };

src/base/scanBase.ts

@@ -2,7 +2,6 @@ import { SfCommand } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
 import { DatacodeBinaryExecutor, type ScanResult } from '../utils/datacodeBinaryExecutor.js';
 import { checkEnvironment } from '../utils/environmentChecker.js';
-import { sharedBaseFlags } from './types.js';
 
 export type BaseScanFlags = {
   entrypoint?: string;
@@ -13,8 +12,7 @@ export type BaseScanFlags = {
 
 // eslint-disable-next-line sf-plugin/command-summary, sf-plugin/command-example
 export abstract class ScanBase extends SfCommand<ScanResult> {
-  // Override baseFlags to hide global flags
-  public static readonly baseFlags = sharedBaseFlags;
+  public static enableJsonFlag = false;
 
   public async run(): Promise<ScanResult> {
     const { flags } = (await this.parse(this.constructor as typeof ScanBase)) as unknown as { flags: BaseScanFlags };

src/base/types.ts

@@ -1,23 +1,7 @@
-import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { type PythonVersionInfo } from '../utils/pythonChecker.js';
 import { type PipPackageInfo } from '../utils/pipChecker.js';
 import { type DatacodeBinaryInfo } from '../utils/datacodeBinaryChecker.js';
 
-// eslint-disable-next-line sf-plugin/no-hardcoded-messages-flags, sf-plugin/no-json-flag
-export const sharedBaseFlags = {
-  ...SfCommand.baseFlags,
-  'flags-dir': Flags.directory({
-    summary: 'Import flag values from a directory.',
-    helpGroup: 'GLOBAL',
-    hidden: false,
-  }),
-  json: Flags.boolean({
-    summary: 'Format output as json.',
-    helpGroup: 'GLOBAL',
-    hidden: true,
-  }),
-};
-
 export type SharedResultProps = {
   success: boolean;
   pythonVersion: PythonVersionInfo;

src/base/zipBase.ts

@@ -3,7 +3,7 @@ import { SfCommand } from '@salesforce/sf-plugins-core';
 import { Messages, SfError } from '@salesforce/core';
 import { DatacodeBinaryExecutor, type DatacodeZipExecutionResult } from '../utils/datacodeBinaryExecutor.js';
 import { checkEnvironment } from '../utils/environmentChecker.js';
-import { sharedBaseFlags, type SharedResultProps } from './types.js';
+import { type SharedResultProps } from './types.js';
 
 export type BaseZipFlags = {
   'package-dir': string;
@@ -17,8 +17,7 @@ export type ZipResult = SharedResultProps & {
 
 // eslint-disable-next-line sf-plugin/command-summary, sf-plugin/command-example
 export abstract class ZipBase extends SfCommand<ZipResult> {
-  // Override baseFlags to hide global flags
-  public static readonly baseFlags = sharedBaseFlags;
+  public static enableJsonFlag = false;
 
   public async run(): Promise<ZipResult> {
     const { flags } = (await this.parse(this.constructor as typeof ZipBase)) as unknown as { flags: BaseZipFlags };

src/commands/data-code-extension/function/deploy.ts

@@ -13,17 +13,15 @@ export type FunctionDeployFlags = BaseDeployFlags & {
 export default class Deploy extends DeployBase<FunctionDeployFlags> {
   public static readonly summary = messages.getMessage('summary', ['function']);
   public static readonly description = messages.getMessage('description');
-  public static readonly examples = messages
-    // eslint-disable-next-line sf-plugin/no-missing-messages
-    .getMessages('examples')
-    .map((example) => example.replace(/%s/g, 'function'));
+  public static readonly examples = messages.getMessages('examples.function');
 
   public static readonly flags = {
     ...DeployBase.flags,
     // Function-specific flag
     'function-invoke-opt': Flags.string({
       summary: messages.getMessage('flags.functionInvokeOpt.summary'),
       description: messages.getMessage('flags.functionInvokeOpt.description'),
+      options: ['UnstructuredChunking'],
       required: true,
     }),
   };

src/commands/data-code-extension/function/init.ts

@@ -9,14 +9,7 @@ const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension',
 export default class Init extends InitBase {
   public static readonly summary = messages.getMessage('summary', ['function']);
   public static readonly description = messages.getMessage('description');
-  public static readonly examples = ((): string[] => {
-    try {
-      // eslint-disable-next-line sf-plugin/no-missing-messages
-      return messages.getMessages('examples').map((example) => example.replace(/%s/g, 'function'));
-    } catch {
-      return [];
-    }
-  })();
+  public static readonly examples = messages.getMessages('examples', ['function', 'function', 'function']);
 
   public static readonly flags = {
     ...InitBase.flags,

src/commands/data-code-extension/function/run.ts

@@ -8,10 +8,7 @@ const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension',
 export default class Run extends RunBase {
   public static readonly summary = messages.getMessage('summary', ['function']);
   public static readonly description = messages.getMessage('description');
-  public static readonly examples = messages
-    // eslint-disable-next-line sf-plugin/no-missing-messages
-    .getMessages('examples')
-    .map((example) => example.replace(/%s/g, 'function'));
+  public static readonly examples = messages.getMessages('examples', ['function', 'function', 'function', 'function']);
 
   public static readonly flags = {
     entrypoint: Flags.file({

src/commands/data-code-extension/function/scan.ts

@@ -8,10 +8,14 @@ const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension',
 export default class Scan extends ScanBase {
   public static readonly summary = messages.getMessage('summary', ['function']);
   public static readonly description = messages.getMessage('description');
-  public static readonly examples = messages
-    // eslint-disable-next-line sf-plugin/no-missing-messages
-    .getMessages('examples')
-    .map((example) => example.replace(/%s/g, 'function'));
+  public static readonly examples = messages.getMessages('examples', [
+    'function',
+    'function',
+    'function',
+    'function',
+    'function',
+    'function',
+  ]);
 
   public static readonly flags = {
     entrypoint: Flags.string({

src/commands/data-code-extension/function/zip.ts

@@ -8,10 +8,13 @@ const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension',
 export default class Zip extends ZipBase {
   public static readonly summary = messages.getMessage('summary', ['function']);
   public static readonly description = messages.getMessage('description');
-  public static readonly examples = messages
-    // eslint-disable-next-line sf-plugin/no-missing-messages
-    .getMessages('examples')
-    .map((example) => example.replace(/%s/g, 'function'));
+  public static readonly examples = messages.getMessages('examples', [
+    'function',
+    'function',
+    'function',
+    'function',
+    'function',
+  ]);
 
   public static readonly flags = {
     'package-dir': Flags.directory({

src/commands/data-code-extension/script/init.ts

@@ -9,14 +9,7 @@ const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension',
 export default class Init extends InitBase {
   public static readonly summary = messages.getMessage('summary', ['script']);
   public static readonly description = messages.getMessage('description');
-  public static readonly examples = ((): string[] => {
-    try {
-      // eslint-disable-next-line sf-plugin/no-missing-messages
-      return messages.getMessages('examples').map((example) => example.replace(/%s/g, 'script'));
-    } catch {
-      return [];
-    }
-  })();
+  public static readonly examples = messages.getMessages('examples', ['script', 'script', 'script']);
 
   public static readonly flags = {
     ...InitBase.flags,

src/commands/data-code-extension/script/run.ts

@@ -8,8 +8,7 @@ const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension',
 export default class Run extends RunBase {
   public static readonly summary = messages.getMessage('summary', ['script']);
   public static readonly description = messages.getMessage('description');
-  // eslint-disable-next-line sf-plugin/no-missing-messages
-  public static readonly examples = messages.getMessages('examples').map((example) => example.replace(/%s/g, 'script'));
+  public static readonly examples = messages.getMessages('examples', ['script', 'script', 'script', 'script']);
 
   public static readonly flags = {
     entrypoint: Flags.file({

src/commands/data-code-extension/script/scan.ts

@@ -8,8 +8,14 @@ const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension',
 export default class Scan extends ScanBase {
   public static readonly summary = messages.getMessage('summary', ['script']);
   public static readonly description = messages.getMessage('description');
-  // eslint-disable-next-line sf-plugin/no-missing-messages
-  public static readonly examples = messages.getMessages('examples').map((example) => example.replace(/%s/g, 'script'));
+  public static readonly examples = messages.getMessages('examples', [
+    'script',
+    'script',
+    'script',
+    'script',
+    'script',
+    'script',
+  ]);
 
   public static readonly flags = {
     entrypoint: Flags.string({

src/commands/data-code-extension/script/zip.ts

@@ -8,8 +8,13 @@ const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension',
 export default class Zip extends ZipBase {
   public static readonly summary = messages.getMessage('summary', ['script']);
   public static readonly description = messages.getMessage('description');
-  // eslint-disable-next-line sf-plugin/no-missing-messages
-  public static readonly examples = messages.getMessages('examples').map((example) => example.replace(/%s/g, 'script'));
+  public static readonly examples = messages.getMessages('examples', [
+    'script',
+    'script',
+    'script',
+    'script',
+    'script',
+  ]);
 
   public static readonly flags = {
     'package-dir': Flags.directory({

test/commands/data-code-extension/deploy.test.ts

@@ -212,7 +212,7 @@ describe('data-code-extension deploy', () => {
         '--target-org',
         'test@example.com',
         '--function-invoke-opt',
-        'sync',
+        'UnstructuredChunking',
       ]);
 
       expect(sfCommandStubs.log.calledWith('Data Code Extension deployment completed successfully!')).to.be.true;
@@ -233,10 +233,10 @@ describe('data-code-extension deploy', () => {
         '--target-org',
         'test@example.com',
         '--function-invoke-opt',
-        'sync',
+        'UnstructuredChunking',
       ]);
 
-      expect(binaryDeployStub.firstCall.args[7]).to.equal('sync');
+      expect(binaryDeployStub.firstCall.args[7]).to.equal('UnstructuredChunking');
     });
 
     it('should validate CPU size options', async () => {
@@ -278,7 +278,7 @@ describe('data-code-extension deploy', () => {
           '--target-org',
           'test@example.com',
           '--function-invoke-opt',
-          'sync',
+          'UnstructuredChunking',
         ]);
         expect.fail('Should have thrown an error');
       } catch (error) {
@@ -303,7 +303,7 @@ describe('data-code-extension deploy', () => {
           '--target-org',
           'test@example.com',
           '--function-invoke-opt',
-          'sync',
+          'UnstructuredChunking',
         ]);
         expect.fail('Should have thrown an error');
       } catch (error) {
@@ -360,7 +360,6 @@ describe('data-code-extension deploy', () => {
         testDir,
         '--target-org',
         'test@example.com',
-        '--json',
       ]);
 
       expect(result).to.have.property('success', true);