create-powerapps-project 0.19.1 → 0.21.1

package/lib/packageManager.js

@@ -1,55 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.install = exports.getYarn = void 0;
+exports.install = void 0;
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const child_process_1 = require("child_process");
-const getEnvInfo_1 = require("./getEnvInfo");
-const getYarn = () => {
-    const yarnInfo = (0, getEnvInfo_1.getEnvInfo)().Binaries.Yarn;
-    return yarnInfo && yarnInfo.path;
-};
-exports.getYarn = getYarn;
-const getNpm = () => {
-    const npmInfo = (0, getEnvInfo_1.getEnvInfo)().Binaries.npm;
-    return npmInfo && npmInfo.path;
-};
-const install = (cwd, type) => {
-    const packages = getPackages(type);
-    if (process.env.JEST_WORKER_ID !== undefined) {
+const install = (cwd, type, packageManager) => {
+    if (process.env.JEST_WORKER_ID != undefined) {
         return;
     }
-    if ((0, exports.getYarn)()) {
-        (0, child_process_1.spawnSync)((0, exports.getYarn)(), ['add', ...packages.devDependencies], { stdio: 'inherit', cwd });
-        if (packages.dependencies) {
-            (0, child_process_1.spawnSync)((0, exports.getYarn)(), ['add', ...packages.dependencies], { stdio: 'inherit', cwd });
-        }
+    if (type === 'pcf') {
+        (0, child_process_1.spawnSync)(packageManager, ['install'], { stdio: 'inherit', shell: true });
     }
     else {
-        (0, child_process_1.spawnSync)(getNpm(), ['install', ...packages.devDependencies], { stdio: 'inherit', cwd });
+        const packages = getPackages(type);
+        (0, child_process_1.spawnSync)(packageManager, ['add', ...packages.devDependencies], { stdio: 'inherit', shell: true });
         if (packages.dependencies) {
-            (0, child_process_1.spawnSync)(getNpm(), ['install', ...packages.dependencies], { stdio: 'inherit', cwd });
+            (0, child_process_1.spawnSync)(packageManager, ['add', ...packages.dependencies], { stdio: 'inherit', shell: true });
         }
     }
 };
 exports.install = install;
 function getPackages(type) {
-    if (type === 'pcf') {
-        return {
-            dependencies: [
-                'react@17.0.2',
-                'react-dom@17.0.2',
-                '@fluentui/react',
-                '@fluentui/font-icons-mdl2'
-            ],
-            devDependencies: [
-                //`powerapps-project-${type}`,
-                '@types/react@17.0.39',
-                '@types/react-dom@17.0.11',
-                '@types/xrm',
-                '-D'
-            ]
-        };
-    }
     const packages = {
         devDependencies: [
             `powerapps-project-${type}`,

package/lib/plopfile.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -27,76 +31,24 @@ const child_process_1 = require("child_process");
 const fs_1 = __importDefault(require("fs"));
 const nuget = __importStar(require("./nuget"));
 const pkg = __importStar(require("./packageManager"));
-const getEnvInfo_1 = require("./getEnvInfo");
 const didSucceed = (code) => `${code}` === '0';
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const version = require('../package').version;
 /* eslint-disable @typescript-eslint/no-explicit-any */
 exports.default = (plop) => {
-    void (0, getEnvInfo_1.initialize)();
-    plop.setActionType('signAssembly', (answers) => {
-        const keyPath = path_1.default.resolve(process.cwd(), `${answers.name}.snk`);
-        return new Promise((resolve, reject) => {
-            if (process.env.JEST_WORKER_ID !== undefined) {
-                resolve('Testing so no need to sign');
-            }
-            const sign = (0, child_process_1.spawn)(path_1.default.resolve(__dirname, '../', 'bin', 'sn.exe'), ['-q', '-k', keyPath], { stdio: 'inherit' });
-            sign.on('close', (code) => {
-                if (didSucceed(code)) {
-                    resolve('signed assembly');
-                }
-                else {
-                    reject('failed to sign assembly');
-                }
-            });
-            sign.on('error', () => {
-                reject('failed to sign assembly');
-            });
-        });
-    });
-    plop.setActionType('runPcf', (answers) => {
-        const args = ['pcf', 'init', '-ns', answers.namespace, '-n', answers.name, '-t', answers.template];
-        /// Setting framework to React currently unsupported by PCF CLI
-        // if (answers.react) {
-        //   args.push('-fw', 'react');
-        // }
-        if (process.env.JEST_WORKER_ID !== undefined) {
-            args.push('-npm', 'false');
-        }
-        return new Promise((resolve, reject) => {
-            const pac = (0, child_process_1.spawn)('pac', args, { stdio: 'inherit' });
-            pac.on('close', (code) => {
-                if (didSucceed(code)) {
-                    resolve('pcf project created');
-                }
-                else {
-                    reject('Ensure the Power Platform CLI is installed. Command must be run from within VS Code if using the Power Platform Extension');
-                }
-            });
-            pac.on('error', () => {
-                reject('Ensure the Power Platform CLI is installed. Command must be run from within VS Code if using the Power Platform Extension');
-            });
-        });
-    });
-    plop.setActionType('addGenScript', async () => {
-        const packagePath = path_1.default.resolve(process.cwd(), 'package.json');
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        const packageJson = require(packagePath);
-        packageJson.scripts.gen = 'plop';
-        await fs_1.default.promises.writeFile(packagePath, JSON.stringify(packageJson, null, 4), 'utf8');
-        return 'added plop script to package.json';
-    });
-    plop.setActionType('nugetInstall', async (answers) => {
-        const xrmVersions = await nuget.getNugetPackageVersions('JourneyTeam.Xrm');
-        const xrmVersion = xrmVersions.shift();
-        nuget.install(answers.name, answers.sdkVersion, xrmVersion);
-        return 'installed nuget packages';
-    });
-    plop.setActionType('npmInstall', (_answers, config) => {
-        if (config?.projectType) {
-            pkg.install(process.cwd(), config.projectType);
-        }
-        return 'installed npm packages';
-    });
-    const connectionQuestions = [
+    plop.setWelcomeMessage(`Creating new Dataverse project using create-powerapps-project v${version}. Please choose type of project to create.`);
+    const packageQuestion = {
+        type: 'list',
+        name: 'package',
+        message: 'package manager (ensure selected option is installed)',
+        choices: [
+            { name: 'npm', value: 'npm' },
+            { name: 'pnpm', value: 'pnpm' },
+            { name: 'yarn', value: 'yarn' }
+        ],
+        default: 'npm'
+    };
+    const sharedQuestions = [
         {
             type: 'input',
             name: 'server',
@@ -114,6 +66,18 @@ exports.default = (plop) => {
             message: 'dataverse solution unique name:'
         }
     ];
+    plop.setActionType('addScript', async (answers) => {
+        const packagePath = path_1.default.resolve(process.cwd(), 'package.json');
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const packageJson = require(packagePath);
+        packageJson.scripts[answers.scriptKey] = answers.scriptValue;
+        await fs_1.default.promises.writeFile(packagePath, JSON.stringify(packageJson, null, 4), 'utf8');
+        return `added ${answers.scriptKey} script to package.json`;
+    });
+    plop.setActionType('npmInstall', (answers) => {
+        pkg.install(process.cwd(), answers.projectType, answers.package);
+        return 'installed npm packages';
+    });
     plop.setGenerator('assembly', {
         description: 'generate dataverse assembly project',
         prompts: [
@@ -129,7 +93,20 @@ exports.default = (plop) => {
             {
                 type: 'input',
                 name: 'name',
-                message: 'default C# namespace (Company.Crm.Plugins):'
+                message: 'default C# namespace (Company.Crm.Plugins):',
+                validate: (name) => {
+                    const namespace = name.split('.');
+                    if (namespace.length !== 3) {
+                        return `enter namespace using 'Company.Crm.Plugins' convention`;
+                    }
+                    for (const item of namespace) {
+                        const title = plop.renderString('{{titleCase name}}', { name: item });
+                        if (title !== item) {
+                            return `enter namespace using pascal case (Company.Crm.Plugins)`;
+                        }
+                    }
+                    return true;
+                }
             },
             {
                 type: 'list',
@@ -147,7 +124,8 @@ exports.default = (plop) => {
                     }
                 ]
             },
-            ...connectionQuestions,
+            packageQuestion,
+            ...sharedQuestions,
         ],
         actions: [
             {
@@ -170,15 +148,39 @@ exports.default = (plop) => {
                 destination: process.cwd(),
                 force: true
             },
-            {
-                type: 'signAssembly'
+            (answers) => {
+                const keyPath = path_1.default.resolve(process.cwd(), `${answers.name}.snk`);
+                return new Promise((resolve, reject) => {
+                    if (process.env.JEST_WORKER_ID !== undefined) {
+                        resolve('Testing so no need to sign');
+                    }
+                    else {
+                        const sign = (0, child_process_1.spawn)(path_1.default.resolve(__dirname, '..', 'bin', 'sn.exe'), ['-q', '-k', keyPath], { stdio: 'inherit' });
+                        sign.on('close', (code) => {
+                            if (didSucceed(code)) {
+                                resolve('signed assembly');
+                            }
+                            else {
+                                reject('failed to sign assembly');
+                            }
+                        });
+                        sign.on('error', () => {
+                            reject('failed to sign assembly');
+                        });
+                    }
+                });
             },
-            {
-                type: 'nugetInstall'
+            async (answers) => {
+                const xrmVersions = await nuget.getNugetPackageVersions('JourneyTeam.Xrm');
+                const xrmVersion = xrmVersions.shift();
+                nuget.install(answers.name, answers.sdkVersion, xrmVersion);
+                return 'installed nuget packages';
             },
             {
                 type: 'npmInstall',
-                projectType: 'assembly'
+                data: {
+                    projectType: 'assembly'
+                }
             }
         ]
     });
@@ -208,52 +210,95 @@ exports.default = (plop) => {
                 type: 'confirm',
                 name: 'react',
                 message: 'use react?'
-            }
+            },
+            packageQuestion
         ],
         actions: [
+            (answers) => {
+                const args = ['pcf', 'init', '-ns', answers.namespace, '-n', answers.name, '-t', answers.template];
+                // Set framework to React if selected
+                if (answers.react) {
+                    args.push('-fw', 'react');
+                }
+                if (process.env.JEST_WORKER_ID !== undefined || answers.package !== 'npm') {
+                    args.push('-npm', 'false');
+                }
+                else {
+                    args.push('-npm', 'true');
+                }
+                return new Promise((resolve, reject) => {
+                    const pac = (0, child_process_1.spawn)('pac', args, { stdio: 'inherit' });
+                    pac.on('close', (code) => {
+                        if (didSucceed(code)) {
+                            resolve('pcf project created');
+                        }
+                        else {
+                            reject('Ensure the Power Platform CLI is installed. Command must be run from within Visual Studio Code if using the Power Platform Extension');
+                        }
+                    });
+                    pac.on('error', () => {
+                        reject('Ensure the Power Platform CLI is installed. Command must be run from within Visual Studio Code if using the Power Platform Extension');
+                    });
+                });
+            },
             {
-                type: 'runPcf'
+                type: 'add',
+                templateFile: '../plop-templates/pcf/tsconfig.json',
+                path: path_1.default.resolve(process.cwd(), 'tsconfig.json'),
+                force: true
             },
             {
                 type: 'addMany',
                 templateFiles: [
-                    '../plop-templates/pcf/App.tsx',
-                    '../plop-templates/pcf/index.ts.hbs'
+                    '../plop-templates/pcf/App.tsx.hbs',
+                    '../plop-templates/pcf/AppContext.ts'
                 ],
                 base: '../plop-templates/pcf',
                 destination: `${process.cwd()}/{{ name }}`,
-                force: true,
                 skip: (answers) => {
                     if (!answers.react) {
                         return 'react not included';
                     }
+                    return;
                 }
             },
             {
-                type: 'add',
-                templateFile: '../plop-templates/pcf/tsconfig.json',
-                path: path_1.default.resolve(process.cwd(), 'tsconfig.json'),
-                force: true,
-                skip: (answers) => {
-                    if (!answers.react) {
-                        return 'react not included';
-                    }
-                }
+                type: 'modify',
+                path: `${process.cwd()}/{{ name }}/index.ts`,
+                pattern: 'import { HelloWorld, IHelloWorldProps } from "./HelloWorld";',
+                template: `import { App, IAppProps } from './App';`
             },
             {
-                type: 'addGenScript',
-                skip: (answers) => {
-                    if (!answers.react) {
-                        return 'react not included';
-                    }
+                type: 'modify',
+                path: `${process.cwd()}/{{ name }}/index.ts`,
+                pattern: 'HelloWorld, props',
+                template: 'App, props'
+            },
+            {
+                type: 'modify',
+                path: `${process.cwd()}/{{ name }}/index.ts`,
+                pattern: `const props: IHelloWorldProps = { name: 'Hello, World!' };`,
+                template: `const props: IAppProps = { context: context };`
+            },
+            {
+                type: 'addScript',
+                data: {
+                    scriptKey: 'build:prod',
+                    scriptValue: 'pcf-scripts build --buildMode production'
                 }
             },
+            async (answers) => {
+                await fs_1.default.promises.rm(path_1.default.resolve(process.cwd(), answers.name, 'HelloWorld.tsx'));
+                return 'removed HelloWorld component';
+            },
             {
                 type: 'npmInstall',
-                projectType: 'pcf',
+                data: {
+                    projectType: 'pcf'
+                },
                 skip: (answers) => {
-                    if (!answers.react) {
-                        return 'react not included';
+                    if (answers.package === 'npm') {
+                        return 'npm packages already installed';
                     }
                 }
             }
@@ -273,7 +318,8 @@ exports.default = (plop) => {
                 name: 'namespace',
                 message: 'namespace for form and ribbon scripts:'
             },
-            ...connectionQuestions
+            packageQuestion,
+            ...sharedQuestions
         ],
         actions: [
             {
@@ -282,6 +328,12 @@ exports.default = (plop) => {
                 base: '../plop-templates/webresource',
                 destination: process.cwd(),
                 force: true
+            },
+            {
+                type: 'npmInstall',
+                data: {
+                    projectType: 'webresource'
+                }
             }
         ]
     });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-powerapps-project",
   "description": "💧 plop generator for Dataverse development",
-  "version": "0.19.1",
+  "version": "0.21.1",
   "license": "MIT",
   "type": "commonjs",
   "main": "lib/index.js",
@@ -23,11 +23,10 @@
     "clean": "rimraf lib"
   },
   "dependencies": {
-    "envinfo": "^7.8.1",
     "plop": "^2.7.6"
   },
   "devDependencies": {
-    "@types/envinfo": "^7.8.1",
-    "@types/node": "^14.14.21"
+    "@types/node": "^14.14.21",
+    "node-plop": "^0.26.3"
   }
 }

package/plop-templates/pcf/App.tsx.hbs

@@ -0,0 +1,20 @@
+import React from 'react';
+import { IInputs } from './generated/ManifestTypes';
+import AppContext from './AppContext';
+
+export interface IAppProps {
+  context: ComponentFramework.Context<IInputs>;
+}
+
+export const App = React.memo((props: IAppProps) => {
+  const {
+    context,
+  } = props;
+
+  return (
+    <AppContext.Provider value=\{{ context: context }}>
+    </AppContext.Provider>
+  );
+});
+
+App.displayName = 'App';

package/plop-templates/pcf/AppContext.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { IInputs } from './generated/ManifestTypes';
+
+interface IAppContext {
+  context: ComponentFramework.Context<IInputs>;
+}
+
+const AppContext = React.createContext<IAppContext>({} as IAppContext);
+
+export default AppContext;

package/plop-templates/pcf/tsconfig.json

@@ -1,7 +1,8 @@
 {
     "extends": "./node_modules/pcf-scripts/tsconfig_base.json",
     "compilerOptions": {
-        "target": "ES6",
-        "esModuleInterop": true
+        "typeRoots": ["node_modules/@types"],
+        "esModuleInterop": true,
+        "target": "ES6"
     }
 }

package/lib/getEnvInfo.js

@@ -1,33 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initialize = exports.getEnvInfo = void 0;
-/* eslint-disable @typescript-eslint/no-explicit-any */
-const envinfo_1 = __importDefault(require("envinfo"));
-const os_1 = __importDefault(require("os"));
-const path_1 = __importDefault(require("path"));
-let envInfoCache;
-const getEnvInfo = () => {
-    return envInfoCache;
-};
-exports.getEnvInfo = getEnvInfo;
-const initialize = async () => {
-    envInfoCache = JSON.parse(await envinfo_1.default.run({
-        Binaries: ['Yarn', 'npm']
-    }, { json: true, showNotFound: false }));
-    if (envInfoCache.Binaries.Yarn) {
-        envInfoCache.Binaries.Yarn.path = expandHome(envInfoCache.Binaries.Yarn.path);
-    }
-    if (envInfoCache.Binaries.npm) {
-        envInfoCache.Binaries.npm.path = expandHome(envInfoCache.Binaries.npm.path);
-    }
-};
-exports.initialize = initialize;
-const expandHome = (pathString) => {
-    if (pathString.startsWith('~' + path_1.default.sep)) {
-        return pathString.replace('~', os_1.default.homedir());
-    }
-    return pathString;
-};

package/plop-templates/pcf/App.tsx

@@ -1,20 +0,0 @@
-import React from 'react';
-import { ThemeProvider } from '@fluentui/react/lib/utilities/ThemeProvider/ThemeProvider';
-
-export interface AppProps {
-  isTestHarness: boolean;
-}
-
-export const App = React.memo((props: AppProps) => {
-  const {
-    isTestHarness
-  } = props;
-  
-  return (
-    <ThemeProvider dir='ltr'>
-    </ThemeProvider>
-  );
-});
-
-App.displayName = 'App';
-

package/plop-templates/pcf/index.ts.hbs

@@ -1,70 +0,0 @@
-import { IInputs, IOutputs } from "./generated/ManifestTypes";
-import React from 'react';
-import ReactDOM from 'react-dom';
-import { initializeIcons } from '@fluentui/font-icons-mdl2';
-
-import { App, AppProps } from './App';
-
-export class {{name}} implements ComponentFramework.StandardControl<IInputs, IOutputs> {
-  container: HTMLDivElement;
-  root: Root;
-  context: ComponentFramework.Context<IInputs>;
-  isTestHarness: boolean;
-  props: AppProps;
-
-  /**
-   * Empty constructor.
-   */
-  constructor() {
-
-  }
-
-  /**
-   * Used to initialize the control instance. Controls can kick off remote server calls and other initialization actions here.
-   * Data-set values are not initialized here, use updateView.
-   * @param context The entire property bag available to control via Context Object; It contains values as set up by the customizer mapped to property names defined in the manifest, as well as utility functions.
-   * @param notifyOutputChanged A callback method to alert the framework that the control has new outputs ready to be retrieved asynchronously.
-   * @param state A piece of data that persists in one session for a single user. Can be set at any point in a controls life cycle by calling 'setControlState' in the Mode interface.
-   * @param container If a control is marked control-type='standard', it will receive an empty div element within which it can render its content.
-   */
-  public init(context: ComponentFramework.Context<IInputs>, notifyOutputChanged: () => void, state: ComponentFramework.Dictionary, container: HTMLDivElement): void {
-    initializeIcons(undefined, { disableWarnings: true });
-
-    this.container = container;
-    this.context = context;
-    this.isTestHarness = document.getElementById('control-dimensions') !== null;
-  }
-
-
-  /**
-   * Called when any value in the property bag has changed. This includes field values, data-sets, global values such as container height and width, offline status, control metadata values such as label, visible, etc.
-   * @param context The entire property bag available to control via Context Object; It contains values as set up by the customizer mapped to names defined in the manifest, as well as utility functions
-   */
-  public updateView(context: ComponentFramework.Context<IInputs>): void {
-    this.props = {
-      isTestHarness: this.isTestHarness
-    };
-
-    ReactDOM.render(
-      React.createElement(App, this.props),
-      this.container
-    );
-  }
-
-  /**
-   * It is called by the framework prior to a control receiving new data.
-   * @returns an object based on nomenclature defined in manifest, expecting object[s] for property marked as “bound” or “output”
-   */
-  public getOutputs(): IOutputs {
-    return {};
-  }
-
-  /**
-   * Called when the control is to be removed from the DOM tree. Controls should use this call for cleanup.
-   * i.e. cancelling any pending remote calls, removing listeners, etc.
-   */
-  public destroy(): void {
-    ReactDOM.unmountComponentAtNode(this.container);
-  }
-
-}