@axinom/mosaic-user-auth 0.4.4 → 0.5.0-rc.0

package/dist/index.js

@@ -59,7 +59,7 @@ function commonjsRequire () {
 
 var enums = createCommonjsModule(function (module, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DecryptNativeCookieResponseCode = exports.IdpProtocol = exports.CheckOtpResponseCode = exports.CompleteUserSignUpResponseCode = exports.UserSignUpResponseCode = exports.ROPCPasswordResponseCode = exports.ROPCSignInResponseCode = exports.IdpConfigurationResponseCode = exports.SignOutResponseCode = exports.TokenResponseCode = void 0;
+exports.DecryptNativeCookieResponseCode = exports.IdpProtocol = exports.CheckOtpResponseCode = exports.CompleteUserSignUpResponseCode = exports.UserSignUpResponseCode = exports.ResetPasswordResponseCode = exports.SignInResponseCode = exports.IdpConfigurationResponseCode = exports.SignOutResponseCode = exports.TokenResponseCode = void 0;
 /**
  * Token response code from User Service Auth API
  */
@@ -94,27 +94,27 @@ var IdpConfigurationResponseCode;
     IdpConfigurationResponseCode["INTERNAL_SERVER_ERROR"] = "INTERNAL_SERVER_ERROR";
 })(IdpConfigurationResponseCode = exports.IdpConfigurationResponseCode || (exports.IdpConfigurationResponseCode = {}));
 /**
- * ROPC Sign In Response Code from User Service Auth API
+ * Sign In With Credentials Response Code from User Service Auth API
  */
-var ROPCSignInResponseCode;
-(function (ROPCSignInResponseCode) {
-    ROPCSignInResponseCode["SUCCESS"] = "SUCCESS";
-    ROPCSignInResponseCode["INTERNAL_SERVER_ERROR"] = "INTERNAL_SERVER_ERROR";
-    ROPCSignInResponseCode["BAD_REQUEST"] = "BAD_REQUEST";
-    ROPCSignInResponseCode["AUTH_FLOW_ERROR"] = "AUTH_FLOW_ERROR";
-    ROPCSignInResponseCode["SERVICE_CONFIGURATION_ERROR"] = "SERVICE_CONFIGURATION_ERROR";
-})(ROPCSignInResponseCode = exports.ROPCSignInResponseCode || (exports.ROPCSignInResponseCode = {}));
+var SignInResponseCode;
+(function (SignInResponseCode) {
+    SignInResponseCode["SUCCESS"] = "SUCCESS";
+    SignInResponseCode["INTERNAL_SERVER_ERROR"] = "INTERNAL_SERVER_ERROR";
+    SignInResponseCode["BAD_REQUEST"] = "BAD_REQUEST";
+    SignInResponseCode["AUTH_FLOW_ERROR"] = "AUTH_FLOW_ERROR";
+    SignInResponseCode["SERVICE_CONFIGURATION_ERROR"] = "SERVICE_CONFIGURATION_ERROR";
+})(SignInResponseCode = exports.SignInResponseCode || (exports.SignInResponseCode = {}));
 /**
- * ROPC Password Reset/Complete Password Reset Code from User Service Auth API
+ * Sign In With Credentials Password Reset/Complete Password Reset Code from User Service Auth API
  */
-var ROPCPasswordResponseCode;
-(function (ROPCPasswordResponseCode) {
-    ROPCPasswordResponseCode["SUCCESS"] = "SUCCESS";
-    ROPCPasswordResponseCode["ERROR"] = "ERROR";
-    ROPCPasswordResponseCode["SERVICE_CONFIGURATION_ERROR"] = "SERVICE_CONFIGURATION_ERROR";
-})(ROPCPasswordResponseCode = exports.ROPCPasswordResponseCode || (exports.ROPCPasswordResponseCode = {}));
+var ResetPasswordResponseCode;
+(function (ResetPasswordResponseCode) {
+    ResetPasswordResponseCode["SUCCESS"] = "SUCCESS";
+    ResetPasswordResponseCode["ERROR"] = "ERROR";
+    ResetPasswordResponseCode["SERVICE_CONFIGURATION_ERROR"] = "SERVICE_CONFIGURATION_ERROR";
+})(ResetPasswordResponseCode = exports.ResetPasswordResponseCode || (exports.ResetPasswordResponseCode = {}));
 /**
- * ROPC Sign Up Response Code from User Service Auth API
+ * Sign Up With Credential Response Code from User Service Auth API
  */
 var UserSignUpResponseCode;
 (function (UserSignUpResponseCode) {
@@ -123,7 +123,7 @@ var UserSignUpResponseCode;
     UserSignUpResponseCode["SERVICE_CONFIGURATION_ERROR"] = "SERVICE_CONFIGURATION_ERROR";
 })(UserSignUpResponseCode = exports.UserSignUpResponseCode || (exports.UserSignUpResponseCode = {}));
 /**
- * Verify ROPC Sign Up Response Code from User Service Auth API
+ * Verify Sign Up With Credential Response Code from User Service Auth API
  */
 var CompleteUserSignUpResponseCode;
 (function (CompleteUserSignUpResponseCode) {
@@ -1660,15 +1660,15 @@ const getWellKnownEndpoints = (userAuthConfig) => __awaiter(void 0, void 0, void
     return userServiceEndpoints;
 });
 /**
- * Perform a user sign in process according to the ROPC flow.
+ * Perform a user sign in process according to the SignInWithCredentials flow.
  *
  * @param userAuthConfig An object containing user authentication info.
  * @param axAuthConnectionId The IDP Connection ID for AX_AUTH as configured for the application.
- * @param ropcSignInRequest Sign info (email, password).
+ * @param signInRequest Sign info (email, password).
  * @returns
  */
-const performROPCSignIn = (userAuthConfig, axAuthConnectionId, ropcSignInRequest) => __awaiter(void 0, void 0, void 0, function* () {
-    const signInURL = new URL(`${userAuthConfig.tenantId}/${userAuthConfig.environmentId}/${userAuthConfig.applicationId}/ropc-sign-in`, userAuthConfig.userAuthBaseUrl);
+const performSignInWithCredentials = (userAuthConfig, axAuthConnectionId, signInRequest) => __awaiter(void 0, void 0, void 0, function* () {
+    const signInURL = new URL(`${userAuthConfig.tenantId}/${userAuthConfig.environmentId}/${userAuthConfig.applicationId}/sign-in-with-credentials`, userAuthConfig.userAuthBaseUrl);
     const signInResponse = yield (yield fetch(signInURL.href, {
         method: 'POST',
         cache: 'no-cache',
@@ -1678,7 +1678,7 @@ const performROPCSignIn = (userAuthConfig, axAuthConnectionId, ropcSignInRequest
         headers: {
             'Content-Type': 'application/json',
         },
-        body: JSON.stringify(Object.assign(Object.assign({}, ropcSignInRequest), { connectionId: axAuthConnectionId })),
+        body: JSON.stringify(Object.assign(Object.assign({}, signInRequest), { connectionId: axAuthConnectionId })),
     })).json();
     return signInResponse;
 });
@@ -1806,12 +1806,12 @@ const initiatePasswordReset = (email, axAuthClientId, axAuthManagementEndpoint)
     })).json();
     if (initiateResetPasswordResponse.errors !== undefined) {
         return {
-            code: dist.ROPCPasswordResponseCode.ERROR,
+            code: dist.ResetPasswordResponseCode.ERROR,
             message: initiateResetPasswordResponse.errors[0].message,
         };
     }
     return {
-        code: dist.ROPCPasswordResponseCode.SUCCESS,
+        code: dist.ResetPasswordResponseCode.SUCCESS,
     };
 });
 /**
@@ -1872,12 +1872,12 @@ const completePasswordReset = (completePasswordResetRequest, axAuthManagementEnd
     })).json();
     if (completePasswordResetResponse.errors !== undefined) {
         return {
-            code: dist.ROPCPasswordResponseCode.ERROR,
+            code: dist.ResetPasswordResponseCode.ERROR,
             message: completePasswordResetResponse.errors[0].message,
         };
     }
     return {
-        code: dist.ROPCPasswordResponseCode.SUCCESS,
+        code: dist.ResetPasswordResponseCode.SUCCESS,
     };
 });
 const getIdpConfigurations = (userAuthConfig) => __awaiter(void 0, void 0, void 0, function* () {
@@ -2267,7 +2267,7 @@ class UserServiceClient {
         this.tokenRenewalMethod = tokenRenewalMethod;
         this._tokenChangedHandlers = [];
         this._tokenResponse = null;
-        this._ropcEndpointResponse = null;
+        this._signInWithCredentialsEndpointResponse = null;
         this.emitTokenChanged = (token) => {
             this._tokenChangedHandlers.forEach((handler) => handler(token));
         };
@@ -2298,19 +2298,19 @@ class UserServiceClient {
         });
         /**
          * Call the well-known endpoint of ax-user-service and retrieves endpoints related to AxAuth.
-         * @returns ROPCEndpointResponse
+         * @returns SignInWithCredentialsEndpointResponse
          */
