@pega/dx-component-builder-sdk 0.1.48 → 0.8.1

package/src/tasks/bundle/builderAssociated/webpack.config.js

@@ -0,0 +1,337 @@
+import { createRequire } from 'module';
+
+import webpack from 'webpack';
+import TerserPlugin from 'terser-webpack-plugin';
+import MiniCssExtractPlugin from 'mini-css-extract-plugin';
+import CssMinimizerPlugin from 'css-minimizer-webpack-plugin';
+import getCSSModuleLocalIdent from 'react-dev-utils/getCSSModuleLocalIdent.js';
+import ModuleNotFoundPlugin from 'react-dev-utils/ModuleNotFoundPlugin.js';
+import CompressionPlugin from 'compression-webpack-plugin';
+
+import paths from './paths.js';
+
+const require = createRequire(import.meta.url);
+
+// const appPackageJson = require(paths.appPackageJson);
+
+// Source maps are resource heavy and can cause out of memory issue for large source files.
+
+const compressionBRConfObj = {
+  filename: '[path][base].br',
+  algorithm: 'brotliCompress',
+  test: /\.(js|css|html|svg|png|jpg|woff|woff2)$/,
+  compressionOptions: { level: 11 }
+};
+
+/* For gzip use below */
+const compressionGZConfObj = {
+  filename: '[path][base].gz',
+  algorithm: 'gzip',
+  test: /\.(js|css|html|svg|png|jpg|woff|woff2)$/,
+  compressionOptions: { level: 9 }
+};
+
+let shouldUseSourceMap = process.env.SOURCE_MAP;
+
+const imageInlineSizeLimit = Number.parseInt(process.env.IMAGE_INLINE_SIZE_LIMIT || '10000', 10);
+
+// style files regex
+const cssRegex = /\.css$/;
+const cssModuleRegex = /\.module\.css$/;
+const sassRegex = /\.(scss|sass)$/;
+const sassModuleRegex = /\.module\.(scss|sass)$/;
+
+// This is the production and development configuration.
+// It is focused on developer experience, fast rebuilds, and a minimal bundle.
+export default (
+  webpackEnv,
+  // eslint-disable-next-line no-unused-vars
+  { inputFile, outputFile, componentKey, externals, globals, sourceMap, devBuild }
+) => {
+  const isEnvDevelopment = webpackEnv === 'development' || devBuild;
+  const isEnvProduction = webpackEnv === 'production';
+  sourceMap = sourceMap === 'true';
+  shouldUseSourceMap = shouldUseSourceMap || sourceMap;
+
+  // common function to get style loaders
+  const getStyleLoaders = (cssOptions, preProcessor) => {
+    const loaders = [
+      isEnvProduction && {
+        loader: MiniCssExtractPlugin.loader
+      },
+      {
+        loader: require.resolve('css-loader'),
+        options: cssOptions
+      },
+      {
+        // Options for PostCSS as we reference these options twice
+        // Adds vendor prefixing based on your specified browser support in
+        // package.json
+        loader: require.resolve('postcss-loader'),
+        options: {
+          postcssOptions: {
+            plugins: [
+              [
+                'postcss-preset-env',
+                {
+                  // Options
+                }
+              ]
+            ]
+          },
+          sourceMap: isEnvProduction ? shouldUseSourceMap : isEnvDevelopment
+        }
+      }
+    ].filter(Boolean);
+    if (preProcessor) {
+      loaders.push(
+        {
+          loader: require.resolve('resolve-url-loader'),
+          options: {
+            sourceMap: isEnvProduction ? shouldUseSourceMap : isEnvDevelopment,
+            root: paths.appSrc
+          }
+        },
+        {
+          loader: require.resolve(preProcessor),
+          options: {
+            sourceMap: true
+          }
+        }
+      );
+    }
+    return loaders;
+  };
+  return {
+    mode: devBuild ? 'development' : 'production',
+    // Stop compilation early in production
+    bail: isEnvProduction,
+    // These are the "entry points" to our application.
+    // This means they will be the "root" imports that are included in JS bundle.
+    entry: inputFile,
+    devtool: devBuild ? 'eval-cheap-module-source-map' : false,
+    output: {
+      // The build folder.
+      path: paths.appBuild,
+      // There will be one main bundle, and one file per asynchronous chunk.
+      // In development, it does not produce real files.
+      filename: isEnvProduction
+        ? `${componentKey}/${componentKey}.js`
+        : isEnvDevelopment && `${componentKey}/${componentKey}.js`,
+      chunkFilename: isEnvProduction
+        ? `${componentKey}/js/[name].[contenthash:8].chunk.js`
+        : isEnvDevelopment && `${componentKey}/js/[name].chunk.js`,
+      library: {
+        name: componentKey,
+        type: 'umd',
+        export: 'default'
+      },
+      publicPath: ''
+    },
+    optimization: {
+      minimize: isEnvProduction,
+      minimizer: [new TerserPlugin(), new CssMinimizerPlugin()]
+    },
+    resolve: {
+      plugins: [],
+      extensions: ['.tsx', '.ts', '.js']
+    },
+    resolveLoader: {
+      plugins: []
+    },
+    module: {
+      strictExportPresence: true,
+      rules: [
+        {
+          // "oneOf" will traverse all following loaders until one will
+          // match the requirements. When no loader matches it will fall
+          // back to the "file" loader at the end of the loader list.
+          oneOf: [
+            // TODO: Merge this config once `image/avif` is in the mime-db
+            // https://github.com/jshttp/mime-db
+            {
+              test: [/\.avif$/],
+              loader: require.resolve('url-loader'),
+              options: {
+                limit: imageInlineSizeLimit,
+                mimetype: 'image/avif',
+                name: `${componentKey}/media/[name].[hash:8].[ext]`
+              }
+            },
+            // "url" loader works like "file" loader except that it embeds assets
+            // smaller than specified limit in bytes as data URLs to avoid requests.
+            // A missing `test` is equivalent to a match.
+            {
+              test: [/\.bmp$/, /\.gif$/, /\.jpe?g$/, /\.png$/, /\.svg$/],
+              loader: require.resolve('url-loader'),
+              options: {
+                limit: imageInlineSizeLimit,
+                name: `${componentKey}/media/[name].[hash:8].[ext]`
+              }
+            },
+            // Process application JS with TS-Loader.
+            // The preset includes JSX, Flow, TypeScript, and some ESnext features.
+            {
+              test: /\.(js|mjs|jsx)$/,
+              include: paths.appSrc,
+              loader: 'ts-loader',
+              options: {
+                configFile: paths.appTsConfig
+              },
+              exclude: /node_modules/
+            },
+
+            {
+              test: /\.(ts|tsx)$/,
+              loader: 'ts-loader',
+              options: {
+                configFile: paths.appTsConfig
+              },
+              exclude: /node_modules/
+            },
+            // "postcss" loader applies autoprefixer to our CSS.
+            // "css" loader resolves paths in CSS and adds assets as dependencies.
+            // "style" loader turns CSS into JS modules that inject <style> tags.
+            // In production, we use MiniCSSExtractPlugin to extract that CSS
+            // to a file, but in development "style" loader enables hot editing
+            // of CSS.
+            // By default we support CSS Modules with the extension .module.css
+            {
+              test: cssRegex,
+              exclude: cssModuleRegex,
+              use: getStyleLoaders({
+                importLoaders: 1,
+                sourceMap: isEnvProduction ? shouldUseSourceMap : isEnvDevelopment
+              }),
+              // Don't consider CSS imports dead code even if the
+              // containing package claims to have no side effects.
+              // Remove this when webpack adds a warning or an error for this.
+              // See https://github.com/webpack/webpack/issues/6571
+              sideEffects: true
+            },
+            // Adds support for CSS Modules (https://github.com/css-modules/css-modules)
+            // using the extension .module.css
+            {
+              test: cssModuleRegex,
+              use: getStyleLoaders({
+                importLoaders: 1,
+                sourceMap: isEnvProduction ? shouldUseSourceMap : isEnvDevelopment,
+                modules: {
+                  getLocalIdent: getCSSModuleLocalIdent
+                }
+              })
+            },
+            // Opt-in support for SASS (using .scss or .sass extensions).
+            // By default we support SASS Modules with the
+            // extensions .module.scss or .module.sass
+            {
+              test: sassRegex,
+              exclude: sassModuleRegex,
+              use: getStyleLoaders(
+                {
+                  importLoaders: 3,
+                  sourceMap: isEnvProduction ? shouldUseSourceMap : isEnvDevelopment
+                },
+                'sass-loader'
+              ),
+              // Don't consider CSS imports dead code even if the
+              // containing package claims to have no side effects.
+              // Remove this when webpack adds a warning or an error for this.
+              // See https://github.com/webpack/webpack/issues/6571
+              sideEffects: true
+            },
+            // Adds support for CSS Modules, but using SASS
+            // using the extension .module.scss or .module.sass
+            {
+              test: sassModuleRegex,
+              use: getStyleLoaders(
+                {
+                  importLoaders: 3,
+                  sourceMap: isEnvProduction ? shouldUseSourceMap : isEnvDevelopment,
+                  modules: {
+                    getLocalIdent: getCSSModuleLocalIdent
+                  }
+                },
+                'sass-loader'
+              )
+            },
+            // "file" loader makes sure those assets get served by WebpackDevServer.
+            // When you `import` an asset, you get its (virtual) filename.
+            // In production, they would get copied to the `build` folder.
+            // This loader doesn't use a "test" so it will catch all modules
+            // that fall through the other loaders.
+            {
+              loader: require.resolve('file-loader'),
+              // Exclude `js` files to keep "css" loader working as it injects
+              // its runtime that would otherwise be processed through "file" loader.
+              // Also exclude `html` and `json` extensions so they get processed
+              // by webpack's internal loaders.
+              exclude: [/\.(js|mjs|jsx|ts|tsx)$/, /\.html$/, /\.json$/],
+              options: {
+                name: `${componentKey}/media/[name].[hash:8].[ext]`
+              }
+            }
+            // ** STOP ** Are you adding a new loader?
+            // Make sure to add the new loader(s) before the "file" loader.
+          ]
+        }
+      ]
+    },
+    plugins: [
+      // This gives some necessary context to module not found errors, such as
+      // the requesting resource.
+      new ModuleNotFoundPlugin(paths.appPath),
+      // Makes some environment variables available to the JS code, for example:
+      // if (process.env.NODE_ENV === 'production') { ... }. See `./env.js`.
+      // It is absolutely essential that NODE_ENV is set to production
+      // during a production build.
+      // Otherwise React will be compiled in the very slow development mode.
+      isEnvProduction &&
+        new webpack.DefinePlugin({
+          PRODUCTION: JSON.stringify(true)
+        }),
+      isEnvProduction &&
+        new MiniCssExtractPlugin({
+          // Options similar to the same options in webpackOptions.output
+          // both options are optional
+          filename: `${componentKey}/css/${componentKey}.[contenthash:8].css`,
+          chunkFilename: `${componentKey}/css/${componentKey}.[contenthash:8].chunk.css`
+        }),
+      // Moment.js is an extremely popular library that bundles large locale files
+      // by default due to how webpack interprets its code. This is a practical
+      // solution that requires the user to opt into importing specific locales.
+      // https://github.com/jmblog/how-to-optimize-momentjs-with-webpack
+      // You can remove this if you don't use Moment.js:
+      new webpack.IgnorePlugin({
+        resourceRegExp: /^\.\/locale$/,
+        contextRegExp: /moment$/
+      }),
+      /* Ignore cosmos icons */
+      new webpack.IgnorePlugin({
+        resourceRegExp: /^\.\/icons$/,
+        contextRegExp: /@pega\/cosmos-react-core\/lib\/components\/Icon$/
+      }),
+
+      /* Ignore cosmos icons - windows */
+      new webpack.IgnorePlugin({
+        resourceRegExp: /^\.\/icons$/,
+        contextRegExp: /@pega\\cosmos-react-core\\lib\\components\\Icon$/
+      }),
+
+      new webpack.optimize.LimitChunkCountPlugin({
+        maxChunks: 1
+      }),
+      new webpack.optimize.MinChunkSizePlugin({
+        minChunkSize: 100000 // Minimum number of characters
+      }),
+      !devBuild && new CompressionPlugin(compressionBRConfObj)
+
+      /* Dont generate gzip file */
+      /* isEnvProduction && new CompressionPlugin(compressionGZConfObj) */
+    ].filter(Boolean),
+    performance: {
+      hints: 'warning'
+    },
+    externals
+  };
+};

