@commercetools-frontend/application-cli 1.4.0 → 1.6.0

package/cli/package.json

@@ -0,0 +1,4 @@
+{
+    "main": "dist/commercetools-frontend-application-cli-cli.cjs.js",
+    "module": "dist/commercetools-frontend-application-cli-cli.esm.js"
+}

package/dist/declarations/src/cli.d.ts

@@ -0,0 +1,2 @@
+declare const run: () => Promise<void>;
+export { run };

package/dist/declarations/src/commands/compile-deployments.d.ts

@@ -0,0 +1,3 @@
+import type { TAllCliFlags } from '../types';
+declare function command(cliFlags: TAllCliFlags, cwd: string): Promise<void>;
+export default command;

package/dist/declarations/src/commands/compile-menu.d.ts

@@ -0,0 +1,3 @@
+import type { TCompileMenuFlags } from '../types';
+declare function command(cliFlags: TCompileMenuFlags, cwd: string): Promise<void>;
+export default command;

package/dist/declarations/src/commands/create-version.d.ts

@@ -0,0 +1,3 @@
+import type { TCreateVersionFlags } from '../types';
+declare function command(cliFlags: TCreateVersionFlags): Promise<void>;
+export default command;

package/dist/declarations/src/commands/validate-menu.d.ts

@@ -0,0 +1,5 @@
+import type { Schema } from 'jsonschema';
+import type { TValidateMenuFlags } from '../types';
+export declare function validateMenu(menuJson: string, schema?: Schema): string;
+declare function command(cliFlags: TValidateMenuFlags): Promise<string>;
+export default command;

package/dist/declarations/src/schema.d.ts

@@ -0,0 +1,228 @@
+export declare const navbarMenuSchema: {
+    $schema: string;
+    title: string;
+    type: string;
+    properties: {
+        submenu: {
+            type: string;
+            items: {
+                type: string;
+                properties: {
+                    key: {
+                        type: string;
+                    };
+                    uriPath: {
+                        type: string;
+                    };
+                    icon: {
+                        type: string;
+                    };
+                    featureToggle: {
+                        type: string[];
+                    };
+                    labelAllLocales: {
+                        type: string;
+                        items: {
+                            type: string;
+                            properties: {
+                                locale: {
+                                    type: string;
+                                };
+                                value: {
+                                    type: string;
+                                };
+                            };
+                            required: string[];
+                        }[];
+                    };
+                    menuVisibility: {
+                        type: string[];
+                    };
+                    permissions: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    dataFences: {
+                        type: string[];
+                        items: {
+                            type: string[];
+                            properties: {
+                                group: {
+                                    type: string;
+                                };
+                                name: {
+                                    type: string;
+                                };
+                                type: {
+                                    type: string;
+                                };
+                            };
+                        }[];
+                    };
+                    actionRights: {
+                        type: string[];
+                        items: {
+                            type: string[];
+                            properties: {
+                                group: {
+                                    type: string;
+                                };
+                                name: {
+                                    type: string;
+                                };
+                            };
+                        }[];
+                    };
+                };
+            }[];
+        };
+        key: {
+            type: string;
+        };
+        uriPath: {
+            type: string;
+        };
+        icon: {
+            type: string;
+        };
+        featureToggle: {
+            type: string[];
+        };
+        labelAllLocales: {
+            type: string;
+            items: {
+                type: string;
+                properties: {
+                    locale: {
+                        type: string;
+                    };
+                    value: {
+                        type: string;
+                    };
+                };
+                required: string[];
+            }[];
+        };
+        menuVisibility: {
+            type: string[];
+        };
+        permissions: {
+            type: string;
+            items: {
+                type: string;
+            };
+        };
+        dataFences: {
+            type: string[];
+            items: {
+                type: string[];
+                properties: {
+                    group: {
+                        type: string;
+                    };
+                    name: {
+                        type: string;
+                    };
+                    type: {
+                        type: string;
+                    };
+                };
+            }[];
+        };
+        actionRights: {
+            type: string[];
+            items: {
+                type: string[];
+                properties: {
+                    group: {
+                        type: string;
+                    };
+                    name: {
+                        type: string;
+                    };
+                };
+            }[];
+        };
+    };
+    required: string[];
+};
+export declare const appbarMenuSchema: {
+    $schema: string;
+    title: string;
+    type: string;
+    items: {
+        type: string;
+        properties: {
+            key: {
+                type: string;
+            };
+            uriPath: {
+                type: string;
+            };
+            icon: {
+                type: string;
+            };
+            featureToggle: {
+                type: string[];
+            };
+            labelAllLocales: {
+                type: string;
+                items: {
+                    type: string;
+                    properties: {
+                        locale: {
+                            type: string;
+                        };
+                        value: {
+                            type: string;
+                        };
+                    };
+                    required: string[];
+                }[];
+            };
+            menuVisibility: {
+                type: string[];
+            };
+            permissions: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            dataFences: {
+                type: string[];
+                items: {
+                    type: string[];
+                    properties: {
+                        group: {
+                            type: string;
+                        };
+                        name: {
+                            type: string;
+                        };
+                        type: {
+                            type: string;
+                        };
+                    };
+                }[];
+            };
+            actionRights: {
+                type: string[];
+                items: {
+                    type: string[];
+                    properties: {
+                        group: {
+                            type: string;
+                        };
+                        name: {
+                            type: string;
+                        };
+                    };
+                }[];
+            };
+        };
+        required: string[];
+    }[];
+};

