@tywalk/pcf-helper 1.4.13 → 1.4.15

package/README.md

@@ -21,6 +21,7 @@ This tool requires the following:
   "upgrade": "pcf-helper-upgrade --path <path to pcf project folder>",
   "build": "pcf-helper-build --path <path to pcf project folder>",
   "import": "pcf-helper-import --path <path to pcf project folder> --environment <environment guid or url>",
-  "deploy": "pcf-helper-deploy --path <path to pcf project folder> --environment <environment guid or url>"
+  "deploy": "pcf-helper-deploy --path <path to pcf project folder> --environment <environment guid or url>",
+  "init": "pcf-helper-init --path <path to pcf project folder (optional)> --name <name of the pcf project> --publisher-name <powerapps publisher name> --publisher-prefix <powerapps publisher prefix>"
 },
 ```

package/package.json

@@ -1,27 +1,38 @@
 {
   "name": "@tywalk/pcf-helper",
-  "version": "1.4.13",
+  "version": "1.4.15",
   "description": "Command line helper for building and publishing PCF controls to Dataverse.",
+  "types": "./types/",
+  "files": [
+    "dist",
+    "types"
+  ],
   "repository": {
     "url": "git+https://github.com/tywalk/pcf-helper.git"
   },
   "scripts": {
-    "test": "jest"
+    "test": "jest",
+    "build": "tsc",
+    "upgrade": "npm version patch --no-git-tag-version",
+    "ready": "npm run upgrade && npm run build"
   },
   "keywords": [
     "pcf"
   ],
   "author": "tywalk",
   "bin": {
-    "pcf-helper-upgrade": "bin/upgrade.js",
-    "pcf-helper-build": "bin/build.js",
-    "pcf-helper-import": "bin/import.js",
-    "pcf-helper-deploy": "bin/deploy.js"
-  },
-  "dependencies": {
-    "@tywalk/color-logger": "^1.0.1"
+    "pcf-helper-upgrade": "dist/bin/upgrade.js",
+    "pcf-helper-build": "dist/bin/build.js",
+    "pcf-helper-import": "dist/bin/import.js",
+    "pcf-helper-deploy": "dist/bin/deploy.js",
+    "pcf-helper-init": "dist/bin/init.js"
   },
   "devDependencies": {
-    "jest": "^29.7.0"
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.13.11",
+    "@tywalk/color-logger": "^1.0.3",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.6",
+    "typescript": "^5.8.2"
   }
 }

package/__tests__/pcf-helper-build.test.js

@@ -1,41 +0,0 @@
-const { spawn } = require('child_process');
-const version = require('../package.json').version;
-
-test('build displays version', (done) => {
-  const task = spawn('node', ['./bin/build.js', '-v']);
-
-  let output = '';
-  task.stdout.on('data', (data) => {
-    output += data.toString();
-  });
-
-  task.stderr.on('data', (data) => {
-    console.error(`stderr: ${data}`);
-  });
-
-  task.on('close', (code) => {
-    console.log(output);
-    expect(output).toContain(version);
-    expect(code).toBe(0);
-    done();
-  });
-});
-
-test('build errors if no path is provided', (done) => {
-  const task = spawn('node', ['./bin/build.js', '-p']);
-
-  let output = '';
-  task.stdout.on('data', (data) => {
-    output += data.toString();
-  });
-
-  task.stderr.on('data', (data) => {
-    console.error(`stderr: ${data}`);
-  });
-
-  task.on('close', (code) => {
-    console.log(output);
-    expect(code).toBe(1);
-    done();
-  });
-});

package/__tests__/pcf-helper-deploy.test.js

@@ -1,37 +0,0 @@
-const { spawn } = require('child_process');
-const version = require('../package.json').version;
-
-test('deploy displays version', (done) => {
-  const task = spawn('node', ['./bin/deploy.js', '-v']);
-
-  let output = '';
-  task.stdout.on('data', (data) => {
-    output += data.toString();
-  });
-
-  task.on('close', (code) => {
-    console.log(output);
-    expect(output).toContain(version);
-    expect(code).toBe(0);
-    done();
-  });
-});
-
-test('deploy errors if no path is provided', (done) => {
-  const task = spawn('node', ['./bin/deploy.js', '-p']);
-
-  let output = '';
-  task.stdout.on('data', (data) => {
-    output += data.toString();
-  });
-
-  task.stderr.on('data', (data) => {
-    console.error(`stderr: ${data}`);
-  });
-
-  task.on('close', (code) => {
-    console.log(output);
-    expect(code).toBe(1);
-    done();
-  });
-});

package/__tests__/pcf-helper-import.test.js

@@ -1,37 +0,0 @@
-const { spawn } = require('child_process');
-const version = require('../package.json').version;
-
-test('import displays version', (done) => {
-  const task = spawn('node', ['./bin/import.js', '-v']);
-
-  let output = '';
-  task.stdout.on('data', (data) => {
-    output += data.toString();
-  });
-
-  task.on('close', (code) => {
-    console.log(output);
-    expect(output).toContain(version);
-    expect(code).toBe(0);
-    done();
-  });
-});
-
-test('import errors if no path is provided', (done) => {
-  const task = spawn('node', ['./bin/import.js', '-p']);
-
-  let output = '';
-  task.stdout.on('data', (data) => {
-    output += data.toString();
-  });
-
-  task.stderr.on('data', (data) => {
-    console.error(`stderr: ${data}`);
-  });
-
-  task.on('close', (code) => {
-    console.log(output);
-    expect(code).toBe(1);
-    done();
-  });
-});

package/__tests__/pcf-helper-upgrade.test.js

@@ -1,37 +0,0 @@
-const { spawn } = require('child_process');
-const version = require('../package.json').version;
-
-test('upgrade displays version', (done) => {
-  const task = spawn('node', ['./bin/upgrade.js', '-v']);
-
-  let output = '';
-  task.stdout.on('data', (data) => {
-    output += data.toString();
-  });
-
-  task.on('close', (code) => {
-    console.log(output);
-    expect(output).toContain(version);
-    expect(code).toBe(0);
-    done();
-  });
-});
-
-test('upgrade errors if no path is provided', (done) => {
-  const task = spawn('node', ['./bin/upgrade.js', '-p']);
-
-  let output = '';
-  task.stdout.on('data', (data) => {
-    output += data.toString();
-  });
-
-  task.stderr.on('data', (data) => {
-    console.error(`stderr: ${data}`);
-  });
-
-  task.on('close', (code) => {
-    console.log(output);
-    expect(code).toBe(1);
-    done();
-  });
-});

package/bin/build.js

@@ -1,33 +0,0 @@
-#!/usr/bin/env node
-const task  = require('../tasks/build-pcf');
-const version = require('../package.json').version;
-const logger = require('@tywalk/color-logger').default;
-const [, , ...args] = process.argv;
-
-const commandArgument = args.at(0)?.toLowerCase();
-if (['-v', '--version'].includes(commandArgument)) {
-  console.log('v%s', version);
-  process.exit(0);
-}
-
-const verboseArgument = args.find(a => ['-v', '--verbose'].includes(a));
-if (typeof verboseArgument !== 'undefined') {
-  logger.setDebug(true);
-}
-
-logger.log('PCF Helper version', version);
-
-const pathArgument = args.find(a => ['-p', '--path'].includes(a));
-if (typeof pathArgument === 'undefined') {
-  logger.error('Path argument is required. Use --path to specify the path to solution folder.');
-  process.exit(1);
-}
-
-const pathIndex = args.indexOf(pathArgument) + 1;
-const path = args.at(pathIndex);
-if (typeof path === 'undefined') {
-  logger.error('Path argument is required. Use --path to specify the path to solution folder.');
-  process.exit(1);
-}
-
-task.run(path);

package/bin/deploy.js

@@ -1,69 +0,0 @@
-#!/usr/bin/env node
-const upgradeTask = require('../tasks/upgrade-pcf');
-const buildTask = require('../tasks/build-pcf');
-const importTask = require('../tasks/import-pcf');
-const { formatMsToSec } = require('../util/performanceUtil');
-const version = require('../package.json').version;
-const logger = require('@tywalk/color-logger').default;
-const [, , ...args] = process.argv;
-
-const commandArgument = args.at(0)?.toLowerCase();
-if (['-v', '--version'].includes(commandArgument)) {
-  console.log('v%s', version);
-  return;
-}
-
-const verboseArgument = args.find(a => ['-v', '--verbose'].includes(a));
-if (typeof verboseArgument !== 'undefined') {
-  logger.setDebug(true);
-}
-
-logger.log('PCF Helper version', version);
-
-const pathArgument = args.find(a => ['-p', '--path'].includes(a));
-if (typeof pathArgument === 'undefined') {
-  logger.error('Path argument is required. Use --path to specify the path to solution folder.');
-  process.exit(1);
-}
-
-const pathIndex = args.indexOf(pathArgument) + 1;
-const path = args.at(pathIndex);
-if (typeof path === 'undefined') {
-  logger.error('Path argument is required. Use --path to specify the path to solution folder.');
-  process.exit(1);
-}
-
-const tick = performance.now();
-
-const envArgument = args.find(a => ['-env', '--environment'].includes(a));
-let envIndex = args.indexOf(envArgument) + 1;
-let env = '';
-if (envIndex > 0) {
-  env = args.at(envIndex);
-}
-
-function executeTasks() {
-  const upgradeResult = upgradeTask.run(path);
-  if (upgradeResult === 1) return 1;
-  const buildResult = buildTask.run(path);
-  if (buildResult === 1) return 1;
-  const importResult = importTask.run(path, env);
-  if (importResult === 1) return 1;
-  return 0;
-}
-
-var result = 0;
-try {
-  result = executeTasks();
-  if (result === 0) {
-    logger.log('Deploy complete!');
-  }
-} catch (e) {
-  logger.error('One or more tasks failed while deploying: ', (e && e.message) || 'unkown error');
-  result = 1;
-} finally {
-  const tock = performance.now();
-  logger.log(formatMsToSec('Deploy finished in %is.', tock - tick));
-}
-
-return result;

package/bin/import.js

@@ -1,40 +0,0 @@
-#!/usr/bin/env node
-const task = require('../tasks/import-pcf');
-const version = require('../package.json').version;
-const logger = require('@tywalk/color-logger').default;
-const [, , ...args] = process.argv;
-
-const commandArgument = args.at(0)?.toLowerCase();
-if (['-v', '--version'].includes(commandArgument)) {
-  console.log('v%s', version);
-  return;
-}
-
-const verboseArgument = args.find(a => ['-v', '--verbose'].includes(a));
-if (typeof verboseArgument !== 'undefined') {
-  logger.setDebug(true);
-}
-
-logger.log('PCF Helper version', version);
-
-const pathArgument = args.find(a => ['-p', '--path'].includes(a));
-if (typeof pathArgument === 'undefined') {
-  logger.error('Path argument is required. Use --path to specify the path to solution folder.');
-  process.exit(1);
-}
-
-const pathIndex = args.indexOf(pathArgument) + 1;
-const path = args.at(pathIndex);
-if (typeof path === 'undefined') {
-  logger.error('Path argument is required. Use --path to specify the path to solution folder.');
-  process.exit(1);
-}
-
-const envArgument = args.find(a => ['-env', '--environment'].includes(a));
-let envIndex = args.indexOf(envArgument) + 1;
-let env = '';
-if (envIndex > 0) {
-  env = args.at(envIndex);
-}
-
-task.run(path, env);

package/bin/upgrade.js

@@ -1,33 +0,0 @@
-#!/usr/bin/env node
-const task = require('../tasks/upgrade-pcf');
-const version = require('../package.json').version;
-const logger = require('@tywalk/color-logger').default;
-const [, , ...args] = process.argv;
-
-const commandArgument = args.at(0)?.toLowerCase();
-if (['-v', '--version'].includes(commandArgument)) {
-  console.log('v%s', version);
-  return;
-}
-
-const verboseArgument = args.find(a => ['-v', '--verbose'].includes(a));
-if (typeof verboseArgument !== 'undefined') {
-  logger.setDebug(true);
-}
-
-logger.log('PCF Helper version', version);
-
-const pathArgument = args.find(a => ['-p', '--path'].includes(a));
-if (typeof pathArgument === 'undefined') {
-  logger.error('Path argument is required. Use --path to specify the path to solution folder.');
-  process.exit(1);
-}
-
-const pathIndex = args.indexOf(pathArgument) + 1;
-const path = args.at(pathIndex);
-if (typeof path === 'undefined') {
-  logger.error('Path argument is required. Use --path to specify the path to solution folder.');
-  process.exit(1);
-}
-
-task.run(path);

package/tasks/build-pcf.js

@@ -1,42 +0,0 @@
-const { spawnSync } = require('child_process');
-const { formatMsToSec, formatTime } = require('../util/performanceUtil');
-const logger = require('@tywalk/color-logger').default;
-
-/**
- * Builds the Power Apps component framework project.
- *
- * @param {string} path The path to the project folder containing the pcfproj.json file.
- *
- * @returns {number} The exit code of the spawned process.
- */
-function run(path) {
-  logger.log('[PCF Helper] ' + formatTime(new Date()) + ' Starting build...\n');
-  const tick = performance.now();
-  const task = spawnSync('dotnet build', ['--restore', '-c', 'Release', path], {
-    cwd: process.cwd(),
-    stdio: 'inherit',
-    shell: true,
-    timeout: 1000 * 60 * 5 // 5 minutes
-  });
-  const tock = performance.now();
-
-  if (task.status === 0) {
-    logger.success('[PCF Helper] Build complete!');
-    logger.debug(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Build finished in %is.\n', tock - tick));
-  } else {
-    if (task.error) {
-      if (task.signal === 'SIGTERM') {
-        logger.error('[PCF Helper] Unable to complete build. A timeout of 5 minutes was reached.', task.error.message);
-      } else {
-        logger.error('[PCF Helper] Unable to complete build: ', task.signal, task.error.message);
-      }
-      logger.debug('[PCF Helper] Error details: ', task.signal, task.error.stack);
-    } else {
-      logger.error('[PCF Helper] Unable to complete build: One or more errors ocurred.');
-    }
-    logger.debug(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Build finished with errors in %is.\n', tock - tick));
-  }
-  return task.status;
-}
-
-exports.run = run;

package/tasks/import-pcf.js

@@ -1,59 +0,0 @@
-const { spawnSync } = require('child_process');
-const { join, extname } = require('path');
-const fs = require('fs');
-const logger = require('@tywalk/color-logger').default;
-const { formatMsToSec, formatTime } = require('../util/performanceUtil');
-
-/**
- * Imports a PCF solution into a specified Dataverse environment.
- *
- * @param {string} path - The path to the solution folder containing the build output.
- * @param {string} env - The environment identifier (GUID or URL) where the solution will be imported.
- * @param {boolean} verbose - If true, additional debug information is logged.
- *
- * @returns {number} The exit status of the import process.
- */
-
-function run(path, env, verbose) {
-  logger.log('[PCF Helper] ' + formatTime(new Date()) + ' Starting import...\n');
-  const tick = performance.now();
-  if (!env) {
-    logger.warn('Path argument not provided. Assuming active auth profile organization.');
-  }
-
-  const zipDirPath = join(path, '/bin/release');
-  // const zipDirPath = join(path, '');
-  const zipDirFiles = fs.readdirSync(zipDirPath);
-  const zipFile = zipDirFiles.find(file => extname(file).toLowerCase() === '.zip');
-  const zipFilePath = join(zipDirPath, zipFile);
-
-  const task = spawnSync('pac solution import', ['-env', env, '-p', zipFilePath, '-pc'], {
-    cwd: process.cwd(),
-    stdio: 'inherit',
-    shell: true,
-    timeout: 1000 * 60 * 5, // 5 minutes
-  });
-  const tock = performance.now();
-
-  if (task.status === 0) {
-    logger.success('[PCF Helper] Import complete!');
-    logger.debug(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Import finished in %is.\n', tock - tick));
-  } else {
-    if (task.error) {
-      if (task.signal === 'SIGTERM') {
-        logger.error('[PCF Helper] Unable to complete import. A timeout of 5 minutes was reached.', task.error.message);
-      } else {
-        logger.error('[PCF Helper] Unable to complete import:', task.signal, task.error.message);
-      }
-      if (verbose) {
-        logger.debug('[PCF Helper] Error details:', task.signal, task.error.stack);
-      }
-    } else {
-      logger.error('[PCF Helper] Unable to complete import: One or more errors ocurred.');
-    }
-    logger.debug(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Import finished with errors in %is.\n', tock - tick));
-  }
-  return task.status;
-}
-
-exports.run = run;

package/tasks/upgrade-pcf.js

@@ -1,42 +0,0 @@
-const { spawnSync } = require('child_process');
-const { formatMsToSec, formatTime } = require('../util/performanceUtil');
-const logger = require('@tywalk/color-logger').default;
-
-/**
- * Upgrades the Power Apps component framework project.
- *
- * @param {string} path The path to the project folder containing the pcfproj.json file.
- *
- * @returns {number} The exit code of the spawned process.
- */
-function run(path) {
-  logger.log('[PCF Helper] ' + formatTime(new Date()) + ' Starting upgrade...\n');
-  const tick = performance.now();
-  const task = spawnSync(`pac solution version -s Solution -sp ${path} && pac pcf version -s Manifest && npm version patch --no-git-tag-version`, {
-    cwd: process.cwd(),
-    stdio: 'inherit',
-    shell: true,
-    timeout: 1000 * 60 // 1 min
-  });
-  const tock = performance.now();
-
-  if (task.status === 0) {
-    logger.success('[PCF Helper] Upgrade complete!');
-    logger.debug(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Upgrade finished in %is.\n', tock - tick));
-  } else {
-    if (task.error) {
-      if (task.signal === 'SIGTERM') {
-        logger.error('[PCF Helper] Unable to complete upgrade. A timeout of 1 minutes was reached.', task.error.message);
-      } else {
-        logger.error('[PCF Helper] Unable to complete upgrade:', task.signal, task.error.message);
-      }
-      logger.debug('[PCF Helper] Error details:', task.signal, task.error.stack);
-    } else {
-      logger.error('[PCF Helper] Unable to complete upgrade: One or more errors ocurred.');
-    }
-    logger.debug(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Upgrade finished with errors in %is.\n', tock - tick));
-  }
-  return task.status;
-}
-
-exports.run = run;

package/util/performanceUtil.js

@@ -1,37 +0,0 @@
-const util = require('node:util');
-
-var formatter = new Intl.DateTimeFormat('en-US', {
-  hour: '2-digit',
-  minute: '2-digit',
-  second: '2-digit',
-  hour12: false
-});
-
-/**
- * Formats a number of milliseconds into seconds.
- *
- * @param {string} format - The string format to use when formatting the number of seconds.
- * @param {number} ms - The number of milliseconds to be formatted.
- *
- * @returns {string} The formatted number of seconds.
- */
-function formatMsToSec(format, ms) {
-  const seconds = ms / 1000;
-  return util.format(format, seconds);
-}
-
-/**
- * Formats a Date object into a human-readable string.
- *
- * @param {Date} date - The date object to be formatted.
- *
- * @returns {string} The formatted string.
- */
-function formatTime(date) {
-  return formatter.format(date);
-}
-
-module.exports = {
-  formatMsToSec,
-  formatTime
-}