@sitecore-content-sdk/core 2.1.3 → 2.1.4-canary.20260824045921

package/dist/cjs/tools/metadata/metadata.js

@@ -3,6 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getMetadata = getMetadata;
 const child_process_1 = require("child_process");
 const trackedScopes = ['@sitecore', '@sitecore-feaas', '@sitecore-content-sdk'];
+// pnpm and yarn match name patterns as globs, in which '*' does not cross the scope separator,
+// so both segments are wildcarded to cover every '@sitecore*' scope.
+const TRACKED_SCOPE_GLOB = '"@sitecore*/*"';
+const PNPM_DEPENDENCY_GROUPS = [
+    'dependencies',
+    'devDependencies',
+    'optionalDependencies',
+    'unsavedDependencies',
+];
+// Matches the 'name@version' entries of the tree printed by `bun pm ls`, e.g '├── @scope/pkg@1.0.0'
+const BUN_PACKAGE_ENTRY = /^[\s│├└─]*((?:@[^\s@/]+\/)?[^\s@/]+)@([^\s]+)$/;
+// Dependency trees of an app can be sizeable, the 1MB default of execSync is not enough.
+const MAX_OUTPUT_BUFFER = 10 * 1024 * 1024;
 /**
  * Get application metadata
  * @param {boolean} allowWorkspaces - Whether to allow workspaces in the metadata generation.
@@ -10,12 +23,17 @@ const trackedScopes = ['@sitecore', '@sitecore-feaas', '@sitecore-content-sdk'];
  */
 function getMetadata(allowWorkspaces = false) {
     const metadata = { packages: {} };
+    const packageManagement = getPackageManagement(allowWorkspaces);
+    const { query, parse } = packageManagement[detectPackageManager(packageManagement)];
     let queryResult = [];
     try {
-        queryResult = JSON.parse((0, child_process_1.execSync)(`npm query [name*=@sitecore] --workspaces ${allowWorkspaces}`).toString());
+        queryResult = parse((0, child_process_1.execSync)(query, {
+            maxBuffer: MAX_OUTPUT_BUFFER,
+            stdio: ['ignore', 'pipe', 'pipe'],
+        }).toString());
     }
     catch (error) {
-        console.error('Failed to retrieve sitecore packages using npm query', error);
+        console.error(`Failed to retrieve sitecore packages using '${query}'`, error);
         return metadata;
     }
     metadata.packages = getPackagesFromQueryResult(queryResult);
@@ -35,3 +53,226 @@ function getPackagesFromQueryResult(scPackages) {
     });
     return packages;
 }