package/dist/declarations/src/types.d.ts

@@ -0,0 +1,92 @@
+export type TApplicationAssetsBucketConfig = {
+    bucketRegion: string;
+    prNumber?: string;
+    applicationName: string;
+};
+export type TApplicationIndexBucketConfig = {
+    bucketRegion: string;
+    prNumber?: string;
+    applicationName: string;
+    cloudEnvironment: string;
+};
+export type TUploadScriptFile = {
+    fileName: string;
+    fileContent: string;
+    filePath: string;
+};
+type TPaths = {
+    publicAssetsPath: string;
+    deploymentsPath: string;
+    dotenvPath?: string;
+    assetsPath: string;
+};
+export type TCompileEnvApplicationIndexes = {
+    cliFlags: TCompileDeploymentsFlags;
+    paths: TPaths;
+    bucketRegion: string;
+    cloudEnvironment: string;
+};
+export type TCompileApplicationAssets = {
+    cliFlags: TCompileDeploymentsFlags;
+    paths: TPaths;
+    bucketRegion: string;
+};
+export type TCosmiconfigResult = {
+    config: {
+        [key: string]: string[];
+    };
+};
+export type TCreateApplicationIndexUploadScript = {
+    packageManagerName: string;
+    bucketUrl: string;
+    cdnUrl: string;
+    cloudEnvironment: string;
+    buildRevision: string;
+    buildNumber: number;
+    applicationIndexOutFile: string;
+};
+export type TCreateApplicationAssetsUploadScript = {
+    bucketUrl: string;
+    assetsPath: string;
+    skipMenu: boolean;
+};
+export type TLoadDotDev = {
+    dotenvPath?: string;
+    cloudEnvironment: string;
+};
+export type TLocalizedField = {
+    locale: string;
+    value: string;
+};
+export type TCompileDeploymentsFlags = {
+    applicationName: string;
+    buildRevision: string;
+    buildNumber: number;
+    dotenvFolder?: string;
+    prNumber?: string;
+    mcUrl?: string;
+    mcApiUrl?: string;
+    applicationIndexOutFile: string;
+    applicationIndexUploadScriptOutFile: string;
+    applicationAssetsUploadScriptOutFile: string;
+    ciAssetsRootPath?: string;
+    packageManagerName: string;
+    skipMenu: boolean;
+};
+export type TCompileMenuFlags = {
+    dotenvFolder?: string;
+};
+export type TCreateVersionFlags = {
+    versionUrl: string;
+    buildRevision: string;
+    buildNumber: number;
+    rollbacks: number;
+    outFile?: string;
+    packageManagerName: string;
+};
+export type TValidateMenuFlags = {
+    inputFile: string;
+    navigation?: string;
+};
+export type TAllCliFlags = TCompileDeploymentsFlags & TCompileMenuFlags & TCreateVersionFlags & TValidateMenuFlags;
+export {};

package/dist/declarations/src/utils/create-application-assets-upload-script.d.ts

@@ -0,0 +1,3 @@
+import type { TCreateApplicationAssetsUploadScript } from '../types';
+declare function createApplicationAssetsUploadScript({ bucketUrl, assetsPath, skipMenu, }: TCreateApplicationAssetsUploadScript): string;
+export default createApplicationAssetsUploadScript;

