@optimizely/ocp-local-env 1.0.6 → 1.0.7

package/dist/src/utils/package-manager.js

@@ -0,0 +1,129 @@
+"use strict";
+/**
+ * Resolving which package manager an OCP app builds with.
+ *
+ * When launched through `ocp dev`, the CLI has already worked this out and passes the
+ * resolved command in OCP_LOCAL_BUILD_COMMAND. This module is the fallback for
+ * standalone `ocp-local-env` runs, where nobody has told us. It deliberately stays
+ * simpler than the CLI's equivalent: there's no runtime manifest to validate against,
+ * and the yarn Classic/Berry distinction doesn't matter because both build the same
+ * way and this tool never runs install.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detectPackageManager = detectPackageManager;
+exports.getBuildCommand = getBuildCommand;
+exports.getPackageManagerWarning = getPackageManagerWarning;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const SUPPORTED = ['yarn', 'npm', 'pnpm', 'bun'];
+/**
+ * Lock files in priority order. This mirrors the CLI's LOCK_FILES, order included: an
+ * app carrying more than one lock file must resolve the same way here as it does in
+ * `ocp app prepare`, or a local build would quietly differ from the deployed one.
+ */
+const LOCK_FILES = [
+    ['yarn.lock', 'yarn'],
+    ['package-lock.json', 'npm'],
+    ['pnpm-lock.yaml', 'pnpm'],
+    ['bun.lockb', 'bun'],
+    ['bun.lock', 'bun'],
+];
+/**
+ * Commands that run the app's `build` script. These mirror the CLI's
+ * runDirectCommand('build') exactly, so `ocp dev` and a standalone run never
+ * disagree about how the app gets built.
+ */
+const BUILD_COMMANDS = {
+    yarn: 'yarn build',
+    pnpm: 'pnpm build',
+    npm: 'npm run build',
+    bun: 'bun run build',
+};
+/**
+ * Read the Corepack `packageManager` field from the app's package.json.
+ *
+ * Returns null when the field is absent, names something we don't know, or
+ * package.json is missing/unreadable/malformed — detection has to degrade quietly,
+ * since it runs while the server is starting up.
+ */
+function fromPackageManagerField(appDir) {
+    let field;
+    try {
+        const packageJson = JSON.parse(fs_1.default.readFileSync(path_1.default.join(appDir, 'package.json'), 'utf8'));
+        field = packageJson?.packageManager;
+    }
+    catch {
+        return null;
+    }
+    if (typeof field !== 'string' || !field.trim()) {
+        return null;
+    }
+    // Corepack format is `name@version`, optionally with a `+sha224.<hash>` suffix.
+    // Tolerate a bare name too — we only care about the name here.
+    const spec = field.trim().split('+')[0];
+    const separator = spec.lastIndexOf('@');
+    const name = separator > 0 ? spec.slice(0, separator) : spec;
+    return SUPPORTED.includes(name) ? name : null;
+}
+function detect(appDir) {
+    const present = LOCK_FILES.filter(([lockFile]) => fs_1.default.existsSync(path_1.default.join(appDir, lockFile)));
+    const strayFor = (packageManager) => present.filter(([, pm]) => pm !== packageManager).map(([lockFile]) => lockFile);
+    const declared = fromPackageManagerField(appDir);
+    if (declared) {
+        return { packageManager: declared, source: 'field', strayLockFiles: strayFor(declared) };
+    }
+    if (present.length > 0) {
+        const [selectedBy, packageManager] = present[0];
+        return {
+            packageManager,
+            source: 'lockFile',
+            selectedBy,
+            strayLockFiles: strayFor(packageManager),
+        };
+    }
+    return { packageManager: 'yarn', source: 'default', strayLockFiles: [] };
+}
+/**
+ * Determine which package manager an app uses.
+ *
+ * The `packageManager` field wins over lock files because it's what Corepack
+ * enforces: an app declaring pnpm will refuse to build with yarn even if a stale
+ * yarn.lock is sitting next to it. Defaults to yarn when there's no signal either way.
+ */
+function detectPackageManager(appDir) {
+    return detect(appDir).packageManager;
+}
+/**
+ * Get the command that runs the app's `build` script with its own package manager.
+ */
+function getBuildCommand(appDir) {
+    return BUILD_COMMANDS[detectPackageManager(appDir)];
+}
+/**
+ * Describe any lock files that contradict the package manager we picked, so the
+ * developer hears about it rather than silently getting a build they didn't expect.
+ *
+ * We never delete or rewrite lock files — which one is stale is the app's call, not
+ * ours. Returns null when there's nothing ambiguous to report.
+ */
+function getPackageManagerWarning(appDir) {
+    const { packageManager, source, selectedBy, strayLockFiles } = detect(appDir);
+    if (strayLockFiles.length === 0) {
+        return null;
+    }
+    const stray = strayLockFiles.join(', ');
+    const plural = strayLockFiles.length > 1 ? 's' : '';
+    if (source === 'field') {
+        return (`Building with ${packageManager}, declared by the "packageManager" field in package.json, ` +
+            `but found ${stray} in the app directory. The lock file${plural} of another package ` +
+            `manager ${strayLockFiles.length > 1 ? 'are' : 'is'} ignored and may be stale — consider ` +
+            `removing ${strayLockFiles.length > 1 ? 'them' : 'it'} to keep local and deployed builds consistent.`);
+    }
+    return (`Found lock files for more than one package manager: ${selectedBy}, ${stray}. Building with ` +
+        `${packageManager} based on ${selectedBy}; the other${plural} ${strayLockFiles.length > 1 ? 'are' : 'is'} ` +
+        `ignored. Add a "packageManager" field to package.json to state which one this app really uses.`);
+}
+//# sourceMappingURL=package-manager.js.map

