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

fix: Remove @empathyco/x-platform-adapter dependency from library c… #575

Merged
merged 2 commits into from
Jun 23, 2022

Conversation

javieri-empathy
Copy link
Contributor

  • Removes Adapter type. This has no sense and it was complicated.
  • Adds XComponentsAdapter type to @empathyco/x-types. Together with the rest of the request/responses info. x-types can be considered as a package where all the shared types needed mainly by x-components, and other packages are.
  • Moves getTaggingInfoFromUrl to @empathyco/x-platform-adapter. This utility was previously in @empathyco/x-utils. Due to the refactor of the types it created a cyclic dependency.
  • Makes PlatformAdapter extendable.

@javieri-empathy javieri-empathy requested a review from a team as a code owner June 23, 2022 06:53
@tajespasarela tajespasarela self-requested a review June 23, 2022 06:57
SearchResponse
} from './response';

export interface XComponentsAdapter {
Copy link
Contributor

Choose a reason for hiding this comment

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

add a TODO to relax types

Copy link
Contributor

Choose a reason for hiding this comment

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

and create a task in backlog and add link to this TODO

packages/x-adapter-platform/src/mappers/url.util.ts Outdated Show resolved Hide resolved
}
};
}

Copy link
Contributor

Choose a reason for hiding this comment

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

Add TODO in line 50 to add future logger

packages/x-components/src/__tests__/utils.ts Outdated Show resolved Hide resolved
@@ -24,15 +24,15 @@ import { assertXPluginOptionsAreValid } from './x-plugin.utils';
*/
export class XPlugin implements PluginObject<XPluginOptions> {
/**
* {@link @empathyco/x-adapter-platform#PlatformAdapter | PlatformAdapter} Is the middleware
* {@link @empathyco/x-typesm#XComponentsAdapter | XComponentsAdapter} Is the middleware
Copy link
Contributor

Choose a reason for hiding this comment

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

Update the doc @example in line 419

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated clarifying usage, but it is an intended example.

@tajespasarela tajespasarela merged commit 104c7e1 into main Jun 23, 2022
@tajespasarela tajespasarela deleted the bugfix/EX-6437-move-adapter-types-to-x-types branch June 23, 2022 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants