Skip to content

refactor: rename EventBridge types #2231

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

Merged
aws-cdk-automation merged 2 commits into from
Nov 20, 2025
+10 −4
Merged

refactor: rename EventBridge types #2231

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
516d04b
refactor: rename EventBridge types
gasolima Nov 20, 2025
da997b2
chore: self mutation
github-actions[bot] Nov 20, 2025
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
6 changes: 6 additions & 0 deletions packages/@aws-cdk/service-spec-types/src/types/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,12 @@ export interface NullType {
readonly type: 'null';
}

/**
*
* T is the entity type for compound objects.
*
* For example: TypeDefinition, EventTypeDefinition.
*/
export interface GenericDefinitionReference<T extends Entity> {
readonly type: 'ref';
readonly reference: Reference<T>;
Expand Down
4 changes: 2 additions & 2 deletions packages/@aws-cdk/service-spec-types/src/types/database.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { promises as fs } from 'fs';
import { gunzipSync } from 'zlib';
import { Database, entityCollection, fieldIndex, stringCmp } from '@cdklabs/tskb';
import { IsAugmentedResource, ResourceAugmentation } from './augmentations';
import { HasEvent, Event, EventUsesType, EventTypeDefinition } from './event';
import { ResourceHasEvent, Event, EventUsesType, EventTypeDefinition } from './event';
import {
DimensionSet,
Metric,
Expand Down Expand Up @@ -63,7 +63,7 @@ export function emptyDatabase() {
serviceHasMetric: r.relationship<ServiceHasMetric>('service', 'metric'),
resourceHasDimensionSet: r.relationship<ResourceHasDimensionSet>('resource', 'dimensionSet'),
serviceHasDimensionSet: r.relationship<ServiceHasDimensionSet>('service', 'dimensionSet'),
hasEvent: r.relationship<HasEvent>('resource', 'event'),
resourceHasEvent: r.relationship<ResourceHasEvent>('resource', 'event'),
Copy link
Contributor

@rix0rrr rix0rrr Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can't rename this, pretty sure this is going to break consumers. Do an alias if you must and deprecate the old name.

Copy link
Contributor Author

@gasolima gasolima Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a new type no one using it yet, so we're fine

eventUsesType: r.relationship<EventUsesType>('event', 'eventTypeDefinition'),
}),
);
Expand Down
4 changes: 2 additions & 2 deletions packages/@aws-cdk/service-spec-types/src/types/event.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export interface Event extends Entity {
*/
readonly resourcesField: Array<ResourceField>;
/**
* rootProperty has the reference for the root proprety for this event
* rootProperty has the reference for the root property for this event
*/
readonly rootProperty: Reference<EventTypeDefinition>;
}
Expand All @@ -44,7 +44,7 @@ export interface ResourceField {
fieldName?: string;
}

export type HasEvent = Relationship<Resource, Event>;
export type ResourceHasEvent = Relationship<Resource, Event>;

export type EventProperties = Record<string, EventProperty>;
export interface EventProperty {
Expand Down
Loading