@scandipwa/magento-scripts 2.1.4 → 2.2.0

package/lib/util/database.js

@@ -99,7 +99,89 @@ const isTableExists = async (database, tableName, { databaseConnection }) => {
     return tableCount > 0
 }
 
+/**
+ * @param {TemplateStringsArray} sqlString
+ * @param  {...any} variables
+ * @returns {string}
+ */
+const sql = (sqlString, ...variables) => {
+    return sqlString.reduce(
+        (acc, val, i) =>
+            `${acc}${
+                typeof variables[i] === 'undefined'
+                    ? ''
+                    : typeof variables[i] === 'string'
+                    ? `'${variables[i]}'`
+                    : String(variables[i])
+            }${val}`,
+        ''
+    )
+}
+
+/**
+ * @param {Object} param0
+ * @param {string} param0.table
+ * @param {[string, string, any][]} param0.where
+ * @param {Record<string, any>} param0.data
+ * @param {import('../../typings/context').ListrContext} param1
+ */
+const databaseQuery = async (
+    { table, where, data },
+    { databaseConnection }
+) => {
+    const values = Object.entries(data).map(([key, val]) => ({
+        path: key,
+        value: val
+    }))
+
+    const whereInQuery = where
+        .map(([key, operator, val]) => `${key} ${operator} ${sql`${val}`}`)
+        .join(' AND ')
+
+    const query = `
+        SELECT * FROM ${table}
+        WHERE ${whereInQuery};`
+
+    const [rows] = await databaseConnection.query(query)
+
+    if (rows.length === 0) {
+        const query2 = `INSERT INTO ${table}
+        (${[...where.map(([key]) => key), ...values.map((p) => p.path)].join(
+            ', '
+        )})
+        VALUES (${[
+            ...where.map(([, , val]) => sql`${val}`),
+            ...values.map((p) => sql`${p.value}`)
+        ].join(', ')});`
+
+        await databaseConnection.query(query2)
+
+        return true
+    }
+
+    const [row] = rows
+
+    const incorrectData = Object.entries(data).filter(
+        ([key, val]) => row[key] !== val
+    )
+
+    if (incorrectData.length > 0) {
+        await databaseConnection.query(
+            `UPDATE ${table}
+            SET ${incorrectData
+                .map(([key, val]) => `${key} = ${sql`${val}`}`)
+                .join(', ')}
+            WHERE ${whereInQuery};`
+        )
+
+        return true
+    }
+
+    return false
+}
+
 module.exports = {
     updateTableValues,
-    isTableExists
+    isTableExists,
+    databaseQuery
 }

package/lib/util/instance-metadata.js

@@ -24,7 +24,7 @@ const getInstanceMetadata = (ctx) => {
         ports,
         config: {
             magentoConfiguration,
-            overridenConfiguration: { host, ssl }
+            overridenConfiguration: { ssl, storeDomains }
         }
     } = ctx
 
