feat(shared,js): add directory sync resource and organization contract

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

@@ -0,0 +1,105 @@
+import type {
+  DirectorySyncJSON,
+  DirectorySyncJSONSnapshot,
+  DirectorySyncProvider,
+  DirectorySyncResource,
+  DirectorySyncUserJSON,
+  DirectorySyncUserResource,
+} from '@clerk/shared/types';
+
+import { unixEpochToDate } from '../../utils/date';
+import { BaseResource } from './Base';
+
+export class DirectorySync extends BaseResource implements DirectorySyncResource {
+  id!: string;
+  name!: string;
+  enterpriseConnectionId: string | null = null;
+  endpointUrl!: string;
+  provider!: DirectorySyncProvider;
+  enabled!: boolean;
+  groupRoleMappingEnabled!: boolean;
+  attributeMapping: Record<string, string> = {};
+  apiKey: string | null = null;
+  createdAt: Date | null = null;
+  updatedAt: Date | null = null;
+
+  constructor(data: DirectorySyncJSON | DirectorySyncJSONSnapshot | null) {
+    super();
+    this.fromJSON(data);
+  }
+
+  protected fromJSON(data: DirectorySyncJSON | DirectorySyncJSONSnapshot | null): this {
+    if (!data) {
+      return this;
+    }
+
+    this.id = data.id;
+    this.name = data.name;
+    this.enterpriseConnectionId = data.enterprise_connection_id ?? null;
+    this.endpointUrl = data.endpoint_url;
+    this.provider = data.provider;
+    this.enabled = data.enabled;
+    this.groupRoleMappingEnabled = data.group_role_mapping_enabled;
+    this.attributeMapping = data.attribute_mapping ?? {};
+    this.apiKey = data.api_key ?? null;
+    this.createdAt = unixEpochToDate(data.created_at);
+    this.updatedAt = unixEpochToDate(data.updated_at);
+
+    return this;
+  }
+
+  public __internal_toSnapshot(): DirectorySyncJSONSnapshot {
+    return {
+      object: 'directory',
+      id: this.id,
+      name: this.name,
+      enterprise_connection_id: this.enterpriseConnectionId,
+      endpoint_url: this.endpointUrl,
+      provider: this.provider,
+      enabled: this.enabled,
+      group_role_mapping_enabled: this.groupRoleMappingEnabled,
+      attribute_mapping: this.attributeMapping,
+      // The bearer token is deliberately absent: snapshots may be persisted
+      // and the secret must never outlive the response it arrived on.
+      created_at: this.createdAt?.getTime() ?? 0,
+      updated_at: this.updatedAt?.getTime() ?? 0,
+    };
+  }
+}
+
+export class DirectorySyncUser extends BaseResource implements DirectorySyncUserResource {
+  id!: string;
+  userId!: string;
+  firstName: string | null = null;
+  lastName: string | null = null;
+  identifier: string | null = null;
+  imageUrl!: string;
+  hasImage!: boolean;
+  active!: boolean;
+  provisionedAt: Date | null = null;
+  updatedAt: Date | null = null;
+
+  constructor(data: DirectorySyncUserJSON | null) {
+    super();
+    this.fromJSON(data);
+  }
+
+  protected fromJSON(data: DirectorySyncUserJSON | null): this {
+    if (!data) {
+      return this;
+    }
+
+    this.id = data.id;
+    this.userId = data.user_id;
+    this.firstName = data.first_name;
+    this.lastName = data.last_name;
+    this.identifier = data.identifier;
+    this.imageUrl = data.image_url;
+    this.hasImage = data.has_image;
+    this.active = data.active;
+    this.provisionedAt = unixEpochToDate(data.provisioned_at);
+    this.updatedAt = unixEpochToDate(data.updated_at);
+
+    return this;
+  }
+}

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

