From 63317d3e3fdcd2ec5c7d69af597d410bcde86c43 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 29 Mar 2023 10:27:57 +0200 Subject: [PATCH] update API reports for TypeScript 5.0 Signed-off-by: Patrik Oldsberg --- packages/core-app-api/api-report.md | 8 +-- packages/core-plugin-api/api-report.md | 8 +-- packages/test-utils/api-report.md | 4 +- plugins/catalog-backend/alpha-api-report.md | 4 +- plugins/permission-node/api-report.md | 13 ++--- plugins/playlist-backend/api-report.md | 5 +- plugins/rollbar-backend/api-report.md | 54 +++---------------- .../scaffolder-backend/alpha-api-report.md | 5 +- plugins/scaffolder-backend/api-report.md | 12 ++++- plugins/scaffolder-node/api-report.md | 20 ++++--- plugins/scaffolder-react/api-report.md | 4 +- 11 files changed, 52 insertions(+), 85 deletions(-) diff --git a/packages/core-app-api/api-report.md b/packages/core-app-api/api-report.md index d7e4a22873..5b6282eddd 100644 --- a/packages/core-app-api/api-report.md +++ b/packages/core-app-api/api-report.md @@ -116,9 +116,11 @@ export const ApiProvider: { (props: PropsWithChildren): JSX.Element; propTypes: { apis: PropTypes.Validator< - PropTypes.InferProps<{ - get: PropTypes.Validator<(...args: any[]) => any>; - }> + NonNullable< + PropTypes.InferProps<{ + get: PropTypes.Validator<(...args: any[]) => any>; + }> + > >; children: PropTypes.Requireable; }; diff --git a/packages/core-plugin-api/api-report.md b/packages/core-plugin-api/api-report.md index eabd300fc6..52ee47f6bb 100644 --- a/packages/core-plugin-api/api-report.md +++ b/packages/core-plugin-api/api-report.md @@ -769,10 +769,12 @@ export function useRouteRefParams( ): Params; // @public -export function withApis(apis: TypesToApiRefs):

( - WrappedComponent: React_2.ComponentType

, +export function withApis( + apis: TypesToApiRefs, +): ( + WrappedComponent: React_2.ComponentType, ) => { - (props: React_2.PropsWithChildren>): JSX.Element; + (props: React_2.PropsWithChildren>): JSX.Element; displayName: string; }; ``` diff --git a/packages/test-utils/api-report.md b/packages/test-utils/api-report.md index 37650ff18a..01fc31c28f 100644 --- a/packages/test-utils/api-report.md +++ b/packages/test-utils/api-report.md @@ -173,7 +173,9 @@ export class MockStorageApi implements StorageApi { // (undocumented) forBucket(name: string): StorageApi; // (undocumented) - observe$(key: string): Observable>; + observe$( + key: string, + ): Observable>; // (undocumented) remove(key: string): Promise; // (undocumented) diff --git a/plugins/catalog-backend/alpha-api-report.md b/plugins/catalog-backend/alpha-api-report.md index df3e809ade..8fd0eb571f 100644 --- a/plugins/catalog-backend/alpha-api-report.md +++ b/plugins/catalog-backend/alpha-api-report.md @@ -79,9 +79,7 @@ export const catalogPlugin: () => BackendFeature; // @alpha export const createCatalogConditionalDecision: ( permission: ResourcePermission<'catalog-entity'>, - conditions: PermissionCriteria< - PermissionCondition<'catalog-entity', PermissionRuleParams> - >, + conditions: PermissionCriteria>, ) => ConditionalPolicyDecision; // @alpha diff --git a/plugins/permission-node/api-report.md b/plugins/permission-node/api-report.md index b3d06efdc7..9d49fd3d01 100644 --- a/plugins/permission-node/api-report.md +++ b/plugins/permission-node/api-report.md @@ -75,17 +75,14 @@ export type ConditionTransformer = ( // @public export const createConditionAuthorizer: ( - rules: PermissionRule[], + rules: PermissionRule[], ) => (decision: PolicyDecision, resource: TResource | undefined) => boolean; // @public export const createConditionExports: < TResourceType extends string, TResource, - TRules extends Record< - string, - PermissionRule - >, + TRules extends Record>, >(options: { pluginId: string; resourceType: TResourceType; @@ -94,9 +91,7 @@ export const createConditionExports: < conditions: Conditions; createConditionalDecision: ( permission: ResourcePermission, - conditions: PermissionCriteria< - PermissionCondition - >, + conditions: PermissionCriteria>, ) => ConditionalPolicyDecision; }; @@ -111,7 +106,7 @@ export const createConditionFactory: < // @public export const createConditionTransformer: < TQuery, - TRules extends PermissionRule[], + TRules extends PermissionRule[], >( permissionRules: [...TRules], ) => ConditionTransformer; diff --git a/plugins/playlist-backend/api-report.md b/plugins/playlist-backend/api-report.md index 6b51f316c4..b755347205 100644 --- a/plugins/playlist-backend/api-report.md +++ b/plugins/playlist-backend/api-report.md @@ -15,7 +15,6 @@ import { PermissionCriteria } from '@backstage/plugin-permission-common'; import { PermissionEvaluator } from '@backstage/plugin-permission-common'; import { PermissionPolicy } from '@backstage/plugin-permission-node'; import { PermissionRule } from '@backstage/plugin-permission-node'; -import { PermissionRuleParams } from '@backstage/plugin-permission-common'; import { PlaylistMetadata } from '@backstage/plugin-playlist-common'; import { PluginDatabaseManager } from '@backstage/backend-common'; import { PluginEndpointDiscovery } from '@backstage/backend-common'; @@ -26,9 +25,7 @@ import { ResourcePermission } from '@backstage/plugin-permission-common'; // @public (undocumented) export const createPlaylistConditionalDecision: ( permission: ResourcePermission<'playlist-list'>, - conditions: PermissionCriteria< - PermissionCondition<'playlist-list', PermissionRuleParams> - >, + conditions: PermissionCriteria>, ) => ConditionalPolicyDecision; // @public (undocumented) diff --git a/plugins/rollbar-backend/api-report.md b/plugins/rollbar-backend/api-report.md index 58a5fb0252..72499fbe58 100644 --- a/plugins/rollbar-backend/api-report.md +++ b/plugins/rollbar-backend/api-report.md @@ -27,21 +27,9 @@ export class RollbarApi { environment: string; item_id?: number; }, - ): Promise< - { - count: number; - timestamp: number; - }[] - >; + ): Promise; // (undocumented) - getAllProjects(): Promise< - { - id: number; - name: string; - status: string; - accountId: number; - }[] - >; + getAllProjects(): Promise; // (undocumented) getOccuranceCounts( projectName: string, @@ -49,25 +37,11 @@ export class RollbarApi { environment: string; item_id?: number; }, - ): Promise< - { - count: number; - timestamp: number; - }[] - >; + ): Promise; // (undocumented) - getProject(projectName: string): Promise<{ - id: number; - name: string; - status: string; - accountId: number; - }>; + getProject(projectName: string): Promise; // (undocumented) - getProjectItems(projectName: string): Promise<{ - page: number; - items: RollbarItem[]; - totalCount: number; - }>; + getProjectItems(projectName: string): Promise; // (undocumented) getTopActiveItems( projectName: string, @@ -75,23 +49,7 @@ export class RollbarApi { hours: number; environment: string; }, - ): Promise< - { - item: { - id: number; - counter: number; - environment: string; - framework: RollbarFrameworkId; - lastOccurrenceTimestamp: number; - level: number; - occurrences: number; - projectId: number; - title: string; - uniqueOccurrences: number; - }; - counts: number[]; - }[] - >; + ): Promise; } // @public (undocumented) diff --git a/plugins/scaffolder-backend/alpha-api-report.md b/plugins/scaffolder-backend/alpha-api-report.md index 2ecd2cc800..e762c2be4f 100644 --- a/plugins/scaffolder-backend/alpha-api-report.md +++ b/plugins/scaffolder-backend/alpha-api-report.md @@ -9,7 +9,6 @@ import { Conditions } from '@backstage/plugin-permission-node'; import { PermissionCondition } from '@backstage/plugin-permission-common'; import { PermissionCriteria } from '@backstage/plugin-permission-common'; import { PermissionRule } from '@backstage/plugin-permission-node'; -import { PermissionRuleParams } from '@backstage/plugin-permission-common'; import { ResourcePermission } from '@backstage/plugin-permission-common'; import { TaskBroker } from '@backstage/plugin-scaffolder-backend'; import { TemplateAction } from '@backstage/plugin-scaffolder-node'; @@ -24,9 +23,7 @@ export const catalogModuleTemplateKind: () => BackendFeature; // @alpha export const createScaffolderConditionalDecision: ( permission: ResourcePermission<'scaffolder-template'>, - conditions: PermissionCriteria< - PermissionCondition<'scaffolder-template', PermissionRuleParams> - >, + conditions: PermissionCriteria>, ) => ConditionalPolicyDecision; // @alpha diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md index f083db5102..aed8921cdc 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/plugins/scaffolder-backend/api-report.md @@ -614,10 +614,18 @@ export const createTemplateAction: < TOutputParams extends JsonObject = JsonObject, TInputSchema extends ZodType | Schema = {}, TOutputSchema extends ZodType | Schema = {}, - TActionInput = TInputSchema extends ZodType + TActionInput extends JsonObject = TInputSchema extends ZodType< + any, + any, + infer IReturn + > ? IReturn : TInputParams, - TActionOutput = TOutputSchema extends ZodType + TActionOutput extends JsonObject = TOutputSchema extends ZodType< + any, + any, + infer IReturn_1 + > ? IReturn_1 : TOutputParams, >( diff --git a/plugins/scaffolder-node/api-report.md b/plugins/scaffolder-node/api-report.md index 51f2aab501..bea689dc70 100644 --- a/plugins/scaffolder-node/api-report.md +++ b/plugins/scaffolder-node/api-report.md @@ -44,10 +44,18 @@ export const createTemplateAction: < TOutputParams extends JsonObject = JsonObject, TInputSchema extends z.ZodType | Schema = {}, TOutputSchema extends z.ZodType | Schema = {}, - TActionInput = TInputSchema extends z.ZodType + TActionInput extends JsonObject = TInputSchema extends z.ZodType< + any, + any, + infer IReturn + > ? IReturn : TInputParams, - TActionOutput = TOutputSchema extends z.ZodType + TActionOutput extends JsonObject = TOutputSchema extends z.ZodType< + any, + any, + infer IReturn_1 + > ? IReturn_1 : TOutputParams, >( @@ -75,8 +83,8 @@ export type TaskSecrets = Record & { // @public (undocumented) export type TemplateAction< - TActionInput = unknown, - TActionOutput = JsonObject, + TActionInput extends JsonObject = JsonObject, + TActionOutput extends JsonObject = JsonObject, > = { id: string; description?: string; @@ -94,8 +102,8 @@ export type TemplateAction< // @public (undocumented) export type TemplateActionOptions< - TActionInput = {}, - TActionOutput = {}, + TActionInput extends JsonObject = {}, + TActionOutput extends JsonObject = {}, TInputSchema extends Schema | z.ZodType = {}, TOutputSchema extends Schema | z.ZodType = {}, > = { diff --git a/plugins/scaffolder-react/api-report.md b/plugins/scaffolder-react/api-report.md index da8309d5ec..baf5afb312 100644 --- a/plugins/scaffolder-react/api-report.md +++ b/plugins/scaffolder-react/api-report.md @@ -71,7 +71,7 @@ export type FieldExtensionComponent<_TReturnValue, _TInputProps> = () => null; // @public export interface FieldExtensionComponentProps< TFieldReturnValue, - TUiOptions extends {} = {}, + TUiOptions = unknown, > extends FieldProps { // (undocumented) uiSchema: FieldProps['uiSchema'] & { @@ -316,7 +316,7 @@ export type TemplateParameterSchema = { // @public export const useCustomFieldExtensions: < - TComponentDataType = FieldExtensionOptions, + TComponentDataType = FieldExtensionOptions, >( outlet: React.ReactNode, ) => TComponentDataType[];