paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 15 Packages Projects Releases Wiki Activity

chore: just the error validation left I think for the next scaffolder

Browse Source 
Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2022-09-12 11:09:45 +02:00
parent 6183125008
commit b9f71b15af
16 changed files with 114 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/app/src/components/scaffolder/customScaffolderExtensions.tsx
+1 -1
View File
@@ -30,7 +30,7 @@ const TextValuePicker = (props: FieldExtensionComponentProps<string>) => {
schema: { title, description },
rawErrors,
formData,
uiSchema: { 'ui:autofocus': autoFocus },
uiSchema: { 'ui:autofocus': autoFocus } = {},
idSchema,
placeholder,
} = props;
plugins/scaffolder/src/components/TemplatePage/createValidator.test.ts
+1 -1
View File
@@ -68,6 +68,6 @@ describe('createValidator', () => {
/* THEN */
expect(result).not.toBeNull();
expect(result.p1.addError).toHaveBeenCalledTimes(1);
expect(result.p1?.addError).toHaveBeenCalledTimes(1);
});
});
plugins/scaffolder/src/components/TemplatePage/createValidator.ts
+1 -1
View File
@@ -62,7 +62,7 @@ export const createValidator = (
if (fieldName && typeof validators[fieldName] === 'function') {
validators[fieldName]!(
propData as JsonValue,
propValidation,
propValidation as FormValidation,
context,
);
}
plugins/scaffolder/src/components/fields/EntityNamePicker/EntityNamePicker.tsx
+1 -1
View File
@@ -29,7 +29,7 @@ export const EntityNamePicker = (
schema: { title = 'Name', description = 'Unique name of the component' },
rawErrors,
formData,
uiSchema: { 'ui:autofocus': autoFocus },
uiSchema: { 'ui:autofocus': autoFocus } = {},
idSchema,
placeholder,
} = props;
plugins/scaffolder/src/components/fields/EntityPicker/EntityPicker.test.tsx
+3 -3
View File
@@ -39,7 +39,7 @@ describe('<EntityPicker />', () => {
const rawErrors: string[] = [];
const formData = undefined;
let props: FieldProps;
let props: FieldProps<string | undefined>;
const catalogApi: jest.Mocked<CatalogApi> = {
getLocationById: jest.fn(),
@@ -76,7 +76,7 @@ describe('<EntityPicker />', () => {
uiSchema,
rawErrors,
formData,
} as unknown as FieldProps<any>;
} as any;
catalogApi.getEntities.mockResolvedValue({ items: entities });
});
@@ -117,7 +117,7 @@ describe('<EntityPicker />', () => {
uiSchema,
rawErrors,
formData,
} as unknown as FieldProps<any>;
} as any;
catalogApi.getEntities.mockResolvedValue({ items: entities });
});
plugins/scaffolder/src/components/fields/EntityPicker/EntityPicker.tsx
+8 -5
View File
@@ -45,7 +45,10 @@ export interface EntityPickerUiOptions {
* @public
*/
export const EntityPicker = (
props: FieldExtensionComponentProps<string, EntityPickerUiOptions>,
props: FieldExtensionComponentProps<
string | undefined,
EntityPickerUiOptions
>,
) => {
const {
onChange,
@@ -56,9 +59,9 @@ export const EntityPicker = (
formData,
idSchema,
} = props;
const allowedKinds = uiSchema['ui:options']?.allowedKinds;
const defaultKind = uiSchema['ui:options']?.defaultKind;
const defaultNamespace = uiSchema['ui:options']?.defaultNamespace;
const allowedKinds = uiSchema?.['ui:options']?.allowedKinds;
const defaultKind = uiSchema?.['ui:options']?.defaultKind;
const defaultNamespace = uiSchema?.['ui:options']?.defaultNamespace;
const catalogApi = useApi(catalogApiRef);
@@ -99,7 +102,7 @@ export const EntityPicker = (
onChange={onSelect}
options={entityRefs || []}
autoSelect
freeSolo={uiSchema['ui:options']?.allowArbitraryValues ?? true}
freeSolo={uiSchema?.['ui:options']?.allowArbitraryValues ?? true}
renderInput={params => (
<TextField
{...params}
plugins/scaffolder/src/components/fields/EntityTagsPicker/EntityTagsPicker.tsx
+3 -3
View File
@@ -51,9 +51,9 @@ export const EntityTagsPicker = (
const [inputValue, setInputValue] = useState('');
const [inputError, setInputError] = useState(false);
const tagValidator = makeValidator().isValidTag;
const kinds = uiSchema['ui:options']?.kinds;
const showCounts = uiSchema['ui:options']?.showCounts;
const helperText = uiSchema['ui:options']?.helperText;
const kinds = uiSchema?.['ui:options']?.kinds;
const showCounts = uiSchema?.['ui:options']?.showCounts;
const helperText = uiSchema?.['ui:options']?.helperText;
const { loading, value: existingTags } = useAsync(async () => {
const facet = 'metadata.tags';
plugins/scaffolder/src/components/fields/OwnedEntityPicker/OwnedEntityPicker.tsx
+4 -4
View File
@@ -59,12 +59,12 @@ export const OwnedEntityPicker = (
formData,
idSchema,
} = props;
const allowedKinds = uiSchema?.['ui:options']?.allowedKinds;
const defaultKind = uiSchema?.['ui:options']?.defaultKind;
const defaultNamespace = uiSchema?.['ui:options']?.defaultNamespace;
const allowedKinds = uiSchema['ui:options']?.allowedKinds;
const defaultKind = uiSchema['ui:options']?.defaultKind;
const defaultNamespace = uiSchema['ui:options']?.defaultNamespace;
const allowArbitraryValues =
uiSchema['ui:options']?.allowArbitraryValues ?? true;
uiSchema?.['ui:options']?.allowArbitraryValues ?? true;
const { ownedEntities, loading } = useOwnedEntities(allowedKinds);
const entityRefs = ownedEntities?.items
plugins/scaffolder/src/components/fields/OwnerPicker/OwnerPicker.test.tsx
+1 -1
View File
@@ -36,7 +36,7 @@ describe('<OwnerPicker />', () => {
const rawErrors: string[] = [];
const formData = undefined;
let props: FieldProps;
let props: FieldProps<string | undefined>;
const catalogApi: jest.Mocked<CatalogApi> = {
getLocationById: jest.fn(),
plugins/scaffolder/src/components/fields/OwnerPicker/OwnerPicker.tsx
+4 -4
View File
@@ -36,7 +36,7 @@ export interface OwnerPickerUiOptions {
* @public
*/
export const OwnerPicker = (
props: FieldExtensionComponentProps<string, OwnerPickerUiOptions>,
props: FieldExtensionComponentProps<string | undefined, OwnerPickerUiOptions>,
) => {
const {
schema: { title = 'Owner', description = 'The owner of the component' },
@@ -44,18 +44,18 @@ export const OwnerPicker = (
...restProps
} = props;
const defaultNamespace = uiSchema['ui:options']?.defaultNamespace;
const defaultNamespace = uiSchema?.['ui:options']?.defaultNamespace;
const ownerUiSchema = {
...uiSchema,
'ui:options': {
allowedKinds: (uiSchema['ui:options']?.allowedKinds || [
allowedKinds: (uiSchema?.['ui:options']?.allowedKinds || [
'Group',
'User',
]) as string[],
defaultKind: 'Group',
allowArbitraryValues:
uiSchema['ui:options']?.allowArbitraryValues ?? true,
uiSchema?.['ui:options']?.allowArbitraryValues ?? true,
...(defaultNamespace !== undefined ? { defaultNamespace } : {}),
},
};
plugins/scaffolder/src/components/fields/RepoUrlPicker/RepoUrlPicker.test.tsx
+4 -3
View File
@@ -32,6 +32,7 @@ import {
SecretsContext,
} from '../../secrets/SecretsContext';
import { act, fireEvent } from '@testing-library/react';
import { Field } from '@rjsf/utils';
describe('RepoUrlPicker', () => {
const mockScaffolderApi: Partial<ScaffolderApi> = {
@@ -68,7 +69,7 @@ describe('RepoUrlPicker', () => {
<Form
schema={{ type: 'string' }}
uiSchema={{ 'ui:field': 'RepoUrlPicker' }}
fields={{ RepoUrlPicker: RepoUrlPicker }}
fields={{ RepoUrlPicker: RepoUrlPicker as Field<unknown> }}
onSubmit={onSubmit}
/>
</SecretsContextProvider>
@@ -107,7 +108,7 @@ describe('RepoUrlPicker', () => {
'ui:field': 'RepoUrlPicker',
'ui:options': { allowedHosts: ['dev.azure.com'] },
}}
fields={{ RepoUrlPicker: RepoUrlPicker }}
fields={{ RepoUrlPicker: RepoUrlPicker as Field<unknown> }}
/>
</SecretsContextProvider>
</TestApiProvider>,
@@ -145,7 +146,7 @@ describe('RepoUrlPicker', () => {
},
},
}}
fields={{ RepoUrlPicker: RepoUrlPicker }}
fields={{ RepoUrlPicker: RepoUrlPicker as Field<unknown> }}
/>
<SecretsComponent />
</SecretsContextProvider>
plugins/scaffolder/src/components/fields/RepoUrlPicker/RepoUrlPicker.tsx
+4 -1
View File
@@ -62,7 +62,10 @@ export interface RepoUrlPickerUiOptions {
* @public
*/
export const RepoUrlPicker = (
props: FieldExtensionComponentProps<string, RepoUrlPickerUiOptions>,
props: FieldExtensionComponentProps<
string | undefined,
RepoUrlPickerUiOptions
>,
) => {
const { uiSchema, onChange, rawErrors, formData } = props;
const [state, setState] = useState<RepoUrlPickerState>(
plugins/scaffolder/src/components/fields/RepoUrlPicker/validation.ts
+1 -1
View File
@@ -26,7 +26,7 @@ import { scmIntegrationsApiRef } from '@backstage/integration-react';
* @public
*/
export const repoPickerValidation = (
value: string,
value: string | undefined,
validation: FieldValidation,
context: { apiHolder: ApiHolder },
) => {
plugins/scaffolder/src/extensions/index.tsx
+2 -1
View File
@@ -21,6 +21,7 @@ import {
FieldExtensionComponentProps,
} from './types';
import { Extension, attachComponentData } from '@backstage/core-plugin-api';
import { UIOptionsType } from '@rjsf/utils';
export const FIELD_EXTENSION_WRAPPER_KEY = 'scaffolder.extensions.wrapper.v1';
export const FIELD_EXTENSION_KEY = 'scaffolder.extensions.field.v1';
@@ -39,7 +40,7 @@ export type FieldExtensionComponent<_TReturnValue, _TInputProps> = () => null;
*/
export function createScaffolderFieldExtension<
TReturnValue = unknown,
TInputProps = unknown,
TInputProps extends UIOptionsType = {},
>(
options: FieldExtensionOptions<TReturnValue, TInputProps>,
): Extension<FieldExtensionComponent<TReturnValue, TInputProps>> {
plugins/scaffolder/src/extensions/types.ts
+12 -6
View File
@@ -14,7 +14,13 @@
* limitations under the License.
*/
import { ApiHolder } from '@backstage/core-plugin-api';
import { FieldValidation, FieldProps } from '@rjsf/utils';
import {
FieldValidation,
FieldProps,
UIOptionsType,
UiSchema,
} from '@rjsf/utils';
import { PropsWithChildren } from 'react';
/**
* Field validation type for Custom Field Extensions.
@@ -35,7 +41,7 @@ export type CustomFieldValidator<TFieldReturnValue> = (
*/
export type FieldExtensionOptions<
TFieldReturnValue = unknown,
TInputProps = unknown,
TInputProps extends UIOptionsType = {},
> = {
name: string;
component: (
@@ -52,9 +58,9 @@ export type FieldExtensionOptions<
*/
export interface FieldExtensionComponentProps<
TFieldReturnValue,
TUiOptions extends {} = {},
> extends FieldProps<TFieldReturnValue> {
uiSchema: FieldProps['uiSchema'] & {
'ui:options'?: TUiOptions;
TUiOptions = {},
> extends PropsWithChildren<FieldProps<TFieldReturnValue>> {
uiSchema?: UiSchema<TFieldReturnValue> & {
'ui:options'?: TUiOptions & UIOptionsType;
};
}
yarn.lock
+64 -51
View File
@@ -6742,8 +6742,10 @@ __metadata:
"@material-ui/icons": ^4.9.1
"@material-ui/lab": 4.0.0-alpha.57
"@react-hookz/web": ^15.0.0
"@rjsf/core": ^3.2.1
"@rjsf/material-ui": ^3.2.1
"@rjsf/core": ^5.0.0-beta.2
"@rjsf/material-ui": ^5.0.0-beta.2
"@rjsf/utils": ^5.0.0-beta.2
"@rjsf/validator-ajv6": ^5.0.0-beta.2
"@testing-library/jest-dom": ^5.10.1
"@testing-library/react": ^12.1.3
"@testing-library/react-hooks": ^8.0.0
@@ -11940,34 +11942,59 @@ __metadata:
languageName: node
linkType: hard
"@rjsf/core@npm:^3.2.1":
version: 3.2.1
resolution: "@rjsf/core@npm:3.2.1"
"@rjsf/core@npm:^5.0.0-beta.2":
version: 5.0.0-beta.5
resolution: "@rjsf/core@npm:5.0.0-beta.5"
dependencies:
"@types/json-schema": ^7.0.7
ajv: ^6.7.0
core-js-pure: ^3.6.5
json-schema-merge-allof: ^0.6.0
jsonpointer: ^5.0.0
lodash: ^4.17.15
nanoid: ^3.1.23
lodash-es: ^4.17.15
nanoid: ^3.3.4
prop-types: ^15.7.2
react-is: ^16.9.0
peerDependencies:
react: ">=16"
checksum: 2142d4a31229ea242b79aca4ed93e2fe89e75f15ce93111457c3017d3ab295cae8f53e4dd870c619afa571959d00f46b3c19085c6a336f522c891fc07ecc46f1
"@rjsf/utils": ^5.0.0-beta.1
react: ^16.14.0 || >=17
checksum: bf9538f98e6238b427afb5cccdcbb88dc7cf99d3dc9c25c8336c8cac6b82c6383fa29cb48139d312f737d668b4f836bca9fac4debebc8bd9ee46a3f8178ad37b
languageName: node
linkType: hard
"@rjsf/material-ui@npm:^3.2.1":
version: 3.2.1
resolution: "@rjsf/material-ui@npm:3.2.1"
"@rjsf/material-ui@npm:^5.0.0-beta.2":
version: 5.0.0-beta.5
resolution: "@rjsf/material-ui@npm:5.0.0-beta.5"
peerDependencies:
"@material-ui/core": ^4.2.0
"@material-ui/icons": ^4.2.1
"@rjsf/core": ^3.0.0
react: ">=16"
checksum: bd25cd9f2e2d568c653755e7268fe3e53279e1ae675e39bccd85f65557623d2052b706763e017a949f897751e25a16d0f2c8b995508bb56907be6786b09e2b1e
"@material-ui/core": ^4.12.3
"@material-ui/icons": ^4.11.2
"@rjsf/core": ^5.0.0-beta.1
"@rjsf/utils": ^5.0.0-beta.1
react: ^16.14.0 || >=17
checksum: 2578ff81c9981ecefab6752a6de6f684cdc4ad0d5a3e4090456a42f811c055437b22ecb662610877598a640d624af9381ef3f15b93bb3a8abfae33770c51d194
languageName: node
linkType: hard
"@rjsf/utils@npm:^5.0.0-beta.2":
version: 5.0.0-beta.5
resolution: "@rjsf/utils@npm:5.0.0-beta.5"
dependencies:
json-schema-merge-allof: ^0.8.1
jsonpointer: ^5.0.1
lodash: ^4.17.15
lodash-es: ^4.17.15
react-is: ^18.2.0
peerDependencies:
react: ^16.14.0 || >=17
checksum: 56549a1b86c068631e19f67c157fbe12e2ec99be2fcbe1b6375f7865b178b874ebce03a129064dcf2c2858b5991067dedac1e4490106269cf81dc4377717dcff
languageName: node
linkType: hard
"@rjsf/validator-ajv6@npm:^5.0.0-beta.2":
version: 5.0.0-beta.5
resolution: "@rjsf/validator-ajv6@npm:5.0.0-beta.5"
dependencies:
ajv: ^6.7.0
lodash: ^4.17.15
lodash-es: ^4.17.15
peerDependencies:
"@rjsf/utils": ^5.0.0-beta.1
checksum: 20e4bf431d8c805e180999c300819b049c52c19cff6f4b5e402edc8eb7757697dc1debb191ccf41bac63de88d067513ba33de958250d6e923f1d34fdaea7283c
languageName: node
linkType: hard
@@ -18550,7 +18577,7 @@ __metadata:
languageName: node
linkType: hard
"compute-lcm@npm:^1.1.0, compute-lcm@npm:^1.1.2":
"compute-lcm@npm:^1.1.2":
version: 1.1.2
resolution: "compute-lcm@npm:1.1.2"
dependencies:
@@ -18786,7 +18813,7 @@ __metadata:
languageName: node
linkType: hard
"core-js-pure@npm:^3.20.2, core-js-pure@npm:^3.6.5, core-js-pure@npm:^3.8.1":
"core-js-pure@npm:^3.20.2, core-js-pure@npm:^3.8.1":
version: 3.21.1
resolution: "core-js-pure@npm:3.21.1"
checksum: 00a5dff599b7fb0b30746a638b9d0edbdc0df24ed1580ca56be595fbe3c78c375d37fc4e1bff23627109229702c9ee8ea2587a66b8280eb33b85160aa4e401e9
@@ -22077,7 +22104,6 @@ __metadata:
"@material-ui/lab": 4.0.0-alpha.57
"@octokit/rest": ^19.0.3
"@oriflame/backstage-plugin-score-card": ^0.5.1
"@rjsf/core": ^3.2.1
"@roadiehq/backstage-plugin-buildkite": ^2.0.8
"@roadiehq/backstage-plugin-github-insights": ^2.0.5
"@roadiehq/backstage-plugin-github-pull-requests": ^2.2.7
@@ -27172,17 +27198,6 @@ __metadata:
languageName: node
linkType: hard
"json-schema-merge-allof@npm:^0.6.0":
version: 0.6.0
resolution: "json-schema-merge-allof@npm:0.6.0"
dependencies:
compute-lcm: ^1.1.0
json-schema-compare: ^0.2.2
lodash: ^4.17.4
checksum: 2008aede3f5d05d7870e7d5e554e5c6a5b451cfff1357d34d3d8b34e2ba57468a97c76aa5b967bdb411d91b98c734f19f350de578d25b2a0a27cd4e1ca92bd1d
languageName: node
linkType: hard
"json-schema-merge-allof@npm:^0.8.1":
version: 0.8.1
resolution: "json-schema-merge-allof@npm:0.8.1"
@@ -27359,10 +27374,10 @@ __metadata:
languageName: node
linkType: hard
"jsonpointer@npm:^5.0.0":
version: 5.0.0
resolution: "jsonpointer@npm:5.0.0"
checksum: c7ec0b6bb596b81de687bc12945586bbcdc80dfb54919656d2690d76334f796a936270067ee9f1b5bbc2d9ecc551afb366ac35e6685aa61f07b5b68d1e5e857d
"jsonpointer@npm:^5.0.1":
version: 5.0.1
resolution: "jsonpointer@npm:5.0.1"
checksum: 0b40f712900ad0c846681ea2db23b6684b9d5eedf55807b4708c656f5894b63507d0e28ae10aa1bddbea551241035afe62b6df0800fc94c2e2806a7f3adecd7c
languageName: node
linkType: hard
@@ -28097,7 +28112,7 @@ __metadata:
languageName: node
linkType: hard
"lodash-es@npm:^4.17.21":
"lodash-es@npm:^4.17.15, lodash-es@npm:^4.17.21":
version: 4.17.21
resolution: "lodash-es@npm:4.17.21"
checksum: 05cbffad6e2adbb331a4e16fbd826e7faee403a1a04873b82b42c0f22090f280839f85b95393f487c1303c8a3d2a010048bf06151a6cbe03eee4d388fb0a12d2
@@ -30062,15 +30077,6 @@ __metadata:
languageName: node
linkType: hard
"nanoid@npm:^3.1.23":
version: 3.3.1
resolution: "nanoid@npm:3.3.1"
bin:
nanoid: bin/nanoid.cjs
checksum: 4ef0969e1bbe866fc223eb32276cbccb0961900bfe79104fa5abe34361979dead8d0e061410a5c03bc3d47455685adf32c09d6f27790f4a6898fb51f7df7ec86
languageName: node
linkType: hard
"nanoid@npm:^3.3.4":
version: 3.3.4
resolution: "nanoid@npm:3.3.4"
@@ -33568,7 +33574,7 @@ __metadata:
languageName: node
linkType: hard
"react-is@npm:^16.10.2, react-is@npm:^16.12.0, react-is@npm:^16.13.1, react-is@npm:^16.7.0, react-is@npm:^16.8.0, react-is@npm:^16.8.6, react-is@npm:^16.9.0":
"react-is@npm:^16.10.2, react-is@npm:^16.12.0, react-is@npm:^16.13.1, react-is@npm:^16.7.0, react-is@npm:^16.8.0, react-is@npm:^16.8.6":
version: 16.13.1
resolution: "react-is@npm:16.13.1"
checksum: f7a19ac3496de32ca9ae12aa030f00f14a3d45374f1ceca0af707c831b2a6098ef0d6bdae51bd437b0a306d7f01d4677fcc8de7c0d331eb47ad0f46130e53c5f
@@ -33589,6 +33595,13 @@ __metadata:
languageName: node
linkType: hard
"react-is@npm:^18.2.0":
version: 18.2.0
resolution: "react-is@npm:18.2.0"
checksum: e72d0ba81b5922759e4aff17e0252bd29988f9642ed817f56b25a3e217e13eea8a7f2322af99a06edb779da12d5d636e9fda473d620df9a3da0df2a74141d53e
languageName: node
linkType: hard
"react-lifecycles-compat@npm:^3.0.4":
version: 3.0.4
resolution: "react-lifecycles-compat@npm:3.0.4"