@zohodesk/react-cli 1.1.14 → 1.1.15-exp.1

package/packages/client_build_tool/lib/schemas/applyValuesToSchema/__test__/replacingSchemaValueByProcessEnv/convertUndefinedAndNull.test.js

@@ -0,0 +1,138 @@
+"use strict";
+
+var _index = require("../../index");
+
+describe('replacing schema value by processEnv from undefined to other data types', () => {
+  const schema = {
+    firstData: {
+      cli: 'first',
+      value: undefined
+    }
+  };
+  const customOptions = {};
+  it('to string', () => {
+    const processEnv = {
+      first: 'ONE'
+    };
+    const output = (0, _index.applyValuesToSchema)(schema, customOptions, processEnv);
+    expect(output).toStrictEqual({
+      firstData: 'ONE'
+    });
+  });
+  it('to number', () => {
+    const processEnv = {
+      first: 28
+    };
+    const output = (0, _index.applyValuesToSchema)(schema, customOptions, processEnv);
+    expect(output).toStrictEqual({
+      firstData: 28
+    });
+  });
+  it('to array', () => {
+    const processEnv = {
+      first: [1, 2, 3]
+    };
+    const output = (0, _index.applyValuesToSchema)(schema, customOptions, processEnv);
+    expect(output).toStrictEqual({
+      firstData: [1, 2, 3]
+    });
+  });
+  it('to object', () => {
+    const processEnv = {
+      first: {
+        hi: 'buddy'
+      }
+    };
+    const output = (0, _index.applyValuesToSchema)(schema, customOptions, processEnv);
+    expect(output).toStrictEqual({
+      firstData: {
+        hi: 'buddy'
+      }
+    });
+  });
+  it('to null', () => {
+    const processEnv = {
+      first: null
+    };
+    const output = (0, _index.applyValuesToSchema)(schema, customOptions, processEnv);
+    expect(output).toStrictEqual({
+      firstData: undefined
+    });
+  });
+  it('to NaN', () => {
+    const processEnv = {
+      first: NaN
+    };
+    const output = (0, _index.applyValuesToSchema)(schema, customOptions, processEnv);
+    expect(output).toStrictEqual({
+      firstData: NaN
+    });
+  });
+});
+describe('replacing schema value by processEnv from null to other data types', () => {
+  const schema = {
+    firstData: {
+      cli: 'first',
+      value: null
+    }
+  };
+  const customOptions = {};
+  it('to string', () => {
+    const processEnv = {
+      first: 'ONE'
+    };
+    const output = (0, _index.applyValuesToSchema)(schema, customOptions, processEnv);
+    expect(output).toStrictEqual({
+      firstData: 'ONE'
+    });
+  });
+  it('to number', () => {
+    const processEnv = {
+      first: 28
+    };
+    const output = (0, _index.applyValuesToSchema)(schema, customOptions, processEnv);
+    expect(output).toStrictEqual({
+      firstData: 28
+    });
+  });
+  it('toC array', () => {
+    const processEnv = {
+      first: [1, 2, 3]
+    };
+    const output = (0, _index.applyValuesToSchema)(schema, customOptions, processEnv);
+    expect(output).toStrictEqual({
+      firstData: [1, 2, 3]
+    });
+  });
+  it('to object', () => {
+    const processEnv = {
+      first: {
+        hi: 'buddy'
+      }
+    };
+    const output = (0, _index.applyValuesToSchema)(schema, customOptions, processEnv);
+    expect(output).toStrictEqual({
+      firstData: {
+        hi: 'buddy'
+      }
+    });
+  });
+  it('to undefined', () => {
+    const processEnv = {
+      first: undefined
+    };
+    const output = (0, _index.applyValuesToSchema)(schema, customOptions, processEnv);
+    expect(output).toStrictEqual({
+      firstData: null
+    });
+  });
+  it('to NaN', () => {
+    const processEnv = {
+      first: NaN
+    };
+    const output = (0, _index.applyValuesToSchema)(schema, customOptions, processEnv);
+    expect(output).toStrictEqual({
+      firstData: NaN
+    });
+  });
+});

