Skip to content
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.

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

Generate ServiceControl API Typescript type definitions as an npm package #4276

Open
cquirosj opened this issue Jun 28, 2024 · 1 comment
Open

Comments

@cquirosj
Copy link
Contributor

Describe the suggested improvement

Is your improvement related to a problem? Please describe.

ServicePulse has type definitions for ServiceControl API in the /src/frontend/src/resources folder. If ServiceControl API changes its DTOs schema, the corresponding type must also be updated in the ServicePulse codebase.

Describe the suggested solution

Automatically generate a ServiceControlAPI.d.ts file in the ServiceControl build and push it as an NPM package.

Make ServicePulse reference the NPM package with the ServiceControl API typescript types. This will automatically make Dependabot create a PR in the ServicePulse repo to update the NPM package whenever a new version of ServiceContrl API types is released.

Note: When this issue was created, ServicePulse had a series of types that extended the ServiceControl API types with properties used by the UI components. This has to be considered when estimating the effort needed to address the idea this issue proposes.

Describe alternatives you've considered

Do nothing and continue manually maintaining the ServiceControl API types in the ServicePulse repo.

Additional Context

No response

@cquirosj cquirosj transferred this issue from Particular/ServicePulse Jun 28, 2024
@cquirosj cquirosj changed the title ServiceControl API Typescript types declarations as an npm package ServiceControl API Typescript types definitions as an npm package Jun 28, 2024
@cquirosj cquirosj changed the title ServiceControl API Typescript types definitions as an npm package ServiceControl API Typescript type definitions as an npm package Jun 28, 2024
@cquirosj cquirosj changed the title ServiceControl API Typescript type definitions as an npm package Generate ServiceControl API Typescript type definitions as an npm package Jun 28, 2024
@danielmarbach
Copy link
Contributor

Would something like pactflow also be an option?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants