@zimbra/zimlet-cli 13.0.0 → 14.0.0

package/dist/commands/package.js

@@ -37,13 +37,12 @@ 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.',
@@ -68,11 +67,21 @@ var _default = (0, _asyncCommand.default)({
 
     let builddir = _path.default.resolve(cwd, argv.builddir || 'build');
 
-    let dest = _path.default.resolve(cwd, argv.dest || 'pkg', `${argv.name}.zip`); // Create the xml descriptor file for the zimlet
+    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="${argv.description}" label="${argv.label}" zimbraXZimletCompatibleSemVer="${argv.zimbraXVersion}">`;
+    let zimletXML = `<zimlet name="${argv.name}" version="${argv.pkgVersion}" description="${description}" label="${label}" zimbraXZimletCompatibleSemVer="${argv.zimbraXVersion}">`;
     let files;
 
     try {
@@ -81,7 +90,7 @@ var _default = (0, _asyncCommand.default)({
       return (0, _util.error)(`Failed to read ${builddir}: ${err}`, 1);
     }
 
-    files.forEach(file => {
+    files.filter(file => !file.match(/\.properties$/)).forEach(file => {
       if (file.match(/\.js$/)) {
         zimletXML += `\n\t<include>${file}</include>`;
       } else if (file.match(/\.css$/)) {
@@ -96,21 +105,9 @@ var _default = (0, _asyncCommand.default)({
       _fs.default.writeFileSync(_path.default.resolve(builddir, xmlFile), zimletXML);
     } catch (err) {
       return (0, _util.error)(`Failed to write XML file: ${err}`, 1);
-    } // Add properties file for description and label
-    // As admin console requires properties file to display label and desciption
-
-
-    let propertiesFile = `${argv.name}.properties`;
-    let zimletProperties = '\n';
-    zimletProperties += `label = ${argv.label}\n`;
-    zimletProperties += `description = ${argv.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);
-    } //Zip up the contents of the build dir along with the xml file as the final zimlet deliverable
+    }
 
+    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, '');
@@ -121,4 +118,86 @@ var _default = (0, _asyncCommand.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/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@zimbra/zimlet-cli",
-  "version": "13.0.0",
+  "version": "14.0.0",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zimbra/zimlet-cli",
-  "version": "13.0.0",
+  "version": "14.0.0",
   "description": "Develop, Build, and Package Zimbra X compatible zimlets for development and production.",
   "main": "dist/index.js",
   "bin": {