create-powerapps-project 0.15.6 → 0.16.0

package/CHANGELOG.json

@@ -2,7 +2,22 @@
   "name": "create-powerapps-project",
   "entries": [
     {
-      "date": "Mon, 17 Jan 2022 15:43:47 GMT",
+      "date": "Mon, 07 Feb 2022 22:01:59 GMT",
+      "tag": "create-powerapps-project_v0.16.0",
+      "version": "0.16.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "derek.finlinson@journeyteam.com",
+            "package": "create-powerapps-project",
+            "commit": "55d633b2c3064bbdce48c5d314d8e7572a015882",
+            "comment": "Add support for PCF projects"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Mon, 17 Jan 2022 15:43:56 GMT",
       "tag": "create-powerapps-project_v0.15.6",
       "version": "0.15.6",
       "comments": {

package/CHANGELOG.md

@@ -1,17 +1,25 @@
 # Change Log - create-powerapps-project
 
-This log was last generated on Mon, 17 Jan 2022 15:43:47 GMT and should not be manually modified.
+This log was last generated on Mon, 07 Feb 2022 22:01:59 GMT and should not be manually modified.
 
 <!-- Start content -->
 
-## 0.15.6
+## 0.16.0
 
-Mon, 17 Jan 2022 15:43:47 GMT
+Mon, 07 Feb 2022 22:01:59 GMT
 
-### Patches
+### Minor changes
 
-- Rework logger (derek.finlinson@journeyteam.com)
+- Add support for PCF projects (derek.finlinson@journeyteam.com)
 
+## 0.15.6
+
+Mon, 17 Jan 2022 15:43:56 GMT
+
+### Patches
+
+- Rework logger (derek.finlinson@journeyteam.com)
+
 ## 0.15.5
 
 Sun, 16 Jan 2022 23:22:22 GMT

package/lib/logger.js

@@ -3,20 +3,34 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logger = void 0;
+exports.logger = exports.icons = void 0;
 const kleur_1 = __importDefault(require("kleur"));
-const tick = '√', cross = '×';
-const log = (method, symbol, ...args) => {
-    console[method](symbol, ...args);
+const isTest = process.env.JEST_WORKER_ID !== undefined;
+exports.icons = {
+    done: kleur_1.default.green('▣'),
+    info: kleur_1.default.cyan('!'),
+    error: kleur_1.default.red('⨂'),
+    warn: kleur_1.default.yellow('‼')
 };
 exports.logger = {
     info(...args) {
-        log('info', kleur_1.default.green(tick), ...args);
+        if (!isTest) {
+            console.info(exports.icons.info, ...args);
+        }
     },
     warn(...args) {
-        log('warn', kleur_1.default.yellow(cross), ...args);
+        if (!isTest) {
+            console.warn(exports.icons.warn, ...args);
+        }
     },
     error(...args) {
-        log('error', kleur_1.default.red(cross), ...args);
-    }
+        if (!isTest) {
+            console.error(exports.icons.error, ...args);
+        }
+    },
+    done(...args) {
+        if (!isTest) {
+            console.info(exports.icons.info, ...args);
+        }
+    },
 };

package/lib/{createDataverseProject.js → packages/create-powerapps-project/src/createDataverseProject.js}

@@ -29,13 +29,12 @@ const path_1 = __importDefault(require("path"));
 const plop_1 = require("./plop");
 const pkg = __importStar(require("./packageManager"));
 const getEnvInfo_1 = require("./getEnvInfo");
-const kleur_1 = __importDefault(require("kleur"));
-const tick = '√', pointer = '>';
+const logger_1 = require("../../../logger");
 exports.default = async (type) => {
     await (0, getEnvInfo_1.initialize)();
     const name = path_1.default.basename(process.cwd());
-    if (!type || (type !== 'webresource' && type !== 'assembly')) {
-        const invalid = type !== undefined && type !== 'webresource' && type !== 'assembly';
+    if (!type || (type !== 'webresource' && type !== 'assembly' && type !== 'pcf')) {
+        const invalid = type !== undefined && type !== 'webresource' && type !== 'assembly' && type !== 'pcf';
         const invalidMessage = invalid ? `${type} is not a valid project type.` : '';
         const { promptType } = await (0, prompts_1.default)({
             type: 'select',
@@ -43,7 +42,8 @@ exports.default = async (type) => {
             message: `${invalidMessage} Select dataverse project to create?`,
             choices: [
                 { title: 'web resource', value: 'webresource' },
-                { title: 'plugin or workflow activity', value: 'assembly' }
+                { title: 'plugin or workflow activity', value: 'assembly' },
+                { title: 'powerapps component framework control', value: 'pcf' }
             ]
         });
         type = promptType;
@@ -54,20 +54,51 @@ exports.default = async (type) => {
         const xrmVersions = await (0, nuget_1.getNugetPackageVersions)('JourneyTeam.Xrm');
         config.xrmVersion = xrmVersions.shift();
     }
-    console.info(kleur_1.default.green(`${kleur_1.default.green(tick)} get plop generator`));
+    logger_1.logger.info('get plop generator');
     const generator = await (0, plop_1.getGenerator)(type, name);
-    console.info(`${kleur_1.default.green(tick)} run powerapps-project-${type} code generator`);
+    logger_1.logger.info(`run powerapps-project-${type} code generator`);
     await (0, plop_1.runGenerator)(generator, config);
-    console.info(`${kleur_1.default.green(tick)} initialize project`);
-    pkg.install(process.cwd(), type);
+    logger_1.logger.info('initialize project');
+    if (type !== 'pcf' || config.react) {
+        pkg.install(process.cwd(), type);
+    }
     if (type === 'assembly') {
-        console.info(`${kleur_1.default.green(tick)} add nuget packages`);
+        logger_1.logger.info('add nuget packages');
         (0, nuget_1.install)(config.name, config.sdkVersion, config.xrmVersion);
     }
     (0, exports.done)(type);
 };
 const getAnswers = async (type) => {
     let questions = [];
+    if (type === 'pcf') {
+        questions = [
+            {
+                type: 'select',
+                name: 'template',
+                message: 'template',
+                choices: [
+                    { title: 'field', value: 'field' },
+                    { title: 'dataset', value: 'dataset' }
+                ]
+            },
+            {
+                type: 'text',
+                name: 'namespace',
+                message: 'namespace'
+            },
+            {
+                type: 'text',
+                name: 'name',
+                message: 'name'
+            },
+            {
+                type: 'confirm',
+                name: 'react',
+                message: 'install react?'
+            }
+        ];
+        return questions;
+    }
     if (type === 'webresource') {
         questions.push({
             type: 'text',
@@ -128,30 +159,54 @@ const getAnswers = async (type) => {
     return questions;
 };
 const done = (type) => {
-    const message = `
+    if (process.env.JEST_WORKER_ID !== undefined) {
+        return;
+    }
+    let message;
+    if (type === 'pcf') {
+        message = `
 
-  ${kleur_1.default.green(tick)} ${type} project created!
+  ${logger_1.icons.done} ${type} project created!
   
     keep your build tools up-to-date by updating these two devDependencies:
-      ${kleur_1.default.cyan(pointer)} dataverse-utils
-      ${kleur_1.default.cyan(pointer)} powerapps-project-${type}
+      ${logger_1.icons.info} powerapps-project-${type}
+  
+    build your project in watch mode with this command:
+      ${logger_1.icons.info} npm start watch
+    build your project in production mode with this command:
+      ${logger_1.icons.info} npm run build
+  
+    run code generator with this command:
+      ${logger_1.icons.info} npm run gen
+  
+  `;
+    }
+    else {
+        message = `
+
+  ${logger_1.icons.done} ${type} project created!
+  
+    keep your build tools up-to-date by updating these two devDependencies:
+      ${logger_1.icons.info} dataverse-utils
+      ${logger_1.icons.info} powerapps-project-${type}
   
     ${type === 'webresource' ?
-        `build your project in watch mode with this command:
-      ${kleur_1.default.cyan(pointer)} ${pkg.getYarn() ? 'yarn' : 'npm run'} start
+            `build your project in watch mode with this command:
+      ${logger_1.icons.info} ${pkg.getYarn() ? 'yarn' : 'npm run'} start
     build your project in production mode with this command:
-      ${kleur_1.default.cyan(pointer)} ${pkg.getYarn() ? 'yarn' : 'npm run'} build
+      ${logger_1.icons.info} ${pkg.getYarn() ? 'yarn' : 'npm run'} build
     generate table definition files with this command:
-      ${kleur_1.default.cyan(pointer)} ${pkg.getYarn() ? 'yarn' : 'npm run'} generate` :
-        `build your project with this command:
+      ${logger_1.icons.info} ${pkg.getYarn() ? 'yarn' : 'npm run'} generate` :
+            `build your project with this command:
         dotnet build
     deploy your project with this command:
-      ${kleur_1.default.cyan(pointer)} ${pkg.getYarn() ? 'yarn' : 'npm run'} deploy`}
+      ${logger_1.icons.info} ${pkg.getYarn() ? 'yarn' : 'npm run'} deploy`}
   
     run code generator with this command:
-      ${kleur_1.default.cyan(pointer)} ${pkg.getYarn() ? 'yarn' : 'npm run'} gen
+      ${logger_1.icons.info} ${pkg.getYarn() ? 'yarn' : 'npm run'} gen
   
   `;
+    }
     console.info(message);
 };
 exports.done = done;

package/lib/{nuget.js → packages/create-powerapps-project/src/nuget.js}

@@ -47,6 +47,9 @@ const install = (project, sdkVersion, xrmVersion) => {
         cwd: process.cwd(),
         stdio: 'inherit'
     });
+    if (process.env.JEST_WORKER_ID !== undefined) {
+        return;
+    }
     (0, child_process_1.spawnSync)('dotnet', ['restore'], {
         cwd: process.cwd(),
         stdio: 'inherit'

package/lib/{packageManager.js → packages/create-powerapps-project/src/packageManager.js}

@@ -15,6 +15,9 @@ const getNpm = () => {
 };
 const install = (cwd, type) => {
     const packages = getPackages(type);
+    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) {
@@ -30,6 +33,20 @@ const install = (cwd, type) => {
 };
 exports.install = install;
 function getPackages(type) {
+    if (type === 'pcf') {
+        return {
+            dependencies: [
+                'react',
+                'react-dom',
+                '@fluentui/react'
+            ],
+            devDependencies: [
+                `powerapps-project-${type}`,
+                '@types/react',
+                '@types/react-dom'
+            ]
+        };
+    }
     const packages = {
         devDependencies: [
             `powerapps-project-${type}`,

package/lib/{plop.js → packages/create-powerapps-project/src/plop.js}

@@ -6,11 +6,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.runGenerator = exports.getGenerator = void 0;
 const node_plop_1 = __importDefault(require("node-plop"));
 const path_1 = __importDefault(require("path"));
-const tick = '√';
+const logger_1 = require("../../../logger");
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const getGenerator = async (type, name) => {
-    const plopFile = path_1.default.resolve(__dirname, 'plopfile.js');
-    const plop = await (0, node_plop_1.default)(plopFile, { destBasePath: name, force: false });
+    let plopFile = path_1.default.resolve(__dirname, 'plopfile.js');
+    if (process.env.JEST_WORKER_ID !== undefined) {
+        plopFile = path_1.default.resolve(__dirname, 'plopfile.ts');
+    }
+    const plop = (0, node_plop_1.default)(plopFile, { destBasePath: name, force: false });
     const generator = plop.getGenerator(type);
     return generator;
 };
@@ -18,7 +21,7 @@ exports.getGenerator = getGenerator;
 const runGenerator = async (generator, args) => {
     const results = await generator.runActions(args, {
         onComment: (comment) => {
-            console.log(`${tick} ${comment}`);
+            logger_1.logger.done(comment);
         }
     });
     if (results.failures && results.failures.length > 0) {
@@ -27,7 +30,7 @@ const runGenerator = async (generator, args) => {
     // do something after the actions have run
     for (const change of results.changes) {
         if (change.path) {
-            console.log(`${tick} ${change.path}`);
+            logger_1.logger.done(change.path);
         }
     }
 };

package/lib/{plopfile.js → packages/create-powerapps-project/src/plopfile.js}

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = __importDefault(require("path"));
 const child_process_1 = require("child_process");
+const fs_1 = __importDefault(require("fs"));
 /* eslint-disable @typescript-eslint/no-explicit-any */
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 exports.default = (plop) => {
@@ -13,6 +14,26 @@ exports.default = (plop) => {
         (0, child_process_1.spawnSync)(path_1.default.resolve(__dirname, '../', 'bin', 'sn.exe'), ['-q', '-k', keyPath], { stdio: 'inherit' });
         return 'signed 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');
+        }
+        (0, child_process_1.spawnSync)('pac', args, { stdio: 'inherit' });
+        return 'pcf project created';
+    });
+    plop.setActionType('addGenScript', () => {
+        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';
+        fs_1.default.writeFileSync(packagePath, JSON.stringify(packageJson, null, 4), 'utf8');
+        return 'added plop script to package.json';
+    });
     plop.setGenerator('webresource', {
         actions: [
             {
@@ -24,6 +45,32 @@ exports.default = (plop) => {
             }
         ]
     });
+    plop.setGenerator('pcf', {
+        actions: [
+            {
+                type: 'runPcf'
+            },
+            {
+                type: 'addMany',
+                templateFiles: [
+                    '../plop-templates/pcf/App.tsx',
+                    '../plop-templates/pcf/index.ts'
+                ],
+                base: '../plop-templates/pcf',
+                destination: `${process.cwd()}/{{ name }}`,
+                force: true,
+                skip: (answers) => {
+                    return !answers.react;
+                }
+            },
+            {
+                type: 'addGenScript',
+                skip: (answers) => {
+                    return !answers.react;
+                }
+            }
+        ]
+    });
     plop.setGenerator('assembly', {
         actions: [
             {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-powerapps-project",
   "description": "💧 plop generator for Dataverse development",
-  "version": "0.15.6",
+  "version": "0.16.0",
   "license": "MIT",
   "main": "lib/index.js",
   "bin": {
@@ -19,14 +19,14 @@
   "scripts": {
     "build": "tsc -p .",
     "lint": "eslint",
-    "prebuild": "rimraf lib"
+    "clean": "rimraf lib"
   },
   "dependencies": {
+    "commander": "^8.3.0",
     "envinfo": "^7.8.1",
+    "kleur": "^4.1.4",
     "node-plop": "^0.26.3",
-    "prompts": "^2.4.2",
-    "commander": "^8.3.0",
-    "kleur": "^4.1.4"
+    "prompts": "^2.4.2"
   },
   "devDependencies": {
     "@types/envinfo": "^7.8.1",

package/plop-templates/pcf/App.tsx

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,66 @@
+import { IInputs, IOutputs } from "./generated/ManifestTypes";
+import React from 'react';
+import ReactDOM from 'react-dom';
+import { initializeIcons } from '@fluentui/font-icons-mdl2';
+
+import { App } from './App';
+
+export class ReportDashboard implements ComponentFramework.StandardControl<IInputs, IOutputs> {
+  container: HTMLDivElement;
+  context: ComponentFramework.Context<IInputs>;
+  isTestHarness: boolean;
+
+  /**
+   * 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 {
+    ReactDOM.render(
+      React.createElement(App, {
+        isTestHarness: this.isTestHarness
+      }),
+      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 {
+    // Add code to cleanup control if necessary
+  }
+
+}

package/lib/createDataverseProject.d.ts

@@ -1,12 +0,0 @@
-export interface Config {
-    name: string;
-    isolation: number;
-    tenant: string;
-    solution: string;
-    server: string;
-    xrmVersion?: string;
-    sdkVersion?: string;
-}
-declare const _default: (type: string) => Promise<void>;
-export default _default;
-export declare const done: (type: string) => void;

package/lib/getEnvInfo.d.ts

@@ -1,11 +0,0 @@
-export interface EnvInfoCache {
-    Binaries: {
-        Yarn: any;
-        npm: any;
-    };
-    npmGlobalPackages: {
-        pnpm: any;
-    };
-}
-export declare const getEnvInfo: () => EnvInfoCache;
-export declare const initialize: () => Promise<any>;

package/lib/index.d.ts

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

package/lib/logger.d.ts

@@ -1,5 +0,0 @@
-export declare const logger: {
-    info(...args: any[]): void;
-    warn(...args: any[]): void;
-    error(...args: any[]): void;
-};

package/lib/nuget.d.ts

@@ -1,2 +0,0 @@
-export declare const getNugetPackageVersions: (name: string) => Promise<string[]>;
-export declare const install: (project: string, sdkVersion?: string | undefined, xrmVersion?: string | undefined) => void;

package/lib/packageManager.d.ts

@@ -1,2 +0,0 @@
-export declare const getYarn: () => any;
-export declare const install: (cwd: string, type: string) => void;

package/lib/plop.d.ts

@@ -1,4 +0,0 @@
-import { PlopGenerator } from 'node-plop';
-import { Config } from './createDataverseProject';
-export declare const getGenerator: (type: string, name: string) => Promise<PlopGenerator>;
-export declare const runGenerator: (generator: PlopGenerator, args: Config) => Promise<void>;

package/lib/plopfile.d.ts

@@ -1,2 +0,0 @@
-declare const _default: (plop: any) => void;
-export default _default;