@@ -2,18 +2,24 @@ import type {
   AddMemberParams,
   ClerkPaginatedResponse,
   ClerkResourceReloadParams,
+  CreateDirectorySyncParams,
   CreateOrganizationDomainParams,
   CreateOrganizationEnterpriseConnectionParams,
   CreateOrganizationParams,
   DeletedObjectJSON,
   DeletedObjectResource,
+  DirectorySyncJSON,
+  DirectorySyncResource,
+  DirectorySyncUserJSON,
+  DirectorySyncUserResource,
   EnterpriseConnectionJSON,
   EnterpriseConnectionResource,
   EnterpriseConnectionTestRunInitJSON,
   EnterpriseConnectionTestRunInitResource,
   EnterpriseConnectionTestRunJSON,
   EnterpriseConnectionTestRunResource,
   EnterpriseConnectionTestRunsPaginatedJSON,
+  GetDirectorySyncUsersParams,
   GetDomainsParams,
   GetEnterpriseConnectionsParams,
   GetEnterpriseConnectionTestRunsParams,
@@ -37,6 +43,7 @@ import type {
   OrganizationResource,
   RoleJSON,
   SetOrganizationLogoParams,
+  UpdateDirectorySyncParams,
   UpdateMembershipParams,
   UpdateOrganizationEnterpriseConnectionParams,
   UpdateOrganizationParams,
@@ -49,6 +56,8 @@ import { addPaymentMethod, getPaymentMethods, initializePaymentMethod } from '..
 import {
   BaseResource,
   DeletedObject,
+  DirectorySync,
+  DirectorySyncUser,
   EnterpriseConnection,
   EnterpriseConnectionTestRun,
   OrganizationInvitation,
@@ -274,6 +283,95 @@ export class Organization extends BaseResource implements OrganizationResource {
     };
   };
 
+  getDirectorySync = async (enterpriseConnectionId: string): Promise<DirectorySyncResource> => {
+    const json = (
+      await BaseResource._fetch<DirectorySyncJSON>({
+        path: `/organizations/${this.id}/enterprise_connections/${enterpriseConnectionId}/directory`,
+        method: 'GET',
+      })
+    )?.response as unknown as DirectorySyncJSON;
+
+    return new DirectorySync(json);
+  };
+
+  createDirectorySync = async (
+    enterpriseConnectionId: string,
+    params?: CreateDirectorySyncParams,
+  ): Promise<DirectorySyncResource> => {
+    const json = (
+      await BaseResource._fetch<DirectorySyncJSON>({
+        path: `/organizations/${this.id}/enterprise_connections/${enterpriseConnectionId}/directory`,
+        method: 'POST',
+        body: (params?.name ? { name: params.name } : {}) as any,
+      })
+    )?.response as unknown as DirectorySyncJSON;
+
+    return new DirectorySync(json);
+  };
+
+  updateDirectorySync = async (
+    enterpriseConnectionId: string,
+    params: UpdateDirectorySyncParams,
+  ): Promise<DirectorySyncResource> => {
+    const body: Record<string, string | boolean> = {};
+    if (params.enabled !== undefined) {
+      body.enabled = params.enabled;
+    }
+    if (params.attributeMapping !== undefined) {
+      body.attribute_mapping = JSON.stringify(params.attributeMapping);
+    }
+
+    const json = (
+      await BaseResource._fetch<DirectorySyncJSON>({
+        path: `/organizations/${this.id}/enterprise_connections/${enterpriseConnectionId}/directory`,
+        method: 'PATCH',
+        body: body as any,
+      })
+    )?.response as unknown as DirectorySyncJSON;
+
+    return new DirectorySync(json);
+  };
+
+  rotateDirectorySyncToken = async (enterpriseConnectionId: string): Promise<DirectorySyncResource> => {
+    const json = (
+      await BaseResource._fetch<DirectorySyncJSON>({
+        path: `/organizations/${this.id}/enterprise_connections/${enterpriseConnectionId}/directory/rotate_api_key`,
+        method: 'POST',
+      })
+    )?.response as unknown as DirectorySyncJSON;
+
+    return new DirectorySync(json);
+  };
+
+  deleteDirectorySync = async (enterpriseConnectionId: string): Promise<DeletedObjectResource> => {
+    const json = (
+      await BaseResource._fetch<DeletedObjectJSON>({
+        path: `/organizations/${this.id}/enterprise_connections/${enterpriseConnectionId}/directory`,
+        method: 'DELETE',
+      })
+    )?.response as unknown as DeletedObjectJSON;
+
+    return new DeletedObject(json);
+  };
+
+  getDirectorySyncUsers = async (
+    enterpriseConnectionId: string,
+    params?: GetDirectorySyncUsersParams,
+  ): Promise<ClerkPaginatedResponse<DirectorySyncUserResource>> => {
+    const res = await BaseResource._fetch({
+      path: `/organizations/${this.id}/enterprise_connections/${enterpriseConnectionId}/directory/users`,
+      method: 'GET',
+      search: convertPageToOffsetSearchParams(params),
+    });
+
+    const payload = res?.response as unknown as ClerkPaginatedResponse<DirectorySyncUserJSON> | undefined;
+
+    return {
+      total_count: payload?.total_count ?? 0,
+      data: (payload?.data ?? []).map(row => new DirectorySyncUser(row)),
+    };
+  };
+
   getMembershipRequests = async (
     getRequestParam?: GetMembershipRequestParams,
   ): Promise<ClerkPaginatedResponse<OrganizationMembershipRequestResource>> => {

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

@@ -108,6 +108,7 @@ export class UserSettings extends BaseResource implements UserSettingsResource {
   enterpriseSSO: EnterpriseSSOSettings = {
     enabled: false,
     self_serve_sso: false,
+    self_serve_directory_sync: false,
   };
   passkeySettings: PasskeySettingsData = {
     allow_autofill: false,
@@ -225,7 +226,10 @@ export class UserSettings extends BaseResource implements UserSettingsResource {
           this.attackProtection.enumeration_protection.enabled,
       },
     };
-    this.enterpriseSSO = this.withDefault(data.enterprise_sso, this.enterpriseSSO);
+    this.enterpriseSSO = {
+      ...this.withDefault(data.enterprise_sso, this.enterpriseSSO),
+      self_serve_directory_sync: data.enterprise_sso?.self_serve_directory_sync ?? false,
+    };
     this.passkeySettings = this.withDefault(data.passkey_settings, this.passkeySettings);
     this.passwordSettings = data.password_settings
       ? {