@tywalk/pcf-helper 1.4.13 → 1.4.14

package/{bin/build.js → src/bin/build.ts}

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
-const task  = require('../tasks/build-pcf');
+import * as task from '../tasks/build-pcf';
 const version = require('../package.json').version;
-const logger = require('@tywalk/color-logger').default;
+import logger from '@tywalk/color-logger';
 const [, , ...args] = process.argv;
 
-const commandArgument = args.at(0)?.toLowerCase();
+const commandArgument = args.at(0)?.toLowerCase() ?? '';
 if (['-v', '--version'].includes(commandArgument)) {
   console.log('v%s', version);
   process.exit(0);
@@ -30,4 +30,4 @@ if (typeof path === 'undefined') {
   process.exit(1);
 }
 
-task.run(path);
+task.run(path, verboseArgument !== undefined);

package/{bin/deploy.js → src/bin/deploy.ts}

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

package/{bin/import.js → src/bin/import.ts}

@@ -1,13 +1,13 @@
 #!/usr/bin/env node
-const task = require('../tasks/import-pcf');
+import * as task from '../tasks/import-pcf';
 const version = require('../package.json').version;
-const logger = require('@tywalk/color-logger').default;
+import logger from '@tywalk/color-logger';
 const [, , ...args] = process.argv;
 
-const commandArgument = args.at(0)?.toLowerCase();
+const commandArgument = args.at(0)?.toLowerCase() ?? '';
 if (['-v', '--version'].includes(commandArgument)) {
   console.log('v%s', version);
-  return;
+  process.exit(0);
 }
 
 const verboseArgument = args.find(a => ['-v', '--verbose'].includes(a));
@@ -30,11 +30,11 @@ if (typeof path === 'undefined') {
   process.exit(1);
 }
 
-const envArgument = args.find(a => ['-env', '--environment'].includes(a));
+const envArgument = args.find(a => ['-env', '--environment'].includes(a)) ?? '';
 let envIndex = args.indexOf(envArgument) + 1;
 let env = '';
 if (envIndex > 0) {
-  env = args.at(envIndex);
+  env = args.at(envIndex) ?? '';
 }
 
 task.run(path, env);

package/src/bin/init.ts

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+import * as task from '../tasks/init-pcf';
+const version = require('../package.json').version;
+import logger from '@tywalk/color-logger';
+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 nameArgument = args.find(a => ['-n', '--name'].includes(a));
+if (typeof nameArgument === 'undefined') {
+  logger.error('Name argument is required. Use --name to specify the name of the control.');
+  process.exit(1);
+}
+
+const nameIndex = args.indexOf(nameArgument) + 1;
+const name = args.at(nameIndex);
+if (typeof name === 'undefined') {
+  logger.error('Path argument is required. Use --path to specify the path to solution folder.');
+  process.exit(1);
+}
+
+let publisherName = '';
+const publisherNameArgument = args.find(a => ['-pn', '--publisher-name'].includes(a));
+if (typeof publisherNameArgument !== 'undefined') {
+  const publisherNameIndex = args.indexOf(publisherNameArgument) + 1;
+  publisherName = args.at(publisherNameIndex) ?? '';
+}
+
+let publisherPrefix = '';
+const publisherPrefixArgument = args.find(a => ['-pp', '--publisher-prefix'].includes(a));
+if (typeof publisherPrefixArgument !== 'undefined') {
+  const publisherPrefixIndex = args.indexOf(publisherPrefixArgument) + 1;
+  publisherPrefix = args.at(publisherPrefixIndex) ?? '';
+}
+
+let path = '';
+const pathArgument = args.find(a => ['-p', '--path'].includes(a));
+if (typeof pathArgument !== 'undefined') {
+  const pathIndex = args.indexOf(pathArgument) + 1;
+  path = args.at(pathIndex) ?? '';
+}
+
+task.run(path, name, publisherName, publisherPrefix, verboseArgument !== undefined);

package/{bin/upgrade.js → src/bin/upgrade.ts}

@@ -1,13 +1,13 @@
 #!/usr/bin/env node
-const task = require('../tasks/upgrade-pcf');
+import * as task from '../tasks/upgrade-pcf';
 const version = require('../package.json').version;
-const logger = require('@tywalk/color-logger').default;
+import logger from '@tywalk/color-logger';
 const [, , ...args] = process.argv;
 
-const commandArgument = args.at(0)?.toLowerCase();
+const commandArgument = args.at(0)?.toLowerCase() ?? '';
 if (['-v', '--version'].includes(commandArgument)) {
   console.log('v%s', version);
-  return;
+  process.exit(0);
 }
 
 const verboseArgument = args.find(a => ['-v', '--verbose'].includes(a));
@@ -30,4 +30,4 @@ if (typeof path === 'undefined') {
   process.exit(1);
 }
 
-task.run(path);
+task.run(path, verboseArgument !== undefined);

package/src/tasks/build-pcf.ts

@@ -0,0 +1,26 @@
+import { spawnSync } from 'child_process';
+import { formatTime, handleTaskCompletion } from '../util/performanceUtil';
+import logger from '@tywalk/color-logger';
+
+/**
+ * Builds the Power Apps component framework project.
+ *
+ * @param {string} path The path to the project folder containing the pcfproj.json file.
+ * @param {boolean} verbose - If true, additional debug information is logged.
+ *
+ * @returns {number} The exit code of the spawned process.
+ */
+function run(path: string, verbose: boolean): number {
+  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
+  });
+  
+  return handleTaskCompletion(task, 'build', performance.now() - tick, verbose);
+}
+
+export { run };

