Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/three-impalas-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Surface organization creation defaults with prefilled form fields and advisory warnings
4 changes: 2 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "924KB" },
{ "path": "./dist/clerk.js", "maxSize": "928KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "87KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "129KB" },
{ "path": "./dist/clerk.headless*.js", "maxSize": "66KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "126KB" },
{ "path": "./dist/vendors*.js", "maxSize": "50KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "38KB" },
{ "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type {
OrganizationCreationAdvisorySeverity,
OrganizationCreationAdvisoryType,
OrganizationCreationDefaultsJSON,
OrganizationCreationDefaultsJSONSnapshot,
OrganizationCreationDefaultsResource,
} from '@clerk/shared/types';

import { BaseResource } from './internal';

export class OrganizationCreationDefaults extends BaseResource implements OrganizationCreationDefaultsResource {
advisory: {
code: OrganizationCreationAdvisoryType;
severity: OrganizationCreationAdvisorySeverity;
meta: Record<string, string>;
} | null = null;
form: {
name: string;
slug: string;
logo: string | null;
blurHash: string | null;
} = {
name: '',
slug: '',
logo: null,
blurHash: null,
};

public constructor(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null = null) {
super();
this.fromJSON(data);
}

protected fromJSON(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null): this {
if (!data) {
return this;
}

if (data.advisory) {
this.advisory = this.withDefault(data.advisory, this.advisory ?? null);
}

if (data.form) {
this.form.name = this.withDefault(data.form.name, this.form.name);
this.form.slug = this.withDefault(data.form.slug, this.form.slug);
this.form.logo = this.withDefault(data.form.logo, this.form.logo);
this.form.blurHash = this.withDefault(data.form.blur_hash, this.form.blurHash);
}

return this;
}

static async retrieve(): Promise<OrganizationCreationDefaultsResource> {
return await BaseResource._fetch({
path: '/me/organization_creation_defaults',
method: 'GET',
}).then(res => {
const data = res?.response as unknown as OrganizationCreationDefaultsJSON;
return new OrganizationCreationDefaults(data);
});
}

public __internal_toSnapshot(): OrganizationCreationDefaultsJSONSnapshot {
return {
advisory: this.advisory
? {
code: this.advisory.code,
meta: this.advisory.meta,
severity: this.advisory.severity,
}
: null,
form: {
name: this.form.name,
slug: this.form.slug,
logo: this.form.logo,
blur_hash: this.form.blurHash,
},
} as unknown as OrganizationCreationDefaultsJSONSnapshot;
}
}
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationSettings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,11 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
} = {
disabled: false,
};
organizationCreationDefaults: {
enabled: boolean;
} = {
enabled: false,
};
enabled: boolean = false;
maxAllowedMemberships: number = 1;
forceOrganizationSelection!: boolean;
Expand DownExpand Up@@ -51,6 +56,13 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
this.slug.disabled = this.withDefault(data.slug.disabled, this.slug.disabled);
}

if (data.organization_creation_defaults) {
this.organizationCreationDefaults.enabled = this.withDefault(
data.organization_creation_defaults.enabled,
this.organizationCreationDefaults.enabled,
);
}

