@zimbra/zimlet-cli 12.13.0 → 14.2.0

package/dist/commands/package.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports["default"] = void 0;
+exports.default = void 0;
 
 var _fs = _interopRequireDefault(require("fs"));
 
@@ -15,13 +15,9 @@ var _util = require("../util");
 
 var _asyncCommand = _interopRequireDefault(require("../lib/async-command"));
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
-
-function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
-
-var _default = (0, _asyncCommand["default"])({
+var _default = (0, _asyncCommand.default)({
   command: 'package',
   desc: 'Package a zimlet for deployment',
   builder: {
@@ -41,22 +37,21 @@ var _default = (0, _asyncCommand["default"])({
     description: {
       alias: 'desc',
       description: 'Description for your zimlet',
-      demandOption: true,
-      requiresArg: true
+      default: null
     },
     label: {
       alias: 'l',
       description: 'Display name for your zimlet',
-      demandOption: true
+      default: null
     },
     zimbraXVersion: {
       description: 'https://semver.org version range of Zimbra X that the Zimlet is compatible with.',
-      "default": '>=1.0.0',
+      default: '>=1.0.0',
       requiresArg: true
     },
     builddir: {
       alias: 'b',
-      "default": './build',
+      default: './build',
       description: 'Source directory of built artifacts to publish'
     },
     dest: {
@@ -65,88 +60,144 @@ var _default = (0, _asyncCommand["default"])({
       description: 'Directory for packaged artifacts'
     }
   },
-  handler: function handler(argv) {
-    return _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
-      var cwd, builddir, dest, xmlFile, zimletXML, files, propertiesFile, zimletProperties, zipFile;
-      return regeneratorRuntime.wrap(function _callee$(_context) {
-        while (1) {
-          switch (_context.prev = _context.next) {
-            case 0:
-              // normalize built files source directory and desination package dir
-              cwd = process.cwd();
-              builddir = _path["default"].resolve(cwd, argv.builddir || 'build');
-              dest = _path["default"].resolve(cwd, argv.dest || 'pkg', "".concat(argv.name, ".zip")); // Create the xml descriptor file for the zimlet
-
-              xmlFile = "".concat(argv.name, ".xml");
-              zimletXML = "<zimlet name=\"".concat(argv.name, "\" version=\"").concat(argv.pkgVersion, "\" description=\"").concat(argv.description, "\" label=\"").concat(argv.label, "\" zimbraXZimletCompatibleSemVer=\"").concat(argv.zimbraXVersion, "\">");
-              _context.prev = 5;
-              files = _fs["default"].readdirSync(builddir);
-              _context.next = 12;
-              break;
-
-            case 9:
-              _context.prev = 9;
-              _context.t0 = _context["catch"](5);
-              return _context.abrupt("return", (0, _util.error)("Failed to read ".concat(builddir, ": ").concat(_context.t0), 1));
-
-            case 12:
-              files.forEach(function (file) {
-                if (file.match(/\.js$/)) {
-                  zimletXML += "\n\t<include>".concat(file, "</include>");
-                } else if (file.match(/\.css$/)) {
-                  zimletXML += "\n\t<includeCSS>".concat(file, "</includeCSS>");
-                } else if (file !== xmlFile) {
-                  zimletXML += "\n\t<resource>".concat(file, "</resource>");
-                }
-              });
-              zimletXML += '\n</zimlet>';
-              _context.prev = 14;
-
-              _fs["default"].writeFileSync(_path["default"].resolve(builddir, xmlFile), zimletXML);
-
-              _context.next = 21;
-              break;
-
-            case 18:
-              _context.prev = 18;
-              _context.t1 = _context["catch"](14);
-              return _context.abrupt("return", (0, _util.error)("Failed to write XML file: ".concat(_context.t1), 1));
-
-            case 21:
-              // Add properties file for description and label
-              // As admin console requires properties file to display label and desciption
-              propertiesFile = "".concat(argv.name, ".properties");
-              zimletProperties = '\n';
-              zimletProperties += "label = ".concat(argv.label, "\n");
-              zimletProperties += "description = ".concat(argv.description, "\n");
-              _context.prev = 25;
-
-              _fs["default"].writeFileSync(_path["default"].resolve(builddir, propertiesFile), zimletProperties);
-
-              _context.next = 32;
-              break;
-
-            case 29:
-              _context.prev = 29;
-              _context.t2 = _context["catch"](25);
-              return _context.abrupt("return", (0, _util.error)("Failed to write properties file: ".concat(_context.t2), 1));
-
-            case 32:
-              //Zip up the contents of the build dir along with the xml file as the final zimlet deliverable
-              zipFile = new _admZip["default"]();
-              zipFile.addLocalFolder(builddir, '');
-              zipFile.writeZip(dest);
-              return _context.abrupt("return", "Successfully packaged zimlet to: ".concat(dest, "\n"));
-
-            case 36:
-            case "end":
-              return _context.stop();
-          }
-        }
-      }, _callee, null, [[5, 9], [14, 18], [25, 29]]);
-    }))();
+
+  async handler(argv) {
+    // normalize built files source directory and desination package dir
+    let cwd = process.cwd();
+
+    let builddir = _path.default.resolve(cwd, argv.builddir || 'build');
+
+    let dest = _path.default.resolve(cwd, argv.dest || 'pkg', `${argv.name}.zip`); // Get label and description from src/intl/en_US.json or from argument
+
+
+    const {
+      label,
+      description
+    } = getZimletLabelDescription() || argv;
+
+    if (!(label && description)) {
+      return (0, _util.error)('label and description string are not provided as argument');
+    } // Create the xml descriptor file for the zimlet
+
+
+    let xmlFile = `${argv.name}.xml`;
+    let zimletXML = `<zimlet name="${argv.name}" version="${argv.pkgVersion}" description="${description}" label="${label}" zimbraXZimletCompatibleSemVer="${argv.zimbraXVersion}">`;
+    let files;
+
+    try {
+      files = _fs.default.readdirSync(builddir);
+    } catch (err) {
+      return (0, _util.error)(`Failed to read ${builddir}: ${err}`, 1);
+    }
+
+    files.filter(file => !file.match(/\.properties$/)).forEach(file => {
+      if (file.match(/\.js$/)) {
+        zimletXML += `\n\t<include>${file}</include>`;
+      } else if (file.match(/\.css$/)) {
+        zimletXML += `\n\t<includeCSS>${file}</includeCSS>`;
+      } else if (file !== xmlFile) {
+        zimletXML += `\n\t<resource>${file}</resource>`;
+      }
+    });
+    zimletXML += '\n</zimlet>';
+
+    try {
+      _fs.default.writeFileSync(_path.default.resolve(builddir, xmlFile), zimletXML);
+    } catch (err) {
+      return (0, _util.error)(`Failed to write XML file: ${err}`, 1);
+    }
+
+    createLocalizationFiles(argv.name, label, description); //Zip up the contents of the build dir along with the xml file as the final zimlet deliverable
+
+    let zipFile = new _admZip.default();
+    zipFile.addLocalFolder(builddir, '');
+    zipFile.writeZip(dest);
+    return `Successfully packaged zimlet to: ${dest}\n`;
   }
+
 });
 
-exports["default"] = _default;
+exports.default = _default;
+
+function getZimletLabelDescription() {
+  const intlDir = _path.default.resolve(process.cwd(), 'src', 'intl');
+
+  try {
+    const content = JSON.parse(_fs.default.readFileSync(_path.default.resolve(intlDir, 'en_US.json')));
+
+    if (!(content.zimlet?.label && content.zimlet?.description)) {
+      throw new Error('label or description not found');
+    }
+
+    return {
+      label: content.zimlet.label,
+      description: content.zimlet.description
+    };
+  } catch (err) {
+    (0, _util.warn)(`Failed to read src/intl/en_US.json file: ${err}. \nMake sure below content present in src/intl/en_US.json file \n
+		"zimlet": {
+			"label": "<zimlet label>",
+			"description": "<zimlet description>"
+		} \nAs a fallback we are using strings from package.json which is deprecated.\n`);
+    return null;
+  }
+} // Add properties file for description and label
+// As admin console requires properties file to display label and desciption
+
+
+function createLocalizationFiles(zimletName, label, description) {
+  const cwd = process.cwd();
+
+  const intlDir = _path.default.resolve(cwd, 'src', 'intl');
+
+  let intlFiles;
+  createPropertyFile(zimletName, label, description);
+
+  try {
+    intlFiles = _fs.default.readdirSync(intlDir);
+  } catch (err) {
+    console.error(`Failed to read ${intlDir}: ${err}`, 1);
+  }
+
+  intlFiles.filter(file => file.match(/\.json$/) && !file.includes('en_US')).forEach(intl => {
+    try {
+      const content = JSON.parse(_fs.default.readFileSync(_path.default.resolve(intlDir, intl)));
+      const propertiesFileName = `${zimletName}_${intl.replace('.json', '')}`;
+      const labelValue = getUnicode(content.zimlet?.label || '');
+      const descriptionValue = getUnicode(content.zimlet?.description || '');
+      createPropertyFile(propertiesFileName, labelValue, descriptionValue);
+    } catch (ex) {
+      (0, _util.error)(`Error while reading file: ${ex}`, 1);
+    }
+  });
+}
+
+function createPropertyFile(fileName, label, description) {
+  const builddir = _path.default.resolve(process.cwd(), 'build');
+
+  const propertiesFile = `${fileName}.properties`;
+  let zimletProperties = '\n';
+  zimletProperties += `label = ${label}\n`;
+  zimletProperties += `description = ${description}\n`;
+
+  try {
+    _fs.default.writeFileSync(_path.default.resolve(builddir, propertiesFile), zimletProperties);
+  } catch (err) {
+    return (0, _util.error)(`Failed to write properties file: ${err}`, 1);
+  }
+}
+
+function getUnicode(txt) {
+  let hex = '';
+  if (txt.length === 0) return;
+
+  for (let i = 0; i < txt.length; i++) {
+    const h = txt.codePointAt(i).toString(16);
+    hex += '\\u' + h.padStart(4, 0);
+    if (h.length > 4) i++;
+  }
+
+  return hex;
+}
+
 module.exports = exports.default;

package/dist/entry.js

@@ -3,16 +3,18 @@
 /** This is the real webpack entry file. It manages setting up the zimlet and HMR.
  *  The user-defined entry file (index.js) is imported here via a `zimlet-cli-entrypoint` alias.
  */
-(function () {
+(() => {
   function init() {
-    zimlet(function (context) {
-      var zimbra = context.zimbra,
-          config = context.config,
-          plugins = context.plugins,
-          shims = context.shims,
-          components = context.components,
-          store = context.store,
-          meta = context.meta; // Add shims to the global scope to expose dependencies to Zimlets
+    zimlet(context => {
+      let {
+        zimbra,
+        config,
+        plugins,
+        shims,
+        components,
+        store,
+        meta
+      } = context; // Add shims to the global scope to expose dependencies to Zimlets
       // Shimmed dependencies include preact, preact-router, react-apollo
 
       global.shims = shims;
@@ -24,11 +26,11 @@
       global.ZIMLET_STYLES = [];
       global.meta = meta;
 
-      var entry = require('zimlet-cli-entrypoint');
+      let entry = require('zimlet-cli-entrypoint');
 
-      var r = entry && entry["default"] || entry; // If export is a factory, pass it context. Otherwise it's a singleton.
+      let r = entry && entry.default || entry; // If export is a factory, pass it context. Otherwise it's a singleton.
 
-      var instance = typeof r === 'function' ? r(context) : r;
+      let instance = typeof r === 'function' ? r(context) : r;
       context.styles.set(global.ZIMLET_STYLES.join('\n'));
       return instance;
     });