package/packages/client_build_tool/lib/schemas/applyValuesToSchema/index.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.applyValuesToSchema = applyValuesToSchema;
+
+var _isObject = require("./isObject");
+
+var _isValid = require("./isValid");
+
+function applyValuesToSchema(schemas, customOptions, processEnv) {
+  const output = {};
+
+  function decideValue(schema, key, customOptions) {
+    const specificSchema = schema[key];
+    const correspondingValue = customOptions && customOptions[key];
+
+    if ((0, _isObject.isObject)(specificSchema)) {
+      if (typeof specificSchema.cli === 'string') {
+        return processEnv[specificSchema.cli] ?? (0, _isValid.isValid)(correspondingValue, specificSchema.value);
+      }
+
+      return applyValuesToSchema(specificSchema, correspondingValue, processEnv);
+    }
+
+    return (0, _isValid.isValid)(correspondingValue, specificSchema);
+  }
+
+  Object.keys(schemas).forEach(key => {
+    output[key] = decideValue(schemas, key, customOptions);
+  });
+  return output;
+}

package/packages/client_build_tool/lib/schemas/applyValuesToSchema/isObject.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isObject = isObject;
+
+function isObject(obj) {
+  return obj !== null && typeof obj === 'object' && !Array.isArray(obj);
+}

package/packages/client_build_tool/lib/schemas/applyValuesToSchema/isValid.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isValid = isValid;
+
+function isValid(correspondingValue, specificSchema) {
+  if (typeof correspondingValue === 'number' && Number.isNaN(correspondingValue)) {
+    return specificSchema;
+  }
+
+  return correspondingValue ?? specificSchema;
+}

package/packages/client_build_tool/lib/schemas/cliArgsToObject.js

@@ -0,0 +1,39 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.cliArgsToObject = cliArgsToObject;
+
+var _giveDefaultValue = require("./giveDefaultValue");
+
+/**
+ * experimental argument parsing logic
+ * @param {Array} cliArgs is when we use cli the options or args
+ *
+ * cliArgs:-
+ *  `cbt start --port=2332 --mode=prod` in this command
+ * ['--port=2332', '--mode=prod'] these are cliArgs
+ * 
+ * return {"port": 2332, "mode":"prod"}
+ */
+function cliArgsToObject(cliArgs) {
+  const processEnv = {};
+  cliArgs.forEach(option => {
+    if (/^--./.test(option)) {
+      const equIndex = option.indexOf('='); // equIndex = equIndex === -1 ? option.length : equIndex;
+
+      let key = option.slice(2, equIndex);
+      let value = (0, _giveDefaultValue.giveDefaultValue)(option.slice(equIndex + 1));
+
+      if (equIndex === -1) {
+        key = option.slice(2);
+        value = true;
+      }
+
+      key = key.replace(/-|:/g, '_');
+      processEnv[key] = value;
+    }
+  });
+  return processEnv;
+}

package/packages/client_build_tool/lib/schemas/defaultConfigValues.js

