@commercetools-frontend/create-mc-app 22.8.0 → 22.8.2

package/src/types.ts

@@ -1,11 +1,15 @@
+import { applicationTypes, availableTemplates } from './constants';
+
 export type TCliGlobalOptions = {
   '--'?: string[];
 };
 
-export type TTemplate = 'starter' | 'starter-typescript';
+export type TApplicationType = keyof typeof applicationTypes;
+export type TTemplate = keyof typeof availableTemplates;
 export type TPackageManager = 'npm' | 'yarn' | 'pnpm';
 
 export type TCliCommandOptions = {
+  applicationType: TApplicationType;
   template: TTemplate;
   templateVersion: string;
   skipInstall: boolean;
@@ -16,11 +20,12 @@ export type TCliCommandOptions = {
 };
 
 export type TCliTaskOptions = {
+  applicationType: TApplicationType;
   projectDirectoryName: string;
   projectDirectoryPath: string;
   templateName: TCliCommandOptions['template'];
   tagOrBranchVersion: string;
-  entryPointUriPath: string;
+  entryPointUriPath?: string;
   initialProjectKey: string;
   packageManager: TCliCommandOptions['packageManager'];
 };

package/src/utils.ts

@@ -1,6 +1,10 @@
-import fs from 'fs';
+import fs from 'node:fs';
 import execa from 'execa';
-import type { TCliTaskOptions, TPackageManager } from './types';
+import type {
+  TApplicationType,
+  TCliTaskOptions,
+  TPackageManager,
+} from './types';
 
 const isSemVer = (version: string) => /^(v?)([0-9].[0-9].[0-9])+/.test(version);
 
@@ -57,6 +61,9 @@ const resolveFilePathByExtension = (requestedModule: string) => {
   return `${requestedModule}${fileExtension}`;
 };
 
+const isCustomView = (applicationType: TApplicationType) =>
+  applicationType === 'custom-view';
+
 export {
   isSemVer,
   shouldUseYarn,
@@ -66,4 +73,5 @@ export {
   resolveFilePathByExtension,
   getPreferredPackageManager,
   getInstallCommand,
+  isCustomView,
 };

package/src/validations.ts

@@ -1,24 +1,42 @@
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
 import semver from 'semver';
-import type { TTemplate } from './types';
+import { applicationTypes, availableTemplates } from './constants';
+import type { TApplicationType, TTemplate } from './types';
 import { isSemVer } from './utils';
 
-const availableTemplates = {
-  starter: 'starter',
-  'starter-typescript': 'starter-typescript',
-} as const;
+const throwIfApplicationTypeIsNotSupported = (
+  applicationType: TApplicationType
+) => {
+  switch (applicationType) {
+    case applicationTypes['custom-view']: {
+      if (process.env.ENABLE_EXPERIMENTAL_CUSTOM_VIEWS !== 'true') {
+        throw new Error(`Custom Views generation is not yet supported.`);
+      }
+      break;
+    }
+    case applicationTypes['custom-application']:
+      break;
+    default: {
+      const applicationTypesList = Object.keys(applicationTypes).toString();
+      throw new Error(
+        `The provided application type "${applicationType}" does not exist. Available types are "${applicationTypesList}". Make sure you are also using the latest version of "@commercetools-frontend/create-mc-app".`
+      );
+    }
+  }
+};
 
 const throwIfTemplateIsNotSupported = (templateName: TTemplate) => {
   switch (templateName) {
     case availableTemplates.starter:
     case availableTemplates['starter-typescript']:
       break;
-    default:
+    default: {
       const templateNamesList = Object.keys(availableTemplates).toString();
       throw new Error(
         `The provided template name "${templateName}" does not exist. Available templates are "${templateNamesList}". Make sure you are also using the latest version of "@commercetools-frontend/create-mc-app".`
       );
+    }
   }
 };
 
@@ -80,6 +98,7 @@ const throwIfNodeVersionIsNotSupported = (
 };
 
 export {
+  throwIfApplicationTypeIsNotSupported,
   throwIfTemplateIsNotSupported,
   throwIfProjectDirectoryExists,
   throwIfTemplateVersionDoesNotExist,

package/dist/declarations/src/tasks/update-custom-application-config.d.ts

@@ -1,4 +0,0 @@
-import type { ListrTask } from 'listr2';
-import type { TCliTaskOptions } from '../types';
-declare function updateCustomApplicationConfig(options: TCliTaskOptions): ListrTask;
-export default updateCustomApplicationConfig;