package/src/tasks/bundle/builderReact/paths.js

@@ -36,6 +36,7 @@ const resolveModule = (resolveFn, filePath) => {
 };
 
 // config after eject: we're in ./config/
+// building a standard React component for react SDK, use same ts config as buid:dev
 export default {
   dotenv: resolveApp('.env'),
   appPath: resolveApp('.'),
@@ -44,7 +45,7 @@ export default {
   appIndexJs: resolveModule(resolveApp, 'src/index'),
   appPackageJson: resolveApp('package.json'),
   appSrc: [resolveApp('src/components'), resolveApp('src/app/_components')],
-  appTsConfig: resolveApp('constellation-comp-config/tsconfig.build.json'),
+  appTsConfig: resolveApp('./tsconfig.build.json'),
   appJsConfig: resolveApp('jsconfig.json'),
   appNodeModules: resolveApp('node_modules')
 };

package/src/tasks/bundle/builderReact/webpack.config.js

@@ -255,6 +255,14 @@ export default (
                 'sass-loader'
               )
             },
+            {
+              test: /\.(d.ts)$/,    /* latest react-sdk-components needs to ignore compiling .d.ts and .map files */
+              loader: 'null-loader',
+            },
+            {
+              test: /\.(map)$/,    /* latest react-sdk-components needs to ignore compiling .d.ts and .map files */
+              loader: 'null-loader',
+            }, 
             // "file" loader makes sure those assets get served by WebpackDevServer.
             // When you `import` an asset, you get its (virtual) filename.
             // In production, they would get copied to the `build` folder.