package/dist/declarations/src/utils/create-application-index-upload-script.d.ts

@@ -0,0 +1,3 @@
+import type { TCreateApplicationIndexUploadScript } from '../types';
+declare function createApplicationIndexUploadScript({ packageManagerName, bucketUrl, cdnUrl, cloudEnvironment, buildRevision, buildNumber, applicationIndexOutFile, }: TCreateApplicationIndexUploadScript): string;
+export default createApplicationIndexUploadScript;

package/dist/declarations/src/utils/get-application-directory.d.ts

@@ -0,0 +1,2 @@
+declare function getApplicationDirectory(cwd: string): string;
+export default getApplicationDirectory;

package/dist/declarations/src/utils/is-ci.d.ts

@@ -0,0 +1,2 @@
+declare function isCI(): boolean;
+export default isCI;

package/dist/declarations/src/utils/load-dotenv-files.d.ts

@@ -0,0 +1,5 @@
+import type { TLoadDotDev } from '../types';
+declare function loadDotenvFiles({ dotenvPath, cloudEnvironment }: TLoadDotDev): {
+    [x: string]: string;
+};
+export default loadDotenvFiles;

package/dist/declarations/src/utils/resolve-in-application.d.ts

@@ -0,0 +1,2 @@
+declare function resolveInApplication(relativePath: string, cwd: string): string;
+export default resolveInApplication;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools-frontend/application-cli",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "Internal CLI to manage Merchant Center application deployments across various environments.",
   "keywords": [
     "commercetools",
@@ -8,26 +8,36 @@
     "custom-application"
   ],
   "license": "MIT",
-  "type": "module",
-  "bin": "./src/bin/cli.js",
+  "main": "dist/commercetools-frontend-application-cli.cjs.js",
+  "module": "dist/commercetools-frontend-application-cli.esm.js",
+  "bin": "bin/cli.js",
   "files": [
-    "src",
+    "cli",
+    "dist",
     "package.json",
     "LICENSE",
     "README.md"
   ],
   "dependencies": {
     "@babel/core": "^7.21.0",
-    "@commercetools-frontend/application-config": "22.0.0",
-    "@manypkg/find-root": "2.1.0",
-    "cosmiconfig": "8.1.3",
-    "dotenv": "16.0.3",
-    "execa": "6.1.0",
+    "@babel/runtime": "^7.21.0",
+    "@babel/runtime-corejs3": "^7.21.0",
+    "@commercetools-frontend/application-config": "22.3.0",
+    "@commercetools-frontend/constants": "22.3.0",
+    "@manypkg/find-root": "2.2.0",
+    "cac": "^6.7.14",
+    "cosmiconfig": "8.2.0",
+    "dotenv": "16.3.1",
+    "execa": "5.1.1",
     "jsonschema": "^1.4.1",
-    "listr": "0.14.3",
-    "listr-verbose-renderer": "0.6.0",
-    "mri": "1.2.0",
-    "node-fetch": "2.6.9"
+    "listr2": "^6.4.2",
+    "node-fetch": "2.6.11"
+  },
+  "devDependencies": {
+    "@tsconfig/node18": "1.0.3",
+    "@types/node": "18.16.18",
+    "@types/node-fetch": "2.6.2",
+    "typescript": "^5.1.3"
   },
   "engines": {
     "node": ">=14",
@@ -35,5 +45,13 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "preconstruct": {
+    "entrypoints": [
+      "./cli.ts"
+    ]
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit"
   }
 }

package/src/bin/cli.js

