Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update imports and props for aliased components #868

Merged
merged 2 commits into from
Jan 4, 2023
Merged

fix: update imports and props for aliased components #868

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
122dc58
fix: update imports and props for aliased components
rtpascual Jan 3, 2023
21c3bf6
test: update tests for type declarations and same name validation
rtpascual Jan 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions packages/codegen-ui-react/lib/__tests__/__snapshots__/studio-ui-codegen-react.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5454,17 +5454,19 @@ export default function CustomButton(
exports[`amplify render tests custom components alias parent should render declarations 1`] = `
"import * as React from \\"react\\";
import { EscapeHatchProps } from \\"@aws-amplify/ui-react/internal\\";
import { CustomButtonProps } from \\"./CustomButton\\";
import { GridProps } from \\"./Grid\\";
import { ButtonProps } from \\"@aws-amplify/ui-react\\";
import { ViewTestProps } from \\"./ViewTest\\";
export declare type PrimitiveOverrideProps<T> = Partial<T> & React.DOMAttributes<HTMLDivElement>;
export declare type CustomParentAndChildrenOverridesProps = {
CustomParentAndChildren?: ViewTestProps;
MyCustomButton?: CustomButtonProps;
export declare type AliasParentOverridesProps = {
AliasParent?: ViewTestProps;
Grid?: GridProps;
Button?: PrimitiveOverrideProps<ButtonProps>;
} & EscapeHatchProps;
export declare type CustomParentAndChildrenProps = React.PropsWithChildren<Partial<ViewTestProps> & {
overrides?: CustomParentAndChildrenOverridesProps | undefined | null;
export declare type AliasParentProps = React.PropsWithChildren<Partial<ViewTestProps> & {
overrides?: AliasParentOverridesProps | undefined | null;
}>;
export default function CustomParentAndChildren(props: CustomParentAndChildrenProps): React.ReactElement;
export default function AliasParent(props: AliasParentProps): React.ReactElement;
"
`;

Expand All @@ -5475,15 +5477,16 @@ import {
EscapeHatchProps,
getOverrideProps,
} from \\"@aws-amplify/ui-react/internal\\";
import { GridCustom } from \\"./Grid\\";
import { Grid as GridCustom, GridProps } from \\"./Grid\\";
import { Button, ButtonProps } from \\"@aws-amplify/ui-react\\";
import ViewTest, { ViewTestProps } from \\"./ViewTest\\";
import { GridCustomProps } from \\"./GridCustom\\";

export declare type PrimitiveOverrideProps<T> = Partial<T> &
React.DOMAttributes<HTMLDivElement>;
export declare type AliasParentOverridesProps = {
AliasParent?: ViewTestProps;
Grid?: GridCustomProps;
Grid?: GridProps;
rtpascual marked this conversation as resolved.
Show resolved Hide resolved
Button?: PrimitiveOverrideProps<ButtonProps>;
} & EscapeHatchProps;
export type AliasParentProps = React.PropsWithChildren<
Partial<ViewTestProps> & {
Expand All @@ -5498,6 +5501,7 @@ export default function AliasParent(
/* @ts-ignore: TS2322 */
<ViewTest {...getOverrideProps(overrides, \\"AliasParent\\")} {...rest}>
<GridCustom {...getOverrideProps(overrides, \\"Grid\\")}></GridCustom>
<Button {...getOverrideProps(overrides, \\"Button\\")}></Button>
</ViewTest>
);
}
Expand Down
2 changes: 1 addition & 1 deletion packages/codegen-ui-react/lib/__tests__/studio-ui-codegen-react.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -548,7 +548,7 @@ describe('amplify render tests', () => {

it('should render declarations', () => {
expect(
generateWithAmplifyRenderer('custom/customParentAndChildren', {
generateWithAmplifyRenderer('custom/aliasParent', {
script: ScriptKind.JS,
renderTypeDeclarations: true,
}).declaration,
Expand Down
9 changes: 6 additions & 3 deletions packages/codegen-ui-react/lib/amplify-ui-renderers/customComponent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*/
import { StudioComponentChild } from '@aws-amplify/codegen-ui';
import { JsxChild, JsxElement, factory } from 'typescript';
import { Primitive } from '../primitive';
import { isAliased } from '../helpers';
import { ReactComponentRenderer } from '../react-component-renderer';

export default class CustomComponentRenderer<TPropIn> extends ReactComponentRenderer<TPropIn> {
Expand All @@ -27,8 +27,11 @@ export default class CustomComponentRenderer<TPropIn> extends ReactComponentRend
factory.createJsxClosingElement(factory.createIdentifier(this.component.componentType)),
);

if (Object.keys(Primitive).includes(this.component.name) && this.component.componentType.match(/(Custom$)/g)) {
this.importCollection.addImport(`./${this.component.name}`, this.component.componentType);
if (isAliased(this.component.componentType)) {
this.importCollection.addImport(
`./${this.component.name}`,
`${this.component.name} as ${this.component.componentType}`,
);
} else {
this.importCollection.addImport(`./${this.component.componentType}`, 'default');
}
Expand Down
9 changes: 9 additions & 0 deletions packages/codegen-ui-react/lib/helpers/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/
import { GenericDataField, GenericDataSchema } from '@aws-amplify/codegen-ui/lib/types';
import { factory, Statement, Expression, NodeFlags, Identifier } from 'typescript';
import { isPrimitive } from '../primitive';

export const lowerCaseFirst = (input: string) => input.charAt(0).toLowerCase() + input.slice(1);

Expand Down Expand Up @@ -104,3 +105,11 @@ export function modelNeedsRelationshipsLoadedForCollection(modelName: string, da
)
);
}

export function isAliased(componentType: string): boolean {
return !!(isPrimitive(removeAlias(componentType)) && componentType.match(/(Custom$)/g));
}

export function removeAlias(aliasString: string): string {
return aliasString.replace(/(Custom$)/g, '');
}
7 changes: 5 additions & 2 deletions packages/codegen-ui-react/lib/react-studio-template-renderer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ import {
buildUseStateExpression,
modelNeedsRelationshipsLoadedForCollection,
fieldNeedsRelationshipLoadedForCollection,
isAliased,
removeAlias,
} from './helpers';

export abstract class ReactStudioTemplateRenderer extends StudioTemplateRenderer<
Expand Down Expand Up @@ -355,9 +357,10 @@ export abstract class ReactStudioTemplateRenderer extends StudioTemplateRenderer
factory.createTypeLiteralNode(
Object.entries(this.componentMetadata.componentNameToTypeMap).map(([name, componentType]) => {
const isComponentTypePrimitive = isPrimitive(componentType);
const componentTypePropName = `${componentType}Props`;
const componentName = isAliased(componentType) ? removeAlias(componentType) : componentType;
const componentTypePropName = `${componentName}Props`;
this.importCollection.addImport(
isComponentTypePrimitive ? ImportSource.UI_REACT : `./${componentType}`,
isComponentTypePrimitive ? ImportSource.UI_REACT : `./${componentName}`,
componentTypePropName,
);
return factory.createPropertySignature(
Expand Down
5 changes: 5 additions & 0 deletions packages/codegen-ui/example-schemas/custom/aliasParent.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
"name": "Grid",
"componentType": "GridCustom",
"properties": {}
},
{
"name": "Button",
"componentType": "Button",
"properties": {}
}
],
"properties": {},
Expand Down
4 changes: 3 additions & 1 deletion packages/codegen-ui/lib/__tests__/__snapshots__/validation-helper.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@ exports[`validation-helper validateComponentSchema fails on componentType with l

exports[`validation-helper validateComponentSchema fails on componentType with whitespace 1`] = `"Expected an alphanumeric string, starting with a character"`;

exports[`validation-helper validateComponentSchema throws on all components sharing a name 1`] = `"Duplicate names are not allowed within a component, found duplicates of [\\"DeepComp\\",\\"MyComp\\"]"`;
exports[`validation-helper validateComponentSchema throws on child components sharing a name 1`] = `"Duplicate names are not allowed within a component, found duplicates of [\\"ChildComponent\\"]"`;

exports[`validation-helper validateComponentSchema throws on invalid schema version 1`] = `"unsupported schemaVersion 1.1.4"`;

exports[`validation-helper validateComponentSchema throws on parent and child components sharing a name 1`] = `"Duplicate names are not allowed within a component, found duplicates of [\\"MyComp\\"]"`;

exports[`validation-helper validateComponentSchema throws on unsupported schema version 1`] = `"unsupported schemaVersion 1.1"`;

exports[`validation-helper validateComponentSchema top-level component requires componentType 1`] = `"componentType is a required field"`;
Expand Down
27 changes: 25 additions & 2 deletions packages/codegen-ui/lib/__tests__/validation-helper.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ describe('validation-helper', () => {
}).toThrowErrorMatchingSnapshot();
});

test('throws on all components sharing a name', () => {
test('throws on parent and child components sharing a name', () => {
expect(() => {
validateComponentSchema({
name: 'MyComp',
Expand All @@ -308,7 +308,7 @@ describe('validation-helper', () => {
properties: {},
children: [
{
name: 'DeepComp',
name: 'DeepCompChild',
componentType: 'Tooltip',
properties: {},
},
Expand All @@ -324,6 +324,29 @@ describe('validation-helper', () => {
}).toThrowErrorMatchingSnapshot();
});

test('throws on child components sharing a name', () => {
expect(() => {
validateComponentSchema({
name: 'MyComp',
componentType: 'Flex',
properties: {},
schemaVersion: '1.0',
children: [
{
name: 'ChildComponent',
componentType: 'Button',
properties: {},
},
{
name: 'ChildComponent',
componentType: 'View',
properties: {},
},
],
});
}).toThrowErrorMatchingSnapshot();
});

test('throws on unsupported schema version', () => {
expect(() => {
validateComponentSchema({
Expand Down