From 2bfff8ddbe989816e711ddfed5795a44872ac5ee Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 8 Mar 2024 14:45:09 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20open-pio?= =?UTF-8?q?neer/trails-core-packages@5ff8f304b91d6d5e40febaf65798b1f3efab3?= =?UTF-8?q?a71=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../assets/{4db025a8fa53.js => 6265da8008fb.js} | 2 +- .../assets/{afc2429a7da1.js => 73a9b51880fc.js} | 2 +- .../assets/{f664fa8964c8.js => 7cefae59068f.js} | 2 +- .../assets/{c8636be98652.js => 8cb5dde696b5.js} | 2 +- .../assets/{df8af7ec6993.js => e833d06c991d.js} | 2 +- .../docs/classes/_open_pioneer_core.Error.html | 8 ++++---- .../classes/_open_pioneer_core.EventEmitter.html | 8 ++++---- .../_open_pioneer_authentication.useAuthState.html | 2 +- .../_open_pioneer_core.createAbortError.html | 2 +- .../functions/_open_pioneer_core.createLogger.html | 2 +- .../_open_pioneer_core.createManualPromise.html | 2 +- .../_open_pioneer_core.destroyResource.html | 2 +- .../_open_pioneer_core.getErrorChain.html | 2 +- .../functions/_open_pioneer_core.isAbortError.html | 2 +- .../_open_pioneer_core.rethrowAbortError.html | 2 +- .../_open_pioneer_core.throwAbortError.html | 2 +- .../functions/_open_pioneer_notifier.Notifier.html | 2 +- .../_open_pioneer_runtime.createCustomElement.html | 2 +- ..._pioneer_test_utils.services.createService.html | 2 +- ..._test_utils.web_components.defineComponent.html | 2 +- ..._test_utils.web_components.renderComponent.html | 2 +- ...ls.web_components.renderComponentShadowDOM.html | 2 +- .../_open_pioneer_authentication.AuthEvents.html | 4 ++-- .../_open_pioneer_authentication.AuthPlugin.html | 12 ++++++------ ...en_pioneer_authentication.AuthPluginEvents.html | 4 ++-- .../_open_pioneer_authentication.AuthService.html | 14 +++++++------- ...neer_authentication.AuthStateAuthenticated.html | 4 ++-- ...r_authentication.AuthStateNotAuthenticated.html | 4 ++-- ...en_pioneer_authentication.AuthStatePending.html | 4 ++-- ...open_pioneer_authentication.ForceAuthProps.html | 8 ++++---- .../_open_pioneer_authentication.LoginEffect.html | 4 ++-- ..._open_pioneer_authentication.LoginFallback.html | 4 ++-- .../_open_pioneer_authentication.SessionInfo.html | 10 +++++----- .../interfaces/_open_pioneer_core.LogMethod.html | 2 +- .../docs/interfaces/_open_pioneer_core.Logger.html | 14 +++++++------- .../_open_pioneer_core.ManualPromise.html | 4 ++-- .../interfaces/_open_pioneer_core.Resource.html | 4 ++-- .../_open_pioneer_http.BeforeRequestParams.html | 10 +++++----- .../interfaces/_open_pioneer_http.HttpService.html | 4 ++-- .../_open_pioneer_http.HttpServiceRequestInit.html | 4 ++-- .../interfaces/_open_pioneer_http.Interceptor.html | 4 ++-- .../_open_pioneer_integration.ApiExtension.html | 4 ++-- ...n_pioneer_integration.ExternalEventService.html | 6 +++--- ...open_pioneer_local_storage.LocalStorageAPI.html | 12 ++++++------ ...oneer_local_storage.LocalStorageProperties.html | 4 ++-- ..._pioneer_local_storage.LocalStorageService.html | 14 +++++++------- ..._open_pioneer_notifier.NotificationOptions.html | 10 +++++----- ..._open_pioneer_notifier.NotificationService.html | 6 +++--- .../_open_pioneer_notifier.NotifierProps.html | 4 ++-- .../_open_pioneer_runtime.ApiExtension.html | 4 ++-- .../_open_pioneer_runtime.ApiService.html | 4 ++-- .../_open_pioneer_runtime.ApplicationConfig.html | 6 +++--- .../_open_pioneer_runtime.ApplicationContext.html | 12 ++++++------ .../_open_pioneer_runtime.ApplicationElement.html | 4 ++-- ...neer_runtime.ApplicationElementConstructor.html | 4 ++-- ...oneer_runtime.ApplicationLifecycleListener.html | 6 +++--- ...open_pioneer_runtime.ApplicationProperties.html | 2 +- .../_open_pioneer_runtime.ConfigContext.html | 4 ++-- ..._open_pioneer_runtime.CustomElementOptions.html | 12 ++++++------ .../_open_pioneer_runtime.DeclaredService.html | 2 +- .../_open_pioneer_runtime.ReferenceMeta.html | 4 ++-- ...open_pioneer_runtime.ServiceLifecycleHooks.html | 4 ++-- ...st_utils.react.PackageContextProviderProps.html | 14 +++++++------- ...r_test_utils.services.CreateServiceOptions.html | 12 ++++++------ .../_open_pioneer_authentication.ForceAuth.html | 2 +- .../docs/modules/_open_pioneer_base_theme.html | 5 +++-- ...er_chakra_integration.CustomChakraProvider.html | 2 +- .../_open_pioneer_chakra_integration.Portal.html | 2 +- .../modules/_open_pioneer_chakra_integration.html | 2 +- .../docs/modules/_open_pioneer_runtime.html | 2 +- .../docs/modules/_open_pioneer_test_utils.html | 2 +- ...er_test_utils.react.PackageContextProvider.html | 2 +- .../modules/_open_pioneer_test_utils.react.html | 2 +- .../modules/_open_pioneer_test_utils.services.html | 2 +- .../_open_pioneer_test_utils.web_components.html | 2 +- ...pioneer_authentication.AuthPluginEventBase.html | 2 +- .../_open_pioneer_authentication.AuthState.html | 2 +- ..._open_pioneer_authentication.LoginBehavior.html | 2 +- .../docs/types/_open_pioneer_core.EventNames.html | 2 +- .../docs/types/_open_pioneer_core.EventSource.html | 2 +- .../docs/types/_open_pioneer_core.LogLevel.html | 2 +- .../docs/types/_open_pioneer_http.ContextData.html | 2 +- .../_open_pioneer_http.ResolvedRequestOptions.html | 2 +- .../types/_open_pioneer_integration.ApiMethod.html | 2 +- .../_open_pioneer_integration.ApiMethods.html | 2 +- ...ioneer_local_storage.LocalStorageNamespace.html | 2 +- .../_open_pioneer_notifier.NotificationLevel.html | 2 +- .../types/_open_pioneer_runtime.ApiMethod.html | 2 +- .../types/_open_pioneer_runtime.ApiMethods.html | 2 +- ...en_pioneer_runtime.AssociatedInterfaceName.html | 2 +- ...ioneer_runtime.InterfaceNameForServiceType.html | 2 +- .../types/_open_pioneer_runtime.PackageIntl.html | 2 +- .../_open_pioneer_runtime.ReferencesMeta.html | 2 +- .../docs/types/_open_pioneer_runtime.Service.html | 2 +- .../_open_pioneer_runtime.ServiceConstructor.html | 2 +- .../_open_pioneer_runtime.ServiceOptions.html | 2 +- .../_open_pioneer_test_utils.react.AnyService.html | 2 +- .../variables/_open_pioneer_base_theme.theme.html | 2 +- ...pen_pioneer_chakra_integration.AlertDialog.html | 2 +- .../_open_pioneer_chakra_integration.Drawer.html | 2 +- .../_open_pioneer_chakra_integration.Modal.html | 2 +- .../_open_pioneer_chakra_integration.Tooltip.html | 2 +- ..._pioneer_runtime.DECLARE_SERVICE_INTERFACE.html | 2 +- core-packages/samples/auth-sample/index.html | 2 +- core-packages/samples/chakra-sample/index.html | 2 +- core-packages/samples/extension-sample/index.html | 2 +- core-packages/samples/notify-sample/index.html | 2 +- core-packages/samples/properties-sample/index.html | 2 +- 108 files changed, 210 insertions(+), 209 deletions(-) rename core-packages/assets/{4db025a8fa53.js => 6265da8008fb.js} (98%) rename core-packages/assets/{afc2429a7da1.js => 73a9b51880fc.js} (97%) rename core-packages/assets/{f664fa8964c8.js => 7cefae59068f.js} (87%) rename core-packages/assets/{c8636be98652.js => 8cb5dde696b5.js} (90%) rename core-packages/assets/{df8af7ec6993.js => e833d06c991d.js} (94%) diff --git a/core-packages/assets/4db025a8fa53.js b/core-packages/assets/6265da8008fb.js similarity index 98% rename from core-packages/assets/4db025a8fa53.js rename to core-packages/assets/6265da8008fb.js index 3c1849a17..bff49e350 100644 --- a/core-packages/assets/4db025a8fa53.js +++ b/core-packages/assets/6265da8008fb.js @@ -1 +1 @@ -import{r as l,j as e,A as Me,m as Y,d as j,w as X,T as Oe,g as ue,e as uo,u as xe,f as po,h as Ae,i as fo,k as ho,l as mo,n as vo,o as xo,p as m,q as v,s as L,t as A,v as yo,M as jo,C as Be,x as k,y as ye,z as bo,B as go,D as se,E as H,F as De,G as Ie,H as _o,I as Po,J as Co,a as ko,K as wo,L as So,N as He,O as To,P as No,Q as Oo,R as Eo,S as Ro,U as Fo,V as Mo,W as Ao,X as Bo,Y as Do,b as Io}from"./f6bce9997efc.js";import{L as Ho}from"./b6adfc9a8c28.js";import{T as Lo}from"./4ebae876f574.js";import{S as $o}from"./bb18577dbf66.js";import{S as Le}from"./ed8cece5af8e.js";import{C as zo,H as $e}from"./29fb1f323e6e.js";import{B as S}from"./d94fd672bb92.js";import{u as Vo}from"./138a1ee7cdf4.js";import{R as Uo,a as ae}from"./9749530ba15d.js";import{S as Go}from"./0895118db53c.js";import{B as g}from"./2e7753f73b7f.js";import"./a6d9340f2712.js";import"./979d11064765.js";function Wo(){return!!(typeof window<"u"&&window.document&&window.document.createElement)}var Ko=Wo(),qo={enter:({transition:o,transitionEnd:r,delay:n}={})=>{var t;return{opacity:1,transition:(t=o?.enter)!=null?t:X.enter(Oe.enter,n),transitionEnd:r?.enter}},exit:({transition:o,transitionEnd:r,delay:n}={})=>{var t;return{opacity:0,transition:(t=o?.exit)!=null?t:X.exit(Oe.exit,n),transitionEnd:r?.exit}}},ze={initial:"exit",animate:"enter",exit:"exit",variants:qo},Xo=l.forwardRef(function(r,n){const{unmountOnExit:t,in:a,className:s,transition:i,transitionEnd:u,delay:d,...c}=r,p=a||t?"enter":"exit",h=t?a&&t:!0,b={transition:i,transitionEnd:u,delay:d};return e.jsx(Me,{custom:b,children:h&&e.jsx(Y.div,{ref:n,className:j("chakra-fade",s),custom:b,...ze,animate:p,...c})})});Xo.displayName="Fade";var Ee={exit:{duration:.15,ease:uo.easeInOut},enter:{type:"spring",damping:25,stiffness:180}},Yo={exit:({direction:o,transition:r,transitionEnd:n,delay:t})=>{var a;const{exit:s}=ue({direction:o});return{...s,transition:(a=r?.exit)!=null?a:X.exit(Ee.exit,t),transitionEnd:n?.exit}},enter:({direction:o,transitionEnd:r,transition:n,delay:t})=>{var a;const{enter:s}=ue({direction:o});return{...s,transition:(a=n?.enter)!=null?a:X.enter(Ee.enter,t),transitionEnd:r?.enter}}},Ve=l.forwardRef(function(r,n){const{direction:t="right",style:a,unmountOnExit:s,in:i,className:u,transition:d,transitionEnd:c,delay:p,motionProps:h,...b}=r,w=ue({direction:t}),O=Object.assign({position:"fixed"},w.position,a),P=s?i&&s:!0,x=i||s?"enter":"exit",_={transitionEnd:c,transition:d,direction:t,delay:p};return e.jsx(Me,{custom:_,children:P&&e.jsx(Y.div,{...b,ref:n,initial:"exit",className:j("chakra-slide",u),animate:x,exit:"exit",custom:_,variants:Yo,style:O,...h})})});Ve.displayName="Slide";function Jo(o){return"current"in o}var Ue=()=>typeof window<"u";function Qo(){var o;const r=navigator.userAgentData;return(o=r?.platform)!=null?o:navigator.platform}var Zo=o=>Ue()&&o.test(navigator.vendor),er=o=>Ue()&&o.test(Qo()),or=()=>er(/mac|iphone|ipad|ipod/i),rr=()=>or()&&Zo(/apple/i);function nr(o){const{ref:r,elements:n,enabled:t}=o,a=()=>{var s,i;return(i=(s=r.current)==null?void 0:s.ownerDocument)!=null?i:document};xe(a,"pointerdown",s=>{if(!rr()||!t)return;const i=s.target,d=(n??[r]).some(c=>{const p=Jo(c)?c.current:c;return p?.contains(i)||p===i});a().activeElement!==i&&d&&(s.preventDefault(),i.focus())})}var tr=Ko?l.useLayoutEffect:l.useEffect;function Re(o,r=[]){const n=l.useRef(o);return tr(()=>{n.current=o}),l.useCallback((...t)=>{var a;return(a=n.current)==null?void 0:a.call(n,...t)},r)}function sr(o,r){const n=l.useId();return l.useMemo(()=>o||[r,n].filter(Boolean).join("-"),[o,r,n])}function ar(o,r){const n=o!==void 0;return[n,n&&typeof o<"u"?o:r]}function je(o={}){const{onClose:r,onOpen:n,isOpen:t,id:a}=o,s=Re(n),i=Re(r),[u,d]=l.useState(o.defaultIsOpen||!1),[c,p]=ar(t,u),h=sr(a,"disclosure"),b=l.useCallback(()=>{c||d(!1),i?.()},[c,i]),w=l.useCallback(()=>{c||d(!0),s?.()},[c,s]),O=l.useCallback(()=>{(p?b:w)()},[p,w,b]);return{isOpen:!!p,onOpen:w,onClose:b,onToggle:O,isControlled:c,getButtonProps:(P={})=>({...P,"aria-expanded":p,"aria-controls":h,onClick:po(P.onClick,O)}),getDisclosureProps:(P={})=>({...P,hidden:!p,id:h})}}function ir(o){const r=o.current;if(!r)return!1;const n=mo(r);return!n||r.contains(n)?!1:!!vo(n)}function lr(o,r){const{shouldFocus:n,visible:t,focusRef:a}=r,s=n&&!t;Ae(()=>{if(!s||ir(o))return;const i=a?.current||o.current;let u;if(i)return u=requestAnimationFrame(()=>{i.focus({preventScroll:!0})}),()=>{cancelAnimationFrame(u)}},[s,o,a])}var cr={preventScroll:!0,shouldFocus:!1};function ur(o,r=cr){const{focusRef:n,preventScroll:t,shouldFocus:a,visible:s}=r,i=dr(o)?o.current:o,u=a&&s,d=l.useRef(u),c=l.useRef(s);fo(()=>{!c.current&&s&&(d.current=u),c.current=s},[s,u]);const p=l.useCallback(()=>{if(!(!s||!i||!d.current)&&(d.current=!1,!i.contains(document.activeElement)))if(n?.current)requestAnimationFrame(()=>{var h;(h=n.current)==null||h.focus({preventScroll:t})});else{const h=ho(i);h.length>0&&requestAnimationFrame(()=>{h[0].focus({preventScroll:t})})}},[s,t,i,n]);Ae(()=>{p()},[p]),xe(i,"transitionend",p)}function dr(o){return"current"in o}function pr(o){const{isOpen:r,ref:n}=o,[t,a]=l.useState(r),[s,i]=l.useState(!1);return l.useEffect(()=>{s||(a(r),i(!0))},[r,s,t]),xe(()=>n.current,"animationend",()=>{a(r)}),{present:!(r?!1:!t),onComplete(){var d;const c=xo(n.current),p=new c.CustomEvent("animationend",{bubbles:!0});(d=n.current)==null||d.dispatchEvent(p)}}}function fr(o){const{wasSelected:r,enabled:n,isSelected:t,mode:a="unmount"}=o;return!!(!n||t||a==="keepMounted"&&r)}var hr=m(Ve),Ge=v((o,r)=>{const{className:n,children:t,motionProps:a,containerProps:s,...i}=o,{getDialogProps:u,getDialogContainerProps:d,isOpen:c}=L(),p=u(i,r),h=d(s),b=j("chakra-modal__content",n),w=A(),O={display:"flex",flexDirection:"column",position:"relative",width:"100%",outline:0,...w.dialog},P={display:"flex",width:"100vw",height:"$100vh",position:"fixed",left:0,top:0,...w.dialogContainer},{placement:x}=yo();return e.jsx(jo,{children:e.jsx(m.div,{...h,className:"chakra-modal__content-container",__css:P,children:e.jsx(hr,{motionProps:a,direction:x,in:c,className:b,...p,__css:O,children:t})})})});Ge.displayName="DrawerContent";var J=v((o,r)=>{const{className:n,...t}=o,a=j("chakra-modal__footer",n),i={display:"flex",alignItems:"center",justifyContent:"flex-end",...A().footer};return e.jsx(m.footer,{ref:r,...t,__css:i,className:a})});J.displayName="ModalFooter";var Q=v((o,r)=>{const{className:n,...t}=o,{headerId:a,setHeaderMounted:s}=L();l.useEffect(()=>(s(!0),()=>s(!1)),[s]);const i=j("chakra-modal__header",n),d={flex:0,...A().header};return e.jsx(m.header,{ref:r,className:i,id:a,...t,__css:d})});Q.displayName="ModalHeader";var mr=m(Y.div),Z=v((o,r)=>{const{className:n,transition:t,motionProps:a,...s}=o,i=j("chakra-modal__overlay",n),d={pos:"fixed",left:"0",top:"0",w:"100vw",h:"100vh",...A().overlay},{motionPreset:c}=L(),h=a||(c==="none"?{}:ze);return e.jsx(mr,{...h,__css:d,ref:r,className:i,...s})});Z.displayName="ModalOverlay";var ee=v((o,r)=>{const{className:n,...t}=o,{bodyId:a,setBodyMounted:s}=L();l.useEffect(()=>(s(!0),()=>s(!1)),[s]);const i=j("chakra-modal__body",n),u=A();return e.jsx(m.div,{ref:r,className:i,id:a,...t,__css:u.body})});ee.displayName="ModalBody";var be=v((o,r)=>{const{onClick:n,className:t,...a}=o,{onClose:s}=L(),i=j("chakra-modal__close-btn",t),u=A();return e.jsx(Be,{ref:r,__css:u.closeButton,className:i,onClick:k(n,d=>{d.stopPropagation(),s()}),...a})});be.displayName="ModalCloseButton";var[vr,R]=ye({name:"PopoverContext",errorMessage:"usePopoverContext: `context` is undefined. Seems you forgot to wrap all popover components within ``"}),[xr,B]=ye({name:"PopoverStylesContext",errorMessage:`usePopoverStyles returned is 'undefined'. Seems you forgot to wrap the components in "" `}),de=v(function(r,n){const{getHeaderProps:t}=R(),a=B();return e.jsx(m.header,{...t(r,n),className:j("chakra-popover__header",r.className),__css:a.header})});de.displayName="PopoverHeader";function pe(o){const r=l.Children.only(o.children),{getTriggerProps:n}=R();return l.cloneElement(r,n(r.props,r.ref))}pe.displayName="PopoverTrigger";var M={click:"click",hover:"hover"};function yr(o={}){const{closeOnBlur:r=!0,closeOnEsc:n=!0,initialFocusRef:t,id:a,returnFocusOnClose:s=!0,autoFocus:i=!0,arrowSize:u,arrowShadowColor:d,trigger:c=M.click,openDelay:p=200,closeDelay:h=200,isLazy:b,lazyBehavior:w="unmount",computePositionOnMount:O,...P}=o,{isOpen:x,onClose:_,onOpen:oe,onToggle:ge}=bo(o),re=l.useRef(null),$=l.useRef(null),F=l.useRef(null),I=l.useRef(!1),_e=l.useRef(!1);x&&(_e.current=!0);const[Pe,Ye]=l.useState(!1),[Ce,Je]=l.useState(!1),Qe=l.useId(),Ze=a??Qe,[ke,z,V,U]=["popover-trigger","popover-content","popover-header","popover-body"].map(f=>`${f}-${Ze}`),{referenceRef:G,getArrowProps:eo,getPopperProps:we,getArrowInnerProps:oo,forceUpdate:ro}=go({...P,enabled:x||!!O}),Se=pr({isOpen:x,ref:F});nr({enabled:x,ref:$}),lr(F,{focusRef:$,visible:x,shouldFocus:s&&c===M.click}),ur(F,{focusRef:t,visible:x,shouldFocus:i&&c===M.click});const Te=fr({wasSelected:_e.current,enabled:b,mode:w,isSelected:Se.present}),no=l.useCallback((f={},C=null)=>{const y={...f,style:{...f.style,transformOrigin:se.transformOrigin.varRef,[se.arrowSize.var]:u?`${u}px`:void 0,[se.arrowShadowColor.var]:d},ref:H(F,C),children:Te?f.children:null,id:z,tabIndex:-1,role:"dialog",onKeyDown:k(f.onKeyDown,T=>{n&&T.key==="Escape"&&_()}),onBlur:k(f.onBlur,T=>{const W=Fe(T),te=ie(F.current,W),co=ie($.current,W);x&&r&&(!te&&!co)&&_()}),"aria-labelledby":Pe?V:void 0,"aria-describedby":Ce?U:void 0};return c===M.hover&&(y.role="tooltip",y.onMouseEnter=k(f.onMouseEnter,()=>{I.current=!0}),y.onMouseLeave=k(f.onMouseLeave,T=>{T.nativeEvent.relatedTarget!==null&&(I.current=!1,setTimeout(()=>_(),h))})),y},[Te,z,Pe,V,Ce,U,c,n,_,x,r,h,d,u]),to=l.useCallback((f={},C=null)=>we({...f,style:{visibility:x?"visible":"hidden",...f.style}},C),[x,we]),so=l.useCallback((f,C=null)=>({...f,ref:H(C,re,G)}),[re,G]),E=l.useRef(),ne=l.useRef(),Ne=l.useCallback(f=>{re.current==null&&G(f)},[G]),ao=l.useCallback((f={},C=null)=>{const y={...f,ref:H($,C,Ne),id:ke,"aria-haspopup":"dialog","aria-expanded":x,"aria-controls":z};return c===M.click&&(y.onClick=k(f.onClick,ge)),c===M.hover&&(y.onFocus=k(f.onFocus,()=>{E.current===void 0&&oe()}),y.onBlur=k(f.onBlur,T=>{const W=Fe(T),te=!ie(F.current,W);x&&r&&te&&_()}),y.onKeyDown=k(f.onKeyDown,T=>{T.key==="Escape"&&_()}),y.onMouseEnter=k(f.onMouseEnter,()=>{I.current=!0,E.current=window.setTimeout(()=>oe(),p)}),y.onMouseLeave=k(f.onMouseLeave,()=>{I.current=!1,E.current&&(clearTimeout(E.current),E.current=void 0),ne.current=window.setTimeout(()=>{I.current===!1&&_()},h)})),y},[ke,x,z,c,Ne,ge,oe,r,_,p,h]);l.useEffect(()=>()=>{E.current&&clearTimeout(E.current),ne.current&&clearTimeout(ne.current)},[]);const io=l.useCallback((f={},C=null)=>({...f,id:V,ref:H(C,y=>{Ye(!!y)})}),[V]),lo=l.useCallback((f={},C=null)=>({...f,id:U,ref:H(C,y=>{Je(!!y)})}),[U]);return{forceUpdate:ro,isOpen:x,onAnimationComplete:Se.onComplete,onClose:_,getAnchorProps:so,getArrowProps:eo,getArrowInnerProps:oo,getPopoverPositionerProps:to,getPopoverProps:no,getTriggerProps:ao,getHeaderProps:io,getBodyProps:lo}}function ie(o,r){return o===r||o?.contains(r)}function Fe(o){var r;const n=o.currentTarget.ownerDocument.activeElement;return(r=o.relatedTarget)!=null?r:n}function fe(o){const r=De("Popover",o),{children:n,...t}=Ie(o),a=_o(),s=yr({...t,direction:a.direction});return e.jsx(vr,{value:s,children:e.jsx(xr,{value:r,children:Po(n,{isOpen:s.isOpen,onClose:s.onClose,forceUpdate:s.forceUpdate})})})}fe.displayName="Popover";var le=(o,r)=>r?`${o}.${r}, ${r}`:void 0;function he(o){var r;const{bg:n,bgColor:t,backgroundColor:a,shadow:s,boxShadow:i,shadowColor:u}=o,{getArrowProps:d,getArrowInnerProps:c}=R(),p=B(),h=(r=n??t)!=null?r:a,b=s??i;return e.jsx(m.div,{...d(),className:"chakra-popover__arrow-positioner",children:e.jsx(m.div,{className:j("chakra-popover__arrow",o.className),...c(o),__css:{"--popper-arrow-shadow-color":le("colors",u),"--popper-arrow-bg":le("colors",h),"--popper-arrow-shadow":le("shadows",b),...p.arrow}})})}he.displayName="PopoverArrow";var q=v(function(r,n){const{getBodyProps:t}=R(),a=B();return e.jsx(m.div,{...t(r,n),className:j("chakra-popover__body",r.className),__css:a.body})});q.displayName="PopoverBody";var me=v(function(r,n){const{onClose:t}=R(),a=B();return e.jsx(Be,{size:"sm",onClick:t,className:j("chakra-popover__close-btn",r.className),__css:a.closeButton,ref:n,...r})});me.displayName="PopoverCloseButton";function jr(o){if(o)return{enter:{...o.enter,visibility:"visible"},exit:{...o.exit,transitionEnd:{visibility:"hidden"}}}}var br={exit:{opacity:0,scale:.95,transition:{duration:.1,ease:[.4,0,1,1]}},enter:{scale:1,opacity:1,transition:{duration:.15,ease:[0,0,.2,1]}}},gr=m(Y.section),We=v(function(r,n){const{variants:t=br,...a}=r,{isOpen:s}=R();return e.jsx(gr,{ref:n,variants:jr(t),initial:!1,animate:s?"enter":"exit",...a})});We.displayName="PopoverTransition";var ve=v(function(r,n){const{rootProps:t,motionProps:a,...s}=r,{getPopoverProps:i,getPopoverPositionerProps:u,onAnimationComplete:d}=R(),c=B(),p={position:"relative",display:"flex",flexDirection:"column",...c.content};return e.jsx(m.div,{...u(t),__css:c.popper,className:"chakra-popover__popper",children:e.jsx(We,{...a,...i(s,n),onAnimationComplete:Co(d,s.onAnimationComplete),className:j("chakra-popover__content",r.className),__css:p})})});ve.displayName="PopoverContent";function Ke(o){const r=B();return e.jsx(m.footer,{...o,className:j("chakra-popover__footer",o.className),__css:r.footer})}Ke.displayName="PopoverFooter";var[_r,D]=ye({name:"TableStylesContext",errorMessage:`useTableStyles returned is 'undefined'. Seems you forgot to wrap the components in "" `}),qe=v((o,r)=>{const n=De("Table",o),{className:t,layout:a,...s}=Ie(o);return e.jsx(_r,{value:n,children:e.jsx(m.table,{ref:r,__css:{tableLayout:a,...n.table},className:j("chakra-table",t),...s})})});qe.displayName="Table";var Pr=v((o,r)=>{const n=D();return e.jsx(m.thead,{...o,ref:r,__css:n.thead})}),K=v((o,r)=>{const n=D();return e.jsx(m.tr,{...o,ref:r,__css:n.tr})}),Xe=v((o,r)=>{const{placement:n="bottom",...t}=o,a=D();return e.jsx(m.caption,{...t,ref:r,__css:{...a.caption,captionSide:n}})});Xe.displayName="TableCaption";var Cr=v((o,r)=>{var n;const{overflow:t,overflowX:a,className:s,...i}=o;return e.jsx(m.div,{ref:r,className:j("chakra-table__container",s),...i,__css:{display:"block",whiteSpace:"nowrap",WebkitOverflowScrolling:"touch",overflowX:(n=t??a)!=null?n:"auto",overflowY:"hidden",maxWidth:"100%"}})}),kr=v((o,r)=>{const n=D();return e.jsx(m.tbody,{...o,ref:r,__css:n.tbody})}),N=v(({isNumeric:o,...r},n)=>{const t=D();return e.jsx(m.td,{...r,ref:n,__css:t.td,"data-is-numeric":o})}),ce=v(({isNumeric:o,...r},n)=>{const t=D();return e.jsx(m.th,{...r,ref:n,__css:t.th,"data-is-numeric":o})});const wr={"chakra-app":{name:"chakra-app",services:{},ui:{references:[]},properties:{}},"@open-pioneer/runtime":{name:"@open-pioneer/runtime",services:{},ui:{references:[]},properties:{}},"@open-pioneer/chakra-integration":{name:"@open-pioneer/chakra-integration",services:{},ui:{references:[]},properties:{}},"@open-pioneer/base-theme":{name:"@open-pioneer/base-theme",services:{},ui:{references:[]},properties:{}},"@open-pioneer/core":{name:"@open-pioneer/core",services:{},ui:{references:[]},properties:{}},"@open-pioneer/runtime-react-support":{name:"@open-pioneer/runtime-react-support",services:{},ui:{references:[]},properties:{}}},Sr="",Tr=[];function Nr(o){throw new Error(`Unsupported locale: '${o}'`)}const Or=ko(Sr),Er=Object.freeze(Object.defineProperty({__proto__:null,loadMessages:Nr,locales:Tr,packages:wr,styles:Or},Symbol.toStringTag,{value:"Module"})),Rr=wo({colors:{primary:{50:"#defffd",100:"#b3fffa",200:"#86feee",300:"#5bfedd",400:"#3efec9",500:"#32e5a6",600:"#23b277",700:"#147f4c",800:"#004d23",900:"#001b0a"}},fonts:{heading:"Helvetica"},components:{Button:{defaultProps:{colorScheme:"primary"},variants:{cancel:{color:"font_inverse",bg:"error",_hover:{backgroundColor:"error_hover"}}}},Link:{baseStyle:{color:"font_link"}},Divider:{baseStyle:{borderColor:"border"}}},semanticTokens:{colors:{background_primary:"primary.300",background_secondary:"primary.500",placeholder:"primary.100",font_primary:"black",font_secondary:"grey.500",font_inverse:"white",font_link:"yellow.300",border:"black",error:"red.500",error_hover:"red.600",success:"green.500",highlight:"yellow.300","chakra-body-bg":"background_primary","chakra-subtle-bg":"background_secondary","chakra-body-text":"font_primary","chakra-subtle-text":"font_secondary","chakra-inverse-text":"font_inverse","chakra-border-color":"border","chakra-placeholder-color":"placeholder"}}},So);function Fr(){return e.jsx(Cr,{sx:{border:"solid"},children:e.jsxs(qe,{variant:"striped",children:[e.jsx(Xe,{children:"This is the table cation"}),e.jsx(Pr,{children:e.jsxs(K,{children:[e.jsx(ce,{children:"First"}),e.jsx(ce,{children:"Test"}),e.jsx(ce,{isNumeric:!0,children:"Third (numeric)"})]})}),e.jsxs(kr,{children:[e.jsxs(K,{children:[e.jsx(N,{children:"one"}),e.jsx(N,{children:"bla"}),e.jsx(N,{isNumeric:!0,children:"22,3"})]}),e.jsxs(K,{children:[e.jsx(N,{children:"two"}),e.jsx(N,{children:"blub"}),e.jsx(N,{isNumeric:!0,children:"23.4"})]}),e.jsxs(K,{children:[e.jsx(N,{children:"three"}),e.jsx(N,{children:"blob"}),e.jsx(N,{isNumeric:!0,children:"12"})]})]})]})})}function Mr(){return e.jsx("div",{style:{overflow:"auto",height:"100%",width:"100%"},children:e.jsxs(zo,{children:[e.jsx($e,{mb:5,children:"chakra technical demo"}),e.jsx(Ar,{}),e.jsx(Br,{}),e.jsx(Fr,{}),e.jsx(Wr,{})]})})}function Ar(){return e.jsxs(Lo,{children:["This is a"," ",e.jsx(Ho,{href:"https://chakra-ui.com",isExternal:!0,children:"link to Chakra's Design system"})]})}function Br(){return e.jsxs(Le,{mb:5,mt:5,divider:e.jsx($o,{}),spacing:"24px",align:"stretch",children:[e.jsx(S,{children:e.jsx(Dr,{})}),e.jsx(S,{children:e.jsx(Ir,{})}),e.jsx(S,{children:e.jsx(Hr,{})}),e.jsx(S,{children:e.jsx(Lr,{})}),e.jsx(S,{children:e.jsx($r,{})}),e.jsx(S,{children:e.jsx(zr,{})}),e.jsx(S,{children:e.jsx(Vr,{})}),e.jsx(S,{children:e.jsx(Ur,{})}),e.jsx(S,{children:e.jsx(Gr,{})})]})}function Dr(){return e.jsxs(S,{bg:"background_secondary",children:[e.jsx($e,{size:"sm",children:"Portal Example: "}),"This is box and displayed here. Scroll/Look down to see the portal that is added at the end of document.body. The Portal is part of this Box.",e.jsx(He,{children:"This is the portal content!"})]})}function Ir(){return e.jsx(To,{hasArrow:!0,label:"Button Tooltip","aria-label":"A tooltip",placement:"top",children:e.jsx(g,{children:"Button with a tooltip"})})}function Hr(){const o=Vo();return e.jsx(g,{onClick:()=>o({title:"Account created.",description:"We've created your account for you.",status:"success",duration:9e3,position:"bottom-left",isClosable:!0}),children:"Show Toast"})}function Lr(){return e.jsxs(No,{status:"error",children:[e.jsx(Oo,{}),e.jsx(Eo,{children:"Test Alert!"}),e.jsx(Ro,{children:"This is a test alert (error)"})]})}function $r(){const{isOpen:o,onOpen:r,onClose:n}=je(),t=l.useRef(null);return e.jsxs(e.Fragment,{children:[e.jsx(g,{onClick:r,children:"Open Alert"}),e.jsx(Fo,{isOpen:o,leastDestructiveRef:t,onClose:n,children:e.jsx(Z,{children:e.jsxs(Mo,{className:"class-from-app",children:[e.jsx(Q,{fontSize:"lg",fontWeight:"bold",children:"Alert Title"}),e.jsx(ee,{children:"This is the text in the alert dialog body."}),e.jsxs(J,{children:[e.jsx(g,{ref:t,onClick:n,variant:"cancel",children:"Cancel"}),e.jsx(g,{onClick:n,ml:3,children:"Okay"})]})]})})})]})}function zr(){const{isOpen:o,onOpen:r,onClose:n}=je();return e.jsxs(e.Fragment,{children:[e.jsx(g,{onClick:r,children:"Show Modal"}),e.jsxs(Ao,{closeOnOverlayClick:!1,isOpen:o,onClose:n,children:[e.jsx(Z,{}),e.jsxs(Bo,{children:[e.jsx(Q,{children:"This is a modal"}),e.jsx(be,{}),e.jsx(ee,{pb:6,children:"This is a modal text!"}),e.jsxs(J,{children:[e.jsx(g,{mr:2,children:"Got it"}),e.jsx(g,{onClick:n,children:"Cancel"})]})]})]})]})}function Vr(){const{isOpen:o,onOpen:r,onClose:n}=je(),t=l.useRef(null);return e.jsxs(e.Fragment,{children:[e.jsx(g,{ref:t,onClick:r,children:"Open Drawer"}),e.jsxs(Do,{isOpen:o,placement:"left",onClose:n,finalFocusRef:t,isFullHeight:!1,children:[e.jsx(Z,{}),e.jsxs(Ge,{children:[e.jsx(be,{}),e.jsx(Q,{children:"This is the drawer header"}),e.jsx(ee,{children:"This is the body."}),e.jsxs(J,{children:[e.jsx(g,{variant:"outline",mr:3,onClick:n,children:"Cancel"}),e.jsx(g,{children:"Got it"})]})]})]})]})}function Ur(){return e.jsxs(e.Fragment,{children:[e.jsxs(fe,{children:[e.jsx(pe,{children:e.jsx(g,{children:"Show Popover"})}),e.jsxs(ve,{children:[e.jsx(he,{}),e.jsx(me,{}),e.jsx(de,{children:"Popover!"}),e.jsx(q,{children:"This is a very important Popover"})]})]}),e.jsxs(fe,{children:[e.jsx(pe,{children:e.jsx(g,{ml:5,children:"Show Popover rendered in an portal"})}),e.jsx(He,{children:e.jsxs(ve,{children:[e.jsx(he,{}),e.jsx(de,{children:"Header"}),e.jsx(me,{}),e.jsx(q,{children:e.jsx(q,{children:"This is a very important Popover"})}),e.jsx(Ke,{children:"This is the footer"})]})})]})]})}function Gr(){const[o,r]=l.useState("2");return e.jsxs(e.Fragment,{children:[e.jsx(Uo,{onChange:r,value:o,children:e.jsxs(Le,{spacing:4,direction:"row",children:[e.jsx(ae,{size:"sm",value:"1",isDisabled:!0,children:"Radio 1 (Disabled)"}),e.jsx(ae,{size:"md",value:"2",children:"Radio 2"}),e.jsx(ae,{size:"lg",value:"3",children:"Radio 3"})]})}),e.jsx("p",{children:"Checked radio: "+o})]})}function Wr(){return e.jsxs(Go,{m:5,placeholder:"Select an item",children:[e.jsx("option",{value:"item1",children:"Item 1"}),e.jsx("option",{value:"item2",children:"Item 2"}),e.jsx("option",{value:"item3",children:"Item 3"})]})}const Kr=Io({component:Mr,theme:Rr,appMetadata:Er});customElements.define("chakra-app",Kr); +import{r as l,j as e,A as Me,m as Y,d as j,w as X,T as Oe,g as ue,e as uo,u as xe,f as po,h as Ae,i as fo,k as ho,l as mo,n as vo,o as xo,p as m,q as v,s as L,t as A,v as yo,M as jo,C as Be,x as k,y as ye,z as bo,B as go,D as se,E as H,F as De,G as Ie,H as _o,I as Po,J as Co,a as ko,K as wo,L as So,N as He,O as To,P as No,Q as Oo,R as Eo,S as Ro,U as Fo,V as Mo,W as Ao,X as Bo,Y as Do,b as Io}from"./f6bce9997efc.js";import{L as Ho}from"./b6adfc9a8c28.js";import{T as Lo}from"./4ebae876f574.js";import{S as $o}from"./bb18577dbf66.js";import{S as Le}from"./ed8cece5af8e.js";import{C as zo,H as $e}from"./29fb1f323e6e.js";import{B as S}from"./d94fd672bb92.js";import{u as Vo}from"./138a1ee7cdf4.js";import{R as Uo,a as ae}from"./9749530ba15d.js";import{S as Go}from"./0895118db53c.js";import{B as g}from"./2e7753f73b7f.js";import"./a6d9340f2712.js";import"./979d11064765.js";function Wo(){return!!(typeof window<"u"&&window.document&&window.document.createElement)}var Ko=Wo(),qo={enter:({transition:o,transitionEnd:r,delay:n}={})=>{var t;return{opacity:1,transition:(t=o?.enter)!=null?t:X.enter(Oe.enter,n),transitionEnd:r?.enter}},exit:({transition:o,transitionEnd:r,delay:n}={})=>{var t;return{opacity:0,transition:(t=o?.exit)!=null?t:X.exit(Oe.exit,n),transitionEnd:r?.exit}}},ze={initial:"exit",animate:"enter",exit:"exit",variants:qo},Xo=l.forwardRef(function(r,n){const{unmountOnExit:t,in:a,className:s,transition:i,transitionEnd:u,delay:d,...c}=r,p=a||t?"enter":"exit",h=t?a&&t:!0,b={transition:i,transitionEnd:u,delay:d};return e.jsx(Me,{custom:b,children:h&&e.jsx(Y.div,{ref:n,className:j("chakra-fade",s),custom:b,...ze,animate:p,...c})})});Xo.displayName="Fade";var Ee={exit:{duration:.15,ease:uo.easeInOut},enter:{type:"spring",damping:25,stiffness:180}},Yo={exit:({direction:o,transition:r,transitionEnd:n,delay:t})=>{var a;const{exit:s}=ue({direction:o});return{...s,transition:(a=r?.exit)!=null?a:X.exit(Ee.exit,t),transitionEnd:n?.exit}},enter:({direction:o,transitionEnd:r,transition:n,delay:t})=>{var a;const{enter:s}=ue({direction:o});return{...s,transition:(a=n?.enter)!=null?a:X.enter(Ee.enter,t),transitionEnd:r?.enter}}},Ve=l.forwardRef(function(r,n){const{direction:t="right",style:a,unmountOnExit:s,in:i,className:u,transition:d,transitionEnd:c,delay:p,motionProps:h,...b}=r,w=ue({direction:t}),O=Object.assign({position:"fixed"},w.position,a),P=s?i&&s:!0,x=i||s?"enter":"exit",_={transitionEnd:c,transition:d,direction:t,delay:p};return e.jsx(Me,{custom:_,children:P&&e.jsx(Y.div,{...b,ref:n,initial:"exit",className:j("chakra-slide",u),animate:x,exit:"exit",custom:_,variants:Yo,style:O,...h})})});Ve.displayName="Slide";function Jo(o){return"current"in o}var Ue=()=>typeof window<"u";function Qo(){var o;const r=navigator.userAgentData;return(o=r?.platform)!=null?o:navigator.platform}var Zo=o=>Ue()&&o.test(navigator.vendor),er=o=>Ue()&&o.test(Qo()),or=()=>er(/mac|iphone|ipad|ipod/i),rr=()=>or()&&Zo(/apple/i);function nr(o){const{ref:r,elements:n,enabled:t}=o,a=()=>{var s,i;return(i=(s=r.current)==null?void 0:s.ownerDocument)!=null?i:document};xe(a,"pointerdown",s=>{if(!rr()||!t)return;const i=s.target,d=(n??[r]).some(c=>{const p=Jo(c)?c.current:c;return p?.contains(i)||p===i});a().activeElement!==i&&d&&(s.preventDefault(),i.focus())})}var tr=Ko?l.useLayoutEffect:l.useEffect;function Re(o,r=[]){const n=l.useRef(o);return tr(()=>{n.current=o}),l.useCallback((...t)=>{var a;return(a=n.current)==null?void 0:a.call(n,...t)},r)}function sr(o,r){const n=l.useId();return l.useMemo(()=>o||[r,n].filter(Boolean).join("-"),[o,r,n])}function ar(o,r){const n=o!==void 0;return[n,n&&typeof o<"u"?o:r]}function je(o={}){const{onClose:r,onOpen:n,isOpen:t,id:a}=o,s=Re(n),i=Re(r),[u,d]=l.useState(o.defaultIsOpen||!1),[c,p]=ar(t,u),h=sr(a,"disclosure"),b=l.useCallback(()=>{c||d(!1),i?.()},[c,i]),w=l.useCallback(()=>{c||d(!0),s?.()},[c,s]),O=l.useCallback(()=>{(p?b:w)()},[p,w,b]);return{isOpen:!!p,onOpen:w,onClose:b,onToggle:O,isControlled:c,getButtonProps:(P={})=>({...P,"aria-expanded":p,"aria-controls":h,onClick:po(P.onClick,O)}),getDisclosureProps:(P={})=>({...P,hidden:!p,id:h})}}function ir(o){const r=o.current;if(!r)return!1;const n=mo(r);return!n||r.contains(n)?!1:!!vo(n)}function lr(o,r){const{shouldFocus:n,visible:t,focusRef:a}=r,s=n&&!t;Ae(()=>{if(!s||ir(o))return;const i=a?.current||o.current;let u;if(i)return u=requestAnimationFrame(()=>{i.focus({preventScroll:!0})}),()=>{cancelAnimationFrame(u)}},[s,o,a])}var cr={preventScroll:!0,shouldFocus:!1};function ur(o,r=cr){const{focusRef:n,preventScroll:t,shouldFocus:a,visible:s}=r,i=dr(o)?o.current:o,u=a&&s,d=l.useRef(u),c=l.useRef(s);fo(()=>{!c.current&&s&&(d.current=u),c.current=s},[s,u]);const p=l.useCallback(()=>{if(!(!s||!i||!d.current)&&(d.current=!1,!i.contains(document.activeElement)))if(n?.current)requestAnimationFrame(()=>{var h;(h=n.current)==null||h.focus({preventScroll:t})});else{const h=ho(i);h.length>0&&requestAnimationFrame(()=>{h[0].focus({preventScroll:t})})}},[s,t,i,n]);Ae(()=>{p()},[p]),xe(i,"transitionend",p)}function dr(o){return"current"in o}function pr(o){const{isOpen:r,ref:n}=o,[t,a]=l.useState(r),[s,i]=l.useState(!1);return l.useEffect(()=>{s||(a(r),i(!0))},[r,s,t]),xe(()=>n.current,"animationend",()=>{a(r)}),{present:!(r?!1:!t),onComplete(){var d;const c=xo(n.current),p=new c.CustomEvent("animationend",{bubbles:!0});(d=n.current)==null||d.dispatchEvent(p)}}}function fr(o){const{wasSelected:r,enabled:n,isSelected:t,mode:a="unmount"}=o;return!!(!n||t||a==="keepMounted"&&r)}var hr=m(Ve),Ge=v((o,r)=>{const{className:n,children:t,motionProps:a,containerProps:s,...i}=o,{getDialogProps:u,getDialogContainerProps:d,isOpen:c}=L(),p=u(i,r),h=d(s),b=j("chakra-modal__content",n),w=A(),O={display:"flex",flexDirection:"column",position:"relative",width:"100%",outline:0,...w.dialog},P={display:"flex",width:"100vw",height:"$100vh",position:"fixed",left:0,top:0,...w.dialogContainer},{placement:x}=yo();return e.jsx(jo,{children:e.jsx(m.div,{...h,className:"chakra-modal__content-container",__css:P,children:e.jsx(hr,{motionProps:a,direction:x,in:c,className:b,...p,__css:O,children:t})})})});Ge.displayName="DrawerContent";var J=v((o,r)=>{const{className:n,...t}=o,a=j("chakra-modal__footer",n),i={display:"flex",alignItems:"center",justifyContent:"flex-end",...A().footer};return e.jsx(m.footer,{ref:r,...t,__css:i,className:a})});J.displayName="ModalFooter";var Q=v((o,r)=>{const{className:n,...t}=o,{headerId:a,setHeaderMounted:s}=L();l.useEffect(()=>(s(!0),()=>s(!1)),[s]);const i=j("chakra-modal__header",n),d={flex:0,...A().header};return e.jsx(m.header,{ref:r,className:i,id:a,...t,__css:d})});Q.displayName="ModalHeader";var mr=m(Y.div),Z=v((o,r)=>{const{className:n,transition:t,motionProps:a,...s}=o,i=j("chakra-modal__overlay",n),d={pos:"fixed",left:"0",top:"0",w:"100vw",h:"100vh",...A().overlay},{motionPreset:c}=L(),h=a||(c==="none"?{}:ze);return e.jsx(mr,{...h,__css:d,ref:r,className:i,...s})});Z.displayName="ModalOverlay";var ee=v((o,r)=>{const{className:n,...t}=o,{bodyId:a,setBodyMounted:s}=L();l.useEffect(()=>(s(!0),()=>s(!1)),[s]);const i=j("chakra-modal__body",n),u=A();return e.jsx(m.div,{ref:r,className:i,id:a,...t,__css:u.body})});ee.displayName="ModalBody";var be=v((o,r)=>{const{onClick:n,className:t,...a}=o,{onClose:s}=L(),i=j("chakra-modal__close-btn",t),u=A();return e.jsx(Be,{ref:r,__css:u.closeButton,className:i,onClick:k(n,d=>{d.stopPropagation(),s()}),...a})});be.displayName="ModalCloseButton";var[vr,R]=ye({name:"PopoverContext",errorMessage:"usePopoverContext: `context` is undefined. Seems you forgot to wrap all popover components within ``"}),[xr,B]=ye({name:"PopoverStylesContext",errorMessage:`usePopoverStyles returned is 'undefined'. Seems you forgot to wrap the components in "" `}),de=v(function(r,n){const{getHeaderProps:t}=R(),a=B();return e.jsx(m.header,{...t(r,n),className:j("chakra-popover__header",r.className),__css:a.header})});de.displayName="PopoverHeader";function pe(o){const r=l.Children.only(o.children),{getTriggerProps:n}=R();return l.cloneElement(r,n(r.props,r.ref))}pe.displayName="PopoverTrigger";var M={click:"click",hover:"hover"};function yr(o={}){const{closeOnBlur:r=!0,closeOnEsc:n=!0,initialFocusRef:t,id:a,returnFocusOnClose:s=!0,autoFocus:i=!0,arrowSize:u,arrowShadowColor:d,trigger:c=M.click,openDelay:p=200,closeDelay:h=200,isLazy:b,lazyBehavior:w="unmount",computePositionOnMount:O,...P}=o,{isOpen:x,onClose:_,onOpen:oe,onToggle:ge}=bo(o),re=l.useRef(null),$=l.useRef(null),F=l.useRef(null),I=l.useRef(!1),_e=l.useRef(!1);x&&(_e.current=!0);const[Pe,Ye]=l.useState(!1),[Ce,Je]=l.useState(!1),Qe=l.useId(),Ze=a??Qe,[ke,z,V,U]=["popover-trigger","popover-content","popover-header","popover-body"].map(f=>`${f}-${Ze}`),{referenceRef:G,getArrowProps:eo,getPopperProps:we,getArrowInnerProps:oo,forceUpdate:ro}=go({...P,enabled:x||!!O}),Se=pr({isOpen:x,ref:F});nr({enabled:x,ref:$}),lr(F,{focusRef:$,visible:x,shouldFocus:s&&c===M.click}),ur(F,{focusRef:t,visible:x,shouldFocus:i&&c===M.click});const Te=fr({wasSelected:_e.current,enabled:b,mode:w,isSelected:Se.present}),no=l.useCallback((f={},C=null)=>{const y={...f,style:{...f.style,transformOrigin:se.transformOrigin.varRef,[se.arrowSize.var]:u?`${u}px`:void 0,[se.arrowShadowColor.var]:d},ref:H(F,C),children:Te?f.children:null,id:z,tabIndex:-1,role:"dialog",onKeyDown:k(f.onKeyDown,T=>{n&&T.key==="Escape"&&_()}),onBlur:k(f.onBlur,T=>{const W=Fe(T),te=ie(F.current,W),co=ie($.current,W);x&&r&&(!te&&!co)&&_()}),"aria-labelledby":Pe?V:void 0,"aria-describedby":Ce?U:void 0};return c===M.hover&&(y.role="tooltip",y.onMouseEnter=k(f.onMouseEnter,()=>{I.current=!0}),y.onMouseLeave=k(f.onMouseLeave,T=>{T.nativeEvent.relatedTarget!==null&&(I.current=!1,setTimeout(()=>_(),h))})),y},[Te,z,Pe,V,Ce,U,c,n,_,x,r,h,d,u]),to=l.useCallback((f={},C=null)=>we({...f,style:{visibility:x?"visible":"hidden",...f.style}},C),[x,we]),so=l.useCallback((f,C=null)=>({...f,ref:H(C,re,G)}),[re,G]),E=l.useRef(),ne=l.useRef(),Ne=l.useCallback(f=>{re.current==null&&G(f)},[G]),ao=l.useCallback((f={},C=null)=>{const y={...f,ref:H($,C,Ne),id:ke,"aria-haspopup":"dialog","aria-expanded":x,"aria-controls":z};return c===M.click&&(y.onClick=k(f.onClick,ge)),c===M.hover&&(y.onFocus=k(f.onFocus,()=>{E.current===void 0&&oe()}),y.onBlur=k(f.onBlur,T=>{const W=Fe(T),te=!ie(F.current,W);x&&r&&te&&_()}),y.onKeyDown=k(f.onKeyDown,T=>{T.key==="Escape"&&_()}),y.onMouseEnter=k(f.onMouseEnter,()=>{I.current=!0,E.current=window.setTimeout(()=>oe(),p)}),y.onMouseLeave=k(f.onMouseLeave,()=>{I.current=!1,E.current&&(clearTimeout(E.current),E.current=void 0),ne.current=window.setTimeout(()=>{I.current===!1&&_()},h)})),y},[ke,x,z,c,Ne,ge,oe,r,_,p,h]);l.useEffect(()=>()=>{E.current&&clearTimeout(E.current),ne.current&&clearTimeout(ne.current)},[]);const io=l.useCallback((f={},C=null)=>({...f,id:V,ref:H(C,y=>{Ye(!!y)})}),[V]),lo=l.useCallback((f={},C=null)=>({...f,id:U,ref:H(C,y=>{Je(!!y)})}),[U]);return{forceUpdate:ro,isOpen:x,onAnimationComplete:Se.onComplete,onClose:_,getAnchorProps:so,getArrowProps:eo,getArrowInnerProps:oo,getPopoverPositionerProps:to,getPopoverProps:no,getTriggerProps:ao,getHeaderProps:io,getBodyProps:lo}}function ie(o,r){return o===r||o?.contains(r)}function Fe(o){var r;const n=o.currentTarget.ownerDocument.activeElement;return(r=o.relatedTarget)!=null?r:n}function fe(o){const r=De("Popover",o),{children:n,...t}=Ie(o),a=_o(),s=yr({...t,direction:a.direction});return e.jsx(vr,{value:s,children:e.jsx(xr,{value:r,children:Po(n,{isOpen:s.isOpen,onClose:s.onClose,forceUpdate:s.forceUpdate})})})}fe.displayName="Popover";var le=(o,r)=>r?`${o}.${r}, ${r}`:void 0;function he(o){var r;const{bg:n,bgColor:t,backgroundColor:a,shadow:s,boxShadow:i,shadowColor:u}=o,{getArrowProps:d,getArrowInnerProps:c}=R(),p=B(),h=(r=n??t)!=null?r:a,b=s??i;return e.jsx(m.div,{...d(),className:"chakra-popover__arrow-positioner",children:e.jsx(m.div,{className:j("chakra-popover__arrow",o.className),...c(o),__css:{"--popper-arrow-shadow-color":le("colors",u),"--popper-arrow-bg":le("colors",h),"--popper-arrow-shadow":le("shadows",b),...p.arrow}})})}he.displayName="PopoverArrow";var q=v(function(r,n){const{getBodyProps:t}=R(),a=B();return e.jsx(m.div,{...t(r,n),className:j("chakra-popover__body",r.className),__css:a.body})});q.displayName="PopoverBody";var me=v(function(r,n){const{onClose:t}=R(),a=B();return e.jsx(Be,{size:"sm",onClick:t,className:j("chakra-popover__close-btn",r.className),__css:a.closeButton,ref:n,...r})});me.displayName="PopoverCloseButton";function jr(o){if(o)return{enter:{...o.enter,visibility:"visible"},exit:{...o.exit,transitionEnd:{visibility:"hidden"}}}}var br={exit:{opacity:0,scale:.95,transition:{duration:.1,ease:[.4,0,1,1]}},enter:{scale:1,opacity:1,transition:{duration:.15,ease:[0,0,.2,1]}}},gr=m(Y.section),We=v(function(r,n){const{variants:t=br,...a}=r,{isOpen:s}=R();return e.jsx(gr,{ref:n,variants:jr(t),initial:!1,animate:s?"enter":"exit",...a})});We.displayName="PopoverTransition";var ve=v(function(r,n){const{rootProps:t,motionProps:a,...s}=r,{getPopoverProps:i,getPopoverPositionerProps:u,onAnimationComplete:d}=R(),c=B(),p={position:"relative",display:"flex",flexDirection:"column",...c.content};return e.jsx(m.div,{...u(t),__css:c.popper,className:"chakra-popover__popper",children:e.jsx(We,{...a,...i(s,n),onAnimationComplete:Co(d,s.onAnimationComplete),className:j("chakra-popover__content",r.className),__css:p})})});ve.displayName="PopoverContent";function Ke(o){const r=B();return e.jsx(m.footer,{...o,className:j("chakra-popover__footer",o.className),__css:r.footer})}Ke.displayName="PopoverFooter";var[_r,D]=ye({name:"TableStylesContext",errorMessage:`useTableStyles returned is 'undefined'. Seems you forgot to wrap the components in "
" `}),qe=v((o,r)=>{const n=De("Table",o),{className:t,layout:a,...s}=Ie(o);return e.jsx(_r,{value:n,children:e.jsx(m.table,{ref:r,__css:{tableLayout:a,...n.table},className:j("chakra-table",t),...s})})});qe.displayName="Table";var Pr=v((o,r)=>{const n=D();return e.jsx(m.thead,{...o,ref:r,__css:n.thead})}),K=v((o,r)=>{const n=D();return e.jsx(m.tr,{...o,ref:r,__css:n.tr})}),Xe=v((o,r)=>{const{placement:n="bottom",...t}=o,a=D();return e.jsx(m.caption,{...t,ref:r,__css:{...a.caption,captionSide:n}})});Xe.displayName="TableCaption";var Cr=v((o,r)=>{var n;const{overflow:t,overflowX:a,className:s,...i}=o;return e.jsx(m.div,{ref:r,className:j("chakra-table__container",s),...i,__css:{display:"block",whiteSpace:"nowrap",WebkitOverflowScrolling:"touch",overflowX:(n=t??a)!=null?n:"auto",overflowY:"hidden",maxWidth:"100%"}})}),kr=v((o,r)=>{const n=D();return e.jsx(m.tbody,{...o,ref:r,__css:n.tbody})}),N=v(({isNumeric:o,...r},n)=>{const t=D();return e.jsx(m.td,{...r,ref:n,__css:t.td,"data-is-numeric":o})}),ce=v(({isNumeric:o,...r},n)=>{const t=D();return e.jsx(m.th,{...r,ref:n,__css:t.th,"data-is-numeric":o})});const wr={"chakra-app":{name:"chakra-app",services:{},ui:{references:[]},properties:{}},"@open-pioneer/base-theme":{name:"@open-pioneer/base-theme",services:{},ui:{references:[]},properties:{}},"@open-pioneer/runtime":{name:"@open-pioneer/runtime",services:{},ui:{references:[]},properties:{}},"@open-pioneer/chakra-integration":{name:"@open-pioneer/chakra-integration",services:{},ui:{references:[]},properties:{}},"@open-pioneer/core":{name:"@open-pioneer/core",services:{},ui:{references:[]},properties:{}},"@open-pioneer/runtime-react-support":{name:"@open-pioneer/runtime-react-support",services:{},ui:{references:[]},properties:{}}},Sr="",Tr=[];function Nr(o){throw new Error(`Unsupported locale: '${o}'`)}const Or=ko(Sr),Er=Object.freeze(Object.defineProperty({__proto__:null,loadMessages:Nr,locales:Tr,packages:wr,styles:Or},Symbol.toStringTag,{value:"Module"})),Rr=wo({colors:{primary:{50:"#defffd",100:"#b3fffa",200:"#86feee",300:"#5bfedd",400:"#3efec9",500:"#32e5a6",600:"#23b277",700:"#147f4c",800:"#004d23",900:"#001b0a"}},fonts:{heading:"Helvetica"},components:{Button:{defaultProps:{colorScheme:"primary"},variants:{cancel:{color:"font_inverse",bg:"error",_hover:{backgroundColor:"error_hover"}}}},Link:{baseStyle:{color:"font_link"}},Divider:{baseStyle:{borderColor:"border"}}},semanticTokens:{colors:{background_primary:"primary.300",background_secondary:"primary.500",placeholder:"primary.100",font_primary:"black",font_secondary:"grey.500",font_inverse:"white",font_link:"yellow.300",border:"black",error:"red.500",error_hover:"red.600",success:"green.500",highlight:"yellow.300","chakra-body-bg":"background_primary","chakra-subtle-bg":"background_secondary","chakra-body-text":"font_primary","chakra-subtle-text":"font_secondary","chakra-inverse-text":"font_inverse","chakra-border-color":"border","chakra-placeholder-color":"placeholder"}}},So);function Fr(){return e.jsx(Cr,{sx:{border:"solid"},children:e.jsxs(qe,{variant:"striped",children:[e.jsx(Xe,{children:"This is the table cation"}),e.jsx(Pr,{children:e.jsxs(K,{children:[e.jsx(ce,{children:"First"}),e.jsx(ce,{children:"Test"}),e.jsx(ce,{isNumeric:!0,children:"Third (numeric)"})]})}),e.jsxs(kr,{children:[e.jsxs(K,{children:[e.jsx(N,{children:"one"}),e.jsx(N,{children:"bla"}),e.jsx(N,{isNumeric:!0,children:"22,3"})]}),e.jsxs(K,{children:[e.jsx(N,{children:"two"}),e.jsx(N,{children:"blub"}),e.jsx(N,{isNumeric:!0,children:"23.4"})]}),e.jsxs(K,{children:[e.jsx(N,{children:"three"}),e.jsx(N,{children:"blob"}),e.jsx(N,{isNumeric:!0,children:"12"})]})]})]})})}function Mr(){return e.jsx("div",{style:{overflow:"auto",height:"100%",width:"100%"},children:e.jsxs(zo,{children:[e.jsx($e,{mb:5,children:"chakra technical demo"}),e.jsx(Ar,{}),e.jsx(Br,{}),e.jsx(Fr,{}),e.jsx(Wr,{})]})})}function Ar(){return e.jsxs(Lo,{children:["This is a"," ",e.jsx(Ho,{href:"https://chakra-ui.com",isExternal:!0,children:"link to Chakra's Design system"})]})}function Br(){return e.jsxs(Le,{mb:5,mt:5,divider:e.jsx($o,{}),spacing:"24px",align:"stretch",children:[e.jsx(S,{children:e.jsx(Dr,{})}),e.jsx(S,{children:e.jsx(Ir,{})}),e.jsx(S,{children:e.jsx(Hr,{})}),e.jsx(S,{children:e.jsx(Lr,{})}),e.jsx(S,{children:e.jsx($r,{})}),e.jsx(S,{children:e.jsx(zr,{})}),e.jsx(S,{children:e.jsx(Vr,{})}),e.jsx(S,{children:e.jsx(Ur,{})}),e.jsx(S,{children:e.jsx(Gr,{})})]})}function Dr(){return e.jsxs(S,{bg:"background_secondary",children:[e.jsx($e,{size:"sm",children:"Portal Example: "}),"This is box and displayed here. Scroll/Look down to see the portal that is added at the end of document.body. The Portal is part of this Box.",e.jsx(He,{children:"This is the portal content!"})]})}function Ir(){return e.jsx(To,{hasArrow:!0,label:"Button Tooltip","aria-label":"A tooltip",placement:"top",children:e.jsx(g,{children:"Button with a tooltip"})})}function Hr(){const o=Vo();return e.jsx(g,{onClick:()=>o({title:"Account created.",description:"We've created your account for you.",status:"success",duration:9e3,position:"bottom-left",isClosable:!0}),children:"Show Toast"})}function Lr(){return e.jsxs(No,{status:"error",children:[e.jsx(Oo,{}),e.jsx(Eo,{children:"Test Alert!"}),e.jsx(Ro,{children:"This is a test alert (error)"})]})}function $r(){const{isOpen:o,onOpen:r,onClose:n}=je(),t=l.useRef(null);return e.jsxs(e.Fragment,{children:[e.jsx(g,{onClick:r,children:"Open Alert"}),e.jsx(Fo,{isOpen:o,leastDestructiveRef:t,onClose:n,children:e.jsx(Z,{children:e.jsxs(Mo,{className:"class-from-app",children:[e.jsx(Q,{fontSize:"lg",fontWeight:"bold",children:"Alert Title"}),e.jsx(ee,{children:"This is the text in the alert dialog body."}),e.jsxs(J,{children:[e.jsx(g,{ref:t,onClick:n,variant:"cancel",children:"Cancel"}),e.jsx(g,{onClick:n,ml:3,children:"Okay"})]})]})})})]})}function zr(){const{isOpen:o,onOpen:r,onClose:n}=je();return e.jsxs(e.Fragment,{children:[e.jsx(g,{onClick:r,children:"Show Modal"}),e.jsxs(Ao,{closeOnOverlayClick:!1,isOpen:o,onClose:n,children:[e.jsx(Z,{}),e.jsxs(Bo,{children:[e.jsx(Q,{children:"This is a modal"}),e.jsx(be,{}),e.jsx(ee,{pb:6,children:"This is a modal text!"}),e.jsxs(J,{children:[e.jsx(g,{mr:2,children:"Got it"}),e.jsx(g,{onClick:n,children:"Cancel"})]})]})]})]})}function Vr(){const{isOpen:o,onOpen:r,onClose:n}=je(),t=l.useRef(null);return e.jsxs(e.Fragment,{children:[e.jsx(g,{ref:t,onClick:r,children:"Open Drawer"}),e.jsxs(Do,{isOpen:o,placement:"left",onClose:n,finalFocusRef:t,isFullHeight:!1,children:[e.jsx(Z,{}),e.jsxs(Ge,{children:[e.jsx(be,{}),e.jsx(Q,{children:"This is the drawer header"}),e.jsx(ee,{children:"This is the body."}),e.jsxs(J,{children:[e.jsx(g,{variant:"outline",mr:3,onClick:n,children:"Cancel"}),e.jsx(g,{children:"Got it"})]})]})]})]})}function Ur(){return e.jsxs(e.Fragment,{children:[e.jsxs(fe,{children:[e.jsx(pe,{children:e.jsx(g,{children:"Show Popover"})}),e.jsxs(ve,{children:[e.jsx(he,{}),e.jsx(me,{}),e.jsx(de,{children:"Popover!"}),e.jsx(q,{children:"This is a very important Popover"})]})]}),e.jsxs(fe,{children:[e.jsx(pe,{children:e.jsx(g,{ml:5,children:"Show Popover rendered in an portal"})}),e.jsx(He,{children:e.jsxs(ve,{children:[e.jsx(he,{}),e.jsx(de,{children:"Header"}),e.jsx(me,{}),e.jsx(q,{children:e.jsx(q,{children:"This is a very important Popover"})}),e.jsx(Ke,{children:"This is the footer"})]})})]})]})}function Gr(){const[o,r]=l.useState("2");return e.jsxs(e.Fragment,{children:[e.jsx(Uo,{onChange:r,value:o,children:e.jsxs(Le,{spacing:4,direction:"row",children:[e.jsx(ae,{size:"sm",value:"1",isDisabled:!0,children:"Radio 1 (Disabled)"}),e.jsx(ae,{size:"md",value:"2",children:"Radio 2"}),e.jsx(ae,{size:"lg",value:"3",children:"Radio 3"})]})}),e.jsx("p",{children:"Checked radio: "+o})]})}function Wr(){return e.jsxs(Go,{m:5,placeholder:"Select an item",children:[e.jsx("option",{value:"item1",children:"Item 1"}),e.jsx("option",{value:"item2",children:"Item 2"}),e.jsx("option",{value:"item3",children:"Item 3"})]})}const Kr=Io({component:Mr,theme:Rr,appMetadata:Er});customElements.define("chakra-app",Kr); diff --git a/core-packages/assets/afc2429a7da1.js b/core-packages/assets/73a9b51880fc.js similarity index 97% rename from core-packages/assets/afc2429a7da1.js rename to core-packages/assets/73a9b51880fc.js index 456ac3d28..372a53533 100644 --- a/core-packages/assets/afc2429a7da1.js +++ b/core-packages/assets/73a9b51880fc.js @@ -1 +1 @@ -var v=(i,n,e)=>{if(!n.has(i))throw TypeError("Cannot "+e)};var c=(i,n,e)=>(v(i,n,"read from private field"),e?e.call(i):n.get(i)),p=(i,n,e)=>{if(n.has(i))throw TypeError("Cannot add the same private member more than once");n instanceof WeakSet?n.add(i):n.set(i,e)};import{a as u,j as r,b as f}from"./f6bce9997efc.js";import{u as g}from"./25a5152ddbe5.js";import{B as x}from"./2e7753f73b7f.js";import{C as h,H as d}from"./29fb1f323e6e.js";import{T as a}from"./4ebae876f574.js";import{V as A}from"./423259cadff8.js";import"./ed8cece5af8e.js";var o;class w{constructor(n){p(this,o,new Map);const e=c(this,o),t=n.references.providers;for(const l of t){const m=l.createActions();for(const s of m){if(e.has(s.id))throw new Error(`Action '${s.id}' was defined twice.`);e.set(s.id,s)}}}getActionInfo(){const n=Array.from(c(this,o).values()).map(e=>({id:e.id,text:e.text}));return n.sort((e,t)=>e.text.localeCompare(t.text)),n}triggerAction(n){const e=c(this,o).get(n);if(!e)throw new Error(`Action '${n}' was not defined.`);e.trigger()}}o=new WeakMap;class b{createActions(){return[{id:"logging-action",text:"Log a message",trigger(){console.info("Logging a message!")}}]}}class P{createActions(){return[{id:"clear-browser-action",text:"Clear browser",trigger(){document.body.innerHTML=""}},{id:"refresh-browser-action",text:"Refresh browser",trigger(){window.location.reload()}}]}}class j{createActions(){return[{id:"open-window-action",text:"Open window",trigger(){window.open("https://www.conterra.de")}}]}}const S={"extension-app":{name:"extension-app",services:{ActionServiceImpl:{name:"ActionServiceImpl",clazz:w,provides:[{name:"extension-app.ActionService",qualifier:void 0}],references:{providers:{name:"extension-app.ActionProvider",qualifier:void 0,all:!0}}},LoggingActionProvider:{name:"LoggingActionProvider",clazz:b,provides:[{name:"extension-app.ActionProvider",qualifier:void 0}],references:{}},MultiActionProvider:{name:"MultiActionProvider",clazz:P,provides:[{name:"extension-app.ActionProvider",qualifier:void 0}],references:{}},OpenWindowActionProvider:{name:"OpenWindowActionProvider",clazz:j,provides:[{name:"extension-app.ActionProvider",qualifier:void 0}],references:{}}},ui:{references:[{name:"extension-app.ActionService",qualifier:void 0,all:!1}]},properties:{}},"@open-pioneer/runtime":{name:"@open-pioneer/runtime",services:{},ui:{references:[]},properties:{}},"@open-pioneer/chakra-integration":{name:"@open-pioneer/chakra-integration",services:{},ui:{references:[]},properties:{}},"@open-pioneer/base-theme":{name:"@open-pioneer/base-theme",services:{},ui:{references:[]},properties:{}},"@open-pioneer/core":{name:"@open-pioneer/core",services:{},ui:{references:[]},properties:{}},"@open-pioneer/runtime-react-support":{name:"@open-pioneer/runtime-react-support",services:{},ui:{references:[]},properties:{}}},y="",I=[];function z(i){throw new Error(`Unsupported locale: '${i}'`)}const E=u(y),M=Object.freeze(Object.defineProperty({__proto__:null,loadMessages:z,locales:I,packages:S,styles:E},Symbol.toStringTag,{value:"Module"})),T="extension-app",k=g.bind(void 0,T);function C(){const i=k("extension-app.ActionService"),n=i.getActionInfo().map(({id:e,text:t})=>r.jsx(x,{onClick:()=>i.triggerAction(e),children:t},e));return r.jsxs(h,{maxW:"3xl",py:2,children:[r.jsx(d,{as:"h1",size:"4xl",mb:4,children:"Extension Example"}),r.jsx(a,{my:2,children:"This example demonstrates how to provide an extensible API with services and 1-to-N dependencies."}),r.jsxs(a,{my:2,children:["Individual ",r.jsx("code",{children:"ActionProvider"})," instances can provide a number of actions, which are then gathered and indexed by the ",r.jsx("code",{children:"ActionService"}),", which depends on all ActionProviders. The UI references the ",r.jsx("code",{children:"ActionService"})," and renders the provided actions as buttons. When a button is clicked, the appropriate action will be triggered."]}),r.jsxs(a,{my:2,children:["To add a new action, simply add new implementation of"," ",r.jsx("code",{children:'"extension-app.ActionProvider"'}),". The"," ",r.jsx("code",{children:"ActionService"})," will pick it up automatically."]}),r.jsxs(d,{as:"h4",size:"xl",children:["Buttons from ",r.jsx("code",{children:"ActionService"}),":"]}),r.jsx(A,{align:"start",children:n})]})}const q=f({component:C,appMetadata:M});customElements.define("extension-app",q); +var v=(i,n,e)=>{if(!n.has(i))throw TypeError("Cannot "+e)};var c=(i,n,e)=>(v(i,n,"read from private field"),e?e.call(i):n.get(i)),p=(i,n,e)=>{if(n.has(i))throw TypeError("Cannot add the same private member more than once");n instanceof WeakSet?n.add(i):n.set(i,e)};import{a as u,j as r,b as f}from"./f6bce9997efc.js";import{u as g}from"./25a5152ddbe5.js";import{B as x}from"./2e7753f73b7f.js";import{C as h,H as d}from"./29fb1f323e6e.js";import{T as a}from"./4ebae876f574.js";import{V as A}from"./423259cadff8.js";import"./ed8cece5af8e.js";var o;class w{constructor(n){p(this,o,new Map);const e=c(this,o),t=n.references.providers;for(const l of t){const m=l.createActions();for(const s of m){if(e.has(s.id))throw new Error(`Action '${s.id}' was defined twice.`);e.set(s.id,s)}}}getActionInfo(){const n=Array.from(c(this,o).values()).map(e=>({id:e.id,text:e.text}));return n.sort((e,t)=>e.text.localeCompare(t.text)),n}triggerAction(n){const e=c(this,o).get(n);if(!e)throw new Error(`Action '${n}' was not defined.`);e.trigger()}}o=new WeakMap;class b{createActions(){return[{id:"logging-action",text:"Log a message",trigger(){console.info("Logging a message!")}}]}}class P{createActions(){return[{id:"clear-browser-action",text:"Clear browser",trigger(){document.body.innerHTML=""}},{id:"refresh-browser-action",text:"Refresh browser",trigger(){window.location.reload()}}]}}class j{createActions(){return[{id:"open-window-action",text:"Open window",trigger(){window.open("https://www.conterra.de")}}]}}const S={"extension-app":{name:"extension-app",services:{ActionServiceImpl:{name:"ActionServiceImpl",clazz:w,provides:[{name:"extension-app.ActionService",qualifier:void 0}],references:{providers:{name:"extension-app.ActionProvider",qualifier:void 0,all:!0}}},LoggingActionProvider:{name:"LoggingActionProvider",clazz:b,provides:[{name:"extension-app.ActionProvider",qualifier:void 0}],references:{}},MultiActionProvider:{name:"MultiActionProvider",clazz:P,provides:[{name:"extension-app.ActionProvider",qualifier:void 0}],references:{}},OpenWindowActionProvider:{name:"OpenWindowActionProvider",clazz:j,provides:[{name:"extension-app.ActionProvider",qualifier:void 0}],references:{}}},ui:{references:[{name:"extension-app.ActionService",qualifier:void 0,all:!1}]},properties:{}},"@open-pioneer/runtime":{name:"@open-pioneer/runtime",services:{},ui:{references:[]},properties:{}},"@open-pioneer/chakra-integration":{name:"@open-pioneer/chakra-integration",services:{},ui:{references:[]},properties:{}},"@open-pioneer/base-theme":{name:"@open-pioneer/base-theme",services:{},ui:{references:[]},properties:{}},"@open-pioneer/runtime-react-support":{name:"@open-pioneer/runtime-react-support",services:{},ui:{references:[]},properties:{}},"@open-pioneer/core":{name:"@open-pioneer/core",services:{},ui:{references:[]},properties:{}}},y="",I=[];function z(i){throw new Error(`Unsupported locale: '${i}'`)}const E=u(y),M=Object.freeze(Object.defineProperty({__proto__:null,loadMessages:z,locales:I,packages:S,styles:E},Symbol.toStringTag,{value:"Module"})),T="extension-app",k=g.bind(void 0,T);function C(){const i=k("extension-app.ActionService"),n=i.getActionInfo().map(({id:e,text:t})=>r.jsx(x,{onClick:()=>i.triggerAction(e),children:t},e));return r.jsxs(h,{maxW:"3xl",py:2,children:[r.jsx(d,{as:"h1",size:"4xl",mb:4,children:"Extension Example"}),r.jsx(a,{my:2,children:"This example demonstrates how to provide an extensible API with services and 1-to-N dependencies."}),r.jsxs(a,{my:2,children:["Individual ",r.jsx("code",{children:"ActionProvider"})," instances can provide a number of actions, which are then gathered and indexed by the ",r.jsx("code",{children:"ActionService"}),", which depends on all ActionProviders. The UI references the ",r.jsx("code",{children:"ActionService"})," and renders the provided actions as buttons. When a button is clicked, the appropriate action will be triggered."]}),r.jsxs(a,{my:2,children:["To add a new action, simply add new implementation of"," ",r.jsx("code",{children:'"extension-app.ActionProvider"'}),". The"," ",r.jsx("code",{children:"ActionService"})," will pick it up automatically."]}),r.jsxs(d,{as:"h4",size:"xl",children:["Buttons from ",r.jsx("code",{children:"ActionService"}),":"]}),r.jsx(A,{align:"start",children:n})]})}const q=f({component:C,appMetadata:M});customElements.define("extension-app",q); diff --git a/core-packages/assets/f664fa8964c8.js b/core-packages/assets/7cefae59068f.js similarity index 87% rename from core-packages/assets/f664fa8964c8.js rename to core-packages/assets/7cefae59068f.js index ad4269694..9497e298d 100644 --- a/core-packages/assets/f664fa8964c8.js +++ b/core-packages/assets/7cefae59068f.js @@ -1 +1 @@ -var E=(e,s,t)=>{if(!s.has(e))throw TypeError("Cannot "+t)};var i=(e,s,t)=>(E(e,s,"read from private field"),t?t.call(e):s.get(e)),p=(e,s,t)=>{if(s.has(e))throw TypeError("Cannot add the same private member more than once");s instanceof WeakSet?s.add(e):s.set(e,t)},o=(e,s,t,r)=>(E(e,s,"write to private field"),r?r.call(e,t):s.set(e,t),t);var F=(e,s,t)=>(E(e,s,"access private method"),t);import{p as Y,q as L,j as n,d as R,r as d,P as _,Q as N,R as J,S as W,ac as X,ad as Z,ae as ee,c as te,a as ne,b as se}from"./f6bce9997efc.js";import{E as q}from"./960f2965a833.js";import{u as ie,I as re,F as ae}from"./a98298bb138a.js";import{I as M}from"./443a3944a6a7.js";import{C as U,H as G}from"./29fb1f323e6e.js";import{V as oe}from"./423259cadff8.js";import{T as ce}from"./4ebae876f574.js";import{F as T}from"./a6d9340f2712.js";import{F as z}from"./24631eb4775c.js";import{B as y}from"./2e7753f73b7f.js";import{u as O}from"./25a5152ddbe5.js";import"./ed8cece5af8e.js";var ue=Y("div",{baseStyle:{display:"flex",alignItems:"center",justifyContent:"center",position:"absolute",top:"0",zIndex:2}}),b=L(function(s,t){var r,a;const{placement:l="left",...x}=s,A=ie(),c=A.field,I={[l==="left"?"insetStart":"insetEnd"]:"0",width:(r=c?.height)!=null?r:c?.h,height:(a=c?.height)!=null?a:c?.h,fontSize:c?.fontSize,...A.element};return n.jsx(ue,{ref:t,__css:I,...x})});b.id="InputElement";b.displayName="InputElement";var $=L(function(s,t){const{className:r,...a}=s,l=R("chakra-input__left-element",r);return n.jsx(b,{ref:t,placement:"left",className:l,...a})});$.id="InputLeftElement";$.displayName="InputLeftElement";var C=L(function(s,t){const{className:r,...a}=s,l=R("chakra-input__right-element",r);return n.jsx(b,{ref:t,placement:"right",className:l,...a})});C.id="InputRightElement";C.displayName="InputRightElement";function le({doLogin:e,wasLoggedIn:s}){const[t,r]=d.useState(""),[a,l]=d.useState(""),[x,A]=d.useState(!1),[c,P]=d.useState(),[I,K]=d.useState(s),V=S=>{S.preventDefault();const Q=e(t,a);P(Q||""),K(!1)};return n.jsx(U,{p:5,children:n.jsxs(oe,{as:"form",onSubmit:V,spacing:4,children:[n.jsx(G,{as:"h1",textAlign:"center",children:"Login"}),n.jsxs(ce,{textAlign:"center",children:["Please enter your user name and password to authenticate.",n.jsx("br",{}),"Note: credentials are ",'"admin"'," / ",'"admin"']}),c&&n.jsxs(_,{status:"error",children:[n.jsx(N,{}),n.jsx(J,{children:c})]}),I&&n.jsxs(_,{status:"info",mb:5,children:[n.jsx(N,{}),n.jsxs(W,{children:["Logout successful.",n.jsx("br",{}),"You can use the form below to log in again."]})]}),n.jsxs(T,{children:[n.jsx(z,{children:"User name"}),n.jsx(M,{placeholder:"User name",value:t,onChange:S=>r(S.target.value),autoComplete:"username"})]}),n.jsxs(T,{children:[n.jsx(z,{children:"Password"}),n.jsxs(re,{children:[n.jsx(M,{pr:"4.5rem",type:x?"text":"password",placeholder:"Enter password",value:a,onChange:S=>l(S.target.value),autoComplete:"current-password"}),n.jsx(C,{width:"4.5rem",children:n.jsx(y,{h:"1.75rem",size:"sm",onClick:()=>A(!x),children:x?"Hide":"Show"})})]})]}),n.jsx(y,{type:"submit",children:"Login"})]})})}var m,f,k;class he extends q{constructor(){super();p(this,m,{kind:"pending"});p(this,f,void 0);p(this,k,!1);o(this,f,setTimeout(()=>{o(this,m,{kind:"not-authenticated"}),this.emit("changed")},500))}destroy(){clearTimeout(i(this,f)),o(this,f,void 0)}getAuthState(){return i(this,m)}getLoginBehavior(){const t=(a,l)=>{if(a==="admin"&&l==="admin")o(this,m,{kind:"authenticated",sessionInfo:{userId:"admin",userName:"Arnold Administrator"}}),o(this,k,!0),this.emit("changed");else return"Invalid user name or password!"};return{kind:"fallback",Fallback:()=>d.createElement(le,{doLogin:t,wasLoggedIn:i(this,k)})}}logout(){(i(this,m).kind==="authenticated"||i(this,m).kind==="pending")&&(o(this,m,{kind:"not-authenticated"}),clearTimeout(i(this,f)),o(this,f,void 0),this.emit("changed"))}}m=new WeakMap,f=new WeakMap,k=new WeakMap;const w=te("authentication:AuthService");var g,u,h,v,j,H;class de extends q{constructor(t){super();p(this,j);p(this,g,void 0);p(this,u,void 0);p(this,h,void 0);p(this,v,void 0);o(this,g,t.references.plugin),o(this,u,i(this,g).getAuthState()),o(this,v,i(this,g).on?.("changed",()=>F(this,j,H).call(this))),w.debug(`Constructed with initial auth state '${i(this,u).kind}'`,i(this,u))}destroy(){i(this,h)?.reject(X()),o(this,h,void 0),o(this,v,Z(i(this,v)))}getAuthState(){return i(this,u)}getSessionInfo(){return i(this,u).kind!=="pending"?Promise.resolve(B(i(this,u))):(i(this,h)||o(this,h,ee()),i(this,h).promise)}getLoginBehavior(){return i(this,g).getLoginBehavior()}logout(){w.debug("Triggering logout"),i(this,g).logout()}}g=new WeakMap,u=new WeakMap,h=new WeakMap,v=new WeakMap,j=new WeakSet,H=function(){const t=i(this,g).getAuthState();o(this,u,t),t.kind!=="pending"&&i(this,h)&&(i(this,h).resolve(B(t)),o(this,h,void 0)),w.debug(`Auth state changed to '${i(this,u).kind}'`,i(this,u)),this.emit("changed")};function B(e){return e.kind==="authenticated"?e.sessionInfo:void 0}const pe={"auth-app":{name:"auth-app",services:{TestAuthPlugin:{name:"TestAuthPlugin",clazz:he,provides:[{name:"authentication.AuthPlugin",qualifier:void 0}],references:{}}},ui:{references:[{name:"authentication.AuthService",qualifier:void 0,all:!1}]},properties:{}},"@open-pioneer/core":{name:"@open-pioneer/core",services:{},ui:{references:[]},properties:{}},"@open-pioneer/chakra-integration":{name:"@open-pioneer/chakra-integration",services:{},ui:{references:[]},properties:{}},"@open-pioneer/runtime":{name:"@open-pioneer/runtime",services:{},ui:{references:[]},properties:{}},"@open-pioneer/base-theme":{name:"@open-pioneer/base-theme",services:{},ui:{references:[]},properties:{}},"@open-pioneer/runtime-react-support":{name:"@open-pioneer/runtime-react-support",services:{},ui:{references:[]},properties:{}},"@open-pioneer/authentication":{name:"@open-pioneer/authentication",services:{AuthServiceImpl:{name:"AuthServiceImpl",clazz:de,provides:[{name:"authentication.AuthService",qualifier:void 0}],references:{plugin:{name:"authentication.AuthPlugin",qualifier:void 0,all:!1}}}},ui:{references:[{name:"authentication.AuthService",qualifier:void 0,all:!1}]},properties:{}}},me="",ge=[];function fe(e){throw new Error(`Unsupported locale: '${e}'`)}const ve=ne(me),xe=Object.freeze(Object.defineProperty({__proto__:null,loadMessages:fe,locales:ge,packages:pe,styles:ve},Symbol.toStringTag,{value:"Module"})),Se="@open-pioneer/authentication",ke=O.bind(void 0,Se);function D(e){const s=d.useCallback(a=>{const l=e.on("changed",a);return()=>l.destroy()},[e]),t=d.useCallback(()=>e.getAuthState(),[e]);return d.useSyncExternalStore(s,t)}const Ae=e=>{const s=ke("authentication.AuthService"),t=D(s),r=d.useMemo(()=>{if(t.kind==="not-authenticated")return s.getLoginBehavior()},[s,t.kind]);switch(d.useEffect(()=>{t.kind==="not-authenticated"&&r?.kind==="effect"&&r.login()},[r,t.kind]),t.kind){case"pending":return null;case"not-authenticated":{if(!r||r.kind!=="fallback")return null;const a=r.Fallback;return e.renderFallback?n.jsx(n.Fragment,{children:e.renderFallback(a)}):n.jsx(a,{...e.fallbackProps})}case"authenticated":return n.jsx(n.Fragment,{children:e.children})}},je="auth-app",be=O.bind(void 0,je);function Ie(){const e=be("authentication.AuthService"),s=D(e),t=()=>{e.logout()};return s.kind==="not-authenticated"||s.kind==="pending"?null:n.jsx(y,{colorScheme:"red",onClick:t,children:"Log out"})}function Ee(){return n.jsx(Ae,{children:n.jsxs(U,{p:5,children:[n.jsx(G,{as:"h1",children:"Authenticated"}),"This is the actual content of the app. Authentication was successful.",n.jsx(ae,{pt:5,flexDirection:"row",justifyContent:"center",children:n.jsx(Ie,{})})]})})}const we=se({component:Ee,appMetadata:xe});customElements.define("auth-app",we); +var E=(e,s,t)=>{if(!s.has(e))throw TypeError("Cannot "+t)};var i=(e,s,t)=>(E(e,s,"read from private field"),t?t.call(e):s.get(e)),p=(e,s,t)=>{if(s.has(e))throw TypeError("Cannot add the same private member more than once");s instanceof WeakSet?s.add(e):s.set(e,t)},o=(e,s,t,r)=>(E(e,s,"write to private field"),r?r.call(e,t):s.set(e,t),t);var F=(e,s,t)=>(E(e,s,"access private method"),t);import{p as Y,q as L,j as n,d as R,r as d,P as _,Q as N,R as J,S as W,ac as X,ad as Z,ae as ee,c as te,a as ne,b as se}from"./f6bce9997efc.js";import{E as q}from"./960f2965a833.js";import{u as ie,I as re,F as ae}from"./a98298bb138a.js";import{I as M}from"./443a3944a6a7.js";import{C as U,H as G}from"./29fb1f323e6e.js";import{V as oe}from"./423259cadff8.js";import{T as ce}from"./4ebae876f574.js";import{F as T}from"./a6d9340f2712.js";import{F as z}from"./24631eb4775c.js";import{B as y}from"./2e7753f73b7f.js";import{u as O}from"./25a5152ddbe5.js";import"./ed8cece5af8e.js";var ue=Y("div",{baseStyle:{display:"flex",alignItems:"center",justifyContent:"center",position:"absolute",top:"0",zIndex:2}}),b=L(function(s,t){var r,a;const{placement:l="left",...x}=s,A=ie(),c=A.field,I={[l==="left"?"insetStart":"insetEnd"]:"0",width:(r=c?.height)!=null?r:c?.h,height:(a=c?.height)!=null?a:c?.h,fontSize:c?.fontSize,...A.element};return n.jsx(ue,{ref:t,__css:I,...x})});b.id="InputElement";b.displayName="InputElement";var $=L(function(s,t){const{className:r,...a}=s,l=R("chakra-input__left-element",r);return n.jsx(b,{ref:t,placement:"left",className:l,...a})});$.id="InputLeftElement";$.displayName="InputLeftElement";var C=L(function(s,t){const{className:r,...a}=s,l=R("chakra-input__right-element",r);return n.jsx(b,{ref:t,placement:"right",className:l,...a})});C.id="InputRightElement";C.displayName="InputRightElement";function le({doLogin:e,wasLoggedIn:s}){const[t,r]=d.useState(""),[a,l]=d.useState(""),[x,A]=d.useState(!1),[c,P]=d.useState(),[I,K]=d.useState(s),V=S=>{S.preventDefault();const Q=e(t,a);P(Q||""),K(!1)};return n.jsx(U,{p:5,children:n.jsxs(oe,{as:"form",onSubmit:V,spacing:4,children:[n.jsx(G,{as:"h1",textAlign:"center",children:"Login"}),n.jsxs(ce,{textAlign:"center",children:["Please enter your user name and password to authenticate.",n.jsx("br",{}),"Note: credentials are ",'"admin"'," / ",'"admin"']}),c&&n.jsxs(_,{status:"error",children:[n.jsx(N,{}),n.jsx(J,{children:c})]}),I&&n.jsxs(_,{status:"info",mb:5,children:[n.jsx(N,{}),n.jsxs(W,{children:["Logout successful.",n.jsx("br",{}),"You can use the form below to log in again."]})]}),n.jsxs(T,{children:[n.jsx(z,{children:"User name"}),n.jsx(M,{placeholder:"User name",value:t,onChange:S=>r(S.target.value),autoComplete:"username"})]}),n.jsxs(T,{children:[n.jsx(z,{children:"Password"}),n.jsxs(re,{children:[n.jsx(M,{pr:"4.5rem",type:x?"text":"password",placeholder:"Enter password",value:a,onChange:S=>l(S.target.value),autoComplete:"current-password"}),n.jsx(C,{width:"4.5rem",children:n.jsx(y,{h:"1.75rem",size:"sm",onClick:()=>A(!x),children:x?"Hide":"Show"})})]})]}),n.jsx(y,{type:"submit",children:"Login"})]})})}var m,f,k;class he extends q{constructor(){super();p(this,m,{kind:"pending"});p(this,f,void 0);p(this,k,!1);o(this,f,setTimeout(()=>{o(this,m,{kind:"not-authenticated"}),this.emit("changed")},500))}destroy(){clearTimeout(i(this,f)),o(this,f,void 0)}getAuthState(){return i(this,m)}getLoginBehavior(){const t=(a,l)=>{if(a==="admin"&&l==="admin")o(this,m,{kind:"authenticated",sessionInfo:{userId:"admin",userName:"Arnold Administrator"}}),o(this,k,!0),this.emit("changed");else return"Invalid user name or password!"};return{kind:"fallback",Fallback:()=>d.createElement(le,{doLogin:t,wasLoggedIn:i(this,k)})}}logout(){(i(this,m).kind==="authenticated"||i(this,m).kind==="pending")&&(o(this,m,{kind:"not-authenticated"}),clearTimeout(i(this,f)),o(this,f,void 0),this.emit("changed"))}}m=new WeakMap,f=new WeakMap,k=new WeakMap;const w=te("authentication:AuthService");var g,u,h,v,j,H;class de extends q{constructor(t){super();p(this,j);p(this,g,void 0);p(this,u,void 0);p(this,h,void 0);p(this,v,void 0);o(this,g,t.references.plugin),o(this,u,i(this,g).getAuthState()),o(this,v,i(this,g).on?.("changed",()=>F(this,j,H).call(this))),w.debug(`Constructed with initial auth state '${i(this,u).kind}'`,i(this,u))}destroy(){i(this,h)?.reject(X()),o(this,h,void 0),o(this,v,Z(i(this,v)))}getAuthState(){return i(this,u)}getSessionInfo(){return i(this,u).kind!=="pending"?Promise.resolve(B(i(this,u))):(i(this,h)||o(this,h,ee()),i(this,h).promise)}getLoginBehavior(){return i(this,g).getLoginBehavior()}logout(){w.debug("Triggering logout"),i(this,g).logout()}}g=new WeakMap,u=new WeakMap,h=new WeakMap,v=new WeakMap,j=new WeakSet,H=function(){const t=i(this,g).getAuthState();o(this,u,t),t.kind!=="pending"&&i(this,h)&&(i(this,h).resolve(B(t)),o(this,h,void 0)),w.debug(`Auth state changed to '${i(this,u).kind}'`,i(this,u)),this.emit("changed")};function B(e){return e.kind==="authenticated"?e.sessionInfo:void 0}const pe={"auth-app":{name:"auth-app",services:{TestAuthPlugin:{name:"TestAuthPlugin",clazz:he,provides:[{name:"authentication.AuthPlugin",qualifier:void 0}],references:{}}},ui:{references:[{name:"authentication.AuthService",qualifier:void 0,all:!1}]},properties:{}},"@open-pioneer/runtime":{name:"@open-pioneer/runtime",services:{},ui:{references:[]},properties:{}},"@open-pioneer/chakra-integration":{name:"@open-pioneer/chakra-integration",services:{},ui:{references:[]},properties:{}},"@open-pioneer/core":{name:"@open-pioneer/core",services:{},ui:{references:[]},properties:{}},"@open-pioneer/authentication":{name:"@open-pioneer/authentication",services:{AuthServiceImpl:{name:"AuthServiceImpl",clazz:de,provides:[{name:"authentication.AuthService",qualifier:void 0}],references:{plugin:{name:"authentication.AuthPlugin",qualifier:void 0,all:!1}}}},ui:{references:[{name:"authentication.AuthService",qualifier:void 0,all:!1}]},properties:{}},"@open-pioneer/base-theme":{name:"@open-pioneer/base-theme",services:{},ui:{references:[]},properties:{}},"@open-pioneer/runtime-react-support":{name:"@open-pioneer/runtime-react-support",services:{},ui:{references:[]},properties:{}}},me="",ge=[];function fe(e){throw new Error(`Unsupported locale: '${e}'`)}const ve=ne(me),xe=Object.freeze(Object.defineProperty({__proto__:null,loadMessages:fe,locales:ge,packages:pe,styles:ve},Symbol.toStringTag,{value:"Module"})),Se="@open-pioneer/authentication",ke=O.bind(void 0,Se);function D(e){const s=d.useCallback(a=>{const l=e.on("changed",a);return()=>l.destroy()},[e]),t=d.useCallback(()=>e.getAuthState(),[e]);return d.useSyncExternalStore(s,t)}const Ae=e=>{const s=ke("authentication.AuthService"),t=D(s),r=d.useMemo(()=>{if(t.kind==="not-authenticated")return s.getLoginBehavior()},[s,t.kind]);switch(d.useEffect(()=>{t.kind==="not-authenticated"&&r?.kind==="effect"&&r.login()},[r,t.kind]),t.kind){case"pending":return null;case"not-authenticated":{if(!r||r.kind!=="fallback")return null;const a=r.Fallback;return e.renderFallback?n.jsx(n.Fragment,{children:e.renderFallback(a)}):n.jsx(a,{...e.fallbackProps})}case"authenticated":return n.jsx(n.Fragment,{children:e.children})}},je="auth-app",be=O.bind(void 0,je);function Ie(){const e=be("authentication.AuthService"),s=D(e),t=()=>{e.logout()};return s.kind==="not-authenticated"||s.kind==="pending"?null:n.jsx(y,{colorScheme:"red",onClick:t,children:"Log out"})}function Ee(){return n.jsx(Ae,{children:n.jsxs(U,{p:5,children:[n.jsx(G,{as:"h1",children:"Authenticated"}),"This is the actual content of the app. Authentication was successful.",n.jsx(ae,{pt:5,flexDirection:"row",justifyContent:"center",children:n.jsx(Ie,{})})]})})}const we=se({component:Ee,appMetadata:xe});customElements.define("auth-app",we); diff --git a/core-packages/assets/c8636be98652.js b/core-packages/assets/8cb5dde696b5.js similarity index 90% rename from core-packages/assets/c8636be98652.js rename to core-packages/assets/8cb5dde696b5.js index 7a715e56f..cb3f423f1 100644 --- a/core-packages/assets/c8636be98652.js +++ b/core-packages/assets/8cb5dde696b5.js @@ -1 +1 @@ -import{a as l,r as a,j as r,b as m}from"./f6bce9997efc.js";import{E as f}from"./960f2965a833.js";import{u}from"./25a5152ddbe5.js";import{u as d}from"./138a1ee7cdf4.js";import{F as h}from"./a6d9340f2712.js";import{F as v}from"./24631eb4775c.js";import{C as g,H as E}from"./29fb1f323e6e.js";import{V as x}from"./423259cadff8.js";import{T as b}from"./4ebae876f574.js";import{I as j}from"./443a3944a6a7.js";import{H as N}from"./13ce7a9f2023.js";import{B as s}from"./2e7753f73b7f.js";import"./ed8cece5af8e.js";const p={DEBUG:0,INFO:1,ERROR:2};class I extends f{level;constructor(e){super(),this.level=w(e.properties)}notify(e,o="INFO"){p[this.level]>p[o]||this.emit("show-notification",{level:o,message:e})}}function w(t){const e=t.notifierLevel;switch(e){case"DEBUG":case"INFO":case"ERROR":return e}throw new Error(`Invalid notifier level: '${e}'.`)}const F={"properties-app":{name:"properties-app",services:{NotifierImpl:{name:"NotifierImpl",clazz:I,provides:[{name:"properties-app.Notifier",qualifier:void 0}],references:{}}},ui:{references:[{name:"properties-app.Notifier",qualifier:void 0,all:!1}]},properties:{notifierLevel:{value:"INFO",required:!1}}},"@open-pioneer/runtime":{name:"@open-pioneer/runtime",services:{},ui:{references:[]},properties:{}},"@open-pioneer/chakra-integration":{name:"@open-pioneer/chakra-integration",services:{},ui:{references:[]},properties:{}},"@open-pioneer/core":{name:"@open-pioneer/core",services:{},ui:{references:[]},properties:{}},"@open-pioneer/base-theme":{name:"@open-pioneer/base-theme",services:{},ui:{references:[]},properties:{}},"@open-pioneer/runtime-react-support":{name:"@open-pioneer/runtime-react-support",services:{},ui:{references:[]},properties:{}}},R="",C=[];function O(t){throw new Error(`Unsupported locale: '${t}'`)}const S=l(R),k=Object.freeze(Object.defineProperty({__proto__:null,loadMessages:O,locales:C,packages:F,styles:S},Symbol.toStringTag,{value:"Module"})),y="properties-app",c=u.bind(void 0,y),T={DEBUG:void 0,INFO:"info",ERROR:"error"};function L(){const t=c("properties-app.Notifier"),e=d();return a.useEffect(()=>{const o=t.on("show-notification",i=>{e({position:"bottom-right",title:i.message,isClosable:!0,status:T[i.level]})});return()=>o.destroy()},[t,e]),null}function U(){return r.jsxs(r.Fragment,{children:[r.jsx(L,{}),r.jsx(A,{})]})}function A(){const t=c("properties-app.Notifier"),[e,o]=a.useState(""),i=n=>{e&&t.notify(e,n)};return r.jsx(g,{children:r.jsxs(x,{my:"20",children:[r.jsx(E,{size:"m",children:"Notifier Sample"}),r.jsxs(b,{children:["This Form attempts to emit a notification with a certain level when clicking one of the button below. The notifier will ignore notifications with a level lower than ",r.jsx("strong",{children:t.level}),". The notifier's level can be configured using an attribute on the web component element."]}),r.jsxs(h,{pt:"3",children:[r.jsx(v,{children:"Enter a message and click one of the buttons to emit a notification"}),r.jsx(j,{placeholder:"Notification text...",value:e,onChange:n=>o(n.target.value)})]}),r.jsxs(N,{children:[r.jsx(s,{onClick:i.bind(void 0,"DEBUG"),children:"Debug"}),r.jsx(s,{onClick:i.bind(void 0,"INFO"),children:"Info"}),r.jsx(s,{onClick:i.bind(void 0,"ERROR"),children:"Error"})]})]})})}const B=m({component:U,appMetadata:k,async resolveConfig(t){const e=t.getAttribute("level");return e?{properties:{"properties-app":{notifierLevel:e}}}:void 0}});customElements.define("properties-app",B); +import{a as l,r as a,j as r,b as m}from"./f6bce9997efc.js";import{E as f}from"./960f2965a833.js";import{u}from"./25a5152ddbe5.js";import{u as d}from"./138a1ee7cdf4.js";import{F as h}from"./a6d9340f2712.js";import{F as v}from"./24631eb4775c.js";import{C as g,H as E}from"./29fb1f323e6e.js";import{V as x}from"./423259cadff8.js";import{T as b}from"./4ebae876f574.js";import{I as j}from"./443a3944a6a7.js";import{H as N}from"./13ce7a9f2023.js";import{B as s}from"./2e7753f73b7f.js";import"./ed8cece5af8e.js";const p={DEBUG:0,INFO:1,ERROR:2};class I extends f{level;constructor(e){super(),this.level=w(e.properties)}notify(e,o="INFO"){p[this.level]>p[o]||this.emit("show-notification",{level:o,message:e})}}function w(t){const e=t.notifierLevel;switch(e){case"DEBUG":case"INFO":case"ERROR":return e}throw new Error(`Invalid notifier level: '${e}'.`)}const F={"properties-app":{name:"properties-app",services:{NotifierImpl:{name:"NotifierImpl",clazz:I,provides:[{name:"properties-app.Notifier",qualifier:void 0}],references:{}}},ui:{references:[{name:"properties-app.Notifier",qualifier:void 0,all:!1}]},properties:{notifierLevel:{value:"INFO",required:!1}}},"@open-pioneer/chakra-integration":{name:"@open-pioneer/chakra-integration",services:{},ui:{references:[]},properties:{}},"@open-pioneer/core":{name:"@open-pioneer/core",services:{},ui:{references:[]},properties:{}},"@open-pioneer/runtime":{name:"@open-pioneer/runtime",services:{},ui:{references:[]},properties:{}},"@open-pioneer/base-theme":{name:"@open-pioneer/base-theme",services:{},ui:{references:[]},properties:{}},"@open-pioneer/runtime-react-support":{name:"@open-pioneer/runtime-react-support",services:{},ui:{references:[]},properties:{}}},R="",C=[];function O(t){throw new Error(`Unsupported locale: '${t}'`)}const S=l(R),k=Object.freeze(Object.defineProperty({__proto__:null,loadMessages:O,locales:C,packages:F,styles:S},Symbol.toStringTag,{value:"Module"})),y="properties-app",c=u.bind(void 0,y),T={DEBUG:void 0,INFO:"info",ERROR:"error"};function L(){const t=c("properties-app.Notifier"),e=d();return a.useEffect(()=>{const o=t.on("show-notification",i=>{e({position:"bottom-right",title:i.message,isClosable:!0,status:T[i.level]})});return()=>o.destroy()},[t,e]),null}function U(){return r.jsxs(r.Fragment,{children:[r.jsx(L,{}),r.jsx(A,{})]})}function A(){const t=c("properties-app.Notifier"),[e,o]=a.useState(""),i=n=>{e&&t.notify(e,n)};return r.jsx(g,{children:r.jsxs(x,{my:"20",children:[r.jsx(E,{size:"m",children:"Notifier Sample"}),r.jsxs(b,{children:["This Form attempts to emit a notification with a certain level when clicking one of the button below. The notifier will ignore notifications with a level lower than ",r.jsx("strong",{children:t.level}),". The notifier's level can be configured using an attribute on the web component element."]}),r.jsxs(h,{pt:"3",children:[r.jsx(v,{children:"Enter a message and click one of the buttons to emit a notification"}),r.jsx(j,{placeholder:"Notification text...",value:e,onChange:n=>o(n.target.value)})]}),r.jsxs(N,{children:[r.jsx(s,{onClick:i.bind(void 0,"DEBUG"),children:"Debug"}),r.jsx(s,{onClick:i.bind(void 0,"INFO"),children:"Info"}),r.jsx(s,{onClick:i.bind(void 0,"ERROR"),children:"Error"})]})]})})}const B=m({component:U,appMetadata:k,async resolveConfig(t){const e=t.getAttribute("level");return e?{properties:{"properties-app":{notifierLevel:e}}}:void 0}});customElements.define("properties-app",B); diff --git a/core-packages/assets/df8af7ec6993.js b/core-packages/assets/e833d06c991d.js similarity index 94% rename from core-packages/assets/df8af7ec6993.js rename to core-packages/assets/e833d06c991d.js index 86451e498..f7a88f977 100644 --- a/core-packages/assets/df8af7ec6993.js +++ b/core-packages/assets/e833d06c991d.js @@ -1,4 +1,4 @@ var b=(t,e,o)=>{if(!e.has(t))throw TypeError("Cannot "+o)};var u=(t,e,o)=>(b(t,e,"read from private field"),o?o.call(t):e.get(t)),v=(t,e,o)=>{if(e.has(t))throw TypeError("Cannot add the same private member more than once");e instanceof WeakSet?e.add(t):e.set(t,o)},y=(t,e,o,r)=>(b(t,e,"write to private field"),r?r.call(t,o):e.set(t,o),o);var S=(t,e,o)=>(b(t,e,"access private method"),o);import{r as c,q as R,j as i,a2 as z,d as G,p as L,c as F,a as P,b as U}from"./f6bce9997efc.js";import{u as H}from"./25a5152ddbe5.js";import{u as O}from"./138a1ee7cdf4.js";import{T as W,C as Z}from"./fe5f8405bb7b.js";import{a as $,B as T}from"./2e7753f73b7f.js";import{C as K,H as V}from"./29fb1f323e6e.js";import{S as N}from"./ed8cece5af8e.js";import{T as J}from"./4ebae876f574.js";import{B as Q}from"./d94fd672bb92.js";import{F as C}from"./a6d9340f2712.js";import{F as w}from"./24631eb4775c.js";import{I as X}from"./443a3944a6a7.js";import{S as Y}from"./0895118db53c.js";import"./979d11064765.js";function ee(t){const{viewBox:e="0 0 24 24",d:o,displayName:r,defaultProps:s={}}=t,l=c.Children.toArray(t.path),f=R((d,n)=>i.jsx(z,{ref:n,viewBox:e,...s,...d,children:l.length?l:i.jsx("path",{fill:"currentColor",d:o})}));return f.displayName=r,f}var te={horizontal:{"> *:first-of-type:not(:last-of-type)":{borderEndRadius:0},"> *:not(:first-of-type):not(:last-of-type)":{borderRadius:0},"> *:not(:first-of-type):last-of-type":{borderStartRadius:0}},vertical:{"> *:first-of-type:not(:last-of-type)":{borderBottomRadius:0},"> *:not(:first-of-type):not(:last-of-type)":{borderRadius:0},"> *:not(:first-of-type):last-of-type":{borderTopRadius:0}}},ie={horizontal:t=>({"& > *:not(style) ~ *:not(style)":{marginStart:t}}),vertical:t=>({"& > *:not(style) ~ *:not(style)":{marginTop:t}})},M=R(function(e,o){const{size:r,colorScheme:s,variant:l,className:f,spacing:d="0.5rem",isAttached:n,isDisabled:h,orientation:m="horizontal",...a}=e,B=G("chakra-button__group",f),_=c.useMemo(()=>({size:r,colorScheme:s,variant:l,isDisabled:h}),[r,s,l,h]);let D={display:"inline-flex",...n?te[m]:ie[m](d)};const q=m==="vertical";return i.jsx($,{value:_,children:i.jsx(L.div,{ref:o,role:"group",__css:D,className:B,"data-attached":n?"":void 0,"data-orientation":m,flexDir:q?"column":void 0,...a})})});M.displayName="ButtonGroup";const k=F("notifier:NotificationService");var p,g,x,j,A,E,re;class oe{constructor(){v(this,j);v(this,E);v(this,p,void 0);v(this,g,void 0);v(this,x,void 0)}destroy(){clearTimeout(u(this,x)),y(this,x,void 0)}notify(e){S(this,j,A).call(this,"showNotification",{title:e.title??void 0,message:e.message??void 0,level:e.level??"info",displayDuration:e.displayDuration})}closeAll(){S(this,j,A).call(this,"closeAll")}registerHandler(e){if(u(this,p))return k.warn(`A notification handler has already been registered; this new handler will be ignored. The component has likely been used twice in your application.`),{destroy(){}};y(this,p,e);const o=u(this,g);if(y(this,g,void 0),o)for(const[s,...l]of o)e[s](...l);let r=!1;return{destroy:()=>{r||(r=!0,u(this,p)===e&&y(this,p,void 0))}}}}p=new WeakMap,g=new WeakMap,x=new WeakMap,j=new WeakSet,A=function(e,...o){if(u(this,p))u(this,p)[e](...o);else{const r=u(this,g)??y(this,g,[]);if(r.length>=1024){k.error(`Internal notification buffer overflow: this event will be dropped to prevent a memory leak. Make sure that the UI is configured to display notifications (use ).`,{method:e,args:o});return}r.push([e,...o])}},E=new WeakSet,re=function(){u(this,p)||k.warn(`No notification handler has been registered: notifications will not be visible. -Make sure that your app contains the component.`)};const ne={"notify-app":{name:"notify-app",services:{},ui:{references:[{name:"notifier.NotificationService",qualifier:void 0,all:!1}]},properties:{}},"@open-pioneer/chakra-integration":{name:"@open-pioneer/chakra-integration",services:{},ui:{references:[]},properties:{}},"@open-pioneer/runtime":{name:"@open-pioneer/runtime",services:{},ui:{references:[]},properties:{}},"@open-pioneer/base-theme":{name:"@open-pioneer/base-theme",services:{},ui:{references:[]},properties:{}},"@open-pioneer/core":{name:"@open-pioneer/core",services:{},ui:{references:[]},properties:{}},"@open-pioneer/runtime-react-support":{name:"@open-pioneer/runtime-react-support",services:{},ui:{references:[]},properties:{}},"@open-pioneer/notifier":{name:"@open-pioneer/notifier",services:{NotificationServiceImpl:{name:"NotificationServiceImpl",clazz:oe,provides:[{name:"notifier.NotificationService",qualifier:void 0}],references:{}}},ui:{references:[{name:"notifier.NotificationService",qualifier:void 0,all:!1}]},properties:{}}},se="",ae=[];function le(t){throw new Error(`Unsupported locale: '${t}'`)}const ce=P(se),pe=Object.freeze(Object.defineProperty({__proto__:null,loadMessages:le,locales:ae,packages:ne,styles:ce},Symbol.toStringTag,{value:"Module"}));function I(t){const e=c.useRef(null);return c.useLayoutEffect(()=>{e.current=t}),c.useCallback((...r)=>{const s=e.current;return s(...r)},[])}const fe="@open-pioneer/notifier",de=H.bind(void 0,fe);var ue=ee({displayName:"WarningTwoIcon",d:"M23.119,20,13.772,2.15h0a2,2,0,0,0-3.543,0L.881,20a2,2,0,0,0,1.772,2.928H21.347A2,2,0,0,0,23.119,20ZM11,8.423a1,1,0,0,1,2,0v6a1,1,0,1,1-2,0Zm1.05,11.51h-.028a1.528,1.528,0,0,1-1.522-1.47,1.476,1.476,0,0,1,1.448-1.53h.028A1.527,1.527,0,0,1,13.5,18.4,1.475,1.475,0,0,1,12.05,19.933Z"});const he=!1;function me(t){const{position:e="top-right"}=t,o=O(),r=de("notifier.NotificationService"),[s,l]=c.useState(!he),f=I(n=>{const h=n.level==="error"?i.jsx(ue,{h:"100%",w:"100%"}):void 0;o({position:e,title:n.title,description:n.message||null,status:n.level,isClosable:!0,duration:n.displayDuration??null,icon:h})}),d=I(()=>{o.closeAll()});return c.useEffect(()=>{const n=r.registerHandler({showNotification:f,closeAll:d});return()=>n.destroy()},[s,r,f,d]),i.jsx(i.Fragment,{})}const ve="notify-app",ye=H.bind(void 0,ve);function ge(){const t=ye("notifier.NotificationService"),[e,o]=c.useState(""),[r,s]=c.useState("info"),[l,f]=c.useState(""),[d,n]=c.useState(!1),h=()=>{const a={title:e,level:r,message:l,displayDuration:d?5e3:void 0};if(!a.title){t.notify({title:"Title is required",level:"error"});return}t.notify(a)},m=()=>{t.closeAll()};return i.jsxs(i.Fragment,{children:[i.jsx(me,{position:"top-right"}),i.jsx(K,{p:5,children:i.jsxs(N,{spacing:8,children:[i.jsxs(N,{align:"center",children:[i.jsx(V,{as:"h1",children:"Notify Sample"}),i.jsx(J,{children:"Use the form below to emit notifications."})]}),i.jsx(Q,{rounded:"lg",boxShadow:"lg",p:8,children:i.jsxs(N,{spacing:4,children:[i.jsxs(C,{isRequired:!0,children:[i.jsx(w,{children:"Title"}),i.jsx(X,{type:"text",value:e,onChange:a=>o(a.target.value)})]}),i.jsxs(C,{isRequired:!0,children:[i.jsx(w,{children:"Level"}),i.jsxs(Y,{value:r,onChange:a=>{s(a.target.value)},children:[i.jsx("option",{value:"success",children:"Success"}),i.jsx("option",{value:"info",children:"Info"}),i.jsx("option",{value:"warning",children:"Warning"}),i.jsx("option",{value:"error",children:"Error"})]})]}),i.jsxs(C,{children:[i.jsx(w,{children:"Message"}),i.jsx(W,{placeholder:"Enter additional message",value:l,onChange:a=>f(a.target.value)})]}),i.jsx(Z,{isChecked:d,onChange:a=>n(a.target.checked),children:"Hide after 5 seconds"}),i.jsxs(M,{justifyContent:"center",children:[i.jsx(T,{flex:"1",onClick:h,children:"Emit Notification"}),i.jsx(T,{flex:"1",variant:"cancel",onClick:m,children:"Clear notifications"})]})]})})]})})]})}const xe=U({component:ge,appMetadata:pe});customElements.define("notify-app",xe); +Make sure that your app contains the component.`)};const ne={"notify-app":{name:"notify-app",services:{},ui:{references:[{name:"notifier.NotificationService",qualifier:void 0,all:!1}]},properties:{}},"@open-pioneer/runtime":{name:"@open-pioneer/runtime",services:{},ui:{references:[]},properties:{}},"@open-pioneer/chakra-integration":{name:"@open-pioneer/chakra-integration",services:{},ui:{references:[]},properties:{}},"@open-pioneer/base-theme":{name:"@open-pioneer/base-theme",services:{},ui:{references:[]},properties:{}},"@open-pioneer/core":{name:"@open-pioneer/core",services:{},ui:{references:[]},properties:{}},"@open-pioneer/notifier":{name:"@open-pioneer/notifier",services:{NotificationServiceImpl:{name:"NotificationServiceImpl",clazz:oe,provides:[{name:"notifier.NotificationService",qualifier:void 0}],references:{}}},ui:{references:[{name:"notifier.NotificationService",qualifier:void 0,all:!1}]},properties:{}},"@open-pioneer/runtime-react-support":{name:"@open-pioneer/runtime-react-support",services:{},ui:{references:[]},properties:{}}},se="",ae=[];function le(t){throw new Error(`Unsupported locale: '${t}'`)}const ce=P(se),pe=Object.freeze(Object.defineProperty({__proto__:null,loadMessages:le,locales:ae,packages:ne,styles:ce},Symbol.toStringTag,{value:"Module"}));function I(t){const e=c.useRef(null);return c.useLayoutEffect(()=>{e.current=t}),c.useCallback((...r)=>{const s=e.current;return s(...r)},[])}const fe="@open-pioneer/notifier",de=H.bind(void 0,fe);var ue=ee({displayName:"WarningTwoIcon",d:"M23.119,20,13.772,2.15h0a2,2,0,0,0-3.543,0L.881,20a2,2,0,0,0,1.772,2.928H21.347A2,2,0,0,0,23.119,20ZM11,8.423a1,1,0,0,1,2,0v6a1,1,0,1,1-2,0Zm1.05,11.51h-.028a1.528,1.528,0,0,1-1.522-1.47,1.476,1.476,0,0,1,1.448-1.53h.028A1.527,1.527,0,0,1,13.5,18.4,1.475,1.475,0,0,1,12.05,19.933Z"});const he=!1;function me(t){const{position:e="top-right"}=t,o=O(),r=de("notifier.NotificationService"),[s,l]=c.useState(!he),f=I(n=>{const h=n.level==="error"?i.jsx(ue,{h:"100%",w:"100%"}):void 0;o({position:e,title:n.title,description:n.message||null,status:n.level,isClosable:!0,duration:n.displayDuration??null,icon:h})}),d=I(()=>{o.closeAll()});return c.useEffect(()=>{const n=r.registerHandler({showNotification:f,closeAll:d});return()=>n.destroy()},[s,r,f,d]),i.jsx(i.Fragment,{})}const ve="notify-app",ye=H.bind(void 0,ve);function ge(){const t=ye("notifier.NotificationService"),[e,o]=c.useState(""),[r,s]=c.useState("info"),[l,f]=c.useState(""),[d,n]=c.useState(!1),h=()=>{const a={title:e,level:r,message:l,displayDuration:d?5e3:void 0};if(!a.title){t.notify({title:"Title is required",level:"error"});return}t.notify(a)},m=()=>{t.closeAll()};return i.jsxs(i.Fragment,{children:[i.jsx(me,{position:"top-right"}),i.jsx(K,{p:5,children:i.jsxs(N,{spacing:8,children:[i.jsxs(N,{align:"center",children:[i.jsx(V,{as:"h1",children:"Notify Sample"}),i.jsx(J,{children:"Use the form below to emit notifications."})]}),i.jsx(Q,{rounded:"lg",boxShadow:"lg",p:8,children:i.jsxs(N,{spacing:4,children:[i.jsxs(C,{isRequired:!0,children:[i.jsx(w,{children:"Title"}),i.jsx(X,{type:"text",value:e,onChange:a=>o(a.target.value)})]}),i.jsxs(C,{isRequired:!0,children:[i.jsx(w,{children:"Level"}),i.jsxs(Y,{value:r,onChange:a=>{s(a.target.value)},children:[i.jsx("option",{value:"success",children:"Success"}),i.jsx("option",{value:"info",children:"Info"}),i.jsx("option",{value:"warning",children:"Warning"}),i.jsx("option",{value:"error",children:"Error"})]})]}),i.jsxs(C,{children:[i.jsx(w,{children:"Message"}),i.jsx(W,{placeholder:"Enter additional message",value:l,onChange:a=>f(a.target.value)})]}),i.jsx(Z,{isChecked:d,onChange:a=>n(a.target.checked),children:"Hide after 5 seconds"}),i.jsxs(M,{justifyContent:"center",children:[i.jsx(T,{flex:"1",onClick:h,children:"Emit Notification"}),i.jsx(T,{flex:"1",variant:"cancel",onClick:m,children:"Clear notifications"})]})]})})]})})]})}const xe=U({component:ge,appMetadata:pe});customElements.define("notify-app",xe); diff --git a/core-packages/docs/classes/_open_pioneer_core.Error.html b/core-packages/docs/classes/_open_pioneer_core.Error.html index 54c9cdb11..89f0f6eb3 100644 --- a/core-packages/docs/classes/_open_pioneer_core.Error.html +++ b/core-packages/docs/classes/_open_pioneer_core.Error.html @@ -4,9 +4,9 @@

Conventions

Error ids should be scoped to a package to avoid conflicts. Each package should pick a sensible namespace prefix.

An example for a good error id is runtime:dependency-cycle.

-

Hierarchy

  • GlobalError
    • Error

Constructors

constructor +

Hierarchy

  • GlobalError
    • Error

Constructors

constructor

Properties

id text -

Constructors

constructor

  • new Error(id, text, options?): Error

  • Parameters

    • id: string
    • text: string
    • Optional options: {
          cause?: unknown;
      }
      • Optional cause?: unknown

    Returns Error

Properties

Readonly id

id: string

Unique error id

-

Readonly text

text: string

Human readable error message

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

  • new Error(id, text, options?): Error

  • Parameters

    • id: string
    • text: string
    • Optional options: {
          cause?: unknown;
      }
      • Optional cause?: unknown

    Returns Error

Properties

Readonly id

id: string

Unique error id

+

Readonly text

text: string

Human readable error message

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/classes/_open_pioneer_core.EventEmitter.html b/core-packages/docs/classes/_open_pioneer_core.EventEmitter.html index b1e8680bf..402387908 100644 --- a/core-packages/docs/classes/_open_pioneer_core.EventEmitter.html +++ b/core-packages/docs/classes/_open_pioneer_core.EventEmitter.html @@ -6,17 +6,17 @@ types using an interface first:

interface Events {
     // key: event name, value: event type
     "mouse-clicked": MouseEvent;
}

const emitter = new EventEmitter<Events>();
emitter.on("mouse-clicked", (event) => {
     // event is a MouseEvent
});
emitter.emit("mouse-clicked", new MouseEvent(...));
-

Type Parameters

  • Events extends {}

Constructors

constructor +

Type Parameters

  • Events extends {}

Constructors

constructor

Methods

emit on once

Constructors

constructor

Methods

emit

  • emit<Name>(eventName, ...args): void

  • Emits an event of the given name and calls the registered event handlers.

    Note: event handlers run synchronously. After emit() has completed, all listeners will already have been invoked.

    -

    Type Parameters

    • Name extends string

    Parameters

    • eventName: Name
    • Rest ...args: ArgType<Events[Name]>

    Returns void

on

  • on<Name>(eventName, listener): Resource

  • Registers the given listener function as an event handler for eventName.

    +

    Type Parameters

    • Name extends string

    Parameters

    • eventName: Name
    • Rest ...args: ArgType<Events[Name]>

    Returns void

on

  • on<Name>(eventName, listener): Resource

  • Registers the given listener function as an event handler for eventName.

    The listener function should be unregistered by destroying the returned Resource when it is no longer needed.

    -

    Type Parameters

    • Name extends string

    Parameters

    • eventName: Name
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: ArgType<Events[Name]>

          Returns void

    Returns Resource

once

  • once<Name>(eventName, listener): Resource

  • Registers the given listener function to listen for eventName events once. +

    Type Parameters

    • Name extends string

    Parameters

    • eventName: Name
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: ArgType<Events[Name]>

          Returns void

    Returns Resource

once

  • once<Name>(eventName, listener): Resource

  • Registers the given listener function to listen for eventName events once. The listener function will automatically be unregistered after it has been called.

    The listener function should be unregistered by destroying the returned Resource.

    -

    Type Parameters

    • Name extends string

    Parameters

    • eventName: Name
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: ArgType<Events[Name]>

          Returns void

    Returns Resource

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

  • Name extends string

Parameters

  • eventName: Name
  • listener: ((...args) => void)
      • (...args): void

      • Parameters

        • Rest ...args: ArgType<Events[Name]>

        Returns void

Returns Resource

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/functions/_open_pioneer_authentication.useAuthState.html b/core-packages/docs/functions/_open_pioneer_authentication.useAuthState.html index b321330cf..e8cc8b6c2 100644 --- a/core-packages/docs/functions/_open_pioneer_authentication.useAuthState.html +++ b/core-packages/docs/functions/_open_pioneer_authentication.useAuthState.html @@ -1,2 +1,2 @@ useAuthState | Open Pioneer Core Packages

Function useAuthState

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns AuthState

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/functions/_open_pioneer_core.createAbortError.html b/core-packages/docs/functions/_open_pioneer_core.createAbortError.html index 159866971..ab917c902 100644 --- a/core-packages/docs/functions/_open_pioneer_core.createAbortError.html +++ b/core-packages/docs/functions/_open_pioneer_core.createAbortError.html @@ -1,2 +1,2 @@ createAbortError | Open Pioneer Core Packages

Function createAbortError

  • createAbortError(): globalThis.Error

  • Returns an abort error (.name === "AbortError").

    -

    Returns globalThis.Error

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns globalThis.Error

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/functions/_open_pioneer_core.createLogger.html b/core-packages/docs/functions/_open_pioneer_core.createLogger.html index 7451aa487..5a18c2711 100644 --- a/core-packages/docs/functions/_open_pioneer_core.createLogger.html +++ b/core-packages/docs/functions/_open_pioneer_core.createLogger.html @@ -2,4 +2,4 @@ For available log methods see Logger interface. The log level is globally configured (see vite.config.ts).

Parameters

  • prefix: string

    Prefix used to prefix all log messages invoked by the created logger instance.

    -

Returns Logger

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns Logger

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/functions/_open_pioneer_core.createManualPromise.html b/core-packages/docs/functions/_open_pioneer_core.createManualPromise.html index 92d946289..d5bd27f86 100644 --- a/core-packages/docs/functions/_open_pioneer_core.createManualPromise.html +++ b/core-packages/docs/functions/_open_pioneer_core.createManualPromise.html @@ -1 +1 @@ -createManualPromise | Open Pioneer Core Packages

Function createManualPromise

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +createManualPromise | Open Pioneer Core Packages

Function createManualPromise

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/functions/_open_pioneer_core.destroyResource.html b/core-packages/docs/functions/_open_pioneer_core.destroyResource.html index bab8ac7f4..a067b6cde 100644 --- a/core-packages/docs/functions/_open_pioneer_core.destroyResource.html +++ b/core-packages/docs/functions/_open_pioneer_core.destroyResource.html @@ -2,4 +2,4 @@

Example:

class Holder {
   private myResource: Resource | undefined;

   destroy() {
       this.myResource = destroyResource(this.myResource);
   }
}
-

Type Parameters

Parameters

  • resource: undefined | R

Returns undefined

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

Parameters

  • resource: undefined | R

Returns undefined

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/functions/_open_pioneer_core.getErrorChain.html b/core-packages/docs/functions/_open_pioneer_core.getErrorChain.html index 13e75c279..e98289096 100644 --- a/core-packages/docs/functions/_open_pioneer_core.getErrorChain.html +++ b/core-packages/docs/functions/_open_pioneer_core.getErrorChain.html @@ -1,4 +1,4 @@ getErrorChain | Open Pioneer Core Packages

Function getErrorChain

  • getErrorChain(err): globalThis.Error[]

  • Returns the error chain for the given err, starting with this error. The error chain contains the error itself and all its causes. The first entry is err itself.

    -

    Parameters

    • err: Error

    Returns globalThis.Error[]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • err: Error

Returns globalThis.Error[]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/functions/_open_pioneer_core.isAbortError.html b/core-packages/docs/functions/_open_pioneer_core.isAbortError.html index 4fe60a5d1..cacbbb1b2 100644 --- a/core-packages/docs/functions/_open_pioneer_core.isAbortError.html +++ b/core-packages/docs/functions/_open_pioneer_core.isAbortError.html @@ -1,2 +1,2 @@ isAbortError | Open Pioneer Core Packages

Function isAbortError

  • isAbortError(err): boolean

  • Returns true if the error represents an abort error.

    -

    Parameters

    • err: unknown

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • err: unknown

Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/functions/_open_pioneer_core.rethrowAbortError.html b/core-packages/docs/functions/_open_pioneer_core.rethrowAbortError.html index 619a0b956..628cb01f1 100644 --- a/core-packages/docs/functions/_open_pioneer_core.rethrowAbortError.html +++ b/core-packages/docs/functions/_open_pioneer_core.rethrowAbortError.html @@ -1,2 +1,2 @@ rethrowAbortError | Open Pioneer Core Packages

Function rethrowAbortError

  • rethrowAbortError(err): void

  • Throws err if it is an abort error. Does nothing otherwise.

    -

    Parameters

    • err: unknown

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • err: unknown

Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/functions/_open_pioneer_core.throwAbortError.html b/core-packages/docs/functions/_open_pioneer_core.throwAbortError.html index 0453724d9..a28f14fa0 100644 --- a/core-packages/docs/functions/_open_pioneer_core.throwAbortError.html +++ b/core-packages/docs/functions/_open_pioneer_core.throwAbortError.html @@ -1,2 +1,2 @@ throwAbortError | Open Pioneer Core Packages

Function throwAbortError

  • throwAbortError(): never

  • Throws an abort error (.name === "AbortError").

    -

    Returns never

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns never

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/functions/_open_pioneer_notifier.Notifier.html b/core-packages/docs/functions/_open_pioneer_notifier.Notifier.html index 2037dbe2b..bbc0f3e97 100644 --- a/core-packages/docs/functions/_open_pioneer_notifier.Notifier.html +++ b/core-packages/docs/functions/_open_pioneer_notifier.Notifier.html @@ -3,4 +3,4 @@ It currently does not matter where the Notifier is located in the react tree.

import { Notifier } from "@open-pioneer/notifier";

export function AppUI() {
    return (
        <>
            <Notifier position="top-right" />
            <h1>Your application</h1>
        </>
    );
}
-

Parameters

Returns ReactElement

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns ReactElement

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/functions/_open_pioneer_runtime.createCustomElement.html b/core-packages/docs/functions/_open_pioneer_runtime.createCustomElement.html index ee4eae5b8..90ed3d208 100644 --- a/core-packages/docs/functions/_open_pioneer_runtime.createCustomElement.html +++ b/core-packages/docs/functions/_open_pioneer_runtime.createCustomElement.html @@ -1,4 +1,4 @@ createCustomElement | Open Pioneer Core Packages

Function createCustomElement

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/functions/_open_pioneer_test_utils.services.createService.html b/core-packages/docs/functions/_open_pioneer_test_utils.services.createService.html index 81b59936a..f2fcc0d9e 100644 --- a/core-packages/docs/functions/_open_pioneer_test_utils.services.createService.html +++ b/core-packages/docs/functions/_open_pioneer_test_utils.services.createService.html @@ -9,4 +9,4 @@

Type Parameters

  • References extends {}

  • Interface extends {}

Parameters

Returns Promise<Service<Interface>>

a new instance of the given service class

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/functions/_open_pioneer_test_utils.web_components.defineComponent.html b/core-packages/docs/functions/_open_pioneer_test_utils.web_components.defineComponent.html index 4c1a08b5d..db1200314 100644 --- a/core-packages/docs/functions/_open_pioneer_test_utils.web_components.defineComponent.html +++ b/core-packages/docs/functions/_open_pioneer_test_utils.web_components.defineComponent.html @@ -1,4 +1,4 @@ defineComponent | Open Pioneer Core Packages

Function defineComponent

  • defineComponent(component, options?): string

  • Defines the given component and returns the unique tag name. This helper is necessary because tag names must not collide in the global elements registry (and un-registration is not possible).

    -

    Parameters

    • component: CustomElementConstructor
    • Optional options: {
          nameHint?: string;
      }
      • Optional nameHint?: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • component: CustomElementConstructor
  • Optional options: {
        nameHint?: string;
    }
    • Optional nameHint?: string

Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/functions/_open_pioneer_test_utils.web_components.renderComponent.html b/core-packages/docs/functions/_open_pioneer_test_utils.web_components.renderComponent.html index 9b13984b1..205c59531 100644 --- a/core-packages/docs/functions/_open_pioneer_test_utils.web_components.renderComponent.html +++ b/core-packages/docs/functions/_open_pioneer_test_utils.web_components.renderComponent.html @@ -1,2 +1,2 @@ renderComponent | Open Pioneer Core Packages

Function renderComponent

  • renderComponent(component, options?): Promise<{
        node: HTMLElement;
    }>

  • Renders the given component into the DOM and returns the new node.

    -

    Parameters

    • component: string | CustomElementConstructor
    • Optional options: {
          attributes?: Record<string, string>;
          container?: HTMLElement;
      }
      • Optional attributes?: Record<string, string>
      • Optional container?: HTMLElement

    Returns Promise<{
        node: HTMLElement;
    }>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • component: string | CustomElementConstructor
  • Optional options: {
        attributes?: Record<string, string>;
        container?: HTMLElement;
    }
    • Optional attributes?: Record<string, string>
    • Optional container?: HTMLElement

Returns Promise<{
    node: HTMLElement;
}>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/functions/_open_pioneer_test_utils.web_components.renderComponentShadowDOM.html b/core-packages/docs/functions/_open_pioneer_test_utils.web_components.renderComponentShadowDOM.html index 197064be3..915eef697 100644 --- a/core-packages/docs/functions/_open_pioneer_test_utils.web_components.renderComponentShadowDOM.html +++ b/core-packages/docs/functions/_open_pioneer_test_utils.web_components.renderComponentShadowDOM.html @@ -4,4 +4,4 @@ where all other searches should be executed.

Returns the shadow root, the inner container, and a bound queries object that automatically searches in the inner container instead of the whole document.

-

Parameters

  • component: string | CustomElementConstructor
  • Optional options: {
        attributes?: Record<string, string>;
        container?: HTMLElement;
        innerContainerSelector?: string;
    }
    • Optional attributes?: Record<string, string>
    • Optional container?: HTMLElement
    • Optional innerContainerSelector?: string

Returns Promise<{
    innerContainer: HTMLElement;
    node: HTMLElement;
    queries: {} & {};
    shadowRoot: ShadowRoot;
}>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • component: string | CustomElementConstructor
  • Optional options: {
        attributes?: Record<string, string>;
        container?: HTMLElement;
        innerContainerSelector?: string;
    }
    • Optional attributes?: Record<string, string>
    • Optional container?: HTMLElement
    • Optional innerContainerSelector?: string

Returns Promise<{
    innerContainer: HTMLElement;
    node: HTMLElement;
    queries: {} & {};
    shadowRoot: ShadowRoot;
}>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_authentication.AuthEvents.html b/core-packages/docs/interfaces/_open_pioneer_authentication.AuthEvents.html index 4e33efa00..7535148b8 100644 --- a/core-packages/docs/interfaces/_open_pioneer_authentication.AuthEvents.html +++ b/core-packages/docs/interfaces/_open_pioneer_authentication.AuthEvents.html @@ -1,4 +1,4 @@ AuthEvents | Open Pioneer Core Packages

Interface AuthEvents

Events emitted by the AuthService.

-
interface AuthEvents {
    changed: void;
}

Properties

changed +
interface AuthEvents {
    changed: void;
}

Properties

changed

Properties

changed

changed: void

Emitted when there were any changes to the service's state.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_authentication.AuthPlugin.html b/core-packages/docs/interfaces/_open_pioneer_authentication.AuthPlugin.html index 1148fc59f..cd28b01e5 100644 --- a/core-packages/docs/interfaces/_open_pioneer_authentication.AuthPlugin.html +++ b/core-packages/docs/interfaces/_open_pioneer_authentication.AuthPlugin.html @@ -5,7 +5,7 @@

The implementation of AuthPluginEventBase is optional: it is only necessary if the state changes during the lifetime of the plugin. To implement the event, you can write class MyPlugin extends EventEmitter<AuthPluginEvents>.

-
interface AuthPlugin {
    getAuthState(): AuthState;
    getLoginBehavior(): LoginBehavior;
    logout(): void | Promise<void>;
    on?<Name>(eventName, listener): Resource;
    once?<Name>(eventName, listener): Resource;
}

Hierarchy

Methods

getAuthState +
interface AuthPlugin {
    getAuthState(): AuthState;
    getLoginBehavior(): LoginBehavior;
    logout(): void | Promise<void>;
    on?<Name>(eventName, listener): Resource;
    once?<Name>(eventName, listener): Resource;
}

Hierarchy

Methods

getAuthState getLoginBehavior logout on? @@ -13,14 +13,14 @@

Methods

getAuthState

getLoginBehavior

logout

getLoginBehavior

logout

  • logout(): void | Promise<void>

  • Explicitly triggers a logout.

    Should result in a new state (including a changed event) if the user was authenticated.

    -

    Returns void | Promise<void>

Optional on

Optional on

  • on<Name>(eventName, listener): Resource

  • Registers the given listener function as an event handler for eventName.

    The listener function should be unregistered by destroying the returned Resource when it is no longer needed.

    -

    Type Parameters

    • Name extends "changed"

    Parameters

    • eventName: Name
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          Returns void

    Returns Resource

Optional once

  • once<Name>(eventName, listener): Resource

  • Registers the given listener function to listen for eventName events once. +

    Type Parameters

    • Name extends "changed"

    Parameters

    • eventName: Name
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          Returns void

    Returns Resource

Optional once

  • once<Name>(eventName, listener): Resource

  • Registers the given listener function to listen for eventName events once. The listener function will automatically be unregistered after it has been called.

    The listener function should be unregistered by destroying the returned Resource.

    -

    Type Parameters

    • Name extends "changed"

    Parameters

    • eventName: Name
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          Returns void

    Returns Resource

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

  • Name extends "changed"

Parameters

  • eventName: Name
  • listener: ((...args) => void)
      • (...args): void

      • Parameters

        Returns void

Returns Resource

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_authentication.AuthPluginEvents.html b/core-packages/docs/interfaces/_open_pioneer_authentication.AuthPluginEvents.html index aa9c2f458..f6a47df52 100644 --- a/core-packages/docs/interfaces/_open_pioneer_authentication.AuthPluginEvents.html +++ b/core-packages/docs/interfaces/_open_pioneer_authentication.AuthPluginEvents.html @@ -1,3 +1,3 @@ AuthPluginEvents | Open Pioneer Core Packages

Interface AuthPluginEvents

Events that may be emitted by an authentication plugin.

-
interface AuthPluginEvents {
    changed: void;
}

Properties

changed -

Properties

changed

changed: void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +
interface AuthPluginEvents {
    changed: void;
}

Properties

changed +

Properties

changed

changed: void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_authentication.AuthService.html b/core-packages/docs/interfaces/_open_pioneer_authentication.AuthService.html index dc4dc1950..6e8ba7ae3 100644 --- a/core-packages/docs/interfaces/_open_pioneer_authentication.AuthService.html +++ b/core-packages/docs/interfaces/_open_pioneer_authentication.AuthService.html @@ -1,6 +1,6 @@ AuthService | Open Pioneer Core Packages

Interface AuthService

Manages the current user's authentication state.

The current state (such as session info) can be retrieved and watched for changes.

-
interface AuthService {
    getAuthState(): AuthState;
    getLoginBehavior(): LoginBehavior;
    getSessionInfo(): Promise<undefined | SessionInfo>;
    logout(): void;
    on<Name>(eventName, listener): Resource;
    once<Name>(eventName, listener): Resource;
}

Hierarchy

Methods

getAuthState +
interface AuthService {
    getAuthState(): AuthState;
    getLoginBehavior(): LoginBehavior;
    getSessionInfo(): Promise<undefined | SessionInfo>;
    logout(): void;
    on<Name>(eventName, listener): Resource;
    once<Name>(eventName, listener): Resource;
}

Hierarchy

Methods

getAuthState getLoginBehavior getSessionInfo logout @@ -10,16 +10,16 @@

The state may initially be pending to allow for async initialization in the authentication plugin. After initialization, the state is either not-authenticated or authenticated.

This method must be called again after the AuthService has emitted the changed event.

-

Returns AuthState

getLoginBehavior

getLoginBehavior

getSessionInfo

getSessionInfo

  • getSessionInfo(): Promise<undefined | SessionInfo>

  • Returns the current user's SessionInfo or undefined, if the current user is not authenticated.

    The method is asynchronous to allow for async initialization in the authentication plugin.

    This method must be called again after the AuthService has emitted the changed event.

    -

    Returns Promise<undefined | SessionInfo>

logout

on

logout

on

  • on<Name>(eventName, listener): Resource

  • Registers the given listener function as an event handler for eventName.

    The listener function should be unregistered by destroying the returned Resource when it is no longer needed.

    -

    Type Parameters

    • Name extends "changed"

    Parameters

    • eventName: Name
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          Returns void

    Returns Resource

once

  • once<Name>(eventName, listener): Resource

  • Registers the given listener function to listen for eventName events once. +

    Type Parameters

    • Name extends "changed"

    Parameters

    • eventName: Name
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          Returns void

    Returns Resource

once

  • once<Name>(eventName, listener): Resource

  • Registers the given listener function to listen for eventName events once. The listener function will automatically be unregistered after it has been called.

    The listener function should be unregistered by destroying the returned Resource.

    -

    Type Parameters

    • Name extends "changed"

    Parameters

    • eventName: Name
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          Returns void

    Returns Resource

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

  • Name extends "changed"

Parameters

  • eventName: Name
  • listener: ((...args) => void)
      • (...args): void

      • Parameters

        Returns void

Returns Resource

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_authentication.AuthStateAuthenticated.html b/core-packages/docs/interfaces/_open_pioneer_authentication.AuthStateAuthenticated.html index 6beb4ef60..1ec6be1bc 100644 --- a/core-packages/docs/interfaces/_open_pioneer_authentication.AuthStateAuthenticated.html +++ b/core-packages/docs/interfaces/_open_pioneer_authentication.AuthStateAuthenticated.html @@ -1,5 +1,5 @@ AuthStateAuthenticated | Open Pioneer Core Packages

Interface AuthStateAuthenticated

The user is authenticated and its session attributes can be retrieved.

-
interface AuthStateAuthenticated {
    kind: "authenticated";
    sessionInfo: SessionInfo;
}

Properties

kind +
interface AuthStateAuthenticated {
    kind: "authenticated";
    sessionInfo: SessionInfo;
}

Properties

kind sessionInfo -

Properties

kind

kind: "authenticated"

sessionInfo

sessionInfo: SessionInfo

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

kind

kind: "authenticated"

sessionInfo

sessionInfo: SessionInfo

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_authentication.AuthStateNotAuthenticated.html b/core-packages/docs/interfaces/_open_pioneer_authentication.AuthStateNotAuthenticated.html index e1a22ca66..2ca62445f 100644 --- a/core-packages/docs/interfaces/_open_pioneer_authentication.AuthStateNotAuthenticated.html +++ b/core-packages/docs/interfaces/_open_pioneer_authentication.AuthStateNotAuthenticated.html @@ -1,3 +1,3 @@ AuthStateNotAuthenticated | Open Pioneer Core Packages

Interface AuthStateNotAuthenticated

The user not authenticated.

-
interface AuthStateNotAuthenticated {
    kind: "not-authenticated";
}

Properties

kind -

Properties

kind

kind: "not-authenticated"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +
interface AuthStateNotAuthenticated {
    kind: "not-authenticated";
}

Properties

kind +

Properties

kind

kind: "not-authenticated"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_authentication.AuthStatePending.html b/core-packages/docs/interfaces/_open_pioneer_authentication.AuthStatePending.html index a16772200..1d6d22463 100644 --- a/core-packages/docs/interfaces/_open_pioneer_authentication.AuthStatePending.html +++ b/core-packages/docs/interfaces/_open_pioneer_authentication.AuthStatePending.html @@ -1,4 +1,4 @@ AuthStatePending | Open Pioneer Core Packages

Interface AuthStatePending

This state is active when the authentication service is still checking whether the current user is authenticated or not.

-
interface AuthStatePending {
    kind: "pending";
}

Properties

kind -

Properties

kind

kind: "pending"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +
interface AuthStatePending {
    kind: "pending";
}

Properties

kind +

Properties

kind

kind: "pending"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_authentication.ForceAuthProps.html b/core-packages/docs/interfaces/_open_pioneer_authentication.ForceAuthProps.html index 2a5844e35..9d36bbc9e 100644 --- a/core-packages/docs/interfaces/_open_pioneer_authentication.ForceAuthProps.html +++ b/core-packages/docs/interfaces/_open_pioneer_authentication.ForceAuthProps.html @@ -1,11 +1,11 @@ ForceAuthProps | Open Pioneer Core Packages

Interface ForceAuthProps

Properties for the ForceAuth component.

-
interface ForceAuthProps {
    children?: ReactNode;
    fallbackProps?: Record<string, unknown>;
    renderFallback?: ((AuthFallback) => ReactNode);
}

Properties

children? +
interface ForceAuthProps {
    children?: ReactNode;
    fallbackProps?: Record<string, unknown>;
    renderFallback?: ((AuthFallback) => ReactNode);
}

Properties

children? fallbackProps? renderFallback?

Properties

Optional children

children?: ReactNode

The children are rendered if the current user is authenticated.

-

Optional fallbackProps

fallbackProps?: Record<string, unknown>

These properties will be provided to the AuthFallback component implemented by the authentication plugin.

+

Optional fallbackProps

fallbackProps?: Record<string, unknown>

These properties will be provided to the AuthFallback component implemented by the authentication plugin.

NOTE: This property is not used when renderFallback is specified.

-

Optional renderFallback

renderFallback?: ((AuthFallback) => ReactNode)

Type declaration

Optional renderFallback

renderFallback?: ((AuthFallback) => ReactNode)

Type declaration

    • (AuthFallback): ReactNode

    • This property can be used to customize rendering of the authentication fallback.

      The AuthFallback parameter passed to the render prop is the fallback implemented by the authentication plugin. You can customize the rendering of the fallback by implementing this function. For example, AuthFallback could be wrapped with a few parent components.

      @@ -13,4 +13,4 @@

      Example:

      <ForceAuth
          renderFallback={(AuthFallback) => {
              return (
                  <SomeContainer>
                      <AuthFallback foo="bar" />
                  </SomeContainer>
              );
          }}
      >
          App Content
      </ForceAuth>
      -

      Parameters

      • AuthFallback: ComponentType<Record<string, unknown>>

      Returns ReactNode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • AuthFallback: ComponentType<Record<string, unknown>>

Returns ReactNode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_authentication.LoginEffect.html b/core-packages/docs/interfaces/_open_pioneer_authentication.LoginEffect.html index 096a85b26..857f910ac 100644 --- a/core-packages/docs/interfaces/_open_pioneer_authentication.LoginEffect.html +++ b/core-packages/docs/interfaces/_open_pioneer_authentication.LoginEffect.html @@ -1,5 +1,5 @@ LoginEffect | Open Pioneer Core Packages

Interface LoginEffect

An effect to perform when the user shall be authenticated. login() may, for example, perform a redirect to an authentication provider.

-
interface LoginEffect {
    kind: "effect";
    login(): void;
}

Properties

kind +
interface LoginEffect {
    kind: "effect";
    login(): void;
}

Properties

kind

Methods

login -

Properties

kind

kind: "effect"

Methods

login

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

kind

kind: "effect"

Methods

login

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_authentication.LoginFallback.html b/core-packages/docs/interfaces/_open_pioneer_authentication.LoginFallback.html index c304a4f05..dd9e5a937 100644 --- a/core-packages/docs/interfaces/_open_pioneer_authentication.LoginFallback.html +++ b/core-packages/docs/interfaces/_open_pioneer_authentication.LoginFallback.html @@ -1,5 +1,5 @@ LoginFallback | Open Pioneer Core Packages

Interface LoginFallback

A fallback react component to present to the user. For example, this can be a login form or a message.

-
interface LoginFallback {
    Fallback: ComponentType;
    kind: "fallback";
}

Properties

Fallback +
interface LoginFallback {
    Fallback: ComponentType;
    kind: "fallback";
}

Properties

Fallback kind -

Properties

Fallback

Fallback: ComponentType

kind

kind: "fallback"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Fallback

Fallback: ComponentType

kind

kind: "fallback"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_authentication.SessionInfo.html b/core-packages/docs/interfaces/_open_pioneer_authentication.SessionInfo.html index b9d043db9..de6ea7266 100644 --- a/core-packages/docs/interfaces/_open_pioneer_authentication.SessionInfo.html +++ b/core-packages/docs/interfaces/_open_pioneer_authentication.SessionInfo.html @@ -1,11 +1,11 @@ SessionInfo | Open Pioneer Core Packages

Interface SessionInfo

Information about the authenticated user's session.

-
interface SessionInfo {
    attributes?: Record<string, unknown>;
    expiresAt?: Date;
    userId: string;
    userName?: string;
}

Properties

attributes? +
interface SessionInfo {
    attributes?: Record<string, unknown>;
    expiresAt?: Date;
    userId: string;
    userName?: string;
}

Properties

attributes? expiresAt? userId userName?

Properties

Optional attributes

attributes?: Record<string, unknown>

Arbitrary attributes from the authentication plugin.

-

Optional expiresAt

expiresAt?: Date

Set to a date if the session expires at some point. Optional.

-

userId

userId: string

Technical user id of the authenticated user, for example an email address.

-

Optional userName

userName?: string

Display name of the authenticated user. +

Optional expiresAt

expiresAt?: Date

Set to a date if the session expires at some point. Optional.

+

userId

userId: string

Technical user id of the authenticated user, for example an email address.

+

Optional userName

userName?: string

Display name of the authenticated user. Use the userId as a default value if this value is not available.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_core.LogMethod.html b/core-packages/docs/interfaces/_open_pioneer_core.LogMethod.html index 0b4c1a609..633414e66 100644 --- a/core-packages/docs/interfaces/_open_pioneer_core.LogMethod.html +++ b/core-packages/docs/interfaces/_open_pioneer_core.LogMethod.html @@ -2,4 +2,4 @@

Parameters

  • message: unknown

    Log message to be logged (attached to the prefix). This can be an arbitrary value. Errors will be logged as-is, and other values are formatted as strings.

  • Rest ...values: unknown[]

    Arbitrary amount of additional values to be logged (attached to message).

    -

Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_core.Logger.html b/core-packages/docs/interfaces/_open_pioneer_core.Logger.html index 691f20313..0d31e005a 100644 --- a/core-packages/docs/interfaces/_open_pioneer_core.Logger.html +++ b/core-packages/docs/interfaces/_open_pioneer_core.Logger.html @@ -1,7 +1,7 @@ Logger | Open Pioneer Core Packages

Interface Logger

Provides a logger for a standardized application wide logging.

The logger's log level is configured globally.

Use the createLogger function to receive a new logger instance for logging.

-
interface Logger {
    debug: LogMethod;
    error: LogMethod;
    info: LogMethod;
    prefix: string;
    warn: LogMethod;
    isDebug(): boolean;
}

Properties

debug +
interface Logger {
    debug: LogMethod;
    error: LogMethod;
    info: LogMethod;
    prefix: string;
    warn: LogMethod;
    isDebug(): boolean;
}

Properties

debug error info prefix @@ -9,12 +9,12 @@

Methods

isDebug

Properties

debug

debug: LogMethod

Logging method for debug log level. Follows normal LogMethod structure but logs in debug level.

-

error

error: LogMethod

Logging method for debug error level. +

error

error: LogMethod

Logging method for debug error level. Follows normal log method structure but logs in error level.

-

info

info: LogMethod

Logging method for info log level. +

info

info: LogMethod

Logging method for info log level. Follows normal log method structure but logs in info level.

-

Readonly prefix

prefix: string

Prefix prepended to all logging messages

-

warn

warn: LogMethod

Logging method for warn log level. +

Readonly prefix

prefix: string

Prefix prepended to all logging messages

+

warn

warn: LogMethod

Logging method for warn log level. Follows normal log method structure but logs in warn level.

-

Methods

isDebug

  • isDebug(): boolean

  • Returns true if debug log level is enabled.

    -

    Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Methods

isDebug

  • isDebug(): boolean

  • Returns true if debug log level is enabled.

    +

    Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_core.ManualPromise.html b/core-packages/docs/interfaces/_open_pioneer_core.ManualPromise.html index 357af3b13..3390a7c22 100644 --- a/core-packages/docs/interfaces/_open_pioneer_core.ManualPromise.html +++ b/core-packages/docs/interfaces/_open_pioneer_core.ManualPromise.html @@ -1,7 +1,7 @@ ManualPromise | Open Pioneer Core Packages

Interface ManualPromise<T>

A manual promise that also exposes its resolve and reject functions.

The user must take care to always call either resolve or reject at least once, otherwise clients waiting for the promise may wait forever.

-
interface ManualPromise {
    promise: Promise<T>;
    reject(error): void;
    resolve(value): void;
}

Type Parameters

  • T

Properties

promise +
interface ManualPromise {
    promise: Promise<T>;
    reject(error): void;
    resolve(value): void;
}

Type Parameters

  • T

Properties

promise

Methods

reject resolve -

Properties

promise

promise: Promise<T>

Methods

reject

  • reject(error): void

  • Parameters

    • error: unknown

    Returns void

resolve

  • resolve(value): void

  • Parameters

    • value: T

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

promise

promise: Promise<T>

Methods

reject

  • reject(error): void

  • Parameters

    • error: unknown

    Returns void

resolve

  • resolve(value): void

  • Parameters

    • value: T

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_core.Resource.html b/core-packages/docs/interfaces/_open_pioneer_core.Resource.html index 35a74a447..071767cdf 100644 --- a/core-packages/docs/interfaces/_open_pioneer_core.Resource.html +++ b/core-packages/docs/interfaces/_open_pioneer_core.Resource.html @@ -1,4 +1,4 @@ Resource | Open Pioneer Core Packages

Interface Resource

An object that has some cleanup code associated with it.

-
interface Resource {
    destroy(): void;
}

Methods

destroy +
interface Resource {
    destroy(): void;
}

Methods

destroy

Methods

destroy

  • destroy(): void

  • A function that releases any state held by the resource.

    -

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_http.BeforeRequestParams.html b/core-packages/docs/interfaces/_open_pioneer_http.BeforeRequestParams.html index bbdcfae3b..296d59510 100644 --- a/core-packages/docs/interfaces/_open_pioneer_http.BeforeRequestParams.html +++ b/core-packages/docs/interfaces/_open_pioneer_http.BeforeRequestParams.html @@ -1,14 +1,14 @@ BeforeRequestParams | Open Pioneer Core Packages

Interface BeforeRequestParams

Options passed to Interceptor.beforeRequest.

-
interface BeforeRequestParams {
    context: ContextData;
    options: ResolvedRequestOptions;
    signal: AbortSignal;
    target: URL;
}

Properties

context +
interface BeforeRequestParams {
    context: ContextData;
    options: ResolvedRequestOptions;
    signal: AbortSignal;
    target: URL;
}

Properties

context options signal target

Properties

Readonly context

context: ContextData

The context object holds arbitrary values associated with this http request. Interceptors can read and modify values within this object.

-

Readonly options

options: ResolvedRequestOptions

The options that were used when the request was made. +

Readonly options

options: ResolvedRequestOptions

The options that were used when the request was made. Option values (such as headers) can be modified by an interceptor.

-

Readonly signal

signal: AbortSignal

The signal can be used to listen for cancellation. +

Readonly signal

signal: AbortSignal

The signal can be used to listen for cancellation. This is useful if an interceptor may run for a longer time.

-

target

target: URL

The request's target URL, including query parameters.

+

target

target: URL

The request's target URL, including query parameters.

This property can be changed by the interceptor.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_http.HttpService.html b/core-packages/docs/interfaces/_open_pioneer_http.HttpService.html index a10e8eb57..e2644c894 100644 --- a/core-packages/docs/interfaces/_open_pioneer_http.HttpService.html +++ b/core-packages/docs/interfaces/_open_pioneer_http.HttpService.html @@ -1,6 +1,6 @@ HttpService | Open Pioneer Core Packages

Interface HttpService

Central service for sending HTTP requests.

Use the interface "http.HttpService" to obtain an instance of this service.

-
interface HttpService {
    fetch(resource, init?): Promise<Response>;
}

Hierarchy

Methods

fetch +
interface HttpService {
    fetch(resource, init?): Promise<Response>;
}

Hierarchy

Methods

fetch

Methods

fetch

  • fetch(resource, init?): Promise<Response>

  • Requests the given resource via HTTP and returns the response.

    This method works almost exactly the same as the browser's native fetch function. However, certain trails extensions (such as interceptors) are implemented on top of fetch @@ -8,4 +8,4 @@

    For example, access tokens or other header / query parameters can be added automatically using an interceptor if a package uses the HttpService.

    See also fetch documentation for reference.

    -

    Parameters

    Returns Promise<Response>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<Response>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_http.HttpServiceRequestInit.html b/core-packages/docs/interfaces/_open_pioneer_http.HttpServiceRequestInit.html index 841194cd1..ab04f81fa 100644 --- a/core-packages/docs/interfaces/_open_pioneer_http.HttpServiceRequestInit.html +++ b/core-packages/docs/interfaces/_open_pioneer_http.HttpServiceRequestInit.html @@ -1,5 +1,5 @@ HttpServiceRequestInit | Open Pioneer Core Packages

Interface HttpServiceRequestInit

Options for HttpService.fetch.

-
interface HttpServiceRequestInit {
    context?: ContextData;
}

Hierarchy

  • RequestInit
    • HttpServiceRequestInit

Properties

context? +
interface HttpServiceRequestInit {
    context?: ContextData;
}

Hierarchy

  • RequestInit
    • HttpServiceRequestInit

Properties

context?

Properties

Optional context

context?: ContextData

Arbitrary context properties for this http request. These values can be accessed by interceptors.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_http.Interceptor.html b/core-packages/docs/interfaces/_open_pioneer_http.Interceptor.html index 0748603a0..d8ca63b2c 100644 --- a/core-packages/docs/interfaces/_open_pioneer_http.Interceptor.html +++ b/core-packages/docs/interfaces/_open_pioneer_http.Interceptor.html @@ -5,7 +5,7 @@

Note that the request interceptor API is experimental: it may change with a new minor release as a response to feedback.

-
interface Interceptor {
    beforeRequest?(params): void | Promise<void>;
}

Hierarchy

Methods

beforeRequest? +
interface Interceptor {
    beforeRequest?(params): void | Promise<void>;
}

Hierarchy

Methods

beforeRequest?

Methods

Optional beforeRequest

  • beforeRequest(params): void | Promise<void>

  • This method will be invoked for every request made by the HttpService.

    The params passed to the interceptor method can be inspected and can also be updated to change how the request is going to be made. For example, target and options.headers can be modified.

    @@ -15,4 +15,4 @@ All interceptors are invoked for every request. The order in which the interceptors are invoked is currently not defined.

    -

    Parameters

    Returns void | Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void | Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_integration.ApiExtension.html b/core-packages/docs/interfaces/_open_pioneer_integration.ApiExtension.html index 6db7be1c8..1e71630c6 100644 --- a/core-packages/docs/interfaces/_open_pioneer_integration.ApiExtension.html +++ b/core-packages/docs/interfaces/_open_pioneer_integration.ApiExtension.html @@ -1,4 +1,4 @@ ApiExtension | Open Pioneer Core Packages

Interface ApiExtension

Provides a set of methods to the application's web component API.

-
interface ApiExtension {
    getApiMethods(): Promise<ApiMethods>;
}

Methods

getApiMethods +
interface ApiExtension {
    getApiMethods(): Promise<ApiMethods>;
}

Methods

getApiMethods

Methods

getApiMethods

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<ApiMethods>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_integration.ExternalEventService.html b/core-packages/docs/interfaces/_open_pioneer_integration.ExternalEventService.html index 1cd434ad6..a86bf78cd 100644 --- a/core-packages/docs/interfaces/_open_pioneer_integration.ExternalEventService.html +++ b/core-packages/docs/interfaces/_open_pioneer_integration.ExternalEventService.html @@ -1,13 +1,13 @@ ExternalEventService | Open Pioneer Core Packages

Interface ExternalEventService

Emits events to users of the current web component.

Use the interface "integration.ExternalEventService" to obtain an instance of this service.

-
interface ExternalEventService {
    emitEvent(name, detail?): void;
    emitEvent(event): void;
}

Hierarchy

Methods

emitEvent +
interface ExternalEventService {
    emitEvent(name, detail?): void;
    emitEvent(event): void;
}

Hierarchy

Methods

emitEvent

Methods

emitEvent

  • emitEvent(name, detail?): void

  • Emits an event to the host site as a CustomEvent.

    The detail value (if any) will be used as the custom event's detail.

    Parameters

    • name: string
    • Optional detail: unknown

    Returns void

    Example

    // In the application, e.g. in a service
    eventService.emitEvent("my-event", { message: "Hello World" });

    // In the host site (node is the application's web component node)
    node.addEventLister("my-event", (event) => {
        console.log(event.detail);
    })
    -
  • emitEvent(event): void

  • Emits a prepared DOM event to the host site.

    +
  • emitEvent(event): void

  • Emits a prepared DOM event to the host site.

    The event will be dispatched on the web component's dom node without being altered by this service.

    You must take care to set the appropriate event options for your use case if you're using this overload (e.g. bubbles).

    Parameters

    • event: Event

    Returns void

    Example

    // You can use the CustomEvent class or your own subclass of Event
    eventService.emitEvent(new CustomEvent("my-event", {
        detail: "detail-value"
    }));
    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_local_storage.LocalStorageAPI.html b/core-packages/docs/interfaces/_open_pioneer_local_storage.LocalStorageAPI.html index e54b42f91..e9e55b9fd 100644 --- a/core-packages/docs/interfaces/_open_pioneer_local_storage.LocalStorageAPI.html +++ b/core-packages/docs/interfaces/_open_pioneer_local_storage.LocalStorageAPI.html @@ -1,14 +1,14 @@ LocalStorageAPI | Open Pioneer Core Packages

Interface LocalStorageAPI

Provides basic operations to interact with the browser's local storage.

The operations provided by this interface always act on an object in local storage: either the root value or a nested object.

-
interface LocalStorageAPI {
    get(key): unknown;
    getNamespace(key): LocalStorageAPI;
    remove(key): void;
    removeAll(): void;
    set(key, value): void;
}

Hierarchy

Methods

get +
interface LocalStorageAPI {
    get(key): unknown;
    getNamespace(key): LocalStorageAPI;
    remove(key): void;
    removeAll(): void;
    set(key, value): void;
}

Hierarchy

Methods

get getNamespace remove removeAll set

Methods

get

  • get(key): unknown

  • Returns the value associated with the given key, or undefined if no such value exists.

    -

    Parameters

    • key: string

    Returns unknown

getNamespace

getNamespace

  • getNamespace(key): LocalStorageAPI

  • Returns a storage namespace operating on the given key that can be used to group multiple related properties. key should either be associated with an object or it's value should be undefined. If key is not associated with a value, a new empty object will be created.

    @@ -20,12 +20,12 @@

    Example:

    const storageService = ...; // injected

    // Namespace operates on the "my-package-name" object (which may not exist yet)
    const packageNamespace = storageService.getNamespace("my-package-name");

    // Setting the first value will ensure that the object exists
    packageNamespace.set("foo", "bar"); // actually sets `"my-package-name" -> "foo"`

    // Retrieving the same object ("my-package-name") via get():
    const backingObject = storageService.get("my-package-name"); // {"foo": "bar"}
    console.log(backingObject);
    -

    Parameters

    • key: string

    Returns LocalStorageAPI

remove

  • remove(key): void

  • Removes any value associated with key.

    -

    Parameters

    • key: string

    Returns void

removeAll

remove

  • remove(key): void

  • Removes any value associated with key.

    +

    Parameters

    • key: string

    Returns void

removeAll

  • removeAll(): void

  • Removes all entries associated managed by this instance.

    If this represents the root object, all entries will be removed. If this represents a (possibly nested) namespace, only the contents of that namespace will be removed.

    -

    Returns void

set

set

  • set(key, value): void

  • Associates the given value with key.

    This method supports arbitrary JSON compatible values, including objects and arrays. If you store an object, you can later access (or modify) its individual properties using getNamespace.

    @@ -33,4 +33,4 @@

    NOTE: This function creates a clone of the original value to protect against accidental side effects. Updating the original value after set() will have no effect on the stored value.

    -

    Parameters

    • key: string
    • value: unknown

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • key: string
  • value: unknown

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_local_storage.LocalStorageProperties.html b/core-packages/docs/interfaces/_open_pioneer_local_storage.LocalStorageProperties.html index ffbb0b460..830b86ea3 100644 --- a/core-packages/docs/interfaces/_open_pioneer_local_storage.LocalStorageProperties.html +++ b/core-packages/docs/interfaces/_open_pioneer_local_storage.LocalStorageProperties.html @@ -1,4 +1,4 @@ LocalStorageProperties | Open Pioneer Core Packages

Interface LocalStorageProperties

Package properties of the "local-storage" package.

-
interface LocalStorageProperties {
    storageId: null | string;
}

Properties

storageId +
interface LocalStorageProperties {
    storageId: null | string;
}

Properties

storageId

Properties

storageId

storageId: null | string

The root local storage key used to store application state.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_local_storage.LocalStorageService.html b/core-packages/docs/interfaces/_open_pioneer_local_storage.LocalStorageService.html index 699276eb3..d43887985 100644 --- a/core-packages/docs/interfaces/_open_pioneer_local_storage.LocalStorageService.html +++ b/core-packages/docs/interfaces/_open_pioneer_local_storage.LocalStorageService.html @@ -1,6 +1,6 @@ LocalStorageService | Open Pioneer Core Packages

Interface LocalStorageService

Provides access to the browser's local storage for trails packages through a convenient API. Use the interface name "local-storage.LocalStorageService" to inject an instance of this interface.

-
interface LocalStorageService {
    isSupported: boolean;
    get(key): unknown;
    getNamespace(key): LocalStorageAPI;
    remove(key): void;
    removeAll(): void;
    set(key, value): void;
}

Hierarchy

Properties

isSupported +
interface LocalStorageService {
    isSupported: boolean;
    get(key): unknown;
    getNamespace(key): LocalStorageAPI;
    remove(key): void;
    removeAll(): void;
    set(key, value): void;
}

Hierarchy

Properties

isSupported

Methods

get getNamespace remove @@ -8,9 +8,9 @@ set

Properties

Readonly isSupported

isSupported: boolean

Whether local storage is supported by the current environment.

Getters and setters working on local storage will throw if this value is false.

-

Methods

get

  • get(key): unknown

  • Returns the value associated with the given key, or undefined if +

Methods

get

  • get(key): unknown

  • Returns the value associated with the given key, or undefined if no such value exists.

    -

    Parameters

    • key: string

    Returns unknown

getNamespace

getNamespace

  • getNamespace(key): LocalStorageAPI

  • Returns a storage namespace operating on the given key that can be used to group multiple related properties. key should either be associated with an object or it's value should be undefined. If key is not associated with a value, a new empty object will be created.

    @@ -22,12 +22,12 @@

    Example:

    const storageService = ...; // injected

    // Namespace operates on the "my-package-name" object (which may not exist yet)
    const packageNamespace = storageService.getNamespace("my-package-name");

    // Setting the first value will ensure that the object exists
    packageNamespace.set("foo", "bar"); // actually sets `"my-package-name" -> "foo"`

    // Retrieving the same object ("my-package-name") via get():
    const backingObject = storageService.get("my-package-name"); // {"foo": "bar"}
    console.log(backingObject);
    -

    Parameters

    • key: string

    Returns LocalStorageAPI

remove

removeAll

remove

removeAll

  • removeAll(): void

  • Removes all entries associated managed by this instance.

    If this represents the root object, all entries will be removed. If this represents a (possibly nested) namespace, only the contents of that namespace will be removed.

    -

    Returns void

set

set

  • set(key, value): void

  • Associates the given value with key.

    This method supports arbitrary JSON compatible values, including objects and arrays. If you store an object, you can later access (or modify) its individual properties using getNamespace.

    @@ -35,4 +35,4 @@

    NOTE: This function creates a clone of the original value to protect against accidental side effects. Updating the original value after set() will have no effect on the stored value.

    -

    Parameters

    • key: string
    • value: unknown

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • key: string
  • value: unknown

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_notifier.NotificationOptions.html b/core-packages/docs/interfaces/_open_pioneer_notifier.NotificationOptions.html index 88f0182c3..02267111e 100644 --- a/core-packages/docs/interfaces/_open_pioneer_notifier.NotificationOptions.html +++ b/core-packages/docs/interfaces/_open_pioneer_notifier.NotificationOptions.html @@ -1,14 +1,14 @@ NotificationOptions | Open Pioneer Core Packages

Interface NotificationOptions

Options used when emitting a new notification via NotificationService.notify.

-
interface NotificationOptions {
    displayDuration?: number;
    level?: NotificationLevel;
    message?: ReactNode;
    title?: ReactNode;
}

Properties

displayDuration? +
interface NotificationOptions {
    displayDuration?: number;
    level?: NotificationLevel;
    message?: ReactNode;
    title?: ReactNode;
}

Properties

displayDuration? level? message? title?

Properties

Optional displayDuration

displayDuration?: number

The duration (in milliseconds) how long the notification is displayed. By default, notifications are displayed until they are explicitly closed by the user.

Note that important messages should not be hidden automatically for a11y reasons.

-

Optional level

level?: NotificationLevel

The level of this notification.

+

Optional level

level?: NotificationLevel

The level of this notification.

Default

"info"
-

Optional message

message?: ReactNode

An optional message, shown below the title.

-

Optional title

title?: ReactNode

The title of the notification.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional message

message?: ReactNode

An optional message, shown below the title.

+

Optional title

title?: ReactNode

The title of the notification.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_notifier.NotificationService.html b/core-packages/docs/interfaces/_open_pioneer_notifier.NotificationService.html index 5315ae2be..9a9f16560 100644 --- a/core-packages/docs/interfaces/_open_pioneer_notifier.NotificationService.html +++ b/core-packages/docs/interfaces/_open_pioneer_notifier.NotificationService.html @@ -1,11 +1,11 @@ NotificationService | Open Pioneer Core Packages

Interface NotificationService

The NotificationService allows any part of the application to emit notifications to the user.

You can inject an instance of this service by referencing the interface name notifier.NotificationService.

-
interface NotificationService {
    closeAll(): void;
    notify(options): void;
}

Hierarchy

Methods

closeAll +
interface NotificationService {
    closeAll(): void;
    notify(options): void;
}

Hierarchy

Methods

closeAll notify

Methods

closeAll

  • closeAll(): void

  • Closes all active notifications.

    -

    Returns void

notify

notify

  • notify(options): void

  • Emits a new notification.

    Notifications are shown by the <Notifier /> component, which must be present in your application.

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_notifier.NotifierProps.html b/core-packages/docs/interfaces/_open_pioneer_notifier.NotifierProps.html index 5ed93f123..5ad31c8d7 100644 --- a/core-packages/docs/interfaces/_open_pioneer_notifier.NotifierProps.html +++ b/core-packages/docs/interfaces/_open_pioneer_notifier.NotifierProps.html @@ -1,6 +1,6 @@ NotifierProps | Open Pioneer Core Packages

Interface NotifierProps

Props supported by the Notifier component.

-
interface NotifierProps {
    position?: "top" | "top-left" | "top-right" | "bottom" | "bottom-left" | "bottom-right";
}

Properties

position? +
interface NotifierProps {
    position?: "top" | "top-left" | "top-right" | "bottom" | "bottom-left" | "bottom-right";
}

Properties

position?

Properties

Optional position

position?: "top" | "top-left" | "top-right" | "bottom" | "bottom-left" | "bottom-right"

The position for new notifications.

Default

"top-right"
-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_runtime.ApiExtension.html b/core-packages/docs/interfaces/_open_pioneer_runtime.ApiExtension.html index 6bec027e5..5b85197fb 100644 --- a/core-packages/docs/interfaces/_open_pioneer_runtime.ApiExtension.html +++ b/core-packages/docs/interfaces/_open_pioneer_runtime.ApiExtension.html @@ -1,4 +1,4 @@ ApiExtension | Open Pioneer Core Packages

Interface ApiExtension

Provides a set of methods to the application's web component API.

-
interface ApiExtension {
    getApiMethods(): Promise<ApiMethods>;
}

Methods

getApiMethods +
interface ApiExtension {
    getApiMethods(): Promise<ApiMethods>;
}

Methods

getApiMethods

Methods

getApiMethods

  • getApiMethods(): Promise<ApiMethods>

  • Returns a set of methods that will be added to the web component's API.

    -

    Returns Promise<ApiMethods>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<ApiMethods>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_runtime.ApiService.html b/core-packages/docs/interfaces/_open_pioneer_runtime.ApiService.html index 5cfb5415e..54f57ab02 100644 --- a/core-packages/docs/interfaces/_open_pioneer_runtime.ApiService.html +++ b/core-packages/docs/interfaces/_open_pioneer_runtime.ApiService.html @@ -1,5 +1,5 @@ ApiService | Open Pioneer Core Packages

Interface ApiService

A service provided by the system. Used by the runtime to assemble the public facing API.

-
interface ApiService {
    getApi(): Promise<ApiMethods>;
}

Hierarchy

Methods

getApi +
interface ApiService {
    getApi(): Promise<ApiMethods>;
}

Hierarchy

Methods

getApi

Methods

getApi

  • getApi(): Promise<ApiMethods>

  • Called by the runtime to gather methods that should be available from the web component's API.

    -

    Returns Promise<ApiMethods>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<ApiMethods>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationConfig.html b/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationConfig.html index c96237b74..dd8947015 100644 --- a/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationConfig.html +++ b/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationConfig.html @@ -1,9 +1,9 @@ ApplicationConfig | Open Pioneer Core Packages

Interface ApplicationConfig

Runtime application configuration.

-
interface ApplicationConfig {
    locale?: string;
    properties?: ApplicationProperties;
}

Properties

locale? +
interface ApplicationConfig {
    locale?: string;
    properties?: ApplicationProperties;
}

Properties

locale? properties?

Properties

Optional locale

locale?: string

Set this value to a locale string (e.g. "en") to for the application's locale. The default behavior is to choose an appropriate locale for the current user based on the browser's settings.

The locale must be supported by the application.

-

Optional properties

properties?: ApplicationProperties

Properties specified here will override default properties of the application's packages.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional properties

properties?: ApplicationProperties

Properties specified here will override default properties of the application's packages.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationContext.html b/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationContext.html index cdff9ab44..2fa69f342 100644 --- a/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationContext.html +++ b/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationContext.html @@ -1,16 +1,16 @@ ApplicationContext | Open Pioneer Core Packages

Interface ApplicationContext

A service provided by the system, useful for accessing values that are global to the application.

-
interface ApplicationContext {
    getApplicationContainer(): HTMLElement;
    getHostElement(): HTMLElement;
    getLocale(): string;
    getShadowRoot(): ShadowRoot;
    getSupportedLocales(): readonly string[];
}

Hierarchy

Methods

getApplicationContainer +
interface ApplicationContext {
    getApplicationContainer(): HTMLElement;
    getHostElement(): HTMLElement;
    getLocale(): string;
    getShadowRoot(): ShadowRoot;
    getSupportedLocales(): readonly string[];
}

Hierarchy

Methods

getApplicationContainer getHostElement getLocale getShadowRoot getSupportedLocales

Methods

getApplicationContainer

  • getApplicationContainer(): HTMLElement

  • The node containing the rest of the application inside the current web component's shadow dom.

    -

    Returns HTMLElement

getHostElement

  • getHostElement(): HTMLElement

  • The web component's host element. +

    Returns HTMLElement

getHostElement

  • getHostElement(): HTMLElement

  • The web component's host element. This dom node can be accessed by the host site.

    -

    Returns HTMLElement

getLocale

  • getLocale(): string

  • Returns the current locale of the application.

    +

    Returns HTMLElement

getLocale

  • getLocale(): string

  • Returns the current locale of the application.

    E.g. "de-DE"

    -

    Returns string

getShadowRoot

  • getShadowRoot(): ShadowRoot

  • The current web component's shadow root.

    -

    Returns ShadowRoot

getSupportedLocales

  • getSupportedLocales(): readonly string[]

  • Returns the locales supported by the application, i.e. +

    Returns string

getShadowRoot

  • getShadowRoot(): ShadowRoot

  • The current web component's shadow root.

    +

    Returns ShadowRoot

getSupportedLocales

  • getSupportedLocales(): readonly string[]

  • Returns the locales supported by the application, i.e. the locales that have associated i18n messages.

    For example: ["de", "en"]

    -

    Returns readonly string[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns readonly string[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationElement.html b/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationElement.html index 280c208e6..629c1fc5e 100644 --- a/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationElement.html +++ b/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationElement.html @@ -1,4 +1,4 @@ ApplicationElement | Open Pioneer Core Packages

Interface ApplicationElement

The interface implemented by web components produced via createCustomElement.

-
interface ApplicationElement {
    when(): Promise<ApiMethods>;
}

Hierarchy

  • HTMLElement
    • ApplicationElement

Methods

when +
interface ApplicationElement {
    when(): Promise<ApiMethods>;
}

Hierarchy

  • HTMLElement
    • ApplicationElement

Methods

when

Methods

when

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<ApiMethods>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationElementConstructor.html b/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationElementConstructor.html index 4ec90b4a7..3a551da37 100644 --- a/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationElementConstructor.html +++ b/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationElementConstructor.html @@ -1,3 +1,3 @@ ApplicationElementConstructor | Open Pioneer Core Packages

Interface ApplicationElementConstructor

The class returned by a call to createCustomElement.

-
interface ApplicationElementConstructor {
    new ApplicationElementConstructornew (): ApplicationElement;
}

Constructors

constructor -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +
interface ApplicationElementConstructor {
    new ApplicationElementConstructornew (): ApplicationElement;
}

Constructors

constructor +

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationLifecycleListener.html b/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationLifecycleListener.html index 6f0a85349..d9595ea0f 100644 --- a/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationLifecycleListener.html +++ b/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationLifecycleListener.html @@ -2,8 +2,8 @@ application-wide lifecycle events.

Experimental. This interface is not affected by semver guarantees. It may change (or be removed) in a future minor release.

-
interface ApplicationLifecycleListener {
    afterApplicationStart?(): void;
    beforeApplicationStop?(): void;
}

Hierarchy

  • DeclaredService<"runtime.ApplicationLifecycleListener">
    • ApplicationLifecycleListener

Methods

afterApplicationStart? +
interface ApplicationLifecycleListener {
    afterApplicationStart?(): void;
    beforeApplicationStop?(): void;
}

Hierarchy

  • DeclaredService<"runtime.ApplicationLifecycleListener">
    • ApplicationLifecycleListener

Methods

afterApplicationStart? beforeApplicationStop?

Methods

Optional afterApplicationStart

  • afterApplicationStart(): void

  • Called after all services required by the application have been started.

    -

    Returns void

Optional beforeApplicationStop

  • beforeApplicationStop(): void

  • Called during the application shutdown just before services will be destroyed.

    -

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns void

Optional beforeApplicationStop

  • beforeApplicationStop(): void

  • Called during the application shutdown just before services will be destroyed.

    +

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationProperties.html b/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationProperties.html index c46a894e6..8f1914d14 100644 --- a/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationProperties.html +++ b/core-packages/docs/interfaces/_open_pioneer_runtime.ApplicationProperties.html @@ -3,4 +3,4 @@
interface ApplicationProperties {
    [packageName: string]: Record<string, unknown>;
}

Indexable

[packageName: string]: Record<string, unknown>

Key: the name of the package. Value: A record of configuration properties (key/value pairs).

Properties will override default property values in the package.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_runtime.ConfigContext.html b/core-packages/docs/interfaces/_open_pioneer_runtime.ConfigContext.html index bcd5da44b..8b7e88dec 100644 --- a/core-packages/docs/interfaces/_open_pioneer_runtime.ConfigContext.html +++ b/core-packages/docs/interfaces/_open_pioneer_runtime.ConfigContext.html @@ -1,4 +1,4 @@ ConfigContext | Open Pioneer Core Packages

Interface ConfigContext

A context object that is passed to the resolveProperties function.

-
interface ConfigContext {
    getAttribute(name): undefined | string;
}

Methods

getAttribute +
interface ConfigContext {
    getAttribute(name): undefined | string;
}

Methods

getAttribute

Methods

getAttribute

  • getAttribute(name): undefined | string

  • Returns an attribute from the application's root node.

    -

    Parameters

    • name: string

    Returns undefined | string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • name: string

Returns undefined | string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_runtime.CustomElementOptions.html b/core-packages/docs/interfaces/_open_pioneer_runtime.CustomElementOptions.html index 67758fbec..f30accbcb 100644 --- a/core-packages/docs/interfaces/_open_pioneer_runtime.CustomElementOptions.html +++ b/core-packages/docs/interfaces/_open_pioneer_runtime.CustomElementOptions.html @@ -1,18 +1,18 @@ CustomElementOptions | Open Pioneer Core Packages

Interface CustomElementOptions

Options for the createCustomElement function.

-
interface CustomElementOptions {
    appMetadata?: ApplicationMetadata;
    component?: ComponentType<Record<string, string>>;
    config?: ApplicationConfig;
    theme?: Record<string, unknown>;
    resolveConfig?(ctx): Promise<undefined | ApplicationConfig>;
}

Properties

appMetadata? +
interface CustomElementOptions {
    appMetadata?: ApplicationMetadata;
    component?: ComponentType<Record<string, string>>;
    config?: ApplicationConfig;
    theme?: Record<string, unknown>;
    resolveConfig?(ctx): Promise<undefined | ApplicationConfig>;
}

Properties

appMetadata? component? config? theme?

Methods

resolveConfig?

Properties

Optional appMetadata

appMetadata?: ApplicationMetadata

Application metadata (packages, services etc.). This is usually autogenerated by importing the virtual "open-pioneer:app" module.

-

Optional component

component?: ComponentType<Record<string, string>>

Rendered UI component.

-

Optional config

config?: ApplicationConfig

Application defined configuration.

+

Optional component

component?: ComponentType<Record<string, string>>

Rendered UI component.

+

Optional config

config?: ApplicationConfig

Application defined configuration.

This option can be used to override default properties of the application's packages.

All instances of the web component will share this static configuration.

-

Optional theme

theme?: Record<string, unknown>

Chakra theming object.

-

Methods

Optional resolveConfig

Optional theme

theme?: Record<string, unknown>

Chakra theming object.

+

Methods

Optional resolveConfig

  • resolveConfig(ctx): Promise<undefined | ApplicationConfig>

  • Function to provide additional application defined configuration parameters.

    Compared to config, this function receives a context object that allows the developer to provide dynamic properties on a per-application instance basis.

    Parameters returned by this function take precedence over the ones defined by config.

    -

    Parameters

    Returns Promise<undefined | ApplicationConfig>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<undefined | ApplicationConfig>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_runtime.DeclaredService.html b/core-packages/docs/interfaces/_open_pioneer_runtime.DeclaredService.html index 107d9e875..381976024 100644 --- a/core-packages/docs/interfaces/_open_pioneer_runtime.DeclaredService.html +++ b/core-packages/docs/interfaces/_open_pioneer_runtime.DeclaredService.html @@ -11,4 +11,4 @@ You can simply remove the offending line; it is not required (and not possible) to implement that attribute - it only exists for the compiler.

-
interface DeclaredService {}

Type Parameters

  • InterfaceName extends string

Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +
interface DeclaredService {}

Type Parameters

  • InterfaceName extends string

Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_runtime.ReferenceMeta.html b/core-packages/docs/interfaces/_open_pioneer_runtime.ReferenceMeta.html index a11aa8a54..978ba33e7 100644 --- a/core-packages/docs/interfaces/_open_pioneer_runtime.ReferenceMeta.html +++ b/core-packages/docs/interfaces/_open_pioneer_runtime.ReferenceMeta.html @@ -1,4 +1,4 @@ ReferenceMeta | Open Pioneer Core Packages

Interface ReferenceMeta

Represents metadata for an injected reference.

-
interface ReferenceMeta {
    serviceId: string;
}

Properties

serviceId +
interface ReferenceMeta {
    serviceId: string;
}

Properties

serviceId

Properties

serviceId

serviceId: string

The unique service id of the injected service.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_runtime.ServiceLifecycleHooks.html b/core-packages/docs/interfaces/_open_pioneer_runtime.ServiceLifecycleHooks.html index b28f647ec..16b3926f2 100644 --- a/core-packages/docs/interfaces/_open_pioneer_runtime.ServiceLifecycleHooks.html +++ b/core-packages/docs/interfaces/_open_pioneer_runtime.ServiceLifecycleHooks.html @@ -1,6 +1,6 @@ ServiceLifecycleHooks | Open Pioneer Core Packages

Interface ServiceLifecycleHooks

Lifecycle hooks supported by the service interface.

-
interface ServiceLifecycleHooks {
    destroy?(): void;
    toString(): string;
}

Methods

destroy? +
interface ServiceLifecycleHooks {
    destroy?(): void;
    toString(): string;
}

Methods

destroy? toString

Methods

Optional destroy

  • destroy(): void

  • Destroys the component. Should clean up all resources used by the component.

    -

    Returns void

toString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns void

toString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_test_utils.react.PackageContextProviderProps.html b/core-packages/docs/interfaces/_open_pioneer_test_utils.react.PackageContextProviderProps.html index 5c941ab98..3db02b6f8 100644 --- a/core-packages/docs/interfaces/_open_pioneer_test_utils.react.PackageContextProviderProps.html +++ b/core-packages/docs/interfaces/_open_pioneer_test_utils.react.PackageContextProviderProps.html @@ -1,18 +1,18 @@ -PackageContextProviderProps | Open Pioneer Core Packages

Interface PackageContextProviderProps

interface PackageContextProviderProps {
    children?: ReactNode;
    locale?: string;
    messages?: {
        [packageName: string]: Record<string, string>;
    };
    properties?: {
        [packageName: string]: Record<string, unknown>;
    };
    qualifiedServices?: {
        [interfaceName: string]: {
            [qualifier: string]: AnyService;
        };
    };
    services?: {
        [interfaceName: string]: AnyService;
    };
}

Properties

children? +PackageContextProviderProps | Open Pioneer Core Packages

Interface PackageContextProviderProps

interface PackageContextProviderProps {
    children?: ReactNode;
    locale?: string;
    messages?: {
        [packageName: string]: Record<string, string>;
    };
    properties?: {
        [packageName: string]: Record<string, unknown>;
    };
    qualifiedServices?: {
        [interfaceName: string]: {
            [qualifier: string]: AnyService;
        };
    };
    services?: {
        [interfaceName: string]: AnyService;
    };
}

Properties

children? locale? messages? properties? qualifiedServices? services?

Properties

Optional children

children?: ReactNode

Children to render

-

Optional locale

locale?: string

The locale for i18n messages and formatting.

+

Optional locale

locale?: string

The locale for i18n messages and formatting.

Default

"en"
-

Optional messages

messages?: {
    [packageName: string]: Record<string, string>;
}

I18n messages for packages

+

Optional messages

messages?: {
    [packageName: string]: Record<string, string>;
}

I18n messages for packages

Type declaration

  • [packageName: string]: Record<string, string>

    I18n messages as (messageId, message) entries.

    Default

    {}
    -

Optional properties

properties?: {
    [packageName: string]: Record<string, unknown>;
}

Package properties (keyed by package name).

-

Type declaration

  • [packageName: string]: Record<string, unknown>

Optional qualifiedServices

qualifiedServices?: {
    [interfaceName: string]: {
        [qualifier: string]: AnyService;
    };
}

Interface implementations, keyed by interface name and then by qualifier.

-

Type declaration

  • [interfaceName: string]: {
        [qualifier: string]: AnyService;
    }

Optional services

services?: {
    [interfaceName: string]: AnyService;
}

Interface implementations, keyed by interface name.

-

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional properties

properties?: {
    [packageName: string]: Record<string, unknown>;
}

Package properties (keyed by package name).

+

Type declaration

  • [packageName: string]: Record<string, unknown>

Optional qualifiedServices

qualifiedServices?: {
    [interfaceName: string]: {
        [qualifier: string]: AnyService;
    };
}

Interface implementations, keyed by interface name and then by qualifier.

+

Type declaration

  • [interfaceName: string]: {
        [qualifier: string]: AnyService;
    }

Optional services

services?: {
    [interfaceName: string]: AnyService;
}

Interface implementations, keyed by interface name.

+

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/interfaces/_open_pioneer_test_utils.services.CreateServiceOptions.html b/core-packages/docs/interfaces/_open_pioneer_test_utils.services.CreateServiceOptions.html index 6340738c5..9d51f92b8 100644 --- a/core-packages/docs/interfaces/_open_pioneer_test_utils.services.CreateServiceOptions.html +++ b/core-packages/docs/interfaces/_open_pioneer_test_utils.services.CreateServiceOptions.html @@ -1,5 +1,5 @@ CreateServiceOptions | Open Pioneer Core Packages

Interface CreateServiceOptions<References>

Options for the createService function.

-
interface CreateServiceOptions {
    defaultMessageLocale?: string;
    locale?: string;
    messages?: Record<string, string>;
    properties?: Record<string, unknown>;
    references?: PartialServiceReferences<References>;
}

Type Parameters

  • References

Properties

defaultMessageLocale? +
interface CreateServiceOptions {
    defaultMessageLocale?: string;
    locale?: string;
    messages?: Record<string, string>;
    properties?: Record<string, unknown>;
    references?: PartialServiceReferences<References>;
}

Type Parameters

  • References

Properties

defaultMessageLocale? locale? messages? properties? @@ -8,16 +8,16 @@

See also https://formatjs.io/docs/intl#message-descriptor

Default

"en"
-

Optional locale

locale?: string

The locale for i18n messages and formatting.

+

Optional locale

locale?: string

The locale for i18n messages and formatting.

Default

"en"
-

Optional messages

messages?: Record<string, string>

I18n messages as (messageId, message) entries.

+

Optional messages

messages?: Record<string, string>

I18n messages as (messageId, message) entries.

Default

{}
-

Optional properties

properties?: Record<string, unknown>

Properties provided to the service constructor.

+

Optional properties

properties?: Record<string, unknown>

Properties provided to the service constructor.

Default

{}
-

Optional references

references?: PartialServiceReferences<References>

References provided to the service constructor.

+

Optional references

references?: PartialServiceReferences<References>

References provided to the service constructor.

Default

{}
-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/modules/_open_pioneer_authentication.ForceAuth.html b/core-packages/docs/modules/_open_pioneer_authentication.ForceAuth.html index f13b682d0..234f716ce 100644 --- a/core-packages/docs/modules/_open_pioneer_authentication.ForceAuth.html +++ b/core-packages/docs/modules/_open_pioneer_authentication.ForceAuth.html @@ -6,4 +6,4 @@ surround the entire application UI with the ForceAuth component:

import { ForceAuth } from "@open-pioneer/authentication";

export function AppUI() {
    return (
        <ForceAuth>
             <TheRestOfYourApplication />
        </ForceAuth>
    );
}
-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/modules/_open_pioneer_base_theme.html b/core-packages/docs/modules/_open_pioneer_base_theme.html index ca66a08a6..9293b54c9 100644 --- a/core-packages/docs/modules/_open_pioneer_base_theme.html +++ b/core-packages/docs/modules/_open_pioneer_base_theme.html @@ -1,6 +1,7 @@ -@open-pioneer/base-theme - v0.3.0 | Open Pioneer Core Packages

Module @open-pioneer/base-theme - v0.3.0

@open-pioneer/base-theme

This package provides a theme that uses the "trails" color scheme.

+@open-pioneer/base-theme - v0.3.0 | Open Pioneer Core Packages

Module @open-pioneer/base-theme - v0.3.0

@open-pioneer/base-theme

This package provides the default theme for all open pioneer trails applications.

Usage

This theme is automatically used as the default theme for all open pioneer trails applications.

-

How to override the trails color scheme

Import the extendTheme helper function:

+

How to override the trails color scheme

When using this theme, the trails color scheme becomes is the default color scheme for all chakra UI components.

+

To override the trails color scheme, import the extendTheme helper function:

import { extendTheme } from "@open-pioneer/chakra-integration";

Define your custom trails (or trails_alt) colors:

diff --git a/core-packages/docs/modules/_open_pioneer_chakra_integration.CustomChakraProvider.html b/core-packages/docs/modules/_open_pioneer_chakra_integration.CustomChakraProvider.html index 9afc2dd89..67f5b7ad7 100644 --- a/core-packages/docs/modules/_open_pioneer_chakra_integration.CustomChakraProvider.html +++ b/core-packages/docs/modules/_open_pioneer_chakra_integration.CustomChakraProvider.html @@ -1 +1 @@ -CustomChakraProvider | Open Pioneer Core Packages

Namespace CustomChakraProvider

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +CustomChakraProvider | Open Pioneer Core Packages

Namespace CustomChakraProvider

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/modules/_open_pioneer_chakra_integration.Portal.html b/core-packages/docs/modules/_open_pioneer_chakra_integration.Portal.html index 89f42eb20..f284cbbe5 100644 --- a/core-packages/docs/modules/_open_pioneer_chakra_integration.Portal.html +++ b/core-packages/docs/modules/_open_pioneer_chakra_integration.Portal.html @@ -1 +1 @@ -Portal | Open Pioneer Core Packages

Namespace Portal

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Portal | Open Pioneer Core Packages

Namespace Portal

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/modules/_open_pioneer_chakra_integration.html b/core-packages/docs/modules/_open_pioneer_chakra_integration.html index d6565e022..98abc247d 100644 --- a/core-packages/docs/modules/_open_pioneer_chakra_integration.html +++ b/core-packages/docs/modules/_open_pioneer_chakra_integration.html @@ -1,4 +1,4 @@ -@open-pioneer/chakra-integration - v1.1.1 | Open Pioneer Core Packages

Module @open-pioneer/chakra-integration - v1.1.1

@open-pioneer/chakra-integration

This package integrates Chakra UI into the open pioneer project. +@open-pioneer/chakra-integration - v1.1.1 | Open Pioneer Core Packages

Module @open-pioneer/chakra-integration - v1.1.1

@open-pioneer/chakra-integration

This package integrates Chakra UI into open pioneer trails application. All components are re-exported from @chakra-ui/react (sometimes with some modifications). All UI packages using the pioneer framework should use this package instead of depending on @chakra-ui/react directly.

Internals

Some changes are made to complex components such as Modal, Drawer etc. to support integration diff --git a/core-packages/docs/modules/_open_pioneer_runtime.html b/core-packages/docs/modules/_open_pioneer_runtime.html index 4defa61b8..366d2efbf 100644 --- a/core-packages/docs/modules/_open_pioneer_runtime.html +++ b/core-packages/docs/modules/_open_pioneer_runtime.html @@ -1,4 +1,4 @@ -@open-pioneer/runtime - v2.1.2 | Open Pioneer Core Packages

Module @open-pioneer/runtime - v2.1.2

@open-pioneer/runtime

Implements the runtime environment for open pioneer apps.

+@open-pioneer/runtime - v2.1.2 | Open Pioneer Core Packages

Module @open-pioneer/runtime - v2.1.2

@open-pioneer/runtime

Implements the runtime environment for open pioneer trails apps.

Quick start

Import the createCustomElement function from this package to create your application as a Web Component:

// my-app/app.js
import { createCustomElement } from "@open-pioneer/runtime";
import * as appMetadata from "open-pioneer:app";
import { AppUI } from "./AppUI";

const Element = createCustomElement({
    component: AppUI,
    appMetadata
});

customElements.define("my-app", Element);
diff --git a/core-packages/docs/modules/_open_pioneer_test_utils.html b/core-packages/docs/modules/_open_pioneer_test_utils.html index fae28ef7e..300bb4081 100644 --- a/core-packages/docs/modules/_open_pioneer_test_utils.html +++ b/core-packages/docs/modules/_open_pioneer_test_utils.html @@ -1,4 +1,4 @@ -@open-pioneer/test-utils - v1.1.1 | Open Pioneer Core Packages

Module @open-pioneer/test-utils - v1.1.1

@open-pioneer/test-utils

This package contains test utilities that make it easier to test parts of a pioneer application.

+@open-pioneer/test-utils - v1.1.1 | Open Pioneer Core Packages

Module @open-pioneer/test-utils - v1.1.1

@open-pioneer/test-utils

This package contains test utilities that make it easier to test parts of an open pioneer trails application.

Web Component utilities

Provides a few helpers to render web components into the DOM.

The helpers can be used to make testing web components that use a Shadow DOM easier.

Example:

diff --git a/core-packages/docs/modules/_open_pioneer_test_utils.react.PackageContextProvider.html b/core-packages/docs/modules/_open_pioneer_test_utils.react.PackageContextProvider.html index 407588d4e..f88412b63 100644 --- a/core-packages/docs/modules/_open_pioneer_test_utils.react.PackageContextProvider.html +++ b/core-packages/docs/modules/_open_pioneer_test_utils.react.PackageContextProvider.html @@ -2,4 +2,4 @@ React components using pioneer hooks like useService and useProperties will receive the mocked properties here instead. Currently also wrapped with the CustomChakraProvider to support chakra-ui elements

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/modules/_open_pioneer_test_utils.react.html b/core-packages/docs/modules/_open_pioneer_test_utils.react.html index d27659ee8..bf207b12d 100644 --- a/core-packages/docs/modules/_open_pioneer_test_utils.react.html +++ b/core-packages/docs/modules/_open_pioneer_test_utils.react.html @@ -1,4 +1,4 @@ -react | Open Pioneer Core Packages

Module react

Index

Namespaces

PackageContextProvider +react | Open Pioneer Core Packages

Module react

Index

Namespaces

PackageContextProvider

Interfaces

PackageContextProviderProps

Type Aliases

AnyService

Functions

PackageContextProvider diff --git a/core-packages/docs/modules/_open_pioneer_test_utils.services.html b/core-packages/docs/modules/_open_pioneer_test_utils.services.html index 5e651e1a7..3df9f5015 100644 --- a/core-packages/docs/modules/_open_pioneer_test_utils.services.html +++ b/core-packages/docs/modules/_open_pioneer_test_utils.services.html @@ -1,3 +1,3 @@ -services | Open Pioneer Core Packages

Module services

Index

Interfaces

CreateServiceOptions +services | Open Pioneer Core Packages

Module services

Index

Interfaces

CreateServiceOptions

Functions

createService

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/modules/_open_pioneer_test_utils.web_components.html b/core-packages/docs/modules/_open_pioneer_test_utils.web_components.html index 42f5f5450..017634848 100644 --- a/core-packages/docs/modules/_open_pioneer_test_utils.web_components.html +++ b/core-packages/docs/modules/_open_pioneer_test_utils.web_components.html @@ -1,4 +1,4 @@ -web-components | Open Pioneer Core Packages

Module web-components

Index

Functions

defineComponent +web-components | Open Pioneer Core Packages

Module web-components

Index

Functions

defineComponent renderComponent renderComponentShadowDOM

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_authentication.AuthPluginEventBase.html b/core-packages/docs/types/_open_pioneer_authentication.AuthPluginEventBase.html index 14e6dd971..971c80b52 100644 --- a/core-packages/docs/types/_open_pioneer_authentication.AuthPluginEventBase.html +++ b/core-packages/docs/types/_open_pioneer_authentication.AuthPluginEventBase.html @@ -1,2 +1,2 @@ AuthPluginEventBase | Open Pioneer Core Packages

Type alias AuthPluginEventBase

AuthPluginEventBase: EventSource<AuthPluginEvents>

Optional base type for an authentication plugin: the event emitter interface is not required.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_authentication.AuthState.html b/core-packages/docs/types/_open_pioneer_authentication.AuthState.html index be7d26bae..c5830bac1 100644 --- a/core-packages/docs/types/_open_pioneer_authentication.AuthState.html +++ b/core-packages/docs/types/_open_pioneer_authentication.AuthState.html @@ -1,4 +1,4 @@ AuthState | Open Pioneer Core Packages

Type alias AuthState

AuthState: AuthStatePending | AuthStateNotAuthenticated | AuthStateAuthenticated

Models the current authentication state.

NOTE: Future versions of this package may define additional states. Your code should contain sensible fallback or error logic.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_authentication.LoginBehavior.html b/core-packages/docs/types/_open_pioneer_authentication.LoginBehavior.html index 19a15fd24..ebfdf7a70 100644 --- a/core-packages/docs/types/_open_pioneer_authentication.LoginBehavior.html +++ b/core-packages/docs/types/_open_pioneer_authentication.LoginBehavior.html @@ -1,3 +1,3 @@ LoginBehavior | Open Pioneer Core Packages

Type alias LoginBehavior

LoginBehavior: LoginFallback | LoginEffect

Defines the behavior of the authentication service when attempting to authenticate a user.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_core.EventNames.html b/core-packages/docs/types/_open_pioneer_core.EventNames.html index 18a075f8a..980e09ea3 100644 --- a/core-packages/docs/types/_open_pioneer_core.EventNames.html +++ b/core-packages/docs/types/_open_pioneer_core.EventNames.html @@ -1 +1 @@ -EventNames | Open Pioneer Core Packages

Type alias EventNames<Events>

EventNames<Events>: keyof Events & string

Type Parameters

  • Events extends {}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +EventNames | Open Pioneer Core Packages

Type alias EventNames<Events>

EventNames<Events>: keyof Events & string

Type Parameters

  • Events extends {}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_core.EventSource.html b/core-packages/docs/types/_open_pioneer_core.EventSource.html index 13320a14a..644161e5d 100644 --- a/core-packages/docs/types/_open_pioneer_core.EventSource.html +++ b/core-packages/docs/types/_open_pioneer_core.EventSource.html @@ -1,2 +1,2 @@ EventSource | Open Pioneer Core Packages

Type alias EventSource<Events>

EventSource<Events>: Pick<EventEmitter<Events>, "on" | "once">

Read-only version of the EventEmitter interface that only allows listening for events.

-

Type Parameters

  • Events extends {}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

  • Events extends {}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_core.LogLevel.html b/core-packages/docs/types/_open_pioneer_core.LogLevel.html index f026fbd30..96d48cb87 100644 --- a/core-packages/docs/types/_open_pioneer_core.LogLevel.html +++ b/core-packages/docs/types/_open_pioneer_core.LogLevel.html @@ -1,3 +1,3 @@ LogLevel | Open Pioneer Core Packages

Type alias LogLevel

LogLevel: "DEBUG" | "INFO" | "WARN" | "ERROR"

Allowed log levels. Order: DEBUG < INFO < WARN < ERROR

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_http.ContextData.html b/core-packages/docs/types/_open_pioneer_http.ContextData.html index d25e587d3..e5d44bffe 100644 --- a/core-packages/docs/types/_open_pioneer_http.ContextData.html +++ b/core-packages/docs/types/_open_pioneer_http.ContextData.html @@ -1 +1 @@ -ContextData | Open Pioneer Core Packages

Type alias ContextData

ContextData: Record<string | symbol, unknown>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ContextData | Open Pioneer Core Packages

Type alias ContextData

ContextData: Record<string | symbol, unknown>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_http.ResolvedRequestOptions.html b/core-packages/docs/types/_open_pioneer_http.ResolvedRequestOptions.html index 602f4e887..55523f832 100644 --- a/core-packages/docs/types/_open_pioneer_http.ResolvedRequestOptions.html +++ b/core-packages/docs/types/_open_pioneer_http.ResolvedRequestOptions.html @@ -1 +1 @@ -ResolvedRequestOptions | Open Pioneer Core Packages

Type alias ResolvedRequestOptions

ResolvedRequestOptions: Omit<HttpServiceRequestInit, "method" | "headers" | "signal" | "context"> & {
    headers: Headers;
    method: string;
}

Type declaration

  • headers: Headers
  • method: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ResolvedRequestOptions | Open Pioneer Core Packages

Type alias ResolvedRequestOptions

ResolvedRequestOptions: Omit<HttpServiceRequestInit, "method" | "headers" | "signal" | "context"> & {
    headers: Headers;
    method: string;
}

Type declaration

  • headers: Headers
  • method: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_integration.ApiMethod.html b/core-packages/docs/types/_open_pioneer_integration.ApiMethod.html index 15f6c9dd3..dd7628703 100644 --- a/core-packages/docs/types/_open_pioneer_integration.ApiMethod.html +++ b/core-packages/docs/types/_open_pioneer_integration.ApiMethod.html @@ -1 +1 @@ -ApiMethod | Open Pioneer Core Packages

Type alias ApiMethod

ApiMethod: ((...args) => any)

Type declaration

    • (...args): any

    • Parameters

      • Rest ...args: any[]

      Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ApiMethod | Open Pioneer Core Packages

Type alias ApiMethod

ApiMethod: ((...args) => any)

Type declaration

    • (...args): any

    • Parameters

      • Rest ...args: any[]

      Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_integration.ApiMethods.html b/core-packages/docs/types/_open_pioneer_integration.ApiMethods.html index 743fb61bd..17bcba3c0 100644 --- a/core-packages/docs/types/_open_pioneer_integration.ApiMethods.html +++ b/core-packages/docs/types/_open_pioneer_integration.ApiMethods.html @@ -1,2 +1,2 @@ ApiMethods | Open Pioneer Core Packages

Type alias ApiMethods

ApiMethods: Record<string, ApiMethod>

A record of exposed functions.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_local_storage.LocalStorageNamespace.html b/core-packages/docs/types/_open_pioneer_local_storage.LocalStorageNamespace.html index 709096c57..0212c6463 100644 --- a/core-packages/docs/types/_open_pioneer_local_storage.LocalStorageNamespace.html +++ b/core-packages/docs/types/_open_pioneer_local_storage.LocalStorageNamespace.html @@ -1,3 +1,3 @@ LocalStorageNamespace | Open Pioneer Core Packages

Type alias LocalStorageNamespace

LocalStorageNamespace: LocalStorageAPI

A namespace provides access to the properties of an object in local storage. This can be used to manage groups of related values under a common name.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_notifier.NotificationLevel.html b/core-packages/docs/types/_open_pioneer_notifier.NotificationLevel.html index d359371df..2652c1e97 100644 --- a/core-packages/docs/types/_open_pioneer_notifier.NotificationLevel.html +++ b/core-packages/docs/types/_open_pioneer_notifier.NotificationLevel.html @@ -1,2 +1,2 @@ NotificationLevel | Open Pioneer Core Packages

Type alias NotificationLevel

NotificationLevel: "success" | "info" | "warning" | "error"

Represents the severity or kind of a notification.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_runtime.ApiMethod.html b/core-packages/docs/types/_open_pioneer_runtime.ApiMethod.html index 4ad85db35..56ec5fc32 100644 --- a/core-packages/docs/types/_open_pioneer_runtime.ApiMethod.html +++ b/core-packages/docs/types/_open_pioneer_runtime.ApiMethod.html @@ -1 +1 @@ -ApiMethod | Open Pioneer Core Packages

Type alias ApiMethod

ApiMethod: ((...args) => any)

Type declaration

    • (...args): any

    • Parameters

      • Rest ...args: any[]

      Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ApiMethod | Open Pioneer Core Packages

Type alias ApiMethod

ApiMethod: ((...args) => any)

Type declaration

    • (...args): any

    • Parameters

      • Rest ...args: any[]

      Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_runtime.ApiMethods.html b/core-packages/docs/types/_open_pioneer_runtime.ApiMethods.html index 1ef78b2dd..9c0362b0e 100644 --- a/core-packages/docs/types/_open_pioneer_runtime.ApiMethods.html +++ b/core-packages/docs/types/_open_pioneer_runtime.ApiMethods.html @@ -1,2 +1,2 @@ ApiMethods | Open Pioneer Core Packages

Type alias ApiMethods

ApiMethods: Record<string, ApiMethod>

A record of exposed functions.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_runtime.AssociatedInterfaceName.html b/core-packages/docs/types/_open_pioneer_runtime.AssociatedInterfaceName.html index 82eae2b9f..0c5fe050a 100644 --- a/core-packages/docs/types/_open_pioneer_runtime.AssociatedInterfaceName.html +++ b/core-packages/docs/types/_open_pioneer_runtime.AssociatedInterfaceName.html @@ -1,3 +1,3 @@ AssociatedInterfaceName | Open Pioneer Core Packages

Type alias AssociatedInterfaceName<T>

AssociatedInterfaceName<T>: T extends DeclaredService<infer InterfaceName>
    ? InterfaceName
    : T extends {
            [DECLARE_SERVICE_INTERFACE]: string & infer InterfaceName;
        }
        ? InterfaceName
        : never

Given a type implementing DeclaredService or using DECLARE_SERVICE_INTERFACE, this type will produce the interface name associated with the service type.

-

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_runtime.InterfaceNameForServiceType.html b/core-packages/docs/types/_open_pioneer_runtime.InterfaceNameForServiceType.html index 6fd817f2f..9de95db7a 100644 --- a/core-packages/docs/types/_open_pioneer_runtime.InterfaceNameForServiceType.html +++ b/core-packages/docs/types/_open_pioneer_runtime.InterfaceNameForServiceType.html @@ -4,4 +4,4 @@
  • If ServiceType implements DeclaredService, it will enforce the associated interface name.
  • Otherwise, a compile time error is generated.
    • -

    Type Parameters

    • ServiceType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • ServiceType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_runtime.PackageIntl.html b/core-packages/docs/types/_open_pioneer_runtime.PackageIntl.html index 6bbfe5b6c..f2f13a4ef 100644 --- a/core-packages/docs/types/_open_pioneer_runtime.PackageIntl.html +++ b/core-packages/docs/types/_open_pioneer_runtime.PackageIntl.html @@ -1,3 +1,3 @@ PackageIntl | Open Pioneer Core Packages

    Type alias PackageIntl

    PackageIntl: Pick<IntlShape, "locale" | "timeZone"> & IntlFormatters<string>

    Gives access to the package's i18n messages for the current locale.

    See also https://formatjs.io/docs/intl

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_runtime.ReferencesMeta.html b/core-packages/docs/types/_open_pioneer_runtime.ReferencesMeta.html index 63921265f..d8dcc9c15 100644 --- a/core-packages/docs/types/_open_pioneer_runtime.ReferencesMeta.html +++ b/core-packages/docs/types/_open_pioneer_runtime.ReferencesMeta.html @@ -1,3 +1,3 @@ ReferencesMeta | Open Pioneer Core Packages

    Type alias ReferencesMeta<References>

    ReferencesMeta<References>: {
        [referenceName in keyof References]: References[referenceName] extends any[]
            ? ReferenceMeta[]
            : ReferenceMeta
    }

    Contains metadata about injected references. The key for the reference metadata is the reference's name.

    -

    Type Parameters

    • References extends {}

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • References extends {}

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_runtime.Service.html b/core-packages/docs/types/_open_pioneer_runtime.Service.html index e2f7ca040..756d53bb9 100644 --- a/core-packages/docs/types/_open_pioneer_runtime.Service.html +++ b/core-packages/docs/types/_open_pioneer_runtime.Service.html @@ -1 +1 @@ -Service | Open Pioneer Core Packages

    Type alias Service<Interface>

    Service<Interface>: ServiceLifecycleHooks & Interface

    Type Parameters

    • Interface extends {} = {}

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Service | Open Pioneer Core Packages

    Type alias Service<Interface>

    Service<Interface>: ServiceLifecycleHooks & Interface

    Type Parameters

    • Interface extends {} = {}

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_runtime.ServiceConstructor.html b/core-packages/docs/types/_open_pioneer_runtime.ServiceConstructor.html index ebcc85037..9cb203696 100644 --- a/core-packages/docs/types/_open_pioneer_runtime.ServiceConstructor.html +++ b/core-packages/docs/types/_open_pioneer_runtime.ServiceConstructor.html @@ -1,2 +1,2 @@ ServiceConstructor | Open Pioneer Core Packages

    Type alias ServiceConstructor<References, Interface>

    ServiceConstructor<References, Interface>: (new (options) => Service<Interface>)

    Type Parameters

    • References extends {} = {}

    • Interface extends {} = {}

    Type declaration

      • new (options): Service<Interface>

      • A service constructor returns a service instance when calling new.

        -

        Parameters

        Returns Service<Interface>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Service<Interface>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_runtime.ServiceOptions.html b/core-packages/docs/types/_open_pioneer_runtime.ServiceOptions.html index ce313b554..86b561ab5 100644 --- a/core-packages/docs/types/_open_pioneer_runtime.ServiceOptions.html +++ b/core-packages/docs/types/_open_pioneer_runtime.ServiceOptions.html @@ -10,4 +10,4 @@

    If a single service has been injected, referencesMeta[key] will be of type ReferenceMeta. If multiple services have been injected, an array of ReferenceMeta will be provided instead, where the indices match the order in the injected references array.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/core-packages/docs/types/_open_pioneer_test_utils.react.AnyService.html b/core-packages/docs/types/_open_pioneer_test_utils.react.AnyService.html index 4ff42ae52..15212266e 100644 --- a/core-packages/docs/types/_open_pioneer_test_utils.react.AnyService.html +++ b/core-packages/docs/types/_open_pioneer_test_utils.react.AnyService.html @@ -1 +1 @@ -AnyService | Open Pioneer Core Packages

    Type alias AnyService

    AnyService: Service<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AnyService | Open Pioneer Core Packages

    Type alias AnyService

    AnyService: Service<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/core-packages/docs/variables/_open_pioneer_base_theme.theme.html b/core-packages/docs/variables/_open_pioneer_base_theme.theme.html index 9275c83e9..952ffe28f 100644 --- a/core-packages/docs/variables/_open_pioneer_base_theme.theme.html +++ b/core-packages/docs/variables/_open_pioneer_base_theme.theme.html @@ -2,4 +2,4 @@

    All custom themes should extend this theme:

    import { extendTheme } from "@open-pioneer/chakra-integration";
    import { theme as baseTheme } from "@open-pioneer/base-theme";

    export const theme = extendTheme({
        // Your overrides
    }, baseTheme);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/core-packages/docs/variables/_open_pioneer_chakra_integration.AlertDialog.html b/core-packages/docs/variables/_open_pioneer_chakra_integration.AlertDialog.html index 5b891c82f..ed7e4655d 100644 --- a/core-packages/docs/variables/_open_pioneer_chakra_integration.AlertDialog.html +++ b/core-packages/docs/variables/_open_pioneer_chakra_integration.AlertDialog.html @@ -1 +1 @@ -AlertDialog | Open Pioneer Core Packages

    Variable AlertDialogConst

    AlertDialog: ComponentType<AlertDialogProps> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AlertDialog | Open Pioneer Core Packages

    Variable AlertDialogConst

    AlertDialog: ComponentType<AlertDialogProps> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/core-packages/docs/variables/_open_pioneer_chakra_integration.Drawer.html b/core-packages/docs/variables/_open_pioneer_chakra_integration.Drawer.html index 58155d162..3e9018dd0 100644 --- a/core-packages/docs/variables/_open_pioneer_chakra_integration.Drawer.html +++ b/core-packages/docs/variables/_open_pioneer_chakra_integration.Drawer.html @@ -1 +1 @@ -Drawer | Open Pioneer Core Packages

    Variable DrawerConst

    Drawer: ComponentType<DrawerProps> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Drawer | Open Pioneer Core Packages

    Variable DrawerConst

    Drawer: ComponentType<DrawerProps> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/core-packages/docs/variables/_open_pioneer_chakra_integration.Modal.html b/core-packages/docs/variables/_open_pioneer_chakra_integration.Modal.html index 4373f3bd5..ca2c4d616 100644 --- a/core-packages/docs/variables/_open_pioneer_chakra_integration.Modal.html +++ b/core-packages/docs/variables/_open_pioneer_chakra_integration.Modal.html @@ -1 +1 @@ -Modal | Open Pioneer Core Packages

    Variable ModalConst

    Modal: ComponentType<ModalProps> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Modal | Open Pioneer Core Packages

    Variable ModalConst

    Modal: ComponentType<ModalProps> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/core-packages/docs/variables/_open_pioneer_chakra_integration.Tooltip.html b/core-packages/docs/variables/_open_pioneer_chakra_integration.Tooltip.html index 8827e5c3b..62f4c12b7 100644 --- a/core-packages/docs/variables/_open_pioneer_chakra_integration.Tooltip.html +++ b/core-packages/docs/variables/_open_pioneer_chakra_integration.Tooltip.html @@ -1 +1 @@ -Tooltip | Open Pioneer Core Packages

    Variable TooltipConst

    Tooltip: ComponentType<TooltipProps> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Tooltip | Open Pioneer Core Packages

    Variable TooltipConst

    Tooltip: ComponentType<TooltipProps> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/core-packages/docs/variables/_open_pioneer_runtime.DECLARE_SERVICE_INTERFACE.html b/core-packages/docs/variables/_open_pioneer_runtime.DECLARE_SERVICE_INTERFACE.html index d527a341b..8daf7c6ab 100644 --- a/core-packages/docs/variables/_open_pioneer_runtime.DECLARE_SERVICE_INTERFACE.html +++ b/core-packages/docs/variables/_open_pioneer_runtime.DECLARE_SERVICE_INTERFACE.html @@ -5,4 +5,4 @@

    Example

    import { type DECLARE_SERVICE_INTERFACE} from "@open-pioneer/runtime";

    class MyServiceImpl {
        // Add this line to your class.
        // It declares (at compile time) that the service class must be used via the given interface name.
        // Note that the property is not really present at runtime.
        declare [DECLARE_SERVICE_INTERFACE]: "my-package.MyInterface";

        method(): void {
            throw new Error("Method not implemented.");
        }
    }
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/core-packages/samples/auth-sample/index.html b/core-packages/samples/auth-sample/index.html index e2951e2ce..7c2e1ea1a 100644 --- a/core-packages/samples/auth-sample/index.html +++ b/core-packages/samples/auth-sample/index.html @@ -16,7 +16,7 @@ max-height: 100%; } - + diff --git a/core-packages/samples/chakra-sample/index.html b/core-packages/samples/chakra-sample/index.html index 4c636266a..b8446c8a8 100644 --- a/core-packages/samples/chakra-sample/index.html +++ b/core-packages/samples/chakra-sample/index.html @@ -28,7 +28,7 @@ height: 80%; } - + diff --git a/core-packages/samples/extension-sample/index.html b/core-packages/samples/extension-sample/index.html index e93c4777c..6f9622607 100644 --- a/core-packages/samples/extension-sample/index.html +++ b/core-packages/samples/extension-sample/index.html @@ -4,7 +4,7 @@ Extension Sample - + diff --git a/core-packages/samples/notify-sample/index.html b/core-packages/samples/notify-sample/index.html index e69327e22..4c557e866 100644 --- a/core-packages/samples/notify-sample/index.html +++ b/core-packages/samples/notify-sample/index.html @@ -11,7 +11,7 @@ margin: 0px; } - + diff --git a/core-packages/samples/properties-sample/index.html b/core-packages/samples/properties-sample/index.html index 364c77153..b52d4958d 100644 --- a/core-packages/samples/properties-sample/index.html +++ b/core-packages/samples/properties-sample/index.html @@ -4,7 +4,7 @@ Properties Demo - +