@commercetools-frontend/mc-scripts 21.7.0 → 21.8.0

package/build/commands/config-sync.js

@@ -1,176 +0,0 @@
-"use strict";
-
-const omit = require('lodash/omit');
-
-const prompts = require('prompts');
-
-const mri = require('mri');
-
-const chalk = require('chalk');
-
-const {
-  processConfig
-} = require('@commercetools-frontend/application-config');
-
-const CredentialsStorage = require('../utils/credentials-storage');
-
-const {
-  fetchCustomApplication,
-  updateCustomApplication,
-  createCustomApplication,
-  fetchUserOrganizations
-} = require('../utils/graphql-requests');
-
-const getConfigDiff = require('../utils/get-config-diff');
-
-const flags = mri(process.argv.slice(2), {
-  boolean: ['dry-run']
-});
-const credentialsStorage = new CredentialsStorage();
-
-const getMcUrlLink = (mcApiUrl, organizationId, applicationId) => {
-  const mcUrl = mcApiUrl.replace('mc-api', 'mc');
-  const customAppLink = `${mcUrl}/account/organizations/${organizationId}/custom-applications/owned/${applicationId}`;
-  return customAppLink;
-};
-
-const configSync = async () => {
-  const applicationConfig = processConfig();
-  const {
-    data: localCustomAppData
-  } = applicationConfig;
-  const {
-    mcApiUrl
-  } = applicationConfig.env;
-
-  if (!credentialsStorage.isSessionValid(mcApiUrl)) {
-    throw new Error(`You don't have a valid session for the ${mcApiUrl} environment. Please, run the "mc-scripts login" command to authenticate yourself.`);
-  }
-
-  const token = credentialsStorage.getToken(mcApiUrl);
-  const fetchedCustomApplication = await fetchCustomApplication({
-    mcApiUrl,
-    token,
-    entryPointUriPath: localCustomAppData.entryPointUriPath
-  });
-
-  if (!fetchedCustomApplication) {
-    const userOrganizations = await fetchUserOrganizations({
-      mcApiUrl,
-      token
-    });
-    let organizationId, organizationName;
-
-    if (userOrganizations.total === 0) {
-      throw new Error(`It seems you are not an admin of any Organization. Please make sure to be part of the Administrators team of the Organization you want the Custom Application to be configured to.`);
-    }
-
-    if (userOrganizations.total === 1) {
-      const [organization] = userOrganizations.results;
-      organizationId = organization.id;
-      organizationName = organization.name;
-    } else {
-      const organizationChoices = userOrganizations.results.map(organization => ({
-        title: organization.name,
-        value: organization.id
-      }));
-      const {
-        organizationId: selectedOrganizationId
-      } = await prompts({
-        type: 'select',
-        name: 'organizationId',
-        message: 'Select Organization',
-        choices: organizationChoices,
-        initial: 0
-      });
-
-      if (!selectedOrganizationId) {
-        throw new Error(`No Organization selected, aborting.`);
-      }
-
-      organizationId = selectedOrganizationId;
-      organizationName = organizationChoices.find(({
-        value
-      }) => value === organizationId).title;
-    }
-
-    const {
-      confirmation
-    } = await prompts({
-      type: 'text',
-      name: 'confirmation',
-      message: `You are about to create a new Custom Application in the "${organizationName}" organization for the ${mcApiUrl} environment. Are you sure you want to proceed?`,
-      initial: 'yes'
-    });
-
-    if (!confirmation || confirmation.toLowerCase().charAt(0) !== 'y') {
-      console.log(chalk.red('Aborted.'));
-      return;
-    }
-
-    const data = omit(localCustomAppData, ['id']);
-
-    if (flags['dry-run']) {
-      console.log(chalk.gray('DRY RUN mode'));
-      console.log(`A new Custom Application would be created for the Organization ${organizationName} with the following payload:`);
-      console.log(JSON.stringify(data));
-      return;
-    }
-
-    const createdCustomApplication = await createCustomApplication({
-      mcApiUrl,
-      token,
-      organizationId,
-      data
-    });
-    const customAppLink = getMcUrlLink(mcApiUrl, organizationId, createdCustomApplication.id);
-    console.log(chalk.green(`Custom Application created.\nThe "applicationId" in your local Custom Application config file should be updated with the application ID: ${createdCustomApplication.id}.\nYou can see the Custom Application data in the Merchant Center at ${customAppLink}.`));
-    return;
-  }
-
-  const customAppLink = getMcUrlLink(mcApiUrl, fetchedCustomApplication.organizationId, fetchedCustomApplication.application.id);
-  const configDiff = getConfigDiff(fetchedCustomApplication.application, localCustomAppData);
-
-  if (!configDiff) {
-    console.log(chalk.green(`Custom Application is already up to date.\nYou can see the Custom Application data in the Merchant Center at ${customAppLink}.`));
-    return;
-  }
-
-  console.log(configDiff);
-  const {
-    confirmation
-  } = await prompts({
-    type: 'text',
-    name: 'confirmation',
-    message: `You are about to update the Custom Application "${localCustomAppData.entryPointUriPath}" with the changes above, in the ${mcApiUrl} environment. Are you sure you want to proceed?`,
-    initial: 'yes'
-  });
-
-  if (!confirmation || confirmation.toLowerCase().charAt(0) !== 'y') {
-    console.log(chalk.red('Aborted.'));
-    return;
-  }
-
-  const data = omit(localCustomAppData, ['id']);
-
-  if (flags['dry-run']) {
-    console.log(chalk.gray('DRY RUN mode'));
-    console.log(`The Custom Application ${data.name} would be updated with the following payload:`);
-    console.log(JSON.stringify(data));
-    return;
-  }
-
-  await updateCustomApplication({
-    mcApiUrl,
-    token,
-    organizationId: fetchedCustomApplication.organizationId,
-    data: omit(localCustomAppData, ['id']),
-    applicationId: fetchedCustomApplication.application.id
-  });
-  console.log(chalk.green(`Custom Application updated.\nYou can see the Custom Application data in the Merchant Center at ${customAppLink}.`));
-};
-
-configSync().catch(error => {
-  console.log(chalk.red(error));
-  process.exit(1);
-});

