@elliemae/pui-app-sdk 6.0.0-alpha.2 → 6.0.0-alpha.3

package/dist/cjs/data/auth/actions.js

@@ -43,9 +43,17 @@ const auth = {
     redirectUri,
     responseType,
     scope,
-    code
+    code,
+    customLogoutUrl
   }) => ({
     type: LOGOUT,
-    payload: { clientId, redirectUri, responseType, scope, code }
+    payload: {
+      clientId,
+      redirectUri,
+      responseType,
+      scope,
+      code,
+      customLogoutUrl
+    }
   })
 };

package/dist/cjs/package.json

@@ -3,5 +3,8 @@
   "sideEffects": [
     "*.css",
     "*.html"
-  ]
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/dist/cjs/utils/auth/index.js

@@ -50,19 +50,42 @@ const navigateToLoginPage = ({
   redirectUri,
   idpErrorCode,
   scope,
-  // eslint-disable-next-line camelcase
-  responseType
+  responseType,
+  instanceId,
+  siteId,
+  userId,
+  disableRememberMe,
+  useCompactIdpPage,
+  isSSO
 }) => {
   const idpHost = (0, import_config.getAppConfigValue)(IDP_ENDPOINT_CONFIG_KEY, "");
   const idpUrl = new URL("/authorize", idpHost);
   const idpOptions = {
     client_id: clientId,
     redirect_uri: redirectUri,
-    response_type: responseType,
-    scope
+    response_type: responseType ?? "",
+    scope,
+    ...instanceId !== void 0 && {
+      instance_id: String(instanceId)
+    },
+    ...siteId !== void 0 && {
+      site_id: String(siteId)
+    },
+    ...userId !== void 0 && {
+      user_id: userId
+    },
+    ...disableRememberMe !== void 0 && {
+      disable_remember_me: String(disableRememberMe)
+    },
+    ...useCompactIdpPage !== void 0 && {
+      tpoifr: String(useCompactIdpPage)
+    },
+    ...isSSO !== void 0 && {
+      is_sso: String(isSSO)
+    }
   };
   const searchParams = new URLSearchParams(
-    idpErrorCode ? Object.assign(idpOptions, { error_code: idpErrorCode }) : idpOptions
+    idpErrorCode ? { ...idpOptions, error_code: idpErrorCode } : idpOptions
   );
   idpUrl.search = searchParams.toString();
   window.location.replace(idpUrl.href);
@@ -73,6 +96,7 @@ const endSession = async ({
   responseType,
   scope,
   code = "",
+  customLogoutUrl = "",
   skipRevoke = false
 }) => {
   try {
@@ -86,17 +110,22 @@ const endSession = async ({
       });
     (0, import_user_session_event.logoutEvent)();
     (0, import_appdynamics.setAppDynamicsUserData)({ instanceId: "", userId: "" });
-    const idpHost = (0, import_config.getAppConfigValue)(IDP_ENDPOINT_CONFIG_KEY, "");
-    const logoutUrl = new URL("/authorize", idpHost);
-    const params = {
-      client_id: clientId,
-      redirect_uri: redirectUri,
-      ...code && { error_code: code },
-      response_type: responseType,
-      scope
-    };
-    const searchParams = new URLSearchParams(params);
-    logoutUrl.search = searchParams.toString();
+    let logoutUrl;
+    if (customLogoutUrl) {
+      logoutUrl = new URL("/", customLogoutUrl);
+    } else {
+      const idpHost = (0, import_config.getAppConfigValue)(IDP_ENDPOINT_CONFIG_KEY, "");
+      logoutUrl = new URL("/authorize", idpHost);
+      const params = {
+        client_id: clientId,
+        redirect_uri: redirectUri,
+        ...code && { error_code: code },
+        response_type: responseType,
+        scope
+      };
+      const searchParams = new URLSearchParams(params);
+      logoutUrl.search = searchParams.toString();
+    }
     window.location.replace(logoutUrl.href);
   } catch (err) {
     (0, import_logger.getLogger)()?.error({
@@ -119,7 +148,12 @@ const authorize = async ({
       scope,
       redirectUri
     });
-    (0, import_loginParams.setLoginParams)({ clientId, scope, responseType, redirectUri });
+    (0, import_loginParams.setLoginParams)({
+      clientId,
+      scope,
+      responseType,
+      redirectUri
+    });
     const authorizationToken = `${tokenType} ${accessToken}`;
     (0, import_helper.setAuthorizationHeader)(authorizationToken);
     const introspectResponse = await (0, import_auth.introspectToken)({
@@ -165,7 +199,13 @@ const authorize = async ({
 const login = async ({
   clientId,
   scope,
-  responseType
+  responseType,
+  instanceId,
+  siteId,
+  userId,
+  disableRememberMe,
+  useCompactIdpPage,
+  isSSO
 }) => {
   const { code, idpErrorCode, redirectUri } = getIDPInfoFromUrl();
   const loginInfo = {
@@ -174,7 +214,13 @@ const login = async ({
     responseType,
     redirectUri,
     code,
-    idpErrorCode
+    idpErrorCode,
+    instanceId,
+    siteId,
+    userId,
+    disableRememberMe,
+    useCompactIdpPage,
+    isSSO
   };
   if (code) {
     await authorize(loginInfo);

package/dist/cjs/view/login/index.js

@@ -30,6 +30,12 @@ const Login = ({
   clientId,
   scope,
   responseType,
+  instanceId,
+  siteId,
+  userId,
+  disableRememberMe,
+  useCompactIdpPage,
+  isSSO,
   children
 }) => {
   const [userAuthorized, setUserAuthorized] = (0, import_react.useState)(false);
@@ -38,13 +44,34 @@ const Login = ({
   (0, import_react.useEffect)(() => {
     if (ref.current) return;
     ref.current = true;
-    (0, import_auth.login)({ clientId, scope, responseType }).then(({ authorized }) => {
+    (0, import_auth.login)({
+      clientId,
+      scope,
+      responseType,
+      instanceId,
+      siteId,
+      userId,
+      disableRememberMe,
+      useCompactIdpPage,
+      isSSO
+    }).then(({ authorized }) => {
       if (authorized) setUserAuthorized(true);
       dispatch({ type: import_actions.LOGIN_SUCCESS });
     }).catch(() => {
     }).finally(() => {
       ref.current = false;
     });
-  }, [dispatch, clientId, scope, responseType]);
+  }, [
+    dispatch,
+    clientId,
+    scope,
+    responseType,
+    instanceId,
+    siteId,
+    userId,
+    disableRememberMe,
+    useCompactIdpPage,
+    isSSO
+  ]);
   return userAuthorized ? /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_jsx_runtime.Fragment, { children }) : null;
 };

package/dist/cjs/view/require-auth.js

@@ -45,7 +45,13 @@ const RequireAuth = ({
   children,
   clientId = import_constants.default.CLIENT_ID,
   scope = "loc",
-  responseType = "code"
+  responseType = "code",
+  instanceId,
+  siteId,
+  userId,
+  disableRememberMe,
+  useCompactIdpPage,
+  isSSO
 }) => {
   const AuthManager = (0, import_redux_injectors.createManager)({
     name: "AuthManager",
@@ -59,5 +65,19 @@ const RequireAuth = ({
     (0, import_loginParams.setLoginParams)({ clientId, scope, responseType });
     return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(AuthManager, { children });
   }
-  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(AuthManager, { children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_login.Login, { clientId, scope, responseType, children }) });
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(AuthManager, { children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(
+    import_login.Login,
+    {
+      clientId,
+      scope,
+      responseType,
+      instanceId,
+      siteId,
+      userId,
+      disableRememberMe,
+      useCompactIdpPage,
+      isSSO,
+      children
+    }
+  ) });
 };

package/dist/esm/data/auth/actions.js

@@ -17,10 +17,18 @@ const auth = {
     redirectUri,
     responseType,
     scope,
-    code
+    code,
+    customLogoutUrl
   }) => ({
     type: LOGOUT,
-    payload: { clientId, redirectUri, responseType, scope, code }
+    payload: {
+      clientId,
+      redirectUri,
+      responseType,
+      scope,
+      code,
+      customLogoutUrl
+    }
   })
 };
 export {

package/dist/esm/package.json

@@ -3,5 +3,8 @@
   "sideEffects": [
     "*.css",
     "*.html"
-  ]
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/dist/esm/utils/auth/index.js

@@ -26,19 +26,42 @@ const navigateToLoginPage = ({
   redirectUri,
   idpErrorCode,
   scope,
-  // eslint-disable-next-line camelcase
-  responseType
+  responseType,
+  instanceId,
+  siteId,
+  userId,
+  disableRememberMe,
+  useCompactIdpPage,
+  isSSO
 }) => {
   const idpHost = getAppConfigValue(IDP_ENDPOINT_CONFIG_KEY, "");
   const idpUrl = new URL("/authorize", idpHost);
   const idpOptions = {
     client_id: clientId,
     redirect_uri: redirectUri,
-    response_type: responseType,
-    scope
+    response_type: responseType ?? "",
+    scope,
+    ...instanceId !== void 0 && {
+      instance_id: String(instanceId)
+    },
+    ...siteId !== void 0 && {
+      site_id: String(siteId)
+    },
+    ...userId !== void 0 && {
+      user_id: userId
+    },
+    ...disableRememberMe !== void 0 && {
+      disable_remember_me: String(disableRememberMe)
+    },
+    ...useCompactIdpPage !== void 0 && {
+      tpoifr: String(useCompactIdpPage)
+    },
+    ...isSSO !== void 0 && {
+      is_sso: String(isSSO)
+    }
   };
   const searchParams = new URLSearchParams(
-    idpErrorCode ? Object.assign(idpOptions, { error_code: idpErrorCode }) : idpOptions
+    idpErrorCode ? { ...idpOptions, error_code: idpErrorCode } : idpOptions
   );
   idpUrl.search = searchParams.toString();
   window.location.replace(idpUrl.href);
@@ -49,6 +72,7 @@ const endSession = async ({
   responseType,
   scope,
   code = "",
+  customLogoutUrl = "",
   skipRevoke = false
 }) => {
   try {
@@ -62,17 +86,22 @@ const endSession = async ({
       });
     logoutEvent();
     setAppDynamicsUserData({ instanceId: "", userId: "" });
-    const idpHost = getAppConfigValue(IDP_ENDPOINT_CONFIG_KEY, "");
-    const logoutUrl = new URL("/authorize", idpHost);
-    const params = {
-      client_id: clientId,
-      redirect_uri: redirectUri,
-      ...code && { error_code: code },
-      response_type: responseType,
-      scope
-    };
-    const searchParams = new URLSearchParams(params);
-    logoutUrl.search = searchParams.toString();
+    let logoutUrl;
+    if (customLogoutUrl) {
+      logoutUrl = new URL("/", customLogoutUrl);
+    } else {
+      const idpHost = getAppConfigValue(IDP_ENDPOINT_CONFIG_KEY, "");
+      logoutUrl = new URL("/authorize", idpHost);
+      const params = {
+        client_id: clientId,
+        redirect_uri: redirectUri,
+        ...code && { error_code: code },
+        response_type: responseType,
+        scope
+      };
+      const searchParams = new URLSearchParams(params);
+      logoutUrl.search = searchParams.toString();
+    }
     window.location.replace(logoutUrl.href);
   } catch (err) {
     getLogger()?.error({
@@ -95,7 +124,12 @@ const authorize = async ({
       scope,
       redirectUri
     });
-    setLoginParams({ clientId, scope, responseType, redirectUri });
+    setLoginParams({
+      clientId,
+      scope,
+      responseType,
+      redirectUri
+    });
     const authorizationToken = `${tokenType} ${accessToken}`;
     setAuthorizationHeader(authorizationToken);
     const introspectResponse = await introspectToken({
@@ -141,7 +175,13 @@ const authorize = async ({
 const login = async ({
   clientId,
   scope,
-  responseType
+  responseType,
+  instanceId,
+  siteId,
+  userId,
+  disableRememberMe,
+  useCompactIdpPage,
+  isSSO
 }) => {
   const { code, idpErrorCode, redirectUri } = getIDPInfoFromUrl();
   const loginInfo = {
@@ -150,7 +190,13 @@ const login = async ({
     responseType,
     redirectUri,
     code,
-    idpErrorCode
+    idpErrorCode,
+    instanceId,
+    siteId,
+    userId,
+    disableRememberMe,
+    useCompactIdpPage,
+    isSSO
   };
   if (code) {
     await authorize(loginInfo);

package/dist/esm/view/login/index.js

@@ -7,6 +7,12 @@ const Login = ({
   clientId,
   scope,
   responseType,
+  instanceId,
+  siteId,
+  userId,
+  disableRememberMe,
+  useCompactIdpPage,
+  isSSO,
   children
 }) => {
   const [userAuthorized, setUserAuthorized] = useState(false);
@@ -15,14 +21,35 @@ const Login = ({
   useEffect(() => {
     if (ref.current) return;
     ref.current = true;
-    login({ clientId, scope, responseType }).then(({ authorized }) => {
+    login({
+      clientId,
+      scope,
+      responseType,
+      instanceId,
+      siteId,
+      userId,
+      disableRememberMe,
+      useCompactIdpPage,
+      isSSO
+    }).then(({ authorized }) => {
       if (authorized) setUserAuthorized(true);
       dispatch({ type: LOGIN_SUCCESS });
     }).catch(() => {
     }).finally(() => {
       ref.current = false;
     });
-  }, [dispatch, clientId, scope, responseType]);
+  }, [
+    dispatch,
+    clientId,
+    scope,
+    responseType,
+    instanceId,
+    siteId,
+    userId,
+    disableRememberMe,
+    useCompactIdpPage,
+    isSSO
+  ]);
   return userAuthorized ? /* @__PURE__ */ jsx(Fragment, { children }) : null;
 };
 export {

package/dist/esm/view/require-auth.js

@@ -12,7 +12,13 @@ const RequireAuth = ({
   children,
   clientId = enums.CLIENT_ID,
   scope = "loc",
-  responseType = "code"
+  responseType = "code",
+  instanceId,
+  siteId,
+  userId,
+  disableRememberMe,
+  useCompactIdpPage,
+  isSSO
 }) => {
   const AuthManager = createManager({
     name: "AuthManager",
@@ -26,7 +32,21 @@ const RequireAuth = ({
     setLoginParams({ clientId, scope, responseType });
     return /* @__PURE__ */ jsx(AuthManager, { children });
   }
-  return /* @__PURE__ */ jsx(AuthManager, { children: /* @__PURE__ */ jsx(Login, { clientId, scope, responseType, children }) });
+  return /* @__PURE__ */ jsx(AuthManager, { children: /* @__PURE__ */ jsx(
+    Login,
+    {
+      clientId,
+      scope,
+      responseType,
+      instanceId,
+      siteId,
+      userId,
+      disableRememberMe,
+      useCompactIdpPage,
+      isSSO,
+      children
+    }
+  ) });
 };
 export {
   RequireAuth

package/dist/types/lib/data/auth/actions.d.ts

@@ -15,8 +15,9 @@ export interface LogoutParams {
     responseType: string;
     scope: string;
     code: string;
+    customLogoutUrl: string;
 }
 export declare const auth: {
     login: ({ code, redirectUri, clientId, responseType, scope, }: LoginParms) => PayloadAction<LoginParms>;
-    logout: ({ clientId, redirectUri, responseType, scope, code, }: LogoutParams) => PayloadAction<LogoutParams>;
+    logout: ({ clientId, redirectUri, responseType, scope, code, customLogoutUrl, }: LogoutParams) => PayloadAction<LogoutParams>;
 };

package/dist/types/lib/utils/auth/index.d.ts

@@ -5,12 +5,41 @@ export declare const getIDPInfoFromUrl: () => {
     idpErrorCode: string;
     redirectUri: string;
 };
-export declare const navigateToLoginPage: ({ clientId, redirectUri, idpErrorCode, scope, responseType, }: {
+/**
+ * Navigates the user to the login page of IDP with the specified
+ * authentication parameters.
+ *
+ * Constructs the authorization URL using the provided options and
+ * redirects the browser to initiate the login flow.
+ * @param options - An object containing authentication parameters:
+ * @param options.clientId - The client identifier for the application.
+ * @param options.redirectUri - The URI to redirect to after authentication.
+ * @param options.idpErrorCode - Optional error code to pass to the IDP.
+ * @param options.scope - The scope of the authentication request.
+ * @param options.responseType - Optional response type for the
+ * authentication request.
+ * @param options.instanceId - Optional instance identifier.
+ * @param options.siteId - Optional site identifier.
+ * @param options.userId - Optional user identifier.
+ * @param options.disableRememberMe - Optional flag to disable
+ * "Remember Me" functionality.
+ * @param options.useCompactIdpPage - Optional flag. Determines whether to use a
+ * compact or full IDP page.
+ * @param options.isSSO - Optional flag. Determines whether to use
+ * SSO or not
+ */
+export declare const navigateToLoginPage: ({ clientId, redirectUri, idpErrorCode, scope, responseType, instanceId, siteId, userId, disableRememberMe, useCompactIdpPage, isSSO, }: {
     clientId: string;
     redirectUri: string;
     idpErrorCode: string;
     scope: string;
-    responseType: string;
+    responseType?: string;
+    instanceId?: number;
+    siteId?: number;
+    userId?: string;
+    disableRememberMe?: boolean;
+    useCompactIdpPage?: boolean;
+    isSSO?: boolean;
 }) => void;
 export declare const endSession: EndSessionFn;
 export declare const authorize: ({ code, redirectUri, clientId, scope, responseType, }: {
@@ -20,10 +49,36 @@ export declare const authorize: ({ code, redirectUri, clientId, scope, responseT
     scope: string;
     responseType: string;
 }) => Promise<void>;
-export declare const login: ({ clientId, scope, responseType, }: {
+/**
+ * Attempts to log in a user using the provided authentication parameters.
+ *
+ * If an authorization code is present in the URL, it calls the `authorize`
+ * function with the login information and returns `{ authorized: true }`.
+ * Otherwise, it navigates to the login page and returns `{ authorized: false }`.
+ * @param params - The authentication parameters.
+ * @param params.clientId - The client identifier for the authentication request.
+ * @param params.scope - The scope of the authentication request.
+ * @param params.responseType - The response type for the authentication request.
+ * @param params.instanceId - (Optional) The instance identifier.
+ * @param params.siteId - (Optional) The site identifier.
+ * @param params.userId - (Optional) The user identifier.
+ * @param params.disableRememberMe - (Optional) Whether to disable the
+ * "Remember Me" option.
+ * @param params.useCompactIdpPage - (Optional). Determines whether to use a compact or
+ * full IDP page.
+ * @param params.isSSO - (Optional). Determines whether to use SSO or not.
+ * @returns An object indicating whether the user is authorized.
+ */
+export declare const login: ({ clientId, scope, responseType, instanceId, siteId, userId, disableRememberMe, useCompactIdpPage, isSSO, }: {
     clientId: string;
     scope: string;
     responseType: string;
+    instanceId?: number;
+    siteId?: number;
+    userId?: string;
+    disableRememberMe?: boolean;
+    useCompactIdpPage?: boolean;
+    isSSO?: boolean;
 }) => Promise<{
     authorized: boolean;
 }>;

package/dist/types/lib/utils/auth/types.d.ts

@@ -4,6 +4,7 @@ export type EndSessionFn = (params: {
     responseType: string;
     scope: string;
     code?: string;
+    customLogoutUrl?: string;
     skipRevoke?: boolean;
 }) => Promise<void>;
 export type LoginParams = {

package/dist/types/lib/view/login/index.d.ts

@@ -2,7 +2,34 @@ interface LoginParams {
     clientId: string;
     scope: string;
     responseType: string;
+    instanceId?: number;
+    siteId?: number;
+    userId?: string;
+    disableRememberMe?: boolean;
+    useCompactIdpPage?: boolean;
+    isSSO?: boolean;
     children: React.ReactNode;
 }
-export declare const Login: ({ clientId, scope, responseType, children, }: LoginParams) => import("react/jsx-runtime.js").JSX.Element | null;
+/**
+ * Renders the login flow for the application and manages user authorization
+ * state.
+ *
+ * This component triggers a login process using the provided parameters and,
+ * upon successful authorization, renders its children.
+ * @param clientId - The client identifier for authentication.
+ * @param scope - The scope of authentication request.
+ * @param responseType - The type of response expected.
+ * @param instanceId - (optional) The instance identifier for the login context.
+ * @param siteId - (optional) The site identifier for the login context.
+ * @param userId - (optional) The identifier of the user attempting to log in.
+ * @param disableRememberMe - (optional) If true, disables the "Remember Me"
+ * option.
+ * @param useCompactIdpPage - (optional) Determines whether to use a compact or full IDP
+ * page.
+ * @param isSSO - (optional) Determines whether to use SSO or not.
+ * @param children - React elements to render upon successful authorization.
+ * @returns The children elements if the user is authorized; otherwise, returns
+ * null.
+ */
+export declare const Login: ({ clientId, scope, responseType, instanceId, siteId, userId, disableRememberMe, useCompactIdpPage, isSSO, children, }: LoginParams) => import("react/jsx-runtime.js").JSX.Element | null;
 export {};

package/dist/types/lib/view/login/tests/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/lib/view/require-auth.d.ts

@@ -2,6 +2,34 @@ export interface RequireAuthProps {
     clientId?: string;
     scope?: string;
     responseType?: string;
+    instanceId?: number;
+    siteId?: number;
+    userId?: string;
+    disableRememberMe?: boolean;
+    useCompactIdpPage?: boolean;
+    isSSO?: boolean;
     children: React.ReactNode;
 }
-export declare const RequireAuth: ({ children, clientId, scope, responseType, }: RequireAuthProps) => import("react/jsx-runtime.js").JSX.Element;
+/**
+ * A React component that ensures authentication for its children.
+ *
+ * If the user is authorized, it renders the children within the AuthManager
+ * context. Otherwise, it renders the Login component to prompt for
+ * authentication, passing relevant props.
+ * @param children - The child components to render, which require
+ *   authentication.
+ * @param clientId - The client identifier for authentication. Defaults to
+ *   `enums.CLIENT_ID`.
+ * @param scope - The scope of authentication. Defaults to `'loc'`.
+ * @param responseType - The response type for authentication. Defaults to
+ *   `'code'`.
+ * @param instanceId - Optional instance identifier.
+ * @param siteId - Optional site identifier.
+ * @param userId - Optional user identifier for authentication.
+ * @param disableRememberMe - Optional flag to disable the "Remember Me"
+ *   feature.
+ * @param useCompactIdpPage - Optional flag. Determines whether to use a compact or full
+ *   IDP page.
+ * @param isSSO - Optional flag. Determines whether to use SSO or not.
+ */
+export declare const RequireAuth: ({ children, clientId, scope, responseType, instanceId, siteId, userId, disableRememberMe, useCompactIdpPage, isSSO, }: RequireAuthProps) => import("react/jsx-runtime.js").JSX.Element;

package/dist/types/lib/view/tests/require-auth.test.d.ts

@@ -0,0 +1 @@
+export {};