@@ -0,0 +1,244 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _os = require("os");
+
+// NOTE: Don't use 'config_file' as cli option it was reserved
+var _default = {
+  context: {
+    value: 'app',
+    cli: 'context'
+  },
+  devtool: 'hidden-cheap-source-map',
+  enableChunkHash: {
+    value: false,
+    cli: 'enable_hash'
+  },
+  bundleAnalyze: {
+    value: false,
+    cli: 'bundle_analyze'
+  },
+  enableMockReplace: {
+    value: false,
+    cli: 'enable_mock_replace'
+  },
+  noPublicPath: {
+    value: false,
+    cli: 'no_public_path'
+  },
+  output: {
+    value: 'build',
+    cli: 'output'
+  },
+  mode: {
+    value: null,
+    cli: 'mode'
+  },
+  printProgress: {
+    value: false,
+    cli: 'print_progress'
+  },
+  server: {
+    httpsCerts: {
+      value: '',
+      cli: 'https_certs'
+    },
+    host: {
+      value: (0, _os.hostname)(),
+      cli: 'host'
+    },
+    port: {
+      value: 9090,
+      cli: 'port'
+    },
+    domain: {
+      value: 'tsi',
+      cli: 'domain'
+    },
+    disableContextURL: {
+      value: false,
+      cli: 'disable_context'
+    }
+  },
+  mockServer: {
+    enable: {
+      value: false,
+      cli: 'enable_mock'
+    },
+    separateSeverPort: {
+      value: null,
+      cli: 'mock_port'
+    },
+    disableNodemon: {
+      value: false,
+      cli: 'disable_nodemon'
+    },
+    mockEntryFile: 'mockapi/index.js',
+    mockPrefix: {
+      value: '/api',
+      cli: 'mock_prefix'
+    }
+  },
+  css: {
+    classNameOptions: {
+      customizations: [{
+        enable: true,
+        blob: '[local]',
+        patterns: ['*.plain.css']
+      }, {
+        enable: true,
+        blob: '[prefix]-[filename]-[local]',
+        patterns: []
+      }],
+      classNamePrefix: 'zd'
+    },
+    // NOTE: Suggestions
+    // Name Suggestions  `customizations` this will be easier then `plugin` to understand for developers
+    plugins: {
+      rtlSplit: {
+        enableRTLSplit: false,
+        templateLabel: '{{--dir}}',
+        disableMinifySelector: false,
+        dirVarName: 'document.dir'
+      },
+      selectorWeight: {
+        enable: false,
+        patterns: [],
+        configFile: null,
+        defaultSelector: '',
+        customFileDetails: '',
+        excludeStrings: []
+      },
+      // postcss plugins start
+      // NOTE: These we have putted names of post-css-plugins in array
+      // packages/client_build_tool/src/shared/bundler/webpack/custom_postcss_loaders/PostCssOptionConstants.js
+      valueReplacer: {
+        enable: false,
+        patterns: [],
+        config: []
+      },
+      selectorReplace: {
+        enable: false,
+        patterns: [],
+        before: [],
+        after: []
+      },
+      hoverActive: {
+        enable: false,
+        patterns: [],
+        hover: '(hover: hover)',
+        active: '(hover: none)'
+      },
+      cssVariableReplacement: {
+        enable: false,
+        patterns: [],
+        configFile: null
+      },
+      rtl: {
+        enable: false,
+        patterns: []
+      } // postcss - plugins end
+
+    },
+    customPlugins: []
+  },
+  i18nChunkSplit: {
+    chunkSplitEnable: {
+      value: false,
+      cli: 'i18n_split'
+    },
+    disableDefault: false,
+    templateLabel: '{{--user-locale}}',
+    localeVarName: 'document.documentElement.lang',
+    jsonpFunc: 'console.log',
+    jsResource: null,
+    propertiesFolder: null
+  },
+  publicFolders: ['...'],
+  app: {
+    entryFile: {
+      value: 'src/index.js',
+      cli: 'entry'
+    }
+  },
+  resolve: {
+    preferLocalFirst: false,
+    defaultAlias: true,
+    moduleResolvePath: {
+      value: '',
+      cli: 'module_resolve_path'
+    },
+    alias: null
+  },
+  htmlTemplate: {
+    templateFile: {
+      value: 'src/index.html',
+      cli: 'initial_html'
+    },
+    minify: null,
+    inject: true
+  },
+  efc: {
+    hasEFC: {
+      value: false,
+      cli: 'enable_efc',
+      type: 'boolean'
+    },
+    entryPointName: 'efc',
+    entryFile: {
+      value: 'src/efc.js',
+      cli: 'efc_entry'
+    },
+    version: {
+      value: 'v1',
+      cli: 'efc_version'
+    },
+    createSDkFile: {
+      value: false,
+      cli: 'create_efc_sdk'
+    },
+    templateFilePath: 'efcTemplate.js',
+    outputFile: {
+      value: 'efc-sdk-[version].js',
+      cli: 'efc_output'
+    }
+  },
+  enableSMap: {
+    value: false,
+    cli: 'source_map_enable'
+  },
+  babelCustomizations: {
+    browserList: null,
+    // NOTE: need to consider
+    // presets: [],
+    plugins: []
+  },
+  webpackPlugins: [],
+  vendorPatterns: [],
+  customChunks: [{
+    name: 'styles',
+    patterns: ['*.css']
+  }],
+  cdnMapping: {
+    isCdnEnabled: false,
+    variableName: '',
+    cssTemplate: '',
+    jsTemplate: '',
+    i18nTemplate: ''
+  },
+  manifestJson: {
+    enable: true
+  },
+  changeRuntimeChunkChar: '~',
+  serviceWorker: {
+    enable: false,
+    templateFilePath: 'sw.js',
+    outputFilePath: '/v1.js',
+    replaceText: '//<!--AssetsFromBuild -->'
+  }
+};
+exports.default = _default;