package/src/tasks/import-pcf.ts

@@ -0,0 +1,40 @@
+import { spawnSync } from 'child_process';
+import { join, extname } from 'path';
+import fs from 'fs';
+import logger from '@tywalk/color-logger';
+import { formatTime, handleTaskCompletion } from '../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: string, env: string, verbose?: boolean): number {
+  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
+  });
+
+  return handleTaskCompletion(task, 'import', performance.now() - tick, verbose);
+}
+
+export { run };

package/src/tasks/init-pcf.ts

@@ -0,0 +1,54 @@
+import { spawnSync } from 'child_process';
+import { join, extname } from 'path';
+import fs from 'fs';
+import logger from '@tywalk/color-logger';
+import { formatTime, handleTaskCompletion } from '../util/performanceUtil';
+
+function pcfExistsInParent(path: string) {
+  let levels = 0;
+  while (levels < 3) {
+    let pathFiles = fs.readdirSync(path);
+    let atRoot = pathFiles.some(file => extname(file).toLowerCase() === '.pcfproj');
+    if (atRoot) {
+      return path;
+    }
+    path = join(path, '..');
+    levels++;
+  }
+  throw new Error('PCF project not found.');
+}
+
+function run(path: string, name: string, publisherName: string, publisherPrefix: string, verbose: boolean): number {
+  logger.log('[PCF Helper] ' + formatTime(new Date()) + ' Starting init...\n');
+  const tick = performance.now();
+
+  path = path ?? process.cwd();
+  let pathFiles = fs.readdirSync(path);
+  let atRoot = pathFiles.some(file => extname(file).toLowerCase() === '.pcfproj');
+  const cdsPath = atRoot ? join(path, 'Solutions', name) : join(path, name);
+
+  const initTask = spawnSync('pac solution init', ['-pn', publisherName, '-pp', publisherPrefix, '-o', cdsPath], {
+    cwd: process.cwd(),
+    stdio: 'inherit',
+    shell: true,
+    timeout: 1000 * 60 * 5, // 5 minutes
+  });
+
+  if (initTask.status !== 0) {
+    return handleTaskCompletion(initTask, 'init', performance.now() - tick, verbose);
+  }
+
+  if (!atRoot) {
+    path = pcfExistsInParent(path);
+  }
+
+  const packageTask = spawnSync('pac solution add-reference', ['-p', path], {
+    cwd: process.cwd(),
+    stdio: 'inherit',
+    shell: true,
+    timeout: 1000 * 60 * 5, // 5 minutes
+  });
+  return handleTaskCompletion(packageTask, 'init', performance.now() - tick, verbose);
+}
+
+export { run };

package/src/tasks/upgrade-pcf.ts

@@ -0,0 +1,26 @@
+import { spawnSync } from 'child_process';
+import { formatTime, handleTaskCompletion } from '../util/performanceUtil';
+import logger from '@tywalk/color-logger';
+
+/**
+ * Upgrades the Power Apps component framework project.
+ *
+ * @param {string} path The path to the project folder containing the pcfproj.json file.
+ * @param {boolean} verbose - If true, additional debug information is logged.
+ *
+ * @returns {number} The exit code of the spawned process.
+ */
+function run(path: string, verbose?: boolean): number {
+  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
+  });
+
+  return handleTaskCompletion(task, 'upgrade', performance.now() - tick, verbose);
+}
+
+export { run }

