@workos-inc/node 2.3.0 → 2.4.0

package/lib/sso/interfaces/authorization-url-options.interface.d.ts

@@ -6,6 +6,8 @@ export interface AuthorizationURLOptions {
      * @deprecated Please use `organization` instead.
      */
     domain?: string;
+    domainHint?: string;
+    loginHint?: string;
     provider?: string;
     redirectURI: string;
     state?: string;

package/lib/sso/sso.d.ts

@@ -11,7 +11,7 @@ export declare class SSO {
     private readonly workos;
     constructor(workos: WorkOS);
     deleteConnection(id: string): Promise<void>;
-    getAuthorizationURL({ connection, clientID, domain, organization, provider, redirectURI, state, }: AuthorizationURLOptions): string;
+    getAuthorizationURL({ connection, clientID, domain, domainHint, loginHint, organization, provider, redirectURI, state, }: AuthorizationURLOptions): string;
     getConnection(id: string): Promise<Connection>;
     getProfileAndToken({ code, clientID, }: GetProfileAndTokenOptions): Promise<ProfileAndToken>;
     getProfile({ accessToken }: GetProfileOptions): Promise<Profile>;

package/lib/sso/sso.js

@@ -23,7 +23,7 @@ class SSO {
             yield this.workos.delete(`/connections/${id}`);
         });
     }
-    getAuthorizationURL({ connection, clientID, domain, organization, provider, redirectURI, state, }) {
+    getAuthorizationURL({ connection, clientID, domain, domainHint, loginHint, organization, provider, redirectURI, state, }) {
         if (!domain && !provider && !connection && !organization) {
             throw new Error(`Incomplete arguments. Need to specify either a 'connection', 'organization', 'domain', or 'provider'.`);
         }
@@ -34,6 +34,8 @@ class SSO {
             connection,
             organization,
             domain,
+            domain_hint: domainHint,
+            login_hint: loginHint,
             provider,
             client_id: clientID,
             redirect_uri: redirectURI,

package/lib/sso/sso.spec.js

@@ -103,6 +103,32 @@ describe('SSO', () => {
                     expect(url).toMatchSnapshot();
                 });
             });
+            describe('with domainHint', () => {
+                it('generates an authorize url with the provided domain hint', () => {
+                    const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                    const url = workos.sso.getAuthorizationURL({
+                        domainHint: 'lyft.com',
+                        connection: 'connection_123',
+                        clientID: 'proj_123',
+                        redirectURI: 'example.com/sso/workos/callback',
+                        state: 'custom state',
+                    });
+                    expect(url).toMatchInlineSnapshot(`"https://api.workos.com/sso/authorize?client_id=proj_123&connection=connection_123&domain_hint=lyft.com&redirect_uri=example.com%2Fsso%2Fworkos%2Fcallback&response_type=code&state=custom%20state"`);
+                });
+            });
+            describe('with loginHint', () => {
+                it('generates an authorize url with the provided login hint', () => {
+                    const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                    const url = workos.sso.getAuthorizationURL({
+                        loginHint: 'foo@workos.com',
+                        connection: 'connection_123',
+                        clientID: 'proj_123',
+                        redirectURI: 'example.com/sso/workos/callback',
+                        state: 'custom state',
+                    });
+                    expect(url).toMatchInlineSnapshot(`"https://api.workos.com/sso/authorize?client_id=proj_123&connection=connection_123&login_hint=foo%40workos.com&redirect_uri=example.com%2Fsso%2Fworkos%2Fcallback&response_type=code&state=custom%20state"`);
+                });
+            });
         });
         describe('getProfileAndToken', () => {
             describe('with all information provided', () => {

package/lib/workos.js

@@ -22,7 +22,7 @@ const passwordless_1 = require("./passwordless/passwordless");
 const portal_1 = require("./portal/portal");
 const sso_1 = require("./sso/sso");
 const webhooks_1 = require("./webhooks/webhooks");
-const VERSION = '2.3.0';
+const VERSION = '2.4.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.3.0",
+  "version": "2.4.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -43,11 +43,11 @@
     "@types/node": "14.18.0",
     "@types/pluralize": "0.0.29",
     "axios-mock-adapter": "1.20.0",
-    "jest": "27.4.4",
+    "jest": "27.4.5",
     "prettier": "2.5.1",
     "supertest": "6.1.6",
     "ts-jest": "27.1.1",
     "tslint": "6.1.3",
-    "typescript": "4.5.3"
+    "typescript": "4.5.4"
   }
 }