package/src/tasks/bundle/index.js

@@ -7,9 +7,69 @@ import { getComponentDirectoryPath, getFramework, removeComponentPrefix } from '
 
 import buildReactComponent from './builderReact/index.js';
 import buildAngularComponent from './builderAngular/index.js';
+import buildAssociatedComponent from './builderAssociated/index.js';
 
 const extensions = ['ts', 'tsx', 'js', 'jsx'];
 
+export const bundleAssociatedComponent = async (componentKey, sourceMap, devBuild, category = CATEGORY_CUSTOM) => {
+  const componentDirectory = await getComponentDirectoryPath(componentKey, category);
+
+  const idx = (
+    await Promise.all(
+      extensions.map(ext =>
+        stat(path.join(componentDirectory, `index.${ext}`))
+          .then(() => true)
+          .catch(() => false)
+      )
+    )
+  ).findIndex(exists => exists);
+
+  if (idx === -1) throw new Error('Index file not found.');
+
+  // remove sub folder, component goes in dist directory without it
+  if (componentKey.indexOf("/") >=0) {
+    const arKey = componentKey.split("/");
+    componentKey = arKey[arKey.length - 1];
+  }
+
+  const inputFile = path.join(componentDirectory, `index.${extensions[idx]}`);
+  const outputFile = `${componentKey}.js`;
+
+  let buildConfig = {};
+
+  if (fs.existsSync(BUILD_CONFIG_JSON_FILENAME)) {
+    buildConfig = JSON.parse(fs.readFileSync(BUILD_CONFIG_JSON_FILENAME, 'utf8'));
+  }
+
+  let externals = buildConfig.externals || [];
+  externals = {
+    react: 'React',
+    'react-dom': 'ReactDOM',
+    PCore: 'PCore',
+    ...buildConfig.externals
+  };
+
+  let globals = buildConfig.globals || {};
+
+  const defaultGlobals = {
+    react: 'React',
+    'react-dom': 'ReactDOM',
+    PCore: 'PCore',
+    ...buildConfig.globals
+  };
+
+  globals = { ...globals, ...defaultGlobals };
+  await buildAssociatedComponent({
+    inputFile,
+    outputFile,
+    componentKey,
+    externals,
+    globals,
+    sourceMap,
+    devBuild
+  });
+};
+
 export const bundleReactComponent = async (componentKey, sourceMap, devBuild, category = CATEGORY_CUSTOM) => {
   const componentDirectory = await getComponentDirectoryPath(componentKey, category);
 
@@ -76,14 +136,14 @@ export const bundleAngularComponent = async (componentKey, sourceMap, devBuild,
 
   const idx = (
     await Promise.all(
-      extensions.map(ext => 
+      extensions.map(ext =>
         stat(path.join(componentDirectory, `${componentKey}.component.${ext}`))
           .then(() => true)
           .catch(() => false)
       )
     )
   ).findIndex(exists => exists);
-  
+
 
   if (idx === -1) throw new Error('Index file not found.');
 
@@ -114,7 +174,7 @@ export const bundleAngularComponent = async (componentKey, sourceMap, devBuild,
     PCore: 'PCore',
     ...buildConfig.globals
   };
-  
+
   globals = { ...globals, ...defaultGlobals };
   await buildAngularComponent({
     inputFile,
@@ -126,5 +186,3 @@ export const bundleAngularComponent = async (componentKey, sourceMap, devBuild,
     devBuild
   });
 };
-
-

package/src/tasks/list/helper.js

@@ -1,11 +1,10 @@
 import fs from 'fs';
-import https from 'https';
 
 import chalk from 'chalk';
 import fetch from 'node-fetch';
 
 import { LIST_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH, COMPONENT_SCHEMA, CATEGORY_CUSTOM } from '../../constants.js';
-import { constructCompleteUrl, getComponents, getPegaServerConfig } from '../../util.js';
+import { constructCompleteUrl, getComponents, getPegaServerConfig, getHttpsAgent } from '../../util.js';
 
 
 export const SOURCE_OF_COMPONENT_TYPES = {
@@ -75,7 +74,7 @@ export const getComponentsFromServer = async data => {
           let status = 500;
           fetch(url, {
             method: 'GET',
-            agent: new https.Agent({ rejectUnauthorized: false }),
+            agent: getHttpsAgent(defaultPegaServerConfig),
             headers: {
               Authorization: `${tokenType} ${accessToken}`
             }

package/src/tasks/override/index.js

@@ -9,20 +9,20 @@ import chalk from 'chalk';
 import { updateComponentMap  } from '../map/map.js';
 
 import {
-  checkPathAccess, 
-  showVersion, 
-  getPegaConfig, 
-  convertIntoKebabCase, 
+  checkPathAccess,
+  showVersion,
+  getPegaConfig,
+  convertIntoKebabCase,
   getFramework,
   getComponentDirectoryPath,
   getComponents,
   getComponentDefaults
 } from '../../util.js';
 
-import { COMPONENT_SCHEMA, 
-  CATEGORY_OVERRIDE, 
-  SDK_CONFIG_JSON_FILENAME, 
-  DXCB_CONFIG, 
+import { COMPONENT_SCHEMA,
+  CATEGORY_OVERRIDE,
+  SDK_CONFIG_JSON_FILENAME,
+  DXCB_CONFIG,
   DXCB_COMPONENT_DEFAULTS,
   CUSTOM_TEMPLATES,
   OVERRIDE_TEMPLATE_PATH,
@@ -94,7 +94,7 @@ const getListAvailableComponents = async (type) => {
       fullList = COMPONENT_SCHEMA.overrideWCComponent[type];
       break;
   }
-  
+
   let availList = [];
   for (var el in fullList) {
 
@@ -121,7 +121,7 @@ const adjustAngularComponentName = (componentName) => {
   if (componentName.indexOf("/") >= 0) {
     componentName = componentName.split("/")[1];
   }
- 
+
 
   return componentName;
 }
@@ -163,7 +163,7 @@ const validateCompile = async (
 
   if (pegaConfig[DXCB_CONFIG] &&
     pegaConfig[DXCB_CONFIG][CUSTOM_TEMPLATES] &&
-    pegaConfig[DXCB_CONFIG][CUSTOM_TEMPLATES][OVERRIDE_TEMPLATE_PATH] && 
+    pegaConfig[DXCB_CONFIG][CUSTOM_TEMPLATES][OVERRIDE_TEMPLATE_PATH] &&
     pegaConfig[DXCB_CONFIG][CUSTOM_TEMPLATES][OVERRIDE_TEMPLATE_PATH] != "") {
     templateParentDir = pegaConfig[DXCB_CONFIG][CUSTOM_TEMPLATES][OVERRIDE_TEMPLATE_PATH];
   }
@@ -266,9 +266,9 @@ export default async options => {
   if (options.params.length >= 5) {
     let componentName = options.params[4];
     let type;
-    
+
     if (promptType) type = promptType;
-  
+
     await validateCompile(
       {
         componentName,
@@ -338,16 +338,16 @@ export default async options => {
           return widgetList.length > 0 && (answers.type === 'widget'  || promptType === 'widget');
         }
       },
-  
+
     ];
-  
+
     await inquirer.prompt(questions).then(async answers => {
       let {
         componentName,
         type
       } = answers;
       if (promptType) type = promptType;
-  
+
       await validateCompile(
         {
           componentName,
@@ -356,7 +356,7 @@ export default async options => {
         options
       );
     });
-  
+
   }
 
 

package/src/tasks/publish/helper.js

@@ -1,6 +1,5 @@
 import fs from 'fs';
 import path from 'path';
-import https from 'https';
 
 import fetch from 'node-fetch';
 import AdmZip from 'adm-zip';
@@ -14,7 +13,8 @@ import {
   validateRulesetVersion,
   getOptionsCategory,
   getLocalComponentKeyFromConfig,
-  getFramework
+  getFramework,
+  getHttpsAgent
 } from '../../util.js';
 
 import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT,
@@ -252,7 +252,7 @@ export const publishComponentToServer = async (data, doFetch = true) => {
         let status = 500;
         fetch(url, {
           method: 'POST',
-          agent: new https.Agent({ rejectUnauthorized: false }),
+          agent: getHttpsAgent(defaultPegaConfig),
           headers: {
             Authorization: `${tokenType} ${accessToken}`
           },

package/src/tasks/publish/index.js

@@ -4,7 +4,7 @@ import chalk from 'chalk';
 
 import validate from '../validator/index.js';
 import { getComponentDirectoryPath, showVersion, getOptionsCategory, getFramework, getLocalComponentKeyFromConfig, convertIntoKebabCase, convertIntoPascalCase } from '../../util.js';
-import { bundleReactComponent, bundleAngularComponent} from '../bundle/index.js';
+import { bundleReactComponent, bundleAngularComponent, bundleAssociatedComponent} from '../bundle/index.js';
 import { updateComponentMap  } from '../map/map.js';
 import { lintComponent } from '../linter/index.js';
 import { CATEGORY_CONSTELLATION, CATEGORY_CUSTOM } from '../../constants.js';
@@ -22,7 +22,7 @@ export default async options => {
   showVersion();
 
   const framework = await getFramework();
-  
+
   let componentKey;
   let sourceMap;
   let devBuild;
@@ -44,16 +44,16 @@ export default async options => {
   } else {
     const catQuestion = await getBuildCategory(options);
     const catAnswers = await inquirer.prompt(catQuestion);
-  
+
     category = catAnswers.category;
     if (category == null) {
       category = getOptionsCategory(options);
     }
-  
+
     const questions = await getPublishComponentQuestions(category);
     const answers = await inquirer.prompt(questions);
     ({ componentKey, sourceMap, devBuild } = answers);
-  
+
     content = {
       ...answers
     };
@@ -129,7 +129,7 @@ export default async options => {
       },
       {
         title: `Bundle associated component ${sDevBuild}`,
-        task: async () => await bundleReactComponent(associatedComponentKey, sourceMap, devBuild, CATEGORY_CONSTELLATION),
+        task: async () => await bundleAssociatedComponent(associatedComponentKey, sourceMap, devBuild, CATEGORY_CONSTELLATION),
         skip: () => (options.skipBundle ? 'Skipped bundling component' : undefined)
       },
       {
@@ -199,7 +199,7 @@ export default async options => {
       {
         title: 'Publish component config',
         task: async () => {
-          await publishComponentToServer(content);
+          await publishComponentToServer(content, doFetch);
         }
       }