package/build/commands/login.js

@@ -1,60 +0,0 @@
-"use strict";
-
-const prompts = require('prompts');
-
-const chalk = require('chalk');
-
-const {
-  processConfig
-} = require('@commercetools-frontend/application-config');
-
-const CredentialsStorage = require('../utils/credentials-storage');
-
-const {
-  getAuthToken
-} = require('../utils/auth');
-
-const credentialsStorage = new CredentialsStorage();
-
-const login = async () => {
-  const applicationConfig = processConfig();
-  const {
-    mcApiUrl
-  } = applicationConfig.env;
-
-  if (credentialsStorage.isSessionValid(mcApiUrl)) {
-    console.log(`You already have a valid session for the ${mcApiUrl} environment.\n`);
-    return;
-  }
-
-  const {
-    email
-  } = await prompts({
-    type: 'text',
-    name: 'email',
-    message: 'Email'
-  });
-  const {
-    password
-  } = await prompts({
-    type: 'invisible',
-    name: 'password',
-    message: 'Password (hidden)'
-  });
-
-  if (!email || !password) {
-    throw new Error(`Missing email or password values. Aborting.`);
-  }
-
-  const credentials = await getAuthToken(mcApiUrl, {
-    email,
-    password
-  });
-  credentialsStorage.setToken(mcApiUrl, credentials);
-  console.log(chalk.green(`Login successful for the ${mcApiUrl} environment.\n`));
-};
-
-login().catch(error => {
-  console.log(chalk.red(error));
-  process.exit(1);
-});

package/build/commands/serve.js

@@ -1,37 +0,0 @@
-"use strict";
-
-/* eslint-disable no-console,global-require,import/no-dynamic-require */
-const http = require('http');
-
-const serveHandler = require('serve-handler');
-
-const paths = require('../config/paths');
-
-const port = 3001;
-const server = http.createServer((request, response) => {
-  // You pass two more arguments for config and middleware
-  // More details here: https://github.com/vercel/serve-handler#options
-  return serveHandler(request, response, {
-    public: paths.appBuild,
-    rewrites: [{
-      source: '/favicon*',
-      destination: '/favicon.png'
-    }, {
-      source: '/login*',
-      destination: '/login.html'
-    }, {
-      source: '/logout',
-      destination: '/logout.html'
-    }, {
-      // Match all routes except for the login, logout, and favicon routes.
-      // NOTE: this complex glob pattern would not be necessary if the rewrite
-      // implementation would stop at the first match.
-      // See https://github.com/vercel/serve-handler/issues/71
-      source: '{/!(favicon|login|logout)*/**,/!(favicon|login|logout)*}',
-      destination: '/index.html'
-    }]
-  });
-});
-server.listen(port, () => {
-  console.log(`Running at http://localhost:${port}`);
-});

package/build/commands/start-vite.js

