feat(elements): Update exports and prep for public builds - #2676

Merged
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components
Jan 30, 2024
Merged

feat(elements): Update exports and prep for public builds#2676
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components

Conversation

@tmilewski

@tmilewskitmilewski commented Jan 29, 2024

Copy link
Copy Markdown
Member

Description

95% of this PR is simply moving components out of single index.tsx files and updating imports and the specific imported component names.

Adding comments to call-out specific points of interest.

  • Splits out components into their respective files from one large index.tsx.
  • Enable export subpaths for:
    • /common
    • /sign-in
    • /sign-up
  • Enable the ability to publish builds.
  • Rename component exports to better handle the case where we don't want to use import * as ___ from ___
  • Adds analysis capabilites via npm run build:analyze

Components can now be imported into applications using the following structures:

import{GlobalError,Submit}from'@clerk/elements/common';import{Continue,Factor,SignIn,SocialProvider,Start,Verification}from'@clerk/elements/sign-in';
import*asClerkfrom'@clerk/elements/common';import*asSignInfrom'@clerk/elements/sign-in';

Note: Root also maps to SignIn allowing for SignIn.Root rather than SignIn.SignIn

Screenshot 2024-01-29 at 4 40 10 PM

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@tmilewskitmilewski self-assigned this Jan 29, 2024
@changeset-bot

changeset-botBot commented Jan 29, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 30f98f8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

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

Not sure what this means? Click here to learn what changesets are.

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

"app:e2e": "(cd examples/nextjs && npm run e2e)",
"app:lint": "(cd examples/nextjs && npm run lint)",
"build": "tsup",
"build:analyze": "tsup --metafile; open https://esbuild.github.io/analyze/",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Enables easy analysis of generated packages.

Comment threadpackages/elements/src/index.ts Outdated
export { useSignUpFlow, useSignUpFlowSelector } from '~/internals/machines/sign-up/sign-up.context';
export { useSignInFlow, useSignInFlowSelector } from '~/internals/machines/sign-in/sign-in.context';
export { useNextRouter };
throw new Error('Please import specific subpaths instead. See documentation for more details: https://clerk.com/docs/'); // TODO: Add link to docs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As-is, we don't need to make anything available at the top-level of the package.

index: 'src/index.ts',
'react/common/index': 'src/react/common/index.ts',
'react/sign-in/index': 'src/react/sign-in/index.ts',
'react/sign-up/index': 'src/react/sign-up/index.ts',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Create specific entrypoints

