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

[Feature]: Split SDK API Client to dedicated packages #2128

Closed
1 of 6 tasks
kpanot opened this issue Sep 4, 2024 · 1 comment · Fixed by #2183
Closed
1 of 6 tasks

[Feature]: Split SDK API Client to dedicated packages #2128

kpanot opened this issue Sep 4, 2024 · 1 comment · Fixed by #2183
Labels
enhancement New feature or request priority:high

Comments

@kpanot
Copy link
Contributor

kpanot commented Sep 4, 2024

Context

In the current implementation, the package @ama-sdk/core contains the following items:

  • Api helpers function (generating the final request parameters)
  • Fetch Api Client
  • Angular Api Client
  • Beacon Api Client
  • Reply and Request Plugins
  • Fetch Plugins
  • (Angular Plugins)
  • Mock mechanism

To be able to expose all the items without forcing non mandatory dependencies, several entrypoints are exported from @ama-sdk/core. (example: Angular dependencies, several plugins, etc...).
The future integration of Tanstack Query will lead potentially to several plugins and Api Client requiring additional entrypoints.

Proposal

Move the Client API to dedicated @ama-sdk/client-* packages.
This proposal comes with the following acceptance criteria:

  • Move the plugins dedicated to the ApiClient to the new package
  • Deprecate the usage of ApiClient and its plugins from @ama-sdk/core
  • Provide schematics to support the migration

The change should affect the following ApiClients:

@kpanot kpanot added the enhancement New feature or request label Sep 4, 2024
@kpanot
Copy link
Contributor Author

kpanot commented Sep 4, 2024

Relative to #2117

@kpanot kpanot added the triage label Sep 9, 2024
github-merge-queue bot pushed a commit that referenced this issue Sep 25, 2024
…2183)

## Proposed change

Split of Angular and Beacon API Client to their own dedicated package

## Related issues

- 🚀 Feature resolves #2128
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request priority:high
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants