@elliemae/pui-app-sdk 5.35.0 → 5.36.0

package/build/docs/assets/js/a6c5c03c.f2cbe66f.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[8737],{116(e,n,t){t.d(n,{R:()=>o,x:()=>a});var i=t(758);const r={},s=i.createContext(r);function o(e){const n=i.useContext(s);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(s.Provider,{value:n},e.children)}},4052(e,n,t){t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>u});const i=JSON.parse('{"id":"api/functions/RequireAuth","title":"RequireAuth()","description":"A React component that ensures authentication for its children.","source":"@site/docs/api/functions/RequireAuth.md","sourceDirName":"api/functions","slug":"/api/functions/RequireAuth","permalink":"/app-sdk/api/functions/RequireAuth","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/RequireAuth.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"RenderWithStateAddOns()","permalink":"/app-sdk/api/functions/RenderWithStateAddOns"},"next":{"title":"SessionTimeout()","permalink":"/app-sdk/api/functions/SessionTimeout"}}');var r=t(6070),s=t(116);const o={},a="RequireAuth()",c={},u=[{value:"Parameters",id:"parameters",level:2},{value:"children",id:"children",level:3},{value:"Returns",id:"returns",level:2}];function h(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"requireauth",children:"RequireAuth()"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function RequireAuth(children: RequireAuthProps): Element;\n"})}),"\n",(0,r.jsx)(n.p,{children:"A React component that ensures authentication for its children."}),"\n",(0,r.jsx)(n.p,{children:"If the user is authorized, it renders the children within the AuthManager\ncontext. Otherwise, it renders the Login component to prompt for\nauthentication, passing relevant props."}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.h3,{id:"children",children:"children"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"RequireAuthProps"})}),"\n",(0,r.jsx)(n.p,{children:"The child components to render, which require\nauthentication."}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Element"})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}}}]);

package/build/docs/assets/js/d071c513.26ec37a4.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[1923],{116(e,a,n){n.d(a,{R:()=>t,x:()=>l});var r=n(758);const s={},i=r.createContext(s);function t(e){const a=r.useContext(i);return r.useMemo(function(){return"function"==typeof e?e(a):{...a,...e}},[a,e])}function l(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:t(e.components),r.createElement(i.Provider,{value:a},e.children)}},6612(e,a,n){n.r(a),n.d(a,{assets:()=>o,contentTitle:()=>l,default:()=>c,frontMatter:()=>t,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"api/variables/endSession","title":"endSession","description":"Ends the current user session and redirects to logout page.","source":"@site/docs/api/variables/endSession.md","sourceDirName":"api/variables","slug":"/api/variables/endSession","permalink":"/app-sdk/api/variables/endSession","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/endSession.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"decorators","permalink":"/app-sdk/api/variables/decorators"},"next":{"title":"error","permalink":"/app-sdk/api/variables/error"}}');var s=n(6070),i=n(116);const t={},l="endSession",o={},d=[{value:"Param",id:"param",level:2},{value:"Param",id:"param-1",level:2},{value:"Param",id:"param-2",level:2},{value:"Param",id:"param-3",level:2},{value:"Param",id:"param-4",level:2},{value:"Param",id:"param-5",level:2},{value:"Param",id:"param-6",level:2},{value:"Param",id:"param-7",level:2},{value:"Example",id:"example",level:2}];function p(e){const a={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(a.header,{children:(0,s.jsx)(a.h1,{id:"endsession",children:"endSession"})}),"\n",(0,s.jsx)(a.pre,{children:(0,s.jsx)(a.code,{className:"language-ts",children:"const endSession: EndSessionFn;\n"})}),"\n",(0,s.jsx)(a.p,{children:"Ends the current user session and redirects to logout page.\nRevokes tokens and clears session storage."}),"\n",(0,s.jsx)(a.h2,{id:"param",children:"Param"}),"\n",(0,s.jsx)(a.p,{children:"Session end parameters"}),"\n",(0,s.jsx)(a.h2,{id:"param-1",children:"Param"}),"\n",(0,s.jsx)(a.p,{children:"OAuth client ID"}),"\n",(0,s.jsx)(a.h2,{id:"param-2",children:"Param"}),"\n",(0,s.jsx)(a.p,{children:"URI to redirect after logout"}),"\n",(0,s.jsx)(a.h2,{id:"param-3",children:"Param"}),"\n",(0,s.jsx)(a.p,{children:"OAuth response type"}),"\n",(0,s.jsx)(a.h2,{id:"param-4",children:"Param"}),"\n",(0,s.jsx)(a.p,{children:"OAuth scopes"}),"\n",(0,s.jsx)(a.h2,{id:"param-5",children:"Param"}),"\n",(0,s.jsx)(a.p,{children:"Optional error code"}),"\n",(0,s.jsx)(a.h2,{id:"param-6",children:"Param"}),"\n",(0,s.jsx)(a.p,{children:"Optional custom logout URL to redirect to instead of IDP"}),"\n",(0,s.jsx)(a.h2,{id:"param-7",children:"Param"}),"\n",(0,s.jsx)(a.p,{children:"Skip token revocation if true"}),"\n",(0,s.jsx)(a.h2,{id:"example",children:"Example"}),"\n",(0,s.jsx)(a.pre,{children:(0,s.jsx)(a.code,{className:"language-typescript",children:"await endSession({\n  clientId: 'my-app',\n  redirectUri: window.location.origin,\n  scope: 'openid'\n});\n"})})]})}function c(e={}){const{wrapper:a}={...(0,i.R)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}}}]);