@sitecore-jss/sitecore-jss-dev-tools 22.5.0-beta.14 → 22.5.0-beta.16

package/dist/cjs/codegen/extract-files.js

@@ -17,6 +17,7 @@ const utils_1 = require("./utils");
 const fetch_bearer_token_1 = require("../auth/fetch-bearer-token");
 const chalk_1 = __importDefault(require("chalk"));
 const path_1 = __importDefault(require("path"));
+const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 /**
  * Handler for the extract-component API command
  * Reads imports from the componentBuilder.ts file and posts the code to the mesh endpoint
@@ -25,15 +26,16 @@ const path_1 = __importDefault(require("path"));
  */
 function extractFiles() {
     return __awaiter(this, arguments, void 0, function* (args = {}) {
-        if (!validateDeployContext()) {
-            console.log(chalk_1.default.yellow('Skipping code extraction, not in deploy context'));
+        if ((args.customValidateDeployContext && !args.customValidateDeployContext()) ||
+            !(0, utils_1.validateDeployContext)()) {
+            sitecore_jss_1.debug.common('Skipping code extraction, not in deploy context');
             return;
         }
-        // TODO: add alternative consent procedure
-        if (!process.env.EXTRACT_CONSENT) {
-            console.log(chalk_1.default.yellow('Skipping code extraction, EXTRACT_CONSENT is not set'));
+        if (!(0, utils_1.validateConsent)()) {
+            console.log(chalk_1.default.yellow('Skipping code extraction, consent not given'));
             return;
         }
+        console.log(chalk_1.default.green('Code extraction started'));
         const basePath = process.cwd();
         try {
             const token = yield (0, fetch_bearer_token_1.fetchBearerToken)();
@@ -52,23 +54,13 @@ function extractFiles() {
                 path: path_1.default.resolve(basePath, './package.json'),
                 type: utils_1.ExtractedFileType.PackageJson,
             }, token));
-            yield Promise.all(fileDispatches);
+            const files = yield Promise.all(fileDispatches);
+            console.log(chalk_1.default.green(`Code extraction completed successfully, files extracted:\r\n${files
+                .filter((file) => file !== null)
+                .join('\r\n')}`));
         }
         catch (error) {
-            console.error(chalk_1.default.red('Error during component extraction:', error));
+            console.error(chalk_1.default.red('Error during code extraction:', error));
         }
     });
 }
-const validateDeployContext = () => {
-    if (process.env.NETLIFY && process.env.BUILD_ID) {
-        return true;
-    }
-    // workaround, Vercel does not have variables that are only accessible at build time
-    if (process.env.VERCEL && !process.env.VERCEL_REGION) {
-        return true;
-    }
-    if (process.env.SITECORE && process.env.BuildMetadata_BuildId) {
-        return true;
-    }
-    return false;
-};

package/dist/cjs/codegen/utils.js

@@ -35,7 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sendCode = exports.resolveComponentImportFiles = exports.ExtractedFileType = void 0;
+exports.sendCode = exports.resolveComponentImportFiles = exports.validateDeployContext = exports.validateConsent = exports.ExtractedFileType = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
@@ -54,6 +54,37 @@ var ExtractedFileType;
     ExtractedFileType["Json"] = "json";
     ExtractedFileType["PackageJson"] = "package.json";
 })(ExtractedFileType || (exports.ExtractedFileType = ExtractedFileType = {}));