@@ -1,100 +0,0 @@
-#!/usr/bin/env node
-
-import mri from 'mri';
-import compileDeployments from '../commands/compile-deployments.js';
-import compileMenu from '../commands/compile-menu.js';
-import createVersion from '../commands/create-version.js';
-import validateMenu from '../commands/validate-menu.js';
-const cwd = process.cwd();
-
-(async () => {
-  try {
-    const cliFlags = mri(process.argv.slice(2), {
-      alias: { help: ['h'] },
-      default: {
-        rollbacks: 15,
-        'build-revision': process.env.CIRCLE_SHA1,
-        'build-number': process.env.CIRCLE_BUILD_NUM,
-        'application-index-upload-script-out-file': 'upload-index.sh',
-        'application-assets-upload-script-out-file': 'upload-assets.sh',
-        'application-index-out-file': 'application.html',
-        'skip-menu': false,
-        'package-manager-name': 'yarn',
-      },
-      boolean: ['skip-menu'],
-    });
-    const cliCommands = cliFlags._;
-
-    if (
-      cliCommands.length === 0 ||
-      (cliCommands.help && cliCommands.length === 0)
-    ) {
-      console.log(`
-Usage: application-cli [command] [flags]
-
-Displays help information.
-
-Command:
-  compile-deployments   Compile the deployments for an application for all environments.
-
-Options:
-  --application-name                           <string>  (required) The name of the application being compiled for example application-products.
-  --build-revision                             <git-sha> (optional) The git commit SHA which is being built. Defaults to the 'CIRCLE_SHA1' environment variable.
-  --build-number                               <string>  (optional) A number of the build on the Continuous Integration system. Defaults to the 'CIRCLE_BUILD_NUM' environment variable.
-  --dotenv-folder                              <string>  (optional) The path to a folder containing a dotenv file '.env.production' and a cloud-environment specific dotenv file (for example '.env.gcp-production-eu'). Those values are parsed and merged together to be used by the \`mc-scripts compile-html\` command.
-  --pr-number                                  <string>  (optional) A pull request number determining a scoped storage bucket for the deployment. Please use it carefully.
-  --mc-url                                     <string>  (optional) The MC URL of the deployment. This is usually inferred from the env file and overwrites the value. Please use it carefully.
-  --mc-api-url                                 <string>  (optional) The MC API URL of the deployment. This is usually inferred from the env file and overwrites the value. Please use it carefully.
-  --application-index-out-file                 <path>    (optional) The name of the application index file. Defaults to application.html.
-  --application-index-upload-script-out-file   <path>    (optional) The name of the the application index upload script file. Defaults to upload-index.sh.
-  --application-assets-upload-script-out-file  <path>    (optional) The name of the the assets upload script file. Defaults to upload-assets.sh.
-  --ci-assets-root-path                        <path>    (optional) A replacement value for the scripts root path only used on CI (e.g. '--ci-assets-root-path=/root/') used in generated scripts.
-  --skip-menu                                            (optional) If provided, it will skip uploading the 'menu.json'.
-
-Command:
-  compile-menu   Compile the menu links of an application into a 'menu.json'. This is only required for internal applications
-
-Options:
-  --dotenv-folder                              <string>  (optional) The path to a folder containing a dotenv file '.env.production' and a cloud-environment specific dotenv file (for example '.env.gcp-production-eu'). Those values are parsed and merged together to be used by the application config.
-
-Command:
-  create-version  Output a JSON string about the information in the 'version.json' for a deployment, including the updated list of rollbacks.
-
-Options:
-  --version-url <url>            (required) The path of an application's current 'version.json' within the storage bucket.
-  --build-revision <git-sha>     (optional) The git commit SHA that needs to be deployed. Defaults to the 'CIRCLE_SHA1' environment variable.
-  --build-number <url>           (optional) The number of a Continuous Integration build. Defaults to the 'CIRCLE_BUILD_NUM' environment variable.
-  --rollbacks <int>              (optional) The number of max rollbacks to keep. Defaults to 5.
-  --out-file <path>              (optional) The path to the file where to write the JSON. If not specified, the JSON is printed to stdout.
-  --package-manager-name <sring> (optional) Name of the binary of the used package manager (e.g. pnpm). Defaults to yarn.
-`);
-      process.exit(0);
-    }
-
-    const cliCommand = cliCommands[0];
-
-    switch (cliCommand) {
-      case 'compile-deployments':
-        await compileDeployments(cliFlags, cwd);
-        process.exit(0);
-        break;
-      case 'compile-menu':
-        await compileMenu(cliFlags, cwd);
-        process.exit(0);
-        break;
-      case 'validate-menu':
-        await validateMenu(cliFlags, cwd);
-        process.exit(0);
-        break;
-      case 'create-version':
-        await createVersion(cliFlags, cwd);
-        process.exit(0);
-        break;
-      default:
-        throw new Error(`💀 Unknown command "${cliCommand}".`);
-    }
-  } catch (error) {
-    console.error(error);
-    process.exit(1);
-  }
-})();