package/dist/src/utils/package-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-manager.js","sourceRoot":"","sources":["../../../src/utils/package-manager.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;AAuGH,oDAEC;AAKD,0CAEC;AASD,4DAuBC;AA9ID,4CAAoB;AACpB,gDAAwB;AAIxB,MAAM,SAAS,GAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAEnE;;;;GAIG;AACH,MAAM,UAAU,GAAoC;IAClD,CAAC,WAAW,EAAE,MAAM,CAAC;IACrB,CAAC,mBAAmB,EAAE,KAAK,CAAC;IAC5B,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAC1B,CAAC,WAAW,EAAE,KAAK,CAAC;IACpB,CAAC,UAAU,EAAE,KAAK,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,cAAc,GAAmC;IACrD,IAAI,EAAE,YAAY;IAClB,IAAI,EAAE,YAAY;IAClB,GAAG,EAAE,eAAe;IACpB,GAAG,EAAE,eAAe;CACrB,CAAC;AAEF;;;;;;GAMG;AACH,SAAS,uBAAuB,CAAC,MAAc;IAC7C,IAAI,KAAc,CAAC;IACnB,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QAC3F,KAAK,GAAG,WAAW,EAAE,cAAc,CAAC;IACtC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gFAAgF;IAChF,+DAA+D;IAC/D,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACxC,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACxC,MAAM,IAAI,GAAG,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAE7D,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAsB,CAAC,CAAC,CAAC,CAAE,IAAuB,CAAC,CAAC,CAAC,IAAI,CAAC;AACtF,CAAC;AAaD,SAAS,MAAM,CAAC,MAAc;IAC5B,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC9F,MAAM,QAAQ,GAAG,CAAC,cAA8B,EAAY,EAAE,CAC5D,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;IAElF,MAAM,QAAQ,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;IACjD,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC3F,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAChD,OAAO;YACL,cAAc;YACd,MAAM,EAAE,UAAU;YAClB,UAAU;YACV,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;SACzC,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;AAC3E,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAC,MAAc;IACjD,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC;AACvC,CAAC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,MAAc;IAC5C,OAAO,cAAc,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;AACtD,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,wBAAwB,CAAC,MAAc;IACrD,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9E,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxC,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAEpD,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QACvB,OAAO,CACL,iBAAiB,cAAc,4DAA4D;YAC3F,aAAa,KAAK,uCAAuC,MAAM,sBAAsB;YACrF,WAAW,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,uCAAuC;YAC1F,YAAY,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,gDAAgD,CACtG,CAAC;IACJ,CAAC;IAED,OAAO,CACL,uDAAuD,UAAU,KAAK,KAAK,kBAAkB;QAC7F,GAAG,cAAc,aAAa,UAAU,cAAc,MAAM,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG;QAC3G,gGAAgG,CACjG,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optimizely/ocp-local-env",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "Local testing environment for Optimizely Connect Platform (OCP) applications",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -63,7 +63,7 @@
   },
   "devDependencies": {
     "@optiaxiom/icons": "^1.1.3",
-    "@optimizely/cms-extensibility-sdk": "^1.0.0",
+    "@optimizely/cms-extensibility-sdk": "^1.0.2",
     "@playwright/test": "^1.40.0",
     "@testing-library/dom": "^10.4.1",
     "@testing-library/jest-dom": "^6.9.1",