@salesforce/pwa-kit-dev 3.0.0-preview.0

package/configs/webpack/overrides-plugin.js

@@ -0,0 +1,120 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _path = _interopRequireDefault(require("path"));
+var _glob = _interopRequireDefault(require("glob"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/*
+ * Copyright (c) 2023, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+/**
+ * @class OverridesResolverPlugin
+ *
+ *  This plugin provides the "Overrides" behavior of the Template Extensibility feature,
+ *  allowing third party implementations that depend on an npm module for the base implementation
+ *  and then overriding only specific files
+ */
+class OverridesResolverPlugin {
+  /**
+   *
+   * @param options
+   * @param {string} options.overridesDir path to application base
+   * @param {string[]} options.overrides paths to overrides
+   * @param {string} options.projectDir path to project directory
+   */
+  constructor(options) {
+    var _this$pkg, _this$pkg$ccExtensibi, _this$pkg$ccExtensibi2, _this$pkg2, _this$pkg2$ccExtensib;
+    this.overridesDir = options.overridesDir || '';
+    this.extends = options.extends || [];
+    this.projectDir = options.projectDir;
+    this._allSearchDirs = [this.projectDir + this.overridesDir, ...this.extends];
+    this.pkg = require(_path.default.resolve(this.projectDir, 'package.json'));
+    this.extendsHashMap = new Map();
+
+    // everything except directories
+    const globPattern = `${(_this$pkg = this.pkg) === null || _this$pkg === void 0 ? void 0 : (_this$pkg$ccExtensibi = _this$pkg.ccExtensibility) === null || _this$pkg$ccExtensibi === void 0 ? void 0 : (_this$pkg$ccExtensibi2 = _this$pkg$ccExtensibi.overridesDir) === null || _this$pkg$ccExtensibi2 === void 0 ? void 0 : _this$pkg$ccExtensibi2.replace(/^\//, '')}/**/*.*`;
+    const overridesFsRead = _glob.default.sync(globPattern);
+    const overrideReplace = ((_this$pkg2 = this.pkg) === null || _this$pkg2 === void 0 ? void 0 : (_this$pkg2$ccExtensib = _this$pkg2.ccExtensibility) === null || _this$pkg2$ccExtensib === void 0 ? void 0 : _this$pkg2$ccExtensib.overridesDir) + '/';
+    overridesFsRead.forEach(item => {
+      const end = item.substring(item.lastIndexOf('/index'));
+      const [l, ...rest] = item.split(/(index|\.)/);
+      this.extendsHashMap.set(l === null || l === void 0 ? void 0 : l.replace(overrideReplace, '').replace(/\/$/, ''), [end, rest]);
+    });
+  }
+
+  /**
+   *
+   * @param requestPath
+   * @param dirs
+   */
+  findFileFromMap(requestPath, dirs) {
+    const fileExt = _path.default.extname(requestPath);
+    for (const dir of dirs) {
+      let base = _path.default.join(dir, requestPath);
+      if (fileExt) {
+        const noExtPath = requestPath.replace(fileExt, '');
+        if (this.extendsHashMap.has(noExtPath)) {
+          return base;
+        }
+      } else {
+        if (this.extendsHashMap.has(requestPath)) {
+          const end = this.extendsHashMap.get(requestPath)[1];
+          const isRequestingIndex = end[0] === 'index';
+          let result = (base === null || base === void 0 ? void 0 : base.replace(/$\//, '')) + end.join('');
+          if (isRequestingIndex) {
+            result = _path.default.join(base, this.extendsHashMap.get(requestPath)[1].join(''));
+          }
+          return result;
+        }
+      }
+    }
+  }
+  toOverrideRelative(path) {
+    const override = this.findOverride(path);
+    return path.substring(override.length + 1);
+  }
+  findOverride(path) {
+    return this._allSearchDirs.find(override => {
+      return path.indexOf(override) === 0;
+    });
+  }
+  isFromExtends(request, path) {
+    var _request$split;
+    // in npm namespaces like `@salesforce/<pkg>` we need to ignore the first slash
+    const basePkgIndex = request !== null && request !== void 0 && request.startsWith('@') ? 1 : 0;
+    return this.extends.includes(request === null || request === void 0 ? void 0 : (_request$split = request.split('/')) === null || _request$split === void 0 ? void 0 : _request$split[basePkgIndex]) &&
+    // this is very important, to avoid circular imports, check that the
+    // `issuer` (requesting context) isn't the overrides directory
+    !path.match(this.projectDir + this.overridesDir);
+  }
+  handleHook(requestContext, resolveContext, callback, resolver) {
+    let targetFile;
+    let overrideRelative;
+    if (this.isFromExtends(requestContext.request, requestContext.path)) {
+      var _this$toOverrideRelat;
+      overrideRelative = (_this$toOverrideRelat = this.toOverrideRelative(requestContext.request)) === null || _this$toOverrideRelat === void 0 ? void 0 : _this$toOverrideRelat.replace(/$\//, '');
+      targetFile = this.findFileFromMap(overrideRelative, this._allSearchDirs);
+    }
+    if (targetFile) {
+      const target = resolver.ensureHook('resolved');
+      requestContext.path = targetFile;
+      resolver.doResolve(target, requestContext, `${this.constructor.name} found base override file`, resolveContext, callback);
+    } else {
+      return callback();
+    }
+  }
+  apply(resolver) {
+    resolver.getHook('resolve').tapAsync('FeatureResolverPlugin', (requestContext, resolveContext, callback) => {
+      this.handleHook(requestContext, resolveContext, callback, resolver);
+    });
+  }
+}
+var _default = OverridesResolverPlugin;
+exports.default = _default;

package/configs/webpack/plugins.js

@@ -0,0 +1,92 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.sdkReplacementPlugin = exports.makeRegExp = void 0;
+var _webpack = _interopRequireDefault(require("webpack"));
+var _path = _interopRequireWildcard(require("path"));
+var _glob = _interopRequireDefault(require("glob"));
+var _config = require("./config");
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+const projectDir = process.cwd();
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const pkg = require((0, _path.resolve)(projectDir, 'package.json'));
+const OVERRIDES_EXTENSIONS = '.+(js|jsx|ts|tsx)';
+const getOverridePath = relativePath => {
+  var _pkg$ccExtensibility;
+  const extendPath = pkg !== null && pkg !== void 0 && (_pkg$ccExtensibility = pkg.ccExtensibility) !== null && _pkg$ccExtensibility !== void 0 && _pkg$ccExtensibility.extends ? `node_modules/${_config.EXT_EXTENDS}` : '';
+  const overridePath = _config.EXT_OVERRIDES_DIR === null || _config.EXT_OVERRIDES_DIR === void 0 ? void 0 : _config.EXT_OVERRIDES_DIR.replace(/^\//, '');
+
+  // order matters here, we perform look ups starting in the following order:
+  // pkg.ccExtensibility.overridesDir => pkg.ccExtensibility.extends => current projectDir
+  if (_config.EXT_EXTENDS && _config.EXT_OVERRIDES_DIR) {
+    const filePath = `${(0, _path.resolve)(projectDir, overridePath, ...relativePath)}${OVERRIDES_EXTENSIONS}`;
+    const overrideFile = _glob.default.sync(filePath);
+    if (overrideFile !== null && overrideFile !== void 0 && overrideFile.length) {
+      return overrideFile === null || overrideFile === void 0 ? void 0 : overrideFile[0];
+    }
+    const extendFile = _glob.default.sync(`${(0, _path.resolve)(projectDir, extendPath, ...relativePath)}${OVERRIDES_EXTENSIONS}`);
+    if (extendFile !== null && extendFile !== void 0 && extendFile.length) {
+      return extendFile === null || extendFile === void 0 ? void 0 : extendFile[0];
+    }
+  }
+  const generatedProjectOverride = _glob.default.sync(`${(0, _path.resolve)(projectDir, ...relativePath)}${OVERRIDES_EXTENSIONS}`);
+  return generatedProjectOverride !== null && generatedProjectOverride !== void 0 && generatedProjectOverride.length ? generatedProjectOverride === null || generatedProjectOverride === void 0 ? void 0 : generatedProjectOverride[0] : (0, _path.resolve)('node_modules', '@salesforce', 'pwa-kit-react-sdk', 'ssr', 'universal', ...relativePath.filter(item => item !== 'app'));
+};
+const makeRegExp = (str, sep = _path.default.sep) => {
+  // Replace unix paths with windows if needed and build a RegExp
+  if (sep === '\\') {
+    str = str.replace(/\//g, '\\\\');
+  }
+  return new RegExp(str);
+};
+
+/**
+ * Allows users to override special SDK components by placing override
+ * files in certain magic locations in a project.
+ *
+ * @returns {webpack.NormalModuleReplacementPlugin}
+ */
+exports.makeRegExp = makeRegExp;
+const sdkReplacementPlugin = () => {
+  var _overridables$filter;
+  const overridables = [{
+    path: makeRegExp('pwa-kit-react-sdk(/dist)?/ssr/universal/components/_app-config$'),
+    newPath: getOverridePath(['app', 'components', '_app-config', 'index'])
+  }, {
+    path: makeRegExp('pwa-kit-react-sdk(/dist)?/ssr/universal/components/_document$'),
+    newPath: getOverridePath(['app', 'components', '_document', 'index'])
+  }, {
+    path: makeRegExp('pwa-kit-react-sdk(/dist)?/ssr/universal/components/_app$'),
+    newPath: getOverridePath(['app', 'components', '_app', 'index'])
+  }, {
+    path: makeRegExp('pwa-kit-react-sdk(/dist)?/ssr/universal/components/_error$'),
+    newPath: getOverridePath(['app', 'components', '_error', 'index'])
+  }, {
+    path: makeRegExp('pwa-kit-react-sdk(/dist)?/ssr/universal/routes$'),
+    newPath: getOverridePath(['app', 'routes'])
+  }];
+  const replacements = overridables === null || overridables === void 0 ? void 0 : (_overridables$filter = overridables.filter) === null || _overridables$filter === void 0 ? void 0 : _overridables$filter.call(overridables, item => item === null || item === void 0 ? void 0 : item.newPath);
+  return new _webpack.default.NormalModuleReplacementPlugin(/.*/, resource => {
+    const resolved = _path.default.resolve(resource.context, resource.request);
+    const replacement = replacements.find(({
+      path
+    }) => resolved.match(path));
+    const sdkPaths = [_path.default.join('packages', 'pwa-kit-react-sdk'), _path.default.join('node_modules', '@salesforce', 'pwa-kit-react-sdk')];
+    const requestedFromSDK = sdkPaths.some(p => resource.context.includes(p));
+    if (requestedFromSDK && replacement) {
+      resource.request = replacement.newPath;
+    }
+  });
+};
+exports.sdkReplacementPlugin = sdkReplacementPlugin;

package/package.json

@@ -0,0 +1,150 @@
+{
+  "name": "@salesforce/pwa-kit-dev",
+  "version": "3.0.0-preview.0",
+  "description": "Build tools for pwa-kit",
+  "homepage": "https://github.com/SalesforceCommerceCloud/pwa-kit/tree/develop/packages/pwa-kit-dev#readme",
+  "bugs": {
+    "url": "https://github.com/SalesforceCommerceCloud/pwa-kit/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SalesforceCommerceCloud/pwa-kit.git"
+  },
+  "license": "SEE LICENSE IN LICENSE",
+  "author": "cc-pwa-kit@salesforce.com",
+  "bin": {
+    "pwa-kit-dev": "bin/pwa-kit-dev.js"
+  },
+  "files": [
+    "bin",
+    "LICENSE",
+    "scripts",
+    "ssr",
+    "utils",
+    "configs"
+  ],
+  "scripts": {
+    "build": "cross-env NODE_ENV=production internal-lib-build build",
+    "build:watch": "nodemon --watch 'src/**' --watch 'bin/**' --exec 'npm run build'",
+    "format": "internal-lib-build format \"**/*.{js,jsx}\"",
+    "lint": "npm run lint:js && npm run typecheck",
+    "lint:fix": "npm run lint:js -- --fix",
+    "lint:js": "eslint .",
+    "prepare": "npm run build",
+    "test": "internal-lib-build test",
+    "typecheck": "tsc --noEmit",
+    "version": "node ./scripts/version.js"
+  },
+  "dependencies": {
+    "@babel/cli": "^7.21.0",
+    "@babel/core": "^7.21.3",
+    "@babel/eslint-parser": "^7.21.3",
+    "@babel/parser": "^7.21.3",
+    "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
+    "@babel/plugin-proposal-optional-chaining": "^7.21.0",
+    "@babel/plugin-transform-async-to-generator": "^7.20.7",
+    "@babel/plugin-transform-object-assign": "^7.18.6",
+    "@babel/plugin-transform-runtime": "^7.21.0",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/preset-react": "^7.18.6",
+    "@babel/preset-typescript": "^7.21.0",
+    "@babel/register": "^7.21.0",
+    "@babel/runtime": "^7.21.0",
+    "@babel/runtime-corejs2": "^7.21.0",
+    "@babel/traverse": "^7.21.3",
+    "@loadable/babel-plugin": "^5.15.3",
+    "@loadable/server": "^5.15.3",
+    "@loadable/webpack-plugin": "^5.15.2",
+    "@pmmmwh/react-refresh-webpack-plugin": "^0.5.10",
+    "@salesforce/pwa-kit-runtime": "3.0.0-preview.0",
+    "@typescript-eslint/eslint-plugin": "^5.57.0",
+    "@typescript-eslint/parser": "^5.57.0",
+    "archiver": "1.3.0",
+    "babel-jest": "^26.6.3",
+    "babel-loader": "^8.3.0",
+    "babel-plugin-dynamic-import-node-babel-7": "^2.0.7",
+    "babel-plugin-formatjs": "10.4.0",
+    "chalk": "^4.1.2",
+    "commander": "^9.5.0",
+    "compression": "1.7.4",
+    "copy-webpack-plugin": "^9.1.0",
+    "cross-env": "^5.2.1",
+    "eslint": "^8.37.0",
+    "eslint-config-prettier": "8.8.0",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-jsx-a11y": "6.7.1",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-react": "^7.32.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-use-effect-no-deps": "^1.1.2",
+    "express": "^4.18.2",
+    "fs-extra": "^11.1.1",
+    "git-rev-sync": "^3.0.2",
+    "glob": "7.2.3",
+    "ignore-loader": "^0.1.2",
+    "jest": "^26.6.3",
+    "jest-cli": "^26.6.3",
+    "jest-environment-jsdom": "^26.6.2",
+    "jest-environment-jsdom-global": "^2.0.4",
+    "jest-expect-message": "1.1.3",
+    "jest-fetch-mock": "^2.1.2",
+    "mime-types": "2.1.35",
+    "minimatch": "3.1.2",
+    "node-fetch": "^2.6.9",
+    "open": "^8.4.2",
+    "prettier": "^2.8.6",
+    "react-refresh": "^0.14.0",
+    "replace-in-file": "^6.3.5",
+    "require-from-string": "^2.0.2",
+    "rimraf": "2.7.1",
+    "speed-measure-webpack-plugin": "^1.5.0",
+    "svg-sprite-loader": "^6.0.11",
+    "validator": "^13.9.0",
+    "webpack": "^5.76.3",
+    "webpack-bundle-analyzer": "^4.8.0",
+    "webpack-cli": "^4.10.0",
+    "webpack-dev-middleware": "^5.3.3",
+    "webpack-hot-middleware": "^2.25.3",
+    "webpack-hot-server-middleware": "^0.6.1",
+    "webpack-notifier": "^1.15.0",
+    "ws": "^8.13.0"
+  },
+  "devDependencies": {
+    "@loadable/component": "^5.15.3",
+    "@types/archiver": "^1.3.0",
+    "@types/fs-extra": "^11.0.1",
+    "@types/git-rev-sync": "^2.0.0",
+    "@types/node-fetch": "^2.6.3",
+    "@types/validator": "^13.7.14",
+    "eslint-plugin-no-relative-import-paths": "^1.5.2",
+    "internal-lib-build": "3.0.0-preview.0",
+    "nock": "^13.3.0",
+    "nodemon": "^2.0.22",
+    "superagent": "^6.1.0",
+    "supertest": "^4.0.2",
+    "typescript": "4.8.3"
+  },
+  "overrides": {
+    "nwsapi": "2.2.2"
+  },
+  "peerDependencies": {
+    "@loadable/component": "^5.15.0",
+    "typescript": ">=4.8.3"
+  },
+  "peerDependenciesMeta": {
+    "@loadable/component": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": "^16.11.0 || ^18.0.0",
+    "npm": "^8.0.0 || ^9.0.0"
+  },
+  "publishConfig": {
+    "directory": "dist"
+  },
+  "gitHead": "a9f820893b7714244a0af509a5aefecc1344153c"
+}

package/scripts/version.js

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+/* eslint-disable @typescript-eslint/no-var-requires */
+// Update Change Log heading
+const pkg = require('../package.json')
+const path = require('path')
+const os = require('os')
+const fs = require('fs')
+
+const date = new Date().toString().split(' ').slice(1, 4)
+const heading = `## v${pkg.version} (${date[0]} ${date[1]}, ${date[2]})\n`
+
+const changelog = path.resolve(os.tmpdir(), 'CHANGELOG.md')
+
+fs.writeFileSync(changelog, heading, 'utf8')
+fs.appendFileSync(changelog, fs.readFileSync('CHANGELOG.md'), 'utf8')
+fs.copyFileSync(changelog, 'CHANGELOG.md')