package/packages/client_build_tool/lib/schemas/defaultConfigValuesOnly.js

@@ -0,0 +1,161 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _os = require("os");
+
+// NOTE: Don't use 'config_file' as cli option it was reserved
+var _default = {
+  context: 'app',
+  devtool: 'hidden-cheap-source-map',
+  enableChunkHash: false,
+  bundleAnalyze: false,
+  enableMockReplace: false,
+  noPublicPath: false,
+  output: 'build',
+  mode: null,
+  printProgress: false,
+  server: {
+    httpsCerts: '@zohodesk-private/client_dev_cert',
+    host: (0, _os.hostname)(),
+    port: 9090,
+    domain: 'tsi',
+    disableContextURL: false
+  },
+  mockServer: {
+    enable: false,
+    separateSeverPort: 5000,
+    disableNodemon: false,
+    mockEntryFile: 'mockapi/index.js',
+    mockPrefix: '/api/'
+  },
+  css: {
+    classNameOptions: {
+      customizations: [{
+        enable: true,
+        blob: '[local]',
+        patterns: ['*.plain.css']
+      }, {
+        enable: true,
+        blob: '[prefix]-[filename]-[local]',
+        patterns: []
+      }],
+      classNamePrefix: 'zd'
+    },
+    // NOTE: Suggestions
+    // Name Suggestions  `customizations` this will be easier then `plugin` to understand for developers
+    plugins: {
+      rtlSplit: {
+        enableRTLSplit: false,
+        templateLabel: '{{--dir}}',
+        disableMinifySelector: false,
+        dirVarName: 'document.dir'
+      },
+      selectorWeight: {
+        enable: false,
+        patterns: [],
+        configFile: null,
+        defaultSelector: '',
+        customFileDetails: '',
+        excludeStrings: []
+      },
+      selectorReplace: {
+        enable: false,
+        patterns: [],
+        before: [],
+        after: []
+      },
+      hoverActive: {
+        enable: false,
+        patterns: [],
+        hover: '(hover: hover)',
+        active: '(hover: none)'
+      },
+      cssVariableReplacement: {
+        enable: false,
+        patterns: [],
+        configFile: null
+      },
+      rtl: {
+        enable: false,
+        patterns: []
+      } // postcss - plugins end
+
+    },
+    customPlugins: []
+  },
+  i18nChunkSplit: {
+    chunkSplitEnable: false,
+    disableDefault: false,
+    templateLabel: '{{--user-locale}}',
+    localeVarName: 'document.documentElement.lang',
+    jsonpFunc: 'console.log',
+    jsResource: null,
+    propertiesFolder: null
+  },
+  publicFolders: ['...', {
+    source: './deskapp/tp/',
+    target: './tp/'
+  }],
+  app: {
+    entryFile: 'src/index.js',
+    tpFolder: null,
+    moduleResolvePath: 'node_modules'
+  },
+  resolve: {
+    preferLocalFirst: false,
+    defaultAlias: true,
+    moduleResolvePath: 'node_modules',
+    alias: null
+  },
+  // EFC means Embedded Functional Components
+  efc: {
+    hasEFC: false,
+    entryPointName: 'efc',
+    entryFile: 'src/efc.js',
+    version: 'v1',
+    createSDkFile: false,
+    templateFilePath: 'efcTemplate.js',
+    outputFile: 'efc-sdk-[version].js'
+  },
+  enableSMap: false,
+  babelCustomizations: {
+    browserList: null,
+    // NOTE: need to consider
+    // presets: [],
+    plugins: []
+  },
+  webpackPlugins: [],
+  vendorPatterns: [],
+  customChunks: [{
+    name: 'styles',
+    patterns: ['*.css']
+  }],
+  htmlTemplate: {
+    templateFile: 'src/index.html',
+    minify: null,
+    inject: true
+  },
+  // CDN means Content Delivery Network
+  cdnMapping: {
+    isCdnEnabled: false,
+    variableName: '',
+    cssTemplate: '',
+    jsTemplate: '',
+    i18nTemplate: ''
+  },
+  manifestJson: {
+    enable: true
+  },
+  changeRuntimeChunkChar: '~',
+  serviceWorker: {
+    enable: false,
+    templateFilePath: 'sw.js',
+    outputFilePath: '/v1.js',
+    replaceText: '//<!--AssetsFromBuild -->'
+  }
+};
+exports.default = _default;

