Skip to content

feat: extract event routing types into @lokalise/aws-event-routing-types#897

Closed
laurismikals wants to merge 1 commit intomainfrom
feat/aws-event-routing-types
Closed

feat: extract event routing types into @lokalise/aws-event-routing-types#897
laurismikals wants to merge 1 commit intomainfrom
feat/aws-event-routing-types

Conversation

@laurismikals
Copy link
Copy Markdown
Contributor

@laurismikals laurismikals commented Mar 27, 2026

Create new zero-dependency package @lokalise/aws-event-routing-types containing EventRoutingConfig, QueueConfig, TopicConfig, CommandConfig, and AwsTagsParams types. Update @lokalise/aws-config to re-export these types from the new package. Wire new package into CI and release workflows.

Made-with: Cursor

Changes

Please describe

Checklist

  • Apply one of following labels; major, minor, patch or skip-release
  • I've updated the documentation, or no changes were necessary
  • I've updated the tests, or no changes were necessary

AI Assistance Tracking

We're running a metric to understand where AI assists our engineering work. Please select exactly one of the options below:

Mark "Yes" if AI helped in any part of this work, for example: generating code, refactoring, debugging support,
explaining something, reviewing an idea, or suggesting an approach.

  • Yes, AI assisted with this PR
  • No, AI did not assist with this PR

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository: lokalise/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 60ac44b3-8ba6-4305-9a78-0cba25ef53b0

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR introduces a new TypeScript types-only package, @lokalise/aws-event-routing-types, that centralizes type definitions for AWS event routing configuration. Type definitions previously defined inline in aws-config (including EventRoutingConfig, QueueConfig, TopicConfig, CommandConfig, and AwsTagsParams) are extracted into the new package as a separate npm-published module. The aws-config package adds this new package as a runtime dependency and re-exports the types for backward compatibility. CI and release workflows are updated to support independent building and publishing of the new package.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~30 minutes

Suggested labels

enhancement

Suggested reviewers

  • dariacm
  • CarlosGamero
  • kibertoad
🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning PR description lacks required detail in the 'Changes' section; most checklist items are marked complete but lack supporting documentation. Expand the 'Changes' section with specific details about what was moved, the new package structure, API compatibility notes, and explain how re-exports maintain backward compatibility.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: extracting event routing types into a new package.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/aws-event-routing-types

Comment @coderabbitai help to get the list of available commands and usage tips.

@laurismikals laurismikals marked this pull request as ready for review March 27, 2026 09:02
Create new zero-dependency package @lokalise/aws-event-routing-types containing
EventRoutingConfig, QueueConfig, TopicConfig, CommandConfig, and AwsTagsParams types.
Update @lokalise/aws-config to re-export these types from the new package.
Wire new package into CI and release workflows.

Made-with: Cursor
@laurismikals laurismikals force-pushed the feat/aws-event-routing-types branch from 05a2580 to a6320e9 Compare March 27, 2026 09:06
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
packages/app/aws-event-routing-types/src/awsTagsParams.ts (1)

1-1: Consider exporting AppEnv for consumer convenience.

The AppEnv type is used internally for the appEnv field but not exported. Consumers who want to type-check environment values independently would benefit from having this type available.

Suggested change
-type AppEnv = 'production' | 'development' | 'staging'
+export type AppEnv = 'production' | 'development' | 'staging'

If exported, also add it to index.ts:

export type { AppEnv, AwsTagsParams } from './awsTagsParams.ts'
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@packages/app/aws-event-routing-types/src/awsTagsParams.ts` at line 1, Export
the AppEnv type so consumers can reuse it: add an export to the AppEnv
declaration (export type AppEnv = 'production' | 'development' | 'staging') and
ensure the AwsTagsParams type remains exported; then update your public exports
(e.g., in index.ts) to re-export AppEnv alongside AwsTagsParams (export type {
AppEnv, AwsTagsParams } from './awsTagsParams') so both types are available to
consumers.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@packages/app/aws-event-routing-types/src/awsTagsParams.ts`:
- Line 1: Export the AppEnv type so consumers can reuse it: add an export to the
AppEnv declaration (export type AppEnv = 'production' | 'development' |
'staging') and ensure the AwsTagsParams type remains exported; then update your
public exports (e.g., in index.ts) to re-export AppEnv alongside AwsTagsParams
(export type { AppEnv, AwsTagsParams } from './awsTagsParams') so both types are
available to consumers.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository: lokalise/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 8bb14055-38d2-4ad7-812d-fb2c067ad4d9

📥 Commits

Reviewing files that changed from the base of the PR and between 5fb7fda and 05a2580.

📒 Files selected for processing (13)
  • .github/workflows/ci.yml
  • .github/workflows/release.yml
  • packages/app/aws-config/package.json
  • packages/app/aws-config/src/event-routing/eventRoutingConfig.ts
  • packages/app/aws-config/src/tags/common.ts
  • packages/app/aws-event-routing-types/README.md
  • packages/app/aws-event-routing-types/package.json
  • packages/app/aws-event-routing-types/src/awsTagsParams.ts
  • packages/app/aws-event-routing-types/src/eventRoutingConfig.ts
  • packages/app/aws-event-routing-types/src/index.ts
  • packages/app/aws-event-routing-types/tsconfig.build.json
  • packages/app/aws-event-routing-types/tsconfig.json
  • packages/app/aws-event-routing-types/vitest.config.ts

@laurismikals laurismikals marked this pull request as draft March 27, 2026 10:05
@laurismikals laurismikals deleted the feat/aws-event-routing-types branch March 30, 2026 08:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant