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

Leverage Conviva types #106

Merged
merged 25 commits into from
May 21, 2024
Merged

Conversation

karpov-kir
Copy link
Contributor

@karpov-kir karpov-kir commented May 16, 2024

  • Install @convivainc/conviva-js-coresdk as a peer dependency and reference types in the code explicitly
  • Remove redundant types
  • Properly reference Conviva types in the source code and use Conviva.ContentMetadata as a basis instead custom re-declaration of the whole Metadata
  • Make the metadata build more explicitly follow the types (just split it into methods that match types semantically)

The above is done to reduce confusion and make future extensions easier to follow.

@karpov-kir karpov-kir changed the title Expose extended types Expose types May 16, 2024
@karpov-kir karpov-kir changed the title Expose types Expose Conviva types May 16, 2024
@karpov-kir karpov-kir requested a review from dweinber May 16, 2024 15:05
@karpov-kir karpov-kir changed the title Expose Conviva types Leverage Conviva types May 17, 2024
Copy link
Member

@dweinber dweinber left a comment

Choose a reason for hiding this comment

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

Nice update! A few comments though

webpack.prod.js Outdated Show resolved Hide resolved
CHANGELOG.md Outdated
Comment on lines 13 to 15
### Deprecated
- Removed `framework` and `frameworkVersion` custom metadata fields (custom tags)
- Removed `CustomContentMetadata`, use `Metadata['custom']` instead
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't these actually be in a ### Removed section?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in cce84d2.

Copy link
Member

Choose a reason for hiding this comment

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

Same for L14, or not? We missed that there but would be good to clean up

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right, done here ecc72d4. 🙂

src/ts/ContentMetadataBuilder.ts Outdated Show resolved Hide resolved
src/ts/ContentMetadataBuilder.ts Show resolved Hide resolved
src/ts/ContentMetadataBuilder.ts Show resolved Hide resolved
src/ts/index.ts Show resolved Hide resolved
@karpov-kir karpov-kir requested a review from dweinber May 20, 2024 08:49
@karpov-kir karpov-kir merged commit 88d707e into develop May 21, 2024
3 checks passed
@karpov-kir karpov-kir deleted the feature/TA-2596-expose-extended-types branch May 21, 2024 07:31
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