feat(clerk-js): Use `org:sys_domains:read` for improved fine grain control of the UI #1896

panteliselef · 2023-10-16T21:24:00Z

Description

This PR makes usage of org:sys_domains:read a permission that allows users to see a list of domains. Previously we were wrapping the whole functionality under the manage permission.

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

Packages affected

changeset-bot · 2023-10-16T21:24:04Z

🦋 Changeset detected

Latest commit: 9a375d9

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

This PR includes changesets to release 12 packages

Name	Type
@clerk/clerk-js	Patch
@clerk/types	Patch
@clerk/chrome-extension	Patch
@clerk/clerk-expo	Patch
@clerk/backend	Patch
@clerk/fastify	Patch
gatsby-plugin-clerk	Patch
@clerk/localizations	Patch
@clerk/nextjs	Patch
@clerk/clerk-react	Patch
@clerk/remix	Patch
@clerk/clerk-sdk-node	Patch

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

packages/clerk-js/src/ui/components/OrganizationProfile/DomainList.tsx

SokratisVidros · 2023-10-17T20:22:11Z

packages/clerk-js/src/ui/components/OrganizationProfile/DomainList.tsx

-                      },
-                    ]}
-                  />
+                  showDotMenu ? (


🙃 showDotMeny && <JSX/>

Already tried that, seems like trailingComponent does not accept null, I didn't want to mess with the signature of the component.

Why don't we update its types?

The following has type of false | EmotionJSX.Element | null

showDotMenu && ( <DomainListDotMenu redirectSubPath={redirectSubPath} domainId={d.id} /> )

So i would have to do

(showDotMenu || null ) && ( <DomainListDotMenu redirectSubPath={redirectSubPath} domainId={d.id} /> )

Which i'm not convinced it is better

I am not sure I understand what you are talking about. Is this the type?

This is the TS error

SokratisVidros · 2023-10-17T20:23:51Z

packages/clerk-js/src/ui/hooks/useFetch.ts

@@ -35,7 +35,7 @@ export const useFetch = <T>(
        requestStatus.setError();
        setData(null);
      });
-  }, []);
+  }, [JSON.stringify(params)]);


❓ Can you elaborate on this change? Is it necessary to be part of this PR?

Previously useFetch would only fire once, "on mount", there was a bug where the Gate component would not hide the content while not having the necessary permission because the "fetch" wouldn't fire when the parameters changed.

For context we are using useFetch to handle the async logic of isAuthorized.

Do we need to make a FAPI call every time the isAuthorized is invoked?

This would only invoke a call if params change, not on every render.

packages/clerk-js/src/ui/utils/test/mockHelpers.ts

desiprisg · 2023-10-18T09:58:23Z

packages/clerk-js/src/utils/url.ts

+ * @returns {string} Returns the string without leading slashes
+ * @param path
+ */
+export const trimLeadingSlash = (path: string): string => {


Can we add a couple of tests for this util?

Yeap, thanks for the reminder

packages/clerk-js/src/core/resources/Session.ts

packages/clerk-js/src/ui/components/OrganizationProfile/DomainList.tsx

SokratisVidros · 2023-10-25T13:22:30Z

packages/clerk-js/src/ui/components/OrganizationProfile/DomainList.tsx

-                      },
-                    ]}
-                  />
+                  showDotMenu ? (


Why don't we update its types?

SokratisVidros · 2023-10-25T13:25:26Z

packages/clerk-js/src/ui/hooks/useFetch.ts

@@ -35,7 +35,7 @@ export const useFetch = <T>(
        requestStatus.setError();
        setData(null);
      });
-  }, []);
+  }, [JSON.stringify(params)]);


Do we need to make a FAPI call every time the isAuthorized is invoked?

packages/clerk-js/src/ui/utils/test/mockHelpers.ts

SokratisVidros · 2023-10-31T15:56:43Z

packages/clerk-js/src/ui/components/OrganizationProfile/DomainList.tsx

