feat(ui,clerk-js,shared): Surface organization creation defaults

.changeset/calm-maps-work.md

@@ -0,0 +1,8 @@
+---
+'@clerk/localizations': minor
+'@clerk/clerk-js': minor
+'@clerk/shared': minor
+'@clerk/ui': minor
+---
+
+Surface organization creation defaults with prefilled form fields and advisory warnings

packages/clerk-js/bundlewatch.config.json

@@ -1,8 +1,8 @@
 {
   "files": [
     { "path": "./dist/clerk.js", "maxSize": "538KB" },
-    { "path": "./dist/clerk.browser.js", "maxSize": "63KB" },
-    { "path": "./dist/clerk.chips.browser.js", "maxSize": "63KB" },
+    { "path": "./dist/clerk.browser.js", "maxSize": "66KB" },
+    { "path": "./dist/clerk.chips.browser.js", "maxSize": "66KB" },
     { "path": "./dist/clerk.legacy.browser.js", "maxSize": "105KB" },
     { "path": "./dist/clerk.no-rhc.js", "maxSize": "305KB" },
     { "path": "./dist/clerk.headless*.js", "maxSize": "65KB" },

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

@@ -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;
+  }
+}

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

@@ -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;
@@ -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(

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

@@ -53,6 +53,7 @@ import {
   UserOrganizationInvitation,
   Web3Wallet,
 } from './internal';
+import { OrganizationCreationDefaults } from './OrganizationCreationDefaults';
 
 export class User extends BaseResource implements UserResource {
   pathRoot = '/me';
@@ -275,6 +276,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>({

packages/clerk-js/src/test/fixture-helpers.ts

@@ -344,6 +344,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;
@@ -356,6 +359,7 @@ const createOrganizationSettingsFixtureHelpers = (environment: EnvironmentJSON)
     withOrganizationDomains,
     withForceOrganizationSelection,
     withOrganizationSlug,
+    withOrganizationCreationDefaults,
   };
 };
 

packages/localizations/src/ar-SA.ts

@@ -882,6 +882,10 @@ export const arSA: LocalizationResource = {
       actionLink: 'تسجيل الخروج',
       actionText: 'تم تسجيل الدخول كـ {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'توجد منظمة بالفعل لاسم الشركة المكتشف ({{organizationName}}) و {{organizationDomain}}. انضم عن طريق الدعوة.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/be-BY.ts

@@ -890,6 +890,10 @@ export const beBY: LocalizationResource = {
       actionLink: 'Выйсці',
       actionText: 'Увайшлі як {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'Арганізацыя ўжо існуе для выяўленай назвы кампаніі ({{organizationName}}) і {{organizationDomain}}. Далучайцеся па запрашэнні.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/bg-BG.ts

@@ -886,6 +886,10 @@ export const bgBG: LocalizationResource = {
       actionLink: 'Изход',
       actionText: 'Влязъл като {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'Организация вече съществува за откритото име на компанията ({{organizationName}}) и {{organizationDomain}}. Присъединете се чрез покана.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/bn-IN.ts

@@ -890,6 +890,10 @@ export const bnIN: LocalizationResource = {
       actionLink: 'সাইন আউট',
       actionText: '{{identifier}} হিসাবে সাইন ইন করা হয়েছে',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'শনাক্ত করা কোম্পানির নাম ({{organizationName}}) এবং {{organizationDomain}}-এর জন্য একটি সংস্থা ইতিমধ্যেই বিদ্যমান। আমন্ত্রণের মাধ্যমে যোগ দিন।',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/ca-ES.ts

@@ -885,6 +885,10 @@ export const caES: LocalizationResource = {
       actionLink: 'Tancar sessió',
       actionText: 'Sessió iniciada com a {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        "Ja existeix una organització per al nom d'empresa detectat ({{organizationName}}) i {{organizationDomain}}. Uneix-te per invitació.",
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/cs-CZ.ts

@@ -896,6 +896,10 @@ export const csCZ: LocalizationResource = {
       actionLink: 'Odhlásit se',
       actionText: 'Přihlášen jako {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'Organizace již existuje pro detekovaný název společnosti ({{organizationName}}) a {{organizationDomain}}. Připojte se prostřednictvím pozvánky.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/da-DK.ts

@@ -883,6 +883,10 @@ export const daDK: LocalizationResource = {
       actionLink: 'Log ud',
       actionText: 'Logget ind som {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'Der findes allerede en organisation for det registrerede firmanavn ({{organizationName}}) og {{organizationDomain}}. Tilmeld dig via invitation.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/de-DE.ts

@@ -901,6 +901,10 @@ export const deDE: LocalizationResource = {
       actionLink: 'Abmelden',
       actionText: 'Angemeldet als {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'Für den erkannten Firmennamen ({{organizationName}}) und {{organizationDomain}} existiert bereits eine Organisation. Treten Sie per Einladung bei.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/el-GR.ts

@@ -888,6 +888,10 @@ export const elGR: LocalizationResource = {
       actionLink: 'Αποσύνδεση',
       actionText: 'Συνδεδεμένος ως {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'Υπάρχει ήδη οργανισμός για το ανιχνευμένο όνομα εταιρείας ({{organizationName}}) και {{organizationDomain}}. Εγγραφείτε μέσω πρόσκλησης.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/en-GB.ts

@@ -887,6 +887,10 @@ export const enGB: LocalizationResource = {
       actionLink: 'Sign out',
       actionText: 'Signed in as {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'An organisation already exists for the detected company name ({{organizationName}}) and {{organizationDomain}}. Join by invitation.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/en-US.ts

@@ -884,6 +884,10 @@ export const enUS: LocalizationResource = {
       actionLink: 'Sign out',
       actionText: 'Signed in as {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'An organization already exists for the detected company name ({{organizationName}}) and {{organizationDomain}}. Join by invitation.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: 'Reset Password',

packages/localizations/src/es-CR.ts

@@ -893,6 +893,10 @@ export const esCR: LocalizationResource = {
       actionLink: 'Cerrar sesión',
       actionText: 'Conectado como {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'Ya existe una organización para el nombre de empresa detectado ({{organizationName}}) y {{organizationDomain}}. Únete por invitación.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/es-ES.ts

@@ -887,6 +887,10 @@ export const esES: LocalizationResource = {
       actionLink: 'Cerrar sesión',
       actionText: 'Sesión iniciada como {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'Ya existe una organización para el nombre de empresa detectado ({{organizationName}}) y {{organizationDomain}}. Únete por invitación.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/es-MX.ts

@@ -894,6 +894,10 @@ export const esMX: LocalizationResource = {
       actionLink: 'Cerrar sesión',
       actionText: 'Registrado como {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'Ya existe una organización para el nombre de empresa detectado ({{organizationName}}) y {{organizationDomain}}. Únete por invitación.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/es-UY.ts

@@ -893,6 +893,10 @@ export const esUY: LocalizationResource = {
       actionLink: 'Cerrar sesión',
       actionText: 'Logueado como {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'Ya existe una organización para el nombre de empresa detectado ({{organizationName}}) y {{organizationDomain}}. Únete por invitación.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/fa-IR.ts

@@ -897,6 +897,10 @@ export const faIR: LocalizationResource = {
       actionLink: 'خروج از همه حساب‌ها',
       actionText: 'می‌خواهید خارج شوید؟',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'سازمانی برای نام شرکت شناسایی شده ({{organizationName}}) و {{organizationDomain}} از قبل وجود دارد. از طریق دعوتنامه بپیوندید.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/fi-FI.ts

@@ -886,6 +886,10 @@ export const fiFI: LocalizationResource = {
       actionLink: 'Kirjaudu ulos',
       actionText: 'Kirjautuneena käyttäjänä {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'Organisaatio on jo olemassa havaitulle yrityksen nimelle ({{organizationName}}) ja {{organizationDomain}}. Liity kutsulla.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/fr-FR.ts

@@ -902,6 +902,10 @@ export const frFR: LocalizationResource = {
       actionLink: 'Se déconnecter',
       actionText: 'Connecté en tant que {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        "Une organisation existe déjà pour le nom d'entreprise détecté ({{organizationName}}) et {{organizationDomain}}. Rejoignez par invitation.",
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/he-IL.ts

@@ -876,6 +876,10 @@ export const heIL: LocalizationResource = {
       actionLink: 'התנתק',
       actionText: 'מחובר כ-{{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'ארגון כבר קיים עבור שם החברה שזוהה ({{organizationName}}) ו-{{organizationDomain}}. הצטרף באמצעות הזמנה.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/hi-IN.ts

@@ -891,6 +891,10 @@ export const hiIN: LocalizationResource = {
       actionLink: 'साइन आउट',
       actionText: '{{identifier}} के रूप में साइन इन किया गया',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'पता लगाई गई कंपनी के नाम ({{organizationName}}) और {{organizationDomain}} के लिए एक संगठन पहले से मौजूद है। आमंत्रण द्वारा शामिल हों।',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,

packages/localizations/src/hr-HR.ts

@@ -887,6 +887,10 @@ export const hrHR: LocalizationResource = {
       actionLink: 'Odjavi se',
       actionText: 'Prijavljen kao {{identifier}}',
     },
+    alerts: {
+      organizationAlreadyExists:
+        'Organizacija već postoji za otkriveni naziv tvrtke ({{organizationName}}) i {{organizationDomain}}. Pridružite se putem pozivnice.',
+    },
   },
   taskResetPassword: {
     formButtonPrimary: undefined,