@tywalk/pcf-helper-run 1.2.15 → 1.3.0

package/README.md

@@ -250,6 +250,22 @@ pcf-helper-run session [options]
 - `-b, --bundle <path>` - Local bundle path
 - `-c, --css <path>` - Local CSS path
 - `-f, --config <path>` - Config file path (default: `session.config.json`)
+- `-w, --watch` - Start pcf-scripts watch process to automatically rebuild on changes
+
+#### Configuration File
+
+Create a `session.config.json` file in your project root to avoid passing parameters repeatedly:
+
+```json
+{
+  "remoteEnvironmentUrl": "https://contoso-dev.crm.dynamics.com",
+  "remoteScriptToIntercept": "/webresources/pub_MyControl/bundle.js",
+  "remoteStylesheetToIntercept": "/webresources/pub_MyControl/css/MyControl.css",
+  "localBundlePath": "./out/controls/MyControl/bundle.js",
+  "localCssPath": "./out/controls/MyControl/css/MyControl.css",
+  "startWatch": false
+}
+```
 
 #### Examples
 
@@ -258,7 +274,13 @@ pcf-helper-run session [options]
 pcf-helper-run session
 
 # Session with custom configuration
-pcf-helper-run session -u "https://contoso.crm.dynamics.com" -s ./bundle.js
+pcf-helper-run session -u "https://contoso.crm.dynamics.com" -s /webresources/pub_MyControl/bundle.js -b ./bundle.js
+
+# Session with watch mode for automatic rebuilds
+pcf-helper-run session --watch
+
+# Session with custom config file
+pcf-helper-run session -f ./my-session.config.json
 ```
 
 ## ⚙️ Global Options
@@ -390,8 +412,8 @@ pcf-helper-run deploy --help
 
 ### Documentation Links
 
-- [Power Platform Component Framework Documentation](https://docs.microsoft.com/en-us/powerapps/developer/component-framework/)
-- [Power Platform CLI Documentation](https://docs.microsoft.com/en-us/powerapps/developer/data-platform/powerapps-cli)
+- [Power Platform Component Framework Documentation](https://learn.microsoft.com/en-us/power-apps/developer/component-framework/overview)
+- [Power Platform CLI Documentation](https://learn.microsoft.com/en-us/power-platform/developer/cli/introduction)
 - [PCF Community Gallery](https://pcf.gallery/)
 
 ## 🔗 Related Packages

package/dist/__tests__/pcf-helper-run.test.js

@@ -38,18 +38,12 @@ const package_json_1 = require("../package.json");
 const tasks = __importStar(require("@tywalk/pcf-helper"));
 test('displays version', (done) => {
     const task = (0, child_process_1.spawn)('node', ['./dist/index.js', '--version']);
-    // Add timeout
-    const timeout = setTimeout(() => {
-        task.kill();
-        done.fail('Test timed out');
-    }, 5000);
     let output = '';
     task.stdout.on('data', (data) => {
         output += data.toString();
     });
     task.on('close', (code) => {
-        clearTimeout(timeout);
-        console.log(output);
+        console.log('Output:', output);
         expect(output).toContain(package_json_1.version);
         expect(code).toBe(0);
         done();
@@ -57,11 +51,6 @@ test('displays version', (done) => {
 }, 10000);
 test('errors if no path is provided', (done) => {
     const task = (0, child_process_1.spawn)('node', ['./dist/index.js', 'build']);
-    // Add timeout
-    const timeout = setTimeout(() => {
-        task.kill();
-        done.fail('Test timed out');
-    }, 5000);
     let output = '';
     task.stdout.on('data', (data) => {
         output += data.toString();
@@ -70,8 +59,7 @@ test('errors if no path is provided', (done) => {
         console.error(`stderr: ${data}`);
     });
     task.on('close', (code) => {
-        clearTimeout(timeout);
-        console.log(output);
+        console.log('Output:', output);
         // The command should exit with non-zero code when required path is missing
         expect(code).not.toBe(0);
         done();
@@ -79,11 +67,6 @@ test('errors if no path is provided', (done) => {
 }, 10000);
 test('errors if incorrect command is provided', (done) => {
     const task = (0, child_process_1.spawn)('node', ['./dist/index.js', 'invalidcommand']);
-    // Add timeout  
-    const timeout = setTimeout(() => {
-        task.kill();
-        done.fail('Test timed out');
-    }, 5000);
     let output = '';
     task.stdout.on('data', (data) => {
         output += data.toString();
@@ -92,8 +75,7 @@ test('errors if incorrect command is provided', (done) => {
         console.error(`stderr: ${data}`);
     });
     task.on('close', (code) => {
-        clearTimeout(timeout);
-        console.log(output);
+        console.log('Output:', output);
         // Invalid command should exit with non-zero code
         expect(code).not.toBe(0);
         done();

package/dist/index.js

@@ -69,8 +69,12 @@ commander_1.program
     .name('pcf-helper-run')
     .description('A simple command-line utility for building and publishing PCF controls to Dataverse.')
     .version(package_json_1.version);
+// Helper function to add verbose option to commands
+const withVerboseOption = (command) => {
+    return command.option('-v, --verbose', 'enable verbose logging');
+};
 // Global options for commands that need them
-const addCommonOptions = (command) => {
+const withCommonOptions = (command) => {
     return command
         .option('-v, --verbose', 'enable verbose logging')
         .option('-t, --timeout <milliseconds>', 'timeout in milliseconds', (value) => {
@@ -81,8 +85,8 @@ const addCommonOptions = (command) => {
         return value;
     });
 };
-const addPathOptions = (command) => {
-    return addCommonOptions(command)
+const withPathOptions = (command) => {
+    return withCommonOptions(command)
         .option('-p, --path <path>', 'path to solution folder')
         .option('-e, --environment <environment>', 'environment name')
         .option('--env <environment>', '[DEPRECATED: use -e/--environment] environment name (deprecated)');
@@ -138,7 +142,7 @@ const handleResults = (taskName, logger, tick, result) => {
     }
 };
 // Define the upgrade command
-addPathOptions(commander_1.program.command('upgrade'))
+withPathOptions(commander_1.program.command('upgrade'))
     .description('upgrade PCF controls')
     .action((options) => {
     const { logger, tick } = setupExecutionContext(options);
@@ -152,13 +156,13 @@ addPathOptions(commander_1.program.command('upgrade'))
         result = tasks.runUpgrade(options.path, options.verbose || false);
     }
     catch (e) {
-        logger.error('[PCF Helper Run] One or more tasks failed while upgrading: ', (e && e.message) || 'unknown error');
+        logger.error('[PCF Helper Run] One or more tasks failed while upgrading: ', e instanceof Error ? e.message : 'unknown error');
         result = 1;
     }
     handleResults('upgrade', logger, tick, result);
 });
 // Define the build command  
-addPathOptions(commander_1.program.command('build'))
+withPathOptions(commander_1.program.command('build'))
     .description('build PCF controls')
     .action((options) => {
     const { logger, tick } = setupExecutionContext(options);
@@ -172,13 +176,13 @@ addPathOptions(commander_1.program.command('build'))
         result = tasks.runBuild(options.path, options.verbose || false, options.timeout ? Number(options.timeout) : undefined);
     }
     catch (e) {
-        logger.error('[PCF Helper Run] One or more tasks failed while building: ', (e && e.message) || 'unknown error');
+        logger.error('[PCF Helper Run] One or more tasks failed while building: ', e instanceof Error ? e.message : 'unknown error');
         result = 1;
     }
     handleResults('build', logger, tick, result);
 });
 // Define the import command
-addPathOptions(commander_1.program.command('import'))
+withPathOptions(commander_1.program.command('import'))
     .description('import PCF controls')
     .action((options) => {
     const { logger, tick } = setupExecutionContext(options);
@@ -196,13 +200,13 @@ addPathOptions(commander_1.program.command('import'))
         result = tasks.runImport(options.path, env, options.verbose || false, options.timeout ? Number(options.timeout) : undefined);
     }
     catch (e) {
-        logger.error('[PCF Helper Run] One or more tasks failed while importing: ', (e && e.message) || 'unknown error');
+        logger.error('[PCF Helper Run] One or more tasks failed while importing: ', e instanceof Error ? e.message : 'unknown error');
         result = 1;
     }
     handleResults('import', logger, tick, result);
 });
 // Define the deploy command (runs upgrade, build, and import)
-addPathOptions(commander_1.program.command('deploy'))
+withPathOptions(commander_1.program.command('deploy'))
     .description('deploy PCF controls (runs upgrade, build, and import)')
     .action((options) => {
     const { logger, tick } = setupExecutionContext(options);
@@ -238,34 +242,36 @@ addPathOptions(commander_1.program.command('deploy'))
         }
     }
     catch (e) {
-        logger.error('[PCF Helper Run] One or more tasks failed while deploying: ', (e && e.message) || 'unknown error');
+        logger.error('[PCF Helper Run] One or more tasks failed while deploying: ', e instanceof Error ? e.message : 'unknown error');
         result = 1;
     }
     handleResults('deploy', logger, tick, result);
 });
 // Define the init command
-addCommonOptions(commander_1.program.command('init'))
+withVerboseOption(commander_1.program.command('init'))
     .description('initialize a new PCF project')
     .requiredOption('-p, --path <path>', 'path to PCF folder')
     .requiredOption('-n, --name <name>', 'name of the control')
     .requiredOption('--publisher-name <publisherName>', 'publisher name')
     .requiredOption('--publisher-prefix <publisherPrefix>', 'publisher prefix')
+    .option('-t, --template <template>', 'template for the component (field|dataset)', 'field')
+    .option('-f, --framework <framework>', 'rendering framework for control (none|react)', 'react')
     .option('--run-npm-install', 'run npm install after initialization', true)
     .action((options) => {
     const { logger, tick } = setupExecutionContext(options);
     let result = 0;
     try {
         logger.log('[PCF Helper Run] ' + (0, performanceUtil_1.formatTime)(new Date()) + ' init started.\n');
-        result = tasks.runInit(options.path, options.name, options.publisherName, options.publisherPrefix, options.runNpmInstall !== false, options.verbose || false);
+        result = tasks.runInit(options.path, options.name, options.publisherName, options.publisherPrefix, options.template || 'field', options.framework || 'react', options.runNpmInstall !== false, options.verbose || false);
     }
     catch (e) {
-        logger.error('[PCF Helper Run] One or more tasks failed while initializing: ', (e && e.message) || 'unknown error');
+        logger.error('[PCF Helper Run] One or more tasks failed while initializing: ', e instanceof Error ? e.message : 'unknown error');
         result = 1;
     }
     handleResults('init', logger, tick, result);
 });
 // Define the session command
-addCommonOptions(commander_1.program.command('session'))
+withCommonOptions(commander_1.program.command('session'))
     .description('run development session')
     .option('-u, --url <url>', 'remote environment URL')
     .option('-i, --intercept-script <script>', 'remote script to intercept')
@@ -290,7 +296,7 @@ addCommonOptions(commander_1.program.command('session'))
         logger.log((0, performanceUtil_1.formatMsToSec)('Session started successfully in %is.', tock - tick));
     }
     catch (e) {
-        logger.error('[PCF Helper Run] One or more tasks failed during session or session startup: ', (e && e.message) || 'unknown error');
+        logger.error('[PCF Helper Run] One or more tasks failed during session or session startup: ', e instanceof Error ? e.message : 'unknown error');
     }
 }));
 // Parse the command line arguments

package/dist/package.json

@@ -1,7 +1,8 @@
 {
     "name": "@tywalk/pcf-helper-run",
-    "version": "1.2.14",
-    "description": "A simple command-line utility for building and publishing PCF controls to Dataverse.",
+    "version": "1.2.16",
+    "description": "Unified CLI interface for Power Platform Component Framework (PCF) development — init, build, import, deploy, and manage PCF controls in Dataverse.",
+    "main": "dist/index.js",
     "types": "./types/",
     "files": [
         "dist",
@@ -22,15 +23,36 @@
         "update": "npm run ready && npm publish --access public"
     },
     "keywords": [
-        "pcf"
+        "pcf",
+        "pcf-control",
+        "pcf-component",
+        "power-platform",
+        "powerapps",
+        "power-apps",
+        "dataverse",
+        "dynamics-365",
+        "microsoft",
+        "cli",
+        "command-line",
+        "developer-tools",
+        "build-tool",
+        "deployment",
+        "automation",
+        "typescript",
+        "pac"
     ],
+    "license": "MIT",
     "author": "tywalk",
+    "homepage": "https://github.com/tywalk/pcf-helper#readme",
+    "engines": {
+        "node": ">=16.0.0"
+    },
     "bin": {
         "pcf-helper-run": "dist/index.js"
     },
     "dependencies": {
         "@tywalk/color-logger": "^1.0.3",
-        "@tywalk/pcf-helper": "^1.6.0"
+        "@tywalk/pcf-helper": "^1.9.0"
     },
     "devDependencies": {
         "@semantic-release/git": "^10.0.1",

package/dist/util/performanceUtil.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatMsToSec = formatMsToSec;
 exports.formatTime = formatTime;
 const util_1 = __importDefault(require("util"));
-var formatter = new Intl.DateTimeFormat('en-US', {
+const formatter = new Intl.DateTimeFormat('en-US', {
     hour: '2-digit',
     minute: '2-digit',
     second: '2-digit',

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@tywalk/pcf-helper-run",
-  "version": "1.2.15",
-  "description": "A simple command-line utility for building and publishing PCF controls to Dataverse.",
+  "version": "1.3.0",
+  "description": "Unified CLI interface for Power Platform Component Framework (PCF) development — init, build, import, deploy, and manage PCF controls in Dataverse.",
+  "main": "dist/index.js",
   "types": "./types/",
   "files": [
     "dist",
@@ -22,15 +23,36 @@
     "update": "npm run ready && npm publish --access public"
   },
   "keywords": [
-    "pcf"
+    "pcf",
+    "pcf-control",
+    "pcf-component",
+    "power-platform",
+    "powerapps",
+    "power-apps",
+    "dataverse",
+    "dynamics-365",
+    "microsoft",
+    "cli",
+    "command-line",
+    "developer-tools",
+    "build-tool",
+    "deployment",
+    "automation",
+    "typescript",
+    "pac"
   ],
+  "license": "MIT",
   "author": "tywalk",
+  "homepage": "https://github.com/tywalk/pcf-helper#readme",
+  "engines": {
+    "node": ">=16.0.0"
+  },
   "bin": {
     "pcf-helper-run": "dist/index.js"
   },
   "dependencies": {
     "@tywalk/color-logger": "^1.0.3",
-    "@tywalk/pcf-helper": "^1.6.0"
+    "@tywalk/pcf-helper": "^1.9.0"
   },
   "devDependencies": {
     "@semantic-release/git": "^10.0.1",

package/types/util/argumentUtil.d.ts

@@ -1,2 +1,2 @@
 export declare function getArg(args: string[], arg: string): string | undefined;
-export declare function getArgValue(args: string[], argOpts: string[], defaultIfExists?: any): string | undefined;
+export declare function getArgValue(args: string[], argOpts: string[], defaultIfExists?: string): string | undefined;