-        this.getROPCEndpoints = () => __awaiter(this, void 0, void 0, function* () {
+        this.getSignInWithCredentialsEndpoints = () => __awaiter(this, void 0, void 0, function* () {
             try {
-                if (this._ropcEndpointResponse === null) {
+                if (this._signInWithCredentialsEndpointResponse === null) {
                     const endpoints = yield getWellKnownEndpoints(this.userAuthConfig);
-                    this._ropcEndpointResponse = {
+                    this._signInWithCredentialsEndpointResponse = {
                         code: 'SUCCESS',
                         managementEndpoint: endpoints.axAuthManagementGQL,
                         authEndpoint: endpoints.axAuthEndpoint,
                     };
                 }
-                return this._ropcEndpointResponse;
+                return this._signInWithCredentialsEndpointResponse;
             }
             catch (error) {
                 assertError(error);
@@ -2343,7 +2343,7 @@ class UserServiceClient {
          * Based on the outcome of this function, an end-user application can conditionally offer the option to Sign-In directly
          * via email & password.
          *
-         * @see {@link ropcSignIn}
+         * @see {@link signInWithCredentials}
          *
          * @returns a boolean indicating if the Mosaic application has an AxAuth IDP provider configured and it is enabled.
          */
@@ -2353,21 +2353,21 @@ class UserServiceClient {
             return this._axAuthIdpConfig !== undefined;
         });
         /**
-         * Starts a ROPC Sign-In flow using the AX_AUTH IDP configured for the application.
+         * Starts a SignInWithCredentials flow using the AX_AUTH IDP configured for the application.
          *
-         * @param ropcSignInRequest
-         * @returns `ROPCSignInResponse`
+         * @param signInRequest
+         * @returns `SignInResponse`
          */
-        this.ropcSignIn = (ropcSignInRequest) => __awaiter(this, void 0, void 0, function* () {
+        this.signInWithCredentials = (signInRequest) => __awaiter(this, void 0, void 0, function* () {
             var _b, _c;
             if (((_b = this._axAuthIdpConfig) === null || _b === void 0 ? void 0 : _b.idpConnectionId) !== undefined) {
-                const result = yield performROPCSignIn(this.userAuthConfig, (_c = this._axAuthIdpConfig) === null || _c === void 0 ? void 0 : _c.idpConnectionId, ropcSignInRequest);
+                const result = yield performSignInWithCredentials(this.userAuthConfig, (_c = this._axAuthIdpConfig) === null || _c === void 0 ? void 0 : _c.idpConnectionId, signInRequest);
                 return result;
             }
             else {
                 return {
-                    code: dist.ROPCSignInResponseCode.SERVICE_CONFIGURATION_ERROR,
-                    message: 'No IDP has configured for ROPC sign-in.',
+                    code: dist.SignInResponseCode.SERVICE_CONFIGURATION_ERROR,
+                    message: 'No IDP has configured for sign in with credentials.',
                 };
             }
         });
@@ -2385,9 +2385,10 @@ class UserServiceClient {
             }
             if (this._axAuthIdpConfig !== undefined &&
                 this._axAuthIdpConfig.clientId !== null &&
-                ((_d = this._ropcEndpointResponse) === null || _d === void 0 ? void 0 : _d.managementEndpoint) !== undefined) {
+                ((_d = this._signInWithCredentialsEndpointResponse) === null || _d === void 0 ? void 0 : _d.managementEndpoint) !==
+                    undefined) {
                 const signUpRequest = Object.assign(Object.assign({}, userSignUpRequest), { oAuthClientId: this._axAuthIdpConfig.clientId });
-                const result = yield initiateUserSignUp(signUpRequest, this._ropcEndpointResponse.managementEndpoint);
+                const result = yield initiateUserSignUp(signUpRequest, this._signInWithCredentialsEndpointResponse.managementEndpoint);
                 return result;
             }
             else {
@@ -2411,8 +2412,9 @@ class UserServiceClient {
             }
             if (this._axAuthIdpConfig !== undefined &&
                 this._axAuthIdpConfig.clientId !== null &&
-                ((_e = this._ropcEndpointResponse) === null || _e === void 0 ? void 0 : _e.managementEndpoint) !== undefined) {
-                const result = yield checkUserSignUpOtp(checkUserSignUpOtpRequest, this._ropcEndpointResponse.managementEndpoint);
+                ((_e = this._signInWithCredentialsEndpointResponse) === null || _e === void 0 ? void 0 : _e.managementEndpoint) !==
+                    undefined) {
+                const result = yield checkUserSignUpOtp(checkUserSignUpOtpRequest, this._signInWithCredentialsEndpointResponse.managementEndpoint);
                 return result;
             }
             else {
@@ -2432,8 +2434,9 @@ class UserServiceClient {
          */
         this.completeUserSignUp = (completeUserSignUpRequest) => __awaiter(this, void 0, void 0, function* () {
             var _f;
-            if (((_f = this._ropcEndpointResponse) === null || _f === void 0 ? void 0 : _f.managementEndpoint) !== undefined) {
-                const result = yield completeUserSignUp(completeUserSignUpRequest, this._ropcEndpointResponse.managementEndpoint);
+            if (((_f = this._signInWithCredentialsEndpointResponse) === null || _f === void 0 ? void 0 : _f.managementEndpoint) !==
+                undefined) {
+                const result = yield completeUserSignUp(completeUserSignUpRequest, this._signInWithCredentialsEndpointResponse.managementEndpoint);
                 return result;
             }
             else {
@@ -2459,13 +2462,14 @@ class UserServiceClient {
             }
             if (this._axAuthIdpConfig !== undefined &&
                 this._axAuthIdpConfig.clientId !== null &&
-                ((_g = this._ropcEndpointResponse) === null || _g === void 0 ? void 0 : _g.managementEndpoint) !== undefined) {
-                const result = yield initiatePasswordReset(email, this._axAuthIdpConfig.clientId, this._ropcEndpointResponse.managementEndpoint);
+                ((_g = this._signInWithCredentialsEndpointResponse) === null || _g === void 0 ? void 0 : _g.managementEndpoint) !==
+                    undefined) {
+                const result = yield initiatePasswordReset(email, this._axAuthIdpConfig.clientId, this._signInWithCredentialsEndpointResponse.managementEndpoint);
                 return result;
             }
             else {
                 return {
-                    code: dist.ROPCPasswordResponseCode.SERVICE_CONFIGURATION_ERROR,
+                    code: dist.ResetPasswordResponseCode.SERVICE_CONFIGURATION_ERROR,
                     message: 'No IDP has been configured to handle password reset.',
                 };
             }
@@ -2484,8 +2488,9 @@ class UserServiceClient {
             }
             if (this._axAuthIdpConfig !== undefined &&
                 this._axAuthIdpConfig.clientId !== null &&
-                ((_h = this._ropcEndpointResponse) === null || _h === void 0 ? void 0 : _h.managementEndpoint) !== undefined) {
-                const result = yield checkPasswordResetOtp(checkPasswordResetOtpRequest, this._ropcEndpointResponse.managementEndpoint);
+                ((_h = this._signInWithCredentialsEndpointResponse) === null || _h === void 0 ? void 0 : _h.managementEndpoint) !==
+                    undefined) {
+                const result = yield checkPasswordResetOtp(checkPasswordResetOtpRequest, this._signInWithCredentialsEndpointResponse.managementEndpoint);
                 return result;
             }
             else {
@@ -2504,13 +2509,14 @@ class UserServiceClient {
          */
         this.completeResetPassword = (completePasswordResetRequest) => __awaiter(this, void 0, void 0, function* () {
             var _j;
-            if (((_j = this._ropcEndpointResponse) === null || _j === void 0 ? void 0 : _j.managementEndpoint) !== undefined) {
-                const result = yield completePasswordReset(completePasswordResetRequest, this._ropcEndpointResponse.managementEndpoint);
+            if (((_j = this._signInWithCredentialsEndpointResponse) === null || _j === void 0 ? void 0 : _j.managementEndpoint) !==
+                undefined) {
+                const result = yield completePasswordReset(completePasswordResetRequest, this._signInWithCredentialsEndpointResponse.managementEndpoint);
                 return result;
             }
             else {
                 return {
-                    code: dist.ROPCPasswordResponseCode.SERVICE_CONFIGURATION_ERROR,
+                    code: dist.ResetPasswordResponseCode.SERVICE_CONFIGURATION_ERROR,
                     message: 'No IDP has been configured to handle password reset.',
                 };
             }
@@ -2557,7 +2563,7 @@ class UserServiceClient {
         };
         /**
          * Returns an array of IDP Configurations that are configured for the application
-         * This list will exclude connections for provider id AX_AUTH as it is used for a user sign-up and ROPC flows.
+         * This list will exclude connections for provider id AX_AUTH as it is used for a user sign-up and SignInWithCredentials flows.
          *
          */
         this.getIdpConfigurations = () => __awaiter(this, void 0, void 0, function* () {
@@ -2696,8 +2702,8 @@ class UserServiceClient {
             const authUrl = getNativeAuthUrl(this.userAuthConfig, idpConnectionId, returnUrl, encryptionKey);
             return authUrl;
         };
-        // asynchronously get the ROPC endpoints at client initialization
-        this.getROPCEndpoints();
+        // asynchronously get the SignInWithCredentials endpoints at client initialization
+        this.getSignInWithCredentialsEndpoints();
     }
     get tokenResponse() {
         return this._tokenResponse;