+/**
+ * Build the listing command and parser for each supported package manager.
+ * Yarn classic is a dedicated entry because its command differs from yarn berry.
+ * @param {boolean} allowWorkspaces whether packages of all workspaces should be included
+ * @returns {Record<string, PackagesQuery>} query and parser per package manager
+ * @internal
+ */
+function getPackageManagement(allowWorkspaces) {
+    return {
+        pnpm: {
+            query: `pnpm list --depth Infinity --json ${allowWorkspaces ? '--recursive ' : ''}${TRACKED_SCOPE_GLOB}`,
+            parse: parsePnpmList,
+        },
+        npm: {
+            query: `npm query [name*=@sitecore] --workspaces ${allowWorkspaces}`,
+            parse: parseNpmQuery,
+        },
+        yarn: {
+            query: `yarn info --json --name-only --recursive ${allowWorkspaces ? '--all ' : ''}${TRACKED_SCOPE_GLOB}`,
+            parse: parseYarnInfo,
+        },
+        yarnClassic: {
+            query: `yarn list --json --depth 0 --pattern ${TRACKED_SCOPE_GLOB}`,
+            parse: parseYarnClassicList,
+        },
+        bun: {
+            // `bun pm ls` has no name filter and only recently gained JSON output, so the tree it
+            // prints is parsed instead, and filtered by scope afterwards.
+            query: 'bun pm ls --all',
+            parse: parseBunPackageList,
+        },
+    };
+}
+/**
+ * Detect the package manager that runs the current process. Package managers advertise themselves
+ * through the environment they set up for the commands they run, so nothing has to be read from
+ * disk - which matters because the app being built is not necessarily the project that declares
+ * the package manager (workspaces).
+ * @param {Record<string, PackagesQuery>} packageManagement supported package managers
+ * @returns {string} the detected package manager, npm when it could not be determined
+ * @internal
+ */
+function detectPackageManager(packageManagement) {
+    const managerNames = Object.keys(packageManagement).sort((left, right) => right.length - left.length);
+    const { npm_config_user_agent: userAgent, npm_execpath: execPath } = process.env;
+    // e.g. 'pnpm/10.33.0 npm/? node/v22.11.0 win32 x64'
+    if (userAgent) {
+        const [descriptor] = userAgent.trim().split(/\s+/);
+        const separatorIndex = descriptor.lastIndexOf('/');
+        const name = (separatorIndex === -1 ? descriptor : descriptor.slice(0, separatorIndex)).toLowerCase();
+        const knownName = managerNames.find((candidate) => candidate === name);
+        if (knownName) {
+            const majorVersion = parseInt(descriptor.slice(separatorIndex + 1), 10);
+            return knownName === 'yarn' && majorVersion === 1 ? 'yarnClassic' : knownName;
+        }
+    }
+    // e.g. 'C:\\Users\\dev\\AppData\\Roaming\\npm\\node_modules\\pnpm\\bin\\pnpm.cjs', which does
+    // not carry a version
+    if (execPath) {
+        const executable = execPath.toLowerCase().split(/[\\/]/).pop();
+        const knownName = managerNames.find((candidate) => executable.includes(candidate));
+        if (knownName) {
+            return knownName;
+        }
+    }
+    return 'npm';
+}
+/**
+ * Parse the output of `npm query`, which is a JSON array of package manifests
+ * @param {string} output command output
+ * @returns {Package[]} installed packages
+ * @internal
+ */
+function parseNpmQuery(output) {
+    const parsed = JSON.parse(output);
+    return Array.isArray(parsed)
+        ? parsed.filter((scPackage) => typeof (scPackage === null || scPackage === void 0 ? void 0 : scPackage.name) === 'string' && typeof (scPackage === null || scPackage === void 0 ? void 0 : scPackage.version) === 'string')
+        : [];
+}
+/**
+ * Parse the output of `pnpm list --json`, which is a dependency tree per project
+ * @param {string} output command output
+ * @returns {Package[]} installed packages
+ * @internal
+ */
+function parsePnpmList(output) {
+    if (!output.trim()) {
+        return [];
+    }
+    const parsed = JSON.parse(output);
+    const projects = Array.isArray(parsed) ? parsed : [parsed];
+    const packages = [];
+    const visited = new Set();
+    const collect = (dependencies) => {
+        if (!dependencies) {
+            return;
+        }
+        Object.entries(dependencies).forEach(([name, node]) => {
+            var _a;
+            if (!node) {
+                return;
+            }
+            const key = `${name}@${(_a = node.version) !== null && _a !== void 0 ? _a : ''}`;
+            // the same package can be reached through many paths, walk it once
+            if (visited.has(key)) {
+                return;
+            }
+            visited.add(key);
+            if (node.version) {
+                packages.push({ name, version: node.version });
+            }
+            collect(node.dependencies);
+        });
+    };
+    projects.forEach((project) => PNPM_DEPENDENCY_GROUPS.forEach((group) => collect(project === null || project === void 0 ? void 0 : project[group])));
+    return packages;
+}
+/**
+ * Parse the output of `yarn info --json`, which is an NDJSON stream of package locators
+ * @param {string} output command output
+ * @returns {Package[]} installed packages
+ * @internal
+ */
+function parseYarnInfo(output) {
+    return parseJsonLines(output).reduce((packages, entry) => {
+        const locator = typeof entry === 'string' ? entry : getRecordString(entry, 'value');
+        const scPackage = locator ? parsePackageLocator(locator) : undefined;
+        return scPackage ? [...packages, scPackage] : packages;
+    }, []);
+}
+/**
+ * Parse the output of `yarn list --json` (yarn classic), which is an NDJSON stream in which the
+ * 'tree' entry holds the hoisted dependency trees
+ * @param {string} output command output
+ * @returns {Package[]} installed packages
+ * @internal
+ */
+function parseYarnClassicList(output) {
+    return parseJsonLines(output).reduce((packages, entry) => {
+        const data = isRecord(entry) && entry.type === 'tree' ? entry.data : undefined;
+        const trees = isRecord(data) && Array.isArray(data.trees) ? data.trees : undefined;
+        if (!trees) {
+            return packages;
+        }
+        return trees.reduce((treePackages, tree) => {
+            const name = getRecordString(tree, 'name');
+            const scPackage = name ? parsePackageLocator(name) : undefined;
+            return scPackage ? [...treePackages, scPackage] : treePackages;
+        }, packages);
+    }, []);
+}
+/**
+ * Parse the dependency tree printed by `bun pm ls`
+ * @param {string} output command output
+ * @returns {Package[]} installed packages
+ * @internal
+ */
+function parseBunPackageList(output) {
+    return output.split(/\r?\n/).reduce((packages, line) => {
+        const match = BUN_PACKAGE_ENTRY.exec(line.trim());
+        return match ? [...packages, { name: match[1], version: match[2] }] : packages;
+    }, []);
+}
+/**
+ * Parse an NDJSON stream, skipping lines that are not valid JSON - package managers mix
+ * diagnostics into their output
+ * @param {string} output command output
+ * @returns {unknown[]} parsed entries
+ * @internal
+ */
+function parseJsonLines(output) {
+    return output.split(/\r?\n/).reduce((entries, line) => {
+        const trimmed = line.trim();
+        if (!trimmed) {
+            return entries;
+        }
+        try {
+            return [...entries, JSON.parse(trimmed)];
+        }
+        catch (_a) {
+            return entries;
+        }
+    }, []);
+}
+/**
+ * Narrow an unknown value to a plain object record
+ * @param {unknown} value value to check
+ * @returns {value is Record<string, unknown>} whether the value is a non-null object
+ * @internal
+ */
+function isRecord(value) {
+    return typeof value === 'object' && value !== null;
+}
+/**
+ * Read a string property from an unknown object
+ * @param {unknown} value object that may contain the property
+ * @param {string} key property name
+ * @returns {string | undefined} the string value, or undefined when it is missing or not a string
+ * @internal
+ */
+function getRecordString(value, key) {
+    if (!isRecord(value)) {
+        return undefined;
+    }
+    const property = value[key];
+    return typeof property === 'string' ? property : undefined;
+}
+/**
+ * Split a package locator into name and version, e.g. '@scope/pkg@npm:1.0.0'. Yarn prefixes the
+ * reference with the protocol it was resolved with, which is not part of the version.
+ * @param {string} locator package locator
+ * @returns {Package | undefined} the package, or undefined when the locator could not be parsed
+ * @internal
+ */
+function parsePackageLocator(locator) {
+    const separatorIndex = locator.lastIndexOf('@');
+    if (separatorIndex <= 0) {
+        return undefined;
+    }
+    const reference = locator.slice(separatorIndex + 1);
+    const version = reference.slice(reference.lastIndexOf(':') + 1);
+    return version ? { name: locator.slice(0, separatorIndex), version } : undefined;
+}