package/src/util/performanceUtil.ts

@@ -0,0 +1,62 @@
+import { SpawnSyncReturns } from 'child_process';
+import util from 'util';
+import logger from '@tywalk/color-logger';
+
+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: string, ms: number): string {
+  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: Date): string {
+  return formatter.format(date);
+}
+
+function handleTaskCompletion(task: SpawnSyncReturns<Buffer<ArrayBufferLike>>, name: string, duration: number, verbose?: boolean) {
+  if (task.status === 0) {
+    logger.success(`[PCF Helper] ${name} complete!`);
+    logger.debug(formatMsToSec(`[PCF Helper] ${formatTime(new Date())} ${name} finished in %is.\n`, duration));
+  } else {
+    if (task.error) {
+      if (task.signal === 'SIGTERM') {
+        logger.error(`[PCF Helper] Unable to complete ${name}. A timeout of 5 minutes was reached.`, task.error.message);
+      } else {
+        logger.error(`[PCF Helper] Unable to complete ${name}:`, 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 ${name}: One or more errors ocurred.`);
+    }
+    logger.debug(formatMsToSec(`[PCF Helper] ${formatTime(new Date())} ${name} finished with errors in %is.\n`, duration));
+  }
+  return task.status ?? 1;
+}
+
+export {
+  formatMsToSec,
+  formatTime,
+  handleTaskCompletion
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",                               /* Specify an output folder for all emitted files. */
+    "declarationDir": "./types",                      /* Specify the output directory for generated declaration files. */
+  },
+  "include": ["src/bin/**/*.ts"],
+}

package/types/bin/build.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/types/bin/deploy.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/types/bin/import.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/types/bin/init.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/types/bin/upgrade.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/types/tasks/build-pcf.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Builds the Power Apps component framework project.
+ *
+ * @param {string} path The path to the project folder containing the pcfproj.json file.
+ * @param {boolean} verbose - If true, additional debug information is logged.
+ *
+ * @returns {number} The exit code of the spawned process.
+ */
+declare function run(path: string, verbose: boolean): number;
+export { run };

package/types/tasks/import-pcf.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ */
+declare function run(path: string, env: string, verbose?: boolean): number;
+export { run };

package/types/tasks/init-pcf.d.ts

@@ -0,0 +1,2 @@
+declare function run(path: string, name: string, publisherName: string, publisherPrefix: string, verbose: boolean): number;
+export { run };

package/types/tasks/upgrade-pcf.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Upgrades the Power Apps component framework project.
+ *
+ * @param {string} path The path to the project folder containing the pcfproj.json file.
+ * @param {boolean} verbose - If true, additional debug information is logged.
+ *
+ * @returns {number} The exit code of the spawned process.
+ */
+declare function run(path: string, verbose?: boolean): number;
+export { run };

package/{util/performanceUtil.js → types/util/performanceUtil.d.ts}

@@ -1,12 +1,4 @@
-const util = require('node:util');
-
-var formatter = new Intl.DateTimeFormat('en-US', {
-  hour: '2-digit',
-  minute: '2-digit',
-  second: '2-digit',
-  hour12: false
-});
-
+import { SpawnSyncReturns } from 'child_process';
 /**
  * Formats a number of milliseconds into seconds.
  *
@@ -15,11 +7,7 @@ var formatter = new Intl.DateTimeFormat('en-US', {
  *
  * @returns {string} The formatted number of seconds.
  */
-function formatMsToSec(format, ms) {
-  const seconds = ms / 1000;
-  return util.format(format, seconds);
-}
-
+declare function formatMsToSec(format: string, ms: number): string;
 /**
  * Formats a Date object into a human-readable string.
  *
@@ -27,11 +15,6 @@ function formatMsToSec(format, ms) {
  *
  * @returns {string} The formatted string.
  */
-function formatTime(date) {
-  return formatter.format(date);
-}
-
-module.exports = {
-  formatMsToSec,
-  formatTime
-}
+declare function formatTime(date: Date): string;
+declare function handleTaskCompletion(task: SpawnSyncReturns<Buffer<ArrayBufferLike>>, name: string, duration: number, verbose?: boolean): number;
+export { formatMsToSec, formatTime, handleTaskCompletion };

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;