remove deprecated properties for v8

nicknisi · nicknisi · commit e94316236124 · 2025-10-07T14:57:42.000-05:00
diff --git a/package.json b/package.json
@@ -36,7 +36,8 @@
     "check:runtimes": "tsx scripts/ecosystem-check.ts",
     "prettier": "prettier \"src/**/*.{js,ts,tsx}\" --check",
     "format": "prettier \"src/**/*.{js,ts,tsx}\" --write",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
     "iron-session": "^8.0.4",
diff --git a/src/client/user-management.ts b/src/client/user-management.ts
@@ -6,11 +6,6 @@ export interface AuthorizationURLOptions {
   codeChallenge?: string;
   codeChallengeMethod?: 'S256';
   connectionId?: string;
-  /**
-   *  @deprecated We previously required initiate login endpoints to return the `context`
-   *  query parameter when getting the authorization URL. This is no longer necessary.
-   */
-  context?: string;
   organizationId?: string;
   domainHint?: string;
   loginHint?: string;
@@ -43,7 +38,6 @@ export function getAuthorizationUrl(
     connectionId,
     codeChallenge,
     codeChallengeMethod,
-    context,
     clientId,
     domainHint,
     loginHint,
@@ -70,18 +64,10 @@ export function getAuthorizationUrl(
     );
   }
 
-  if (context) {
-    console.warn(
-      `WorkOS: \`context\` is deprecated. We previously required initiate login endpoints to return the
-\`context\` query parameter when getting the authorization URL. This is no longer necessary.`,
-    );
-  }
-
   const query = toQueryString({
     connection_id: connectionId,
     code_challenge: codeChallenge,
     code_challenge_method: codeChallengeMethod,
-    context,
     organization_id: organizationId,
     domain_hint: domainHint,
     login_hint: loginHint,
diff --git a/src/directory-sync/directory-sync.spec.ts b/src/directory-sync/directory-sync.spec.ts
@@ -81,21 +81,12 @@ describe('DirectorySync', () => {
     directoryId: 'dir_123',
     organizationId: 'org_123',
     email: 'jonsnow@workos.com',
-    emails: [
-      {
-        primary: true,
-        type: 'type',
-        value: 'jonsnow@workos.com',
-      },
-    ],
     firstName: 'Jon',
     groups: [group],
     idpId: 'idp_foo',
     lastName: 'Snow',
-    jobTitle: 'Knight of the Watch',
     rawAttributes: {},
     state: 'active',
-    username: 'jonsnow',
     createdAt: '2021-10-27 15:21:50.640959',
     updatedAt: '2021-12-13 12:15:45.531847',
   };
@@ -109,21 +100,12 @@ describe('DirectorySync', () => {
     directory_id: 'dir_123',
     organization_id: 'org_123',
     email: 'jonsnow@workos.com',
-    emails: [
-      {
-        primary: true,
-        type: 'type',
-        value: 'jonsnow@workos.com',
-      },
-    ],
     first_name: 'Jon',
     groups: [groupResponse],
     idp_id: 'idp_foo',
     last_name: 'Snow',
-    job_title: 'Knight of the Watch',
     raw_attributes: {},
     state: 'active',
-    username: 'jonsnow',
     created_at: '2021-10-27 15:21:50.640959',
     updated_at: '2021-12-13 12:15:45.531847',
   };
@@ -137,21 +119,12 @@ describe('DirectorySync', () => {
     directoryId: 'dir_123',
     organizationId: 'org_123',
     email: 'jonsnow@workos.com',
-    emails: [
-      {
-        primary: true,
-        type: 'type',
-        value: 'jonsnow@workos.com',
-      },
-    ],
     firstName: 'Jon',
     groups: [group],
     idpId: 'idp_foo',
     lastName: 'Snow',
-    jobTitle: 'Knight of the Watch',
     rawAttributes: {},
     state: 'active',
-    username: 'jonsnow',
     role: { slug: 'super_admin' },
     createdAt: '2021-10-27 15:21:50.640959',
     updatedAt: '2021-12-13 12:15:45.531847',
@@ -166,21 +139,12 @@ describe('DirectorySync', () => {
     directory_id: 'dir_123',
     organization_id: 'org_123',
     email: 'jonsnow@workos.com',
-    emails: [
-      {
-        primary: true,
-        type: 'type',
-        value: 'jonsnow@workos.com',
-      },
-    ],
     first_name: 'Jon',
     groups: [groupResponse],
     idp_id: 'idp_foo',
     last_name: 'Snow',
-    job_title: 'Knight of the Watch',
     raw_attributes: {},
     state: 'active',
-    username: 'jonsnow',
     role: { slug: 'super_admin' },
     created_at: '2021-10-27 15:21:50.640959',
     updated_at: '2021-12-13 12:15:45.531847',
diff --git a/src/directory-sync/interfaces/directory-user.interface.ts b/src/directory-sync/interfaces/directory-user.interface.ts
@@ -19,26 +19,7 @@ export interface DirectoryUser<
   idpId: string;
   firstName: string | null;
   email: string | null;
-  /** @deprecated Will be removed in a future major version.
-   * Enable the `emails` custom attribute in dashboard and pull from customAttributes instead.
-   * See https://workos.com/docs/directory-sync/attributes/custom-attributes/auto-mapped-attributes for details.
-   */
-  emails: {
-    type?: string;
-    value?: string;
-    primary?: boolean;
-  }[];
-  /** @deprecated Will be removed in a future major version.
-   * Enable the `username` custom attribute in dashboard and pull from customAttributes instead.
-   * See https://workos.com/docs/directory-sync/attributes/custom-attributes/auto-mapped-attributes for details.
-   */
-  username: string | null;
   lastName: string | null;
-  /** @deprecated Will be removed in a future major version.
-   * Enable the `job_title` custom attribute in dashboard and pull from customAttributes instead.
-   * See https://workos.com/docs/directory-sync/attributes/custom-attributes/auto-mapped-attributes for details.
-   */
-  jobTitle: string | null;
   state: 'active' | 'inactive';
   role?: RoleResponse;
   createdAt: string;
@@ -58,26 +39,7 @@ export interface DirectoryUserResponse<
   idp_id: string;
   first_name: string | null;
   email: string | null;
-  /** @deprecated Will be removed in a future major version.
-   * Enable the `emails` custom attribute in dashboard and pull from customAttributes instead.
-   * See https://workos.com/docs/directory-sync/attributes/custom-attributes/auto-mapped-attributes for details.
-   */
-  emails: {
-    type?: string;
-    value?: string;
-    primary?: boolean;
-  }[];
-  /** @deprecated Will be removed in a future major version.
-   * Enable the `username` custom attribute in dashboard and pull from customAttributes instead.
-   * See https://workos.com/docs/directory-sync/attributes/custom-attributes/auto-mapped-attributes for details.
-   */
-  username: string | null;
   last_name: string | null;
-  /** @deprecated Will be removed in a future major version.
-   * Enable the `job_title` custom attribute in dashboard and pull from customAttributes instead.
-   * See https://workos.com/docs/directory-sync/attributes/custom-attributes/auto-mapped-attributes for details.
-   */
-  job_title: string | null;
   state: 'active' | 'inactive';
   role?: RoleResponse;
   created_at: string;
diff --git a/src/directory-sync/serializers/directory-user.serializer.ts b/src/directory-sync/serializers/directory-user.serializer.ts
@@ -23,10 +23,7 @@ export const deserializeDirectoryUser = <
   idpId: directoryUser.idp_id,
   firstName: directoryUser.first_name,
   email: directoryUser.email,
-  emails: directoryUser.emails,
-  username: directoryUser.username,
   lastName: directoryUser.last_name,
-  jobTitle: directoryUser.job_title,
   state: directoryUser.state,
   role: directoryUser.role,
   createdAt: directoryUser.created_at,
@@ -54,10 +51,7 @@ export const deserializeUpdatedEventDirectoryUser = (
   idpId: directoryUser.idp_id,
   firstName: directoryUser.first_name,
   email: directoryUser.email,
-  emails: directoryUser.emails,
-  username: directoryUser.username,
   lastName: directoryUser.last_name,
-  jobTitle: directoryUser.job_title,
   state: directoryUser.state,
   role: directoryUser.role,
   createdAt: directoryUser.created_at,
diff --git a/src/directory-sync/utils/get-primary-email.spec.ts b/src/directory-sync/utils/get-primary-email.spec.ts
diff --git a/src/directory-sync/utils/get-primary-email.ts b/src/directory-sync/utils/get-primary-email.ts
diff --git a/src/events/events.spec.ts b/src/events/events.spec.ts
@@ -129,20 +129,11 @@ describe('Event', () => {
             directoryId: 'dir_123',
             organizationId: 'org_123',
             email: 'jonsnow@workos.com',
-            emails: [
-              {
-                primary: true,
-                type: 'type',
-                value: 'jonsnow@workos.com',
-              },
-            ],
             firstName: 'Jon',
             idpId: 'idp_foo',
             lastName: 'Snow',
-            jobTitle: 'Knight of the Watch',
             rawAttributes: {},
             state: 'active',
-            username: 'jonsnow',
             role: { slug: 'super_admin' },
             previousAttributes: {
               role: { slug: 'member' },
@@ -165,20 +156,11 @@ describe('Event', () => {
             directory_id: 'dir_123',
             organization_id: 'org_123',
             email: 'jonsnow@workos.com',
-            emails: [
-              {
-                primary: true,
-                type: 'type',
-                value: 'jonsnow@workos.com',
-              },
-            ],
             first_name: 'Jon',
             idp_id: 'idp_foo',
             last_name: 'Snow',
-            job_title: 'Knight of the Watch',
             raw_attributes: {},
             state: 'active',
-            username: 'jonsnow',
             role: { slug: 'super_admin' },
             previous_attributes: {
               role: { slug: 'member' },
diff --git a/src/index.ts b/src/index.ts
@@ -15,7 +15,6 @@ export * from './common/exceptions';
 export * from './common/interfaces';
 export * from './common/utils/pagination';
 export * from './directory-sync/interfaces';
-export * from './directory-sync/utils/get-primary-email';
 export * from './events/interfaces';
 export * from './fga/interfaces';
 export * from './organizations/interfaces';
diff --git a/src/index.worker.ts b/src/index.worker.ts
@@ -13,7 +13,6 @@ export * from './common/exceptions';
 export * from './common/interfaces';
 export * from './common/utils/pagination';
 export * from './directory-sync/interfaces';
-export * from './directory-sync/utils/get-primary-email';
 export * from './events/interfaces';
 export * from './fga/interfaces';
 export * from './organizations/interfaces';
diff --git a/src/organization-domains/interfaces/organization-domain.interface.ts b/src/organization-domains/interfaces/organization-domain.interface.ts
@@ -1,8 +1,4 @@
 export enum OrganizationDomainState {
-  /**
-   * @deprecated
-   */
-  LegacyVerified = 'legacy_verified',
   Verified = 'verified',
   Pending = 'pending',
   Failed = 'failed',
diff --git a/src/user-management/interfaces/authorization-url-options.interface.ts b/src/user-management/interfaces/authorization-url-options.interface.ts
@@ -3,11 +3,6 @@ export interface UserManagementAuthorizationURLOptions {
   codeChallenge?: string;
   codeChallengeMethod?: 'S256';
   connectionId?: string;
-  /**
-   *  @deprecated We previously required initiate login endpoints to return the `context`
-   *  query parameter when getting the authorization URL. This is no longer necessary.
-   */
-  context?: string;
   organizationId?: string;
   domainHint?: string;
   loginHint?: string;
diff --git a/src/webhooks/fixtures/webhook.json b/src/webhooks/fixtures/webhook.json
@@ -3,19 +3,10 @@
   "data": {
     "id": "directory_user_01FAEAJCR3ZBZ30D8BD1924TVG",
     "state": "active",
-    "emails": [
-      {
-        "type": "work",
-        "value": "blair@foo-corp.com",
-        "primary": true
-      }
-    ],
     "idp_id": "00u1e8mutl6wlH3lL4x7",
     "object": "directory_user",
-    "username": "blair@foo-corp.com",
     "last_name": "Lunchford",
     "first_name": "Blair",
-    "job_title": "Software Engineer",
     "directory_id": "directory_01F9M7F68PZP8QXP8G7X5QRHS7",
     "created_at": "2021-06-25T19:07:33.155Z",
     "updated_at": "2021-06-25T19:07:33.155Z",
@@ -28,20 +19,12 @@
       },
       "title": "Software Engineer",
       "active": true,
-      "emails": [
-        {
-          "type": "work",
-          "value": "blair@foo-corp.com",
-          "primary": true
-        }
-      ],
       "groups": [],
       "locale": "en-US",
       "schemas": [
         "urn:ietf:params:scim:schemas:core:2.0:User",
         "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
       ],
-      "userName": "blair@foo-corp.com",
       "addresses": [
         {
           "region": "CA",
@@ -64,4 +47,5 @@
   },
   "event": "dsync.user.created",
   "created_at": "2021-06-25T19:07:33.155Z"
-}
+}
+
diff --git a/src/webhooks/webhooks.spec.ts b/src/webhooks/webhooks.spec.ts