package/dist/esm/tools/metadata/metadata.js

@@ -1,5 +1,18 @@
 import { execSync } from 'child_process';
 const trackedScopes = ['@sitecore', '@sitecore-feaas', '@sitecore-content-sdk'];
+// pnpm and yarn match name patterns as globs, in which '*' does not cross the scope separator,
+// so both segments are wildcarded to cover every '@sitecore*' scope.
+const TRACKED_SCOPE_GLOB = '"@sitecore*/*"';
+const PNPM_DEPENDENCY_GROUPS = [
+    'dependencies',
+    'devDependencies',
+    'optionalDependencies',
+    'unsavedDependencies',
+];
+// Matches the 'name@version' entries of the tree printed by `bun pm ls`, e.g '├── @scope/pkg@1.0.0'
+const BUN_PACKAGE_ENTRY = /^[\s│├└─]*((?:@[^\s@/]+\/)?[^\s@/]+)@([^\s]+)$/;
+// Dependency trees of an app can be sizeable, the 1MB default of execSync is not enough.
+const MAX_OUTPUT_BUFFER = 10 * 1024 * 1024;
 /**
  * Get application metadata
  * @param {boolean} allowWorkspaces - Whether to allow workspaces in the metadata generation.
@@ -7,12 +20,17 @@ const trackedScopes = ['@sitecore', '@sitecore-feaas', '@sitecore-content-sdk'];
  */
 export function getMetadata(allowWorkspaces = false) {
     const metadata = { packages: {} };
+    const packageManagement = getPackageManagement(allowWorkspaces);
+    const { query, parse } = packageManagement[detectPackageManager(packageManagement)];
     let queryResult = [];
     try {
-        queryResult = JSON.parse(execSync(`npm query [name*=@sitecore] --workspaces ${allowWorkspaces}`).toString());
+        queryResult = parse(execSync(query, {
+            maxBuffer: MAX_OUTPUT_BUFFER,
+            stdio: ['ignore', 'pipe', 'pipe'],
+        }).toString());
     }
     catch (error) {
-        console.error('Failed to retrieve sitecore packages using npm query', error);
+        console.error(`Failed to retrieve sitecore packages using '${query}'`, error);
         return metadata;
     }
     metadata.packages = getPackagesFromQueryResult(queryResult);
@@ -32,3 +50,226 @@ function getPackagesFromQueryResult(scPackages) {
     });
     return packages;
 }
