Release 13.0.0

Author: benm071

README.md

@@ -1,12 +1,12 @@
-# @oracle/oraclejet-tooling 12.1.0
+# @oracle/oraclejet-tooling 13.0.0
 
 ## About the tooling API
 This tooling API contains methods to build and serve Oracle JET web and hybrid mobile apps. It is intended to be used with task running tools such as grunt or gulp. The APIs can also be invoked directly. 
 
 This is an open source project maintained by Oracle Corp.
 
 ## Installation
-This module will be automatically installed when you scaffold a web or hybrid mobile app following the [Oracle JET Developers Guide](http://www.oracle.com/pls/topic/lookup?ctx=jet1210&id=homepage).
+This module will be automatically installed when you scaffold a web or hybrid mobile app following the [Oracle JET Developers Guide](http://www.oracle.com/pls/topic/lookup?ctx=jet1300&id=homepage).
 
 ## [Contributing](https://github.com/oracle/oraclejet-tooling/blob/master/CONTRIBUTING.md)
 Oracle JET is an open source project.  Pull Requests are currently not being accepted. See 

RELEASENOTES.md

@@ -1,6 +1,6 @@
 ## Release Notes for oraclejet-tooling ##
 
-### 12.1.0
+### 13.0.0
 
 ### 11.0.0
 * oraclejet-tooling now requires node 12.21 or later

lib/addtypescript.js

@@ -35,7 +35,7 @@ function installTypescipt(options) {
   util.log('Installing Typescript');
   const installer = util.getInstallerCommand({ options });
 
-  const command = `${installer.installer} ${installer.verbs.install} typescript@${CONSTANTS.TYPESCRIPT_VERSION} --save-dev --save-exact`;
+  const command = `${installer.installer} ${installer.verbs.install} typescript@${CONSTANTS.TYPESCRIPT_VERSION} ts-creator@~1.2.5 yargs-parser@~13.1.2 --save-dev --save-exact`;
   return util.exec(command);
 }
 

lib/addwebpack.js

@@ -50,7 +50,6 @@ function installWebpack(options) {
     webpack-merge
     compression-webpack-plugin
     mini-css-extract-plugin
-    zlib
     --save-dev --save-exact
   `.replace(/\n/g, '').replace(/\s+/g, ' ');
   return util.exec(command);

lib/buildCommon.js

@@ -235,8 +235,14 @@ function _copyThemesToStaging(context) {
   // copy the entire theme/platform folder during build
   const ext = util.getThemeCssExtention(buildType);
   const src = _getThemeSrcPath(theme, ext, livereload);
+  const themePreact = Object.assign({},
+    { name: `theme-${theme.name}`, platform: theme.platform, compile: false, version: util.getJETVersion() });
+  const preactSrc = _getThemeSrcPath(themePreact, ext, livereload);
 
   const dest = _getThemeDestPath(theme, stgPath, ext, livereload, platform, opts.destination);
+  const preactDest = _getThemeDestPath(themePreact, stgPath, ext, livereload, platform,
+    opts.destination);
+
   const rwood = Object.assign({},
     { name: 'redwood', platform: 'web', compile: false, version: util.getJETVersion() });
   if ((opts.theme.cssGeneratedType === 'add-on' && opts.theme.basetheme === CONSTANTS.DEFAULT_PCSS_THEME) || (opts.themes && opts.themes.length > 1)) {
@@ -284,6 +290,14 @@ function _copyThemesToStaging(context) {
     // copy to staging
     // copy theme/platform to staging
     fs.copySync(src, dest);
+    // Copy preact theme if present
+    if (fs.existsSync(preactSrc)) {
+      fs.copySync(preactSrc, preactDest);
+      if (buildType === 'release') {
+        // Preact images need to be a peer of the code bundle.js
+        fs.copySync(path.join(preactSrc, 'images'), path.join(stgPath, 'images'));
+      }
+    }
 
     // copy additional resources staged-themes/theme/common
     _copyThemeCommonToStaging(theme, stgPath)
@@ -297,7 +311,7 @@ function _copyThemesToStaging(context) {
 
 // only runs when platform is windows, fixing locale Bug 26871715
 function _renameNlsDirs() {
-  const srcBase = `${config('paths').staging.stagingPath}/${config('paths').src.javascript}/libs/oj/v${util.getJETVersion()}/resources/nls`;
+  const srcBase = `${config('paths').staging.stagingPath}/${config('paths').src.javascript}/libs/oj/${util.getJETVersionV(util.getJETVersion())}/resources/nls`;
   const match = glob.sync('*', { cwd: srcBase, ignore: ['*.js', '*locale*'] });
   match.forEach((file) => {
     const src = path.join(srcBase, file);
@@ -463,6 +477,18 @@ module.exports = {
     });
   },
 
+  injectTs: function _injectTs(context) {
+    util.log('Running typescript injection tasks.');
+    return new Promise((resolve, reject) => {
+      mainJsInjector.injectTs(context)
+        .then(() => {
+          util.log('Task typescript injection finished.');
+          resolve(context);
+        })
+        .catch(err => reject(err));
+    });
+  },
+
   injectLocalhostCspRule: function _injectLocalhostCspRule(context) {
     util.log('Running localhost csp rule injection task.');
 
@@ -816,7 +842,7 @@ module.exports = {
       componentList.forEach((component) => {
         const componentDirPath = `./${configPaths.exchangeComponents}/${component}/${CONSTANTS.JET_COMPONENT_JSON}`;
         const componentJson = util.readJsonAndReturnObject(`${componentDirPath}`);
-        if (componentJson.type === 'reference') {
+        if (componentJson.type === CONSTANTS.COMPONENT_TYPE.REFERENCE) {
           const npmPckgName = componentJson.package;
           const retObj = util.getNpmPckgInitFileRelativePath(componentJson, context.buildType);
           const npmPckgInitFileRelativePath = retObj.npmPckgInitFileRelativePath;

lib/buildCommon/compileTypescript.js

@@ -107,7 +107,7 @@ function _compileComponentTypescript({
     type: 'component',
     tsconfigJson: {
       include,
-      exclude: CONSTANTS.JEST_TEST_FILE_GLOBS.map(testFileGlob => (
+      exclude: CONSTANTS.JEST_TEST_FILE_AND_LIBS_GLOBS.map(testFileGlob => (
         `${componentTypescriptPath}/${testFileGlob}`
       )),
       compilerOptions: {
@@ -124,7 +124,7 @@ function _compileComponentTypescript({
     // run before_component_typescript hook
     () => hookRunner('before_component_typescript', context),
     // compile component typescript
-    () => _runTypescriptCompilation(context),
+    () => _runTypescriptCompilation({ context, pack, component }),
     // copy runtime resources to /js
     () => _runIfTypescriptCompilationSucceeded(
       context,
@@ -209,7 +209,7 @@ function compileApplicationTypescript(context) {
     type: 'application',
     tsconfigJson: {
       include,
-      exclude: CONSTANTS.JEST_TEST_FILE_GLOBS.map(testFileGlob => (
+      exclude: CONSTANTS.JEST_TEST_FILE_AND_LIBS_GLOBS.map(testFileGlob => (
         `${applicationTypescriptPath}/${testFileGlob}`
       )),
       compilerOptions: {
@@ -224,7 +224,7 @@ function compileApplicationTypescript(context) {
     // run before_app_typescript hook
     () => hookRunner('before_app_typescript', context),
     // compile app typescript
-    () => _runTypescriptCompilation(context),
+    () => _runTypescriptCompilation({ context }),
     // copy runtime sources to /js
     () => _runIfTypescriptCompilationSucceeded(
       context,
@@ -319,7 +319,7 @@ function _setupTypescriptCompilation(context) {
  * @private
  * @param {object} context - build context
  */
-function _runTypescriptCompilation(context) {
+function _runTypescriptCompilation({ context, pack, component }) {
   return new Promise((resolve) => {
     const configPaths = util.getConfiguredPaths();
     const { tsconfigJson } = context.opts.typescript;
@@ -328,6 +328,26 @@ function _runTypescriptCompilation(context) {
     // eslint-disable-next-line max-len
     // eslint-disable-next-line global-require, import/newline-after-import, import/no-dynamic-require
     const CustomTypescriptCompiler = require(customCompiler);
+
+    let apiDocDir;
+    const components = path.join(context.opts.stagingPath, configPaths.src.javascript,
+      configPaths.components);
+    if (component && pack) {
+      apiDocDir = path.join(components, pack, component);
+    } else if (component) {
+      apiDocDir = path.join(components, component);
+    } else {
+      apiDocDir = null;
+    }
+    // For component(s) in a pack, the version number is between the pack and component:
+    if (apiDocDir && !context.opts[CONSTANTS.OMIT_COMPONENT_VERSION_FLAG]) {
+      const componentVersion = util.getComponentVersion({ pack, component });
+      if (component && pack) {
+        apiDocDir = path.join(components, pack, componentVersion, component);
+      } else if (component) {
+        apiDocDir = path.join(apiDocDir, componentVersion);
+      }
+    }
     const compileOptions = {
       // tsconfig JSON to use for compilation
       tsconfigJson,
@@ -339,6 +359,7 @@ function _runTypescriptCompilation(context) {
       buildOptions: {
         debug: !!context.opts.dbg,
         dtDir: `${context.opts.stagingPath}/${configPaths.src.typescript}/${CONSTANTS.COMPONENTS_DT}`,
+        apiDocDir,
         version: '',
         jetVersion: '',
         templatePath: path.join(
@@ -350,6 +371,7 @@ function _runTypescriptCompilation(context) {
         typesDir: `${context.opts.stagingPath}/${configPaths.src.javascript}/${configPaths.components}`
       }
     };
+
     const { errors, parsedTsconfigJson } = CustomTypescriptCompiler.compile(compileOptions);
     // Replace tsconfigJson with version used by custom-tsc. This is needed if the tsconfigJson
     // had inherited properties from other tsconfig.json files via the "extends" option.

lib/buildCommon/copyLocalComponent.js

@@ -291,7 +291,7 @@ class ResourceComponentStager extends PackComponentStager {
  */
 function generateComponentStager({ context, componentJson, srcPath, destPath }) {
   if (componentJson.pack) {
-    if (componentJson.type === 'resource') {
+    if (componentJson.type === CONSTANTS.COMPONENT_TYPE.RESOURCE) {
       return new ResourceComponentStager({ context, srcPath, destPath, componentJson });
     }
     return new PackComponentStager({ context, srcPath, destPath, componentJson });

lib/buildCommon/generateComponentsCache.js

@@ -57,7 +57,7 @@ function generateComponentsCache({ context }) {
       const componentPath = path.join(componentBasePath, component);
       const componentJson = util.getComponentJson({ context, component });
       const { name: componentName, type } = componentJson;
-      if (!componentJson.jetVersion) {
+      if (!componentJson.jetVersion && type !== CONSTANTS.COMPONENT_TYPE.REFERENCE) {
         componentJson.jetVersion = util.getJETVersion();
       }
       componentsCache[componentName] = generateComponentCache({
@@ -92,7 +92,8 @@ function generateComponentsCache({ context }) {
           if (util.hasMissingProperty(componentInPackComponentJson, 'version')) {
             componentInPackComponentJson.version = packCompJson.version;
           }
-          if (util.hasMissingProperty(componentInPackComponentJson, 'jetVersion')) {
+          if (util.hasMissingProperty(componentInPackComponentJson, 'jetVersion') &&
+          componentInPackComponentJson.type !== CONSTANTS.COMPONENT_TYPE.REFERENCE) {
             componentInPackComponentJson.jetVersion = packCompJson.jetVersion;
           }
           if (util.hasMissingProperty(componentInPackComponentJson, 'pack')) {
@@ -222,7 +223,7 @@ function generateComponentCache({ context, componentJson, componentPath, pack })
 function generateComponentImportName({ context, componentJson, pack }) {
   const { name: componentName } = componentJson;
   let importName;
-  if (componentJson.type === 'reference') {
+  if (componentJson.type === CONSTANTS.COMPONENT_TYPE.REFERENCE) {
     const mapping = pathGenerator.getReferencePath(context.buildType, true, componentJson);
     importName = Object.keys(mapping).pop();
   } else {

lib/buildCommon/minifyComponent.js

@@ -391,7 +391,7 @@ function minifyComponent({ context, componentJson, componentName, destBase }) {
         }).generateMinificationFunction());
       } else if (componentHasType && componentType === 'pack') {
         const packComponentJson = componentJson;
-        const packVersion = packComponentJson.version;
+        const packVersion = context.opts[CONSTANTS.OMIT_COMPONENT_VERSION_FLAG] ? '' : packComponentJson.version;
         const packName = util.hasProperty(packComponentJson, 'name') && packComponentJson.name;
         if (!packName) {
           util.log.error('Missing "name" property for pack.');
@@ -416,7 +416,7 @@ function minifyComponent({ context, componentJson, componentName, destBase }) {
                     packComponentJson
                   }).generateMinificationFunction());
                   break;
-                case 'resource':
+                case CONSTANTS.COMPONENT_TYPE.RESOURCE:
                   minificationFunctions.push(new ResourceComponentMinifier({
                     context,
                     componentJson: packMemberComponentJson,

lib/buildCommon/optimizeComponent.js

@@ -131,8 +131,18 @@ function optimizeComponentInvoker({ context, rjsOptions, tempBundleFile }) {
             }
             resolve(context);
           } else {
+            // Handle the case where the before_optimize trigger has updated
+            // the configuration used by r.js to output a non-standard optimized
+            // component file - something other than loader.js
+            // (This code should be revisited when main support is added for components)
+            const loaderSignature = `${path.sep}loader.js`;
+            let minifyFile = rjsOptions.out;
+            if (rjsOptions.out.endsWith(loaderSignature) &&
+                !context.opts.componentRequireJs.out.endsWith(loaderSignature)) {
+              minifyFile = context.opts.componentRequireJs.out;
+            }
             util.minifyFiles({
-              files: [{ dest: rjsOptions.out, src: rjsOptions.out }],
+              files: [{ dest: minifyFile, src: minifyFile }],
               options: context.opts.terser.options,
               generateSourceMaps: true,
               minify: true