"author": "Clerk",
"sideEffects": false,
"exports": {
"./*": {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All React-specific code is contained within dist/react but available at the top-level by default, per previous conversations.

}
: {
className: 'bg-tertiary rounded-sm px-2 py-1 border border-foreground data-[invalid]:border-red-500',
ref: forwardedRef,

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

forwardedRef only applies to the non-otp input at this point.

@tmilewskitmilewski changed the title chore(elements): Update imports and prep for public buildschore(elements): Update exports and prep for public buildsJan 29, 2024
"@radix-ui/react-slot": "^1.0.2",
"@statelyai/inspect": "^0.1.0",
"@xstate/react": "^4.0.2",
"clsx": "^2.1.0",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Wasn't used.

@tmilewski
tmilewskiforce-pushed the tm.elements/react-components branch from cf43412 to e81605bCompareJanuary 29, 2024 21:19
@tmilewskitmilewski changed the title chore(elements): Update exports and prep for public buildsfeat(elements): Update exports and prep for public buildsJan 29, 2024
@tmilewski

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @tmilewski - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.v59b1e3b
@clerk/chrome-extension1.0.1-snapshot.v59b1e3b
@clerk/clerk-js5.0.1-snapshot.v59b1e3b
@clerk/elements0.0.2-snapshot.v59b1e3b
@clerk/clerk-expo1.0.1-snapshot.v59b1e3b
@clerk/fastify1.0.1-snapshot.v59b1e3b
gatsby-plugin-clerk5.0.1-snapshot.v59b1e3b
@clerk/localizations2.0.1-snapshot.v59b1e3b
@clerk/nextjs5.0.1-snapshot.v59b1e3b
@clerk/clerk-react5.0.1-snapshot.v59b1e3b
@clerk/remix4.0.1-snapshot.v59b1e3b
@clerk/clerk-sdk-node5.0.1-snapshot.v59b1e3b
@clerk/shared2.0.1-snapshot.v59b1e3b
@clerk/themes2.0.1-snapshot.v59b1e3b
@clerk/types4.0.1-snapshot.v59b1e3b

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/elements

npm i @clerk/elements@0.0.2-snapshot.v59b1e3b --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.v59b1e3b --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.v59b1e3b --save-exact

Comment threadpackages/elements/package.json Outdated
"files": [
"dist"
"dist",
"!dist/metafile-*.json",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Generated for bundle analysis and unable to configure where they're generated. This ensures we don't include them in the resulting package.

}

const Comp = asChild ? Slot : 'button';
const defaultProps = asChild ? {} : { type: 'button' as const };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

When encapsulated in form elements, buttons without a type default to submit causing issues when hitting enter.

@LekoArts
LekoArts enabled auto-merge January 30, 2024 10:52
@LekoArts
LekoArts added this pull request to the merge queue Jan 30, 2024
Merged via the queue into main with commit 25a8ff7Jan 30, 2024
@LekoArts
LekoArts deleted the tm.elements/react-components branch January 30, 2024 11:02
@LekoArtsLekoArts added this to the @clerk/elements (Alpha) milestone Feb 1, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@tmilewski@clerk-cookie@LekoArts
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

feat(elements): Update exports and prep for public builds - #2676

Merged
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components
Jan 30, 2024
Merged

feat(elements): Update exports and prep for public builds#2676
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components

Conversation

@tmilewski

@tmilewskitmilewski commented Jan 29, 2024

Copy link
Copy Markdown
Member

Description

95% of this PR is simply moving components out of single index.tsx files and updating imports and the specific imported component names.

Adding comments to call-out specific points of interest.

  • Splits out components into their respective files from one large index.tsx.
  • Enable export subpaths for:
    • /common
    • /sign-in
    • /sign-up
  • Enable the ability to publish builds.
  • Rename component exports to better handle the case where we don't want to use import * as ___ from ___
  • Adds analysis capabilites via npm run build:analyze

Components can now be imported into applications using the following structures:

import{GlobalError,Submit}from'@clerk/elements/common';import{Continue,Factor,SignIn,SocialProvider,Start,Verification}from'@clerk/elements/sign-in';
import*asClerkfrom'@clerk/elements/common';import*asSignInfrom'@clerk/elements/sign-in';

Note: Root also maps to SignIn allowing for SignIn.Root rather than SignIn.SignIn

Screenshot 2024-01-29 at 4 40 10 PM

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@tmilewskitmilewski self-assigned this Jan 29, 2024
@changeset-bot

changeset-botBot commented Jan 29, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 30f98f8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

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

Not sure what this means? Click here to learn what changesets are.

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

"app:e2e": "(cd examples/nextjs && npm run e2e)",
"app:lint": "(cd examples/nextjs && npm run lint)",
"build": "tsup",
"build:analyze": "tsup --metafile; open https://esbuild.github.io/analyze/",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Enables easy analysis of generated packages.

Comment threadpackages/elements/src/index.ts Outdated
export { useSignUpFlow, useSignUpFlowSelector } from '~/internals/machines/sign-up/sign-up.context';
export { useSignInFlow, useSignInFlowSelector } from '~/internals/machines/sign-in/sign-in.context';
export { useNextRouter };
throw new Error('Please import specific subpaths instead. See documentation for more details: https://clerk.com/docs/'); // TODO: Add link to docs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As-is, we don't need to make anything available at the top-level of the package.

index: 'src/index.ts',
'react/common/index': 'src/react/common/index.ts',
'react/sign-in/index': 'src/react/sign-in/index.ts',
'react/sign-up/index': 'src/react/sign-up/index.ts',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Create specific entrypoints

"author": "Clerk",
"sideEffects": false,
"exports": {
"./*": {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All React-specific code is contained within dist/react but available at the top-level by default, per previous conversations.

}
: {
className: 'bg-tertiary rounded-sm px-2 py-1 border border-foreground data-[invalid]:border-red-500',
ref: forwardedRef,

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

forwardedRef only applies to the non-otp input at this point.

@tmilewskitmilewski changed the title chore(elements): Update imports and prep for public buildschore(elements): Update exports and prep for public buildsJan 29, 2024
"@radix-ui/react-slot": "^1.0.2",
"@statelyai/inspect": "^0.1.0",
"@xstate/react": "^4.0.2",
"clsx": "^2.1.0",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Wasn't used.

@tmilewski
tmilewskiforce-pushed the tm.elements/react-components branch from cf43412 to e81605bCompareJanuary 29, 2024 21:19
@tmilewskitmilewski changed the title chore(elements): Update exports and prep for public buildsfeat(elements): Update exports and prep for public buildsJan 29, 2024
@tmilewski

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @tmilewski - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.v59b1e3b
@clerk/chrome-extension1.0.1-snapshot.v59b1e3b
@clerk/clerk-js5.0.1-snapshot.v59b1e3b
@clerk/elements0.0.2-snapshot.v59b1e3b
@clerk/clerk-expo1.0.1-snapshot.v59b1e3b
@clerk/fastify1.0.1-snapshot.v59b1e3b
gatsby-plugin-clerk5.0.1-snapshot.v59b1e3b
@clerk/localizations2.0.1-snapshot.v59b1e3b
@clerk/nextjs5.0.1-snapshot.v59b1e3b
@clerk/clerk-react5.0.1-snapshot.v59b1e3b
@clerk/remix4.0.1-snapshot.v59b1e3b
@clerk/clerk-sdk-node5.0.1-snapshot.v59b1e3b
@clerk/shared2.0.1-snapshot.v59b1e3b
@clerk/themes2.0.1-snapshot.v59b1e3b
@clerk/types4.0.1-snapshot.v59b1e3b

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/elements

npm i @clerk/elements@0.0.2-snapshot.v59b1e3b --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.v59b1e3b --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.v59b1e3b --save-exact

Comment threadpackages/elements/package.json Outdated
"files": [
"dist"
"dist",
"!dist/metafile-*.json",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Generated for bundle analysis and unable to configure where they're generated. This ensures we don't include them in the resulting package.

}

const Comp = asChild ? Slot : 'button';
const defaultProps = asChild ? {} : { type: 'button' as const };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

When encapsulated in form elements, buttons without a type default to submit causing issues when hitting enter.

@LekoArts
LekoArts enabled auto-merge January 30, 2024 10:52
@LekoArts
LekoArts added this pull request to the merge queue Jan 30, 2024
Merged via the queue into main with commit 25a8ff7Jan 30, 2024
@LekoArts
LekoArts deleted the tm.elements/react-components branch January 30, 2024 11:02
@LekoArtsLekoArts added this to the @clerk/elements (Alpha) milestone Feb 1, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@tmilewski@clerk-cookie@LekoArts
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(elements): Update exports and prep for public builds - #2676

Merged
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components
Jan 30, 2024
Merged

feat(elements): Update exports and prep for public builds#2676
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components

Conversation

@tmilewski

@tmilewskitmilewski commented Jan 29, 2024

Copy link
Copy Markdown
Member

Description

95% of this PR is simply moving components out of single index.tsx files and updating imports and the specific imported component names.

Adding comments to call-out specific points of interest.

  • Splits out components into their respective files from one large index.tsx.
  • Enable export subpaths for:
    • /common
    • /sign-in
    • /sign-up
  • Enable the ability to publish builds.
  • Rename component exports to better handle the case where we don't want to use import * as ___ from ___
  • Adds analysis capabilites via npm run build:analyze

Components can now be imported into applications using the following structures:

import{GlobalError,Submit}from'@clerk/elements/common';import{Continue,Factor,SignIn,SocialProvider,Start,Verification}from'@clerk/elements/sign-in';
import*asClerkfrom'@clerk/elements/common';import*asSignInfrom'@clerk/elements/sign-in';

Note: Root also maps to SignIn allowing for SignIn.Root rather than SignIn.SignIn

Screenshot 2024-01-29 at 4 40 10 PM

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@tmilewskitmilewski self-assigned this Jan 29, 2024
@changeset-bot

changeset-botBot commented Jan 29, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 30f98f8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

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

Not sure what this means? Click here to learn what changesets are.

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

"app:e2e": "(cd examples/nextjs && npm run e2e)",
"app:lint": "(cd examples/nextjs && npm run lint)",
"build": "tsup",
"build:analyze": "tsup --metafile; open https://esbuild.github.io/analyze/",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Enables easy analysis of generated packages.

Comment threadpackages/elements/src/index.ts Outdated
export { useSignUpFlow, useSignUpFlowSelector } from '~/internals/machines/sign-up/sign-up.context';
export { useSignInFlow, useSignInFlowSelector } from '~/internals/machines/sign-in/sign-in.context';
export { useNextRouter };
throw new Error('Please import specific subpaths instead. See documentation for more details: https://clerk.com/docs/'); // TODO: Add link to docs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As-is, we don't need to make anything available at the top-level of the package.

index: 'src/index.ts',
'react/common/index': 'src/react/common/index.ts',
'react/sign-in/index': 'src/react/sign-in/index.ts',
'react/sign-up/index': 'src/react/sign-up/index.ts',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Create specific entrypoints

"author": "Clerk",
"sideEffects": false,
"exports": {
"./*": {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All React-specific code is contained within dist/react but available at the top-level by default, per previous conversations.

}
: {
className: 'bg-tertiary rounded-sm px-2 py-1 border border-foreground data-[invalid]:border-red-500',
ref: forwardedRef,

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

forwardedRef only applies to the non-otp input at this point.

@tmilewskitmilewski changed the title chore(elements): Update imports and prep for public buildschore(elements): Update exports and prep for public buildsJan 29, 2024
"@radix-ui/react-slot": "^1.0.2",
"@statelyai/inspect": "^0.1.0",
"@xstate/react": "^4.0.2",
"clsx": "^2.1.0",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Wasn't used.

@tmilewski
tmilewskiforce-pushed the tm.elements/react-components branch from cf43412 to e81605bCompareJanuary 29, 2024 21:19
@tmilewskitmilewski changed the title chore(elements): Update exports and prep for public buildsfeat(elements): Update exports and prep for public buildsJan 29, 2024
@tmilewski

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @tmilewski - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.v59b1e3b
@clerk/chrome-extension1.0.1-snapshot.v59b1e3b
@clerk/clerk-js5.0.1-snapshot.v59b1e3b
@clerk/elements0.0.2-snapshot.v59b1e3b
@clerk/clerk-expo1.0.1-snapshot.v59b1e3b
@clerk/fastify1.0.1-snapshot.v59b1e3b
gatsby-plugin-clerk5.0.1-snapshot.v59b1e3b
@clerk/localizations2.0.1-snapshot.v59b1e3b
@clerk/nextjs5.0.1-snapshot.v59b1e3b
@clerk/clerk-react5.0.1-snapshot.v59b1e3b
@clerk/remix4.0.1-snapshot.v59b1e3b
@clerk/clerk-sdk-node5.0.1-snapshot.v59b1e3b
@clerk/shared2.0.1-snapshot.v59b1e3b
@clerk/themes2.0.1-snapshot.v59b1e3b
@clerk/types4.0.1-snapshot.v59b1e3b

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/elements

npm i @clerk/elements@0.0.2-snapshot.v59b1e3b --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.v59b1e3b --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.v59b1e3b --save-exact

Comment threadpackages/elements/package.json Outdated
"files": [
"dist"
"dist",
"!dist/metafile-*.json",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Generated for bundle analysis and unable to configure where they're generated. This ensures we don't include them in the resulting package.

}

const Comp = asChild ? Slot : 'button';
const defaultProps = asChild ? {} : { type: 'button' as const };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

When encapsulated in form elements, buttons without a type default to submit causing issues when hitting enter.

@LekoArts
LekoArts enabled auto-merge January 30, 2024 10:52
@LekoArts
LekoArts added this pull request to the merge queue Jan 30, 2024
Merged via the queue into main with commit 25a8ff7Jan 30, 2024
@LekoArts
LekoArts deleted the tm.elements/react-components branch January 30, 2024 11:02
@LekoArtsLekoArts added this to the @clerk/elements (Alpha) milestone Feb 1, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@tmilewski@clerk-cookie@LekoArts
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(elements): Update exports and prep for public builds - #2676

Merged
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components
Jan 30, 2024
Merged

feat(elements): Update exports and prep for public builds#2676
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components

Conversation

@tmilewski

@tmilewskitmilewski commented Jan 29, 2024

Copy link
Copy Markdown
Member

Description

95% of this PR is simply moving components out of single index.tsx files and updating imports and the specific imported component names.

Adding comments to call-out specific points of interest.

  • Splits out components into their respective files from one large index.tsx.
  • Enable export subpaths for:
    • /common
    • /sign-in
    • /sign-up
  • Enable the ability to publish builds.
  • Rename component exports to better handle the case where we don't want to use import * as ___ from ___
  • Adds analysis capabilites via npm run build:analyze

Components can now be imported into applications using the following structures:

import{GlobalError,Submit}from'@clerk/elements/common';import{Continue,Factor,SignIn,SocialProvider,Start,Verification}from'@clerk/elements/sign-in';
import*asClerkfrom'@clerk/elements/common';import*asSignInfrom'@clerk/elements/sign-in';

Note: Root also maps to SignIn allowing for SignIn.Root rather than SignIn.SignIn

Screenshot 2024-01-29 at 4 40 10 PM

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@tmilewskitmilewski self-assigned this Jan 29, 2024
@changeset-bot

changeset-botBot commented Jan 29, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 30f98f8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

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

Not sure what this means? Click here to learn what changesets are.

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

"app:e2e": "(cd examples/nextjs && npm run e2e)",
"app:lint": "(cd examples/nextjs && npm run lint)",
"build": "tsup",
"build:analyze": "tsup --metafile; open https://esbuild.github.io/analyze/",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Enables easy analysis of generated packages.

Comment threadpackages/elements/src/index.ts Outdated
export { useSignUpFlow, useSignUpFlowSelector } from '~/internals/machines/sign-up/sign-up.context';
export { useSignInFlow, useSignInFlowSelector } from '~/internals/machines/sign-in/sign-in.context';
export { useNextRouter };
throw new Error('Please import specific subpaths instead. See documentation for more details: https://clerk.com/docs/'); // TODO: Add link to docs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As-is, we don't need to make anything available at the top-level of the package.

index: 'src/index.ts',
'react/common/index': 'src/react/common/index.ts',
'react/sign-in/index': 'src/react/sign-in/index.ts',
'react/sign-up/index': 'src/react/sign-up/index.ts',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Create specific entrypoints

"author": "Clerk",
"sideEffects": false,
"exports": {
"./*": {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All React-specific code is contained within dist/react but available at the top-level by default, per previous conversations.

}
: {
className: 'bg-tertiary rounded-sm px-2 py-1 border border-foreground data-[invalid]:border-red-500',
ref: forwardedRef,

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

forwardedRef only applies to the non-otp input at this point.

@tmilewskitmilewski changed the title chore(elements): Update imports and prep for public buildschore(elements): Update exports and prep for public buildsJan 29, 2024
"@radix-ui/react-slot": "^1.0.2",
"@statelyai/inspect": "^0.1.0",
"@xstate/react": "^4.0.2",
"clsx": "^2.1.0",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Wasn't used.

@tmilewski
tmilewskiforce-pushed the tm.elements/react-components branch from cf43412 to e81605bCompareJanuary 29, 2024 21:19
@tmilewskitmilewski changed the title chore(elements): Update exports and prep for public buildsfeat(elements): Update exports and prep for public buildsJan 29, 2024
@tmilewski

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @tmilewski - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.v59b1e3b
@clerk/chrome-extension1.0.1-snapshot.v59b1e3b
@clerk/clerk-js5.0.1-snapshot.v59b1e3b
@clerk/elements0.0.2-snapshot.v59b1e3b
@clerk/clerk-expo1.0.1-snapshot.v59b1e3b
@clerk/fastify1.0.1-snapshot.v59b1e3b
gatsby-plugin-clerk5.0.1-snapshot.v59b1e3b
@clerk/localizations2.0.1-snapshot.v59b1e3b
@clerk/nextjs5.0.1-snapshot.v59b1e3b
@clerk/clerk-react5.0.1-snapshot.v59b1e3b
@clerk/remix4.0.1-snapshot.v59b1e3b
@clerk/clerk-sdk-node5.0.1-snapshot.v59b1e3b
@clerk/shared2.0.1-snapshot.v59b1e3b
@clerk/themes2.0.1-snapshot.v59b1e3b
@clerk/types4.0.1-snapshot.v59b1e3b

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/elements

npm i @clerk/elements@0.0.2-snapshot.v59b1e3b --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.v59b1e3b --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.v59b1e3b --save-exact

Comment threadpackages/elements/package.json Outdated
"files": [
"dist"
"dist",
"!dist/metafile-*.json",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Generated for bundle analysis and unable to configure where they're generated. This ensures we don't include them in the resulting package.

}

const Comp = asChild ? Slot : 'button';
const defaultProps = asChild ? {} : { type: 'button' as const };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

When encapsulated in form elements, buttons without a type default to submit causing issues when hitting enter.

@LekoArts
LekoArts enabled auto-merge January 30, 2024 10:52
@LekoArts
LekoArts added this pull request to the merge queue Jan 30, 2024
Merged via the queue into main with commit 25a8ff7Jan 30, 2024
@LekoArts
LekoArts deleted the tm.elements/react-components branch January 30, 2024 11:02
@LekoArtsLekoArts added this to the @clerk/elements (Alpha) milestone Feb 1, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@tmilewski@clerk-cookie@LekoArts
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat(elements): Update exports and prep for public builds - #2676

Merged
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components
Jan 30, 2024
Merged

feat(elements): Update exports and prep for public builds#2676
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components

Conversation

@tmilewski

@tmilewskitmilewski commented Jan 29, 2024

Copy link
Copy Markdown
Member

Description

95% of this PR is simply moving components out of single index.tsx files and updating imports and the specific imported component names.

Adding comments to call-out specific points of interest.

  • Splits out components into their respective files from one large index.tsx.
  • Enable export subpaths for:
    • /common
    • /sign-in
    • /sign-up
  • Enable the ability to publish builds.
  • Rename component exports to better handle the case where we don't want to use import * as ___ from ___
  • Adds analysis capabilites via npm run build:analyze

Components can now be imported into applications using the following structures:

import{GlobalError,Submit}from'@clerk/elements/common';import{Continue,Factor,SignIn,SocialProvider,Start,Verification}from'@clerk/elements/sign-in';
import*asClerkfrom'@clerk/elements/common';import*asSignInfrom'@clerk/elements/sign-in';

Note: Root also maps to SignIn allowing for SignIn.Root rather than SignIn.SignIn

Screenshot 2024-01-29 at 4 40 10 PM

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@tmilewskitmilewski self-assigned this Jan 29, 2024
@changeset-bot

changeset-botBot commented Jan 29, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 30f98f8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

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

Not sure what this means? Click here to learn what changesets are.

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

"app:e2e": "(cd examples/nextjs && npm run e2e)",
"app:lint": "(cd examples/nextjs && npm run lint)",
"build": "tsup",
"build:analyze": "tsup --metafile; open https://esbuild.github.io/analyze/",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Enables easy analysis of generated packages.

Comment threadpackages/elements/src/index.ts Outdated
export { useSignUpFlow, useSignUpFlowSelector } from '~/internals/machines/sign-up/sign-up.context';
export { useSignInFlow, useSignInFlowSelector } from '~/internals/machines/sign-in/sign-in.context';
export { useNextRouter };
throw new Error('Please import specific subpaths instead. See documentation for more details: https://clerk.com/docs/'); // TODO: Add link to docs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As-is, we don't need to make anything available at the top-level of the package.

index: 'src/index.ts',
'react/common/index': 'src/react/common/index.ts',
'react/sign-in/index': 'src/react/sign-in/index.ts',
'react/sign-up/index': 'src/react/sign-up/index.ts',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Create specific entrypoints

"author": "Clerk",
"sideEffects": false,
"exports": {
"./*": {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All React-specific code is contained within dist/react but available at the top-level by default, per previous conversations.

}
: {
className: 'bg-tertiary rounded-sm px-2 py-1 border border-foreground data-[invalid]:border-red-500',
ref: forwardedRef,

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

forwardedRef only applies to the non-otp input at this point.

@tmilewskitmilewski changed the title chore(elements): Update imports and prep for public buildschore(elements): Update exports and prep for public buildsJan 29, 2024
"@radix-ui/react-slot": "^1.0.2",
"@statelyai/inspect": "^0.1.0",
"@xstate/react": "^4.0.2",
"clsx": "^2.1.0",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Wasn't used.

@tmilewski
tmilewskiforce-pushed the tm.elements/react-components branch from cf43412 to e81605bCompareJanuary 29, 2024 21:19
@tmilewskitmilewski changed the title chore(elements): Update exports and prep for public buildsfeat(elements): Update exports and prep for public buildsJan 29, 2024
@tmilewski

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @tmilewski - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.v59b1e3b
@clerk/chrome-extension1.0.1-snapshot.v59b1e3b
@clerk/clerk-js5.0.1-snapshot.v59b1e3b
@clerk/elements0.0.2-snapshot.v59b1e3b
@clerk/clerk-expo1.0.1-snapshot.v59b1e3b
@clerk/fastify1.0.1-snapshot.v59b1e3b
gatsby-plugin-clerk5.0.1-snapshot.v59b1e3b
@clerk/localizations2.0.1-snapshot.v59b1e3b
@clerk/nextjs5.0.1-snapshot.v59b1e3b
@clerk/clerk-react5.0.1-snapshot.v59b1e3b
@clerk/remix4.0.1-snapshot.v59b1e3b
@clerk/clerk-sdk-node5.0.1-snapshot.v59b1e3b
@clerk/shared2.0.1-snapshot.v59b1e3b
@clerk/themes2.0.1-snapshot.v59b1e3b
@clerk/types4.0.1-snapshot.v59b1e3b

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/elements

npm i @clerk/elements@0.0.2-snapshot.v59b1e3b --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.v59b1e3b --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.v59b1e3b --save-exact

Comment threadpackages/elements/package.json Outdated
"files": [
"dist"
"dist",
"!dist/metafile-*.json",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Generated for bundle analysis and unable to configure where they're generated. This ensures we don't include them in the resulting package.

}

const Comp = asChild ? Slot : 'button';
const defaultProps = asChild ? {} : { type: 'button' as const };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

When encapsulated in form elements, buttons without a type default to submit causing issues when hitting enter.

@LekoArts
LekoArts enabled auto-merge January 30, 2024 10:52
@LekoArts
LekoArts added this pull request to the merge queue Jan 30, 2024
Merged via the queue into main with commit 25a8ff7Jan 30, 2024
@LekoArts
LekoArts deleted the tm.elements/react-components branch January 30, 2024 11:02
@LekoArtsLekoArts added this to the @clerk/elements (Alpha) milestone Feb 1, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@tmilewski@clerk-cookie@LekoArts
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(elements): Update exports and prep for public builds - #2676

Merged
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components
Jan 30, 2024
Merged

feat(elements): Update exports and prep for public builds#2676
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components

Conversation

@tmilewski

@tmilewskitmilewski commented Jan 29, 2024

Copy link
Copy Markdown
Member

Description

95% of this PR is simply moving components out of single index.tsx files and updating imports and the specific imported component names.

Adding comments to call-out specific points of interest.

  • Splits out components into their respective files from one large index.tsx.
  • Enable export subpaths for:
    • /common
    • /sign-in
    • /sign-up
  • Enable the ability to publish builds.
  • Rename component exports to better handle the case where we don't want to use import * as ___ from ___
  • Adds analysis capabilites via npm run build:analyze

Components can now be imported into applications using the following structures:

import{GlobalError,Submit}from'@clerk/elements/common';import{Continue,Factor,SignIn,SocialProvider,Start,Verification}from'@clerk/elements/sign-in';
import*asClerkfrom'@clerk/elements/common';import*asSignInfrom'@clerk/elements/sign-in';

Note: Root also maps to SignIn allowing for SignIn.Root rather than SignIn.SignIn

Screenshot 2024-01-29 at 4 40 10 PM

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@tmilewskitmilewski self-assigned this Jan 29, 2024
@changeset-bot

changeset-botBot commented Jan 29, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 30f98f8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

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

Not sure what this means? Click here to learn what changesets are.

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

"app:e2e": "(cd examples/nextjs && npm run e2e)",
"app:lint": "(cd examples/nextjs && npm run lint)",
"build": "tsup",
"build:analyze": "tsup --metafile; open https://esbuild.github.io/analyze/",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Enables easy analysis of generated packages.

Comment threadpackages/elements/src/index.ts Outdated
export { useSignUpFlow, useSignUpFlowSelector } from '~/internals/machines/sign-up/sign-up.context';
export { useSignInFlow, useSignInFlowSelector } from '~/internals/machines/sign-in/sign-in.context';
export { useNextRouter };
throw new Error('Please import specific subpaths instead. See documentation for more details: https://clerk.com/docs/'); // TODO: Add link to docs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As-is, we don't need to make anything available at the top-level of the package.

index: 'src/index.ts',
'react/common/index': 'src/react/common/index.ts',
'react/sign-in/index': 'src/react/sign-in/index.ts',
'react/sign-up/index': 'src/react/sign-up/index.ts',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Create specific entrypoints

"author": "Clerk",
"sideEffects": false,
"exports": {
"./*": {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All React-specific code is contained within dist/react but available at the top-level by default, per previous conversations.

}
: {
className: 'bg-tertiary rounded-sm px-2 py-1 border border-foreground data-[invalid]:border-red-500',
ref: forwardedRef,

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

forwardedRef only applies to the non-otp input at this point.

@tmilewskitmilewski changed the title chore(elements): Update imports and prep for public buildschore(elements): Update exports and prep for public buildsJan 29, 2024
"@radix-ui/react-slot": "^1.0.2",
"@statelyai/inspect": "^0.1.0",
"@xstate/react": "^4.0.2",
"clsx": "^2.1.0",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Wasn't used.

@tmilewski
tmilewskiforce-pushed the tm.elements/react-components branch from cf43412 to e81605bCompareJanuary 29, 2024 21:19
@tmilewskitmilewski changed the title chore(elements): Update exports and prep for public buildsfeat(elements): Update exports and prep for public buildsJan 29, 2024
@tmilewski

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @tmilewski - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.v59b1e3b
@clerk/chrome-extension1.0.1-snapshot.v59b1e3b
@clerk/clerk-js5.0.1-snapshot.v59b1e3b
@clerk/elements0.0.2-snapshot.v59b1e3b
@clerk/clerk-expo1.0.1-snapshot.v59b1e3b
@clerk/fastify1.0.1-snapshot.v59b1e3b
gatsby-plugin-clerk5.0.1-snapshot.v59b1e3b
@clerk/localizations2.0.1-snapshot.v59b1e3b
@clerk/nextjs5.0.1-snapshot.v59b1e3b
@clerk/clerk-react5.0.1-snapshot.v59b1e3b
@clerk/remix4.0.1-snapshot.v59b1e3b
@clerk/clerk-sdk-node5.0.1-snapshot.v59b1e3b
@clerk/shared2.0.1-snapshot.v59b1e3b
@clerk/themes2.0.1-snapshot.v59b1e3b
@clerk/types4.0.1-snapshot.v59b1e3b

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/elements

npm i @clerk/elements@0.0.2-snapshot.v59b1e3b --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.v59b1e3b --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.v59b1e3b --save-exact

Comment threadpackages/elements/package.json Outdated
"files": [
"dist"
"dist",
"!dist/metafile-*.json",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Generated for bundle analysis and unable to configure where they're generated. This ensures we don't include them in the resulting package.

}

const Comp = asChild ? Slot : 'button';
const defaultProps = asChild ? {} : { type: 'button' as const };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

When encapsulated in form elements, buttons without a type default to submit causing issues when hitting enter.

@LekoArts
LekoArts enabled auto-merge January 30, 2024 10:52
@LekoArts
LekoArts added this pull request to the merge queue Jan 30, 2024
Merged via the queue into main with commit 25a8ff7Jan 30, 2024
@LekoArts
LekoArts deleted the tm.elements/react-components branch January 30, 2024 11:02
@LekoArtsLekoArts added this to the @clerk/elements (Alpha) milestone Feb 1, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@tmilewski@clerk-cookie@LekoArts
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(elements): Update exports and prep for public builds - #2676

Merged
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components
Jan 30, 2024
Merged

feat(elements): Update exports and prep for public builds#2676
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components

Conversation

@tmilewski

@tmilewskitmilewski commented Jan 29, 2024

Copy link
Copy Markdown
Member

Description

95% of this PR is simply moving components out of single index.tsx files and updating imports and the specific imported component names.

Adding comments to call-out specific points of interest.

  • Splits out components into their respective files from one large index.tsx.
  • Enable export subpaths for:
    • /common
    • /sign-in
    • /sign-up
  • Enable the ability to publish builds.
  • Rename component exports to better handle the case where we don't want to use import * as ___ from ___
  • Adds analysis capabilites via npm run build:analyze

Components can now be imported into applications using the following structures:

import{GlobalError,Submit}from'@clerk/elements/common';import{Continue,Factor,SignIn,SocialProvider,Start,Verification}from'@clerk/elements/sign-in';
import*asClerkfrom'@clerk/elements/common';import*asSignInfrom'@clerk/elements/sign-in';

Note: Root also maps to SignIn allowing for SignIn.Root rather than SignIn.SignIn

Screenshot 2024-01-29 at 4 40 10 PM

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@tmilewskitmilewski self-assigned this Jan 29, 2024
@changeset-bot

changeset-botBot commented Jan 29, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 30f98f8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

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

Not sure what this means? Click here to learn what changesets are.

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

"app:e2e": "(cd examples/nextjs && npm run e2e)",
"app:lint": "(cd examples/nextjs && npm run lint)",
"build": "tsup",
"build:analyze": "tsup --metafile; open https://esbuild.github.io/analyze/",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Enables easy analysis of generated packages.

Comment threadpackages/elements/src/index.ts Outdated
export { useSignUpFlow, useSignUpFlowSelector } from '~/internals/machines/sign-up/sign-up.context';
export { useSignInFlow, useSignInFlowSelector } from '~/internals/machines/sign-in/sign-in.context';
export { useNextRouter };
throw new Error('Please import specific subpaths instead. See documentation for more details: https://clerk.com/docs/'); // TODO: Add link to docs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As-is, we don't need to make anything available at the top-level of the package.

index: 'src/index.ts',
'react/common/index': 'src/react/common/index.ts',
'react/sign-in/index': 'src/react/sign-in/index.ts',
'react/sign-up/index': 'src/react/sign-up/index.ts',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Create specific entrypoints

"author": "Clerk",
"sideEffects": false,
"exports": {
"./*": {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All React-specific code is contained within dist/react but available at the top-level by default, per previous conversations.

}
: {
className: 'bg-tertiary rounded-sm px-2 py-1 border border-foreground data-[invalid]:border-red-500',
ref: forwardedRef,

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

forwardedRef only applies to the non-otp input at this point.

@tmilewskitmilewski changed the title chore(elements): Update imports and prep for public buildschore(elements): Update exports and prep for public buildsJan 29, 2024
"@radix-ui/react-slot": "^1.0.2",
"@statelyai/inspect": "^0.1.0",
"@xstate/react": "^4.0.2",
"clsx": "^2.1.0",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Wasn't used.

@tmilewski
tmilewskiforce-pushed the tm.elements/react-components branch from cf43412 to e81605bCompareJanuary 29, 2024 21:19
@tmilewskitmilewski changed the title chore(elements): Update exports and prep for public buildsfeat(elements): Update exports and prep for public buildsJan 29, 2024
@tmilewski

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @tmilewski - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.v59b1e3b
@clerk/chrome-extension1.0.1-snapshot.v59b1e3b
@clerk/clerk-js5.0.1-snapshot.v59b1e3b
@clerk/elements0.0.2-snapshot.v59b1e3b
@clerk/clerk-expo1.0.1-snapshot.v59b1e3b
@clerk/fastify1.0.1-snapshot.v59b1e3b
gatsby-plugin-clerk5.0.1-snapshot.v59b1e3b
@clerk/localizations2.0.1-snapshot.v59b1e3b
@clerk/nextjs5.0.1-snapshot.v59b1e3b
@clerk/clerk-react5.0.1-snapshot.v59b1e3b
@clerk/remix4.0.1-snapshot.v59b1e3b
@clerk/clerk-sdk-node5.0.1-snapshot.v59b1e3b
@clerk/shared2.0.1-snapshot.v59b1e3b
@clerk/themes2.0.1-snapshot.v59b1e3b
@clerk/types4.0.1-snapshot.v59b1e3b

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/elements

npm i @clerk/elements@0.0.2-snapshot.v59b1e3b --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.v59b1e3b --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.v59b1e3b --save-exact

Comment threadpackages/elements/package.json Outdated
"files": [
"dist"
"dist",
"!dist/metafile-*.json",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Generated for bundle analysis and unable to configure where they're generated. This ensures we don't include them in the resulting package.

}

const Comp = asChild ? Slot : 'button';
const defaultProps = asChild ? {} : { type: 'button' as const };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

When encapsulated in form elements, buttons without a type default to submit causing issues when hitting enter.

@LekoArts
LekoArts enabled auto-merge January 30, 2024 10:52
@LekoArts
LekoArts added this pull request to the merge queue Jan 30, 2024
Merged via the queue into main with commit 25a8ff7Jan 30, 2024
@LekoArts
LekoArts deleted the tm.elements/react-components branch January 30, 2024 11:02
@LekoArtsLekoArts added this to the @clerk/elements (Alpha) milestone Feb 1, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@tmilewski@clerk-cookie@LekoArts
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

feat(elements): Update exports and prep for public builds - #2676

Merged
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components
Jan 30, 2024
Merged

feat(elements): Update exports and prep for public builds#2676
LekoArts merged 15 commits into
mainfrom
tm.elements/react-components

Conversation

@tmilewski

@tmilewskitmilewski commented Jan 29, 2024

Copy link
Copy Markdown
Member

Description

95% of this PR is simply moving components out of single index.tsx files and updating imports and the specific imported component names.

Adding comments to call-out specific points of interest.

  • Splits out components into their respective files from one large index.tsx.
  • Enable export subpaths for:
    • /common
    • /sign-in
    • /sign-up
  • Enable the ability to publish builds.
  • Rename component exports to better handle the case where we don't want to use import * as ___ from ___
  • Adds analysis capabilites via npm run build:analyze

Components can now be imported into applications using the following structures:

import{GlobalError,Submit}from'@clerk/elements/common';import{Continue,Factor,SignIn,SocialProvider,Start,Verification}from'@clerk/elements/sign-in';
import*asClerkfrom'@clerk/elements/common';import*asSignInfrom'@clerk/elements/sign-in';

Note: Root also maps to SignIn allowing for SignIn.Root rather than SignIn.SignIn

Screenshot 2024-01-29 at 4 40 10 PM

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@tmilewskitmilewski self-assigned this Jan 29, 2024
@changeset-bot

changeset-botBot commented Jan 29, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 30f98f8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

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

Not sure what this means? Click here to learn what changesets are.

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

"app:e2e": "(cd examples/nextjs && npm run e2e)",
"app:lint": "(cd examples/nextjs && npm run lint)",
"build": "tsup",
"build:analyze": "tsup --metafile; open https://esbuild.github.io/analyze/",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Enables easy analysis of generated packages.

Comment threadpackages/elements/src/index.ts Outdated
export { useSignUpFlow, useSignUpFlowSelector } from '~/internals/machines/sign-up/sign-up.context';
export { useSignInFlow, useSignInFlowSelector } from '~/internals/machines/sign-in/sign-in.context';
export { useNextRouter };
throw new Error('Please import specific subpaths instead. See documentation for more details: https://clerk.com/docs/'); // TODO: Add link to docs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As-is, we don't need to make anything available at the top-level of the package.

index: 'src/index.ts',
'react/common/index': 'src/react/common/index.ts',
'react/sign-in/index': 'src/react/sign-in/index.ts',
'react/sign-up/index': 'src/react/sign-up/index.ts',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Create specific entrypoints

"author": "Clerk",
"sideEffects": false,
"exports": {
"./*": {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All React-specific code is contained within dist/react but available at the top-level by default, per previous conversations.

}
: {
className: 'bg-tertiary rounded-sm px-2 py-1 border border-foreground data-[invalid]:border-red-500',
ref: forwardedRef,

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

forwardedRef only applies to the non-otp input at this point.

@tmilewskitmilewski changed the title chore(elements): Update imports and prep for public buildschore(elements): Update exports and prep for public buildsJan 29, 2024
"@radix-ui/react-slot": "^1.0.2",
"@statelyai/inspect": "^0.1.0",
"@xstate/react": "^4.0.2",
"clsx": "^2.1.0",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Wasn't used.

@tmilewski
tmilewskiforce-pushed the tm.elements/react-components branch from cf43412 to e81605bCompareJanuary 29, 2024 21:19
@tmilewskitmilewski changed the title chore(elements): Update exports and prep for public buildsfeat(elements): Update exports and prep for public buildsJan 29, 2024
@tmilewski

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @tmilewski - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.v59b1e3b
@clerk/chrome-extension1.0.1-snapshot.v59b1e3b
@clerk/clerk-js5.0.1-snapshot.v59b1e3b
@clerk/elements0.0.2-snapshot.v59b1e3b
@clerk/clerk-expo1.0.1-snapshot.v59b1e3b
@clerk/fastify1.0.1-snapshot.v59b1e3b
gatsby-plugin-clerk5.0.1-snapshot.v59b1e3b
@clerk/localizations2.0.1-snapshot.v59b1e3b
@clerk/nextjs5.0.1-snapshot.v59b1e3b
@clerk/clerk-react5.0.1-snapshot.v59b1e3b
@clerk/remix4.0.1-snapshot.v59b1e3b
@clerk/clerk-sdk-node5.0.1-snapshot.v59b1e3b
@clerk/shared2.0.1-snapshot.v59b1e3b
@clerk/themes2.0.1-snapshot.v59b1e3b
@clerk/types4.0.1-snapshot.v59b1e3b

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/elements

npm i @clerk/elements@0.0.2-snapshot.v59b1e3b --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.v59b1e3b --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.v59b1e3b --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.v59b1e3b --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.v59b1e3b --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.v59b1e3b --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.v59b1e3b --save-exact

Comment threadpackages/elements/package.json Outdated
"files": [
"dist"
"dist",
"!dist/metafile-*.json",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Generated for bundle analysis and unable to configure where they're generated. This ensures we don't include them in the resulting package.

}

const Comp = asChild ? Slot : 'button';
const defaultProps = asChild ? {} : { type: 'button' as const };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

When encapsulated in form elements, buttons without a type default to submit causing issues when hitting enter.

@LekoArts
LekoArts enabled auto-merge January 30, 2024 10:52
@LekoArts
LekoArts added this pull request to the merge queue Jan 30, 2024
Merged via the queue into main with commit 25a8ff7Jan 30, 2024
@LekoArts
LekoArts deleted the tm.elements/react-components branch January 30, 2024 11:02
@LekoArtsLekoArts added this to the @clerk/elements (Alpha) milestone Feb 1, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@tmilewski@clerk-cookie@LekoArts