Skip to content

Add TypeScript Types for Cloudinary Product Gallery Widget#218

Merged
colbyfayock merged 1 commit intocloudinary-community:betafrom
Mrinank-Bhowmick:main
Oct 22, 2024
Merged

Add TypeScript Types for Cloudinary Product Gallery Widget#218
colbyfayock merged 1 commit intocloudinary-community:betafrom
Mrinank-Bhowmick:main

Conversation

@Mrinank-Bhowmick
Copy link

@Mrinank-Bhowmick Mrinank-Bhowmick commented Oct 18, 2024

Description

This pull request introduces TypeScript types for the Cloudinary Product Gallery Widget. It defines a comprehensive interface for the widget, following the reference documentation for better type safety and improved developer experience. No additional dependencies are required for this change.

Issue Ticket Number

199

Fixes #199

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Fix or improve the documentation
  • This change requires a documentation update

Checklist

  • I have followed the contributing guidelines of this project as mentioned in CONTRIBUTING.md
  • I have created an issue ticket for this PR
  • I have checked to ensure there aren't other open Pull Requests for the same update/change?
  • I have performed a self-review of my own code
  • I have run tests locally to ensure they all pass
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes needed to the documentation

@colbyfayock
Copy link
Collaborator

colbyfayock commented Oct 18, 2024

hey thanks @Mrinank-Bhowmick this is great!

just curious about the zoomProps and the thumbnailProps, did you intentionally leave those as any as I see they have definitions

i could consider it out of scope for this because i imagine it was a lot of work typing it up for what you have so far and can create a followup Issue, but just wondering if there was an actual reason first

@Mrinank-Bhowmick
Copy link
Author

Mrinank-Bhowmick commented Oct 18, 2024

Thanks @colbyfayock for the feedback!

Regarding zoomProps and thumbnailProps, I initially left those as any because they have too many sub-data types, and I wanted to make sure I was following the right code style before diving into those. I decided to submit the PR at this stage to get some feedback on the overall approach.

However, it would make a great follow-up,beginner friendly good-first-issue for others.

@Mrinank-Bhowmick
Copy link
Author

Mrinank-Bhowmick commented Oct 20, 2024

@colbyfayock any updates?

@colbyfayock colbyfayock changed the base branch from main to beta October 22, 2024 12:31
@colbyfayock colbyfayock merged commit 05cd33e into cloudinary-community:beta Oct 22, 2024
github-actions bot pushed a commit that referenced this pull request Oct 22, 2024
@semantic-release-bot
chore(release): 2.0.0-beta.2 [skip ci]
d262d80 
# [@cloudinary-util/types-v2.0.0-beta.2](https://github.com/cloudinary-community/cloudinary-util/compare/@cloudinary-util/types-v2.0.0-beta.1...@cloudinary-util/types-v2.0.0-beta.2) (2024-10-22)

### Bug Fixes

* Add TypeScript Types for Cloudinary Product Gallery Widget ([#218](#218)) ([05cd33e](05cd33e)), closes [#199](#199)
@colbyfayock colbyfayock mentioned this pull request Oct 22, 2024
Open
@colbyfayock
Copy link
Collaborator

colbyfayock commented Oct 22, 2024

sure thats fine, ideally you could go ahead and just get the other ones in, otherwise someone else can pick it up

#221

thanks for your contribution. this PR is eligible for free Cloudinary Hackatoberfest swag. Please send me an email at hacktoberfest@cloudinary.com with your name, GitHub username, and a link to the PR where I'll send further instructions.

Happy Hacktoberfest!

@colbyfayock
Copy link
Collaborator

colbyfayock commented Oct 22, 2024

@all-contributors please add @Mrinank-Bhowmick for code

@allcontributors allcontributors bot mentioned this pull request Oct 22, 2024
Merged
@allcontributors
Copy link
Contributor

allcontributors bot commented Oct 22, 2024

@colbyfayock

I've put up a pull request to add @Mrinank-Bhowmick! 🎉

colbyfayock pushed a commit that referenced this pull request Oct 22, 2024
@allcontributors
docs: add Mrinank-Bhowmick as a contributor for code (#222)
53887cd 
Adds @Mrinank-Bhowmick as a contributor for code.

This was requested by colbyfayock [in this
comment](#218 (comment))

[skip ci]

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

hacktoberfest

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Feature] Write out Typescript Types for Cloudinary Product Gallery Widget

2 participants

@Mrinank-Bhowmick @colbyfayock