+/**
+ * Validates consent for code extraction procedures
+ * @returns {boolean} - true if consent is given, false otherwise
+ */
+const validateConsent = () => {
+    var _a;
+    if (((_a = process.env.EXTRACT_CONSENT) === null || _a === void 0 ? void 0 : _a.toLowerCase()) !== 'true') {
+        return false;
+    }
+    return true;
+};
+exports.validateConsent = validateConsent;
+/**
+ * Validates if the current operation is done in Vercel, Netlify or XMCloud
+ * deploy context
+ * @returns {boolean} - true if in deploy context, false otherwise
+ */
+const validateDeployContext = () => {
+    if (process.env.NETLIFY && process.env.BUILD_ID) {
+        return true;
+    }
+    // workaround, Vercel does not have variables that are only accessible at build time
+    if (process.env.VERCEL && !process.env.VERCEL_REGION) {
+        return true;
+    }
+    if (process.env.SITECORE && process.env.SITECORE_BUILD) {
+        return true;
+    }
+    return false;
+};
+exports.validateDeployContext = validateDeployContext;
 /**
  * Parses the componentBuilder.ts file and returns a map of component names
  * and their respective import strings
@@ -180,13 +211,13 @@ const sendCode = (file, token) => __awaiter(void 0, void 0, void 0, function* ()
                 url: response.url,
                 headers: response.headers,
             });
-            return;
+            return null;
         }
     }
     catch (error) {
         console.error(chalk_1.default.red(`Fetch request to send extracted code from ${file.path} failed: ${JSON.stringify(error)}`));
-        return;
+        return null;
     }
-    console.log(chalk_1.default.green(`Code from ${file.path} extracted and sent to mesh endpoint`));
+    return file.path;
 });
 exports.sendCode = sendCode;

package/dist/esm/codegen/extract-files.js

@@ -7,10 +7,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { ExtractedFileType, resolveComponentImportFiles, sendCode } from './utils';
+import { validateDeployContext, validateConsent, ExtractedFileType, resolveComponentImportFiles, sendCode, } from './utils';
 import { fetchBearerToken } from '../auth/fetch-bearer-token';
 import chalk from 'chalk';
 import path from 'path';
+import { debug } from '@sitecore-jss/sitecore-jss';
 /**
  * Handler for the extract-component API command
  * Reads imports from the componentBuilder.ts file and posts the code to the mesh endpoint
@@ -19,15 +20,16 @@ import path from 'path';
  */
 export function extractFiles() {
     return __awaiter(this, arguments, void 0, function* (args = {}) {
-        if (!validateDeployContext()) {
-            console.log(chalk.yellow('Skipping code extraction, not in deploy context'));
+        if ((args.customValidateDeployContext && !args.customValidateDeployContext()) ||
+            !validateDeployContext()) {
+            debug.common('Skipping code extraction, not in deploy context');
             return;
         }
-        // TODO: add alternative consent procedure
-        if (!process.env.EXTRACT_CONSENT) {
-            console.log(chalk.yellow('Skipping code extraction, EXTRACT_CONSENT is not set'));
+        if (!validateConsent()) {
+            console.log(chalk.yellow('Skipping code extraction, consent not given'));
             return;
         }
+        console.log(chalk.green('Code extraction started'));
         const basePath = process.cwd();
         try {
             const token = yield fetchBearerToken();
@@ -46,23 +48,13 @@ export function extractFiles() {
                 path: path.resolve(basePath, './package.json'),
                 type: ExtractedFileType.PackageJson,
             }, token));
-            yield Promise.all(fileDispatches);
+            const files = yield Promise.all(fileDispatches);
+            console.log(chalk.green(`Code extraction completed successfully, files extracted:\r\n${files
+                .filter((file) => file !== null)
+                .join('\r\n')}`));
         }
         catch (error) {
-            console.error(chalk.red('Error during component extraction:', error));
+            console.error(chalk.red('Error during code extraction:', error));
         }
     });
 }
-const validateDeployContext = () => {
-    if (process.env.NETLIFY && process.env.BUILD_ID) {
-        return true;
-    }
-    // workaround, Vercel does not have variables that are only accessible at build time
-    if (process.env.VERCEL && !process.env.VERCEL_REGION) {
-        return true;
-    }
-    if (process.env.SITECORE && process.env.BuildMetadata_BuildId) {
-        return true;
-    }
-    return false;
-};

package/dist/esm/codegen/utils.js

@@ -25,6 +25,35 @@ export var ExtractedFileType;
     ExtractedFileType["Json"] = "json";
     ExtractedFileType["PackageJson"] = "package.json";
 })(ExtractedFileType || (ExtractedFileType = {}));
