feat(clerk-js,types): Add __experimental_startPath to openOrganizationProfile (#5926)

Author: alexcarpenter

.changeset/cute-hoops-find.md

@@ -0,0 +1,14 @@
+---
+'@clerk/clerk-js': minor
+'@clerk/types': minor
+---
+
+Introduce `__experimental_startPath` option for `openOrganizationProfile`.
+
+Example usage:
+
+```ts
+clerk.openOrganizationProfile({
+  __experimental_startPath: '/billing',
+});
+```

packages/clerk-js/src/ui/Components.tsx

@@ -482,7 +482,7 @@ const Components = (props: ComponentsProps) => {
       onExternalNavigate={() => componentsControls.closeModal('organizationProfile')}
       startPath={buildVirtualRouterUrl({
         base: '/organizationProfile',
-        path: urlStateParam?.path,
+        path: organizationProfileModal?.__experimental_startPath || urlStateParam?.path,
       })}
       componentName={'OrganizationProfileModal'}
       modalContainerSx={{ alignItems: 'center' }}

packages/types/src/clerk.ts

@@ -1310,6 +1310,11 @@ export type OrganizationProfileProps = RoutingOptions & {
    * Provide custom pages and links to be rendered inside the OrganizationProfile.
    */
   customPages?: CustomPage[];
+  /**
+   * Specify on which page the organization profile modal will open.
+   * @experimental
+   **/
+  __experimental_startPath?: string;
 };
 
 export type OrganizationProfileModalProps = WithoutRouting<OrganizationProfileProps>;