this.enabled = this.withDefault(data.enabled, this.enabled);
this.maxAllowedMemberships = this.withDefault(data.max_allowed_memberships, this.maxAllowedMemberships);
this.forceOrganizationSelection = this.withDefault(
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/core/resources/User.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ import {
UserOrganizationInvitation,
Web3Wallet,
} from './internal';
import { OrganizationCreationDefaults } from './OrganizationCreationDefaults';

export class User extends BaseResource implements UserResource {
pathRoot = '/me';
Expand DownExpand Up@@ -280,6 +281,8 @@ export class User extends BaseResource implements UserResource {
getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
OrganizationMembership.retrieve(retrieveMembership);

getOrganizationCreationDefaults = () => OrganizationCreationDefaults.retrieve();

leaveOrganization = async (organizationId: string): Promise<DeletedObjectResource> => {
const json = (
await BaseResource._fetch<DeletedObjectJSON>({
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/test/fixture-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -346,6 +346,9 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
const withOrganizationSlug = (enabled = false) => {
os.slug.disabled = !enabled;
};
const withOrganizationCreationDefaults = (enabled = false) => {
os.organization_creation_defaults.enabled = enabled;
};

const withOrganizationDomains = (modes?: OrganizationEnrollmentMode[], defaultRole?: string) => {
os.domains.enabled = true;
Expand All@@ -358,6 +361,7 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
withOrganizationDomains,
withForceOrganizationSelection,
withOrganizationSlug,
withOrganizationCreationDefaults,
};
};

Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/test/fixtures.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,9 @@ const createBaseOrganizationSettings = (): OrganizationSettingsJSON => {
slug: {
disabled: true,
},
organization_creation_defaults: {
enabled: false,
},
} as unknown as OrganizationSettingsJSON;
};

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,13 @@ import { Col, descriptors, Text } from '../../customizables';
import { localizationKeys } from '../../localization';

export const OrganizationProfileAvatarUploader = (
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & { organization: Partial<OrganizationResource> },
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & {
organization: Partial<OrganizationResource>;
/** Shows a loading spinner while the image is loading */
showLoadingSpinner?: boolean;
},
) => {
const { organization, ...rest } = props;
const { organization, showLoadingSpinner, ...rest } = props;

return (
<Col elementDescriptor={descriptors.organizationAvatarUploaderContainer}>
Expand All@@ -28,6 +32,7 @@ export const OrganizationProfileAvatarUploader = (
avatarPreview={
<OrganizationAvatar
size={theme => theme.sizes.$16}
showLoadingSpinner={showLoadingSpinner}
{...organization}
/>
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
import { useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams } from '@clerk/shared/types';
import type { CreateOrganizationParams, OrganizationCreationDefaultsResource } from '@clerk/shared/types';
import { useState } from 'react';

import { OrganizationProfileAvatarUploader } from '@/ui/components/OrganizationProfile/OrganizationProfileAvatarUploader';
import { useEnvironment } from '@/ui/contexts';
import { useSessionTasksContext, useTaskChooseOrganizationContext } from '@/ui/contexts/components/SessionTasks';
import { localizationKeys } from '@/ui/customizables';
import { Icon, localizationKeys } from '@/ui/customizables';
import { useCardState } from '@/ui/elements/contexts';
import { Form } from '@/ui/elements/Form';
import { FormButtonContainer } from '@/ui/elements/FormButtons';
import { FormContainer } from '@/ui/elements/FormContainer';
import { Header } from '@/ui/elements/Header';
import { IconButton } from '@/ui/elements/IconButton';
import { Upload } from '@/ui/icons';
import { createSlug } from '@/ui/utils/createSlug';
import { handleError } from '@/ui/utils/errorHandler';
import { useFormControl } from '@/ui/utils/useFormControl';

import { organizationListParams } from '../../../OrganizationSwitcher/utils';
import { OrganizationCreationDefaultsAlert } from './OrganizationCreationDefaultsAlert';

type CreateOrganizationScreenProps = {
onCancel?: () => void;
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
};

export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) => {
Expand All@@ -27,13 +33,14 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
userMemberships: organizationListParams.userMemberships,
});
const { organizationSettings } = useEnvironment();
const [file, setFile] = useState<File | null>();

const nameField = useFormControl('name', '', {
const nameField = useFormControl('name', props.organizationCreationDefaults?.form?.name ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__name'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__name'),
});
const slugField = useFormControl('slug', '', {
const slugField = useFormControl('slug', props.organizationCreationDefaults?.form?.slug ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__slug'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__slug'),
Expand All@@ -57,6 +64,15 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =

const organization = await createOrganization(createOrgParams);

if (file) {
await organization.setLogo({ file });
} else if (defaultLogoUrl) {
const response = await fetch(defaultLogoUrl);
const blob = await response.blob();
const logoFile = new File([blob], 'logo', { type: blob.type });
await organization.setLogo({ file: logoFile });
}

await setActive({
organization,
navigate: async ({ session }) => {
Expand All@@ -77,7 +93,13 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
slugField.setValue(val);
};

const onAvatarRemove = () => {
card.setIdle();
return setFile(null);
};

const isSubmitButtonDisabled = !nameField.value || !isLoaded;
const defaultLogoUrl = file === undefined ? props.organizationCreationDefaults?.form?.logo : undefined;

return (
<>
Expand All@@ -90,6 +112,44 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
</Header.Root>
<FormContainer sx={t => ({ padding: `${t.space.$none} ${t.space.$10} ${t.space.$8}` })}>
<Form.Root onSubmit={onSubmit}>
<OrganizationCreationDefaultsAlert organizationCreationDefaults={props.organizationCreationDefaults} />
<OrganizationProfileAvatarUploader
organization={{ name: nameField.value, imageUrl: defaultLogoUrl ?? undefined }}
onAvatarChange={async file => await setFile(file)}
onAvatarRemove={file || defaultLogoUrl ? onAvatarRemove : null}
showLoadingSpinner={!!defaultLogoUrl}
avatarPreviewPlaceholder={
<IconButton
variant='ghost'
aria-label='Upload organization logo'
icon={
<Icon
size='md'
icon={Upload}
sx={t => ({
color: t.colors.$colorMutedForeground,
transitionDuration: t.transitionDuration.$controls,
})}
/>
}
sx={t => ({
width: t.sizes.$16,
height: t.sizes.$16,
borderRadius: t.radii.$md,
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$dashed,
borderColor: t.colors.$borderAlpha200,
backgroundColor: t.colors.$neutralAlpha50,
':hover': {
backgroundColor: t.colors.$neutralAlpha50,
svg: {
transform: 'scale(1.2)',
},
},
})}
/>
}
/>
<Form.ControlRow elementId={nameField.id}>
<Form.PlainInput
{...nameField.props}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import type { OrganizationCreationDefaultsResource } from '@clerk/shared/types';

import { localizationKeys, Text } from '@/ui/customizables';
import { Alert } from '@/ui/primitives';

export function OrganizationCreationDefaultsAlert({
organizationCreationDefaults,
}: {
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
}) {
const localizationKey = advisoryToLocalizationKey(organizationCreationDefaults?.advisory);
if (!localizationKey) {
return null;
}

return (
<Alert colorScheme='warning'>
<Text
colorScheme='warning'
localizationKey={localizationKey}
variant='caption'
/>
</Alert>
);
}

const advisoryToLocalizationKey = (advisory?: OrganizationCreationDefaultsResource['advisory']) => {
if (!advisory) {
return null;
}

switch (advisory.code) {
case 'organization_already_exists':
return localizationKeys('taskChooseOrganization.alerts.organizationAlreadyExists', {
organizationDomain: advisory.meta.organization_domain,
organizationName: advisory.meta.organization_name,
});
default:
return null;
}
};
Loading
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/three-impalas-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Surface organization creation defaults with prefilled form fields and advisory warnings
4 changes: 2 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "924KB" },
{ "path": "./dist/clerk.js", "maxSize": "928KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "87KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "129KB" },
{ "path": "./dist/clerk.headless*.js", "maxSize": "66KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "126KB" },
{ "path": "./dist/vendors*.js", "maxSize": "50KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "38KB" },
{ "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type {
OrganizationCreationAdvisorySeverity,
OrganizationCreationAdvisoryType,
OrganizationCreationDefaultsJSON,
OrganizationCreationDefaultsJSONSnapshot,
OrganizationCreationDefaultsResource,
} from '@clerk/shared/types';

import { BaseResource } from './internal';

export class OrganizationCreationDefaults extends BaseResource implements OrganizationCreationDefaultsResource {
advisory: {
code: OrganizationCreationAdvisoryType;
severity: OrganizationCreationAdvisorySeverity;
meta: Record<string, string>;
} | null = null;
form: {
name: string;
slug: string;
logo: string | null;
blurHash: string | null;
} = {
name: '',
slug: '',
logo: null,
blurHash: null,
};

public constructor(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null = null) {
super();
this.fromJSON(data);
}

protected fromJSON(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null): this {
if (!data) {
return this;
}

if (data.advisory) {
this.advisory = this.withDefault(data.advisory, this.advisory ?? null);
}

if (data.form) {
this.form.name = this.withDefault(data.form.name, this.form.name);
this.form.slug = this.withDefault(data.form.slug, this.form.slug);
this.form.logo = this.withDefault(data.form.logo, this.form.logo);
this.form.blurHash = this.withDefault(data.form.blur_hash, this.form.blurHash);
}

return this;
}

static async retrieve(): Promise<OrganizationCreationDefaultsResource> {
return await BaseResource._fetch({
path: '/me/organization_creation_defaults',
method: 'GET',
}).then(res => {
const data = res?.response as unknown as OrganizationCreationDefaultsJSON;
return new OrganizationCreationDefaults(data);
});
}

public __internal_toSnapshot(): OrganizationCreationDefaultsJSONSnapshot {
return {
advisory: this.advisory
? {
code: this.advisory.code,
meta: this.advisory.meta,
severity: this.advisory.severity,
}
: null,
form: {
name: this.form.name,
slug: this.form.slug,
logo: this.form.logo,
blur_hash: this.form.blurHash,
},
} as unknown as OrganizationCreationDefaultsJSONSnapshot;
}
}
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationSettings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,11 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
} = {
disabled: false,
};
organizationCreationDefaults: {
enabled: boolean;
} = {
enabled: false,
};
enabled: boolean = false;
maxAllowedMemberships: number = 1;
forceOrganizationSelection!: boolean;
Expand DownExpand Up@@ -51,6 +56,13 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
this.slug.disabled = this.withDefault(data.slug.disabled, this.slug.disabled);
}

if (data.organization_creation_defaults) {
this.organizationCreationDefaults.enabled = this.withDefault(
data.organization_creation_defaults.enabled,
this.organizationCreationDefaults.enabled,
);
}

this.enabled = this.withDefault(data.enabled, this.enabled);
this.maxAllowedMemberships = this.withDefault(data.max_allowed_memberships, this.maxAllowedMemberships);
this.forceOrganizationSelection = this.withDefault(
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/core/resources/User.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ import {
UserOrganizationInvitation,
Web3Wallet,
} from './internal';
import { OrganizationCreationDefaults } from './OrganizationCreationDefaults';

export class User extends BaseResource implements UserResource {
pathRoot = '/me';
Expand DownExpand Up@@ -280,6 +281,8 @@ export class User extends BaseResource implements UserResource {
getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
OrganizationMembership.retrieve(retrieveMembership);

getOrganizationCreationDefaults = () => OrganizationCreationDefaults.retrieve();

leaveOrganization = async (organizationId: string): Promise<DeletedObjectResource> => {
const json = (
await BaseResource._fetch<DeletedObjectJSON>({
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/test/fixture-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -346,6 +346,9 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
const withOrganizationSlug = (enabled = false) => {
os.slug.disabled = !enabled;
};
const withOrganizationCreationDefaults = (enabled = false) => {
os.organization_creation_defaults.enabled = enabled;
};

const withOrganizationDomains = (modes?: OrganizationEnrollmentMode[], defaultRole?: string) => {
os.domains.enabled = true;
Expand All@@ -358,6 +361,7 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
withOrganizationDomains,
withForceOrganizationSelection,
withOrganizationSlug,
withOrganizationCreationDefaults,
};
};

Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/test/fixtures.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,9 @@ const createBaseOrganizationSettings = (): OrganizationSettingsJSON => {
slug: {
disabled: true,
},
organization_creation_defaults: {
enabled: false,
},
} as unknown as OrganizationSettingsJSON;
};

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,13 @@ import { Col, descriptors, Text } from '../../customizables';
import { localizationKeys } from '../../localization';

export const OrganizationProfileAvatarUploader = (
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & { organization: Partial<OrganizationResource> },
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & {
organization: Partial<OrganizationResource>;
/** Shows a loading spinner while the image is loading */
showLoadingSpinner?: boolean;
},
) => {
const { organization, ...rest } = props;
const { organization, showLoadingSpinner, ...rest } = props;

return (
<Col elementDescriptor={descriptors.organizationAvatarUploaderContainer}>
Expand All@@ -28,6 +32,7 @@ export const OrganizationProfileAvatarUploader = (
avatarPreview={
<OrganizationAvatar
size={theme => theme.sizes.$16}
showLoadingSpinner={showLoadingSpinner}
{...organization}
/>
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
import { useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams } from '@clerk/shared/types';
import type { CreateOrganizationParams, OrganizationCreationDefaultsResource } from '@clerk/shared/types';
import { useState } from 'react';

import { OrganizationProfileAvatarUploader } from '@/ui/components/OrganizationProfile/OrganizationProfileAvatarUploader';
import { useEnvironment } from '@/ui/contexts';
import { useSessionTasksContext, useTaskChooseOrganizationContext } from '@/ui/contexts/components/SessionTasks';
import { localizationKeys } from '@/ui/customizables';
import { Icon, localizationKeys } from '@/ui/customizables';
import { useCardState } from '@/ui/elements/contexts';
import { Form } from '@/ui/elements/Form';
import { FormButtonContainer } from '@/ui/elements/FormButtons';
import { FormContainer } from '@/ui/elements/FormContainer';
import { Header } from '@/ui/elements/Header';
import { IconButton } from '@/ui/elements/IconButton';
import { Upload } from '@/ui/icons';
import { createSlug } from '@/ui/utils/createSlug';
import { handleError } from '@/ui/utils/errorHandler';
import { useFormControl } from '@/ui/utils/useFormControl';

import { organizationListParams } from '../../../OrganizationSwitcher/utils';
import { OrganizationCreationDefaultsAlert } from './OrganizationCreationDefaultsAlert';

type CreateOrganizationScreenProps = {
onCancel?: () => void;
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
};

export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) => {
Expand All@@ -27,13 +33,14 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
userMemberships: organizationListParams.userMemberships,
});
const { organizationSettings } = useEnvironment();
const [file, setFile] = useState<File | null>();

const nameField = useFormControl('name', '', {
const nameField = useFormControl('name', props.organizationCreationDefaults?.form?.name ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__name'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__name'),
});
const slugField = useFormControl('slug', '', {
const slugField = useFormControl('slug', props.organizationCreationDefaults?.form?.slug ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__slug'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__slug'),
Expand All@@ -57,6 +64,15 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =

const organization = await createOrganization(createOrgParams);

if (file) {
await organization.setLogo({ file });
} else if (defaultLogoUrl) {
const response = await fetch(defaultLogoUrl);
const blob = await response.blob();
const logoFile = new File([blob], 'logo', { type: blob.type });
await organization.setLogo({ file: logoFile });
}

await setActive({
organization,
navigate: async ({ session }) => {
Expand All@@ -77,7 +93,13 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
slugField.setValue(val);
};

const onAvatarRemove = () => {
card.setIdle();
return setFile(null);
};

const isSubmitButtonDisabled = !nameField.value || !isLoaded;
const defaultLogoUrl = file === undefined ? props.organizationCreationDefaults?.form?.logo : undefined;

return (
<>
Expand All@@ -90,6 +112,44 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
</Header.Root>
<FormContainer sx={t => ({ padding: `${t.space.$none} ${t.space.$10} ${t.space.$8}` })}>
<Form.Root onSubmit={onSubmit}>
<OrganizationCreationDefaultsAlert organizationCreationDefaults={props.organizationCreationDefaults} />
<OrganizationProfileAvatarUploader
organization={{ name: nameField.value, imageUrl: defaultLogoUrl ?? undefined }}
onAvatarChange={async file => await setFile(file)}
onAvatarRemove={file || defaultLogoUrl ? onAvatarRemove : null}
showLoadingSpinner={!!defaultLogoUrl}
avatarPreviewPlaceholder={
<IconButton
variant='ghost'
aria-label='Upload organization logo'
icon={
<Icon
size='md'
icon={Upload}
sx={t => ({
color: t.colors.$colorMutedForeground,
transitionDuration: t.transitionDuration.$controls,
})}
/>
}
sx={t => ({
width: t.sizes.$16,
height: t.sizes.$16,
borderRadius: t.radii.$md,
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$dashed,
borderColor: t.colors.$borderAlpha200,
backgroundColor: t.colors.$neutralAlpha50,
':hover': {
backgroundColor: t.colors.$neutralAlpha50,
svg: {
transform: 'scale(1.2)',
},
},
})}
/>
}
/>
<Form.ControlRow elementId={nameField.id}>
<Form.PlainInput
{...nameField.props}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import type { OrganizationCreationDefaultsResource } from '@clerk/shared/types';

import { localizationKeys, Text } from '@/ui/customizables';
import { Alert } from '@/ui/primitives';

export function OrganizationCreationDefaultsAlert({
organizationCreationDefaults,
}: {
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
}) {
const localizationKey = advisoryToLocalizationKey(organizationCreationDefaults?.advisory);
if (!localizationKey) {
return null;
}

return (
<Alert colorScheme='warning'>
<Text
colorScheme='warning'
localizationKey={localizationKey}
variant='caption'
/>
</Alert>
);
}

const advisoryToLocalizationKey = (advisory?: OrganizationCreationDefaultsResource['advisory']) => {
if (!advisory) {
return null;
}

switch (advisory.code) {
case 'organization_already_exists':
return localizationKeys('taskChooseOrganization.alerts.organizationAlreadyExists', {
organizationDomain: advisory.meta.organization_domain,
organizationName: advisory.meta.organization_name,
});
default:
return null;
}
};
Loading
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/three-impalas-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Surface organization creation defaults with prefilled form fields and advisory warnings
4 changes: 2 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "924KB" },
{ "path": "./dist/clerk.js", "maxSize": "928KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "87KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "129KB" },
{ "path": "./dist/clerk.headless*.js", "maxSize": "66KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "126KB" },
{ "path": "./dist/vendors*.js", "maxSize": "50KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "38KB" },
{ "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type {
OrganizationCreationAdvisorySeverity,
OrganizationCreationAdvisoryType,
OrganizationCreationDefaultsJSON,
OrganizationCreationDefaultsJSONSnapshot,
OrganizationCreationDefaultsResource,
} from '@clerk/shared/types';

import { BaseResource } from './internal';

export class OrganizationCreationDefaults extends BaseResource implements OrganizationCreationDefaultsResource {
advisory: {
code: OrganizationCreationAdvisoryType;
severity: OrganizationCreationAdvisorySeverity;
meta: Record<string, string>;
} | null = null;
form: {
name: string;
slug: string;
logo: string | null;
blurHash: string | null;
} = {
name: '',
slug: '',
logo: null,
blurHash: null,
};

public constructor(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null = null) {
super();
this.fromJSON(data);
}

protected fromJSON(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null): this {
if (!data) {
return this;
}

if (data.advisory) {
this.advisory = this.withDefault(data.advisory, this.advisory ?? null);
}

if (data.form) {
this.form.name = this.withDefault(data.form.name, this.form.name);
this.form.slug = this.withDefault(data.form.slug, this.form.slug);
this.form.logo = this.withDefault(data.form.logo, this.form.logo);
this.form.blurHash = this.withDefault(data.form.blur_hash, this.form.blurHash);
}

return this;
}

static async retrieve(): Promise<OrganizationCreationDefaultsResource> {
return await BaseResource._fetch({
path: '/me/organization_creation_defaults',
method: 'GET',
}).then(res => {
const data = res?.response as unknown as OrganizationCreationDefaultsJSON;
return new OrganizationCreationDefaults(data);
});
}

public __internal_toSnapshot(): OrganizationCreationDefaultsJSONSnapshot {
return {
advisory: this.advisory
? {
code: this.advisory.code,
meta: this.advisory.meta,
severity: this.advisory.severity,
}
: null,
form: {
name: this.form.name,
slug: this.form.slug,
logo: this.form.logo,
blur_hash: this.form.blurHash,
},
} as unknown as OrganizationCreationDefaultsJSONSnapshot;
}
}
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationSettings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,11 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
} = {
disabled: false,
};
organizationCreationDefaults: {
enabled: boolean;
} = {
enabled: false,
};
enabled: boolean = false;
maxAllowedMemberships: number = 1;
forceOrganizationSelection!: boolean;
Expand DownExpand Up@@ -51,6 +56,13 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
this.slug.disabled = this.withDefault(data.slug.disabled, this.slug.disabled);
}

if (data.organization_creation_defaults) {
this.organizationCreationDefaults.enabled = this.withDefault(
data.organization_creation_defaults.enabled,
this.organizationCreationDefaults.enabled,
);
}

this.enabled = this.withDefault(data.enabled, this.enabled);
this.maxAllowedMemberships = this.withDefault(data.max_allowed_memberships, this.maxAllowedMemberships);
this.forceOrganizationSelection = this.withDefault(
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/core/resources/User.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ import {
UserOrganizationInvitation,
Web3Wallet,
} from './internal';
import { OrganizationCreationDefaults } from './OrganizationCreationDefaults';

export class User extends BaseResource implements UserResource {
pathRoot = '/me';
Expand DownExpand Up@@ -280,6 +281,8 @@ export class User extends BaseResource implements UserResource {
getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
OrganizationMembership.retrieve(retrieveMembership);

getOrganizationCreationDefaults = () => OrganizationCreationDefaults.retrieve();

leaveOrganization = async (organizationId: string): Promise<DeletedObjectResource> => {
const json = (
await BaseResource._fetch<DeletedObjectJSON>({
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/test/fixture-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -346,6 +346,9 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
const withOrganizationSlug = (enabled = false) => {
os.slug.disabled = !enabled;
};
const withOrganizationCreationDefaults = (enabled = false) => {
os.organization_creation_defaults.enabled = enabled;
};

const withOrganizationDomains = (modes?: OrganizationEnrollmentMode[], defaultRole?: string) => {
os.domains.enabled = true;
Expand All@@ -358,6 +361,7 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
withOrganizationDomains,
withForceOrganizationSelection,
withOrganizationSlug,
withOrganizationCreationDefaults,
};
};

Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/test/fixtures.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,9 @@ const createBaseOrganizationSettings = (): OrganizationSettingsJSON => {
slug: {
disabled: true,
},
organization_creation_defaults: {
enabled: false,
},
} as unknown as OrganizationSettingsJSON;
};

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,13 @@ import { Col, descriptors, Text } from '../../customizables';
import { localizationKeys } from '../../localization';

export const OrganizationProfileAvatarUploader = (
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & { organization: Partial<OrganizationResource> },
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & {
organization: Partial<OrganizationResource>;
/** Shows a loading spinner while the image is loading */
showLoadingSpinner?: boolean;
},
) => {
const { organization, ...rest } = props;
const { organization, showLoadingSpinner, ...rest } = props;

return (
<Col elementDescriptor={descriptors.organizationAvatarUploaderContainer}>
Expand All@@ -28,6 +32,7 @@ export const OrganizationProfileAvatarUploader = (
avatarPreview={
<OrganizationAvatar
size={theme => theme.sizes.$16}
showLoadingSpinner={showLoadingSpinner}
{...organization}
/>
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
import { useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams } from '@clerk/shared/types';
import type { CreateOrganizationParams, OrganizationCreationDefaultsResource } from '@clerk/shared/types';
import { useState } from 'react';

import { OrganizationProfileAvatarUploader } from '@/ui/components/OrganizationProfile/OrganizationProfileAvatarUploader';
import { useEnvironment } from '@/ui/contexts';
import { useSessionTasksContext, useTaskChooseOrganizationContext } from '@/ui/contexts/components/SessionTasks';
import { localizationKeys } from '@/ui/customizables';
import { Icon, localizationKeys } from '@/ui/customizables';
import { useCardState } from '@/ui/elements/contexts';
import { Form } from '@/ui/elements/Form';
import { FormButtonContainer } from '@/ui/elements/FormButtons';
import { FormContainer } from '@/ui/elements/FormContainer';
import { Header } from '@/ui/elements/Header';
import { IconButton } from '@/ui/elements/IconButton';
import { Upload } from '@/ui/icons';
import { createSlug } from '@/ui/utils/createSlug';
import { handleError } from '@/ui/utils/errorHandler';
import { useFormControl } from '@/ui/utils/useFormControl';

import { organizationListParams } from '../../../OrganizationSwitcher/utils';
import { OrganizationCreationDefaultsAlert } from './OrganizationCreationDefaultsAlert';

type CreateOrganizationScreenProps = {
onCancel?: () => void;
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
};

export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) => {
Expand All@@ -27,13 +33,14 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
userMemberships: organizationListParams.userMemberships,
});
const { organizationSettings } = useEnvironment();
const [file, setFile] = useState<File | null>();

const nameField = useFormControl('name', '', {
const nameField = useFormControl('name', props.organizationCreationDefaults?.form?.name ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__name'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__name'),
});
const slugField = useFormControl('slug', '', {
const slugField = useFormControl('slug', props.organizationCreationDefaults?.form?.slug ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__slug'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__slug'),
Expand All@@ -57,6 +64,15 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =

const organization = await createOrganization(createOrgParams);

if (file) {
await organization.setLogo({ file });
} else if (defaultLogoUrl) {
const response = await fetch(defaultLogoUrl);
const blob = await response.blob();
const logoFile = new File([blob], 'logo', { type: blob.type });
await organization.setLogo({ file: logoFile });
}

await setActive({
organization,
navigate: async ({ session }) => {
Expand All@@ -77,7 +93,13 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
slugField.setValue(val);
};

const onAvatarRemove = () => {
card.setIdle();
return setFile(null);
};

const isSubmitButtonDisabled = !nameField.value || !isLoaded;
const defaultLogoUrl = file === undefined ? props.organizationCreationDefaults?.form?.logo : undefined;

return (
<>
Expand All@@ -90,6 +112,44 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
</Header.Root>
<FormContainer sx={t => ({ padding: `${t.space.$none} ${t.space.$10} ${t.space.$8}` })}>
<Form.Root onSubmit={onSubmit}>
<OrganizationCreationDefaultsAlert organizationCreationDefaults={props.organizationCreationDefaults} />
<OrganizationProfileAvatarUploader
organization={{ name: nameField.value, imageUrl: defaultLogoUrl ?? undefined }}
onAvatarChange={async file => await setFile(file)}
onAvatarRemove={file || defaultLogoUrl ? onAvatarRemove : null}
showLoadingSpinner={!!defaultLogoUrl}
avatarPreviewPlaceholder={
<IconButton
variant='ghost'
aria-label='Upload organization logo'
icon={
<Icon
size='md'
icon={Upload}
sx={t => ({
color: t.colors.$colorMutedForeground,
transitionDuration: t.transitionDuration.$controls,
})}
/>
}
sx={t => ({
width: t.sizes.$16,
height: t.sizes.$16,
borderRadius: t.radii.$md,
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$dashed,
borderColor: t.colors.$borderAlpha200,
backgroundColor: t.colors.$neutralAlpha50,
':hover': {
backgroundColor: t.colors.$neutralAlpha50,
svg: {
transform: 'scale(1.2)',
},
},
})}
/>
}
/>
<Form.ControlRow elementId={nameField.id}>
<Form.PlainInput
{...nameField.props}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import type { OrganizationCreationDefaultsResource } from '@clerk/shared/types';

import { localizationKeys, Text } from '@/ui/customizables';
import { Alert } from '@/ui/primitives';

export function OrganizationCreationDefaultsAlert({
organizationCreationDefaults,
}: {
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
}) {
const localizationKey = advisoryToLocalizationKey(organizationCreationDefaults?.advisory);
if (!localizationKey) {
return null;
}

return (
<Alert colorScheme='warning'>
<Text
colorScheme='warning'
localizationKey={localizationKey}
variant='caption'
/>
</Alert>
);
}

const advisoryToLocalizationKey = (advisory?: OrganizationCreationDefaultsResource['advisory']) => {
if (!advisory) {
return null;
}

switch (advisory.code) {
case 'organization_already_exists':
return localizationKeys('taskChooseOrganization.alerts.organizationAlreadyExists', {
organizationDomain: advisory.meta.organization_domain,
organizationName: advisory.meta.organization_name,
});
default:
return null;
}
};
Loading
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/three-impalas-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Surface organization creation defaults with prefilled form fields and advisory warnings
4 changes: 2 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "924KB" },
{ "path": "./dist/clerk.js", "maxSize": "928KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "87KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "129KB" },
{ "path": "./dist/clerk.headless*.js", "maxSize": "66KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "126KB" },
{ "path": "./dist/vendors*.js", "maxSize": "50KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "38KB" },
{ "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type {
OrganizationCreationAdvisorySeverity,
OrganizationCreationAdvisoryType,
OrganizationCreationDefaultsJSON,
OrganizationCreationDefaultsJSONSnapshot,
OrganizationCreationDefaultsResource,
} from '@clerk/shared/types';

import { BaseResource } from './internal';

export class OrganizationCreationDefaults extends BaseResource implements OrganizationCreationDefaultsResource {
advisory: {
code: OrganizationCreationAdvisoryType;
severity: OrganizationCreationAdvisorySeverity;
meta: Record<string, string>;
} | null = null;
form: {
name: string;
slug: string;
logo: string | null;
blurHash: string | null;
} = {
name: '',
slug: '',
logo: null,
blurHash: null,
};

public constructor(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null = null) {
super();
this.fromJSON(data);
}

protected fromJSON(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null): this {
if (!data) {
return this;
}

if (data.advisory) {
this.advisory = this.withDefault(data.advisory, this.advisory ?? null);
}

if (data.form) {
this.form.name = this.withDefault(data.form.name, this.form.name);
this.form.slug = this.withDefault(data.form.slug, this.form.slug);
this.form.logo = this.withDefault(data.form.logo, this.form.logo);
this.form.blurHash = this.withDefault(data.form.blur_hash, this.form.blurHash);
}

return this;
}

static async retrieve(): Promise<OrganizationCreationDefaultsResource> {
return await BaseResource._fetch({
path: '/me/organization_creation_defaults',
method: 'GET',
}).then(res => {
const data = res?.response as unknown as OrganizationCreationDefaultsJSON;
return new OrganizationCreationDefaults(data);
});
}

public __internal_toSnapshot(): OrganizationCreationDefaultsJSONSnapshot {
return {
advisory: this.advisory
? {
code: this.advisory.code,
meta: this.advisory.meta,
severity: this.advisory.severity,
}
: null,
form: {
name: this.form.name,
slug: this.form.slug,
logo: this.form.logo,
blur_hash: this.form.blurHash,
},
} as unknown as OrganizationCreationDefaultsJSONSnapshot;
}
}
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationSettings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,11 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
} = {
disabled: false,
};
organizationCreationDefaults: {
enabled: boolean;
} = {
enabled: false,
};
enabled: boolean = false;
maxAllowedMemberships: number = 1;
forceOrganizationSelection!: boolean;
Expand DownExpand Up@@ -51,6 +56,13 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
this.slug.disabled = this.withDefault(data.slug.disabled, this.slug.disabled);
}

if (data.organization_creation_defaults) {
this.organizationCreationDefaults.enabled = this.withDefault(
data.organization_creation_defaults.enabled,
this.organizationCreationDefaults.enabled,
);
}

this.enabled = this.withDefault(data.enabled, this.enabled);
this.maxAllowedMemberships = this.withDefault(data.max_allowed_memberships, this.maxAllowedMemberships);
this.forceOrganizationSelection = this.withDefault(
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/core/resources/User.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ import {
UserOrganizationInvitation,
Web3Wallet,
} from './internal';
import { OrganizationCreationDefaults } from './OrganizationCreationDefaults';

export class User extends BaseResource implements UserResource {
pathRoot = '/me';
Expand DownExpand Up@@ -280,6 +281,8 @@ export class User extends BaseResource implements UserResource {
getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
OrganizationMembership.retrieve(retrieveMembership);

getOrganizationCreationDefaults = () => OrganizationCreationDefaults.retrieve();

leaveOrganization = async (organizationId: string): Promise<DeletedObjectResource> => {
const json = (
await BaseResource._fetch<DeletedObjectJSON>({
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/test/fixture-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -346,6 +346,9 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
const withOrganizationSlug = (enabled = false) => {
os.slug.disabled = !enabled;
};
const withOrganizationCreationDefaults = (enabled = false) => {
os.organization_creation_defaults.enabled = enabled;
};

const withOrganizationDomains = (modes?: OrganizationEnrollmentMode[], defaultRole?: string) => {
os.domains.enabled = true;
Expand All@@ -358,6 +361,7 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
withOrganizationDomains,
withForceOrganizationSelection,
withOrganizationSlug,
withOrganizationCreationDefaults,
};
};

Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/test/fixtures.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,9 @@ const createBaseOrganizationSettings = (): OrganizationSettingsJSON => {
slug: {
disabled: true,
},
organization_creation_defaults: {
enabled: false,
},
} as unknown as OrganizationSettingsJSON;
};

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,13 @@ import { Col, descriptors, Text } from '../../customizables';
import { localizationKeys } from '../../localization';

export const OrganizationProfileAvatarUploader = (
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & { organization: Partial<OrganizationResource> },
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & {
organization: Partial<OrganizationResource>;
/** Shows a loading spinner while the image is loading */
showLoadingSpinner?: boolean;
},
) => {
const { organization, ...rest } = props;
const { organization, showLoadingSpinner, ...rest } = props;

return (
<Col elementDescriptor={descriptors.organizationAvatarUploaderContainer}>
Expand All@@ -28,6 +32,7 @@ export const OrganizationProfileAvatarUploader = (
avatarPreview={
<OrganizationAvatar
size={theme => theme.sizes.$16}
showLoadingSpinner={showLoadingSpinner}
{...organization}
/>
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
import { useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams } from '@clerk/shared/types';
import type { CreateOrganizationParams, OrganizationCreationDefaultsResource } from '@clerk/shared/types';
import { useState } from 'react';

import { OrganizationProfileAvatarUploader } from '@/ui/components/OrganizationProfile/OrganizationProfileAvatarUploader';
import { useEnvironment } from '@/ui/contexts';
import { useSessionTasksContext, useTaskChooseOrganizationContext } from '@/ui/contexts/components/SessionTasks';
import { localizationKeys } from '@/ui/customizables';
import { Icon, localizationKeys } from '@/ui/customizables';
import { useCardState } from '@/ui/elements/contexts';
import { Form } from '@/ui/elements/Form';
import { FormButtonContainer } from '@/ui/elements/FormButtons';
import { FormContainer } from '@/ui/elements/FormContainer';
import { Header } from '@/ui/elements/Header';
import { IconButton } from '@/ui/elements/IconButton';
import { Upload } from '@/ui/icons';
import { createSlug } from '@/ui/utils/createSlug';
import { handleError } from '@/ui/utils/errorHandler';
import { useFormControl } from '@/ui/utils/useFormControl';

import { organizationListParams } from '../../../OrganizationSwitcher/utils';
import { OrganizationCreationDefaultsAlert } from './OrganizationCreationDefaultsAlert';

type CreateOrganizationScreenProps = {
onCancel?: () => void;
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
};

export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) => {
Expand All@@ -27,13 +33,14 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
userMemberships: organizationListParams.userMemberships,
});
const { organizationSettings } = useEnvironment();
const [file, setFile] = useState<File | null>();

const nameField = useFormControl('name', '', {
const nameField = useFormControl('name', props.organizationCreationDefaults?.form?.name ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__name'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__name'),
});
const slugField = useFormControl('slug', '', {
const slugField = useFormControl('slug', props.organizationCreationDefaults?.form?.slug ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__slug'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__slug'),
Expand All@@ -57,6 +64,15 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =

const organization = await createOrganization(createOrgParams);

if (file) {
await organization.setLogo({ file });
} else if (defaultLogoUrl) {
const response = await fetch(defaultLogoUrl);
const blob = await response.blob();
const logoFile = new File([blob], 'logo', { type: blob.type });
await organization.setLogo({ file: logoFile });
}

await setActive({
organization,
navigate: async ({ session }) => {
Expand All@@ -77,7 +93,13 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
slugField.setValue(val);
};

const onAvatarRemove = () => {
card.setIdle();
return setFile(null);
};

const isSubmitButtonDisabled = !nameField.value || !isLoaded;
const defaultLogoUrl = file === undefined ? props.organizationCreationDefaults?.form?.logo : undefined;

return (
<>
Expand All@@ -90,6 +112,44 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
</Header.Root>
<FormContainer sx={t => ({ padding: `${t.space.$none} ${t.space.$10} ${t.space.$8}` })}>
<Form.Root onSubmit={onSubmit}>
<OrganizationCreationDefaultsAlert organizationCreationDefaults={props.organizationCreationDefaults} />
<OrganizationProfileAvatarUploader
organization={{ name: nameField.value, imageUrl: defaultLogoUrl ?? undefined }}
onAvatarChange={async file => await setFile(file)}
onAvatarRemove={file || defaultLogoUrl ? onAvatarRemove : null}
showLoadingSpinner={!!defaultLogoUrl}
avatarPreviewPlaceholder={
<IconButton
variant='ghost'
aria-label='Upload organization logo'
icon={
<Icon
size='md'
icon={Upload}
sx={t => ({
color: t.colors.$colorMutedForeground,
transitionDuration: t.transitionDuration.$controls,
})}
/>
}
sx={t => ({
width: t.sizes.$16,
height: t.sizes.$16,
borderRadius: t.radii.$md,
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$dashed,
borderColor: t.colors.$borderAlpha200,
backgroundColor: t.colors.$neutralAlpha50,
':hover': {
backgroundColor: t.colors.$neutralAlpha50,
svg: {
transform: 'scale(1.2)',
},
},
})}
/>
}
/>
<Form.ControlRow elementId={nameField.id}>
<Form.PlainInput
{...nameField.props}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import type { OrganizationCreationDefaultsResource } from '@clerk/shared/types';

import { localizationKeys, Text } from '@/ui/customizables';
import { Alert } from '@/ui/primitives';

export function OrganizationCreationDefaultsAlert({
organizationCreationDefaults,
}: {
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
}) {
const localizationKey = advisoryToLocalizationKey(organizationCreationDefaults?.advisory);
if (!localizationKey) {
return null;
}

return (
<Alert colorScheme='warning'>
<Text
colorScheme='warning'
localizationKey={localizationKey}
variant='caption'
/>
</Alert>
);
}

const advisoryToLocalizationKey = (advisory?: OrganizationCreationDefaultsResource['advisory']) => {
if (!advisory) {
return null;
}

switch (advisory.code) {
case 'organization_already_exists':
return localizationKeys('taskChooseOrganization.alerts.organizationAlreadyExists', {
organizationDomain: advisory.meta.organization_domain,
organizationName: advisory.meta.organization_name,
});
default:
return null;
}
};
Loading
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/three-impalas-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Surface organization creation defaults with prefilled form fields and advisory warnings
4 changes: 2 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "924KB" },
{ "path": "./dist/clerk.js", "maxSize": "928KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "87KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "129KB" },
{ "path": "./dist/clerk.headless*.js", "maxSize": "66KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "126KB" },
{ "path": "./dist/vendors*.js", "maxSize": "50KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "38KB" },
{ "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type {
OrganizationCreationAdvisorySeverity,
OrganizationCreationAdvisoryType,
OrganizationCreationDefaultsJSON,
OrganizationCreationDefaultsJSONSnapshot,
OrganizationCreationDefaultsResource,
} from '@clerk/shared/types';

import { BaseResource } from './internal';

export class OrganizationCreationDefaults extends BaseResource implements OrganizationCreationDefaultsResource {
advisory: {
code: OrganizationCreationAdvisoryType;
severity: OrganizationCreationAdvisorySeverity;
meta: Record<string, string>;
} | null = null;
form: {
name: string;
slug: string;
logo: string | null;
blurHash: string | null;
} = {
name: '',
slug: '',
logo: null,
blurHash: null,
};

public constructor(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null = null) {
super();
this.fromJSON(data);
}

protected fromJSON(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null): this {
if (!data) {
return this;
}

if (data.advisory) {
this.advisory = this.withDefault(data.advisory, this.advisory ?? null);
}

if (data.form) {
this.form.name = this.withDefault(data.form.name, this.form.name);
this.form.slug = this.withDefault(data.form.slug, this.form.slug);
this.form.logo = this.withDefault(data.form.logo, this.form.logo);
this.form.blurHash = this.withDefault(data.form.blur_hash, this.form.blurHash);
}

return this;
}

static async retrieve(): Promise<OrganizationCreationDefaultsResource> {
return await BaseResource._fetch({
path: '/me/organization_creation_defaults',
method: 'GET',
}).then(res => {
const data = res?.response as unknown as OrganizationCreationDefaultsJSON;
return new OrganizationCreationDefaults(data);
});
}

public __internal_toSnapshot(): OrganizationCreationDefaultsJSONSnapshot {
return {
advisory: this.advisory
? {
code: this.advisory.code,
meta: this.advisory.meta,
severity: this.advisory.severity,
}
: null,
form: {
name: this.form.name,
slug: this.form.slug,
logo: this.form.logo,
blur_hash: this.form.blurHash,
},
} as unknown as OrganizationCreationDefaultsJSONSnapshot;
}
}
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationSettings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,11 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
} = {
disabled: false,
};
organizationCreationDefaults: {
enabled: boolean;
} = {
enabled: false,
};
enabled: boolean = false;
maxAllowedMemberships: number = 1;
forceOrganizationSelection!: boolean;
Expand DownExpand Up@@ -51,6 +56,13 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
this.slug.disabled = this.withDefault(data.slug.disabled, this.slug.disabled);
}

if (data.organization_creation_defaults) {
this.organizationCreationDefaults.enabled = this.withDefault(
data.organization_creation_defaults.enabled,
this.organizationCreationDefaults.enabled,
);
}

this.enabled = this.withDefault(data.enabled, this.enabled);
this.maxAllowedMemberships = this.withDefault(data.max_allowed_memberships, this.maxAllowedMemberships);
this.forceOrganizationSelection = this.withDefault(
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/core/resources/User.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ import {
UserOrganizationInvitation,
Web3Wallet,
} from './internal';
import { OrganizationCreationDefaults } from './OrganizationCreationDefaults';

export class User extends BaseResource implements UserResource {
pathRoot = '/me';
Expand DownExpand Up@@ -280,6 +281,8 @@ export class User extends BaseResource implements UserResource {
getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
OrganizationMembership.retrieve(retrieveMembership);

getOrganizationCreationDefaults = () => OrganizationCreationDefaults.retrieve();

leaveOrganization = async (organizationId: string): Promise<DeletedObjectResource> => {
const json = (
await BaseResource._fetch<DeletedObjectJSON>({
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/test/fixture-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -346,6 +346,9 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
const withOrganizationSlug = (enabled = false) => {
os.slug.disabled = !enabled;
};
const withOrganizationCreationDefaults = (enabled = false) => {
os.organization_creation_defaults.enabled = enabled;
};

const withOrganizationDomains = (modes?: OrganizationEnrollmentMode[], defaultRole?: string) => {
os.domains.enabled = true;
Expand All@@ -358,6 +361,7 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
withOrganizationDomains,
withForceOrganizationSelection,
withOrganizationSlug,
withOrganizationCreationDefaults,
};
};

Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/test/fixtures.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,9 @@ const createBaseOrganizationSettings = (): OrganizationSettingsJSON => {
slug: {
disabled: true,
},
organization_creation_defaults: {
enabled: false,
},
} as unknown as OrganizationSettingsJSON;
};

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,13 @@ import { Col, descriptors, Text } from '../../customizables';
import { localizationKeys } from '../../localization';

export const OrganizationProfileAvatarUploader = (
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & { organization: Partial<OrganizationResource> },
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & {
organization: Partial<OrganizationResource>;
/** Shows a loading spinner while the image is loading */
showLoadingSpinner?: boolean;
},
) => {
const { organization, ...rest } = props;
const { organization, showLoadingSpinner, ...rest } = props;

return (
<Col elementDescriptor={descriptors.organizationAvatarUploaderContainer}>
Expand All@@ -28,6 +32,7 @@ export const OrganizationProfileAvatarUploader = (
avatarPreview={
<OrganizationAvatar
size={theme => theme.sizes.$16}
showLoadingSpinner={showLoadingSpinner}
{...organization}
/>
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
import { useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams } from '@clerk/shared/types';
import type { CreateOrganizationParams, OrganizationCreationDefaultsResource } from '@clerk/shared/types';
import { useState } from 'react';

import { OrganizationProfileAvatarUploader } from '@/ui/components/OrganizationProfile/OrganizationProfileAvatarUploader';
import { useEnvironment } from '@/ui/contexts';
import { useSessionTasksContext, useTaskChooseOrganizationContext } from '@/ui/contexts/components/SessionTasks';
import { localizationKeys } from '@/ui/customizables';
import { Icon, localizationKeys } from '@/ui/customizables';
import { useCardState } from '@/ui/elements/contexts';
import { Form } from '@/ui/elements/Form';
import { FormButtonContainer } from '@/ui/elements/FormButtons';
import { FormContainer } from '@/ui/elements/FormContainer';
import { Header } from '@/ui/elements/Header';
import { IconButton } from '@/ui/elements/IconButton';
import { Upload } from '@/ui/icons';
import { createSlug } from '@/ui/utils/createSlug';
import { handleError } from '@/ui/utils/errorHandler';
import { useFormControl } from '@/ui/utils/useFormControl';

import { organizationListParams } from '../../../OrganizationSwitcher/utils';
import { OrganizationCreationDefaultsAlert } from './OrganizationCreationDefaultsAlert';

type CreateOrganizationScreenProps = {
onCancel?: () => void;
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
};

export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) => {
Expand All@@ -27,13 +33,14 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
userMemberships: organizationListParams.userMemberships,
});
const { organizationSettings } = useEnvironment();
const [file, setFile] = useState<File | null>();

const nameField = useFormControl('name', '', {
const nameField = useFormControl('name', props.organizationCreationDefaults?.form?.name ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__name'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__name'),
});
const slugField = useFormControl('slug', '', {
const slugField = useFormControl('slug', props.organizationCreationDefaults?.form?.slug ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__slug'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__slug'),
Expand All@@ -57,6 +64,15 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =

const organization = await createOrganization(createOrgParams);

if (file) {
await organization.setLogo({ file });
} else if (defaultLogoUrl) {
const response = await fetch(defaultLogoUrl);
const blob = await response.blob();
const logoFile = new File([blob], 'logo', { type: blob.type });
await organization.setLogo({ file: logoFile });
}

await setActive({
organization,
navigate: async ({ session }) => {
Expand All@@ -77,7 +93,13 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
slugField.setValue(val);
};

const onAvatarRemove = () => {
card.setIdle();
return setFile(null);
};

const isSubmitButtonDisabled = !nameField.value || !isLoaded;
const defaultLogoUrl = file === undefined ? props.organizationCreationDefaults?.form?.logo : undefined;

return (
<>
Expand All@@ -90,6 +112,44 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
</Header.Root>
<FormContainer sx={t => ({ padding: `${t.space.$none} ${t.space.$10} ${t.space.$8}` })}>
<Form.Root onSubmit={onSubmit}>
<OrganizationCreationDefaultsAlert organizationCreationDefaults={props.organizationCreationDefaults} />
<OrganizationProfileAvatarUploader
organization={{ name: nameField.value, imageUrl: defaultLogoUrl ?? undefined }}
onAvatarChange={async file => await setFile(file)}
onAvatarRemove={file || defaultLogoUrl ? onAvatarRemove : null}
showLoadingSpinner={!!defaultLogoUrl}
avatarPreviewPlaceholder={
<IconButton
variant='ghost'
aria-label='Upload organization logo'
icon={
<Icon
size='md'
icon={Upload}
sx={t => ({
color: t.colors.$colorMutedForeground,
transitionDuration: t.transitionDuration.$controls,
})}
/>
}
sx={t => ({
width: t.sizes.$16,
height: t.sizes.$16,
borderRadius: t.radii.$md,
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$dashed,
borderColor: t.colors.$borderAlpha200,
backgroundColor: t.colors.$neutralAlpha50,
':hover': {
backgroundColor: t.colors.$neutralAlpha50,
svg: {
transform: 'scale(1.2)',
},
},
})}
/>
}
/>
<Form.ControlRow elementId={nameField.id}>
<Form.PlainInput
{...nameField.props}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import type { OrganizationCreationDefaultsResource } from '@clerk/shared/types';

import { localizationKeys, Text } from '@/ui/customizables';
import { Alert } from '@/ui/primitives';

export function OrganizationCreationDefaultsAlert({
organizationCreationDefaults,
}: {
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
}) {
const localizationKey = advisoryToLocalizationKey(organizationCreationDefaults?.advisory);
if (!localizationKey) {
return null;
}

return (
<Alert colorScheme='warning'>
<Text
colorScheme='warning'
localizationKey={localizationKey}
variant='caption'
/>
</Alert>
);
}

const advisoryToLocalizationKey = (advisory?: OrganizationCreationDefaultsResource['advisory']) => {
if (!advisory) {
return null;
}

switch (advisory.code) {
case 'organization_already_exists':
return localizationKeys('taskChooseOrganization.alerts.organizationAlreadyExists', {
organizationDomain: advisory.meta.organization_domain,
organizationName: advisory.meta.organization_name,
});
default:
return null;
}
};
Loading
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/three-impalas-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Surface organization creation defaults with prefilled form fields and advisory warnings
4 changes: 2 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "924KB" },
{ "path": "./dist/clerk.js", "maxSize": "928KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "87KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "129KB" },
{ "path": "./dist/clerk.headless*.js", "maxSize": "66KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "126KB" },
{ "path": "./dist/vendors*.js", "maxSize": "50KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "38KB" },
{ "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type {
OrganizationCreationAdvisorySeverity,
OrganizationCreationAdvisoryType,
OrganizationCreationDefaultsJSON,
OrganizationCreationDefaultsJSONSnapshot,
OrganizationCreationDefaultsResource,
} from '@clerk/shared/types';

import { BaseResource } from './internal';

export class OrganizationCreationDefaults extends BaseResource implements OrganizationCreationDefaultsResource {
advisory: {
code: OrganizationCreationAdvisoryType;
severity: OrganizationCreationAdvisorySeverity;
meta: Record<string, string>;
} | null = null;
form: {
name: string;
slug: string;
logo: string | null;
blurHash: string | null;
} = {
name: '',
slug: '',
logo: null,
blurHash: null,
};

public constructor(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null = null) {
super();
this.fromJSON(data);
}

protected fromJSON(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null): this {
if (!data) {
return this;
}

if (data.advisory) {
this.advisory = this.withDefault(data.advisory, this.advisory ?? null);
}

if (data.form) {
this.form.name = this.withDefault(data.form.name, this.form.name);
this.form.slug = this.withDefault(data.form.slug, this.form.slug);
this.form.logo = this.withDefault(data.form.logo, this.form.logo);
this.form.blurHash = this.withDefault(data.form.blur_hash, this.form.blurHash);
}

return this;
}

static async retrieve(): Promise<OrganizationCreationDefaultsResource> {
return await BaseResource._fetch({
path: '/me/organization_creation_defaults',
method: 'GET',
}).then(res => {
const data = res?.response as unknown as OrganizationCreationDefaultsJSON;
return new OrganizationCreationDefaults(data);
});
}

public __internal_toSnapshot(): OrganizationCreationDefaultsJSONSnapshot {
return {
advisory: this.advisory
? {
code: this.advisory.code,
meta: this.advisory.meta,
severity: this.advisory.severity,
}
: null,
form: {
name: this.form.name,
slug: this.form.slug,
logo: this.form.logo,
blur_hash: this.form.blurHash,
},
} as unknown as OrganizationCreationDefaultsJSONSnapshot;
}
}
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationSettings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,11 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
} = {
disabled: false,
};
organizationCreationDefaults: {
enabled: boolean;
} = {
enabled: false,
};
enabled: boolean = false;
maxAllowedMemberships: number = 1;
forceOrganizationSelection!: boolean;
Expand DownExpand Up@@ -51,6 +56,13 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
this.slug.disabled = this.withDefault(data.slug.disabled, this.slug.disabled);
}

if (data.organization_creation_defaults) {
this.organizationCreationDefaults.enabled = this.withDefault(
data.organization_creation_defaults.enabled,
this.organizationCreationDefaults.enabled,
);
}

this.enabled = this.withDefault(data.enabled, this.enabled);
this.maxAllowedMemberships = this.withDefault(data.max_allowed_memberships, this.maxAllowedMemberships);
this.forceOrganizationSelection = this.withDefault(
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/core/resources/User.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ import {
UserOrganizationInvitation,
Web3Wallet,
} from './internal';
import { OrganizationCreationDefaults } from './OrganizationCreationDefaults';

export class User extends BaseResource implements UserResource {
pathRoot = '/me';
Expand DownExpand Up@@ -280,6 +281,8 @@ export class User extends BaseResource implements UserResource {
getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
OrganizationMembership.retrieve(retrieveMembership);

getOrganizationCreationDefaults = () => OrganizationCreationDefaults.retrieve();

leaveOrganization = async (organizationId: string): Promise<DeletedObjectResource> => {
const json = (
await BaseResource._fetch<DeletedObjectJSON>({
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/test/fixture-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -346,6 +346,9 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
const withOrganizationSlug = (enabled = false) => {
os.slug.disabled = !enabled;
};
const withOrganizationCreationDefaults = (enabled = false) => {
os.organization_creation_defaults.enabled = enabled;
};

const withOrganizationDomains = (modes?: OrganizationEnrollmentMode[], defaultRole?: string) => {
os.domains.enabled = true;
Expand All@@ -358,6 +361,7 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
withOrganizationDomains,
withForceOrganizationSelection,
withOrganizationSlug,
withOrganizationCreationDefaults,
};
};

Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/test/fixtures.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,9 @@ const createBaseOrganizationSettings = (): OrganizationSettingsJSON => {
slug: {
disabled: true,
},
organization_creation_defaults: {
enabled: false,
},
} as unknown as OrganizationSettingsJSON;
};

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,13 @@ import { Col, descriptors, Text } from '../../customizables';
import { localizationKeys } from '../../localization';

export const OrganizationProfileAvatarUploader = (
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & { organization: Partial<OrganizationResource> },
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & {
organization: Partial<OrganizationResource>;
/** Shows a loading spinner while the image is loading */
showLoadingSpinner?: boolean;
},
) => {
const { organization, ...rest } = props;
const { organization, showLoadingSpinner, ...rest } = props;

return (
<Col elementDescriptor={descriptors.organizationAvatarUploaderContainer}>
Expand All@@ -28,6 +32,7 @@ export const OrganizationProfileAvatarUploader = (
avatarPreview={
<OrganizationAvatar
size={theme => theme.sizes.$16}
showLoadingSpinner={showLoadingSpinner}
{...organization}
/>
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
import { useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams } from '@clerk/shared/types';
import type { CreateOrganizationParams, OrganizationCreationDefaultsResource } from '@clerk/shared/types';
import { useState } from 'react';

import { OrganizationProfileAvatarUploader } from '@/ui/components/OrganizationProfile/OrganizationProfileAvatarUploader';
import { useEnvironment } from '@/ui/contexts';
import { useSessionTasksContext, useTaskChooseOrganizationContext } from '@/ui/contexts/components/SessionTasks';
import { localizationKeys } from '@/ui/customizables';
import { Icon, localizationKeys } from '@/ui/customizables';
import { useCardState } from '@/ui/elements/contexts';
import { Form } from '@/ui/elements/Form';
import { FormButtonContainer } from '@/ui/elements/FormButtons';
import { FormContainer } from '@/ui/elements/FormContainer';
import { Header } from '@/ui/elements/Header';
import { IconButton } from '@/ui/elements/IconButton';
import { Upload } from '@/ui/icons';
import { createSlug } from '@/ui/utils/createSlug';
import { handleError } from '@/ui/utils/errorHandler';
import { useFormControl } from '@/ui/utils/useFormControl';

import { organizationListParams } from '../../../OrganizationSwitcher/utils';
import { OrganizationCreationDefaultsAlert } from './OrganizationCreationDefaultsAlert';

type CreateOrganizationScreenProps = {
onCancel?: () => void;
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
};

export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) => {
Expand All@@ -27,13 +33,14 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
userMemberships: organizationListParams.userMemberships,
});
const { organizationSettings } = useEnvironment();
const [file, setFile] = useState<File | null>();

const nameField = useFormControl('name', '', {
const nameField = useFormControl('name', props.organizationCreationDefaults?.form?.name ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__name'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__name'),
});
const slugField = useFormControl('slug', '', {
const slugField = useFormControl('slug', props.organizationCreationDefaults?.form?.slug ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__slug'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__slug'),
Expand All@@ -57,6 +64,15 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =

const organization = await createOrganization(createOrgParams);

if (file) {
await organization.setLogo({ file });
} else if (defaultLogoUrl) {
const response = await fetch(defaultLogoUrl);
const blob = await response.blob();
const logoFile = new File([blob], 'logo', { type: blob.type });
await organization.setLogo({ file: logoFile });
}

await setActive({
organization,
navigate: async ({ session }) => {
Expand All@@ -77,7 +93,13 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
slugField.setValue(val);
};

const onAvatarRemove = () => {
card.setIdle();
return setFile(null);
};

const isSubmitButtonDisabled = !nameField.value || !isLoaded;
const defaultLogoUrl = file === undefined ? props.organizationCreationDefaults?.form?.logo : undefined;

return (
<>
Expand All@@ -90,6 +112,44 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
</Header.Root>
<FormContainer sx={t => ({ padding: `${t.space.$none} ${t.space.$10} ${t.space.$8}` })}>
<Form.Root onSubmit={onSubmit}>
<OrganizationCreationDefaultsAlert organizationCreationDefaults={props.organizationCreationDefaults} />
<OrganizationProfileAvatarUploader
organization={{ name: nameField.value, imageUrl: defaultLogoUrl ?? undefined }}
onAvatarChange={async file => await setFile(file)}
onAvatarRemove={file || defaultLogoUrl ? onAvatarRemove : null}
showLoadingSpinner={!!defaultLogoUrl}
avatarPreviewPlaceholder={
<IconButton
variant='ghost'
aria-label='Upload organization logo'
icon={
<Icon
size='md'
icon={Upload}
sx={t => ({
color: t.colors.$colorMutedForeground,
transitionDuration: t.transitionDuration.$controls,
})}
/>
}
sx={t => ({
width: t.sizes.$16,
height: t.sizes.$16,
borderRadius: t.radii.$md,
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$dashed,
borderColor: t.colors.$borderAlpha200,
backgroundColor: t.colors.$neutralAlpha50,
':hover': {
backgroundColor: t.colors.$neutralAlpha50,
svg: {
transform: 'scale(1.2)',
},
},
})}
/>
}
/>
<Form.ControlRow elementId={nameField.id}>
<Form.PlainInput
{...nameField.props}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import type { OrganizationCreationDefaultsResource } from '@clerk/shared/types';

import { localizationKeys, Text } from '@/ui/customizables';
import { Alert } from '@/ui/primitives';

export function OrganizationCreationDefaultsAlert({
organizationCreationDefaults,
}: {
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
}) {
const localizationKey = advisoryToLocalizationKey(organizationCreationDefaults?.advisory);
if (!localizationKey) {
return null;
}

return (
<Alert colorScheme='warning'>
<Text
colorScheme='warning'
localizationKey={localizationKey}
variant='caption'
/>
</Alert>
);
}

const advisoryToLocalizationKey = (advisory?: OrganizationCreationDefaultsResource['advisory']) => {
if (!advisory) {
return null;
}

switch (advisory.code) {
case 'organization_already_exists':
return localizationKeys('taskChooseOrganization.alerts.organizationAlreadyExists', {
organizationDomain: advisory.meta.organization_domain,
organizationName: advisory.meta.organization_name,
});
default:
return null;
}
};
Loading
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/three-impalas-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Surface organization creation defaults with prefilled form fields and advisory warnings
4 changes: 2 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "924KB" },
{ "path": "./dist/clerk.js", "maxSize": "928KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "87KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "129KB" },
{ "path": "./dist/clerk.headless*.js", "maxSize": "66KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "126KB" },
{ "path": "./dist/vendors*.js", "maxSize": "50KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "38KB" },
{ "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type {
OrganizationCreationAdvisorySeverity,
OrganizationCreationAdvisoryType,
OrganizationCreationDefaultsJSON,
OrganizationCreationDefaultsJSONSnapshot,
OrganizationCreationDefaultsResource,
} from '@clerk/shared/types';

import { BaseResource } from './internal';

export class OrganizationCreationDefaults extends BaseResource implements OrganizationCreationDefaultsResource {
advisory: {
code: OrganizationCreationAdvisoryType;
severity: OrganizationCreationAdvisorySeverity;
meta: Record<string, string>;
} | null = null;
form: {
name: string;
slug: string;
logo: string | null;
blurHash: string | null;
} = {
name: '',
slug: '',
logo: null,
blurHash: null,
};

public constructor(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null = null) {
super();
this.fromJSON(data);
}

protected fromJSON(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null): this {
if (!data) {
return this;
}

if (data.advisory) {
this.advisory = this.withDefault(data.advisory, this.advisory ?? null);
}

if (data.form) {
this.form.name = this.withDefault(data.form.name, this.form.name);
this.form.slug = this.withDefault(data.form.slug, this.form.slug);
this.form.logo = this.withDefault(data.form.logo, this.form.logo);
this.form.blurHash = this.withDefault(data.form.blur_hash, this.form.blurHash);
}

return this;
}

static async retrieve(): Promise<OrganizationCreationDefaultsResource> {
return await BaseResource._fetch({
path: '/me/organization_creation_defaults',
method: 'GET',
}).then(res => {
const data = res?.response as unknown as OrganizationCreationDefaultsJSON;
return new OrganizationCreationDefaults(data);
});
}

public __internal_toSnapshot(): OrganizationCreationDefaultsJSONSnapshot {
return {
advisory: this.advisory
? {
code: this.advisory.code,
meta: this.advisory.meta,
severity: this.advisory.severity,
}
: null,
form: {
name: this.form.name,
slug: this.form.slug,
logo: this.form.logo,
blur_hash: this.form.blurHash,
},
} as unknown as OrganizationCreationDefaultsJSONSnapshot;
}
}
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationSettings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,11 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
} = {
disabled: false,
};
organizationCreationDefaults: {
enabled: boolean;
} = {
enabled: false,
};
enabled: boolean = false;
maxAllowedMemberships: number = 1;
forceOrganizationSelection!: boolean;
Expand DownExpand Up@@ -51,6 +56,13 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
this.slug.disabled = this.withDefault(data.slug.disabled, this.slug.disabled);
}

if (data.organization_creation_defaults) {
this.organizationCreationDefaults.enabled = this.withDefault(
data.organization_creation_defaults.enabled,
this.organizationCreationDefaults.enabled,
);
}

this.enabled = this.withDefault(data.enabled, this.enabled);
this.maxAllowedMemberships = this.withDefault(data.max_allowed_memberships, this.maxAllowedMemberships);
this.forceOrganizationSelection = this.withDefault(
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/core/resources/User.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ import {
UserOrganizationInvitation,
Web3Wallet,
} from './internal';
import { OrganizationCreationDefaults } from './OrganizationCreationDefaults';

export class User extends BaseResource implements UserResource {
pathRoot = '/me';
Expand DownExpand Up@@ -280,6 +281,8 @@ export class User extends BaseResource implements UserResource {
getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
OrganizationMembership.retrieve(retrieveMembership);

getOrganizationCreationDefaults = () => OrganizationCreationDefaults.retrieve();

leaveOrganization = async (organizationId: string): Promise<DeletedObjectResource> => {
const json = (
await BaseResource._fetch<DeletedObjectJSON>({
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/test/fixture-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -346,6 +346,9 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
const withOrganizationSlug = (enabled = false) => {
os.slug.disabled = !enabled;
};
const withOrganizationCreationDefaults = (enabled = false) => {
os.organization_creation_defaults.enabled = enabled;
};

const withOrganizationDomains = (modes?: OrganizationEnrollmentMode[], defaultRole?: string) => {
os.domains.enabled = true;
Expand All@@ -358,6 +361,7 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
withOrganizationDomains,
withForceOrganizationSelection,
withOrganizationSlug,
withOrganizationCreationDefaults,
};
};

Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/test/fixtures.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,9 @@ const createBaseOrganizationSettings = (): OrganizationSettingsJSON => {
slug: {
disabled: true,
},
organization_creation_defaults: {
enabled: false,
},
} as unknown as OrganizationSettingsJSON;
};

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,13 @@ import { Col, descriptors, Text } from '../../customizables';
import { localizationKeys } from '../../localization';

export const OrganizationProfileAvatarUploader = (
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & { organization: Partial<OrganizationResource> },
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & {
organization: Partial<OrganizationResource>;
/** Shows a loading spinner while the image is loading */
showLoadingSpinner?: boolean;
},
) => {
const { organization, ...rest } = props;
const { organization, showLoadingSpinner, ...rest } = props;

return (
<Col elementDescriptor={descriptors.organizationAvatarUploaderContainer}>
Expand All@@ -28,6 +32,7 @@ export const OrganizationProfileAvatarUploader = (
avatarPreview={
<OrganizationAvatar
size={theme => theme.sizes.$16}
showLoadingSpinner={showLoadingSpinner}
{...organization}
/>
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
import { useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams } from '@clerk/shared/types';
import type { CreateOrganizationParams, OrganizationCreationDefaultsResource } from '@clerk/shared/types';
import { useState } from 'react';

import { OrganizationProfileAvatarUploader } from '@/ui/components/OrganizationProfile/OrganizationProfileAvatarUploader';
import { useEnvironment } from '@/ui/contexts';
import { useSessionTasksContext, useTaskChooseOrganizationContext } from '@/ui/contexts/components/SessionTasks';
import { localizationKeys } from '@/ui/customizables';
import { Icon, localizationKeys } from '@/ui/customizables';
import { useCardState } from '@/ui/elements/contexts';
import { Form } from '@/ui/elements/Form';
import { FormButtonContainer } from '@/ui/elements/FormButtons';
import { FormContainer } from '@/ui/elements/FormContainer';
import { Header } from '@/ui/elements/Header';
import { IconButton } from '@/ui/elements/IconButton';
import { Upload } from '@/ui/icons';
import { createSlug } from '@/ui/utils/createSlug';
import { handleError } from '@/ui/utils/errorHandler';
import { useFormControl } from '@/ui/utils/useFormControl';

import { organizationListParams } from '../../../OrganizationSwitcher/utils';
import { OrganizationCreationDefaultsAlert } from './OrganizationCreationDefaultsAlert';

type CreateOrganizationScreenProps = {
onCancel?: () => void;
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
};

export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) => {
Expand All@@ -27,13 +33,14 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
userMemberships: organizationListParams.userMemberships,
});
const { organizationSettings } = useEnvironment();
const [file, setFile] = useState<File | null>();

const nameField = useFormControl('name', '', {
const nameField = useFormControl('name', props.organizationCreationDefaults?.form?.name ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__name'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__name'),
});
const slugField = useFormControl('slug', '', {
const slugField = useFormControl('slug', props.organizationCreationDefaults?.form?.slug ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__slug'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__slug'),
Expand All@@ -57,6 +64,15 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =

const organization = await createOrganization(createOrgParams);

if (file) {
await organization.setLogo({ file });
} else if (defaultLogoUrl) {
const response = await fetch(defaultLogoUrl);
const blob = await response.blob();
const logoFile = new File([blob], 'logo', { type: blob.type });
await organization.setLogo({ file: logoFile });
}

await setActive({
organization,
navigate: async ({ session }) => {
Expand All@@ -77,7 +93,13 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
slugField.setValue(val);
};

const onAvatarRemove = () => {
card.setIdle();
return setFile(null);
};

const isSubmitButtonDisabled = !nameField.value || !isLoaded;
const defaultLogoUrl = file === undefined ? props.organizationCreationDefaults?.form?.logo : undefined;

return (
<>
Expand All@@ -90,6 +112,44 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
</Header.Root>
<FormContainer sx={t => ({ padding: `${t.space.$none} ${t.space.$10} ${t.space.$8}` })}>
<Form.Root onSubmit={onSubmit}>
<OrganizationCreationDefaultsAlert organizationCreationDefaults={props.organizationCreationDefaults} />
<OrganizationProfileAvatarUploader
organization={{ name: nameField.value, imageUrl: defaultLogoUrl ?? undefined }}
onAvatarChange={async file => await setFile(file)}
onAvatarRemove={file || defaultLogoUrl ? onAvatarRemove : null}
showLoadingSpinner={!!defaultLogoUrl}
avatarPreviewPlaceholder={
<IconButton
variant='ghost'
aria-label='Upload organization logo'
icon={
<Icon
size='md'
icon={Upload}
sx={t => ({
color: t.colors.$colorMutedForeground,
transitionDuration: t.transitionDuration.$controls,
})}
/>
}
sx={t => ({
width: t.sizes.$16,
height: t.sizes.$16,
borderRadius: t.radii.$md,
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$dashed,
borderColor: t.colors.$borderAlpha200,
backgroundColor: t.colors.$neutralAlpha50,
':hover': {
backgroundColor: t.colors.$neutralAlpha50,
svg: {
transform: 'scale(1.2)',
},
},
})}
/>
}
/>
<Form.ControlRow elementId={nameField.id}>
<Form.PlainInput
{...nameField.props}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import type { OrganizationCreationDefaultsResource } from '@clerk/shared/types';

import { localizationKeys, Text } from '@/ui/customizables';
import { Alert } from '@/ui/primitives';

export function OrganizationCreationDefaultsAlert({
organizationCreationDefaults,
}: {
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
}) {
const localizationKey = advisoryToLocalizationKey(organizationCreationDefaults?.advisory);
if (!localizationKey) {
return null;
}

return (
<Alert colorScheme='warning'>
<Text
colorScheme='warning'
localizationKey={localizationKey}
variant='caption'
/>
</Alert>
);
}

const advisoryToLocalizationKey = (advisory?: OrganizationCreationDefaultsResource['advisory']) => {
if (!advisory) {
return null;
}

switch (advisory.code) {
case 'organization_already_exists':
return localizationKeys('taskChooseOrganization.alerts.organizationAlreadyExists', {
organizationDomain: advisory.meta.organization_domain,
organizationName: advisory.meta.organization_name,
});
default:
return null;
}
};
Loading
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/three-impalas-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Surface organization creation defaults with prefilled form fields and advisory warnings
4 changes: 2 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "924KB" },
{ "path": "./dist/clerk.js", "maxSize": "928KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "87KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "129KB" },
{ "path": "./dist/clerk.headless*.js", "maxSize": "66KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "123KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "126KB" },
{ "path": "./dist/vendors*.js", "maxSize": "50KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "38KB" },
{ "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type {
OrganizationCreationAdvisorySeverity,
OrganizationCreationAdvisoryType,
OrganizationCreationDefaultsJSON,
OrganizationCreationDefaultsJSONSnapshot,
OrganizationCreationDefaultsResource,
} from '@clerk/shared/types';

import { BaseResource } from './internal';

export class OrganizationCreationDefaults extends BaseResource implements OrganizationCreationDefaultsResource {
advisory: {
code: OrganizationCreationAdvisoryType;
severity: OrganizationCreationAdvisorySeverity;
meta: Record<string, string>;
} | null = null;
form: {
name: string;
slug: string;
logo: string | null;
blurHash: string | null;
} = {
name: '',
slug: '',
logo: null,
blurHash: null,
};

public constructor(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null = null) {
super();
this.fromJSON(data);
}

protected fromJSON(data: OrganizationCreationDefaultsJSON | OrganizationCreationDefaultsJSONSnapshot | null): this {
if (!data) {
return this;
}

if (data.advisory) {
this.advisory = this.withDefault(data.advisory, this.advisory ?? null);
}

if (data.form) {
this.form.name = this.withDefault(data.form.name, this.form.name);
this.form.slug = this.withDefault(data.form.slug, this.form.slug);
this.form.logo = this.withDefault(data.form.logo, this.form.logo);
this.form.blurHash = this.withDefault(data.form.blur_hash, this.form.blurHash);
}

return this;
}

static async retrieve(): Promise<OrganizationCreationDefaultsResource> {
return await BaseResource._fetch({
path: '/me/organization_creation_defaults',
method: 'GET',
}).then(res => {
const data = res?.response as unknown as OrganizationCreationDefaultsJSON;
return new OrganizationCreationDefaults(data);
});
}

public __internal_toSnapshot(): OrganizationCreationDefaultsJSONSnapshot {
return {
advisory: this.advisory
? {
code: this.advisory.code,
meta: this.advisory.meta,
severity: this.advisory.severity,
}
: null,
form: {
name: this.form.name,
slug: this.form.slug,
logo: this.form.logo,
blur_hash: this.form.blurHash,
},
} as unknown as OrganizationCreationDefaultsJSONSnapshot;
}
}
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationSettings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,11 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
} = {
disabled: false,
};
organizationCreationDefaults: {
enabled: boolean;
} = {
enabled: false,
};
enabled: boolean = false;
maxAllowedMemberships: number = 1;
forceOrganizationSelection!: boolean;
Expand DownExpand Up@@ -51,6 +56,13 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
this.slug.disabled = this.withDefault(data.slug.disabled, this.slug.disabled);
}

if (data.organization_creation_defaults) {
this.organizationCreationDefaults.enabled = this.withDefault(
data.organization_creation_defaults.enabled,
this.organizationCreationDefaults.enabled,
);
}

this.enabled = this.withDefault(data.enabled, this.enabled);
this.maxAllowedMemberships = this.withDefault(data.max_allowed_memberships, this.maxAllowedMemberships);
this.forceOrganizationSelection = this.withDefault(
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/core/resources/User.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ import {
UserOrganizationInvitation,
Web3Wallet,
} from './internal';
import { OrganizationCreationDefaults } from './OrganizationCreationDefaults';

export class User extends BaseResource implements UserResource {
pathRoot = '/me';
Expand DownExpand Up@@ -280,6 +281,8 @@ export class User extends BaseResource implements UserResource {
getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
OrganizationMembership.retrieve(retrieveMembership);

getOrganizationCreationDefaults = () => OrganizationCreationDefaults.retrieve();

leaveOrganization = async (organizationId: string): Promise<DeletedObjectResource> => {
const json = (
await BaseResource._fetch<DeletedObjectJSON>({
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/test/fixture-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -346,6 +346,9 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
const withOrganizationSlug = (enabled = false) => {
os.slug.disabled = !enabled;
};
const withOrganizationCreationDefaults = (enabled = false) => {
os.organization_creation_defaults.enabled = enabled;
};

const withOrganizationDomains = (modes?: OrganizationEnrollmentMode[], defaultRole?: string) => {
os.domains.enabled = true;
Expand All@@ -358,6 +361,7 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
withOrganizationDomains,
withForceOrganizationSelection,
withOrganizationSlug,
withOrganizationCreationDefaults,
};
};

Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/test/fixtures.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,9 @@ const createBaseOrganizationSettings = (): OrganizationSettingsJSON => {
slug: {
disabled: true,
},
organization_creation_defaults: {
enabled: false,
},
} as unknown as OrganizationSettingsJSON;
};

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,13 @@ import { Col, descriptors, Text } from '../../customizables';
import { localizationKeys } from '../../localization';

export const OrganizationProfileAvatarUploader = (
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & { organization: Partial<OrganizationResource> },
props: Omit<AvatarUploaderProps, 'avatarPreview' | 'title'> & {
organization: Partial<OrganizationResource>;
/** Shows a loading spinner while the image is loading */
showLoadingSpinner?: boolean;
},
) => {
const { organization, ...rest } = props;
const { organization, showLoadingSpinner, ...rest } = props;

return (
<Col elementDescriptor={descriptors.organizationAvatarUploaderContainer}>
Expand All@@ -28,6 +32,7 @@ export const OrganizationProfileAvatarUploader = (
avatarPreview={
<OrganizationAvatar
size={theme => theme.sizes.$16}
showLoadingSpinner={showLoadingSpinner}
{...organization}
/>
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
import { useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams } from '@clerk/shared/types';
import type { CreateOrganizationParams, OrganizationCreationDefaultsResource } from '@clerk/shared/types';
import { useState } from 'react';

import { OrganizationProfileAvatarUploader } from '@/ui/components/OrganizationProfile/OrganizationProfileAvatarUploader';
import { useEnvironment } from '@/ui/contexts';
import { useSessionTasksContext, useTaskChooseOrganizationContext } from '@/ui/contexts/components/SessionTasks';
import { localizationKeys } from '@/ui/customizables';
import { Icon, localizationKeys } from '@/ui/customizables';
import { useCardState } from '@/ui/elements/contexts';
import { Form } from '@/ui/elements/Form';
import { FormButtonContainer } from '@/ui/elements/FormButtons';
import { FormContainer } from '@/ui/elements/FormContainer';
import { Header } from '@/ui/elements/Header';
import { IconButton } from '@/ui/elements/IconButton';
import { Upload } from '@/ui/icons';
import { createSlug } from '@/ui/utils/createSlug';
import { handleError } from '@/ui/utils/errorHandler';
import { useFormControl } from '@/ui/utils/useFormControl';

import { organizationListParams } from '../../../OrganizationSwitcher/utils';
import { OrganizationCreationDefaultsAlert } from './OrganizationCreationDefaultsAlert';

type CreateOrganizationScreenProps = {
onCancel?: () => void;
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
};

export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) => {
Expand All@@ -27,13 +33,14 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
userMemberships: organizationListParams.userMemberships,
});
const { organizationSettings } = useEnvironment();
const [file, setFile] = useState<File | null>();

const nameField = useFormControl('name', '', {
const nameField = useFormControl('name', props.organizationCreationDefaults?.form?.name ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__name'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__name'),
});
const slugField = useFormControl('slug', '', {
const slugField = useFormControl('slug', props.organizationCreationDefaults?.form?.slug ?? '', {
type: 'text',
label: localizationKeys('taskChooseOrganization.createOrganization.formFieldLabel__slug'),
placeholder: localizationKeys('taskChooseOrganization.createOrganization.formFieldInputPlaceholder__slug'),
Expand All@@ -57,6 +64,15 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =

const organization = await createOrganization(createOrgParams);

if (file) {
await organization.setLogo({ file });
} else if (defaultLogoUrl) {
const response = await fetch(defaultLogoUrl);
const blob = await response.blob();
const logoFile = new File([blob], 'logo', { type: blob.type });
await organization.setLogo({ file: logoFile });
}

await setActive({
organization,
navigate: async ({ session }) => {
Expand All@@ -77,7 +93,13 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
slugField.setValue(val);
};

const onAvatarRemove = () => {
card.setIdle();
return setFile(null);
};

const isSubmitButtonDisabled = !nameField.value || !isLoaded;
const defaultLogoUrl = file === undefined ? props.organizationCreationDefaults?.form?.logo : undefined;

return (
<>
Expand All@@ -90,6 +112,44 @@ export const CreateOrganizationScreen = (props: CreateOrganizationScreenProps) =
</Header.Root>
<FormContainer sx={t => ({ padding: `${t.space.$none} ${t.space.$10} ${t.space.$8}` })}>
<Form.Root onSubmit={onSubmit}>
<OrganizationCreationDefaultsAlert organizationCreationDefaults={props.organizationCreationDefaults} />
<OrganizationProfileAvatarUploader
organization={{ name: nameField.value, imageUrl: defaultLogoUrl ?? undefined }}
onAvatarChange={async file => await setFile(file)}
onAvatarRemove={file || defaultLogoUrl ? onAvatarRemove : null}
showLoadingSpinner={!!defaultLogoUrl}
avatarPreviewPlaceholder={
<IconButton
variant='ghost'
aria-label='Upload organization logo'
icon={
<Icon
size='md'
icon={Upload}
sx={t => ({
color: t.colors.$colorMutedForeground,
transitionDuration: t.transitionDuration.$controls,
})}
/>
}
sx={t => ({
width: t.sizes.$16,
height: t.sizes.$16,
borderRadius: t.radii.$md,
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$dashed,
borderColor: t.colors.$borderAlpha200,
backgroundColor: t.colors.$neutralAlpha50,
':hover': {
backgroundColor: t.colors.$neutralAlpha50,
svg: {
transform: 'scale(1.2)',
},
},
})}
/>
}
/>
<Form.ControlRow elementId={nameField.id}>
<Form.PlainInput
{...nameField.props}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import type { OrganizationCreationDefaultsResource } from '@clerk/shared/types';

import { localizationKeys, Text } from '@/ui/customizables';
import { Alert } from '@/ui/primitives';

export function OrganizationCreationDefaultsAlert({
organizationCreationDefaults,
}: {
organizationCreationDefaults?: OrganizationCreationDefaultsResource | null;
}) {
const localizationKey = advisoryToLocalizationKey(organizationCreationDefaults?.advisory);
if (!localizationKey) {
return null;
}

return (
<Alert colorScheme='warning'>
<Text
colorScheme='warning'
localizationKey={localizationKey}
variant='caption'
/>
</Alert>
);
}

const advisoryToLocalizationKey = (advisory?: OrganizationCreationDefaultsResource['advisory']) => {
if (!advisory) {
return null;
}

switch (advisory.code) {
case 'organization_already_exists':
return localizationKeys('taskChooseOrganization.alerts.organizationAlreadyExists', {
organizationDomain: advisory.meta.organization_domain,
organizationName: advisory.meta.organization_name,
});
default:
return null;
}
};
Loading
Loading