babel-plugin-hylid-bridge 2.10.0 → 2.11.1

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.11.0] (2023-03-01)
+
+**Note:** Version bump only for package babel-plugin-hylid-bridge
+
+
+
+
+
 ## [2.10.0] (2023-02-22)
 
 **Note:** Version bump only for package babel-plugin-hylid-bridge

package/lib/getLibraryDir.d.ts

@@ -0,0 +1 @@
+export default function getLibraryDir(): string;

package/lib/getLibraryDir.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = getLibraryDir;
+var _utils = require("./utils");
+var libraryDir;
+function getLibraryDir() {
+  if (!libraryDir) {
+    var cwd = process.cwd();
+    try {
+      libraryDir = process.env.HYLID_BRIDGE_PACKAGE_DIR || require.resolve('hylid-bridge/package.json', {
+        paths: [cwd]
+      }).replace('package.json', '');
+      (0, _utils.log)("Find the hylid-bridge package: ".concat(libraryDir));
+    } catch (e) {
+      (0, _utils.error)("Can not resolve the hylid-bridge package from the directory: ".concat(cwd, "."), e);
+    }
+  }
+  return libraryDir;
+}

package/lib/index.d.ts

@@ -0,0 +1,7 @@
+import type babelCore from '@babel/core';
+import { PluginPass } from '@babel/core';
+interface IState extends PluginPass {
+    usedJSAPIList: 'all' | string[];
+}
+declare const _default: (core: typeof babelCore, opts?: Record<string, any>) => babelCore.PluginObj<IState>;
+export default _default;

package/lib/index.js

