@tywalk/pcf-helper 1.5.5 → 1.5.6

package/dist/bin/session.js

@@ -52,7 +52,7 @@ program
     .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')
+    .option('-f, --config <path>', 'config file path', 'session.config.json')
     .parse();
 const options = program.opts();
 if (options.verbose) {

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tywalk/pcf-helper",
-    "version": "1.5.5",
+    "version": "1.5.6",
     "description": "Command line helper for building and publishing PCF controls to Dataverse.",
     "main": "dist/index.js",
     "types": "./types/",
@@ -15,7 +15,8 @@
         "test": "jest",
         "build": "tsc",
         "upgrade": "npm version patch --no-git-tag-version",
-        "ready": "npm run upgrade && npm run build && npm publish --access public"
+        "ready": "npm run upgrade && npm run build",
+        "update": "npm run ready && npm publish --access public"
     },
     "keywords": [
         "pcf"

package/dist/tasks/session-pcf.js

@@ -18,10 +18,18 @@ 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");
+/**
+ * Loads configuration for the session task, supporting a combination of config file, environment variables, and CLI arguments.
+ * The priority order is: CLI arguments > environment variables > config file > defaults.
+ * It also handles constructing full URLs for the script and stylesheet to intercept, allowing for relative paths in the config that are combined with the base URL.
+ * @param config Optional path to a JSON config file. If not provided, it will look for 'session.config.json' in the current working directory.
+ * @returns An object containing the resolved configuration values for the session task.
+ */
 function loadConfig(config) {
+    var _a, _b;
     // Load file config if exists
     let fileConfig = {};
-    const configPath = path_1.default.join(process.cwd(), config || 'dev-config.json');
+    const configPath = path_1.default.join(process.cwd(), config || 'session.config.json');
     color_logger_1.default.log(`📁 Looking for config file at: ${configPath}`);
     if (fs_1.default.existsSync(configPath)) {
         fileConfig = JSON.parse(fs_1.default.readFileSync(configPath, 'utf8'));
@@ -35,12 +43,10 @@ function loadConfig(config) {
     }
     // Get the base URL first
     const remoteEnvironmentUrl = process.env.REMOTE_ENVIRONMENT_URL ||
-        fileConfig.remoteEnvironmentUrl ||
-        'https://app.your-remote-environment.com';
+        fileConfig.remoteEnvironmentUrl;
     // Handle script argument - support both relative paths and full URLs
     let remoteScriptToIntercept = process.env.REMOTE_SCRIPT_TO_INTERCEPT ||
-        fileConfig.remoteScriptToIntercept ||
-        'https://app.your-remote-environment.com/static/js/remote-control-bundle.js';
+        fileConfig.remoteScriptToIntercept;
     // 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)
@@ -52,8 +58,7 @@ function loadConfig(config) {
         remoteScriptToIntercept = `${baseUrl}${scriptPath}`;
     }
     let remoteStylesheetToIntercept = process.env.REMOTE_STYLESHEET_TO_INTERCEPT ||
-        fileConfig.remoteStylesheetToIntercept ||
-        'https://app.your-remote-environment.com/static/css/remote-control-styles.css';
+        fileConfig.remoteStylesheetToIntercept;
     // 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)
@@ -69,19 +74,41 @@ function loadConfig(config) {
         remoteEnvironmentUrl: remoteEnvironmentUrl,
         remoteScriptToIntercept: remoteScriptToIntercept,
         remoteStylesheetToIntercept: remoteStylesheetToIntercept,
-        localCssPath: process.env.LOCAL_CSS_PATH ||
-            fileConfig.localCssPath ||
-            path_1.default.join(process.cwd(), 'dist', 'local-control-styles.css'),
-        localBundlePath: process.env.LOCAL_BUNDLE_PATH ||
-            fileConfig.localBundlePath ||
-            path_1.default.join(process.cwd(), 'dist', 'local-control-bundle.js')
+        localCssPath: (_a = process.env.LOCAL_CSS_PATH) !== null && _a !== void 0 ? _a : fileConfig.localCssPath,
+        localBundlePath: (_b = process.env.LOCAL_BUNDLE_PATH) !== null && _b !== void 0 ? _b : fileConfig.localBundlePath,
     };
 }
+/**
+ * Runs an ephemeral browser session that intercepts requests to the specified remote script and stylesheet URLs, serving local files instead.
+ * It also manages session state by saving cookies and local storage to a file, allowing for persistent login sessions across runs.
+ * The session will automatically clean up and save state on exit, including handling various exit signals and browser events.
+ * @param remoteEnvironmentUrl The URL of the remote environment to navigate to.
+ * @param remoteScriptToIntercept The full URL of the remote script to intercept (e.g., https://app.your-remote-environment.com/static/js/remote-control-bundle.js).
+ * @param remoteStylesheetToIntercept The full URL of the remote stylesheet to intercept (e.g., https://app.your-remote-environment.com/static/css/remote-control-styles.css).
+ * @param localBundlePath The local file path to the JavaScript bundle that should be served when the remote script URL is requested.
+ * @param localCssPath The local file path to the CSS file that should be served when the remote stylesheet URL is requested.
+ */
 function runSession(remoteEnvironmentUrl, remoteScriptToIntercept, remoteStylesheetToIntercept, localBundlePath, localCssPath) {
     if (!remoteEnvironmentUrl) {
         color_logger_1.default.error('❌ Remote environment URL is required. Please provide it via CLI, config file, or environment variable.');
         process.exit(1);
     }
+    if (!remoteScriptToIntercept) {
+        color_logger_1.default.error('❌ Remote script URL to intercept is required. Please provide it via CLI, config file, or environment variable.');
+        process.exit(1);
+    }
+    if (!remoteStylesheetToIntercept) {
+        color_logger_1.default.error('❌ Remote stylesheet URL to intercept is required. Please provide it via CLI, config file, or environment variable.');
+        process.exit(1);
+    }
+    if (!localBundlePath) {
+        color_logger_1.default.error('❌ Local bundle path is required. Please provide it via CLI, config file, or environment variable.');
+        process.exit(1);
+    }
+    if (!localCssPath) {
+        color_logger_1.default.error('❌ Local CSS path is required. Please provide it via CLI, config file, or environment variable.');
+        process.exit(1);
+    }
     const REMOTE_ENVIRONMENT_URL = remoteEnvironmentUrl;
     const REMOTE_SCRIPT_TO_INTERCEPT = remoteScriptToIntercept;
     const REMOTE_STYLESHEET_TO_INTERCEPT = remoteStylesheetToIntercept;
@@ -180,7 +207,7 @@ function runSession(remoteEnvironmentUrl, remoteScriptToIntercept, remoteStylesh
                 return false;
             }
             // Match script URLs that end with the same path structure
-            return route.href.includes(scriptPattern) && route.href.includes('bundle.js');
+            return route.href.includes(scriptPattern);
         }, (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}`);
@@ -195,7 +222,7 @@ function runSession(remoteEnvironmentUrl, remoteScriptToIntercept, remoteStylesh
                 return false;
             }
             // Match CSS URLs that end with the same path structure  
-            return route.href.includes(stylesheetPattern) && route.href.includes('ItemDescriptionPCF.css');
+            return route.href.includes(stylesheetPattern);
         }, (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}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tywalk/pcf-helper",
-  "version": "1.5.5",
+  "version": "1.5.6",
   "description": "Command line helper for building and publishing PCF controls to Dataverse.",
   "main": "dist/index.js",
   "types": "./types/",
@@ -15,7 +15,8 @@
     "test": "jest",
     "build": "tsc",
     "upgrade": "npm version patch --no-git-tag-version",
-    "ready": "npm run upgrade && npm run build && npm publish --access public"
+    "ready": "npm run upgrade && npm run build",
+    "update": "npm run ready && npm publish --access public"
   },
   "keywords": [
     "pcf"

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

@@ -1,3 +1,10 @@
+/**
+ * Loads configuration for the session task, supporting a combination of config file, environment variables, and CLI arguments.
+ * The priority order is: CLI arguments > environment variables > config file > defaults.
+ * It also handles constructing full URLs for the script and stylesheet to intercept, allowing for relative paths in the config that are combined with the base URL.
+ * @param config Optional path to a JSON config file. If not provided, it will look for 'session.config.json' in the current working directory.
+ * @returns An object containing the resolved configuration values for the session task.
+ */
 declare function loadConfig(config?: string): {
     remoteEnvironmentUrl?: undefined;
     remoteScriptToIntercept?: undefined;
@@ -11,5 +18,15 @@ declare function loadConfig(config?: string): {
     localCssPath: any;
     localBundlePath: any;
 };
+/**
+ * Runs an ephemeral browser session that intercepts requests to the specified remote script and stylesheet URLs, serving local files instead.
+ * It also manages session state by saving cookies and local storage to a file, allowing for persistent login sessions across runs.
+ * The session will automatically clean up and save state on exit, including handling various exit signals and browser events.
+ * @param remoteEnvironmentUrl The URL of the remote environment to navigate to.
+ * @param remoteScriptToIntercept The full URL of the remote script to intercept (e.g., https://app.your-remote-environment.com/static/js/remote-control-bundle.js).
+ * @param remoteStylesheetToIntercept The full URL of the remote stylesheet to intercept (e.g., https://app.your-remote-environment.com/static/css/remote-control-styles.css).
+ * @param localBundlePath The local file path to the JavaScript bundle that should be served when the remote script URL is requested.
+ * @param localCssPath The local file path to the CSS file that should be served when the remote stylesheet URL is requested.
+ */
 declare function runSession(remoteEnvironmentUrl: string, remoteScriptToIntercept: string, remoteStylesheetToIntercept: string, localBundlePath: string, localCssPath: string): void;
 export { runSession, loadConfig };