+/**
+ * Validates consent for code extraction procedures
+ * @returns {boolean} - true if consent is given, false otherwise
+ */
+export const validateConsent = () => {
+    var _a;
+    if (((_a = process.env.EXTRACT_CONSENT) === null || _a === void 0 ? void 0 : _a.toLowerCase()) !== 'true') {
+        return false;
+    }
+    return true;
+};
+/**
+ * Validates if the current operation is done in Vercel, Netlify or XMCloud
+ * deploy context
+ * @returns {boolean} - true if in deploy context, false otherwise
+ */
+export const validateDeployContext = () => {
+    if (process.env.NETLIFY && process.env.BUILD_ID) {
+        return true;
+    }
+    // workaround, Vercel does not have variables that are only accessible at build time
+    if (process.env.VERCEL && !process.env.VERCEL_REGION) {
+        return true;
+    }
+    if (process.env.SITECORE && process.env.SITECORE_BUILD) {
+        return true;
+    }
+    return false;
+};
 /**
  * Parses the componentBuilder.ts file and returns a map of component names
  * and their respective import strings
@@ -150,12 +179,12 @@ export const sendCode = (file, token) => __awaiter(void 0, void 0, void 0, funct
                 url: response.url,
                 headers: response.headers,
             });
-            return;
+            return null;
         }
     }
     catch (error) {
         console.error(chalk.red(`Fetch request to send extracted code from ${file.path} failed: ${JSON.stringify(error)}`));
-        return;
+        return null;
     }
-    console.log(chalk.green(`Code from ${file.path} extracted and sent to mesh endpoint`));
+    return file.path;
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-dev-tools",
-  "version": "22.5.0-beta.14",
+  "version": "22.5.0-beta.16",
   "description": "Utilities to assist in the development and deployment of Sitecore JSS apps.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "@babel/parser": "^7.24.0",
-    "@sitecore-jss/sitecore-jss": "22.5.0-beta.14",
+    "@sitecore-jss/sitecore-jss": "22.5.0-beta.16",
     "chalk": "^4.1.2",
     "chokidar": "^3.6.0",
     "del": "^6.0.0",
@@ -85,7 +85,7 @@
     "typescript": "~5.6.3"
   },
   "types": "types/index.d.ts",
-  "gitHead": "5d4ba1509f35d860a1920c2728fb203fbf11b2a5",
+  "gitHead": "a99edf7bd6bfc0fd0724f7abfb1838d2b42d315a",
   "files": [
     "dist",
     "types",

package/types/codegen/extract-files.d.ts

@@ -1,5 +1,6 @@
 type ExtracFilesOptions = {
     componentBuilderPath?: string;
+    customValidateDeployContext?: () => boolean;
 };
 /**
  * Handler for the extract-component API command

package/types/codegen/utils.d.ts

@@ -14,6 +14,17 @@ export declare enum ExtractedFileType {
     Json = "json",
     PackageJson = "package.json"
 }
+/**
+ * Validates consent for code extraction procedures
+ * @returns {boolean} - true if consent is given, false otherwise
+ */
+export declare const validateConsent: () => boolean;
+/**
+ * Validates if the current operation is done in Vercel, Netlify or XMCloud
+ * deploy context
+ * @returns {boolean} - true if in deploy context, false otherwise
+ */
+export declare const validateDeployContext: () => boolean;
 /**
  * Parses the componentBuilder.ts file and returns a map of component names
  * and their respective import strings
@@ -27,4 +38,4 @@ export declare const resolveComponentImportFiles: (appPath: string, componentBui
  * @param {ExcractedFile} file properties of the file to be sent
  * @param {string} token bearer token for authentication into mesh endpoint
  */
-export declare const sendCode: (file: ExtractedFile, token: string) => Promise<void>;
+export declare const sendCode: (file: ExtractedFile, token: string) => Promise<string | null | undefined>;