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

Synced ComponentInfo to the current state of Component interface in gen1 builder.class.ts #2886

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

murtaza-builder
Copy link
Contributor

Description

Synced missing fields in gen2's ComponentInfo interface with gen1's Component interface in builder.class.ts

Copy link

changeset-bot bot commented Dec 19, 2023

⚠️ No Changeset found

Latest commit: b0fe4c4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Dec 19, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Ignored Deployments
Name Status Preview Comments Updated (UTC)
nextjs-sdk-example ⬜️ Ignored (Inspect) Visit Preview Dec 25, 2023 6:32am
qwik-city-sdk-example ⬜️ Ignored (Inspect) Visit Preview Dec 25, 2023 6:32am
svelte-vite-example ⬜️ Ignored (Inspect) Visit Preview Dec 25, 2023 6:32am

Comment on lines +30 to +31
export { isBrowser } from './functions/is-browser.js';
export { isServer } from './functions/is-server.js';
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we want to export these in the new SDKs. It makes little sense to provide our users with helpers like these: they have nothing to do with SDK functionality.

What is the use case for adding them here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We have exposed these helpers before in Gen1 and they are widely used in client code, example - in our site. Migrating to gen2 will require users with a substitute, thus exporting them

Copy link
Contributor

Choose a reason for hiding this comment

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

I understand, and that's the way to go. I would rather users rely on their own isBrowser/isServer helpers than reuse ours. The Builder SDK shouldn't be exporting generic helpers such as these: they are unrelated to the Builder SDK's purpose.

class?: any;
/** @hidden @deprecated */
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for adding these tags. We will want to go ahead and completely remove any deprecated attributes in gen2 SDKs before we bump to v1, as this is our big chance to remove deprecated features.

They can stay here for now though, and these tags will help us know what to remove in the near future 👍🏽

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.

None yet

2 participants