@scandipwa/magento-scripts 2.0.0-alpha.0 → 2.0.0-alpha.3

package/typings/context.d.ts

@@ -11,7 +11,7 @@ export interface ListrContext {
         app: number
         fpm: number
         xdebug: number
-        mysql: number
+        mariadb: number
         redis: number
         elasticsearch: number
         varnish: number
@@ -45,15 +45,15 @@ export interface ListrContext {
             network: {
                 name: string
             }
-            volumes: Record<'mysql' | 'redis' | 'elasticsearch' | 'nginx' | 'appPub' | 'appSetup', {
+            volumes: Record<'mariadb' | 'redis' | 'elasticsearch' | 'nginx' | 'appPub' | 'appSetup', {
                 name: string
-                opts?: {
+                opt?: {
                     type: string
                     device: string
                     o: string
                 }
             }>
-            getContainers(): Record<'php' | 'sslTerminator' | 'nginx' | 'redis' | 'mysql' | 'elasticsearch' | 'varnish', {
+            getContainers(): Record<'php' | 'sslTerminator' | 'nginx' | 'redis' | 'mariadb' | 'elasticsearch' | 'varnish', {
                 _: string
                 ports: string[]
                 healthCheck: {
@@ -88,6 +88,6 @@ export interface ListrContext {
         analytics: boolean
         useNonOverlappingPorts: boolean
     }
-    mysqlConnection: mysql2.Connection
+    databaseConnection: mysql2.Connection
     isSetupUpgradeNeeded?: boolean
 }

package/typings/index.d.ts

@@ -1,14 +1,21 @@
 import { ListrContext } from './context';
 
 /* eslint-disable no-use-before-define */
-export interface ServiceWithVersion {
+export interface ServiceWithImage {
     /**
      * Service version
+     *
+     * @deprecated
      */
     version: string
+
+    /**
+     * Service Docker image
+     */
+    image: string
 }
 
-export interface SSLTerminatorConfiguration extends ServiceWithVersion {
+export interface SSLTerminatorConfiguration extends ServiceWithImage {
     /**
      * Configuration file location
      *
@@ -17,7 +24,7 @@ export interface SSLTerminatorConfiguration extends ServiceWithVersion {
     configTemplate: string
 }
 
-export interface NginxConfiguration extends ServiceWithVersion {
+export interface NginxConfiguration extends ServiceWithImage {
     /**
      * Configuration file location
      *
@@ -26,7 +33,14 @@ export interface NginxConfiguration extends ServiceWithVersion {
     configTemplate: string
 }
 
-export interface VarnishConfiguration extends ServiceWithVersion {
+export interface ElasticSearchConfiguration extends ServiceWithImage {
+    /**
+     * Environmental variables used for Elasticsearch container
+     */
+    env: Record<string, unknown>
+}
+
+export interface VarnishConfiguration extends ServiceWithImage {
     /**
      * Enable or disable Varnish in the project
      */
@@ -40,6 +54,13 @@ export interface VarnishConfiguration extends ServiceWithVersion {
     configTemplate: string
 }
 
+export interface ComposerConfiguration {
+    /**
+     * Composer version
+     */
+    version: string
+}
+
 export interface PHPExtensionInstallationInstruction {
     /**
      * Alternative name for extension
@@ -109,11 +130,6 @@ export interface PHPConfiguration {
      * Extensions for PHP
      */
     extensions: PHPExtensions
-
-    /**
-     * Disabled extension list
-     */
-    disabledExtensions?: string[]
 }
 export interface SSLConfiguration {
     /**
@@ -153,30 +169,25 @@ export interface CMAConfiguration {
          */
         nginx: NginxConfiguration
 
-        /**
-         * MySQL configuration
-         */
-        mysql: ServiceWithVersion
-
         /**
          * MariaDB configuration
          */
-        mariadb: ServiceWithVersion
+        mariadb: ServiceWithImage
 
         /**
          * ElasticSearch configuration
          */
-        elasticsearch: ServiceWithVersion
+        elasticsearch: ElasticSearchConfiguration
 
         /**
          * Redis configuration
          */
-        redis: ServiceWithVersion
+        redis: ServiceWithImage
 
         /**
          * Composer configuration
          */
-        composer: ServiceWithVersion
+        composer: ComposerConfiguration
 
         /**
          * Varnish configuration
@@ -222,8 +233,8 @@ export interface CMAConfiguration {
     }
     /**
      *  Custom host for website base url
-     * @default 'localhost'
-     * */
+     *  @default 'localhost'
+     */
     host: string
 
     /**
@@ -242,14 +253,4 @@ export interface CMAConfiguration {
      * If prefix is set to `false` docker container and volume names will only include folder name **which is not safe and not recommended**.
      */
     prefix: boolean
-
-    /**
-     * Non-overlapping ports config
-     * @default false
-     *
-     * @deprecated Use global configuration file.
-     * @description If set to `true` CMA will try retrieving others CMA projects port configuration
-     * and will not use their ports for itself.
-     */
-    useNonOverlappingPorts: boolean
 }