-                      },
-                    ]}
-                  />
+                  showDotMenu ? (


I am not sure I understand what you are talking about. Is this the type?

…ntrol of the UI Backport of #1896

…ntrol of the UI (#1988) Backport of #1896

panteliselef self-assigned this Oct 16, 2023

panteliselef requested a review from a team as a code owner October 16, 2023 21:24

clerk-cookie added types clerk-js labels Oct 16, 2023

panteliselef changed the title ~~Org 286~~ [WIP] Org 286 Oct 17, 2023

panteliselef requested a review from chanioxaris October 17, 2023 07:24

panteliselef changed the title ~~[WIP] Org 286~~ feat(clerk-js): Use org:sys_domains:read for improved fine grain control of the UI Oct 17, 2023

panteliselef force-pushed the ORG-286 branch from bd31c9e to 3ba4493 Compare October 17, 2023 08:07

panteliselef requested a review from anagstef October 17, 2023 16:11

SokratisVidros suggested changes Oct 17, 2023

View reviewed changes

panteliselef requested a review from SokratisVidros October 18, 2023 08:26

desiprisg reviewed Oct 18, 2023

View reviewed changes

desiprisg approved these changes Oct 18, 2023

View reviewed changes

panteliselef force-pushed the ORG-286 branch 2 times, most recently from a591162 to d19c8a0 Compare October 18, 2023 13:21

SokratisVidros suggested changes Oct 25, 2023

View reviewed changes

desiprisg and others added 9 commits October 25, 2023 14:14

fix(clerk-js): Correct initial ref value for form feedback (#1933)

74a2cbe

chore(clerk-js): Use org:sys_domains:read

28ec80d

test(clerk-js): Use org:sys_domains:read

c5622fb

chore(clerk-js): Add changeset

8fb7cd2

chore(clerk-js): UseDomainList

b4eb751

feat(clerk-js): Session.isAuthorized now support the any parameter

c3092fd

chore(clerk-js): Improve relative url creation in DomainList

d8acfa8

test(clerk-js): Test cases for trimLeadingSlash

01f9db6

chore(clerk-js): Address Pr comments

9a375d9

panteliselef force-pushed the ORG-286 branch from d19c8a0 to 9a375d9 Compare October 25, 2023 18:30

panteliselef requested a review from SokratisVidros October 25, 2023 18:41

panteliselef changed the base branch from main to main-v4 October 25, 2023 18:53

SokratisVidros approved these changes Oct 31, 2023

View reviewed changes

panteliselef added this pull request to the merge queue Oct 31, 2023

Merged via the queue into main-v4 with commit f6f67f9 Oct 31, 2023

panteliselef deleted the ORG-286 branch October 31, 2023 17:05

clerk-cookie mentioned this pull request Oct 31, 2023

Version Packages - V4 #1973

Closed

panteliselef added a commit that referenced this pull request Oct 31, 2023

feat(clerk-js): Use org:sys_domains:read for improved fine grain co…

34b6343

…ntrol of the UI Backport of #1896

panteliselef mentioned this pull request Oct 31, 2023

feat(clerk-js): Use org:sys_domains:read for improved fine grain control of the UI #1988

Merged

24 tasks

github-merge-queue bot pushed a commit that referenced this pull request Oct 31, 2023

feat(clerk-js): Use org:sys_domains:read for improved fine grain co…

d37d44a

…ntrol of the UI (#1988) Backport of #1896

clerk-cookie mentioned this pull request Oct 31, 2023

Version Packages - V4 #1989

Merged

LekoArts mentioned this pull request Mar 13, 2024

fix(themes): Add tslib and @clerk/types as dependencies to @clerk/themes (#2665) #2987

Merged

LekoArts mentioned this pull request Aug 2, 2024

chore(repo): Correct changeset #3883

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(clerk-js): Use `org:sys_domains:read` for improved fine grain control of the UI #1896

feat(clerk-js): Use `org:sys_domains:read` for improved fine grain control of the UI #1896

panteliselef commented Oct 16, 2023 •

edited

Loading

changeset-bot bot commented Oct 16, 2023 •

edited

Loading

SokratisVidros Oct 17, 2023

panteliselef Oct 18, 2023

SokratisVidros Oct 25, 2023

panteliselef Oct 25, 2023

SokratisVidros Oct 31, 2023

panteliselef Oct 31, 2023

SokratisVidros Oct 17, 2023

panteliselef Oct 18, 2023

SokratisVidros Oct 25, 2023

panteliselef Oct 25, 2023

desiprisg Oct 18, 2023

panteliselef Oct 18, 2023

SokratisVidros Oct 25, 2023

SokratisVidros Oct 25, 2023

SokratisVidros Oct 31, 2023

feat(clerk-js): Use org:sys_domains:read for improved fine grain control of the UI #1896

feat(clerk-js): Use org:sys_domains:read for improved fine grain control of the UI #1896

Conversation

panteliselef commented Oct 16, 2023 • edited Loading

Description

Checklist

Type of change

Packages affected

changeset-bot bot commented Oct 16, 2023 • edited Loading

🦋 Changeset detected

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

feat(clerk-js): Use `org:sys_domains:read` for improved fine grain control of the UI #1896

feat(clerk-js): Use `org:sys_domains:read` for improved fine grain control of the UI #1896

panteliselef commented Oct 16, 2023 •

edited

Loading

changeset-bot bot commented Oct 16, 2023 •

edited

Loading