@@ -1,138 +0,0 @@
-"use strict";
-
-const fs = require('fs-extra');
-
-const path = require('path');
-
-const {
-  createServer
-} = require('vite');
-
-const pluginGraphql = require('@rollup/plugin-graphql');
-
-const pluginReact = require('@vitejs/plugin-react').default;
-
-const {
-  processConfig
-} = require('@commercetools-frontend/application-config');
-
-const {
-  replaceHtmlPlaceholders,
-  processHeaders,
-  generateTemplate
-} = require('@commercetools-frontend/mc-html-template');
-
-const {
-  createMcDevAuthenticationMiddleware
-} = require('@commercetools-frontend/mc-dev-authentication');
-
-const {
-  packageLocation: applicationStaticAssetsPath
-} = require('@commercetools-frontend/assets');
-
-const paths = require('../config/paths');
-
-const DEFAULT_PORT = parseInt(process.env.HTTP_PORT, 10) || 3001;
-
-const pluginCustomApplication = applicationConfig => {
-  /**
-   * @type {import('vite').Plugin}
-   */
-  return {
-    name: 'custom-application',
-
-    /**
-     * @type {import('vite').ServerHook}
-     */
-    configureServer(server) {
-      return () => {
-        // Users do not need to have/maintain the `index.html` (as expected by Vite)
-        // as it's generated and maintained by the Custom Application CLI.
-        // Therefore, the generated `index.html` (template) is written into the `/public`
-        // folder so that it's gitignored.
-        // As a result, we need to make sure to point the URI path to the correct location.
-        server.middlewares.use((req, res, next) => {
-          if (req.url === '/index.html') {
-            req.url = '/public/index.html';
-          }
-
-          next();
-        }); // Handle auth routes for internal local development.
-
-        server.middlewares.use(createMcDevAuthenticationMiddleware(applicationConfig));
-      };
-    },
-
-    /**
-     * @type {import('vite').IndexHtmlTransformHook}
-     */
-    transformIndexHtml(rawHtml, _ctx) {
-      const compiledHeaders = processHeaders(applicationConfig);
-      const enhancedLocalEnv = Object.assign({}, applicationConfig.env, // Now that the app config is defined as a `env.json`, when we start the FE app
-      // to point to the local backend API by passing the `MC_API_URL` env does not
-      // work anymore). To make it work again, we can override the `env.json` config
-      // with the env variable before injecting the values into the index.html.
-      // NOTE: this is only necessary for development.
-      process.env.MC_API_URL ? {
-        mcApiUrl: process.env.MC_API_URL
-      } : {}); // Resolve the placeholders of the `index.html` (template) file, before serving it.
-
-      const html = replaceHtmlPlaceholders(rawHtml, {
-        env: enhancedLocalEnv,
-        headers: compiledHeaders
-      });
-      return html;
-    }
-
-  };
-};
-
-const execute = async () => {
-  // Load the Custom Application config file first.
-  const applicationConfig = processConfig(); // Ensure the `/public` folder exists.
-
-  fs.mkdirSync(paths.appBuild, {
-    recursive: true
-  }); // Generate `index.html` (template).
-
-  const appEntryPoint = path.relative(paths.appRoot, paths.entryPoint);
-  const html = generateTemplate({
-    // Define the module entry point (path relative to the `/public` folder).
-    // NOTE: that this is different from the production configuration.
-    scriptImports: [`<script type="module" src="/../${appEntryPoint}"></script>`]
-  }); // Write `index.html` (template) into the `/public` folder.
-
-  fs.writeFileSync(paths.appIndexHtml, html, {
-    encoding: 'utf8'
-  });
-  const server = await createServer({
-    root: paths.appRoot,
-    define: {
-      'process.env.DEBUG': JSON.stringify(false),
-      'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV)
-    },
-    server: {
-      port: DEFAULT_PORT
-    },
-    plugins: [pluginGraphql(), pluginReact({
-      jsxImportSource: '@emotion/react',
-      babel: {
-        plugins: ['@emotion/babel-plugin']
-      }
-    }), pluginCustomApplication(applicationConfig)]
-  });
-  await server.listen(); // Copy public assets to `/public` folder (even in development).
-
-  fs.copySync(path.join(applicationStaticAssetsPath, 'html-page'), paths.appBuild, {
-    dereference: true
-  });
-  server.printUrls();
-};
-
-execute().catch(error => {
-  if (error && error.message) {
-    console.error(error.message);
-  }
-
-  process.exit(1);
-});

package/build/commands/start.js