+/**
+ * Build the listing command and parser for each supported package manager.
+ * Yarn classic is a dedicated entry because its command differs from yarn berry.
+ * @param {boolean} allowWorkspaces whether packages of all workspaces should be included
+ * @returns {Record<string, PackagesQuery>} query and parser per package manager
+ * @internal
+ */
+function getPackageManagement(allowWorkspaces) {
+    return {
+        pnpm: {
+            query: `pnpm list --depth Infinity --json ${allowWorkspaces ? '--recursive ' : ''}${TRACKED_SCOPE_GLOB}`,
+            parse: parsePnpmList,
+        },
+        npm: {
+            query: `npm query [name*=@sitecore] --workspaces ${allowWorkspaces}`,
+            parse: parseNpmQuery,
+        },
+        yarn: {
+            query: `yarn info --json --name-only --recursive ${allowWorkspaces ? '--all ' : ''}${TRACKED_SCOPE_GLOB}`,
+            parse: parseYarnInfo,
+        },
+        yarnClassic: {
+            query: `yarn list --json --depth 0 --pattern ${TRACKED_SCOPE_GLOB}`,
+            parse: parseYarnClassicList,
+        },
+        bun: {
+            // `bun pm ls` has no name filter and only recently gained JSON output, so the tree it
+            // prints is parsed instead, and filtered by scope afterwards.
+            query: 'bun pm ls --all',
+            parse: parseBunPackageList,
+        },
+    };
+}
+/**
+ * Detect the package manager that runs the current process. Package managers advertise themselves
+ * through the environment they set up for the commands they run, so nothing has to be read from
+ * disk - which matters because the app being built is not necessarily the project that declares
+ * the package manager (workspaces).
+ * @param {Record<string, PackagesQuery>} packageManagement supported package managers
+ * @returns {string} the detected package manager, npm when it could not be determined
+ * @internal
+ */
+function detectPackageManager(packageManagement) {
+    const managerNames = Object.keys(packageManagement).sort((left, right) => right.length - left.length);
+    const { npm_config_user_agent: userAgent, npm_execpath: execPath } = process.env;
+    // e.g. 'pnpm/10.33.0 npm/? node/v22.11.0 win32 x64'
+    if (userAgent) {
+        const [descriptor] = userAgent.trim().split(/\s+/);
+        const separatorIndex = descriptor.lastIndexOf('/');
+        const name = (separatorIndex === -1 ? descriptor : descriptor.slice(0, separatorIndex)).toLowerCase();
+        const knownName = managerNames.find((candidate) => candidate === name);
+        if (knownName) {
+            const majorVersion = parseInt(descriptor.slice(separatorIndex + 1), 10);
+            return knownName === 'yarn' && majorVersion === 1 ? 'yarnClassic' : knownName;
+        }
+    }
+    // e.g. 'C:\\Users\\dev\\AppData\\Roaming\\npm\\node_modules\\pnpm\\bin\\pnpm.cjs', which does
+    // not carry a version
+    if (execPath) {
+        const executable = execPath.toLowerCase().split(/[\\/]/).pop();
+        const knownName = managerNames.find((candidate) => executable.includes(candidate));
+        if (knownName) {
+            return knownName;
+        }
+    }
+    return 'npm';
+}
+/**
+ * Parse the output of `npm query`, which is a JSON array of package manifests
+ * @param {string} output command output
+ * @returns {Package[]} installed packages
+ * @internal
+ */
+function parseNpmQuery(output) {
+    const parsed = JSON.parse(output);
+    return Array.isArray(parsed)
+        ? parsed.filter((scPackage) => typeof (scPackage === null || scPackage === void 0 ? void 0 : scPackage.name) === 'string' && typeof (scPackage === null || scPackage === void 0 ? void 0 : scPackage.version) === 'string')
+        : [];
+}
+/**
+ * Parse the output of `pnpm list --json`, which is a dependency tree per project
+ * @param {string} output command output
+ * @returns {Package[]} installed packages
+ * @internal
+ */
+function parsePnpmList(output) {
+    if (!output.trim()) {
+        return [];
+    }
+    const parsed = JSON.parse(output);
+    const projects = Array.isArray(parsed) ? parsed : [parsed];
+    const packages = [];
+    const visited = new Set();
+    const collect = (dependencies) => {
+        if (!dependencies) {
+            return;
+        }
+        Object.entries(dependencies).forEach(([name, node]) => {
+            var _a;
+            if (!node) {
+                return;
+            }
+            const key = `${name}@${(_a = node.version) !== null && _a !== void 0 ? _a : ''}`;
+            // the same package can be reached through many paths, walk it once
+            if (visited.has(key)) {
+                return;
+            }
+            visited.add(key);
+            if (node.version) {
+                packages.push({ name, version: node.version });
+            }
+            collect(node.dependencies);
+        });
+    };
+    projects.forEach((project) => PNPM_DEPENDENCY_GROUPS.forEach((group) => collect(project === null || project === void 0 ? void 0 : project[group])));
+    return packages;
+}
+/**
+ * Parse the output of `yarn info --json`, which is an NDJSON stream of package locators
+ * @param {string} output command output
+ * @returns {Package[]} installed packages
+ * @internal
+ */
+function parseYarnInfo(output) {
+    return parseJsonLines(output).reduce((packages, entry) => {
+        const locator = typeof entry === 'string' ? entry : getRecordString(entry, 'value');
+        const scPackage = locator ? parsePackageLocator(locator) : undefined;
+        return scPackage ? [...packages, scPackage] : packages;
+    }, []);
+}
+/**
+ * Parse the output of `yarn list --json` (yarn classic), which is an NDJSON stream in which the
+ * 'tree' entry holds the hoisted dependency trees
+ * @param {string} output command output
+ * @returns {Package[]} installed packages
+ * @internal
+ */
+function parseYarnClassicList(output) {
+    return parseJsonLines(output).reduce((packages, entry) => {
+        const data = isRecord(entry) && entry.type === 'tree' ? entry.data : undefined;
+        const trees = isRecord(data) && Array.isArray(data.trees) ? data.trees : undefined;
+        if (!trees) {
+            return packages;
+        }
+        return trees.reduce((treePackages, tree) => {
+            const name = getRecordString(tree, 'name');
+            const scPackage = name ? parsePackageLocator(name) : undefined;
+            return scPackage ? [...treePackages, scPackage] : treePackages;
+        }, packages);
+    }, []);
+}
+/**
+ * Parse the dependency tree printed by `bun pm ls`
+ * @param {string} output command output
+ * @returns {Package[]} installed packages
+ * @internal
+ */
+function parseBunPackageList(output) {
+    return output.split(/\r?\n/).reduce((packages, line) => {
+        const match = BUN_PACKAGE_ENTRY.exec(line.trim());
+        return match ? [...packages, { name: match[1], version: match[2] }] : packages;
+    }, []);
+}
+/**
+ * Parse an NDJSON stream, skipping lines that are not valid JSON - package managers mix
+ * diagnostics into their output
+ * @param {string} output command output
+ * @returns {unknown[]} parsed entries
+ * @internal
+ */
+function parseJsonLines(output) {
+    return output.split(/\r?\n/).reduce((entries, line) => {
+        const trimmed = line.trim();
+        if (!trimmed) {
+            return entries;
+        }
+        try {
+            return [...entries, JSON.parse(trimmed)];
+        }
+        catch (_a) {
+            return entries;
+        }
+    }, []);
+}
+/**
+ * Narrow an unknown value to a plain object record
+ * @param {unknown} value value to check
+ * @returns {value is Record<string, unknown>} whether the value is a non-null object
+ * @internal
+ */
+function isRecord(value) {
+    return typeof value === 'object' && value !== null;
+}
+/**
+ * Read a string property from an unknown object
+ * @param {unknown} value object that may contain the property
+ * @param {string} key property name
+ * @returns {string | undefined} the string value, or undefined when it is missing or not a string
+ * @internal
+ */
+function getRecordString(value, key) {
+    if (!isRecord(value)) {
+        return undefined;
+    }
+    const property = value[key];
+    return typeof property === 'string' ? property : undefined;
+}
+/**
+ * Split a package locator into name and version, e.g. '@scope/pkg@npm:1.0.0'. Yarn prefixes the
+ * reference with the protocol it was resolved with, which is not part of the version.
+ * @param {string} locator package locator
+ * @returns {Package | undefined} the package, or undefined when the locator could not be parsed
+ * @internal
+ */
+function parsePackageLocator(locator) {
+    const separatorIndex = locator.lastIndexOf('@');
+    if (separatorIndex <= 0) {
+        return undefined;
+    }
+    const reference = locator.slice(separatorIndex + 1);
+    const version = reference.slice(reference.lastIndexOf(':') + 1);
+    return version ? { name: locator.slice(0, separatorIndex), version } : undefined;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/core",
-  "version": "2.1.3",
+  "version": "2.1.4-canary.20260824045921",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,

package/types/tools/metadata/metadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../../src/tools/metadata/metadata.ts"],"names":[],"mappings":"AAOA;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACrC;AAID;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,eAAe,GAAE,OAAe,GAAG,QAAQ,CAgBtE"}
+{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../../src/tools/metadata/metadata.ts"],"names":[],"mappings":"AAyBA;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACrC;AAqBD;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,eAAe,GAAE,OAAe,GAAG,QAAQ,CAqBtE"}