@aws-amplify/amplify-util-uibuilder 1.6.8 → 1.6.9-mxp.0

package/src/commands/utils/codegenResources.ts

@@ -26,9 +26,7 @@ import {
   ReactThemeStudioTemplateRendererOptions,
 } from '@aws-amplify/codegen-ui-react';
 import { printer } from 'amplify-prompts';
-import {
-  $TSContext, AmplifyCategories, AmplifySupportedService, stateManager,
-} from 'amplify-cli-core';
+import { $TSContext, AmplifyCategories, AmplifySupportedService, stateManager } from 'amplify-cli-core';
 import { getUiBuilderComponentsPath } from './getUiBuilderComponentsPath';
 import { AmplifyStudioClient } from '../../clients';
 
@@ -68,7 +66,8 @@ export const createUiBuilderTheme = (
 ): StudioTheme => {
   const uiBuilderComponentsPath = getUiBuilderComponentsPath(context);
   const rendererFactory = new StudioTemplateRendererFactory(
-    (component: StudioTheme) => (new ReactThemeStudioTemplateRenderer(component, config, options) as unknown) as StudioTemplateRenderer<
+    (component: StudioTheme) =>
+      new ReactThemeStudioTemplateRenderer(component, config, options) as unknown as StudioTemplateRenderer<
         unknown,
         StudioTheme,
         FrameworkOutputManager<unknown>,
@@ -99,7 +98,8 @@ export const createUiBuilderTheme = (
 export const createUiBuilderForm = (context: $TSContext, schema: StudioForm, dataSchema?: GenericDataSchema): StudioForm => {
   const uiBuilderComponentsPath = getUiBuilderComponentsPath(context);
   const rendererFactory = new StudioTemplateRendererFactory(
-    (form: StudioForm) => (new AmplifyFormRenderer(form, dataSchema, config) as unknown) as StudioTemplateRenderer<
+    (form: StudioForm) =>
+      new AmplifyFormRenderer(form, dataSchema, config) as unknown as StudioTemplateRenderer<
         unknown,
         StudioForm,
         FrameworkOutputManager<unknown>,
@@ -130,7 +130,8 @@ export const createUiBuilderForm = (context: $TSContext, schema: StudioForm, dat
 export const generateAmplifyUiBuilderIndexFile = (context: $TSContext, schemas: StudioSchema[]): void => {
   const uiBuilderComponentsPath = getUiBuilderComponentsPath(context);
   const rendererFactory = new StudioTemplateRendererFactory(
-    (schema: StudioSchema[]) => (new ReactIndexStudioTemplateRenderer(schema, config) as unknown) as StudioTemplateRenderer<
+    (schema: StudioSchema[]) =>
+      new ReactIndexStudioTemplateRenderer(schema, config) as unknown as StudioTemplateRenderer<
         unknown,
         StudioSchema[],
         FrameworkOutputManager<unknown>,
@@ -145,7 +146,7 @@ export const generateAmplifyUiBuilderIndexFile = (context: $TSContext, schemas:
   });
 
   try {
-    if(schemas.length) {
+    if (schemas.length) {
       rendererManager.renderSchemaToTemplate(schemas);
     }
   } catch (e) {
@@ -166,7 +167,7 @@ type UtilFileChecks = {
 export const generateAmplifyUiBuilderUtilFile = (context: $TSContext, { hasForms, hasViews }: UtilFileChecks): void => {
   const uiBuilderComponentsPath = getUiBuilderComponentsPath(context);
   const rendererFactory = new StudioTemplateRendererFactory(
-    (utils: UtilTemplateType[]) => (new ReactUtilsStudioTemplateRenderer(utils, config)),
+    (utils: UtilTemplateType[]) => new ReactUtilsStudioTemplateRenderer(utils, config),
   );
 
   const outputPathDir = uiBuilderComponentsPath;
@@ -202,9 +203,7 @@ export const generateAmplifyUiBuilderUtilFile = (context: $TSContext, { hasForms
  * If models are available, they will be populated in the models field of the returned object.
  * If they're not available, it will return undefined
  */
-export const getAmplifyDataSchema = async (
-  studioClient: AmplifyStudioClient,
-): Promise<GenericDataSchema | undefined> => {
+export const getAmplifyDataSchema = async (studioClient: AmplifyStudioClient): Promise<GenericDataSchema | undefined> => {
   if (!studioClient.isGraphQLSupported) {
     return undefined;
   }
@@ -231,8 +230,8 @@ export const getAmplifyDataSchema = async (
 /**
  * generates base create/update froms from names
  */
-export const generateBaseForms = (modelMap: {[model: string]: Set<'create' | 'update'>}): StudioForm[] => {
-  const getSchema = (name: string, type: 'create' | 'update') : StudioForm => ({
+export const generateBaseForms = (modelMap: { [model: string]: Set<'create' | 'update'> }): StudioForm[] => {
+  const getSchema = (name: string, type: 'create' | 'update'): StudioForm => ({
     name: `${name}${type === 'create' ? 'CreateForm' : 'UpdateForm'}`,
     formActionType: type,
     dataType: { dataSourceType: 'DataStore', dataTypeName: name },
@@ -242,10 +241,10 @@ export const generateBaseForms = (modelMap: {[model: string]: Set<'create' | 'up
     cta: {},
   });
 
-  const schemas : StudioForm[] = [];
+  const schemas: StudioForm[] = [];
 
   Object.entries(modelMap).forEach(([name, set]) => {
-    set.forEach(type => schemas.push(getSchema(name, type)));
+    set.forEach((type) => schemas.push(getSchema(name, type)));
   });
   return schemas;
 };

package/src/commands/utils/detachedFormCleanup.ts

@@ -25,7 +25,7 @@ export const isFormSchemaCustomized = (formSchema: StudioForm | Form): boolean =
 
   // Check style
   // If not empty, at least one style must be defined
-  return Object.values(style).some(styleConfig => styleConfig !== undefined);
+  return Object.values(style).some((styleConfig) => styleConfig !== undefined);
 };
 
 /**
@@ -36,19 +36,19 @@ export const isStudioForm = (schema: StudioSchema | undefined): schema is Studio
   return 'formActionType' in schema;
 };
 
-export const deleteDetachedForms = async (detachedForms: {id: string, name: string}[], studioClient: AmplifyStudioClient) => {
-  const deleteForm = async ({id, name}: {id: string, name: string}) => {
+export const deleteDetachedForms = async (detachedForms: { id: string; name: string }[], studioClient: AmplifyStudioClient) => {
+  const deleteForm = async ({ id, name }: { id: string; name: string }) => {
     try {
       // Try to delete the form but don't stop any other operations if it fails
       await studioClient.deleteForm(id);
-      return {status: 'SUCCESS', message: `Deleted detached form ${name}`};
+      return { status: 'SUCCESS', message: `Deleted detached form ${name}` };
     } catch (error) {
-      return {status: 'FAIL', message: `Failed to delete detached form ${name}`}
+      return { status: 'FAIL', message: `Failed to delete detached form ${name}` };
     }
   };
   for await (const status of asyncPool(5, detachedForms, deleteForm)) {
     printer.debug(status.message);
-  };
+  }
 };
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/src/commands/utils/featureFlags.ts

@@ -1,7 +1,5 @@
 /* eslint-disable spellcheck/spell-checker */
-import {
-  FeatureFlags, pathManager, stateManager,
-} from 'amplify-cli-core';
+import { FeatureFlags, pathManager, stateManager } from 'amplify-cli-core';
 import { printer } from 'amplify-prompts';
 
 // This is copy-pasta from the category api until they can expose the method to plugins
@@ -9,7 +7,8 @@ import { printer } from 'amplify-prompts';
 /**
  * Shorthand for Feature flag retrieval.
  */
-const useExperimentalPipelinedTransformerFF = (): boolean => FeatureFlags.getBoolean('graphQLTransformer.useExperimentalPipelinedTransformer');
+const useExperimentalPipelinedTransformerFF = (): boolean =>
+  FeatureFlags.getBoolean('graphQLTransformer.useExperimentalPipelinedTransformer');
 const transformerVersionFF = (): number => FeatureFlags.getNumber('graphQLTransformer.transformerVersion');
 
 /**

package/src/commands/utils/notifyMissingPackages.ts

@@ -1,6 +1,4 @@
-import {
-  pathManager, JSONUtilities, $TSContext, $TSAny,
-} from 'amplify-cli-core';
+import { pathManager, JSONUtilities, $TSContext, $TSAny } from 'amplify-cli-core';
 import { printer } from 'amplify-prompts';
 import fs from 'fs-extra';
 import path from 'path';

package/src/commands/utils/syncAmplifyUiBuilderComponents.ts

@@ -1,14 +1,7 @@
 import { printer } from 'amplify-prompts';
 import { $TSContext } from 'amplify-cli-core';
-import {
-  StudioComponent, StudioTheme, GenericDataSchema, StudioForm, StudioSchema, checkIsSupportedAsForm,
-} from '@aws-amplify/codegen-ui';
-import {
-  createUiBuilderComponent,
-  createUiBuilderForm,
-  createUiBuilderTheme,
-  generateBaseForms,
-} from './codegenResources';
+import { StudioComponent, StudioTheme, GenericDataSchema, StudioForm, StudioSchema, checkIsSupportedAsForm } from '@aws-amplify/codegen-ui';
+import { createUiBuilderComponent, createUiBuilderForm, createUiBuilderTheme, generateBaseForms } from './codegenResources';
 import { getUiBuilderComponentsPath } from './getUiBuilderComponentsPath';
 
 type CodegenResponse<T extends StudioSchema> =
@@ -34,7 +27,7 @@ export const generateUiBuilderComponents = (
   componentSchemas: any[], // eslint-disable-line @typescript-eslint/no-explicit-any
   dataSchema?: GenericDataSchema,
 ): CodegenResponse<StudioComponent>[] => {
-  const componentResults = componentSchemas.map<CodegenResponse<StudioComponent>>(schema => {
+  const componentResults = componentSchemas.map<CodegenResponse<StudioComponent>>((schema) => {
     try {
       const component = createUiBuilderComponent(context, schema, dataSchema);
       return { resultType: 'SUCCESS', schema: component };
@@ -46,7 +39,7 @@ export const generateUiBuilderComponents = (
   });
 
   printer.debug(
-    `Generated ${componentResults.filter(result => result.resultType === 'SUCCESS').length} components in ${getUiBuilderComponentsPath(
+    `Generated ${componentResults.filter((result) => result.resultType === 'SUCCESS').length} components in ${getUiBuilderComponentsPath(
       context,
     )}`,
   );
@@ -61,7 +54,7 @@ export const generateUiBuilderThemes = (context: $TSContext, themeSchemas: any[]
   if (themeSchemas.length === 0) {
     return [generateDefaultTheme(context)];
   }
-  const themeResults = themeSchemas.map<CodegenResponse<StudioTheme>>(schema => {
+  const themeResults = themeSchemas.map<CodegenResponse<StudioTheme>>((schema) => {
     try {
       const theme = createUiBuilderTheme(context, schema);
       return { resultType: 'SUCCESS', schema: theme };
@@ -73,7 +66,7 @@ export const generateUiBuilderThemes = (context: $TSContext, themeSchemas: any[]
   });
 
   printer.debug(
-    `Generated ${themeResults.filter(result => result.resultType === 'SUCCESS').length} themes in ${getUiBuilderComponentsPath(context)}`,
+    `Generated ${themeResults.filter((result) => result.resultType === 'SUCCESS').length} themes in ${getUiBuilderComponentsPath(context)}`,
   );
   return themeResults;
 };
@@ -84,9 +77,7 @@ export const generateUiBuilderThemes = (context: $TSContext, themeSchemas: any[]
 const generateDefaultTheme = (context: $TSContext): CodegenResponse<StudioTheme> => {
   try {
     const theme = createUiBuilderTheme(context, { name: 'studioTheme', values: [] }, { renderDefaultTheme: true });
-    printer.debug(
-      `Generated default theme in ${getUiBuilderComponentsPath(context)}`,
-    );
+    printer.debug(`Generated default theme in ${getUiBuilderComponentsPath(context)}`);
     return { resultType: 'SUCCESS', schema: theme };
   } catch (e) {
     printer.debug(`Failure caught rendering default theme`);
@@ -121,7 +112,10 @@ export const generateUiBuilderForms = (
       printer.debug(`Failure caught processing ${schema.name}`);
       printer.debug(e);
       return {
-        resultType: 'FAILURE', schemaName: schema.name, schema, error: e,
+        resultType: 'FAILURE',
+        schemaName: schema.name,
+        schema,
+        error: e,
       };
     }
   };
@@ -136,7 +130,7 @@ export const generateUiBuilderForms = (
   formResults.push(...generateBaseForms(modelMap).map(codegenForm));
 
   printer.debug(
-    `Generated ${formResults.filter(result => result.resultType === 'SUCCESS').length} forms in ${getUiBuilderComponentsPath(context)}`,
+    `Generated ${formResults.filter((result) => result.resultType === 'SUCCESS').length} forms in ${getUiBuilderComponentsPath(context)}`,
   );
   return formResults;
 };

package/src/event-handlers/handle-PrePush.ts

@@ -12,4 +12,4 @@ export const run = async (context: $TSContext): Promise<void> => {
     // Swallow all errors from the uibuilder plugin
     printer.debug(e);
   }
-};
+};

package/src/utils/prePushHandler.ts

@@ -1,10 +1,14 @@
 import { $TSContext } from 'amplify-cli-core';
-import type { Schema } from '@aws-amplify/datastore';
 import { printer } from 'amplify-prompts';
 import AmplifyUIBuilder from 'aws-sdk/clients/amplifyuibuilder';
 import { AmplifyStudioClient } from '../clients';
 import { isFormDetachedFromModel, isFormSchemaCustomized, shouldRenderComponents } from '../commands/utils';
 
+// TODO: replace this type when amplify-codegen package export official types
+type Schema = {
+  models: Record<string, unknown>;
+};
+
 /**
  * Handles showing a warning for detached forms pre-push.
  */
@@ -13,18 +17,14 @@ export const prePushHandler = async (context: $TSContext): Promise<void> => {
     return;
   }
   const studioClient = await AmplifyStudioClient.setClientInfo(context);
-  const [formSchemas, localSchema] = await Promise.all<[Promise<{
-    entities: AmplifyUIBuilder.Form[];
-  }>, Promise<Schema>]>([
-    studioClient.listForms(),
-    context.amplify.invokePluginMethod(
-      context,
-      'codegen',
-      undefined,
-      'getModelIntrospection',
-      [context],
-    ),
-  ]);
+  const [formSchemas, localSchema] = await Promise.all<
+    [
+      Promise<{
+        entities: AmplifyUIBuilder.Form[];
+      }>,
+      Promise<Schema>,
+    ]
+  >([studioClient.listForms(), context.amplify.invokePluginMethod(context, 'codegen', undefined, 'getModelIntrospection', [context])]);
 
   if (!localSchema) {
     printer.debug('Local schema not found');
@@ -37,7 +37,7 @@ const printDetachedFormsWarning = (formSchemas: { entities: AmplifyUIBuilder.For
   const modelNames = new Set(Object.keys(localSchema.models));
   const detachedCustomForms: string[] = [];
 
-  formSchemas.entities.forEach(form => {
+  formSchemas.entities.forEach((form) => {
     // Only show warnings for schema's that have customization, otherwise it's the same as
     // an autogenerated form.
     if (isFormDetachedFromModel(form, modelNames) && isFormSchemaCustomized(form)) {
@@ -46,6 +46,10 @@ const printDetachedFormsWarning = (formSchemas: { entities: AmplifyUIBuilder.For
   });
 
   if (detachedCustomForms.length > 0) {
-    printer.warn(`The following form${detachedCustomForms.length === 1 ? '' : 's'} will no longer be available because the connected data model no longer exists: ${detachedCustomForms.join(', ')}`);
+    printer.warn(
+      `The following form${
+        detachedCustomForms.length === 1 ? '' : 's'
+      } will no longer be available because the connected data model no longer exists: ${detachedCustomForms.join(', ')}`,
+    );
   }
-};
+};