@@ -1,108 +0,0 @@
-"use strict";
-
-/* eslint-disable no-console,global-require,import/no-dynamic-require */
-const fs = require('fs');
-
-const webpack = require('webpack');
-
-const WebpackDevServer = require('webpack-dev-server');
-
-const chalk = require('react-dev-utils/chalk');
-
-const clearConsole = require('react-dev-utils/clearConsole');
-
-const checkRequiredFiles = require('react-dev-utils/checkRequiredFiles');
-
-const {
-  choosePort,
-  createCompiler,
-  prepareUrls
-} = require('react-dev-utils/WebpackDevServerUtils');
-
-const openBrowser = require('react-dev-utils/openBrowser');
-
-const paths = require('../config/paths');
-
-const createDevServerConfig = require('../config/webpack-dev-server.config');
-
-const createWebpackConfigForDevelopment = require('../config/create-webpack-config-for-development');
-
-const useYarn = fs.existsSync(paths.yarnLockFile);
-const isInteractive = process.stdout.isTTY; // Whether or not `react-refresh` is enabled, `react-refresh` is not 100% stable at this time,
-// which is why it's disabled by default.
-
-const hasWebpackConfig = fs.existsSync(paths.appWebpackConfig); // Warn and crash if required files are missing
-
-if (!checkRequiredFiles([])) {
-  process.exit(1);
-} // Tools like Cloud9 rely on this.
-
-
-const DEFAULT_PORT = parseInt(process.env.HTTP_PORT, 10) || 3001;
-const HOST = process.env.HOST || '0.0.0.0'; // We attempt to use the default port but if it is busy, we offer the user to
-// run on a different port. `detect()` Promise resolves to the next free port.
-
-choosePort(HOST, DEFAULT_PORT).then(port => {
-  if (port == null) {
-    // We have not found a port.
-    return;
-  }
-
-  const protocol = process.env.HTTPS === 'true' ? 'https' : 'http';
-
-  const appName = require(paths.appPackageJson).name;
-
-  const urls = prepareUrls(protocol, HOST, port); // Get webpack config
-
-  const config = hasWebpackConfig ? require(paths.appWebpackConfig) : createWebpackConfigForDevelopment();
-  const devSocket = {
-    warnings: warnings => // eslint-disable-next-line @typescript-eslint/no-use-before-define
-    devServer.sockWrite(devServer.sockets, 'warnings', warnings),
-    errors: errors => // eslint-disable-next-line @typescript-eslint/no-use-before-define
-    devServer.sockWrite(devServer.sockets, 'errors', errors)
-  }; // Create a webpack compiler that is configured with custom messages.
-
-  const compiler = createCompiler({
-    appName,
-    config,
-    devSocket,
-    urls,
-    useYarn,
-    webpack
-  }); // Serve webpack assets generated by the compiler over a web sever.
-
-  const serverConfig = createDevServerConfig({
-    port,
-    publicPath: config.output.publicPath
-  });
-  const devServer = new WebpackDevServer(serverConfig, compiler); // Launch WebpackDevServer.
-
-  devServer.startCallback(() => {
-    if (isInteractive) {
-      clearConsole();
-    }
-
-    console.log(chalk.cyan('Starting the development server...\n'));
-    openBrowser(urls.localUrlForBrowser);
-  });
-  ['SIGINT', 'SIGTERM'].forEach(sig => {
-    process.on(sig, () => {
-      devServer.close();
-      process.exit();
-    });
-  });
-
-  if (process.env.CI !== 'true') {
-    // Gracefully exit when stdin ends
-    process.stdin.on('end', function () {
-      devServer.close();
-      process.exit();
-    });
-  }
-}).catch(err => {
-  if (err && err.message) {
-    console.error(err.message);
-  }
-
-  process.exit(1);
-});

package/build/config/paths.js

@@ -1,38 +0,0 @@
-"use strict";
-
-const fs = require('fs');
-
-const path = require('path');
-
-const moduleFileExtensions = ['js', 'mjs', 'cjs', 'jsx', 'ts', 'tsx']; // Make sure any symlinks in the project folder are resolved:
-// https://github.com/facebook/create-react-app/issues/637
-
-const appDirectory = fs.realpathSync(process.cwd());
-
-const resolveApp = relativePath => path.resolve(appDirectory, relativePath); // Resolve file paths in the order given
-
-
-const resolveModule = (resolveFn, filePath) => {
-  const extension = moduleFileExtensions.find(extension => fs.existsSync(resolveFn(`${filePath}.${extension}`)));
-
-  if (extension) {
-    return resolveFn(`${filePath}.${extension}`);
-  }
-
-  return resolveFn(`${filePath}.js`);
-}; // Resolve the absolute path of the caller location. This is necessary
-// to point to files within that folder.
-
-
-const paths = {
-  appPackageJson: resolveApp('package.json'),
-  appBuild: resolveApp('public'),
-  appIndexHtmlTemplate: resolveApp('public/index.html.template'),
-  appIndexHtml: resolveApp('public/index.html'),
-  appWebpackConfig: resolveModule(resolveApp, `webpack.config.${process.env.NODE_ENV === 'production' ? 'prod' : 'dev'}`),
-  yarnLockFile: resolveApp('yarn.lock'),
-  appRoot: resolveApp('.'),
-  entryPoint: resolveModule(resolveApp, 'src/index'),
-  sourceFolders: [resolveApp('src')]
-};
-module.exports = paths;