@@ -43,25 +43,22 @@ const getInstanceMetadata = (ctx) => {
      */
     const maildev = []
 
-    const isNgrok = host.endsWith('ngrok.io')
+    frontend.push({
+        title: WEB_LOCATION_TITLE,
+        text: `${ssl.enabled ? 'https' : 'http'}://${storeDomains.admin}${
+            ssl.enabled || ports.sslTerminator === 80
+                ? ''
+                : `:${ports.sslTerminator}`
+        }/`
+    })
 
-    if (isNgrok) {
-        frontend.push({
-            title: WEB_LOCAL_LOCATION_TITLE,
-            text: `${ssl.enabled ? 'https' : 'http'}://localhost${
-                ssl.enabled || ports.sslTerminator === 80
-                    ? ''
-                    : `:${ports.sslTerminator}`
-            }/`
-        })
-        frontend.push({
-            title: WEB_LOCATION_TITLE,
-            text: `${ssl.enabled ? 'https' : 'http'}://${host}/`
-        })
-    } else {
+    for (const [storeCode, domain] of Object.entries(storeDomains)) {
+        if (storeCode === 'admin') {
+            continue
+        }
         frontend.push({
-            title: WEB_LOCATION_TITLE,
-            text: `${ssl.enabled ? 'https' : 'http'}://${host}${
+            title: `Frontend store ${logger.style.file(storeCode)} location`,
+            text: `${ssl.enabled ? 'https' : 'http'}://${domain}${
                 ssl.enabled || ports.sslTerminator === 80
                     ? ''
                     : `:${ports.sslTerminator}`
@@ -87,7 +84,7 @@ const getInstanceMetadata = (ctx) => {
 
     maildev.push({
         title: WEB_MAILDEV_LOCATION_TITLE,
-        text: `http://${host}:${ports.maildevWeb}/`
+        text: `http://localhost:${ports.maildevWeb}/`
     })
 
     return {

package/lib/util/match-filesystem.js

@@ -17,6 +17,7 @@ const matchFilesystem = async (cwd, structure) => {
 
         return ok
     }
+
     if (typeof structure === 'object') {
         const ok = (
             await Promise.all(

package/lib/util/run-magento.js

@@ -6,6 +6,7 @@ const { runPHPContainerCommand } = require('../tasks/php/php-container')
  * @param {import('../../typings/context').ListrContext} ctx
  * @param {String} command magento command
  * @param {Parameters<typeof import('../tasks/php/php-container')['runPHPContainerCommand']>[2] & { throwNonZeroCode?: boolean }} options
+ * @returns {Promise<{ code: number, result: string }>}
  */
 const runMagentoCommand = async (ctx, command, options = {}) => {
     const { throwNonZeroCode = true } = options

package/package.json

@@ -3,7 +3,7 @@
     "description": "Scripts and configuration used by CMA.",
     "homepage": "https://docs.create-magento-app.com/",
     "repository": "github:scandipwa/create-magento-app",
-    "version": "2.1.4",
+    "version": "2.2.0",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -58,5 +58,5 @@
     "devDependencies": {
         "@types/yargs": "^17.0.13"
     },
-    "gitHead": "71b3bef6b620023fedca851dd529b60e22b113e0"
+    "gitHead": "395e82651091c1355946c60224457b01f9e7204d"
 }

package/tsconfig.json

@@ -12,7 +12,8 @@
         "moduleResolution": "Node",
         "types": [
             "./typings"
-        ]
+        ],
+        "noEmit": true
     },
     "exclude": [
         "**/node_modules",

package/typings/common.d.ts

@@ -0,0 +1,53 @@
+import { CMAConfiguration, ServiceWithImage } from "./index"
+import { ListrContext } from "./context"
+
+export type MagentoVersionConfigurationFunction = (args: ListrContext['config']['baseConfig']) => MagentoVersionConfiguration
+
+export type MagentoVersionConfiguration = CMAConfigurationWithMySQL &  {
+    magentoVersion: string
+    isDefault?: boolean
+}
+
+export type CMAConfigurationWithMySQL = Optional<CMAConfiguration, 'storeDomains' | 'host' | 'magento' | 'prefix' | 'ssl'> & {
+    configuration: {
+        mysql: Optional<ServiceWithImage, 'image'>
+    }
+}
+
+type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>
+
+export interface ConfigPHPType {
+    modules: Record<string, number>
+    scopes?: {
+        websites: {
+            [websiteCode: string]: {
+                website_id: string
+                code: string
+                name: string
+                sort_order: string
+                default_group_id: string
+                is_default: string
+            }
+        }
+        groups: {
+            group_id: string
+            website_id: string
+            code: string
+            name: string
+            root_category_id: string
+            default_store_id: string
+        }[]
+        stores: {
+            [storeCode: string]: {
+                store_id: string
+                code: string
+                website_id: string
+                group_id: string
+                name: string
+                sort_order: string
+                is_active: string
+            }
+        }
+    }
+    system?: any
+}

package/typings/index.d.ts

@@ -202,6 +202,11 @@ export interface PHPConfiguration {
      * Extensions for PHP
      */
     extensions: PHPExtensions
+
+    /**
+     * Environmental variables used for PHP container
+     */
+    env: Record<string, unknown>
 }
 export interface SSLConfiguration {
     /**
@@ -224,6 +229,32 @@ export interface SSLConfiguration {
      * `./ssl_certificate-key.pem`
      */
     ssl_certificate_key?: string
+
+    /**
+     * SSL external provider configuration
+     *
+     * Set to `true` if you don't need locally provided SSL certificates
+     *
+     * @default false
+     */
+    external_provider?: boolean
+}
+
+export interface NewRelicConfiguration {
+    /**
+     * Enables or disables New Relic in application
+     */
+    enabled: boolean
+
+    /**
+     * New Relic Agent version
+     */
+    agentVersion?: string
+
+    /**
+     * New Relic license key
+     */
+    licenseKey?: string
 }
 
 export interface CMAConfiguration {
@@ -271,6 +302,11 @@ export interface CMAConfiguration {
          */
         sslTerminator: SSLTerminatorConfiguration
 
+        /**
+         * New Relic configuration
+         */
+        newRelic?: NewRelicConfiguration
+
         /**
          * MailDev configuration
          */
@@ -316,9 +352,28 @@ export interface CMAConfiguration {
     /**
      *  Custom host for website base url
      *  @default 'localhost'
+     *
+     * @deprecated Use `storeDomains` instead, as follows: `storeDomains: { admin: 'localhost' }`
      */
     host: string
 
+    /**
+     * Custom domains for magento stores by store code
+     *
+     * Note: you can look up **scope_id** in `app/etc/config.php` in `scopes` section.
+     *
+     * @default { admin: 'localhost' }
+     *
+     * @example ```js
+     *  storeDomains: {
+     *   admin: 'localhost',
+     *   custom_store_code: 'scandipwa.local',
+     *   another_store_code: 'another-store.local'
+     * }
+     * ```
+     */
+    storeDomains: { admin: string } & Record<string, string>
+
     /**
      * SSL Configuration
      */