rename and deprecate the AuthorizationURLOptions interfaces (#1282)

Author: nicknisi

src/sso/interfaces/authorization-url-options.interface.ts

@@ -1,4 +1,4 @@
-export interface AuthorizationURLOptions {
+export interface SSOAuthorizationURLOptions {
   clientId: string;
   connection?: string;
   organization?: string;
@@ -13,3 +13,9 @@ export interface AuthorizationURLOptions {
   redirectUri: string;
   state?: string;
 }
+
+/**
+ * @deprecated Use SSOAuthorizationURLOptions instead
+ */
+// tslint:disable-next-line:no-empty-interface
+export interface AuthorizationURLOptions extends SSOAuthorizationURLOptions {}

src/sso/sso.ts

@@ -1,7 +1,8 @@
+import { UnknownRecord } from '../common/interfaces/unknown-record.interface';
+import { fetchAndDeserialize } from '../common/utils/fetch-and-deserialize';
 import { AutoPaginatable } from '../common/utils/pagination';
 import { WorkOS } from '../workos';
 import {
-  AuthorizationURLOptions,
   Connection,
   ConnectionResponse,
   GetProfileAndTokenOptions,
@@ -11,15 +12,14 @@ import {
   ProfileAndToken,
   ProfileAndTokenResponse,
   ProfileResponse,
+  SSOAuthorizationURLOptions,
 } from './interfaces';
 import {
   deserializeConnection,
   deserializeProfile,
   deserializeProfileAndToken,
   serializeListConnectionsOptions,
 } from './serializers';
-import { fetchAndDeserialize } from '../common/utils/fetch-and-deserialize';
-import { UnknownRecord } from '../common/interfaces/unknown-record.interface';
 
 const toQueryString = (options: Record<string, string | undefined>): string => {
   const searchParams = new URLSearchParams();
@@ -73,7 +73,7 @@ export class SSO {
     provider,
     redirectUri,
     state,
-  }: AuthorizationURLOptions): string {
+  }: SSOAuthorizationURLOptions): string {
     if (!domain && !provider && !connection && !organization) {
       throw new Error(
         `Incomplete arguments. Need to specify either a 'connection', 'organization', 'domain', or 'provider'.`,

src/user-management/interfaces/authorization-url-options.interface.ts

@@ -1,4 +1,4 @@
-export interface AuthorizationURLOptions {
+export interface UserManagementAuthorizationURLOptions {
   clientId: string;
   codeChallenge?: string;
   codeChallengeMethod?: 'S256';

src/user-management/interfaces/index.ts

@@ -8,8 +8,9 @@ export * from './authenticate-with-refresh-token-options.interface';
 export * from './authenticate-with-session-cookie.interface';
 export * from './authenticate-with-totp-options.interface';
 export * from './authentication-event.interface';
-export * from './authentication-response.interface';
 export * from './authentication-radar-risk-detected-event.interface';
+export * from './authentication-response.interface';
+export * from './authorization-url-options.interface';
 export * from './create-magic-auth-options.interface';
 export * from './create-organization-membership-options.interface';
 export * from './create-password-reset-options.interface';

src/user-management/user-management.ts

@@ -1,5 +1,6 @@
 import { createRemoteJWKSet, decodeJwt, jwtVerify } from 'jose';
 import { OauthException } from '../common/exceptions/oauth.exception';
+import { IronSessionProvider } from '../common/iron-session/iron-session-provider';
 import { fetchAndDeserialize } from '../common/utils/fetch-and-deserialize';
 import { AutoPaginatable } from '../common/utils/pagination';
 import { Challenge, ChallengeResponse } from '../mfa/interfaces';
@@ -63,7 +64,7 @@ import {
   AuthenticateWithSessionCookieSuccessResponse,
   SessionCookieData,
 } from './interfaces/authenticate-with-session-cookie.interface';
-import { AuthorizationURLOptions } from './interfaces/authorization-url-options.interface';
+import { UserManagementAuthorizationURLOptions } from './interfaces/authorization-url-options.interface';
 import {
   CreateOrganizationMembershipOptions,
   SerializedCreateOrganizationMembershipOptions,
@@ -136,7 +137,6 @@ import { serializeListUsersOptions } from './serializers/list-users-options.seri
 import { deserializeOrganizationMembership } from './serializers/organization-membership.serializer';
 import { serializeSendInvitationOptions } from './serializers/send-invitation-options.serializer';
 import { serializeUpdateOrganizationMembershipOptions } from './serializers/update-organization-membership-options.serializer';
-import { IronSessionProvider } from '../common/iron-session/iron-session-provider';
 import { Session } from './session';
 
 const toQueryString = (options: Record<string, string | undefined>): string => {
@@ -994,7 +994,7 @@ export class UserManagement {
     redirectUri,
     state,
     screenHint,
-  }: AuthorizationURLOptions): string {
+  }: UserManagementAuthorizationURLOptions): string {
     if (!provider && !connectionId && !organizationId) {
       throw new TypeError(
         `Incomplete arguments. Need to specify either a 'connectionId', 'organizationId', or 'provider'.`,