package/packages/client_build_tool/lib/schemas/deprecatedOptionsHandler.js

@@ -0,0 +1,67 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.deprecatedOptionsHandler = deprecatedOptionsHandler;
+
+var _logger = require("../logger");
+
+function nestedSelect(obj, key) {
+  let temp = obj;
+  const keys = key.split('.');
+
+  for (let i = 0; i < keys.length && temp; i++) {
+    const element = keys[i];
+    temp = temp[element];
+  }
+
+  return temp;
+}
+
+function nestedUpdate(obj, key, value) {
+  let temp = obj;
+  const keys = key.split('.');
+  let i = 0;
+
+  for (; i < keys.length - 1 && temp; i++) {
+    const element = keys[i];
+    temp = temp[element];
+  }
+
+  if (temp) {
+    temp[keys[i]] = value;
+  }
+}
+
+function deprecatedOptionsHandler(options) {
+  function checkAndUpdateAndPrintWaring(oldKey, newkey) {
+    const oldVal = nestedSelect(options, oldKey);
+    const newVal = nestedSelect(options, newkey); // console.log({ oldVal, newVal });
+
+    if (oldVal !== undefined && newVal === undefined) {
+      nestedUpdate(options, newkey, newVal);
+      (0, _logger.warnLogger)(`"${oldKey}" deprecated use "${newkey}" instead`);
+    }
+  } // return;
+
+
+  checkAndUpdateAndPrintWaring('app.context', 'context'); // TODO handle deprecations  here
+  // we will finish this logic later when options are confirmed
+
+  if (nestedSelect(options, 'app.hasRTL') === true) {
+    nestedUpdate(options, 'app.plugins.hasRTL', true);
+  }
+
+  if (nestedSelect(options, 'docs.hasRTL') === true) {
+    nestedUpdate(options, 'docs.plugins.hasRTL', true);
+  }
+
+  if (nestedSelect(options, 'app.rtlExclude.length') > 0) {
+    nestedUpdate(options, 'app.exclude.rtl', nestedSelect(options, 'app.rtlExclude'));
+  }
+
+  if (nestedSelect(options, 'docs.rtlExclude.length') > 0) {
+    nestedUpdate(options, 'docs.exclude.rtl', nestedSelect(options, 'docs.rtlExclude'));
+  }
+}