Skip to content

Commit

Permalink
feat: add min required library versions for generated components (#302)…
Browse files Browse the repository at this point in the history
… (#303)
  • Loading branch information
alharris-at committed Dec 10, 2021
1 parent ba6e1a2 commit 7f08cd9
Show file tree
Hide file tree
Showing 7 changed files with 310 additions and 10 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License").
You may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import semver from 'semver';
import { ReactRequiredDependencyProvider } from '..';

describe('ReactStudioDependencyProvider', () => {
const requiredDependencies = new ReactRequiredDependencyProvider().getRequiredDependencies();

describe('getRequiredDependencies', () => {
it('has required dependencies', () => {
expect(requiredDependencies.length).toBeGreaterThan(0);
});

it('includes ui-react', () => {
expect(requiredDependencies.filter((dep) => dep.dependencyName === '@aws-amplify/ui-react')).toBeTruthy();
});

it('includes all valid semver values', () => {
requiredDependencies.forEach((dep) => {
expect(semver.valid(dep.supportedSemVerPattern)).toBeDefined();
});
});

it('includes reasons on all dependencies', () => {
requiredDependencies.forEach((dep) => {
expect(dep.reason.length).toBeGreaterThan(0);
});
});
});
});
1 change: 1 addition & 0 deletions packages/codegen-ui-react/lib/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ export * from './react-output-manager';
export * from './amplify-ui-renderers/amplify-renderer';
export * from './primitive';
export * from './react-index-studio-template-renderer';
export * from './react-required-dependency-provider';
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
/*
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License").
You may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import { RequiredDependency, RequiredDependencyProvider } from '@aws-amplify/codegen-ui';

type SemVerRequiredDependency = RequiredDependency & {
supportedSemVerPattern: string;
};

export class ReactRequiredDependencyProvider extends RequiredDependencyProvider<SemVerRequiredDependency> {
getRequiredDependencies(): SemVerRequiredDependency[] {
return [
{
dependencyName: '@aws-amplify/ui-react',
supportedSemVerPattern: '^2.1.4',
reason: 'Required to leverage amplify ui primitives, and studio component helper functions.',
},
];
}
}

0 comments on commit 7f08cd9

Please sign in to comment.