package/build/config/vendors-to-transpile.js

@@ -1,3 +0,0 @@
-"use strict";
-
-module.exports = [];

package/build/config/webpack-dev-server.config.js

@@ -1,69 +0,0 @@
-"use strict";
-
-const {
-  processConfig
-} = require('@commercetools-frontend/application-config');
-
-const {
-  processHeaders
-} = require('@commercetools-frontend/mc-html-template');
-
-const {
-  createMcDevAuthenticationMiddleware
-} = require('@commercetools-frontend/mc-dev-authentication');
-
-const applicationConfig = processConfig();
-const compiledHeaders = processHeaders(applicationConfig);
-const host = process.env.HOST || '0.0.0.0'; // We support configuring the sockjs pathname during development.
-// These settings let a developer run multiple simultaneous projects.
-// They are used as the connection `hostname`, `pathname` and `port`
-// in webpackHotDevClient. They are used as the `sockHost`, `sockPath`
-// and `sockPort` options in webpack-dev-server.
-
-const sockHost = process.env.WDS_SOCKET_HOST;
-const sockPath = process.env.WDS_SOCKET_PATH; // default: '/ws'
-
-const sockPort = process.env.WDS_SOCKET_PORT;
-
-module.exports = ({
-  port,
-  publicPath
-}) => ({
-  client: {
-    overlay: false,
-    webSocketURL: {
-      hostname: sockHost,
-      pathname: sockPath,
-      port: sockPort
-    }
-  },
-  // Enable gzip compression of generated files.
-  compress: true,
-  devMiddleware: {
-    // It is important to tell WebpackDevServer to use the same "publicPath" path as
-    // we specified in the webpack config. When homepage is '.', default to serving
-    // from the root.
-    publicPath
-  },
-  headers: compiledHeaders,
-  historyApiFallback: {
-    // Paths with dots should still use the history fallback.
-    // See https://github.com/facebookincubator/create-react-app/issues/387.
-    disableDotRule: true,
-    index: publicPath
-  },
-  host,
-  hot: true,
-  https: false,
-  port,
-
-  setupMiddlewares(middlewares, devServer) {
-    if (!devServer) {
-      throw new Error('webpack-dev-server is not defined');
-    }
-
-    devServer.app.use(createMcDevAuthenticationMiddleware(applicationConfig));
-    return middlewares;
-  }
-
-});

package/build/index.js

@@ -1,16 +0,0 @@
-"use strict";
-
-const createWebpackConfigForDevelopment = require('./config/create-webpack-config-for-development');
-
-const createWebpackConfigForProduction = require('./config/create-webpack-config-for-production');
-
-const vendorsToCompile = require('./config/vendors-to-transpile');
-
-const createPostcssConfig = require('./config/create-postcss-config');
-
-module.exports = {
-  createWebpackConfigForDevelopment,
-  createWebpackConfigForProduction,
-  vendorsToCompile,
-  createPostcssConfig
-};

package/build/utils/auth.js

@@ -1,34 +0,0 @@
-"use strict";
-
-const fetch = require('node-fetch');
-
-const userAgent = require('./user-agent');
-
-const getAuthToken = async (mcApiUrl, payload) => {
-  const response = await fetch(`${mcApiUrl}/tokens/cli`, {
-    method: 'POST',
-    headers: {
-      Accept: 'application/json',
-      'Content-Type': 'application/json',
-      'x-user-agent': userAgent
-    },
-    body: JSON.stringify(payload)
-  });
-
-  if (!response.ok) {
-    const text = await response.text();
-    let parsed;
-
-    try {
-      parsed = JSON.parse(text);
-    } catch (error) {}
-
-    const errorMessage = parsed ? parsed.message : text;
-    throw new Error(errorMessage);
-  }
-
-  const authToken = await response.json();
-  return authToken;
-};
-
-exports.getAuthToken = getAuthToken;