@@ -0,0 +1,241 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+var _path = _interopRequireDefault(require("path"));
+var _fsExtra = _interopRequireDefault(require("fs-extra"));
+var _lodash = _interopRequireDefault(require("lodash"));
+var babelTypes = _interopRequireWildcard(require("@babel/types"));
+var _getLibraryDir = _interopRequireDefault(require("./getLibraryDir"));
+var utils = _interopRequireWildcard(require("./utils"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(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; }
+/**
+ * https://astexplorer.net/
+ */
+
+var identifierPrefix = '__hylid_bridge__';
+var libraryName = 'hylid-bridge';
+var libraryDir = (0, _getLibraryDir.default)();
+function snakeCaseTarget(value) {
+  if (value === 'H5') {
+    return 'h5';
+  }
+  return _lodash.default.snakeCase(value);
+}
+function isTargetSupported(target) {
+  var libraryDir = (0, _getLibraryDir.default)();
+  return ['MpWeb', 'Mp', 'Web'].some(function (prefix) {
+    if (target.startsWith(prefix)) {
+      var targetClientDir = _path.default.resolve(libraryDir, 'lib/clients', snakeCaseTarget(prefix), snakeCaseTarget(target.replace(prefix, '')));
+      return _fsExtra.default.existsSync(targetClientDir);
+    }
+    return false;
+  });
+}
+function getTargets(customTargets) {
+  var targets = customTargets || (process.env.HYLID_BRIDGE_TARGETS ? process.env.HYLID_BRIDGE_TARGETS.split(',') : []);
+  return targets.filter(isTargetSupported);
+}
+function isApiExists(name, target) {
+  var targetSplit = splitTarget(target);
+  if (targetSplit.length !== 2) {
+    throw new Error("Wrong target configuration: ".concat(target, "."));
+  }
+  return _fsExtra.default.existsSync(_path.default.resolve(libraryDir, "./lib/clients/".concat(targetSplit[0], "/").concat(targetSplit[1], "/").concat(name, ".js")));
+}
+function getUserAppEnvPath(appEnvPath) {
+  var realAppEnvPath = appEnvPath !== null && appEnvPath !== void 0 ? appEnvPath : _path.default.resolve(process.cwd(), './src/appEnv.ts');
+  if (!_fsExtra.default.existsSync(realAppEnvPath)) {
+    utils.log("Can not find the appEnv module at the path: ".concat(realAppEnvPath, "."));
+    return;
+  }
+  return realAppEnvPath;
+}
+function splitTarget(target) {
+  var prefixList = ['MpWeb', 'Mp', 'Web'];
+  for (var i = 0, il = prefixList.length; i < il; i++) {
+    var prefix = prefixList[i];
+    if (target.startsWith(prefix)) {
+      return [snakeCaseTarget(prefix), snakeCaseTarget(target.replace(prefix, ''))];
+    }
+  }
+  throw new Error("Invalid bridge target: ".concat(target, "."));
+}
+var myLocalName = "".concat(identifierPrefix, "my__");
+function getNames(node, scope, state, targets) {
+  var _state$filename;
+  if (node.object.type === 'Identifier' && node.property.type === 'Identifier' &&
+  // Remix 中会编译所有 node_modules 下的模块
+  !((_state$filename = state.filename) !== null && _state$filename !== void 0 && _state$filename.includes("".concat(_path.default.sep, "node_modules").concat(_path.default.sep, "hylid-bridge").concat(_path.default.sep))) && targets && targets.length && !scope.hasBinding('my')) {
+    return {
+      objectName: node.object.name,
+      propertyName: node.property.name
+    };
+  }
+  return {
+    objectName: undefined,
+    propertyName: undefined
+  };
+}
+function isJSAPIInTargets(jsapiName, targets, filename) {
+  return targets.every(function (target) {
+    var targetSplit = splitTarget(target);
+    if (!isApiExists(jsapiName, target)) {
+      utils.warn("Can not find the API `".concat(jsapiName, "` in `").concat(_path.default.resolve(libraryDir, './lib/clients/' + targetSplit[0] + '/' + targetSplit[1]), "`. Fallback to import all API codes of ").concat(target, ". Current file path: `").concat(filename, "`."));
+      return false;
+    }
+    return true;
+  });
+}
+var _default = function _default(core, opts) {
+  var targets = getTargets(opts === null || opts === void 0 ? void 0 : opts.targets);
+  var userAppEnvPath = getUserAppEnvPath(opts === null || opts === void 0 ? void 0 : opts.appEnvPath);
+  return {
+    name: 'babel-plugin-hylid-bridge',
+    visitor: {
+      MemberExpression: function MemberExpression(path, state) {
+        var _getNames = getNames(path.node, path.scope, state, targets),
+          objectName = _getNames.objectName,
+          propertyName = _getNames.propertyName;
+        if (!propertyName || propertyName === 'call' || objectName !== 'my') {
+          return;
+        }
+        var newNode = core.types.cloneNode(path.node, true, true);
+        newNode.object = core.types.identifier(myLocalName);
+        if (state.usedJSAPIList === 'all') {
+          path.replaceWith(newNode);
+          return;
+        }
+        if (path.node.computed) {
+          state.usedJSAPIList = 'all';
+          utils.warn("Detect visiting the property of `my` with computed mode: my[".concat(propertyName, "]. Fallback to import all API codes of ").concat(targets.join(','), ". Current file path: `").concat(state.filename, "`."));
+        } else {
+          state.usedJSAPIList = state.usedJSAPIList || [];
+          var name = propertyName;
+          if (isJSAPIInTargets(name, targets, state.filename)) {
+            state.usedJSAPIList.push(name);
+          } else {
+            state.usedJSAPIList = 'all';
+          }
+        }
+        path.replaceWith(newNode);
+      },
+      CallExpression: function CallExpression(path, state) {
+        if (path.node.callee.type !== 'MemberExpression') {
+          return;
+        }
+        var _getNames2 = getNames(path.node.callee, path.scope, state, targets),
+          objectName = _getNames2.objectName,
+          propertyName = _getNames2.propertyName;
+        if (objectName !== 'my' || propertyName !== 'call' || !path.node.arguments[0] || path.node.arguments[0].type !== 'StringLiteral') {
+          return;
+        }
+        var newNode = core.types.callExpression(babelTypes.memberExpression(babelTypes.identifier(myLocalName), babelTypes.identifier(path.node.arguments[0].value)), path.node.arguments.slice(1));
+        if (state.usedJSAPIList === 'all') {
+          path.replaceWith(newNode);
+          return;
+        }
+        state.usedJSAPIList = state.usedJSAPIList || [];
+        var name = path.node.arguments[0].value;
+        if (isJSAPIInTargets(name, targets, state.filename)) {
+          state.usedJSAPIList.push(name);
+        } else {
+          state.usedJSAPIList = 'all';
+        }
+        path.replaceWith(newNode);
+      },
+      Program: {
+        exit: function exit(path, state) {
+          if (!state.usedJSAPIList) {
+            return;
+          }
+          var usedJSAPIList = state.usedJSAPIList || [];
+          var appEnvLocalName = "".concat(identifierPrefix, "appEnv__");
+          if (path.scope.hasBinding(appEnvLocalName)) {
+            return;
+          }
+          var innerAppEnvLocalName = "".concat(identifierPrefix, "innerAppEnv__");
+          var userAppEnvLocalName = "".concat(identifierPrefix, "userAppEnv__");
+          var nodes = [babelTypes.importDeclaration([babelTypes.importDefaultSpecifier(babelTypes.identifier(innerAppEnvLocalName))], babelTypes.stringLiteral("".concat(libraryName, "/lib/appEnv")))];
+          if (userAppEnvPath) {
+            var relativePath = _path.default.relative(_path.default.dirname(state.filename), userAppEnvPath.replace(/\.ts$/, ''));
+            nodes.push(babelTypes.importDeclaration([babelTypes.importDefaultSpecifier(babelTypes.identifier(userAppEnvLocalName))], babelTypes.stringLiteral(relativePath.startsWith('../') ? relativePath : "./".concat(relativePath))));
+          } else {
+            nodes.push(babelTypes.variableDeclaration('var', [babelTypes.variableDeclarator(babelTypes.identifier(userAppEnvLocalName), babelTypes.objectExpression([]))]));
+          }
+          var objectSpreadName = "".concat(identifierPrefix, "objectSpread__");
+          nodes.push(babelTypes.importDeclaration([babelTypes.importDefaultSpecifier(babelTypes.identifier(objectSpreadName))], babelTypes.stringLiteral("".concat(libraryName, "/lib/objectSpread"))), babelTypes.variableDeclaration('var', [babelTypes.variableDeclarator(babelTypes.identifier(appEnvLocalName), babelTypes.callExpression(babelTypes.identifier(objectSpreadName), [babelTypes.identifier(innerAppEnvLocalName), babelTypes.identifier(userAppEnvLocalName)]))]));
+          if (usedJSAPIList === 'all') {
+            nodes.push.apply(nodes, (0, _toConsumableArray2.default)(targets.map(function (target) {
+              var targetSplit = splitTarget(target);
+              return babelTypes.importDeclaration([babelTypes.importDefaultSpecifier(babelTypes.identifier("".concat(identifierPrefix).concat(targetSplit[0], "_").concat(targetSplit[1], "_my__")))], babelTypes.stringLiteral("".concat(libraryName, "/lib/clients/").concat(targetSplit[0], "/").concat(targetSplit[1], "/index")));
+            })));
+            var buildElseIf = function buildElseIf(targetList) {
+              if (!targetList.length) {
+                return;
+              }
+              var target = targetList[0];
+              var targetSplit = splitTarget(target);
+              return babelTypes.ifStatement(babelTypes.identifier("".concat(appEnvLocalName, ".").concat(_lodash.default.camelCase("is_".concat(targetSplit[0], "_").concat(targetSplit[1])))), babelTypes.blockStatement([babelTypes.expressionStatement(babelTypes.assignmentExpression('=', babelTypes.identifier(myLocalName), babelTypes.identifier("".concat(identifierPrefix).concat(targetSplit[0], "_").concat(targetSplit[1], "_my__"))))]), buildElseIf(targetList.slice(1)));
+            };
+            nodes.push(babelTypes.variableDeclaration('var', [babelTypes.variableDeclarator(babelTypes.identifier(myLocalName))]));
+            // Do not generate the `if statement` when there is just one target.
+            if (targets.length === 1) {
+              var targetSplit = splitTarget(targets[0]);
+              nodes.push(babelTypes.expressionStatement(babelTypes.assignmentExpression('=', babelTypes.identifier(myLocalName), babelTypes.identifier("".concat(identifierPrefix).concat(targetSplit[0], "_").concat(targetSplit[1], "_my__")))));
+            } else {
+              var elseIfNode = buildElseIf(targets);
+              elseIfNode && nodes.push(elseIfNode);
+            }
+          } else if (usedJSAPIList.length) {
+            var normalizedJSAPIList = _lodash.default.uniq(usedJSAPIList);
+            normalizedJSAPIList.forEach(function (name) {
+              targets.forEach(function (target) {
+                var targetSplit = splitTarget(target);
+                var localName = "".concat(identifierPrefix).concat(targetSplit[0], "_").concat(targetSplit[1], "_").concat(name, "__");
+                var n = babelTypes.importDeclaration([babelTypes.importDefaultSpecifier(babelTypes.identifier(localName))], babelTypes.stringLiteral("".concat(libraryName, "/lib/clients/").concat(targetSplit[0], "/").concat(targetSplit[1], "/").concat(name)));
+                nodes.push(n);
+              });
+            });
+            var _buildElseIf = function _buildElseIf(targetList) {
+              if (!targetList.length) {
+                return;
+              }
+              var target = targetList[0];
+              var targetSplit = splitTarget(target);
+              var propertyList = normalizedJSAPIList.map(function (name) {
+                return babelTypes.objectProperty(babelTypes.identifier(name), babelTypes.identifier("".concat(identifierPrefix).concat(targetSplit[0], "_").concat(targetSplit[1], "_").concat(name, "__")));
+              });
+              return babelTypes.ifStatement(babelTypes.identifier("".concat(appEnvLocalName, ".").concat(_lodash.default.camelCase("is_".concat(targetSplit[0], "_").concat(targetSplit[1])))), babelTypes.blockStatement([babelTypes.expressionStatement(babelTypes.assignmentExpression('=', babelTypes.identifier(myLocalName), babelTypes.objectExpression(propertyList)))]), _buildElseIf(targetList.slice(1)));
+            };
+            nodes.push(babelTypes.variableDeclaration('var', [babelTypes.variableDeclarator(babelTypes.identifier(myLocalName))]));
+            // Do not generate the `if statement` when there is just one target.
+            if (targets.length === 1) {
+              var _targetSplit = splitTarget(targets[0]);
+              var propertyList = normalizedJSAPIList.map(function (name) {
+                return babelTypes.objectProperty(babelTypes.identifier(name), babelTypes.identifier("".concat(identifierPrefix).concat(_targetSplit[0], "_").concat(_targetSplit[1], "_").concat(name, "__")));
+              });
+              nodes.push(babelTypes.expressionStatement(babelTypes.assignmentExpression('=', babelTypes.identifier(myLocalName), babelTypes.objectExpression(propertyList))));
+            } else {
+              var _elseIfNode = _buildElseIf(targets);
+              _elseIfNode && nodes.push(_elseIfNode);
+            }
+          }
+          if (nodes.length) {
+            path.unshiftContainer('body', nodes);
+          }
+          if (targets.length && (usedJSAPIList === 'all' || usedJSAPIList.length)) {
+            utils.log("Successfully inject the Hylid-bridge into ".concat(state.filename, " to support the targets: ").concat(targets.join(','), "."));
+          }
+        }
+      }
+    }
+  };
+};
+exports.default = _default;

package/lib/utils.d.ts

@@ -0,0 +1,3 @@
+export declare function log(...args: Parameters<typeof console.log>): void;
+export declare function error(...args: Parameters<typeof console.error>): void;
+export declare function warn(...args: Parameters<typeof console.error>): void;

package/lib/utils.js

@@ -0,0 +1,31 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.error = error;
+exports.log = log;
+exports.warn = warn;
+var _chalk = _interopRequireDefault(require("chalk"));
+function log() {
+  var _console;
+  for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+    args[_key] = arguments[_key];
+  }
+  (_console = console).log.apply(_console, [_chalk.default.bold.green('[LOG]')].concat(args));
+}
+function error() {
+  var _console2;
+  for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
+    args[_key2] = arguments[_key2];
+  }
+  (_console2 = console).error.apply(_console2, [_chalk.default.bold.red('[ERROR]')].concat(args));
+}
+function warn() {
+  var _console3;
+  for (var _len3 = arguments.length, args = new Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
+    args[_key3] = arguments[_key3];
+  }
+  (_console3 = console).error.apply(_console3, [_chalk.default.bold.yellow('[WARN]')].concat(args));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "babel-plugin-hylid-bridge",
-  "version": "2.10.0",
+  "version": "2.11.1",
   "description": "babel-plugin-hylid-bridge",
   "main": "lib/index.js",
   "files": [