@tywalk/pcf-helper 1.4.24 → 1.4.26

package/README.md

@@ -25,3 +25,9 @@ This tool requires the following:
   "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>"
 },
 ```
+
+## Contributing
+
+### Deployment
+
+  

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

@@ -13,7 +13,7 @@ test('build displays version', (done) => {
     });
     task.on('close', (code) => {
         console.log(output);
-        expect(output).toContain(package_json_1.version);
+        expect(output).toContain(`v${package_json_1.version}`);
         expect(code).toBe(0);
         done();
     });

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

@@ -13,7 +13,7 @@ test('deploy displays version', (done) => {
     });
     task.on('close', (code) => {
         console.log(output);
-        expect(output).toContain(package_json_1.version);
+        expect(output).toContain(`v${package_json_1.version}`);
         expect(code).toBe(0);
         done();
     });

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

@@ -10,7 +10,7 @@ test('import displays version', (done) => {
     });
     task.on('close', (code) => {
         console.log(output);
-        expect(output).toContain(package_json_1.version);
+        expect(output).toContain(`v${package_json_1.version}`);
         expect(code).toBe(0);
         done();
     });

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

@@ -10,7 +10,7 @@ test('init displays version', (done) => {
     });
     task.on('close', (code) => {
         console.log(output);
-        expect(output).toContain(package_json_1.version);
+        expect(output).toContain(`v${package_json_1.version}`);
         expect(code).toBe(0);
         done();
     });

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

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const child_process_1 = require("child_process");
+const package_json_1 = require("../package.json");
+test('session displays version', (done) => {
+    const task = (0, child_process_1.spawn)('node', ['./dist/bin/session.js', '-v']);
+    let output = '';
+    task.stdout.on('data', (data) => {
+        output += data.toString();
+    });
+    task.on('close', (code) => {
+        console.log(output);
+        expect(output).toContain(`v${package_json_1.version}`);
+        expect(code).toBe(0);
+        done();
+    });
+});
+test('session errors if no args are provided', (done) => {
+    const task = (0, child_process_1.spawn)('node', ['./dist/bin/session.js', '-e']);
+    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/dist/__tests__/pcf-helper-upgrade.test.js

@@ -10,7 +10,7 @@ test('upgrade displays version', (done) => {
     });
     task.on('close', (code) => {
         console.log(output);
-        expect(output).toContain(package_json_1.version);
+        expect(output).toContain(`v${package_json_1.version}`);
         expect(code).toBe(0);
         done();
     });

package/dist/bin/deploy.js

@@ -51,6 +51,14 @@ if (['-v', '--version'].includes(commandArgument)) {
     console.log('v%s', package_json_1.version);
     process.exit(0);
 }
+const timeout = (0, argumentUtil_1.getArgValue)(args, ['-t', '--timeout']);
+if (typeof timeout !== 'undefined') {
+    const timeoutNumber = Number(timeout);
+    if (isNaN(timeoutNumber) || timeoutNumber <= 0) {
+        color_logger_1.default.error('Timeout argument must be a positive number representing milliseconds.');
+        process.exit(1);
+    }
+}
 const verboseArgument = args.find(a => ['-v', '--verbose'].includes(a));
 if (typeof verboseArgument !== 'undefined') {
     color_logger_1.default.setDebug(true);
@@ -73,10 +81,10 @@ function executeTasks() {
     const upgradeResult = upgradeTask.runUpgrade(path, typeof verboseArgument !== 'undefined');
     if (upgradeResult === 1)
         return 1;
-    const buildResult = buildTask.runBuild(path, typeof verboseArgument !== 'undefined');
+    const buildResult = buildTask.runBuild(path, typeof verboseArgument !== 'undefined', typeof timeout !== 'undefined' ? Number(timeout) : undefined);
     if (buildResult === 1)
         return 1;
-    const importResult = importTask.runImport(path, env, typeof verboseArgument !== 'undefined');
+    const importResult = importTask.runImport(path, env, typeof verboseArgument !== 'undefined', typeof timeout !== 'undefined' ? Number(timeout) : undefined);
     if (importResult === 1)
         return 1;
     return 0;

package/dist/bin/session.js

@@ -0,0 +1,60 @@
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const task = __importStar(require("../tasks/session-pcf"));
+const package_json_1 = require("../package.json");
+const color_logger_1 = __importDefault(require("@tywalk/color-logger"));
+const commander_1 = require("commander");
+const program = new commander_1.Command();
+program
+    .option('-v, --version', 'output the version number')
+    .option('-vv, --verbose', 'enable verbose logging')
+    .parse();
+const options = program.opts();
+if (options.version) {
+    console.log('v%s', package_json_1.version);
+    process.exit(0);
+}
+if (options.verbose) {
+    color_logger_1.default.setLevel('debug');
+    color_logger_1.default.debug('Verbose logging enabled');
+}
+color_logger_1.default.log('PCF Helper version', package_json_1.version);
+const config = task.loadConfig();
+task.runSession(config.remoteEnvironmentUrl, config.remoteScriptToIntercept, config.remoteStylesheetToIntercept, config.localBundlePath, config.localCssPath);

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tywalk/pcf-helper",
-    "version": "1.4.23",
+    "version": "1.4.26",
     "description": "Command line helper for building and publishing PCF controls to Dataverse.",
     "main": "dist/index.js",
     "types": "./types/",
@@ -26,7 +26,8 @@
         "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"
+        "pcf-helper-init": "dist/bin/init.js",
+        "pcf-helper-session": "dist/bin/session.js"
     },
     "devDependencies": {
         "@types/jest": "^29.5.14",
@@ -36,6 +37,8 @@
         "typescript": "^5.8.2"
     },
     "dependencies": {
-        "@tywalk/color-logger": "^1.0.3"
+        "@tywalk/color-logger": "^1.0.3",
+        "commander": "^14.0.3",
+        "playwright": "^1.58.2"
     }
 }

package/dist/tasks/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./build-pcf"), exports);
 __exportStar(require("./import-pcf"), exports);
 __exportStar(require("./init-pcf"), exports);
 __exportStar(require("./upgrade-pcf"), exports);
+__exportStar(require("./session-pcf"), exports);

package/dist/tasks/session-pcf.js

@@ -0,0 +1,252 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runSession = runSession;
+exports.loadConfig = loadConfig;
+const color_logger_1 = __importDefault(require("@tywalk/color-logger"));
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const playwright_1 = require("playwright");
+const commander_1 = require("commander");
+function loadConfig() {
+    const program = new commander_1.Command();
+    program
+        .option('-u, --url <url>', 'remote environment URL')
+        .option('-s, --script <script>', 'remote script to intercept')
+        .option('-t, --stylesheet <stylesheet>', 'remote stylesheet to intercept')
+        .option('-b, --bundle <path>', 'local bundle path')
+        .option('-c, --css <path>', 'local CSS path')
+        .option('-f, --config <path>', 'config file path', 'dev-config.json')
+        .parse();
+    const options = program.opts();
+    // Load file config if exists
+    let fileConfig = {};
+    const configPath = path_1.default.join(__dirname, options.config);
+    console.log(`📁 Looking for config file at: ${configPath}`);
+    if (fs_1.default.existsSync(configPath)) {
+        fileConfig = JSON.parse(fs_1.default.readFileSync(configPath, 'utf8'));
+        console.log(`✅ Loaded config file: ${JSON.stringify(fileConfig, null, 2)}`);
+    }
+    else {
+        console.log(`⚠️ Config file not found, using defaults or CLI/env options.`);
+    }
+    // Get the base URL first
+    const remoteEnvironmentUrl = options.url ||
+        process.env.REMOTE_ENVIRONMENT_URL ||
+        fileConfig.remoteEnvironmentUrl ||
+        'https://app.your-remote-environment.com';
+    // Handle script argument - support both relative paths and full URLs
+    let remoteScriptToIntercept = options.script ||
+        process.env.REMOTE_SCRIPT_TO_INTERCEPT ||
+        fileConfig.remoteScriptToIntercept ||
+        'https://app.your-remote-environment.com/static/js/remote-control-bundle.js';
+    // If script is a relative path (doesn't start with http/https), combine with base URL
+    if (remoteScriptToIntercept && !remoteScriptToIntercept.startsWith('http')) {
+        // Normalize the base URL (remove trailing slash)
+        const baseUrl = remoteEnvironmentUrl.replace(/\/$/, '');
+        // Normalize the script path (ensure it starts with /)
+        const scriptPath = remoteScriptToIntercept.startsWith('/')
+            ? remoteScriptToIntercept
+            : '/' + remoteScriptToIntercept;
+        remoteScriptToIntercept = `${baseUrl}${scriptPath}`;
+    }
+    let remoteStylesheetToIntercept = options.stylesheet ||
+        process.env.REMOTE_STYLESHEET_TO_INTERCEPT ||
+        fileConfig.remoteStylesheetToIntercept ||
+        'https://app.your-remote-environment.com/static/css/remote-control-styles.css';
+    // If stylesheet is a relative path (doesn't start with http/https), combine with base URL
+    if (remoteStylesheetToIntercept && !remoteStylesheetToIntercept.startsWith('http')) {
+        // Normalize the base URL (remove trailing slash)
+        const baseUrl = remoteEnvironmentUrl.replace(/\/$/, '');
+        // Normalize the stylesheet path (ensure it starts with /)
+        const stylesheetPath = remoteStylesheetToIntercept.startsWith('/')
+            ? remoteStylesheetToIntercept
+            : '/' + remoteStylesheetToIntercept;
+        remoteStylesheetToIntercept = `${baseUrl}${stylesheetPath}`;
+    }
+    // Priority: CLI args > env vars > config file > defaults
+    return {
+        remoteEnvironmentUrl: remoteEnvironmentUrl,
+        remoteScriptToIntercept: remoteScriptToIntercept,
+        remoteStylesheetToIntercept: remoteStylesheetToIntercept,
+        localCssPath: options.css ||
+            process.env.LOCAL_CSS_PATH ||
+            fileConfig.localCssPath ||
+            path_1.default.join(__dirname, 'dist', 'local-control-styles.css'),
+        localBundlePath: options.bundle ||
+            process.env.LOCAL_BUNDLE_PATH ||
+            fileConfig.localBundlePath ||
+            path_1.default.join(__dirname, 'dist', 'local-control-bundle.js')
+    };
+}
+function runSession(remoteEnvironmentUrl, remoteScriptToIntercept, remoteStylesheetToIntercept, localBundlePath, localCssPath) {
+    const REMOTE_ENVIRONMENT_URL = remoteEnvironmentUrl;
+    const REMOTE_SCRIPT_TO_INTERCEPT = remoteScriptToIntercept;
+    const REMOTE_STYLESHEET_TO_INTERCEPT = remoteStylesheetToIntercept;
+    const LOCAL_BUNDLE_PATH = path_1.default.resolve(localBundlePath);
+    const LOCAL_CSS_PATH = path_1.default.resolve(localCssPath);
+    // Debug logging for URL construction
+    color_logger_1.default.debug('🔍 Debug - Final URLs:');
+    color_logger_1.default.debug(`   Remote Environment: ${REMOTE_ENVIRONMENT_URL}`);
+    color_logger_1.default.debug(`   Script to intercept: ${REMOTE_SCRIPT_TO_INTERCEPT}`);
+    color_logger_1.default.debug(`   CSS to intercept: ${REMOTE_STYLESHEET_TO_INTERCEPT}`);
+    color_logger_1.default.debug(`   Local bundle path: ${LOCAL_BUNDLE_PATH}`);
+    color_logger_1.default.debug(`   Local CSS path: ${LOCAL_CSS_PATH}`);
+    color_logger_1.default.debug('');
+    // Path to store your session cookies
+    const AUTH_DIR = path_1.default.join(__dirname, '.auth');
+    const STATE_FILE = path_1.default.join(AUTH_DIR, 'state.json');
+    (() => __awaiter(this, void 0, void 0, function* () {
+        color_logger_1.default.log('🚀 Starting ephemeral browser session...');
+        // 1. Prepare context options (load session if it exists)
+        let contextOptions = {};
+        if (fs_1.default.existsSync(STATE_FILE)) {
+            color_logger_1.default.log('🔓 Loading previous login session...');
+            contextOptions.storageState = STATE_FILE;
+        }
+        else {
+            color_logger_1.default.log('⚠️ No previous session found. You may need to log in.');
+        }
+        // 2. Launch browser and apply context
+        const browser = yield playwright_1.chromium.launch({ headless: false });
+        const context = yield browser.newContext(Object.assign(Object.assign({}, contextOptions), { viewport: null // Use the actual browser window size
+         }));
+        // Shared cleanup function to save state and close browser
+        const cleanup = (...args_1) => __awaiter(this, [...args_1], void 0, function* (reason = 'unknown') {
+            try {
+                color_logger_1.default.log(`💾 Saving session state (${reason})...`);
+                // Ensure the .auth directory exists before saving
+                if (!fs_1.default.existsSync(AUTH_DIR)) {
+                    fs_1.default.mkdirSync(AUTH_DIR, { recursive: true });
+                }
+                if (!browser.isConnected()) {
+                    color_logger_1.default.log('Browser already disconnected.');
+                }
+                else {
+                    // Save the cookies and local storage to the JSON file
+                    yield context.storageState({ path: STATE_FILE });
+                    color_logger_1.default.log('🛑 Tearing down rules and session.');
+                    yield browser.close();
+                }
+            }
+            catch (error) {
+                color_logger_1.default.error('Error during cleanup:', error);
+            }
+        });
+        // Handle process exit signals
+        process.on('SIGINT', () => __awaiter(this, void 0, void 0, function* () {
+            yield cleanup('SIGINT');
+            process.exit(0);
+        }));
+        process.on('SIGTERM', () => __awaiter(this, void 0, void 0, function* () {
+            yield cleanup('SIGTERM');
+            process.exit(0);
+        }));
+        process.on('beforeExit', () => __awaiter(this, void 0, void 0, function* () {
+            yield cleanup('beforeExit');
+        }));
+        // Handle uncaught exceptions
+        process.on('uncaughtException', (error) => __awaiter(this, void 0, void 0, function* () {
+            color_logger_1.default.error('Uncaught exception:', error);
+            yield cleanup('uncaughtException');
+            process.exit(1);
+        }));
+        process.on('unhandledRejection', (reason) => __awaiter(this, void 0, void 0, function* () {
+            color_logger_1.default.error('Unhandled promise rejection:', reason);
+            yield cleanup('unhandledRejection');
+            process.exit(1);
+        }));
+        // Handle browser disconnect
+        browser.on('disconnected', () => __awaiter(this, void 0, void 0, function* () {
+            color_logger_1.default.log('Browser disconnected');
+            yield cleanup('browser disconnected');
+        }));
+        // Handle context close (when all pages in context are closed)
+        context.on('close', () => __awaiter(this, void 0, void 0, function* () {
+            color_logger_1.default.log('Browser context closed');
+            yield cleanup('context closed');
+            process.exit(0);
+        }));
+        // 3. Programmatically apply your network interception rule with pattern matching
+        // Handle dynamic version segments in CRM URLs like /version?/webresources/...
+        const scriptPattern = REMOTE_SCRIPT_TO_INTERCEPT.replace(/^https?:\/\/[^\/]+/, '');
+        const stylesheetPattern = REMOTE_STYLESHEET_TO_INTERCEPT.replace(/^https?:\/\/[^\/]+/, '');
+        color_logger_1.default.debug(`📡 Setting up interception patterns:`);
+        color_logger_1.default.debug(`   Script pattern: **${scriptPattern}`);
+        color_logger_1.default.debug(`   CSS pattern: **${stylesheetPattern}`);
+        yield context.route(route => {
+            if (!route.href) {
+                return false;
+            }
+            // Match script URLs that end with the same path structure
+            return route.href.includes(scriptPattern) && route.href.includes('bundle.js');
+        }, (route) => __awaiter(this, void 0, void 0, function* () {
+            color_logger_1.default.log(`✅ Intercepted script request: ${route.request().url()}`);
+            color_logger_1.default.log(`   Serving local file: ${LOCAL_BUNDLE_PATH}`);
+            route.fulfill({
+                status: 200,
+                contentType: 'application/javascript',
+                body: fs_1.default.readFileSync(LOCAL_BUNDLE_PATH)
+            });
+        }));
+        yield context.route(route => {
+            if (!route.href) {
+                return false;
+            }
+            // Match CSS URLs that end with the same path structure  
+            return route.href.includes(stylesheetPattern) && route.href.includes('ItemDescriptionPCF.css');
+        }, (route) => __awaiter(this, void 0, void 0, function* () {
+            color_logger_1.default.log(`✅ Intercepted CSS request: ${route.request().url()}`);
+            color_logger_1.default.log(`   Serving local file: ${LOCAL_CSS_PATH}`);
+            route.fulfill({
+                status: 200,
+                contentType: 'text/css',
+                body: fs_1.default.readFileSync(LOCAL_CSS_PATH)
+            });
+        }));
+        // 4. Open a new tab and navigate to your remote environment
+        const page = yield context.newPage();
+        yield page.goto(REMOTE_ENVIRONMENT_URL);
+        // 5. Clean up and save state when the page is closed (but others may still be open)
+        page.on('close', () => __awaiter(this, void 0, void 0, function* () {
+            const pages = context.pages();
+            if (pages.length <= 1) {
+                // This was the last page, trigger full cleanup
+                yield cleanup('last page closed');
+                process.exit(0);
+            }
+            else {
+                color_logger_1.default.debug(`Page closed, but ${pages.length - 1} pages still open. Keeping session alive.`);
+            }
+        }));
+        // 6. Watch the local bundle for changes and auto-reload
+        let reloadTimeout;
+        fs_1.default.watch(LOCAL_BUNDLE_PATH, (eventType) => {
+            if (eventType === 'change') {
+                // Clear the previous timer if the file changes again quickly
+                clearTimeout(reloadTimeout);
+                // Wait 300ms for the bundler to finish writing the file before reloading
+                reloadTimeout = setTimeout(() => __awaiter(this, void 0, void 0, function* () {
+                    color_logger_1.default.log(`\n🔄 Local bundle updated! Reloading the page...`);
+                    try {
+                        yield page.reload();
+                    }
+                    catch (err) {
+                        color_logger_1.default.error('⚠️ Could not reload page (browser might be closed).', err);
+                    }
+                }), 300);
+            }
+        });
+    }))();
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tywalk/pcf-helper",
-  "version": "1.4.24",
+  "version": "1.4.26",
   "description": "Command line helper for building and publishing PCF controls to Dataverse.",
   "main": "dist/index.js",
   "types": "./types/",
@@ -26,7 +26,8 @@
     "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"
+    "pcf-helper-init": "dist/bin/init.js",
+    "pcf-helper-session": "dist/bin/session.js"
   },
   "devDependencies": {
     "@types/jest": "^29.5.14",
@@ -36,6 +37,8 @@
     "typescript": "^5.8.2"
   },
   "dependencies": {
-    "@tywalk/color-logger": "^1.0.3"
+    "@tywalk/color-logger": "^1.0.3",
+    "commander": "^14.0.3",
+    "playwright": "^1.58.2"
   }
 }

package/types/__tests__/pcf-helper-session.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/bin/session.d.ts

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

package/types/tasks/index.d.ts

@@ -2,3 +2,4 @@ export * from './build-pcf';
 export * from './import-pcf';
 export * from './init-pcf';
 export * from './upgrade-pcf';
+export * from './session-pcf';

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

@@ -0,0 +1,9 @@
+declare function loadConfig(): {
+    remoteEnvironmentUrl: any;
+    remoteScriptToIntercept: any;
+    remoteStylesheetToIntercept: any;
+    localCssPath: any;
+    localBundlePath: any;
+};
+declare function runSession(remoteEnvironmentUrl: string, remoteScriptToIntercept: string, remoteStylesheetToIntercept: string, localBundlePath: string, localCssPath: string): void;
+export { runSession, loadConfig };