diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..7877d4cd --- /dev/null +++ b/404.html @@ -0,0 +1,1693 @@ + + + + + + + + + + + + + + + + + + + Mojodex - Open Source Enterprise Digital Assistant Platform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ +

404 - Not found

+ +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/assets/images/favicon.png b/assets/images/favicon.png new file mode 100644 index 00000000..1cf13b9f Binary files /dev/null and b/assets/images/favicon.png differ diff --git a/assets/javascripts/bundle.ad660dcc.min.js b/assets/javascripts/bundle.ad660dcc.min.js new file mode 100644 index 00000000..0ffc0460 --- /dev/null +++ b/assets/javascripts/bundle.ad660dcc.min.js @@ -0,0 +1,29 @@ +"use strict";(()=>{var Fi=Object.create;var gr=Object.defineProperty;var ji=Object.getOwnPropertyDescriptor;var Wi=Object.getOwnPropertyNames,Dt=Object.getOwnPropertySymbols,Ui=Object.getPrototypeOf,xr=Object.prototype.hasOwnProperty,no=Object.prototype.propertyIsEnumerable;var oo=(e,t,r)=>t in e?gr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,R=(e,t)=>{for(var r in t||(t={}))xr.call(t,r)&&oo(e,r,t[r]);if(Dt)for(var r of Dt(t))no.call(t,r)&&oo(e,r,t[r]);return e};var io=(e,t)=>{var r={};for(var o in e)xr.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&Dt)for(var o of Dt(e))t.indexOf(o)<0&&no.call(e,o)&&(r[o]=e[o]);return r};var yr=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Di=(e,t,r,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of Wi(t))!xr.call(e,n)&&n!==r&&gr(e,n,{get:()=>t[n],enumerable:!(o=ji(t,n))||o.enumerable});return e};var Vt=(e,t,r)=>(r=e!=null?Fi(Ui(e)):{},Di(t||!e||!e.__esModule?gr(r,"default",{value:e,enumerable:!0}):r,e));var ao=(e,t,r)=>new Promise((o,n)=>{var i=p=>{try{s(r.next(p))}catch(c){n(c)}},a=p=>{try{s(r.throw(p))}catch(c){n(c)}},s=p=>p.done?o(p.value):Promise.resolve(p.value).then(i,a);s((r=r.apply(e,t)).next())});var co=yr((Er,so)=>{(function(e,t){typeof Er=="object"&&typeof so!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(Er,function(){"use strict";function e(r){var o=!0,n=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(H){return!!(H&&H!==document&&H.nodeName!=="HTML"&&H.nodeName!=="BODY"&&"classList"in H&&"contains"in H.classList)}function p(H){var mt=H.type,ze=H.tagName;return!!(ze==="INPUT"&&a[mt]&&!H.readOnly||ze==="TEXTAREA"&&!H.readOnly||H.isContentEditable)}function c(H){H.classList.contains("focus-visible")||(H.classList.add("focus-visible"),H.setAttribute("data-focus-visible-added",""))}function l(H){H.hasAttribute("data-focus-visible-added")&&(H.classList.remove("focus-visible"),H.removeAttribute("data-focus-visible-added"))}function f(H){H.metaKey||H.altKey||H.ctrlKey||(s(r.activeElement)&&c(r.activeElement),o=!0)}function u(H){o=!1}function h(H){s(H.target)&&(o||p(H.target))&&c(H.target)}function w(H){s(H.target)&&(H.target.classList.contains("focus-visible")||H.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),l(H.target))}function A(H){document.visibilityState==="hidden"&&(n&&(o=!0),te())}function te(){document.addEventListener("mousemove",J),document.addEventListener("mousedown",J),document.addEventListener("mouseup",J),document.addEventListener("pointermove",J),document.addEventListener("pointerdown",J),document.addEventListener("pointerup",J),document.addEventListener("touchmove",J),document.addEventListener("touchstart",J),document.addEventListener("touchend",J)}function ie(){document.removeEventListener("mousemove",J),document.removeEventListener("mousedown",J),document.removeEventListener("mouseup",J),document.removeEventListener("pointermove",J),document.removeEventListener("pointerdown",J),document.removeEventListener("pointerup",J),document.removeEventListener("touchmove",J),document.removeEventListener("touchstart",J),document.removeEventListener("touchend",J)}function J(H){H.target.nodeName&&H.target.nodeName.toLowerCase()==="html"||(o=!1,ie())}document.addEventListener("keydown",f,!0),document.addEventListener("mousedown",u,!0),document.addEventListener("pointerdown",u,!0),document.addEventListener("touchstart",u,!0),document.addEventListener("visibilitychange",A,!0),te(),r.addEventListener("focus",h,!0),r.addEventListener("blur",w,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var Yr=yr((Rt,Kr)=>{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof Rt=="object"&&typeof Kr=="object"?Kr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Rt=="object"?Rt.ClipboardJS=r():t.ClipboardJS=r()})(Rt,function(){return function(){var e={686:function(o,n,i){"use strict";i.d(n,{default:function(){return Ii}});var a=i(279),s=i.n(a),p=i(370),c=i.n(p),l=i(817),f=i.n(l);function u(V){try{return document.execCommand(V)}catch(_){return!1}}var h=function(_){var O=f()(_);return u("cut"),O},w=h;function A(V){var _=document.documentElement.getAttribute("dir")==="rtl",O=document.createElement("textarea");O.style.fontSize="12pt",O.style.border="0",O.style.padding="0",O.style.margin="0",O.style.position="absolute",O.style[_?"right":"left"]="-9999px";var j=window.pageYOffset||document.documentElement.scrollTop;return O.style.top="".concat(j,"px"),O.setAttribute("readonly",""),O.value=V,O}var te=function(_,O){var j=A(_);O.container.appendChild(j);var D=f()(j);return u("copy"),j.remove(),D},ie=function(_){var O=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},j="";return typeof _=="string"?j=te(_,O):_ instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(_==null?void 0:_.type)?j=te(_.value,O):(j=f()(_),u("copy")),j},J=ie;function H(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?H=function(O){return typeof O}:H=function(O){return O&&typeof Symbol=="function"&&O.constructor===Symbol&&O!==Symbol.prototype?"symbol":typeof O},H(V)}var mt=function(){var _=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},O=_.action,j=O===void 0?"copy":O,D=_.container,Y=_.target,ke=_.text;if(j!=="copy"&&j!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(Y!==void 0)if(Y&&H(Y)==="object"&&Y.nodeType===1){if(j==="copy"&&Y.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(j==="cut"&&(Y.hasAttribute("readonly")||Y.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(ke)return J(ke,{container:D});if(Y)return j==="cut"?w(Y):J(Y,{container:D})},ze=mt;function Ie(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?Ie=function(O){return typeof O}:Ie=function(O){return O&&typeof Symbol=="function"&&O.constructor===Symbol&&O!==Symbol.prototype?"symbol":typeof O},Ie(V)}function _i(V,_){if(!(V instanceof _))throw new TypeError("Cannot call a class as a function")}function ro(V,_){for(var O=0;O<_.length;O++){var j=_[O];j.enumerable=j.enumerable||!1,j.configurable=!0,"value"in j&&(j.writable=!0),Object.defineProperty(V,j.key,j)}}function Ai(V,_,O){return _&&ro(V.prototype,_),O&&ro(V,O),V}function Ci(V,_){if(typeof _!="function"&&_!==null)throw new TypeError("Super expression must either be null or a function");V.prototype=Object.create(_&&_.prototype,{constructor:{value:V,writable:!0,configurable:!0}}),_&&br(V,_)}function br(V,_){return br=Object.setPrototypeOf||function(j,D){return j.__proto__=D,j},br(V,_)}function Hi(V){var _=Pi();return function(){var j=Wt(V),D;if(_){var Y=Wt(this).constructor;D=Reflect.construct(j,arguments,Y)}else D=j.apply(this,arguments);return ki(this,D)}}function ki(V,_){return _&&(Ie(_)==="object"||typeof _=="function")?_:$i(V)}function $i(V){if(V===void 0)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return V}function Pi(){if(typeof Reflect=="undefined"||!Reflect.construct||Reflect.construct.sham)return!1;if(typeof Proxy=="function")return!0;try{return Date.prototype.toString.call(Reflect.construct(Date,[],function(){})),!0}catch(V){return!1}}function Wt(V){return Wt=Object.setPrototypeOf?Object.getPrototypeOf:function(O){return O.__proto__||Object.getPrototypeOf(O)},Wt(V)}function vr(V,_){var O="data-clipboard-".concat(V);if(_.hasAttribute(O))return _.getAttribute(O)}var Ri=function(V){Ci(O,V);var _=Hi(O);function O(j,D){var Y;return _i(this,O),Y=_.call(this),Y.resolveOptions(D),Y.listenClick(j),Y}return Ai(O,[{key:"resolveOptions",value:function(){var D=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof D.action=="function"?D.action:this.defaultAction,this.target=typeof D.target=="function"?D.target:this.defaultTarget,this.text=typeof D.text=="function"?D.text:this.defaultText,this.container=Ie(D.container)==="object"?D.container:document.body}},{key:"listenClick",value:function(D){var Y=this;this.listener=c()(D,"click",function(ke){return Y.onClick(ke)})}},{key:"onClick",value:function(D){var Y=D.delegateTarget||D.currentTarget,ke=this.action(Y)||"copy",Ut=ze({action:ke,container:this.container,target:this.target(Y),text:this.text(Y)});this.emit(Ut?"success":"error",{action:ke,text:Ut,trigger:Y,clearSelection:function(){Y&&Y.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(D){return vr("action",D)}},{key:"defaultTarget",value:function(D){var Y=vr("target",D);if(Y)return document.querySelector(Y)}},{key:"defaultText",value:function(D){return vr("text",D)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(D){var Y=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return J(D,Y)}},{key:"cut",value:function(D){return w(D)}},{key:"isSupported",value:function(){var D=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],Y=typeof D=="string"?[D]:D,ke=!!document.queryCommandSupported;return Y.forEach(function(Ut){ke=ke&&!!document.queryCommandSupported(Ut)}),ke}}]),O}(s()),Ii=Ri},828:function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,p){for(;s&&s.nodeType!==n;){if(typeof s.matches=="function"&&s.matches(p))return s;s=s.parentNode}}o.exports=a},438:function(o,n,i){var a=i(828);function s(l,f,u,h,w){var A=c.apply(this,arguments);return l.addEventListener(u,A,w),{destroy:function(){l.removeEventListener(u,A,w)}}}function p(l,f,u,h,w){return typeof l.addEventListener=="function"?s.apply(null,arguments):typeof u=="function"?s.bind(null,document).apply(null,arguments):(typeof l=="string"&&(l=document.querySelectorAll(l)),Array.prototype.map.call(l,function(A){return s(A,f,u,h,w)}))}function c(l,f,u,h){return function(w){w.delegateTarget=a(w.target,f),w.delegateTarget&&h.call(l,w)}}o.exports=p},879:function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}},370:function(o,n,i){var a=i(879),s=i(438);function p(u,h,w){if(!u&&!h&&!w)throw new Error("Missing required arguments");if(!a.string(h))throw new TypeError("Second argument must be a String");if(!a.fn(w))throw new TypeError("Third argument must be a Function");if(a.node(u))return c(u,h,w);if(a.nodeList(u))return l(u,h,w);if(a.string(u))return f(u,h,w);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(u,h,w){return u.addEventListener(h,w),{destroy:function(){u.removeEventListener(h,w)}}}function l(u,h,w){return Array.prototype.forEach.call(u,function(A){A.addEventListener(h,w)}),{destroy:function(){Array.prototype.forEach.call(u,function(A){A.removeEventListener(h,w)})}}}function f(u,h,w){return s(document.body,u,h,w)}o.exports=p},817:function(o){function n(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var p=window.getSelection(),c=document.createRange();c.selectNodeContents(i),p.removeAllRanges(),p.addRange(c),a=p.toString()}return a}o.exports=n},279:function(o){function n(){}n.prototype={on:function(i,a,s){var p=this.e||(this.e={});return(p[i]||(p[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var p=this;function c(){p.off(i,c),a.apply(s,arguments)}return c._=a,this.on(i,c,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),p=0,c=s.length;for(p;p{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var ts=/["'&<>]/;ei.exports=rs;function rs(e){var t=""+e,r=ts.exec(t);if(!r)return t;var o,n="",i=0,a=0;for(i=r.index;i0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function N(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],a;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(s){a={error:s}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(a)throw a.error}}return i}function q(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||s(u,h)})})}function s(u,h){try{p(o[u](h))}catch(w){f(i[0][3],w)}}function p(u){u.value instanceof nt?Promise.resolve(u.value.v).then(c,l):f(i[0][2],u)}function c(u){s("next",u)}function l(u){s("throw",u)}function f(u,h){u(h),i.shift(),i.length&&s(i[0][0],i[0][1])}}function mo(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof de=="function"?de(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(a){return new Promise(function(s,p){a=e[i](a),n(s,p,a.done,a.value)})}}function n(i,a,s,p){Promise.resolve(p).then(function(c){i({value:c,done:s})},a)}}function k(e){return typeof e=="function"}function ft(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var zt=ft(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(o,n){return n+1+") "+o.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function qe(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Fe=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=de(a),p=s.next();!p.done;p=s.next()){var c=p.value;c.remove(this)}}catch(A){t={error:A}}finally{try{p&&!p.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var l=this.initialTeardown;if(k(l))try{l()}catch(A){i=A instanceof zt?A.errors:[A]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=de(f),h=u.next();!h.done;h=u.next()){var w=h.value;try{fo(w)}catch(A){i=i!=null?i:[],A instanceof zt?i=q(q([],N(i)),N(A.errors)):i.push(A)}}}catch(A){o={error:A}}finally{try{h&&!h.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new zt(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)fo(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&qe(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&qe(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Tr=Fe.EMPTY;function qt(e){return e instanceof Fe||e&&"closed"in e&&k(e.remove)&&k(e.add)&&k(e.unsubscribe)}function fo(e){k(e)?e():e.unsubscribe()}var $e={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var ut={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,a=n.isStopped,s=n.observers;return i||a?Tr:(this.currentObservers=null,s.push(r),new Fe(function(){o.currentObservers=null,qe(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,a=o.isStopped;n?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new F;return r.source=this,r},t.create=function(r,o){return new Eo(r,o)},t}(F);var Eo=function(e){re(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:Tr},t}(g);var _r=function(e){re(t,e);function t(r){var o=e.call(this)||this;return o._value=r,o}return Object.defineProperty(t.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),t.prototype._subscribe=function(r){var o=e.prototype._subscribe.call(this,r);return!o.closed&&r.next(this._value),o},t.prototype.getValue=function(){var r=this,o=r.hasError,n=r.thrownError,i=r._value;if(o)throw n;return this._throwIfClosed(),i},t.prototype.next=function(r){e.prototype.next.call(this,this._value=r)},t}(g);var Lt={now:function(){return(Lt.delegate||Date).now()},delegate:void 0};var _t=function(e){re(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=Lt);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,a=o._infiniteTimeWindow,s=o._timestampProvider,p=o._windowTime;n||(i.push(r),!a&&i.push(s.now()+p)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,a=n._buffer,s=a.slice(),p=0;p0?e.prototype.schedule.call(this,r,o):(this.delay=o,this.state=r,this.scheduler.flush(this),this)},t.prototype.execute=function(r,o){return o>0||this.closed?e.prototype.execute.call(this,r,o):this._execute(r,o)},t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!=null&&n>0||n==null&&this.delay>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.flush(this),0)},t}(vt);var So=function(e){re(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t}(gt);var Hr=new So(To);var Oo=function(e){re(t,e);function t(r,o){var n=e.call(this,r,o)||this;return n.scheduler=r,n.work=o,n}return t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!==null&&n>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=bt.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var a=r.actions;o!=null&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==o&&(bt.cancelAnimationFrame(o),r._scheduled=void 0)},t}(vt);var Mo=function(e){re(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o=this._scheduled;this._scheduled=void 0;var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t}(gt);var me=new Mo(Oo);var M=new F(function(e){return e.complete()});function Yt(e){return e&&k(e.schedule)}function kr(e){return e[e.length-1]}function Xe(e){return k(kr(e))?e.pop():void 0}function He(e){return Yt(kr(e))?e.pop():void 0}function Bt(e,t){return typeof kr(e)=="number"?e.pop():t}var xt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function Gt(e){return k(e==null?void 0:e.then)}function Jt(e){return k(e[ht])}function Xt(e){return Symbol.asyncIterator&&k(e==null?void 0:e[Symbol.asyncIterator])}function Zt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Gi(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var er=Gi();function tr(e){return k(e==null?void 0:e[er])}function rr(e){return lo(this,arguments,function(){var r,o,n,i;return Nt(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,nt(r.read())];case 3:return o=a.sent(),n=o.value,i=o.done,i?[4,nt(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,nt(n)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function or(e){return k(e==null?void 0:e.getReader)}function W(e){if(e instanceof F)return e;if(e!=null){if(Jt(e))return Ji(e);if(xt(e))return Xi(e);if(Gt(e))return Zi(e);if(Xt(e))return Lo(e);if(tr(e))return ea(e);if(or(e))return ta(e)}throw Zt(e)}function Ji(e){return new F(function(t){var r=e[ht]();if(k(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function Xi(e){return new F(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?b(function(n,i){return e(n,i,o)}):le,Te(1),r?Be(t):zo(function(){return new ir}))}}function Fr(e){return e<=0?function(){return M}:y(function(t,r){var o=[];t.subscribe(T(r,function(n){o.push(n),e=2,!0))}function pe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new g}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,p=s===void 0?!0:s;return function(c){var l,f,u,h=0,w=!1,A=!1,te=function(){f==null||f.unsubscribe(),f=void 0},ie=function(){te(),l=u=void 0,w=A=!1},J=function(){var H=l;ie(),H==null||H.unsubscribe()};return y(function(H,mt){h++,!A&&!w&&te();var ze=u=u!=null?u:r();mt.add(function(){h--,h===0&&!A&&!w&&(f=Wr(J,p))}),ze.subscribe(mt),!l&&h>0&&(l=new at({next:function(Ie){return ze.next(Ie)},error:function(Ie){A=!0,te(),f=Wr(ie,n,Ie),ze.error(Ie)},complete:function(){w=!0,te(),f=Wr(ie,a),ze.complete()}}),W(H).subscribe(l))})(c)}}function Wr(e,t){for(var r=[],o=2;oe.next(document)),e}function $(e,t=document){return Array.from(t.querySelectorAll(e))}function P(e,t=document){let r=fe(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function fe(e,t=document){return t.querySelector(e)||void 0}function Re(){var e,t,r,o;return(o=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?o:void 0}var xa=S(d(document.body,"focusin"),d(document.body,"focusout")).pipe(_e(1),Q(void 0),m(()=>Re()||document.body),B(1));function et(e){return xa.pipe(m(t=>e.contains(t)),K())}function kt(e,t){return C(()=>S(d(e,"mouseenter").pipe(m(()=>!0)),d(e,"mouseleave").pipe(m(()=>!1))).pipe(t?Ht(r=>Me(+!r*t)):le,Q(e.matches(":hover"))))}function Bo(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)Bo(e,r)}function x(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)Bo(o,n);return o}function sr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function wt(e){let t=x("script",{src:e});return C(()=>(document.head.appendChild(t),S(d(t,"load"),d(t,"error").pipe(v(()=>$r(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(m(()=>{}),L(()=>document.head.removeChild(t)),Te(1))))}var Go=new g,ya=C(()=>typeof ResizeObserver=="undefined"?wt("https://unpkg.com/resize-observer-polyfill"):I(void 0)).pipe(m(()=>new ResizeObserver(e=>e.forEach(t=>Go.next(t)))),v(e=>S(Ke,I(e)).pipe(L(()=>e.disconnect()))),B(1));function ce(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ge(e){let t=e;for(;t.clientWidth===0&&t.parentElement;)t=t.parentElement;return ya.pipe(E(r=>r.observe(t)),v(r=>Go.pipe(b(o=>o.target===t),L(()=>r.unobserve(t)))),m(()=>ce(e)),Q(ce(e)))}function Tt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function cr(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}function Jo(e){let t=[],r=e.parentElement;for(;r;)(e.clientWidth>r.clientWidth||e.clientHeight>r.clientHeight)&&t.push(r),r=(e=r).parentElement;return t.length===0&&t.push(document.documentElement),t}function Ue(e){return{x:e.offsetLeft,y:e.offsetTop}}function Xo(e){let t=e.getBoundingClientRect();return{x:t.x+window.scrollX,y:t.y+window.scrollY}}function Zo(e){return S(d(window,"load"),d(window,"resize")).pipe(Le(0,me),m(()=>Ue(e)),Q(Ue(e)))}function pr(e){return{x:e.scrollLeft,y:e.scrollTop}}function De(e){return S(d(e,"scroll"),d(window,"scroll"),d(window,"resize")).pipe(Le(0,me),m(()=>pr(e)),Q(pr(e)))}var en=new g,Ea=C(()=>I(new IntersectionObserver(e=>{for(let t of e)en.next(t)},{threshold:0}))).pipe(v(e=>S(Ke,I(e)).pipe(L(()=>e.disconnect()))),B(1));function tt(e){return Ea.pipe(E(t=>t.observe(e)),v(t=>en.pipe(b(({target:r})=>r===e),L(()=>t.unobserve(e)),m(({isIntersecting:r})=>r))))}function tn(e,t=16){return De(e).pipe(m(({y:r})=>{let o=ce(e),n=Tt(e);return r>=n.height-o.height-t}),K())}var lr={drawer:P("[data-md-toggle=drawer]"),search:P("[data-md-toggle=search]")};function rn(e){return lr[e].checked}function Je(e,t){lr[e].checked!==t&&lr[e].click()}function Ve(e){let t=lr[e];return d(t,"change").pipe(m(()=>t.checked),Q(t.checked))}function wa(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Ta(){return S(d(window,"compositionstart").pipe(m(()=>!0)),d(window,"compositionend").pipe(m(()=>!1))).pipe(Q(!1))}function on(){let e=d(window,"keydown").pipe(b(t=>!(t.metaKey||t.ctrlKey)),m(t=>({mode:rn("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),b(({mode:t,type:r})=>{if(t==="global"){let o=Re();if(typeof o!="undefined")return!wa(o,r)}return!0}),pe());return Ta().pipe(v(t=>t?M:e))}function xe(){return new URL(location.href)}function pt(e,t=!1){if(G("navigation.instant")&&!t){let r=x("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function nn(){return new g}function an(){return location.hash.slice(1)}function sn(e){let t=x("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Sa(e){return S(d(window,"hashchange"),e).pipe(m(an),Q(an()),b(t=>t.length>0),B(1))}function cn(e){return Sa(e).pipe(m(t=>fe(`[id="${t}"]`)),b(t=>typeof t!="undefined"))}function $t(e){let t=matchMedia(e);return ar(r=>t.addListener(()=>r(t.matches))).pipe(Q(t.matches))}function pn(){let e=matchMedia("print");return S(d(window,"beforeprint").pipe(m(()=>!0)),d(window,"afterprint").pipe(m(()=>!1))).pipe(Q(e.matches))}function Nr(e,t){return e.pipe(v(r=>r?t():M))}function zr(e,t){return new F(r=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(r.next(o.response),r.complete()):r.error(new Error(o.statusText))}),o.addEventListener("error",()=>{r.error(new Error("Network error"))}),o.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)t.progress$.next(n.loaded/n.total*100);else{let a=(i=o.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(n.loaded/+a*100)}}),t.progress$.next(5)),o.send(),()=>o.abort()})}function Ne(e,t){return zr(e,t).pipe(v(r=>r.text()),m(r=>JSON.parse(r)),B(1))}function ln(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/html")),B(1))}function mn(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/xml")),B(1))}function fn(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function un(){return S(d(window,"scroll",{passive:!0}),d(window,"resize",{passive:!0})).pipe(m(fn),Q(fn()))}function dn(){return{width:innerWidth,height:innerHeight}}function hn(){return d(window,"resize",{passive:!0}).pipe(m(dn),Q(dn()))}function bn(){return z([un(),hn()]).pipe(m(([e,t])=>({offset:e,size:t})),B(1))}function mr(e,{viewport$:t,header$:r}){let o=t.pipe(Z("size")),n=z([o,r]).pipe(m(()=>Ue(e)));return z([r,t,n]).pipe(m(([{height:i},{offset:a,size:s},{x:p,y:c}])=>({offset:{x:a.x-p,y:a.y-c+i},size:s})))}function Oa(e){return d(e,"message",t=>t.data)}function Ma(e){let t=new g;return t.subscribe(r=>e.postMessage(r)),t}function vn(e,t=new Worker(e)){let r=Oa(t),o=Ma(t),n=new g;n.subscribe(o);let i=o.pipe(X(),ne(!0));return n.pipe(X(),Pe(r.pipe(U(i))),pe())}var La=P("#__config"),St=JSON.parse(La.textContent);St.base=`${new URL(St.base,xe())}`;function ye(){return St}function G(e){return St.features.includes(e)}function Ee(e,t){return typeof t!="undefined"?St.translations[e].replace("#",t.toString()):St.translations[e]}function Se(e,t=document){return P(`[data-md-component=${e}]`,t)}function ae(e,t=document){return $(`[data-md-component=${e}]`,t)}function _a(e){let t=P(".md-typeset > :first-child",e);return d(t,"click",{once:!0}).pipe(m(()=>P(".md-typeset",e)),m(r=>({hash:__md_hash(r.innerHTML)})))}function gn(e){if(!G("announce.dismiss")||!e.childElementCount)return M;if(!e.hidden){let t=P(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return C(()=>{let t=new g;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),_a(e).pipe(E(r=>t.next(r)),L(()=>t.complete()),m(r=>R({ref:e},r)))})}function Aa(e,{target$:t}){return t.pipe(m(r=>({hidden:r!==e})))}function xn(e,t){let r=new g;return r.subscribe(({hidden:o})=>{e.hidden=o}),Aa(e,t).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))}function Pt(e,t){return t==="inline"?x("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"})):x("div",{class:"md-tooltip",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"}))}function yn(...e){return x("div",{class:"md-tooltip2",role:"tooltip"},x("div",{class:"md-tooltip2__inner md-typeset"},e))}function En(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return x("aside",{class:"md-annotation",tabIndex:0},Pt(t),x("a",{href:r,class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}else return x("aside",{class:"md-annotation",tabIndex:0},Pt(t),x("span",{class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}function wn(e){return x("button",{class:"md-clipboard md-icon",title:Ee("clipboard.copy"),"data-clipboard-target":`#${e} > code`})}function qr(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(p=>!e.terms[p]).reduce((p,c)=>[...p,x("del",null,c)," "],[]).slice(0,-1),i=ye(),a=new URL(e.location,i.base);G("search.highlight")&&a.searchParams.set("h",Object.entries(e.terms).filter(([,p])=>p).reduce((p,[c])=>`${p} ${c}`.trim(),""));let{tags:s}=ye();return x("a",{href:`${a}`,class:"md-search-result__link",tabIndex:-1},x("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&x("div",{class:"md-search-result__icon md-icon"}),r>0&&x("h1",null,e.title),r<=0&&x("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&e.tags.map(p=>{let c=s?p in s?`md-tag-icon md-tag--${s[p]}`:"md-tag-icon":"";return x("span",{class:`md-tag ${c}`},p)}),o>0&&n.length>0&&x("p",{class:"md-search-result__terms"},Ee("search.result.term.missing"),": ",...n)))}function Tn(e){let t=e[0].score,r=[...e],o=ye(),n=r.findIndex(l=>!`${new URL(l.location,o.base)}`.includes("#")),[i]=r.splice(n,1),a=r.findIndex(l=>l.scoreqr(l,1)),...p.length?[x("details",{class:"md-search-result__more"},x("summary",{tabIndex:-1},x("div",null,p.length>0&&p.length===1?Ee("search.result.more.one"):Ee("search.result.more.other",p.length))),...p.map(l=>qr(l,1)))]:[]];return x("li",{class:"md-search-result__item"},c)}function Sn(e){return x("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>x("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?sr(r):r)))}function Qr(e){let t=`tabbed-control tabbed-control--${e}`;return x("div",{class:t,hidden:!0},x("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function On(e){return x("div",{class:"md-typeset__scrollwrap"},x("div",{class:"md-typeset__table"},e))}function Ca(e){var o;let t=ye(),r=new URL(`../${e.version}/`,t.base);return x("li",{class:"md-version__item"},x("a",{href:`${r}`,class:"md-version__link"},e.title,((o=t.version)==null?void 0:o.alias)&&e.aliases.length>0&&x("span",{class:"md-version__alias"},e.aliases[0])))}function Mn(e,t){var o;let r=ye();return e=e.filter(n=>{var i;return!((i=n.properties)!=null&&i.hidden)}),x("div",{class:"md-version"},x("button",{class:"md-version__current","aria-label":Ee("select.version")},t.title,((o=r.version)==null?void 0:o.alias)&&t.aliases.length>0&&x("span",{class:"md-version__alias"},t.aliases[0])),x("ul",{class:"md-version__list"},e.map(Ca)))}var Ha=0;function ka(e){let t=z([et(e),kt(e)]).pipe(m(([o,n])=>o||n),K()),r=C(()=>Jo(e)).pipe(oe(De),ct(1),m(()=>Xo(e)));return t.pipe(Ae(o=>o),v(()=>z([t,r])),m(([o,n])=>({active:o,offset:n})),pe())}function $a(e,t){let{content$:r,viewport$:o}=t,n=`__tooltip2_${Ha++}`;return C(()=>{let i=new g,a=new _r(!1);i.pipe(X(),ne(!1)).subscribe(a);let s=a.pipe(Ht(c=>Me(+!c*250,Hr)),K(),v(c=>c?r:M),E(c=>c.id=n),pe());z([i.pipe(m(({active:c})=>c)),s.pipe(v(c=>kt(c,250)),Q(!1))]).pipe(m(c=>c.some(l=>l))).subscribe(a);let p=a.pipe(b(c=>c),ee(s,o),m(([c,l,{size:f}])=>{let u=e.getBoundingClientRect(),h=u.width/2;if(l.role==="tooltip")return{x:h,y:8+u.height};if(u.y>=f.height/2){let{height:w}=ce(l);return{x:h,y:-16-w}}else return{x:h,y:16+u.height}}));return z([s,i,p]).subscribe(([c,{offset:l},f])=>{c.style.setProperty("--md-tooltip-host-x",`${l.x}px`),c.style.setProperty("--md-tooltip-host-y",`${l.y}px`),c.style.setProperty("--md-tooltip-x",`${f.x}px`),c.style.setProperty("--md-tooltip-y",`${f.y}px`),c.classList.toggle("md-tooltip2--top",f.y<0),c.classList.toggle("md-tooltip2--bottom",f.y>=0)}),a.pipe(b(c=>c),ee(s,(c,l)=>l),b(c=>c.role==="tooltip")).subscribe(c=>{let l=ce(P(":scope > *",c));c.style.setProperty("--md-tooltip-width",`${l.width}px`),c.style.setProperty("--md-tooltip-tail","0px")}),a.pipe(K(),be(me),ee(s)).subscribe(([c,l])=>{l.classList.toggle("md-tooltip2--active",c)}),z([a.pipe(b(c=>c)),s]).subscribe(([c,l])=>{l.role==="dialog"?(e.setAttribute("aria-controls",n),e.setAttribute("aria-haspopup","dialog")):e.setAttribute("aria-describedby",n)}),a.pipe(b(c=>!c)).subscribe(()=>{e.removeAttribute("aria-controls"),e.removeAttribute("aria-describedby"),e.removeAttribute("aria-haspopup")}),ka(e).pipe(E(c=>i.next(c)),L(()=>i.complete()),m(c=>R({ref:e},c)))})}function lt(e,{viewport$:t},r=document.body){return $a(e,{content$:new F(o=>{let n=e.title,i=yn(n);return o.next(i),e.removeAttribute("title"),r.append(i),()=>{i.remove(),e.setAttribute("title",n)}}),viewport$:t})}function Pa(e,t){let r=C(()=>z([Zo(e),De(t)])).pipe(m(([{x:o,y:n},i])=>{let{width:a,height:s}=ce(e);return{x:o-i.x+a/2,y:n-i.y+s/2}}));return et(e).pipe(v(o=>r.pipe(m(n=>({active:o,offset:n})),Te(+!o||1/0))))}function Ln(e,t,{target$:r}){let[o,n]=Array.from(e.children);return C(()=>{let i=new g,a=i.pipe(X(),ne(!0));return i.subscribe({next({offset:s}){e.style.setProperty("--md-tooltip-x",`${s.x}px`),e.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),tt(e).pipe(U(a)).subscribe(s=>{e.toggleAttribute("data-md-visible",s)}),S(i.pipe(b(({active:s})=>s)),i.pipe(_e(250),b(({active:s})=>!s))).subscribe({next({active:s}){s?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe(Le(16,me)).subscribe(({active:s})=>{o.classList.toggle("md-tooltip--active",s)}),i.pipe(ct(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:s})=>s)).subscribe({next(s){s?e.style.setProperty("--md-tooltip-0",`${-s}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),d(n,"click").pipe(U(a),b(s=>!(s.metaKey||s.ctrlKey))).subscribe(s=>{s.stopPropagation(),s.preventDefault()}),d(n,"mousedown").pipe(U(a),ee(i)).subscribe(([s,{active:p}])=>{var c;if(s.button!==0||s.metaKey||s.ctrlKey)s.preventDefault();else if(p){s.preventDefault();let l=e.parentElement.closest(".md-annotation");l instanceof HTMLElement?l.focus():(c=Re())==null||c.blur()}}),r.pipe(U(a),b(s=>s===o),Ge(125)).subscribe(()=>e.focus()),Pa(e,t).pipe(E(s=>i.next(s)),L(()=>i.complete()),m(s=>R({ref:e},s)))})}function Ra(e){return e.tagName==="CODE"?$(".c, .c1, .cm",e):[e]}function Ia(e){let t=[];for(let r of Ra(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let a;for(;a=/(\(\d+\))(!)?/.exec(i.textContent);){let[,s,p]=a;if(typeof p=="undefined"){let c=i.splitText(a.index);i=c.splitText(s.length),t.push(c)}else{i.textContent=s,t.push(i);break}}}}return t}function _n(e,t){t.append(...Array.from(e.childNodes))}function fr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,a=new Map;for(let s of Ia(t)){let[,p]=s.textContent.match(/\((\d+)\)/);fe(`:scope > li:nth-child(${p})`,e)&&(a.set(p,En(p,i)),s.replaceWith(a.get(p)))}return a.size===0?M:C(()=>{let s=new g,p=s.pipe(X(),ne(!0)),c=[];for(let[l,f]of a)c.push([P(".md-typeset",f),P(`:scope > li:nth-child(${l})`,e)]);return o.pipe(U(p)).subscribe(l=>{e.hidden=!l,e.classList.toggle("md-annotation-list",l);for(let[f,u]of c)l?_n(f,u):_n(u,f)}),S(...[...a].map(([,l])=>Ln(l,t,{target$:r}))).pipe(L(()=>s.complete()),pe())})}function An(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return An(t)}}function Cn(e,t){return C(()=>{let r=An(e);return typeof r!="undefined"?fr(r,e,t):M})}var Hn=Vt(Yr());var Fa=0;function kn(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return kn(t)}}function ja(e){return ge(e).pipe(m(({width:t})=>({scrollable:Tt(e).width>t})),Z("scrollable"))}function $n(e,t){let{matches:r}=matchMedia("(hover)"),o=C(()=>{let n=new g,i=n.pipe(Fr(1));n.subscribe(({scrollable:c})=>{c&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let a=[];if(Hn.default.isSupported()&&(e.closest(".copy")||G("content.code.copy")&&!e.closest(".no-copy"))){let c=e.closest("pre");c.id=`__code_${Fa++}`;let l=wn(c.id);c.insertBefore(l,e),G("content.tooltips")&&a.push(lt(l,{viewport$}))}let s=e.closest(".highlight");if(s instanceof HTMLElement){let c=kn(s);if(typeof c!="undefined"&&(s.classList.contains("annotate")||G("content.code.annotate"))){let l=fr(c,e,t);a.push(ge(s).pipe(U(i),m(({width:f,height:u})=>f&&u),K(),v(f=>f?l:M)))}}return $(":scope > span[id]",e).length&&e.classList.add("md-code__content"),ja(e).pipe(E(c=>n.next(c)),L(()=>n.complete()),m(c=>R({ref:e},c)),Pe(...a))});return G("content.lazy")?tt(e).pipe(b(n=>n),Te(1),v(()=>o)):o}function Wa(e,{target$:t,print$:r}){let o=!0;return S(t.pipe(m(n=>n.closest("details:not([open])")),b(n=>e===n),m(()=>({action:"open",reveal:!0}))),r.pipe(b(n=>n||!o),E(()=>o=e.open),m(n=>({action:n?"open":"close"}))))}function Pn(e,t){return C(()=>{let r=new g;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),Wa(e,t).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))})}var Rn=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel rect,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel rect{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color);stroke-width:.05rem}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs #classDiagram-compositionEnd,defs #classDiagram-compositionStart,defs #classDiagram-dependencyEnd,defs #classDiagram-dependencyStart,defs #classDiagram-extensionEnd,defs #classDiagram-extensionStart{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs #classDiagram-aggregationEnd,defs #classDiagram-aggregationStart{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}a .nodeLabel{text-decoration:underline}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}.attributeBoxEven,.attributeBoxOdd{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityBox{fill:var(--md-mermaid-label-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityLabel{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.relationshipLabelBox{fill:var(--md-mermaid-label-bg-color);fill-opacity:1;background-color:var(--md-mermaid-label-bg-color);opacity:1}.relationshipLabel{fill:var(--md-mermaid-label-fg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs #ONE_OR_MORE_END *,defs #ONE_OR_MORE_START *,defs #ONLY_ONE_END *,defs #ONLY_ONE_START *,defs #ZERO_OR_MORE_END *,defs #ZERO_OR_MORE_START *,defs #ZERO_OR_ONE_END *,defs #ZERO_OR_ONE_START *{stroke:var(--md-mermaid-edge-color)!important}defs #ZERO_OR_MORE_END circle,defs #ZERO_OR_MORE_START circle{fill:var(--md-mermaid-label-bg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var Br,Da=0;function Va(){return typeof mermaid=="undefined"||mermaid instanceof Element?wt("https://unpkg.com/mermaid@10/dist/mermaid.min.js"):I(void 0)}function In(e){return e.classList.remove("mermaid"),Br||(Br=Va().pipe(E(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Rn,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),m(()=>{}),B(1))),Br.subscribe(()=>ao(this,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${Da++}`,r=x("div",{class:"mermaid"}),o=e.textContent,{svg:n,fn:i}=yield mermaid.render(t,o),a=r.attachShadow({mode:"closed"});a.innerHTML=n,e.replaceWith(r),i==null||i(a)})),Br.pipe(m(()=>({ref:e})))}var Fn=x("table");function jn(e){return e.replaceWith(Fn),Fn.replaceWith(On(e)),I({ref:e})}function Na(e){let t=e.find(r=>r.checked)||e[0];return S(...e.map(r=>d(r,"change").pipe(m(()=>P(`label[for="${r.id}"]`))))).pipe(Q(P(`label[for="${t.id}"]`)),m(r=>({active:r})))}function Wn(e,{viewport$:t,target$:r}){let o=P(".tabbed-labels",e),n=$(":scope > input",e),i=Qr("prev");e.append(i);let a=Qr("next");return e.append(a),C(()=>{let s=new g,p=s.pipe(X(),ne(!0));z([s,ge(e),tt(e)]).pipe(U(p),Le(1,me)).subscribe({next([{active:c},l]){let f=Ue(c),{width:u}=ce(c);e.style.setProperty("--md-indicator-x",`${f.x}px`),e.style.setProperty("--md-indicator-width",`${u}px`);let h=pr(o);(f.xh.x+l.width)&&o.scrollTo({left:Math.max(0,f.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),z([De(o),ge(o)]).pipe(U(p)).subscribe(([c,l])=>{let f=Tt(o);i.hidden=c.x<16,a.hidden=c.x>f.width-l.width-16}),S(d(i,"click").pipe(m(()=>-1)),d(a,"click").pipe(m(()=>1))).pipe(U(p)).subscribe(c=>{let{width:l}=ce(o);o.scrollBy({left:l*c,behavior:"smooth"})}),r.pipe(U(p),b(c=>n.includes(c))).subscribe(c=>c.click()),o.classList.add("tabbed-labels--linked");for(let c of n){let l=P(`label[for="${c.id}"]`);l.replaceChildren(x("a",{href:`#${l.htmlFor}`,tabIndex:-1},...Array.from(l.childNodes))),d(l.firstElementChild,"click").pipe(U(p),b(f=>!(f.metaKey||f.ctrlKey)),E(f=>{f.preventDefault(),f.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${l.htmlFor}`),l.click()})}return G("content.tabs.link")&&s.pipe(Ce(1),ee(t)).subscribe(([{active:c},{offset:l}])=>{let f=c.innerText.trim();if(c.hasAttribute("data-md-switching"))c.removeAttribute("data-md-switching");else{let u=e.offsetTop-l.y;for(let w of $("[data-tabs]"))for(let A of $(":scope > input",w)){let te=P(`label[for="${A.id}"]`);if(te!==c&&te.innerText.trim()===f){te.setAttribute("data-md-switching",""),A.click();break}}window.scrollTo({top:e.offsetTop-u});let h=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([f,...h])])}}),s.pipe(U(p)).subscribe(()=>{for(let c of $("audio, video",e))c.pause()}),Na(n).pipe(E(c=>s.next(c)),L(()=>s.complete()),m(c=>R({ref:e},c)))}).pipe(Qe(se))}function Un(e,{viewport$:t,target$:r,print$:o}){return S(...$(".annotate:not(.highlight)",e).map(n=>Cn(n,{target$:r,print$:o})),...$("pre:not(.mermaid) > code",e).map(n=>$n(n,{target$:r,print$:o})),...$("pre.mermaid",e).map(n=>In(n)),...$("table:not([class])",e).map(n=>jn(n)),...$("details",e).map(n=>Pn(n,{target$:r,print$:o})),...$("[data-tabs]",e).map(n=>Wn(n,{viewport$:t,target$:r})),...$("[title]",e).filter(()=>G("content.tooltips")).map(n=>lt(n,{viewport$:t})))}function za(e,{alert$:t}){return t.pipe(v(r=>S(I(!0),I(!1).pipe(Ge(2e3))).pipe(m(o=>({message:r,active:o})))))}function Dn(e,t){let r=P(".md-typeset",e);return C(()=>{let o=new g;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),za(e,t).pipe(E(n=>o.next(n)),L(()=>o.complete()),m(n=>R({ref:e},n)))})}var qa=0;function Qa(e,t){document.body.append(e);let{width:r}=ce(e);e.style.setProperty("--md-tooltip-width",`${r}px`),e.remove();let o=cr(t),n=typeof o!="undefined"?De(o):I({x:0,y:0}),i=S(et(t),kt(t)).pipe(K());return z([i,n]).pipe(m(([a,s])=>{let{x:p,y:c}=Ue(t),l=ce(t),f=t.closest("table");return f&&t.parentElement&&(p+=f.offsetLeft+t.parentElement.offsetLeft,c+=f.offsetTop+t.parentElement.offsetTop),{active:a,offset:{x:p-s.x+l.width/2-r/2,y:c-s.y+l.height+8}}}))}function Vn(e){let t=e.title;if(!t.length)return M;let r=`__tooltip_${qa++}`,o=Pt(r,"inline"),n=P(".md-typeset",o);return n.innerHTML=t,C(()=>{let i=new g;return i.subscribe({next({offset:a}){o.style.setProperty("--md-tooltip-x",`${a.x}px`),o.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){o.style.removeProperty("--md-tooltip-x"),o.style.removeProperty("--md-tooltip-y")}}),S(i.pipe(b(({active:a})=>a)),i.pipe(_e(250),b(({active:a})=>!a))).subscribe({next({active:a}){a?(e.insertAdjacentElement("afterend",o),e.setAttribute("aria-describedby",r),e.removeAttribute("title")):(o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t))},complete(){o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t)}}),i.pipe(Le(16,me)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(ct(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:a})=>a)).subscribe({next(a){a?o.style.setProperty("--md-tooltip-0",`${-a}px`):o.style.removeProperty("--md-tooltip-0")},complete(){o.style.removeProperty("--md-tooltip-0")}}),Qa(o,e).pipe(E(a=>i.next(a)),L(()=>i.complete()),m(a=>R({ref:e},a)))}).pipe(Qe(se))}function Ka({viewport$:e}){if(!G("header.autohide"))return I(!1);let t=e.pipe(m(({offset:{y:n}})=>n),Ye(2,1),m(([n,i])=>[nMath.abs(i-n.y)>100),m(([,[n]])=>n),K()),o=Ve("search");return z([e,o]).pipe(m(([{offset:n},i])=>n.y>400&&!i),K(),v(n=>n?r:I(!1)),Q(!1))}function Nn(e,t){return C(()=>z([ge(e),Ka(t)])).pipe(m(([{height:r},o])=>({height:r,hidden:o})),K((r,o)=>r.height===o.height&&r.hidden===o.hidden),B(1))}function zn(e,{header$:t,main$:r}){return C(()=>{let o=new g,n=o.pipe(X(),ne(!0));o.pipe(Z("active"),We(t)).subscribe(([{active:a},{hidden:s}])=>{e.classList.toggle("md-header--shadow",a&&!s),e.hidden=s});let i=ue($("[title]",e)).pipe(b(()=>G("content.tooltips")),oe(a=>Vn(a)));return r.subscribe(o),t.pipe(U(n),m(a=>R({ref:e},a)),Pe(i.pipe(U(n))))})}function Ya(e,{viewport$:t,header$:r}){return mr(e,{viewport$:t,header$:r}).pipe(m(({offset:{y:o}})=>{let{height:n}=ce(e);return{active:o>=n}}),Z("active"))}function qn(e,t){return C(()=>{let r=new g;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=fe(".md-content h1");return typeof o=="undefined"?M:Ya(o,t).pipe(E(n=>r.next(n)),L(()=>r.complete()),m(n=>R({ref:e},n)))})}function Qn(e,{viewport$:t,header$:r}){let o=r.pipe(m(({height:i})=>i),K()),n=o.pipe(v(()=>ge(e).pipe(m(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),Z("bottom"))));return z([o,n,t]).pipe(m(([i,{top:a,bottom:s},{offset:{y:p},size:{height:c}}])=>(c=Math.max(0,c-Math.max(0,a-p,i)-Math.max(0,c+p-s)),{offset:a-i,height:c,active:a-i<=p})),K((i,a)=>i.offset===a.offset&&i.height===a.height&&i.active===a.active))}function Ba(e){let t=__md_get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return I(...e).pipe(oe(o=>d(o,"change").pipe(m(()=>o))),Q(e[r]),m(o=>({index:e.indexOf(o),color:{media:o.getAttribute("data-md-color-media"),scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),B(1))}function Kn(e){let t=$("input",e),r=x("meta",{name:"theme-color"});document.head.appendChild(r);let o=x("meta",{name:"color-scheme"});document.head.appendChild(o);let n=$t("(prefers-color-scheme: light)");return C(()=>{let i=new g;return i.subscribe(a=>{if(document.body.setAttribute("data-md-color-switching",""),a.color.media==="(prefers-color-scheme)"){let s=matchMedia("(prefers-color-scheme: light)"),p=document.querySelector(s.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");a.color.scheme=p.getAttribute("data-md-color-scheme"),a.color.primary=p.getAttribute("data-md-color-primary"),a.color.accent=p.getAttribute("data-md-color-accent")}for(let[s,p]of Object.entries(a.color))document.body.setAttribute(`data-md-color-${s}`,p);for(let s=0;sa.key==="Enter"),ee(i,(a,s)=>s)).subscribe(({index:a})=>{a=(a+1)%t.length,t[a].click(),t[a].focus()}),i.pipe(m(()=>{let a=Se("header"),s=window.getComputedStyle(a);return o.content=s.colorScheme,s.backgroundColor.match(/\d+/g).map(p=>(+p).toString(16).padStart(2,"0")).join("")})).subscribe(a=>r.content=`#${a}`),i.pipe(be(se)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),Ba(t).pipe(U(n.pipe(Ce(1))),st(),E(a=>i.next(a)),L(()=>i.complete()),m(a=>R({ref:e},a)))})}function Yn(e,{progress$:t}){return C(()=>{let r=new g;return r.subscribe(({value:o})=>{e.style.setProperty("--md-progress-value",`${o}`)}),t.pipe(E(o=>r.next({value:o})),L(()=>r.complete()),m(o=>({ref:e,value:o})))})}var Gr=Vt(Yr());function Ga(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function Bn({alert$:e}){Gr.default.isSupported()&&new F(t=>{new Gr.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||Ga(P(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(E(t=>{t.trigger.focus()}),m(()=>Ee("clipboard.copied"))).subscribe(e)}function Gn(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,e}function Ja(e,t){let r=new Map;for(let o of $("url",e)){let n=P("loc",o),i=[Gn(new URL(n.textContent),t)];r.set(`${i[0]}`,i);for(let a of $("[rel=alternate]",o)){let s=a.getAttribute("href");s!=null&&i.push(Gn(new URL(s),t))}}return r}function ur(e){return mn(new URL("sitemap.xml",e)).pipe(m(t=>Ja(t,new URL(e))),ve(()=>I(new Map)))}function Xa(e,t){if(!(e.target instanceof Element))return M;let r=e.target.closest("a");if(r===null)return M;if(r.target||e.metaKey||e.ctrlKey)return M;let o=new URL(r.href);return o.search=o.hash="",t.has(`${o}`)?(e.preventDefault(),I(new URL(r.href))):M}function Jn(e){let t=new Map;for(let r of $(":scope > *",e.head))t.set(r.outerHTML,r);return t}function Xn(e){for(let t of $("[href], [src]",e))for(let r of["href","src"]){let o=t.getAttribute(r);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){t[r]=t[r];break}}return I(e)}function Za(e){for(let o of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...G("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let n=fe(o),i=fe(o,e);typeof n!="undefined"&&typeof i!="undefined"&&n.replaceWith(i)}let t=Jn(document);for(let[o,n]of Jn(e))t.has(o)?t.delete(o):document.head.appendChild(n);for(let o of t.values()){let n=o.getAttribute("name");n!=="theme-color"&&n!=="color-scheme"&&o.remove()}let r=Se("container");return je($("script",r)).pipe(v(o=>{let n=e.createElement("script");if(o.src){for(let i of o.getAttributeNames())n.setAttribute(i,o.getAttribute(i));return o.replaceWith(n),new F(i=>{n.onload=()=>i.complete()})}else return n.textContent=o.textContent,o.replaceWith(n),M}),X(),ne(document))}function Zn({location$:e,viewport$:t,progress$:r}){let o=ye();if(location.protocol==="file:")return M;let n=ur(o.base);I(document).subscribe(Xn);let i=d(document.body,"click").pipe(We(n),v(([p,c])=>Xa(p,c)),pe()),a=d(window,"popstate").pipe(m(xe),pe());i.pipe(ee(t)).subscribe(([p,{offset:c}])=>{history.replaceState(c,""),history.pushState(null,"",p)}),S(i,a).subscribe(e);let s=e.pipe(Z("pathname"),v(p=>ln(p,{progress$:r}).pipe(ve(()=>(pt(p,!0),M)))),v(Xn),v(Za),pe());return S(s.pipe(ee(e,(p,c)=>c)),s.pipe(v(()=>e),Z("pathname"),v(()=>e),Z("hash")),e.pipe(K((p,c)=>p.pathname===c.pathname&&p.hash===c.hash),v(()=>i),E(()=>history.back()))).subscribe(p=>{var c,l;history.state!==null||!p.hash?window.scrollTo(0,(l=(c=history.state)==null?void 0:c.y)!=null?l:0):(history.scrollRestoration="auto",sn(p.hash),history.scrollRestoration="manual")}),e.subscribe(()=>{history.scrollRestoration="manual"}),d(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),t.pipe(Z("offset"),_e(100)).subscribe(({offset:p})=>{history.replaceState(p,"")}),s}var ri=Vt(ti());function oi(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,a)=>`${i}${a}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return a=>(0,ri.default)(a).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function It(e){return e.type===1}function dr(e){return e.type===3}function ni(e,t){let r=vn(e);return S(I(location.protocol!=="file:"),Ve("search")).pipe(Ae(o=>o),v(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:G("search.suggest")}}})),r}function ii({document$:e}){let t=ye(),r=Ne(new URL("../versions.json",t.base)).pipe(ve(()=>M)),o=r.pipe(m(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:a,aliases:s})=>a===i||s.includes(i))||n[0]}));r.pipe(m(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),v(n=>d(document.body,"click").pipe(b(i=>!i.metaKey&&!i.ctrlKey),ee(o),v(([i,a])=>{if(i.target instanceof Element){let s=i.target.closest("a");if(s&&!s.target&&n.has(s.href)){let p=s.href;return!i.target.closest(".md-version")&&n.get(p)===a?M:(i.preventDefault(),I(p))}}return M}),v(i=>ur(new URL(i)).pipe(m(a=>{let p=xe().href.replace(t.base,i);return a.has(p.split("#")[0])?new URL(p):new URL(i)})))))).subscribe(n=>pt(n,!0)),z([r,o]).subscribe(([n,i])=>{P(".md-header__topic").appendChild(Mn(n,i))}),e.pipe(v(()=>o)).subscribe(n=>{var a;let i=__md_get("__outdated",sessionStorage);if(i===null){i=!0;let s=((a=t.version)==null?void 0:a.default)||"latest";Array.isArray(s)||(s=[s]);e:for(let p of s)for(let c of n.aliases.concat(n.version))if(new RegExp(p,"i").test(c)){i=!1;break e}__md_set("__outdated",i,sessionStorage)}if(i)for(let s of ae("outdated"))s.hidden=!1})}function ns(e,{worker$:t}){let{searchParams:r}=xe();r.has("q")&&(Je("search",!0),e.value=r.get("q"),e.focus(),Ve("search").pipe(Ae(i=>!i)).subscribe(()=>{let i=xe();i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=et(e),n=S(t.pipe(Ae(It)),d(e,"keyup"),o).pipe(m(()=>e.value),K());return z([n,o]).pipe(m(([i,a])=>({value:i,focus:a})),B(1))}function ai(e,{worker$:t}){let r=new g,o=r.pipe(X(),ne(!0));z([t.pipe(Ae(It)),r],(i,a)=>a).pipe(Z("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(Z("focus")).subscribe(({focus:i})=>{i&&Je("search",i)}),d(e.form,"reset").pipe(U(o)).subscribe(()=>e.focus());let n=P("header [for=__search]");return d(n,"click").subscribe(()=>e.focus()),ns(e,{worker$:t}).pipe(E(i=>r.next(i)),L(()=>r.complete()),m(i=>R({ref:e},i)),B(1))}function si(e,{worker$:t,query$:r}){let o=new g,n=tn(e.parentElement).pipe(b(Boolean)),i=e.parentElement,a=P(":scope > :first-child",e),s=P(":scope > :last-child",e);Ve("search").subscribe(l=>s.setAttribute("role",l?"list":"presentation")),o.pipe(ee(r),Ur(t.pipe(Ae(It)))).subscribe(([{items:l},{value:f}])=>{switch(l.length){case 0:a.textContent=f.length?Ee("search.result.none"):Ee("search.result.placeholder");break;case 1:a.textContent=Ee("search.result.one");break;default:let u=sr(l.length);a.textContent=Ee("search.result.other",u)}});let p=o.pipe(E(()=>s.innerHTML=""),v(({items:l})=>S(I(...l.slice(0,10)),I(...l.slice(10)).pipe(Ye(4),Vr(n),v(([f])=>f)))),m(Tn),pe());return p.subscribe(l=>s.appendChild(l)),p.pipe(oe(l=>{let f=fe("details",l);return typeof f=="undefined"?M:d(f,"toggle").pipe(U(o),m(()=>f))})).subscribe(l=>{l.open===!1&&l.offsetTop<=i.scrollTop&&i.scrollTo({top:l.offsetTop})}),t.pipe(b(dr),m(({data:l})=>l)).pipe(E(l=>o.next(l)),L(()=>o.complete()),m(l=>R({ref:e},l)))}function is(e,{query$:t}){return t.pipe(m(({value:r})=>{let o=xe();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function ci(e,t){let r=new g,o=r.pipe(X(),ne(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),d(e,"click").pipe(U(o)).subscribe(n=>n.preventDefault()),is(e,t).pipe(E(n=>r.next(n)),L(()=>r.complete()),m(n=>R({ref:e},n)))}function pi(e,{worker$:t,keyboard$:r}){let o=new g,n=Se("search-query"),i=S(d(n,"keydown"),d(n,"focus")).pipe(be(se),m(()=>n.value),K());return o.pipe(We(i),m(([{suggest:s},p])=>{let c=p.split(/([\s-]+)/);if(s!=null&&s.length&&c[c.length-1]){let l=s[s.length-1];l.startsWith(c[c.length-1])&&(c[c.length-1]=l)}else c.length=0;return c})).subscribe(s=>e.innerHTML=s.join("").replace(/\s/g," ")),r.pipe(b(({mode:s})=>s==="search")).subscribe(s=>{switch(s.type){case"ArrowRight":e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText);break}}),t.pipe(b(dr),m(({data:s})=>s)).pipe(E(s=>o.next(s)),L(()=>o.complete()),m(()=>({ref:e})))}function li(e,{index$:t,keyboard$:r}){let o=ye();try{let n=ni(o.search,t),i=Se("search-query",e),a=Se("search-result",e);d(e,"click").pipe(b(({target:p})=>p instanceof Element&&!!p.closest("a"))).subscribe(()=>Je("search",!1)),r.pipe(b(({mode:p})=>p==="search")).subscribe(p=>{let c=Re();switch(p.type){case"Enter":if(c===i){let l=new Map;for(let f of $(":first-child [href]",a)){let u=f.firstElementChild;l.set(f,parseFloat(u.getAttribute("data-md-score")))}if(l.size){let[[f]]=[...l].sort(([,u],[,h])=>h-u);f.click()}p.claim()}break;case"Escape":case"Tab":Je("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof c=="undefined")i.focus();else{let l=[i,...$(":not(details) > [href], summary, details[open] [href]",a)],f=Math.max(0,(Math.max(0,l.indexOf(c))+l.length+(p.type==="ArrowUp"?-1:1))%l.length);l[f].focus()}p.claim();break;default:i!==Re()&&i.focus()}}),r.pipe(b(({mode:p})=>p==="global")).subscribe(p=>{switch(p.type){case"f":case"s":case"/":i.focus(),i.select(),p.claim();break}});let s=ai(i,{worker$:n});return S(s,si(a,{worker$:n,query$:s})).pipe(Pe(...ae("search-share",e).map(p=>ci(p,{query$:s})),...ae("search-suggest",e).map(p=>pi(p,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,Ke}}function mi(e,{index$:t,location$:r}){return z([t,r.pipe(Q(xe()),b(o=>!!o.searchParams.get("h")))]).pipe(m(([o,n])=>oi(o.config)(n.searchParams.get("h"))),m(o=>{var a;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let s=i.nextNode();s;s=i.nextNode())if((a=s.parentElement)!=null&&a.offsetHeight){let p=s.textContent,c=o(p);c.length>p.length&&n.set(s,c)}for(let[s,p]of n){let{childNodes:c}=x("span",null,p);s.replaceWith(...Array.from(c))}return{ref:e,nodes:n}}))}function as(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return z([r,t]).pipe(m(([{offset:i,height:a},{offset:{y:s}}])=>(a=a+Math.min(n,Math.max(0,s-i))-n,{height:a,locked:s>=i+n})),K((i,a)=>i.height===a.height&&i.locked===a.locked))}function Jr(e,o){var n=o,{header$:t}=n,r=io(n,["header$"]);let i=P(".md-sidebar__scrollwrap",e),{y:a}=Ue(i);return C(()=>{let s=new g,p=s.pipe(X(),ne(!0)),c=s.pipe(Le(0,me));return c.pipe(ee(t)).subscribe({next([{height:l},{height:f}]){i.style.height=`${l-2*a}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),c.pipe(Ae()).subscribe(()=>{for(let l of $(".md-nav__link--active[href]",e)){if(!l.clientHeight)continue;let f=l.closest(".md-sidebar__scrollwrap");if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:h}=ce(f);f.scrollTo({top:u-h/2})}}}),ue($("label[tabindex]",e)).pipe(oe(l=>d(l,"click").pipe(be(se),m(()=>l),U(p)))).subscribe(l=>{let f=P(`[id="${l.htmlFor}"]`);P(`[aria-labelledby="${l.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),as(e,r).pipe(E(l=>s.next(l)),L(()=>s.complete()),m(l=>R({ref:e},l)))})}function fi(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return Ct(Ne(`${r}/releases/latest`).pipe(ve(()=>M),m(o=>({version:o.tag_name})),Be({})),Ne(r).pipe(ve(()=>M),m(o=>({stars:o.stargazers_count,forks:o.forks_count})),Be({}))).pipe(m(([o,n])=>R(R({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return Ne(r).pipe(m(o=>({repositories:o.public_repos})),Be({}))}}function ui(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return Ne(r).pipe(ve(()=>M),m(({star_count:o,forks_count:n})=>({stars:o,forks:n})),Be({}))}function di(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return fi(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return ui(r,o)}return M}var ss;function cs(e){return ss||(ss=C(()=>{let t=__md_get("__source",sessionStorage);if(t)return I(t);if(ae("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return M}return di(e.href).pipe(E(o=>__md_set("__source",o,sessionStorage)))}).pipe(ve(()=>M),b(t=>Object.keys(t).length>0),m(t=>({facts:t})),B(1)))}function hi(e){let t=P(":scope > :last-child",e);return C(()=>{let r=new g;return r.subscribe(({facts:o})=>{t.appendChild(Sn(o)),t.classList.add("md-source__repository--active")}),cs(e).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))})}function ps(e,{viewport$:t,header$:r}){return ge(document.body).pipe(v(()=>mr(e,{header$:r,viewport$:t})),m(({offset:{y:o}})=>({hidden:o>=10})),Z("hidden"))}function bi(e,t){return C(()=>{let r=new g;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(G("navigation.tabs.sticky")?I({hidden:!1}):ps(e,t)).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))})}function ls(e,{viewport$:t,header$:r}){let o=new Map,n=$(".md-nav__link",e);for(let s of n){let p=decodeURIComponent(s.hash.substring(1)),c=fe(`[id="${p}"]`);typeof c!="undefined"&&o.set(s,c)}let i=r.pipe(Z("height"),m(({height:s})=>{let p=Se("main"),c=P(":scope > :first-child",p);return s+.8*(c.offsetTop-p.offsetTop)}),pe());return ge(document.body).pipe(Z("height"),v(s=>C(()=>{let p=[];return I([...o].reduce((c,[l,f])=>{for(;p.length&&o.get(p[p.length-1]).tagName>=f.tagName;)p.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let h=f.offsetParent;for(;h;h=h.offsetParent)u+=h.offsetTop;return c.set([...p=[...p,l]].reverse(),u)},new Map))}).pipe(m(p=>new Map([...p].sort(([,c],[,l])=>c-l))),We(i),v(([p,c])=>t.pipe(jr(([l,f],{offset:{y:u},size:h})=>{let w=u+h.height>=Math.floor(s.height);for(;f.length;){let[,A]=f[0];if(A-c=u&&!w)f=[l.pop(),...f];else break}return[l,f]},[[],[...p]]),K((l,f)=>l[0]===f[0]&&l[1]===f[1])))))).pipe(m(([s,p])=>({prev:s.map(([c])=>c),next:p.map(([c])=>c)})),Q({prev:[],next:[]}),Ye(2,1),m(([s,p])=>s.prev.length{let i=new g,a=i.pipe(X(),ne(!0));if(i.subscribe(({prev:s,next:p})=>{for(let[c]of p)c.classList.remove("md-nav__link--passed"),c.classList.remove("md-nav__link--active");for(let[c,[l]]of s.entries())l.classList.add("md-nav__link--passed"),l.classList.toggle("md-nav__link--active",c===s.length-1)}),G("toc.follow")){let s=S(t.pipe(_e(1),m(()=>{})),t.pipe(_e(250),m(()=>"smooth")));i.pipe(b(({prev:p})=>p.length>0),We(o.pipe(be(se))),ee(s)).subscribe(([[{prev:p}],c])=>{let[l]=p[p.length-1];if(l.offsetHeight){let f=cr(l);if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:h}=ce(f);f.scrollTo({top:u-h/2,behavior:c})}}})}return G("navigation.tracking")&&t.pipe(U(a),Z("offset"),_e(250),Ce(1),U(n.pipe(Ce(1))),st({delay:250}),ee(i)).subscribe(([,{prev:s}])=>{let p=xe(),c=s[s.length-1];if(c&&c.length){let[l]=c,{hash:f}=new URL(l.href);p.hash!==f&&(p.hash=f,history.replaceState({},"",`${p}`))}else p.hash="",history.replaceState({},"",`${p}`)}),ls(e,{viewport$:t,header$:r}).pipe(E(s=>i.next(s)),L(()=>i.complete()),m(s=>R({ref:e},s)))})}function ms(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(m(({offset:{y:a}})=>a),Ye(2,1),m(([a,s])=>a>s&&s>0),K()),i=r.pipe(m(({active:a})=>a));return z([i,n]).pipe(m(([a,s])=>!(a&&s)),K(),U(o.pipe(Ce(1))),ne(!0),st({delay:250}),m(a=>({hidden:a})))}function gi(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new g,a=i.pipe(X(),ne(!0));return i.subscribe({next({hidden:s}){e.hidden=s,s?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(U(a),Z("height")).subscribe(({height:s})=>{e.style.top=`${s+16}px`}),d(e,"click").subscribe(s=>{s.preventDefault(),window.scrollTo({top:0})}),ms(e,{viewport$:t,main$:o,target$:n}).pipe(E(s=>i.next(s)),L(()=>i.complete()),m(s=>R({ref:e},s)))}function xi({document$:e,viewport$:t}){e.pipe(v(()=>$(".md-ellipsis")),oe(r=>tt(r).pipe(U(e.pipe(Ce(1))),b(o=>o),m(()=>r),Te(1))),b(r=>r.offsetWidth{let o=r.innerText,n=r.closest("a")||r;return n.title=o,lt(n,{viewport$:t}).pipe(U(e.pipe(Ce(1))),L(()=>n.removeAttribute("title")))})).subscribe(),e.pipe(v(()=>$(".md-status")),oe(r=>lt(r,{viewport$:t}))).subscribe()}function yi({document$:e,tablet$:t}){e.pipe(v(()=>$(".md-toggle--indeterminate")),E(r=>{r.indeterminate=!0,r.checked=!1}),oe(r=>d(r,"change").pipe(Dr(()=>r.classList.contains("md-toggle--indeterminate")),m(()=>r))),ee(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function fs(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function Ei({document$:e}){e.pipe(v(()=>$("[data-md-scrollfix]")),E(t=>t.removeAttribute("data-md-scrollfix")),b(fs),oe(t=>d(t,"touchstart").pipe(m(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function wi({viewport$:e,tablet$:t}){z([Ve("search"),t]).pipe(m(([r,o])=>r&&!o),v(r=>I(r).pipe(Ge(r?400:100))),ee(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function us(){return location.protocol==="file:"?wt(`${new URL("search/search_index.js",Xr.base)}`).pipe(m(()=>__index),B(1)):Ne(new URL("search/search_index.json",Xr.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var ot=Yo(),jt=nn(),Ot=cn(jt),Zr=on(),Oe=bn(),hr=$t("(min-width: 960px)"),Si=$t("(min-width: 1220px)"),Oi=pn(),Xr=ye(),Mi=document.forms.namedItem("search")?us():Ke,eo=new g;Bn({alert$:eo});var to=new g;G("navigation.instant")&&Zn({location$:jt,viewport$:Oe,progress$:to}).subscribe(ot);var Ti;((Ti=Xr.version)==null?void 0:Ti.provider)==="mike"&&ii({document$:ot});S(jt,Ot).pipe(Ge(125)).subscribe(()=>{Je("drawer",!1),Je("search",!1)});Zr.pipe(b(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=fe("link[rel=prev]");typeof t!="undefined"&&pt(t);break;case"n":case".":let r=fe("link[rel=next]");typeof r!="undefined"&&pt(r);break;case"Enter":let o=Re();o instanceof HTMLLabelElement&&o.click()}});xi({viewport$:Oe,document$:ot});yi({document$:ot,tablet$:hr});Ei({document$:ot});wi({viewport$:Oe,tablet$:hr});var rt=Nn(Se("header"),{viewport$:Oe}),Ft=ot.pipe(m(()=>Se("main")),v(e=>Qn(e,{viewport$:Oe,header$:rt})),B(1)),ds=S(...ae("consent").map(e=>xn(e,{target$:Ot})),...ae("dialog").map(e=>Dn(e,{alert$:eo})),...ae("header").map(e=>zn(e,{viewport$:Oe,header$:rt,main$:Ft})),...ae("palette").map(e=>Kn(e)),...ae("progress").map(e=>Yn(e,{progress$:to})),...ae("search").map(e=>li(e,{index$:Mi,keyboard$:Zr})),...ae("source").map(e=>hi(e))),hs=C(()=>S(...ae("announce").map(e=>gn(e)),...ae("content").map(e=>Un(e,{viewport$:Oe,target$:Ot,print$:Oi})),...ae("content").map(e=>G("search.highlight")?mi(e,{index$:Mi,location$:jt}):M),...ae("header-title").map(e=>qn(e,{viewport$:Oe,header$:rt})),...ae("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?Nr(Si,()=>Jr(e,{viewport$:Oe,header$:rt,main$:Ft})):Nr(hr,()=>Jr(e,{viewport$:Oe,header$:rt,main$:Ft}))),...ae("tabs").map(e=>bi(e,{viewport$:Oe,header$:rt})),...ae("toc").map(e=>vi(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Ot})),...ae("top").map(e=>gi(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Ot})))),Li=ot.pipe(v(()=>hs),Pe(ds),B(1));Li.subscribe();window.document$=ot;window.location$=jt;window.target$=Ot;window.keyboard$=Zr;window.viewport$=Oe;window.tablet$=hr;window.screen$=Si;window.print$=Oi;window.alert$=eo;window.progress$=to;window.component$=Li;})(); +//# sourceMappingURL=bundle.ad660dcc.min.js.map + diff --git a/assets/javascripts/bundle.ad660dcc.min.js.map b/assets/javascripts/bundle.ad660dcc.min.js.map new file mode 100644 index 00000000..6d61170f --- /dev/null +++ b/assets/javascripts/bundle.ad660dcc.min.js.map @@ -0,0 +1,7 @@ +{ + "version": 3, + "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/clipboard/dist/clipboard.js", "node_modules/escape-html/index.js", "src/templates/assets/javascripts/bundle.ts", "node_modules/rxjs/node_modules/tslib/tslib.es6.js", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/BehaviorSubject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/QueueAction.ts", "node_modules/rxjs/src/internal/scheduler/QueueScheduler.ts", "node_modules/rxjs/src/internal/scheduler/queue.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounce.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/takeLast.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/templates/assets/javascripts/browser/document/index.ts", "src/templates/assets/javascripts/browser/element/_/index.ts", "src/templates/assets/javascripts/browser/element/focus/index.ts", "src/templates/assets/javascripts/browser/element/hover/index.ts", "src/templates/assets/javascripts/utilities/h/index.ts", "src/templates/assets/javascripts/utilities/round/index.ts", "src/templates/assets/javascripts/browser/script/index.ts", "src/templates/assets/javascripts/browser/element/size/_/index.ts", "src/templates/assets/javascripts/browser/element/size/content/index.ts", "src/templates/assets/javascripts/browser/element/offset/_/index.ts", "src/templates/assets/javascripts/browser/element/offset/content/index.ts", "src/templates/assets/javascripts/browser/element/visibility/index.ts", "src/templates/assets/javascripts/browser/toggle/index.ts", "src/templates/assets/javascripts/browser/keyboard/index.ts", "src/templates/assets/javascripts/browser/location/_/index.ts", "src/templates/assets/javascripts/browser/location/hash/index.ts", "src/templates/assets/javascripts/browser/media/index.ts", "src/templates/assets/javascripts/browser/request/index.ts", "src/templates/assets/javascripts/browser/viewport/offset/index.ts", "src/templates/assets/javascripts/browser/viewport/size/index.ts", "src/templates/assets/javascripts/browser/viewport/_/index.ts", "src/templates/assets/javascripts/browser/viewport/at/index.ts", "src/templates/assets/javascripts/browser/worker/index.ts", "src/templates/assets/javascripts/_/index.ts", "src/templates/assets/javascripts/components/_/index.ts", "src/templates/assets/javascripts/components/announce/index.ts", "src/templates/assets/javascripts/components/consent/index.ts", "src/templates/assets/javascripts/templates/tooltip/index.tsx", "src/templates/assets/javascripts/templates/annotation/index.tsx", "src/templates/assets/javascripts/templates/clipboard/index.tsx", "src/templates/assets/javascripts/templates/search/index.tsx", "src/templates/assets/javascripts/templates/source/index.tsx", "src/templates/assets/javascripts/templates/tabbed/index.tsx", "src/templates/assets/javascripts/templates/table/index.tsx", "src/templates/assets/javascripts/templates/version/index.tsx", "src/templates/assets/javascripts/components/tooltip2/index.ts", "src/templates/assets/javascripts/components/content/annotation/_/index.ts", "src/templates/assets/javascripts/components/content/annotation/list/index.ts", "src/templates/assets/javascripts/components/content/annotation/block/index.ts", "src/templates/assets/javascripts/components/content/code/_/index.ts", "src/templates/assets/javascripts/components/content/details/index.ts", "src/templates/assets/javascripts/components/content/mermaid/index.css", "src/templates/assets/javascripts/components/content/mermaid/index.ts", "src/templates/assets/javascripts/components/content/table/index.ts", "src/templates/assets/javascripts/components/content/tabs/index.ts", "src/templates/assets/javascripts/components/content/_/index.ts", "src/templates/assets/javascripts/components/dialog/index.ts", "src/templates/assets/javascripts/components/tooltip/index.ts", "src/templates/assets/javascripts/components/header/_/index.ts", "src/templates/assets/javascripts/components/header/title/index.ts", "src/templates/assets/javascripts/components/main/index.ts", "src/templates/assets/javascripts/components/palette/index.ts", "src/templates/assets/javascripts/components/progress/index.ts", "src/templates/assets/javascripts/integrations/clipboard/index.ts", "src/templates/assets/javascripts/integrations/sitemap/index.ts", "src/templates/assets/javascripts/integrations/instant/index.ts", "src/templates/assets/javascripts/integrations/search/highlighter/index.ts", "src/templates/assets/javascripts/integrations/search/worker/message/index.ts", "src/templates/assets/javascripts/integrations/search/worker/_/index.ts", "src/templates/assets/javascripts/integrations/version/index.ts", "src/templates/assets/javascripts/components/search/query/index.ts", "src/templates/assets/javascripts/components/search/result/index.ts", "src/templates/assets/javascripts/components/search/share/index.ts", "src/templates/assets/javascripts/components/search/suggest/index.ts", "src/templates/assets/javascripts/components/search/_/index.ts", "src/templates/assets/javascripts/components/search/highlight/index.ts", "src/templates/assets/javascripts/components/sidebar/index.ts", "src/templates/assets/javascripts/components/source/facts/github/index.ts", "src/templates/assets/javascripts/components/source/facts/gitlab/index.ts", "src/templates/assets/javascripts/components/source/facts/_/index.ts", "src/templates/assets/javascripts/components/source/_/index.ts", "src/templates/assets/javascripts/components/tabs/index.ts", "src/templates/assets/javascripts/components/toc/index.ts", "src/templates/assets/javascripts/components/top/index.ts", "src/templates/assets/javascripts/patches/ellipsis/index.ts", "src/templates/assets/javascripts/patches/indeterminate/index.ts", "src/templates/assets/javascripts/patches/scrollfix/index.ts", "src/templates/assets/javascripts/patches/scrolllock/index.ts", "src/templates/assets/javascripts/polyfills/index.ts"], + "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*\n * Copyright (c) 2016-2024 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountProgress,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n setupClipboardJS,\n setupInstantNavigation,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchEllipsis,\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 960px)\")\nconst screen$ = watchMedia(\"(min-width: 1220px)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up progress indicator */\nconst progress$ = new Subject()\n\n/* Set up instant navigation, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantNavigation({ location$, viewport$, progress$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchEllipsis({ viewport$, document$ })\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Progress bar */\n ...getComponentElements(\"progress\")\n .map(el => mountProgress(el, { progress$ })),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.progress$ = progress$ /* Progress indicator subject */\nwindow.component$ = component$ /* Component observable */\n", "/*! *****************************************************************************\r\nCopyright (c) Microsoft Corporation.\r\n\r\nPermission to use, copy, modify, and/or distribute this software for any\r\npurpose with or without fee is hereby granted.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\r\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\r\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\r\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\r\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\r\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\r\nPERFORMANCE OF THIS SOFTWARE.\r\n***************************************************************************** */\r\n/* global Reflect, Promise */\r\n\r\nvar extendStatics = function(d, b) {\r\n extendStatics = Object.setPrototypeOf ||\r\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\r\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\r\n return extendStatics(d, b);\r\n};\r\n\r\nexport function __extends(d, b) {\r\n if (typeof b !== \"function\" && b !== null)\r\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\r\n extendStatics(d, b);\r\n function __() { this.constructor = d; }\r\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\r\n}\r\n\r\nexport var __assign = function() {\r\n __assign = Object.assign || function __assign(t) {\r\n for (var s, i = 1, n = arguments.length; i < n; i++) {\r\n s = arguments[i];\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\r\n }\r\n return t;\r\n }\r\n return __assign.apply(this, arguments);\r\n}\r\n\r\nexport function __rest(s, e) {\r\n var t = {};\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\r\n t[p] = s[p];\r\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\r\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\r\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\r\n t[p[i]] = s[p[i]];\r\n }\r\n return t;\r\n}\r\n\r\nexport function __decorate(decorators, target, key, desc) {\r\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\r\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\r\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\r\n return c > 3 && r && Object.defineProperty(target, key, r), r;\r\n}\r\n\r\nexport function __param(paramIndex, decorator) {\r\n return function (target, key) { decorator(target, key, paramIndex); }\r\n}\r\n\r\nexport function __metadata(metadataKey, metadataValue) {\r\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\r\n}\r\n\r\nexport function __awaiter(thisArg, _arguments, P, generator) {\r\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\r\n return new (P || (P = Promise))(function (resolve, reject) {\r\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\r\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\r\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\r\n step((generator = generator.apply(thisArg, _arguments || [])).next());\r\n });\r\n}\r\n\r\nexport function __generator(thisArg, body) {\r\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;\r\n return g = { next: verb(0), \"throw\": verb(1), \"return\": verb(2) }, typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\r\n function verb(n) { return function (v) { return step([n, v]); }; }\r\n function step(op) {\r\n if (f) throw new TypeError(\"Generator is already executing.\");\r\n while (_) try {\r\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\r\n if (y = 0, t) op = [op[0] & 2, t.value];\r\n switch (op[0]) {\r\n case 0: case 1: t = op; break;\r\n case 4: _.label++; return { value: op[1], done: false };\r\n case 5: _.label++; y = op[1]; op = [0]; continue;\r\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\r\n default:\r\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\r\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\r\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\r\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\r\n if (t[2]) _.ops.pop();\r\n _.trys.pop(); continue;\r\n }\r\n op = body.call(thisArg, _);\r\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\r\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\r\n }\r\n}\r\n\r\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });\r\n}) : (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n o[k2] = m[k];\r\n});\r\n\r\nexport function __exportStar(m, o) {\r\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\r\n}\r\n\r\nexport function __values(o) {\r\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\r\n if (m) return m.call(o);\r\n if (o && typeof o.length === \"number\") return {\r\n next: function () {\r\n if (o && i >= o.length) o = void 0;\r\n return { value: o && o[i++], done: !o };\r\n }\r\n };\r\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\r\n}\r\n\r\nexport function __read(o, n) {\r\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\r\n if (!m) return o;\r\n var i = m.call(o), r, ar = [], e;\r\n try {\r\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\r\n }\r\n catch (error) { e = { error: error }; }\r\n finally {\r\n try {\r\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\r\n }\r\n finally { if (e) throw e.error; }\r\n }\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spread() {\r\n for (var ar = [], i = 0; i < arguments.length; i++)\r\n ar = ar.concat(__read(arguments[i]));\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spreadArrays() {\r\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\r\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\r\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\r\n r[k] = a[j];\r\n return r;\r\n}\r\n\r\nexport function __spreadArray(to, from, pack) {\r\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\r\n if (ar || !(i in from)) {\r\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\r\n ar[i] = from[i];\r\n }\r\n }\r\n return to.concat(ar || Array.prototype.slice.call(from));\r\n}\r\n\r\nexport function __await(v) {\r\n return this instanceof __await ? (this.v = v, this) : new __await(v);\r\n}\r\n\r\nexport function __asyncGenerator(thisArg, _arguments, generator) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\r\n return i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i;\r\n function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }\r\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\r\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\r\n function fulfill(value) { resume(\"next\", value); }\r\n function reject(value) { resume(\"throw\", value); }\r\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\r\n}\r\n\r\nexport function __asyncDelegator(o) {\r\n var i, p;\r\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\r\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: n === \"return\" } : f ? f(v) : v; } : f; }\r\n}\r\n\r\nexport function __asyncValues(o) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var m = o[Symbol.asyncIterator], i;\r\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\r\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\r\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\r\n}\r\n\r\nexport function __makeTemplateObject(cooked, raw) {\r\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\r\n return cooked;\r\n};\r\n\r\nvar __setModuleDefault = Object.create ? (function(o, v) {\r\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\r\n}) : function(o, v) {\r\n o[\"default\"] = v;\r\n};\r\n\r\nexport function __importStar(mod) {\r\n if (mod && mod.__esModule) return mod;\r\n var result = {};\r\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\r\n __setModuleDefault(result, mod);\r\n return result;\r\n}\r\n\r\nexport function __importDefault(mod) {\r\n return (mod && mod.__esModule) ? mod : { default: mod };\r\n}\r\n\r\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\r\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\r\n}\r\n\r\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\r\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\r\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\r\n}\r\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n *\n * @class Subscription\n */\nexport class Subscription implements SubscriptionLike {\n /** @nocollapse */\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n * @return {void}\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n *\n * @class Subscriber\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @nocollapse\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param {T} [value] The `next` value.\n * @return {void}\n */\n next(value?: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param {any} [err] The `error` exception.\n * @return {void}\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n * @return {void}\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as (((value: T) => void) | undefined),\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent\n * @param subscriber The stopped subscriber\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n *\n * @class Observable\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @constructor\n * @param {Function} subscribe the function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @owner Observable\n * @method create\n * @param {Function} subscribe? the subscriber function to be passed to the Observable constructor\n * @return {Observable} a new observable\n * @nocollapse\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @method lift\n * @param operator the operator defining the operation to take on the observable\n * @return a new observable with the Operator applied\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening.\n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param {Observer|Function} observerOrNext (optional) Either an observer with methods to be called,\n * or the first of three possible handlers, which is the handler for each value emitted from the subscribed\n * Observable.\n * @param {Function} error (optional) A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param {Function} complete (optional) A handler for a terminal event resulting from successful completion.\n * @return {Subscription} a subscription reference to the registered handlers\n * @method subscribe\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next a handler for each value emitted by the observable\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @method Symbol.observable\n * @return {Observable} this instance of the observable\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction,\n ...operations: OperatorFunction[]\n ): Observable;\n /* tslint:enable:max-line-length */\n\n /**\n * Used to stitch together functional operators into a chain.\n * @method pipe\n * @return {Observable} the Observable result of all of the operators having\n * been called in the order they were passed in.\n *\n * ## Example\n *\n * ```ts\n * import { interval, filter, map, scan } from 'rxjs';\n *\n * interval(1000)\n * .pipe(\n * filter(x => x % 2 === 0),\n * map(x => x + x),\n * scan((acc, x) => acc + x)\n * )\n * .subscribe(x => console.log(x));\n * ```\n */\n pipe(...operations: OperatorFunction[]): Observable {\n return pipeFromArray(operations)(this);\n }\n\n /* tslint:disable:max-line-length */\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: typeof Promise): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: PromiseConstructorLike): Promise;\n /* tslint:enable:max-line-length */\n\n /**\n * Subscribe to this Observable and get a Promise resolving on\n * `complete` with the last emission (if any).\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * @method toPromise\n * @param [promiseCtor] a constructor function used to instantiate\n * the Promise\n * @return A Promise that resolves with the last value emit, or\n * rejects on an error. If there were no emissions, Promise\n * resolves with undefined.\n * @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise\n */\n toPromise(promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n let value: T | undefined;\n this.subscribe(\n (x: T) => (value = x),\n (err: any) => reject(err),\n () => resolve(value)\n );\n }) as Promise;\n }\n}\n\n/**\n * Decides between a passed promise constructor from consuming code,\n * A default configured promise constructor, and the native promise\n * constructor and returns it. If nothing can be found, it will throw\n * an error.\n * @param promiseCtor The optional promise constructor to passed by consuming code\n */\nfunction getPromiseCtor(promiseCtor: PromiseConstructorLike | undefined) {\n return promiseCtor ?? config.Promise ?? Promise;\n}\n\nfunction isObserver(value: any): value is Observer {\n return value && isFunction(value.next) && isFunction(value.error) && isFunction(value.complete);\n}\n\nfunction isSubscriber(value: any): value is Subscriber {\n return (value && value instanceof Subscriber) || (isObserver(value) && isSubscription(value));\n}\n", "import { Observable } from '../Observable';\nimport { Subscriber } from '../Subscriber';\nimport { OperatorFunction } from '../types';\nimport { isFunction } from './isFunction';\n\n/**\n * Used to determine if an object is an Observable with a lift function.\n */\nexport function hasLift(source: any): source is { lift: InstanceType['lift'] } {\n return isFunction(source?.lift);\n}\n\n/**\n * Creates an `OperatorFunction`. Used to define operators throughout the library in a concise way.\n * @param init The logic to connect the liftedSource to the subscriber at the moment of subscription.\n */\nexport function operate(\n init: (liftedSource: Observable, subscriber: Subscriber) => (() => void) | void\n): OperatorFunction {\n return (source: Observable) => {\n if (hasLift(source)) {\n return source.lift(function (this: Subscriber, liftedSource: Observable) {\n try {\n return init(liftedSource, this);\n } catch (err) {\n this.error(err);\n }\n });\n }\n throw new TypeError('Unable to lift unknown Observable type');\n };\n}\n", "import { Subscriber } from '../Subscriber';\n\n/**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional teardown logic here. This will only be called on teardown if the\n * subscriber itself is not already closed. This is called after all other teardown logic is executed.\n */\nexport function createOperatorSubscriber(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n onFinalize?: () => void\n): Subscriber {\n return new OperatorSubscriber(destination, onNext, onComplete, onError, onFinalize);\n}\n\n/**\n * A generic helper for allowing operators to be created with a Subscriber and\n * use closures to capture necessary state from the operator function itself.\n */\nexport class OperatorSubscriber extends Subscriber {\n /**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional finalization logic here. This will only be called on finalization if the\n * subscriber itself is not already closed. This is called after all other finalization logic is executed.\n * @param shouldUnsubscribe An optional check to see if an unsubscribe call should truly unsubscribe.\n * NOTE: This currently **ONLY** exists to support the strange behavior of {@link groupBy}, where unsubscription\n * to the resulting observable does not actually disconnect from the source if there are active subscriptions\n * to any grouped observable. (DO NOT EXPOSE OR USE EXTERNALLY!!!)\n */\n constructor(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n private onFinalize?: () => void,\n private shouldUnsubscribe?: () => boolean\n ) {\n // It's important - for performance reasons - that all of this class's\n // members are initialized and that they are always initialized in the same\n // order. This will ensure that all OperatorSubscriber instances have the\n // same hidden class in V8. This, in turn, will help keep the number of\n // hidden classes involved in property accesses within the base class as\n // low as possible. If the number of hidden classes involved exceeds four,\n // the property accesses will become megamorphic and performance penalties\n // will be incurred - i.e. inline caches won't be used.\n //\n // The reasons for ensuring all instances have the same hidden class are\n // further discussed in this blog post from Benedikt Meurer:\n // https://benediktmeurer.de/2018/03/23/impact-of-polymorphism-on-component-based-frameworks-like-react/\n super(destination);\n this._next = onNext\n ? function (this: OperatorSubscriber, value: T) {\n try {\n onNext(value);\n } catch (err) {\n destination.error(err);\n }\n }\n : super._next;\n this._error = onError\n ? function (this: OperatorSubscriber, err: any) {\n try {\n onError(err);\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._error;\n this._complete = onComplete\n ? function (this: OperatorSubscriber) {\n try {\n onComplete();\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._complete;\n }\n\n unsubscribe() {\n if (!this.shouldUnsubscribe || this.shouldUnsubscribe()) {\n const { closed } = this;\n super.unsubscribe();\n // Execute additional teardown if we have any and we didn't already do so.\n !closed && this.onFinalize?.();\n }\n }\n}\n", "import { Subscription } from '../Subscription';\n\ninterface AnimationFrameProvider {\n schedule(callback: FrameRequestCallback): Subscription;\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n delegate:\n | {\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n }\n | undefined;\n}\n\nexport const animationFrameProvider: AnimationFrameProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n schedule(callback) {\n let request = requestAnimationFrame;\n let cancel: typeof cancelAnimationFrame | undefined = cancelAnimationFrame;\n const { delegate } = animationFrameProvider;\n if (delegate) {\n request = delegate.requestAnimationFrame;\n cancel = delegate.cancelAnimationFrame;\n }\n const handle = request((timestamp) => {\n // Clear the cancel function. The request has been fulfilled, so\n // attempting to cancel the request upon unsubscription would be\n // pointless.\n cancel = undefined;\n callback(timestamp);\n });\n return new Subscription(() => cancel?.(handle));\n },\n requestAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.requestAnimationFrame || requestAnimationFrame)(...args);\n },\n cancelAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.cancelAnimationFrame || cancelAnimationFrame)(...args);\n },\n delegate: undefined,\n};\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface ObjectUnsubscribedError extends Error {}\n\nexport interface ObjectUnsubscribedErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (): ObjectUnsubscribedError;\n}\n\n/**\n * An error thrown when an action is invalid because the object has been\n * unsubscribed.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n *\n * @class ObjectUnsubscribedError\n */\nexport const ObjectUnsubscribedError: ObjectUnsubscribedErrorCtor = createErrorClass(\n (_super) =>\n function ObjectUnsubscribedErrorImpl(this: any) {\n _super(this);\n this.name = 'ObjectUnsubscribedError';\n this.message = 'object unsubscribed';\n }\n);\n", "import { Operator } from './Operator';\nimport { Observable } from './Observable';\nimport { Subscriber } from './Subscriber';\nimport { Subscription, EMPTY_SUBSCRIPTION } from './Subscription';\nimport { Observer, SubscriptionLike, TeardownLogic } from './types';\nimport { ObjectUnsubscribedError } from './util/ObjectUnsubscribedError';\nimport { arrRemove } from './util/arrRemove';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A Subject is a special type of Observable that allows values to be\n * multicasted to many Observers. Subjects are like EventEmitters.\n *\n * Every Subject is an Observable and an Observer. You can subscribe to a\n * Subject, and you can call next to feed values as well as error and complete.\n */\nexport class Subject extends Observable implements SubscriptionLike {\n closed = false;\n\n private currentObservers: Observer[] | null = null;\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n observers: Observer[] = [];\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n isStopped = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n hasError = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n thrownError: any = null;\n\n /**\n * Creates a \"subject\" by basically gluing an observer to an observable.\n *\n * @nocollapse\n * @deprecated Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.\n */\n static create: (...args: any[]) => any = (destination: Observer, source: Observable): AnonymousSubject => {\n return new AnonymousSubject(destination, source);\n };\n\n constructor() {\n // NOTE: This must be here to obscure Observable's constructor.\n super();\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n lift(operator: Operator): Observable {\n const subject = new AnonymousSubject(this, this);\n subject.operator = operator as any;\n return subject as any;\n }\n\n /** @internal */\n protected _throwIfClosed() {\n if (this.closed) {\n throw new ObjectUnsubscribedError();\n }\n }\n\n next(value: T) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n if (!this.currentObservers) {\n this.currentObservers = Array.from(this.observers);\n }\n for (const observer of this.currentObservers) {\n observer.next(value);\n }\n }\n });\n }\n\n error(err: any) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.hasError = this.isStopped = true;\n this.thrownError = err;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.error(err);\n }\n }\n });\n }\n\n complete() {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.isStopped = true;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.complete();\n }\n }\n });\n }\n\n unsubscribe() {\n this.isStopped = this.closed = true;\n this.observers = this.currentObservers = null!;\n }\n\n get observed() {\n return this.observers?.length > 0;\n }\n\n /** @internal */\n protected _trySubscribe(subscriber: Subscriber): TeardownLogic {\n this._throwIfClosed();\n return super._trySubscribe(subscriber);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._checkFinalizedStatuses(subscriber);\n return this._innerSubscribe(subscriber);\n }\n\n /** @internal */\n protected _innerSubscribe(subscriber: Subscriber) {\n const { hasError, isStopped, observers } = this;\n if (hasError || isStopped) {\n return EMPTY_SUBSCRIPTION;\n }\n this.currentObservers = null;\n observers.push(subscriber);\n return new Subscription(() => {\n this.currentObservers = null;\n arrRemove(observers, subscriber);\n });\n }\n\n /** @internal */\n protected _checkFinalizedStatuses(subscriber: Subscriber) {\n const { hasError, thrownError, isStopped } = this;\n if (hasError) {\n subscriber.error(thrownError);\n } else if (isStopped) {\n subscriber.complete();\n }\n }\n\n /**\n * Creates a new Observable with this Subject as the source. You can do this\n * to create custom Observer-side logic of the Subject and conceal it from\n * code that uses the Observable.\n * @return {Observable} Observable that the Subject casts to\n */\n asObservable(): Observable {\n const observable: any = new Observable();\n observable.source = this;\n return observable;\n }\n}\n\n/**\n * @class AnonymousSubject\n */\nexport class AnonymousSubject extends Subject {\n constructor(\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n public destination?: Observer,\n source?: Observable\n ) {\n super();\n this.source = source;\n }\n\n next(value: T) {\n this.destination?.next?.(value);\n }\n\n error(err: any) {\n this.destination?.error?.(err);\n }\n\n complete() {\n this.destination?.complete?.();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n return this.source?.subscribe(subscriber) ?? EMPTY_SUBSCRIPTION;\n }\n}\n", "import { Subject } from './Subject';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\n\n/**\n * A variant of Subject that requires an initial value and emits its current\n * value whenever it is subscribed to.\n *\n * @class BehaviorSubject\n */\nexport class BehaviorSubject extends Subject {\n constructor(private _value: T) {\n super();\n }\n\n get value(): T {\n return this.getValue();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n const subscription = super._subscribe(subscriber);\n !subscription.closed && subscriber.next(this._value);\n return subscription;\n }\n\n getValue(): T {\n const { hasError, thrownError, _value } = this;\n if (hasError) {\n throw thrownError;\n }\n this._throwIfClosed();\n return _value;\n }\n\n next(value: T): void {\n super.next((this._value = value));\n }\n}\n", "import { TimestampProvider } from '../types';\n\ninterface DateTimestampProvider extends TimestampProvider {\n delegate: TimestampProvider | undefined;\n}\n\nexport const dateTimestampProvider: DateTimestampProvider = {\n now() {\n // Use the variable rather than `this` so that the function can be called\n // without being bound to the provider.\n return (dateTimestampProvider.delegate || Date).now();\n },\n delegate: undefined,\n};\n", "import { Subject } from './Subject';\nimport { TimestampProvider } from './types';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * A variant of {@link Subject} that \"replays\" old values to new subscribers by emitting them when they first subscribe.\n *\n * `ReplaySubject` has an internal buffer that will store a specified number of values that it has observed. Like `Subject`,\n * `ReplaySubject` \"observes\" values by having them passed to its `next` method. When it observes a value, it will store that\n * value for a time determined by the configuration of the `ReplaySubject`, as passed to its constructor.\n *\n * When a new subscriber subscribes to the `ReplaySubject` instance, it will synchronously emit all values in its buffer in\n * a First-In-First-Out (FIFO) manner. The `ReplaySubject` will also complete, if it has observed completion; and it will\n * error if it has observed an error.\n *\n * There are two main configuration items to be concerned with:\n *\n * 1. `bufferSize` - This will determine how many items are stored in the buffer, defaults to infinite.\n * 2. `windowTime` - The amount of time to hold a value in the buffer before removing it from the buffer.\n *\n * Both configurations may exist simultaneously. So if you would like to buffer a maximum of 3 values, as long as the values\n * are less than 2 seconds old, you could do so with a `new ReplaySubject(3, 2000)`.\n *\n * ### Differences with BehaviorSubject\n *\n * `BehaviorSubject` is similar to `new ReplaySubject(1)`, with a couple of exceptions:\n *\n * 1. `BehaviorSubject` comes \"primed\" with a single value upon construction.\n * 2. `ReplaySubject` will replay values, even after observing an error, where `BehaviorSubject` will not.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n * @see {@link shareReplay}\n */\nexport class ReplaySubject extends Subject {\n private _buffer: (T | number)[] = [];\n private _infiniteTimeWindow = true;\n\n /**\n * @param bufferSize The size of the buffer to replay on subscription\n * @param windowTime The amount of time the buffered items will stay buffered\n * @param timestampProvider An object with a `now()` method that provides the current timestamp. This is used to\n * calculate the amount of time something has been buffered.\n */\n constructor(\n private _bufferSize = Infinity,\n private _windowTime = Infinity,\n private _timestampProvider: TimestampProvider = dateTimestampProvider\n ) {\n super();\n this._infiniteTimeWindow = _windowTime === Infinity;\n this._bufferSize = Math.max(1, _bufferSize);\n this._windowTime = Math.max(1, _windowTime);\n }\n\n next(value: T): void {\n const { isStopped, _buffer, _infiniteTimeWindow, _timestampProvider, _windowTime } = this;\n if (!isStopped) {\n _buffer.push(value);\n !_infiniteTimeWindow && _buffer.push(_timestampProvider.now() + _windowTime);\n }\n this._trimBuffer();\n super.next(value);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._trimBuffer();\n\n const subscription = this._innerSubscribe(subscriber);\n\n const { _infiniteTimeWindow, _buffer } = this;\n // We use a copy here, so reentrant code does not mutate our array while we're\n // emitting it to a new subscriber.\n const copy = _buffer.slice();\n for (let i = 0; i < copy.length && !subscriber.closed; i += _infiniteTimeWindow ? 1 : 2) {\n subscriber.next(copy[i] as T);\n }\n\n this._checkFinalizedStatuses(subscriber);\n\n return subscription;\n }\n\n private _trimBuffer() {\n const { _bufferSize, _timestampProvider, _buffer, _infiniteTimeWindow } = this;\n // If we don't have an infinite buffer size, and we're over the length,\n // use splice to truncate the old buffer values off. Note that we have to\n // double the size for instances where we're not using an infinite time window\n // because we're storing the values and the timestamps in the same array.\n const adjustedBufferSize = (_infiniteTimeWindow ? 1 : 2) * _bufferSize;\n _bufferSize < Infinity && adjustedBufferSize < _buffer.length && _buffer.splice(0, _buffer.length - adjustedBufferSize);\n\n // Now, if we're not in an infinite time window, remove all values where the time is\n // older than what is allowed.\n if (!_infiniteTimeWindow) {\n const now = _timestampProvider.now();\n let last = 0;\n // Search the array for the first timestamp that isn't expired and\n // truncate the buffer up to that point.\n for (let i = 1; i < _buffer.length && (_buffer[i] as number) <= now; i += 2) {\n last = i;\n }\n last && _buffer.splice(0, last + 1);\n }\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Subscription } from '../Subscription';\nimport { SchedulerAction } from '../types';\n\n/**\n * A unit of work to be executed in a `scheduler`. An action is typically\n * created from within a {@link SchedulerLike} and an RxJS user does not need to concern\n * themselves about creating and manipulating an Action.\n *\n * ```ts\n * class Action extends Subscription {\n * new (scheduler: Scheduler, work: (state?: T) => void);\n * schedule(state?: T, delay: number = 0): Subscription;\n * }\n * ```\n *\n * @class Action\n */\nexport class Action extends Subscription {\n constructor(scheduler: Scheduler, work: (this: SchedulerAction, state?: T) => void) {\n super();\n }\n /**\n * Schedules this action on its parent {@link SchedulerLike} for execution. May be passed\n * some context object, `state`. May happen at some point in the future,\n * according to the `delay` parameter, if specified.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler.\n * @return {void}\n */\n public schedule(state?: T, delay: number = 0): Subscription {\n return this;\n }\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetIntervalFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearIntervalFunction = (handle: TimerHandle) => void;\n\ninterface IntervalProvider {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n delegate:\n | {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n }\n | undefined;\n}\n\nexport const intervalProvider: IntervalProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setInterval(handler: () => void, timeout?: number, ...args) {\n const { delegate } = intervalProvider;\n if (delegate?.setInterval) {\n return delegate.setInterval(handler, timeout, ...args);\n }\n return setInterval(handler, timeout, ...args);\n },\n clearInterval(handle) {\n const { delegate } = intervalProvider;\n return (delegate?.clearInterval || clearInterval)(handle as any);\n },\n delegate: undefined,\n};\n", "import { Action } from './Action';\nimport { SchedulerAction } from '../types';\nimport { Subscription } from '../Subscription';\nimport { AsyncScheduler } from './AsyncScheduler';\nimport { intervalProvider } from './intervalProvider';\nimport { arrRemove } from '../util/arrRemove';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncAction extends Action {\n public id: TimerHandle | undefined;\n public state?: T;\n // @ts-ignore: Property has no initializer and is not definitely assigned\n public delay: number;\n protected pending: boolean = false;\n\n constructor(protected scheduler: AsyncScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (this.closed) {\n return this;\n }\n\n // Always replace the current state with the new state.\n this.state = state;\n\n const id = this.id;\n const scheduler = this.scheduler;\n\n //\n // Important implementation note:\n //\n // Actions only execute once by default, unless rescheduled from within the\n // scheduled callback. This allows us to implement single and repeat\n // actions via the same code path, without adding API surface area, as well\n // as mimic traditional recursion but across asynchronous boundaries.\n //\n // However, JS runtimes and timers distinguish between intervals achieved by\n // serial `setTimeout` calls vs. a single `setInterval` call. An interval of\n // serial `setTimeout` calls can be individually delayed, which delays\n // scheduling the next `setTimeout`, and so on. `setInterval` attempts to\n // guarantee the interval callback will be invoked more precisely to the\n // interval period, regardless of load.\n //\n // Therefore, we use `setInterval` to schedule single and repeat actions.\n // If the action reschedules itself with the same delay, the interval is not\n // canceled. If the action doesn't reschedule, or reschedules with a\n // different delay, the interval will be canceled after scheduled callback\n // execution.\n //\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, delay);\n }\n\n // Set the pending flag indicating that this action has been scheduled, or\n // has recursively rescheduled itself.\n this.pending = true;\n\n this.delay = delay;\n // If this action has already an async Id, don't request a new one.\n this.id = this.id ?? this.requestAsyncId(scheduler, this.id, delay);\n\n return this;\n }\n\n protected requestAsyncId(scheduler: AsyncScheduler, _id?: TimerHandle, delay: number = 0): TimerHandle {\n return intervalProvider.setInterval(scheduler.flush.bind(scheduler, this), delay);\n }\n\n protected recycleAsyncId(_scheduler: AsyncScheduler, id?: TimerHandle, delay: number | null = 0): TimerHandle | undefined {\n // If this action is rescheduled with the same delay time, don't clear the interval id.\n if (delay != null && this.delay === delay && this.pending === false) {\n return id;\n }\n // Otherwise, if the action's delay time is different from the current delay,\n // or the action has been rescheduled before it's executed, clear the interval id\n if (id != null) {\n intervalProvider.clearInterval(id);\n }\n\n return undefined;\n }\n\n /**\n * Immediately executes this action and the `work` it contains.\n * @return {any}\n */\n public execute(state: T, delay: number): any {\n if (this.closed) {\n return new Error('executing a cancelled action');\n }\n\n this.pending = false;\n const error = this._execute(state, delay);\n if (error) {\n return error;\n } else if (this.pending === false && this.id != null) {\n // Dequeue if the action didn't reschedule itself. Don't call\n // unsubscribe(), because the action could reschedule later.\n // For example:\n // ```\n // scheduler.schedule(function doWork(counter) {\n // /* ... I'm a busy worker bee ... */\n // var originalAction = this;\n // /* wait 100ms before rescheduling the action */\n // setTimeout(function () {\n // originalAction.schedule(counter + 1);\n // }, 100);\n // }, 1000);\n // ```\n this.id = this.recycleAsyncId(this.scheduler, this.id, null);\n }\n }\n\n protected _execute(state: T, _delay: number): any {\n let errored: boolean = false;\n let errorValue: any;\n try {\n this.work(state);\n } catch (e) {\n errored = true;\n // HACK: Since code elsewhere is relying on the \"truthiness\" of the\n // return here, we can't have it return \"\" or 0 or false.\n // TODO: Clean this up when we refactor schedulers mid-version-8 or so.\n errorValue = e ? e : new Error('Scheduled action threw falsy error');\n }\n if (errored) {\n this.unsubscribe();\n return errorValue;\n }\n }\n\n unsubscribe() {\n if (!this.closed) {\n const { id, scheduler } = this;\n const { actions } = scheduler;\n\n this.work = this.state = this.scheduler = null!;\n this.pending = false;\n\n arrRemove(actions, this);\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, null);\n }\n\n this.delay = null!;\n super.unsubscribe();\n }\n }\n}\n", "import { Action } from './scheduler/Action';\nimport { Subscription } from './Subscription';\nimport { SchedulerLike, SchedulerAction } from './types';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * An execution context and a data structure to order tasks and schedule their\n * execution. Provides a notion of (potentially virtual) time, through the\n * `now()` getter method.\n *\n * Each unit of work in a Scheduler is called an `Action`.\n *\n * ```ts\n * class Scheduler {\n * now(): number;\n * schedule(work, delay?, state?): Subscription;\n * }\n * ```\n *\n * @class Scheduler\n * @deprecated Scheduler is an internal implementation detail of RxJS, and\n * should not be used directly. Rather, create your own class and implement\n * {@link SchedulerLike}. Will be made internal in v8.\n */\nexport class Scheduler implements SchedulerLike {\n public static now: () => number = dateTimestampProvider.now;\n\n constructor(private schedulerActionCtor: typeof Action, now: () => number = Scheduler.now) {\n this.now = now;\n }\n\n /**\n * A getter method that returns a number representing the current time\n * (at the time this function was called) according to the scheduler's own\n * internal clock.\n * @return {number} A number that represents the current time. May or may not\n * have a relation to wall-clock time. May or may not refer to a time unit\n * (e.g. milliseconds).\n */\n public now: () => number;\n\n /**\n * Schedules a function, `work`, for execution. May happen at some point in\n * the future, according to the `delay` parameter, if specified. May be passed\n * some context object, `state`, which will be passed to the `work` function.\n *\n * The given arguments will be processed an stored as an Action object in a\n * queue of actions.\n *\n * @param {function(state: ?T): ?Subscription} work A function representing a\n * task, or some unit of work to be executed by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler itself.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @return {Subscription} A subscription in order to be able to unsubscribe\n * the scheduled work.\n */\n public schedule(work: (this: SchedulerAction, state?: T) => void, delay: number = 0, state?: T): Subscription {\n return new this.schedulerActionCtor(this, work).schedule(state, delay);\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Action } from './Action';\nimport { AsyncAction } from './AsyncAction';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncScheduler extends Scheduler {\n public actions: Array> = [];\n /**\n * A flag to indicate whether the Scheduler is currently executing a batch of\n * queued actions.\n * @type {boolean}\n * @internal\n */\n public _active: boolean = false;\n /**\n * An internal ID used to track the latest asynchronous task such as those\n * coming from `setTimeout`, `setInterval`, `requestAnimationFrame`, and\n * others.\n * @type {any}\n * @internal\n */\n public _scheduled: TimerHandle | undefined;\n\n constructor(SchedulerAction: typeof Action, now: () => number = Scheduler.now) {\n super(SchedulerAction, now);\n }\n\n public flush(action: AsyncAction): void {\n const { actions } = this;\n\n if (this._active) {\n actions.push(action);\n return;\n }\n\n let error: any;\n this._active = true;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions.shift()!)); // exhaust the scheduler queue\n\n this._active = false;\n\n if (error) {\n while ((action = actions.shift()!)) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\n/**\n *\n * Async Scheduler\n *\n * Schedule task as if you used setTimeout(task, duration)\n *\n * `async` scheduler schedules tasks asynchronously, by putting them on the JavaScript\n * event loop queue. It is best used to delay tasks in time or to schedule tasks repeating\n * in intervals.\n *\n * If you just want to \"defer\" task, that is to perform it right after currently\n * executing synchronous code ends (commonly achieved by `setTimeout(deferredTask, 0)`),\n * better choice will be the {@link asapScheduler} scheduler.\n *\n * ## Examples\n * Use async scheduler to delay task\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * const task = () => console.log('it works!');\n *\n * asyncScheduler.schedule(task, 2000);\n *\n * // After 2 seconds logs:\n * // \"it works!\"\n * ```\n *\n * Use async scheduler to repeat task in intervals\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * function task(state) {\n * console.log(state);\n * this.schedule(state + 1, 1000); // `this` references currently executing Action,\n * // which we reschedule with new state and delay\n * }\n *\n * asyncScheduler.schedule(task, 3000, 0);\n *\n * // Logs:\n * // 0 after 3s\n * // 1 after 4s\n * // 2 after 5s\n * // 3 after 6s\n * ```\n */\n\nexport const asyncScheduler = new AsyncScheduler(AsyncAction);\n\n/**\n * @deprecated Renamed to {@link asyncScheduler}. Will be removed in v8.\n */\nexport const async = asyncScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { Subscription } from '../Subscription';\nimport { QueueScheduler } from './QueueScheduler';\nimport { SchedulerAction } from '../types';\nimport { TimerHandle } from './timerHandle';\n\nexport class QueueAction extends AsyncAction {\n constructor(protected scheduler: QueueScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (delay > 0) {\n return super.schedule(state, delay);\n }\n this.delay = delay;\n this.state = state;\n this.scheduler.flush(this);\n return this;\n }\n\n public execute(state: T, delay: number): any {\n return delay > 0 || this.closed ? super.execute(state, delay) : this._execute(state, delay);\n }\n\n protected requestAsyncId(scheduler: QueueScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n\n if ((delay != null && delay > 0) || (delay == null && this.delay > 0)) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n\n // Otherwise flush the scheduler starting with this action.\n scheduler.flush(this);\n\n // HACK: In the past, this was returning `void`. However, `void` isn't a valid\n // `TimerHandle`, and generally the return value here isn't really used. So the\n // compromise is to return `0` which is both \"falsy\" and a valid `TimerHandle`,\n // as opposed to refactoring every other instanceo of `requestAsyncId`.\n return 0;\n }\n}\n", "import { AsyncScheduler } from './AsyncScheduler';\n\nexport class QueueScheduler extends AsyncScheduler {\n}\n", "import { QueueAction } from './QueueAction';\nimport { QueueScheduler } from './QueueScheduler';\n\n/**\n *\n * Queue Scheduler\n *\n * Put every next task on a queue, instead of executing it immediately\n *\n * `queue` scheduler, when used with delay, behaves the same as {@link asyncScheduler} scheduler.\n *\n * When used without delay, it schedules given task synchronously - executes it right when\n * it is scheduled. However when called recursively, that is when inside the scheduled task,\n * another task is scheduled with queue scheduler, instead of executing immediately as well,\n * that task will be put on a queue and wait for current one to finish.\n *\n * This means that when you execute task with `queue` scheduler, you are sure it will end\n * before any other task scheduled with that scheduler will start.\n *\n * ## Examples\n * Schedule recursively first, then do something\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(() => {\n * queueScheduler.schedule(() => console.log('second')); // will not happen now, but will be put on a queue\n *\n * console.log('first');\n * });\n *\n * // Logs:\n * // \"first\"\n * // \"second\"\n * ```\n *\n * Reschedule itself recursively\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(function(state) {\n * if (state !== 0) {\n * console.log('before', state);\n * this.schedule(state - 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * console.log('after', state);\n * }\n * }, 0, 3);\n *\n * // In scheduler that runs recursively, you would expect:\n * // \"before\", 3\n * // \"before\", 2\n * // \"before\", 1\n * // \"after\", 1\n * // \"after\", 2\n * // \"after\", 3\n *\n * // But with queue it logs:\n * // \"before\", 3\n * // \"after\", 3\n * // \"before\", 2\n * // \"after\", 2\n * // \"before\", 1\n * // \"after\", 1\n * ```\n */\n\nexport const queueScheduler = new QueueScheduler(QueueAction);\n\n/**\n * @deprecated Renamed to {@link queueScheduler}. Will be removed in v8.\n */\nexport const queue = queueScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\nimport { SchedulerAction } from '../types';\nimport { animationFrameProvider } from './animationFrameProvider';\nimport { TimerHandle } from './timerHandle';\n\nexport class AnimationFrameAction extends AsyncAction {\n constructor(protected scheduler: AnimationFrameScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n protected requestAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay is greater than 0, request as an async action.\n if (delay !== null && delay > 0) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n // Push the action to the end of the scheduler queue.\n scheduler.actions.push(this);\n // If an animation frame has already been requested, don't request another\n // one. If an animation frame hasn't been requested yet, request one. Return\n // the current animation frame request id.\n return scheduler._scheduled || (scheduler._scheduled = animationFrameProvider.requestAnimationFrame(() => scheduler.flush(undefined)));\n }\n\n protected recycleAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle | undefined {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n if (delay != null ? delay > 0 : this.delay > 0) {\n return super.recycleAsyncId(scheduler, id, delay);\n }\n // If the scheduler queue has no remaining actions with the same async id,\n // cancel the requested animation frame and set the scheduled flag to\n // undefined so the next AnimationFrameAction will request its own.\n const { actions } = scheduler;\n if (id != null && actions[actions.length - 1]?.id !== id) {\n animationFrameProvider.cancelAnimationFrame(id as number);\n scheduler._scheduled = undefined;\n }\n // Return undefined so the action knows to request a new async id if it's rescheduled.\n return undefined;\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\nexport class AnimationFrameScheduler extends AsyncScheduler {\n public flush(action?: AsyncAction): void {\n this._active = true;\n // The async id that effects a call to flush is stored in _scheduled.\n // Before executing an action, it's necessary to check the action's async\n // id to determine whether it's supposed to be executed in the current\n // flush.\n // Previous implementations of this method used a count to determine this,\n // but that was unsound, as actions that are unsubscribed - i.e. cancelled -\n // are removed from the actions array and that can shift actions that are\n // scheduled to be executed in a subsequent flush into positions at which\n // they are executed within the current flush.\n const flushId = this._scheduled;\n this._scheduled = undefined;\n\n const { actions } = this;\n let error: any;\n action = action || actions.shift()!;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions[0]) && action.id === flushId && actions.shift());\n\n this._active = false;\n\n if (error) {\n while ((action = actions[0]) && action.id === flushId && actions.shift()) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AnimationFrameAction } from './AnimationFrameAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\n\n/**\n *\n * Animation Frame Scheduler\n *\n * Perform task when `window.requestAnimationFrame` would fire\n *\n * When `animationFrame` scheduler is used with delay, it will fall back to {@link asyncScheduler} scheduler\n * behaviour.\n *\n * Without delay, `animationFrame` scheduler can be used to create smooth browser animations.\n * It makes sure scheduled task will happen just before next browser content repaint,\n * thus performing animations as efficiently as possible.\n *\n * ## Example\n * Schedule div height animation\n * ```ts\n * // html:
\n * import { animationFrameScheduler } from 'rxjs';\n *\n * const div = document.querySelector('div');\n *\n * animationFrameScheduler.schedule(function(height) {\n * div.style.height = height + \"px\";\n *\n * this.schedule(height + 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * }, 0, 0);\n *\n * // You will see a div element growing in height\n * ```\n */\n\nexport const animationFrameScheduler = new AnimationFrameScheduler(AnimationFrameAction);\n\n/**\n * @deprecated Renamed to {@link animationFrameScheduler}. Will be removed in v8.\n */\nexport const animationFrame = animationFrameScheduler;\n", "import { Observable } from '../Observable';\nimport { SchedulerLike } from '../types';\n\n/**\n * A simple Observable that emits no items to the Observer and immediately\n * emits a complete notification.\n *\n * Just emits 'complete', and nothing else.\n *\n * ![](empty.png)\n *\n * A simple Observable that only emits the complete notification. It can be used\n * for composing with other Observables, such as in a {@link mergeMap}.\n *\n * ## Examples\n *\n * Log complete notification\n *\n * ```ts\n * import { EMPTY } from 'rxjs';\n *\n * EMPTY.subscribe({\n * next: () => console.log('Next'),\n * complete: () => console.log('Complete!')\n * });\n *\n * // Outputs\n * // Complete!\n * ```\n *\n * Emit the number 7, then complete\n *\n * ```ts\n * import { EMPTY, startWith } from 'rxjs';\n *\n * const result = EMPTY.pipe(startWith(7));\n * result.subscribe(x => console.log(x));\n *\n * // Outputs\n * // 7\n * ```\n *\n * Map and flatten only odd numbers to the sequence `'a'`, `'b'`, `'c'`\n *\n * ```ts\n * import { interval, mergeMap, of, EMPTY } from 'rxjs';\n *\n * const interval$ = interval(1000);\n * const result = interval$.pipe(\n * mergeMap(x => x % 2 === 1 ? of('a', 'b', 'c') : EMPTY),\n * );\n * result.subscribe(x => console.log(x));\n *\n * // Results in the following to the console:\n * // x is equal to the count on the interval, e.g. (0, 1, 2, 3, ...)\n * // x will occur every 1000ms\n * // if x % 2 is equal to 1, print a, b, c (each on its own)\n * // if x % 2 is not equal to 1, nothing will be output\n * ```\n *\n * @see {@link Observable}\n * @see {@link NEVER}\n * @see {@link of}\n * @see {@link throwError}\n */\nexport const EMPTY = new Observable((subscriber) => subscriber.complete());\n\n/**\n * @param scheduler A {@link SchedulerLike} to use for scheduling\n * the emission of the complete notification.\n * @deprecated Replaced with the {@link EMPTY} constant or {@link scheduled} (e.g. `scheduled([], scheduler)`). Will be removed in v8.\n */\nexport function empty(scheduler?: SchedulerLike) {\n return scheduler ? emptyScheduled(scheduler) : EMPTY;\n}\n\nfunction emptyScheduled(scheduler: SchedulerLike) {\n return new Observable((subscriber) => scheduler.schedule(() => subscriber.complete()));\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport function isScheduler(value: any): value is SchedulerLike {\n return value && isFunction(value.schedule);\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\nimport { isScheduler } from './isScheduler';\n\nfunction last(arr: T[]): T | undefined {\n return arr[arr.length - 1];\n}\n\nexport function popResultSelector(args: any[]): ((...args: unknown[]) => unknown) | undefined {\n return isFunction(last(args)) ? args.pop() : undefined;\n}\n\nexport function popScheduler(args: any[]): SchedulerLike | undefined {\n return isScheduler(last(args)) ? args.pop() : undefined;\n}\n\nexport function popNumber(args: any[], defaultValue: number): number {\n return typeof last(args) === 'number' ? args.pop()! : defaultValue;\n}\n", "export const isArrayLike = ((x: any): x is ArrayLike => x && typeof x.length === 'number' && typeof x !== 'function');", "import { isFunction } from \"./isFunction\";\n\n/**\n * Tests to see if the object is \"thennable\".\n * @param value the object to test\n */\nexport function isPromise(value: any): value is PromiseLike {\n return isFunction(value?.then);\n}\n", "import { InteropObservable } from '../types';\nimport { observable as Symbol_observable } from '../symbol/observable';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being Observable (but not necessary an Rx Observable) */\nexport function isInteropObservable(input: any): input is InteropObservable {\n return isFunction(input[Symbol_observable]);\n}\n", "import { isFunction } from './isFunction';\n\nexport function isAsyncIterable(obj: any): obj is AsyncIterable {\n return Symbol.asyncIterator && isFunction(obj?.[Symbol.asyncIterator]);\n}\n", "/**\n * Creates the TypeError to throw if an invalid object is passed to `from` or `scheduled`.\n * @param input The object that was passed.\n */\nexport function createInvalidObservableTypeError(input: any) {\n // TODO: We should create error codes that can be looked up, so this can be less verbose.\n return new TypeError(\n `You provided ${\n input !== null && typeof input === 'object' ? 'an invalid object' : `'${input}'`\n } where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.`\n );\n}\n", "export function getSymbolIterator(): symbol {\n if (typeof Symbol !== 'function' || !Symbol.iterator) {\n return '@@iterator' as any;\n }\n\n return Symbol.iterator;\n}\n\nexport const iterator = getSymbolIterator();\n", "import { iterator as Symbol_iterator } from '../symbol/iterator';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being an Iterable */\nexport function isIterable(input: any): input is Iterable {\n return isFunction(input?.[Symbol_iterator]);\n}\n", "import { ReadableStreamLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport async function* readableStreamLikeToAsyncGenerator(readableStream: ReadableStreamLike): AsyncGenerator {\n const reader = readableStream.getReader();\n try {\n while (true) {\n const { value, done } = await reader.read();\n if (done) {\n return;\n }\n yield value!;\n }\n } finally {\n reader.releaseLock();\n }\n}\n\nexport function isReadableStreamLike(obj: any): obj is ReadableStreamLike {\n // We don't want to use instanceof checks because they would return\n // false for instances from another Realm, like an + +

What can companies do with Mojodex?

+
+
    +
  • +

    Recruitment Assistance

    +
    +

    Custom Interview Recaps: Teams of 8-10 members use Mojodex to standardize their interview processes, ensuring consistent and well-structured interview summaries.

    +
    • +
  • +

    Sales Process Enhancement

    +
    +

    On-the-Go Sales Support: Sales teams utilize Mojodex to streamline their workflow, capturing conversation details directly into their CRM while traveling between meetings.

    +
    • +
  • +

    Proprietary Consulting Assistants

    +
    +

    Secure Customer Data Handling: Consulting teams create tailored assistants with Mojodex to manage sensitive customer information on their own secure infrastructure.

    +
    • +
  • +

    Customer Relationship Management

    +
    +

    Guided Communication for Newcomers: Customer success teams employ digital assistants to mentor new members, leveraging internal data and established procedures from over 20 years of customer engagement in the sound factory industry.

    +
    • +
+
+
+

Beyond those examples: Make it your own

+

Mojodex is designed to be flexible and adaptable to a wide range of use cases. It can be tailored to fit the specific needs of any business, from small startups to large enterprises.

+
+

What's unique with Mojodex?

+

Not Just a Chatbot like ChatGPT

+

Mojodex goes beyond reactive chatbot functionality. It proactively guides users, responds proactively, and assists in various tasks, not just instant Q&A.

+

More Than a Retrieval Augmented Generation (RAG) Tool

+

Mojodex doesn't merely retrieve information from company data like RAG tools. It collaborates with users, performing tasks and enhancing work processes using the available data.

+

Mojodex is tasks-oriented

+

A task for Mojodex is any job activity requiring written content creation.

+

images/tasks/tasks.png

+

Why an Open-source Digital Assistant Platform for Enterprises?

+

Mojodex was created to foster the adoption of digital assistants in businesses. The reasons for its open-source release are:

+
    +
  • Enable Enterprises to Building their own AI Assets: To support companies in creating their refined prompts and data wheel pipeline of high quality interaction with experts.
    • +
  • On Premise & Tailor-made: Providing an open-source platform for complete control over the software and data, development, hosting, and evolution.
    • +
  • Boosting Internal Adoption: Business experts and tech team teamwork to tailor your company's digital assistants, tailored to their needs, fostering adoption.
    • +
+

A highly valuable side effect of implementing a digital assistant platform is Process Optimization. Configuring their own digital assistant implies to optimizing a company's internal processes, promoting long-term development.

+

Frequently Asked Questions (FAQs)

+

What makes the Mojodex open-source platform different from other GPT chat platforms or copilot platforms?

+

Beyond Chat : Unlike platforms that are solely chat-based, Mojodex is task-oriented, using conversation to achieve the goal of completing tasks and producing deliverables.

+

What are the benefits of using Mojodex over other platforms?

+
    +
  • +

    Never Locked: Being open-source, it allows for the creation of custom prompts and working on proprietary processes, rather than sending them to an uncontrolled platform.

    +
    • +
  • +

    Ease of Integration: The assistant's API-centric architecture facilitates seamless integration with existing tools.

    +
    • +
+

How about the data privacy and security?

+
    +
  • +

    You own your data: Complete control over data flows, especially towards large language models, enabling users to connect their proprietary LLM solutions and fully manage the data stream.

    +
    • +
  • +

    As secure as your infrastructure is: For sensitive data, hosting on personal infrastructure provides total control.

    +
    • +
+

What can I do with the data generated by Mojodex?

+

Users own their data, allowing the construction of interaction datasets at an enterprise scale, which are invaluable for retraining on specific use cases.

+

Can I use open-source LLMs with Mojodex?

+

Yes, Mojodex is designed to be compatible with open-source LLMs, allowing best of both worlds with the use of proprietary models through APIS and hosted open-source models. This may require some development work.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/motivations/index.html b/motivations/index.html new file mode 100644 index 00000000..be26a315 --- /dev/null +++ b/motivations/index.html @@ -0,0 +1,1912 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Why Mojodex? - Mojodex - Open Source Enterprise Digital Assistant Platform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + +

Why Mojodex?

+
+

🌟 Mojodex, is an Open-source Digital Assistant for Enterprise.

+
+

🔍 What's Unique

+
    +
  1. +

    Mojodex is highly customizable, allowing enterprises to create text-based tasks that are directly aligned with their business workflows. Go beyond chat-based interfaces; get the work done.

    +
    2. +
  2. +

    This user-friendly multi-interfaces platform is not just another tool; it's fully customizable for your daily operations. All-in-one, a webapp, a mobile app and a browser extension.

    +
    3. +
  3. +

    You own it. Mojodex is open-source, meaning you can modify it to fit your needs and keep your data secure. Don't delegate your internal process to a third-party SaaS platform;

    +
    4. +
+

🕒 Why now?

+

Companies are looking to invest in their own AI assets – prompts, workflows, process – by crafting specialized tasks for their digital assistants.

+
+

💡 Integrating Mojodex is equivalent to creating the AI assets of the company.

+
+

Mojodex stands out by turning each interaction into a valuable asset, fueling the data flywheel at the heart of your company's AI-powered processes.

+
+

💡 Using Mojodex means creating the data you need to train your future AI tools

+
+

🚀 Open-source

+

What sets Mojodex apart is its full integration of AI-native open-source code and open-weights models.

+
+

This synergy creates a first-of-its-kind, future-proof platform for building your company's digital assets.

+
+

🌐 Mojodex in your Business Ecosystem

+

🚀 It's time to elevate your business with an AI assistant that's built for the task at hand and the challenges ahead. Let's embark on this journey together, shaping a future where AI is not only powerful but also a trusted ally in the enterprise software landscape.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/openAPI/backend_api.yaml b/openAPI/backend_api.yaml new file mode 100644 index 00000000..8ccc721f --- /dev/null +++ b/openAPI/backend_api.yaml @@ -0,0 +1,6733 @@ +openapi: 3.0.0 +info: + title: Mojodex API Backend + version: 1.0.0 +tags: + - name: Application + description: Routes called from the application + - name: Background + description: Routes called from the background + - name: Scheduler + description: Routes called from the scheduler + - name: Backoffice + description: Routes called from the backoffice + - name: Purchase updater + description: Routes called from the purchase updater + - name: External service + description: Routes called from an external service + +paths: + /calendar_suggestion: + put: + tags: + - Application + summary: Put a new calendar suggestion in backend and return waiting message + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - user_planning + properties: + datetime: + type: string + format: date-time + user_planning: + type: array + items: + type: object + version: + type: string + use_placeholder: + type: boolean + responses: + '200': + description: Calendar suggestion and waiting message returned successfully + content: + application/json: + schema: + type: object + properties: + calendar_suggestion_pk: + type: integer + waiting_message: + type: string + ready_message: + type: string + '400': + description: Error in getting calendar suggestion + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + get: + tags: + - Application + summary: Get a calendar suggestion from backend + parameters: + - in: query + name: datetime + required: true + schema: + type: string + format: date-time + - in: query + name: calendar_suggestion_pk + required: true + schema: + type: integer + - name: version + in: query + required: true + schema: + type: string + - name: Authorization + in: header + required: true + schema: + type: string + responses: + '200': + description: Calendar suggestion text returned successfully + content: + application/json: + schema: + type: object + properties: + calendar_suggestion_pk: + type: integer + suggestion_text: + type: string + message_title: + type: string + message_emoji: + type: string + task_pk: + type: integer + '404': + description: Calendar suggestion not found for this user + content: + application/json: + schema: + type: object + properties: + error: + type: string + '400': + description: Error in getting calendar suggestion text + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Application + summary: Answer calendar suggestion + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - calendar_suggestion_pk + properties: + datetime: + type: string + format: date-time + calendar_suggestion_pk: + type: integer + user_reacted: + type: boolean + user_task_execution_pk: + type: integer + responses: + '200': + description: Answer to calendar suggestion treated successfully + content: + application/json: + schema: + type: object + properties: + success: + type: string + '404': + description: Calendar suggestion not found for this user + content: + application/json: + schema: + type: object + properties: + error: + type: string + '400': + description: Error in treating answer to calendar suggestion + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /company: + put: + tags: + - Application + summary: Create or update a company based on the provided website URL + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - website_url + properties: + datetime: + type: string + format: date-time + website_url: + type: string + format: uri + responses: + '200': + description: Company created or updated successfully + content: + application/json: + schema: + type: object + properties: + company_pk: + type: integer + company_emoji: + type: string + company_name: + type: string + company_description: + type: string + '400': + description: Invalid URL provided + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Application + summary: Update company information based on user feedback + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + properties: + datetime: + type: string + format: date-time + feedback: + type: string + correct: + type: boolean + responses: + '200': + description: Company information updated successfully + content: + application/json: + schema: + type: object + properties: + company_pk: + type: integer + company_emoji: + type: string + company_name: + type: string + company_description: + type: string + '400': + description: Error in updating company information + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /device: + put: + tags: + - Application + summary: Create a new device for a user + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - fcm_token + properties: + datetime: + type: string + format: date-time + fcm_token: + type: string + responses: + '200': + description: Device created successfully + content: + application/json: + schema: + type: object + properties: + device_pk: + type: integer + '400': + description: Error in device creation + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /error: + put: + tags: + - Application + summary: Log an error event for a given user + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - error + properties: + datetime: + type: string + format: date-time + description: The timestamp when the error occurred + error: + type: string + description: A description of the error + notify_admin: + type: boolean + default: false + description: Whether to notify the admin about the error + session_id: + type: string + description: Optional session ID associated with the error event + responses: + '200': + description: Error event logged successfully + content: + application/json: + schema: + type: object + properties: + success: + type: string + description: A success message indicating the error was logged + '400': + description: Bad request, such as missing JSON body or required fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + description: An error message indicating the reason for the bad request + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /event: + put: + tags: + - Background + summary: Add a new event for a user + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - user_id + - message + - event_type + properties: + datetime: + type: string + format: date-time + user_id: + type: string + message: + type: object + properties: + title: + type: string + body: + type: string + subject: + type: string + email: + type: string + event_type: + type: string + data: + type: object + additionalProperties: true + responses: + '200': + description: Event created successfully + content: + application/json: + schema: + type: object + properties: + event_pk: + type: integer + '400': + description: Invalid request or missing fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Error occurred while creating the event + content: + application/json: + schema: + type: object + properties: + error: + type: string + /check_disengaged_free_trial_users: + post: + tags: + - Scheduler + summary: Check engagement of users with active free and limited products + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + properties: + datetime: + type: string + format: date-time + n_disengaged_users: + type: integer + default: 50 + offset: + type: integer + default: 0 + responses: + '200': + description: List of disengaged user IDs retrieved successfully + content: + application/json: + schema: + type: object + properties: + user_ids: + type: array + items: + type: string + '400': + description: Bad request, missing or invalid parameters + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, missing or wrong secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error occurred while processing the request + content: + application/json: + schema: + type: object + properties: + error: + type: string + /onboarding: + put: + tags: + - Application + summary: Set the onboarding presented date for a user + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + properties: + datetime: + type: string + format: date-time + responses: + '200': + description: Onboarding presented date set successfully + content: + application/json: + schema: + type: object + properties: + user_id: + type: string + '400': + description: Error setting onboarding presented date + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + get: + tags: + - Application + summary: Get the onboarding presented status for a user + parameters: + - name: datetime + in: query + required: true + description: The current date and time + schema: + type: string + format: date-time + - in: header + name: Authorization + required: true + schema: + type: string + responses: + '200': + description: Onboarding presented status retrieved successfully + content: + application/json: + schema: + type: object + properties: + onboarding_presented: + type: boolean + '400': + description: Error asking for onboarding presented status + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /produced_text: + get: + tags: + - Application + summary: Retrieve produced texts for a user + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + - name: datetime + in: query + required: true + description: Timestamp of the request + schema: + type: string + format: date-time + - name: produced_text_pk + in: query + required: false + description: Primary key of the produced text to retrieve + schema: + type: integer + - name: n_produced_texts + in: query + required: false + description: Number of produced texts to retrieve + schema: + type: integer + - name: offset + in: query + required: false + description: Offset for pagination + schema: + type: integer + responses: + '200': + description: Successfully retrieved produced texts + content: + application/json: + schema: + type: object + properties: + produced_texts: + type: array + items: + $ref: '#/components/schemas/ProducedText' + '400': + description: Bad request due to missing or invalid parameters + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Error occurred while retrieving produced texts + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Application + summary: Save a new produced text or update an existing one + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - production + properties: + datetime: + type: string + format: date-time + user_task_execution_pk: + type: integer + session_id: + type: string + produced_text_pk: + type: integer + production: + type: string + title: + type: string + responses: + '200': + description: Successfully saved produced text + content: + application/json: + schema: + type: object + properties: + produced_text_pk: + type: integer + produced_text_version_pk: + type: integer + '400': + description: Bad request due to missing or invalid parameters + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Error occurred while saving produced text + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + delete: + tags: + - Application + summary: Delete a produced text + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + - name: datetime + in: query + required: true + description: Timestamp of the request + schema: + type: string + format: date-time + - name: produced_text_pk + in: query + required: true + description: Primary key of the produced text to delete + schema: + type: integer + responses: + '200': + description: Successfully deleted produced text + content: + application/json: + schema: + type: object + properties: + produced_text_pk: + type: integer + '400': + description: Bad request due to missing or invalid parameters + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Error occurred while deleting produced text + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /product_category: + put: + tags: + - Backoffice + summary: Create a new product category + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - label + - displayed_data + - emoji + - implicit_goal + - visible + properties: + datetime: + type: string + format: date-time + label: + type: string + displayed_data: + type: array + items: + type: object + required: + - language_code + - name_for_user + - description_for_user + properties: + language_code: + type: string + name_for_user: + type: string + description_for_user: + type: string + emoji: + type: string + implicit_goal: + type: string + visible: + type: boolean + responses: + '200': + description: Product category created successfully + content: + application/json: + schema: + type: object + properties: + product_category_pk: + type: integer + '400': + description: Bad request with missing fields or invalid data + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while creating product category + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Backoffice + summary: Update an existing product category + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - product_category_pk + properties: + datetime: + type: string + format: date-time + product_category_pk: + type: integer + visible: + type: boolean + label: + type: string + emoji: + type: string + displayed_data: + type: array + items: + type: object + properties: + language_code: + type: string + name_for_user: + type: string + description_for_user: + type: string + responses: + '200': + description: Product category updated successfully + content: + application/json: + schema: + type: object + properties: + product_category_pk: + type: integer + '400': + description: Bad request with missing fields or invalid data + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while updating product category + content: + application/json: + schema: + type: object + properties: + error: + type: string + get: + tags: + - Application + summary: Get all visible product categories for a user + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + - in: query + name: datetime + required: true + schema: + type: string + format: date-time + responses: + '200': + description: List of visible product categories + content: + application/json: + schema: + type: object + properties: + product_categories: + type: array + items: + type: object + properties: + product_category_pk: + type: integer + emoji: + type: string + name: + type: string + description: + type: string + '400': + description: Bad request with missing fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while getting product categories + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /profile_category: + put: + tags: + - Backoffice + summary: Create a new profile category + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - label + - displayed_data + - emoji + - implicit_goal + - visible + properties: + datetime: + type: string + format: date-time + label: + type: string + displayed_data: + type: array + items: + type: object + required: + - language_code + - name_for_user + - description_for_user + properties: + language_code: + type: string + name_for_user: + type: string + description_for_user: + type: string + emoji: + type: string + implicit_goal: + type: string + visible: + type: boolean + responses: + '200': + description: Profile category created successfully + content: + application/json: + schema: + type: object + properties: + profile_category_pk: + type: integer + '400': + description: Bad request, missing or invalid fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while creating profile category + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Backoffice + summary: Update an existing profile category + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - profile_category_pk + properties: + datetime: + type: string + format: date-time + profile_category_pk: + type: integer + label: + type: string + displayed_data: + type: array + items: + type: object + properties: + language_code: + type: string + name_for_user: + type: string + description_for_user: + type: string + emoji: + type: string + implicit_goal: + type: string + visible: + type: boolean + responses: + '200': + description: Profile category updated successfully + content: + application/json: + schema: + type: object + properties: + profile_category_pk: + type: integer + '400': + description: Bad request, missing or invalid fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while updating profile category + content: + application/json: + schema: + type: object + properties: + error: + type: string + /product_task_association: + put: + tags: + - Backoffice + summary: Create a new product_task_association + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - product_pk + - task_pk + properties: + datetime: + type: string + format: date-time + product_pk: + type: integer + task_pk: + type: integer + responses: + '200': + description: Product task association created successfully + content: + application/json: + schema: + type: object + properties: + product_task_association_pk: + type: integer + '400': + description: Bad request with missing fields or association already exists + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while creating product_task_association + content: + application/json: + schema: + type: object + properties: + error: + type: string + /profile_task_association: + put: + tags: + - Backoffice + summary: Associate a profile with a task + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - profile_pk + - task_pk + properties: + datetime: + type: string + format: date-time + profile_pk: + type: integer + task_pk: + type: integer + responses: + '200': + description: Profile task association created successfully + content: + application/json: + schema: + type: object + properties: + profile_task_association_pk: + type: integer + '400': + description: Error due to missing field or invalid request format + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + /subscription_end: + post: + tags: + - External service + summary: Stripe webhook endpoint for handling the end of a subscription + requestBody: + required: true + content: + application/json: + schema: + type: object + # properties: + # The properties are not explicitly defined in the provided code, + # but we can assume that the request will be a JSON payload sent by Stripe. + responses: + '200': + description: Purchase ended successfully + content: + application/json: + schema: + type: object + properties: + purchase_pk: + type: integer + '400': + description: Request must be JSON or purchase with subscription_stripe_id does not exist in mojodex db + content: + application/json: + schema: + type: object + properties: + error: + type: string + '409': + description: Error in stripe webhook ending purchase + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Unhandled event type + content: + application/json: + schema: + type: object + properties: + error: + type: string + /task: + put: + tags: + - Backoffice + summary: Create a new task + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - task_type + - platforms + - name_for_system + - definition_for_system + - icon + - task_displayed_data + - output_type + properties: + datetime: + type: string + format: date-time + task_type: + type: string + enum: + - instruct + - workflow + platforms: + type: array + items: + type: string + name_for_system: + type: string + definition_for_system: + type: string + final_instruction: + type: string + output_format_instruction_title: + type: string + output_format_instruction_draft: + type: string + infos_to_extract: + type: array + items: + type: object + icon: + type: string + task_displayed_data: + type: array + items: + type: object + predefined_actions: + type: array + items: + type: object + output_type: + type: string + responses: + '200': + description: Task created successfully + content: + application/json: + schema: + type: object + properties: + task_pk: + type: integer + '400': + description: Bad request with missing or invalid fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while creating task + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Backoffice + summary: Edit any field of a task + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - task_pk + properties: + datetime: + type: string + format: date-time + task_pk: + type: integer + platforms: + type: array + items: + type: string + task_displayed_data: + type: array + items: + type: object + predefined_actions: + type: array + items: + type: object + name_for_system: + type: string + definition_for_system: + type: string + final_instruction: + type: string + output_format_instruction_title: + type: string + output_format_instruction_draft: + type: string + infos_to_extract: + type: array + items: + type: object + icon: + type: string + output_type: + type: string + responses: + '200': + description: Task edited successfully + content: + application/json: + schema: + type: object + properties: + task_pk: + type: integer + '400': + description: Bad request with missing or invalid fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Task not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while editing task + content: + application/json: + schema: + type: object + properties: + error: + type: string + get: + tags: + - Backoffice + summary: Get JSON of a task + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + - in: query + name: datetime + required: true + schema: + type: string + format: date-time + - in: query + name: task_pk + required: true + schema: + type: integer + responses: + '200': + description: Task JSON retrieved successfully + content: + application/json: + schema: + type: object + properties: + type: + type: string + platforms: + type: array + items: + type: string + predefined_actions: + type: array + items: + type: object + task_displayed_data: + type: array + items: + type: object + name_for_system: + type: string + definition_for_system: + type: string + final_instruction: + type: string + output_format_instruction_title: + type: string + output_format_instruction_draft: + type: string + output_type: + type: string + icon: + type: string + infos_to_extract: + type: array + items: + type: object + '400': + description: Bad request with missing fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Task not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while getting task JSON + content: + application/json: + schema: + type: object + properties: + error: + type: string + /task_json: + post: + tags: + - Backoffice + summary: Generate json configuration file of a task from requirements description + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - task_requirements + properties: + datetime: + type: string + format: date-time + task_requirements: + type: string + responses: + '200': + description: Task JSON created successfully + content: + application/json: + schema: + type: object + properties: + datetime: + type: string + format: date-time + platforms: + type: array + items: + type: string + predefined_actions: + type: array + items: + type: object + task_displayed_data: + type: array + items: + type: object + name_for_system: + type: string + definition_for_system: + type: string + final_instruction: + type: string + output_format_instruction_title: + type: string + output_format_instruction_draft: + type: string + output_type: + type: string + icon: + type: string + infos_to_extract: + type: array + items: + type: object + '400': + description: Bad request, missing fields or not a JSON request + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error when creating new task + content: + application/json: + schema: + type: object + properties: + error: + type: string + /text_type: + put: + tags: + - Backoffice + summary: Create a new text type + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - timestamp + - text_type_name + properties: + timestamp: + type: string + format: date-time + text_type_name: + type: string + responses: + '200': + description: Text type created successfully + content: + application/json: + schema: + type: object + properties: + text_type_pk: + type: integer + '400': + description: Error in creating text type or missing field + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + get: + tags: + - Backoffice + summary: Get a list of existing text types + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + - in: query + name: datetime + required: true + schema: + type: string + format: date-time + - in: query + name: n_text_types + schema: + type: integer + default: 50 + - in: query + name: offset + schema: + type: integer + default: 0 + responses: + '200': + description: List of text types retrieved successfully + content: + application/json: + schema: + type: object + properties: + text_types: + type: array + items: + type: object + properties: + text_type_pk: + type: integer + name: + type: string + '400': + description: Error in retrieving text types or missing field + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + /todo_daily_emails: + post: + tags: + - Scheduler + summary: Send daily emails with todos + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + properties: + datetime: + type: string + format: date-time + n_emails: + type: integer + offset: + type: integer + responses: + '200': + description: Daily emails sent successfully + content: + application/json: + schema: + type: object + properties: + user_ids: + type: array + items: + type: string + '400': + description: Bad request, missing or invalid parameters + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /todos: + put: + tags: + - Background + summary: Add a new todo + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - description + - due_date + - user_task_execution_fk + properties: + datetime: + type: string + format: date-time + description: + type: string + due_date: + type: string + format: date + user_task_execution_fk: + type: integer + responses: + '200': + description: Todo created successfully + content: + application/json: + schema: + type: object + properties: + todo_pk: + type: integer + '400': + description: Bad request + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Forbidden - Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Application + summary: Mark a todo as read or done + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + properties: + datetime: + type: string + format: date-time + mark_as_read: + type: boolean + mark_as_done: + type: boolean + todo_pk: + type: integer + user_task_execution_fk: + type: integer + responses: + '200': + description: Todo marked as read or done successfully + content: + application/json: + schema: + type: object + properties: + todo_pk: + type: integer + user_task_execution_pk: + type: integer + '400': + description: Bad request + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Todo not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + delete: + tags: + - Application + summary: Delete a todo + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + - in: query + name: datetime + required: true + schema: + type: string + format: date-time + description: The current date and time + - in: query + name: todo_pk + required: true + schema: + type: integer + description: The primary key of the todo to delete + responses: + '200': + description: Todo deleted successfully + content: + application/json: + schema: + type: object + properties: + todo_pk: + type: integer + '400': + description: Bad request + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Todo not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + get: + tags: + - Application + summary: Get todos for a user + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + - in: query + name: datetime + required: true + schema: + type: string + format: date-time + description: The current date and time + - in: query + name: n_todos + schema: + type: integer + description: The number of todos to return + - in: query + name: offset + schema: + type: integer + description: The offset for pagination + - in: query + name: user_task_execution_fk + schema: + type: integer + description: The foreign key of the user task execution + responses: + '200': + description: Todos retrieved successfully + content: + application/json: + schema: + type: object + properties: + todos: + type: array + items: + type: object + properties: + todo_pk: + type: integer + user_task_execution_fk: + type: integer + description: + type: string + scheduled_date: + type: string + format: date-time + completed: + type: string + format: date-time + creation_date: + type: string + format: date-time + read_by_user: + type: string + format: date-time + user_has_never_done_todo: + type: boolean + n_todos_not_read: + type: integer + '400': + description: Bad request + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /user: + post: + tags: + - Application + summary: Log in an existing user or register a new user with third-party tokens + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - email + - login_method + properties: + datetime: + type: string + format: date-time + email: + type: string + format: email + login_method: + type: string + enum: + - email_password + - microsoft + - google + - apple + version: + type: string + password: + type: string + microsoft_token: + type: string + google_token: + type: string + apple_token: + type: string + responses: + '200': + description: User logged in or registered successfully + content: + application/json: + schema: + type: object + properties: + token: + type: string + language_code: + type: string + name: + type: string + perception_token: + type: string + perception_usernamespace: + type: string + terms_and_conditions_agreed: + type: boolean + company_fk: + type: integer + emotion_engine_uri: + type: string + emotion_engine_uuid: + type: string + emotion_engine_token: + type: string + '400': + description: Error in user login or registration + content: + application/json: + schema: + type: object + properties: + error: + type: string + put: + tags: + - Application + summary: Register a new user with email and password + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - email + - name + - password + properties: + datetime: + type: string + format: date-time + email: + type: string + format: email + name: + type: string + password: + type: string + version: + type: string + responses: + '200': + description: User registered successfully + content: + application/json: + schema: + type: object + properties: + token: + type: string + language_code: + type: string + name: + type: string + perception_token: + type: string + perception_usernamespace: + type: string + terms_and_conditions_agreed: + type: boolean + company_fk: + type: integer + emotion_engine_uri: + type: string + emotion_engine_uuid: + type: string + emotion_engine_token: + type: string + '400': + description: Error in user registration + content: + application/json: + schema: + type: object + properties: + error: + type: string + /user_summary: + post: + tags: + - Background + summary: Update user summary + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - summary + - session_id + properties: + datetime: + type: string + format: date-time + summary: + type: string + session_id: + type: string + responses: + '200': + description: User summary updated successfully + content: + application/json: + schema: + type: object + properties: + success: + type: boolean + '400': + description: Bad request, missing or invalid fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + /calendar_suggestion_notifications: + post: + tags: + - Scheduler + summary: Send calendar suggestion notifications + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - since_date + - until_date + properties: + datetime: + type: string + format: date-time + since_date: + type: string + format: date-time + until_date: + type: string + format: date-time + n_notifications: + type: integer + offset: + type: integer + responses: + '200': + description: Calendar suggestion notifications sent successfully + content: + application/json: + schema: + type: object + properties: + calendar_suggestion_pks: + type: array + items: + type: integer + '400': + description: Bad request, missing or invalid parameters + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '409': + description: Conflict or error while processing the request + content: + application/json: + schema: + type: object + properties: + error: + type: string + /check_expired_purchases: + post: + tags: + - Scheduler + summary: Check for expired purchases and deactivate them + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + properties: + datetime: + type: string + format: date-time + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + - in: query + name: n_purchases + required: false + schema: + type: integer + default: 50 + minimum: 1 + responses: + '200': + description: Expired purchases checked and deactivated successfully + content: + application/json: + schema: + type: object + properties: + purchase_pks: + type: array + items: + type: integer + '400': + description: Invalid request or missing datetime in body + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to missing or wrong secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + /send_daily_emails: + post: + tags: + - Scheduler + summary: Send daily emails to users + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + properties: + datetime: + type: string + format: date-time + n_emails: + type: integer + default: 50 + offset: + type: integer + default: 0 + responses: + '200': + description: Daily emails sent successfully + content: + application/json: + schema: + type: object + properties: + user_ids: + type: array + items: + type: string + '400': + description: Bad request, missing or invalid parameters + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error occurred while sending daily emails + content: + application/json: + schema: + type: object + properties: + error: + type: string + /send_daily_notifications: + post: + tags: + - Scheduler + summary: Send daily notifications to users + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + properties: + datetime: + type: string + format: date-time + n_notifications: + type: integer + default: 50 + offset: + type: integer + default: 0 + responses: + '200': + description: Daily notifications sent successfully + content: + application/json: + schema: + type: object + properties: + user_ids: + type: array + items: + type: string + '400': + description: Bad request, missing or invalid parameters + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while sending notifications + content: + application/json: + schema: + type: object + properties: + error: + type: string + /document: + put: + tags: + - Background + summary: Create a new document + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - name + - document_type + - user_id + properties: + datetime: + type: string + format: date-time + name: + type: string + document_type: + type: string + user_id: + type: string + responses: + '200': + description: Document created successfully + content: + application/json: + schema: + type: object + properties: + document_pk: + type: integer + '400': + description: Bad request, missing or invalid input + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Forbidden, authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Background + summary: Update an existing document + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - document_pk + - update_date + properties: + datetime: + type: string + format: date-time + document_pk: + type: integer + update_date: + type: string + format: date-time + responses: + '200': + description: Document updated successfully + content: + application/json: + schema: + type: object + properties: + document_pk: + type: integer + '400': + description: Bad request, missing or invalid input + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Forbidden, authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Document not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /document_chunk: + put: + tags: + - Background + summary: Create a new document chunk + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - document_fk + - chunk_index + - chunk_text + - embedding + properties: + datetime: + type: string + format: date-time + document_fk: + type: integer + chunk_index: + type: integer + chunk_text: + type: string + embedding: + type: array + items: + type: number + responses: + '200': + description: Document chunk created successfully + content: + application/json: + schema: + type: object + properties: + document_chunk_pk: + type: integer + '400': + description: Bad request with missing keys or non-JSON format + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Background + summary: Update an existing document chunk + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - chunk_pk + - chunk_text + - embedding + properties: + datetime: + type: string + format: date-time + chunk_pk: + type: integer + chunk_text: + type: string + embedding: + type: array + items: + type: number + responses: + '200': + description: Document chunk updated successfully + content: + application/json: + schema: + type: object + properties: + document_chunk_pk: + type: integer + '400': + description: Bad request with missing keys or non-JSON format + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Document chunk not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + delete: + tags: + - Background + summary: Delete a document chunk + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + - in: query + name: datetime + required: true + schema: + type: string + format: date-time + - in: query + name: chunk_pk + required: true + schema: + type: integer + responses: + '200': + description: Document chunk deleted successfully + content: + application/json: + schema: + type: object + properties: + document_chunk_pk: + type: integer + '400': + description: Bad request with missing keys + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Document chunk not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + get: + tags: + - Background + summary: Retrieve document chunks based on a query + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + - in: query + name: datetime + required: true + schema: + type: string + format: date-time + - in: query + name: query + required: true + schema: + type: string + - in: query + name: user_task_execution_pk + required: true + schema: + type: integer + - in: query + name: task_name_for_system + required: true + schema: + type: string + - in: query + name: top_k + required: true + schema: + type: integer + responses: + '200': + description: Document chunks retrieved successfully + content: + application/json: + schema: + type: object + properties: + document_chunks: + type: array + items: + type: object + #properties: + # Define the properties of a document chunk object + '400': + description: Bad request with missing keys + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /extract_todos: + post: + tags: + - Scheduler + summary: Extract todos from user task executions + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + properties: + datetime: + type: string + format: date-time + responses: + '200': + description: Todos extracted successfully + content: + application/json: + schema: + type: object + properties: + user_task_execution_pks: + type: array + items: + type: integer + '400': + description: Bad request, JSON required or missing datetime + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error during todo extraction + content: + application/json: + schema: + type: object + properties: + error: + type: string + put: + tags: + - Background + summary: Mark todo as extracted + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - user_task_execution_fk + properties: + datetime: + type: string + format: date-time + user_task_execution_fk: + type: integer + responses: + '200': + description: Todo marked as extracted successfully + content: + application/json: + schema: + type: object + properties: + user_task_execution_pk: + type: integer + '400': + description: Bad request, JSON required or missing key in body + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: User task execution not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error during marking todo as extracted + content: + application/json: + schema: + type: object + properties: + error: + type: string + /goal: + put: + tags: + - Application + summary: Update the goal for a user + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - goal + properties: + datetime: + type: string + format: date-time + goal: + type: string + responses: + '200': + description: Goal updated successfully + content: + application/json: + schema: + type: object + properties: + success: + type: string + '400': + description: Error in updating goal + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /home_chat: + get: + tags: + - Application + summary: Get initial chat message for a user + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + responses: + '200': + description: Initial chat message retrieved successfully + content: + application/json: + schema: + type: object + properties: + home_chat_pk: + type: integer + session_id: + type: string + message_pk: + type: integer + message: + type: object + properties: + text: + type: string + type: + type: string + sender: + type: string + '400': + description: Missing field in request + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Server error occurred + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Application + summary: Create next home chat for a user + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + properties: + datetime: + type: string + format: date-time + responses: + '200': + description: Home chat created successfully + '400': + description: Missing field in request + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Server error occurred + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + put: + tags: + - Scheduler + summary: Prepare next week's first home chat + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - n_users + - offset + properties: + datetime: + type: string + format: date-time + n_users: + type: integer + offset: + type: integer + responses: + '200': + description: Next week's first home chat prepared successfully + content: + application/json: + schema: + type: object + properties: + user_ids: + type: array + items: + type: string + '400': + description: Missing field in request or request must be JSON + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Server error occurred + content: + application/json: + schema: + type: object + properties: + error: + type: string + /in_app_apple_purchase: + post: + tags: + - External service + summary: Handle Apple in-app purchase notifications + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - signedPayload + properties: + signedPayload: + type: string + responses: + '200': + description: Notification processed successfully + '400': + description: Error processing notification + content: + application/json: + schema: + type: object + properties: + error: + type: string + put: + tags: + - Application + summary: Associate user_id to purchase and verify transaction + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - transaction_id + properties: + datetime: + type: string + format: date-time + transaction_id: + type: string + responses: + '200': + description: User associated with purchase successfully + '400': + description: Error associating user with purchase + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + /language: + post: + tags: + - Application + summary: Set the language of the user + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - language_code + properties: + datetime: + type: string + format: date-time + language_code: + type: string + responses: + '200': + description: Language updated successfully + content: + application/json: + schema: + type: object + properties: + success: + type: string + '400': + description: Error updating language + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + get: + tags: + - Application + summary: Get the system language of the user + parameters: + - in: query + name: datetime + required: true + schema: + type: string + format: date-time + - in: query + name: language_code + required: true + schema: + type: string + responses: + '200': + description: System language retrieved successfully + content: + application/json: + schema: + type: object + properties: + available_languages: + type: array + items: + type: string + language_json_file: + type: object + '400': + description: Error getting language + content: + application/json: + schema: + type: object + properties: + error: + type: string + /manual_purchase: + put: + tags: + - Backoffice + summary: Create manually a new purchase for a user + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - product_pk + properties: + datetime: + type: string + format: date-time + user_id: + type: string + user_email: + type: string + product_pk: + type: integer + custom_purchase_id: + type: string + responses: + '200': + description: Purchase created successfully + content: + application/json: + schema: + type: object + properties: + purchase_pk: + type: integer + '400': + description: Bad request, missing fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while creating purchase + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Backoffice + summary: Deactivate manually a purchase for a user + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - purchase_pk + properties: + datetime: + type: string + format: date-time + purchase_pk: + type: integer + responses: + '200': + description: Purchase deactivated successfully + content: + application/json: + schema: + type: object + '400': + description: Bad request, missing fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while deactivating purchase + content: + application/json: + schema: + type: object + properties: + error: + type: string + /role: + put: + tags: + - Backoffice + summary: Create a new role for a user + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - profile_pk + properties: + datetime: + type: string + format: date-time + profile_pk: + type: string + user_id: + type: string + user_email: + type: string + responses: + '200': + description: Role created successfully + content: + application/json: + schema: + type: object + properties: + role_pk: + type: string + '400': + description: Bad request, missing or invalid fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while creating role + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Backoffice + summary: Deactivate an existing role + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - role_pk + properties: + datetime: + type: string + format: date-time + role_pk: + type: string + responses: + '200': + description: Role deactivated successfully + '400': + description: Bad request, missing or invalid fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while deactivating role + content: + application/json: + schema: + type: object + properties: + error: + type: string + /message: + get: + tags: + - Application + summary: Retrieve messages for a user session + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + - name: datetime + in: query + required: true + description: Timestamp for the message retrieval + schema: + type: string + format: date-time + - name: session_id + in: query + required: true + description: The ID of the session to retrieve messages from + schema: + type: string + - name: offset_direction + in: query + required: false + description: The direction for message offset, older or newer + schema: + type: string + enum: + - older + - newer + - name: n_messages + in: query + required: false + description: The number of messages to retrieve + schema: + type: integer + - name: offset + in: query + required: false + description: The offset for message retrieval + schema: + type: integer + - in: query + name: user_task_execution_pk + schema: + type: string + description: The primary key of the user task execution + responses: + '200': + description: Messages retrieved successfully + content: + application/json: + schema: + type: object + properties: + messages: + type: array + items: + type: object + properties: + message_pk: + type: string + sender: + type: string + message: + type: object + additionalProperties: true + audio: + type: boolean + in_error_state: + type: boolean + '400': + description: Bad request, missing required fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Session not found for this user + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /mojo_message: + put: + tags: + - Background + summary: Add a new mojo message + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - message + - session_id + properties: + datetime: + type: string + format: date-time + message: + type: string + session_id: + type: string + responses: + '200': + description: Mojo message added successfully + content: + application/json: + schema: + type: object + properties: + message_pk: + type: integer + '400': + description: Invalid request or missing fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Session not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /password: + put: + tags: + - Application + summary: Send a link to reset the password + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - email + properties: + datetime: + type: string + format: date-time + email: + type: string + format: email + responses: + '200': + description: Email sent successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + '400': + description: Error due to invalid request format + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Email not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + '409': + description: Error sending reset password email + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Application + summary: Reset the password using the token + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - Authorization + - datetime + - new_password + properties: + Authorization: + type: string + datetime: + type: string + format: date-time + new_password: + type: string + responses: + '200': + description: Password updated successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + '400': + description: Error due to invalid request format + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Error due to invalid or expired token + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: User not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + '409': + description: Error resetting password + content: + application/json: + schema: + type: object + properties: + error: + type: string + /product: + put: + tags: + - Backoffice + summary: Create a new product + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - product_label + - displayed_data + - product_category_pk + - product_stripe_id + - product_apple_id + - is_free + - n_days_validity + - n_tasks_limit + properties: + datetime: + type: string + format: date-time + product_label: + type: string + displayed_data: + type: array + items: + type: object + required: + - language_code + - name + properties: + language_code: + type: string + name: + type: string + product_category_pk: + type: integer + product_stripe_id: + type: string + product_apple_id: + type: string + is_free: + type: boolean + n_days_validity: + type: integer + n_tasks_limit: + type: integer + responses: + '200': + description: Product created successfully + content: + application/json: + schema: + type: object + properties: + product_pk: + type: integer + '400': + description: Bad request with missing fields or invalid data + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while creating product + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Backoffice + summary: Edit an existing product + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - product_pk + properties: + datetime: + type: string + format: date-time + product_pk: + type: integer + label: + type: string + product_category_fk: + type: integer + displayed_data: + type: array + items: + type: object + required: + - language_code + - name + properties: + language_code: + type: string + name: + type: string + product_stripe_id: + type: string + product_apple_id: + type: string + is_free: + type: boolean + n_days_validity: + type: integer + n_tasks_limit: + type: integer + responses: + '200': + description: Product updated successfully + content: + application/json: + schema: + type: object + properties: + product_pk: + type: integer + '400': + description: Bad request with missing fields or invalid data + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error due to wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while updating product + content: + application/json: + schema: + type: object + properties: + error: + type: string + /profile: + put: + tags: + - Backoffice + summary: Create a new profile + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - profile_label + - displayed_data + - profile_category_pk + properties: + datetime: + type: string + format: date-time + profile_label: + type: string + displayed_data: + type: array + items: + type: object + required: + - language_code + - name + properties: + language_code: + type: string + name: + type: string + profile_category_pk: + type: integer + responses: + '200': + description: Profile created successfully + content: + application/json: + schema: + type: object + properties: + profile_pk: + type: integer + '400': + description: Bad request, missing or invalid fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while creating profile + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Backoffice + summary: Update an existing profile + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - profile_pk + properties: + datetime: + type: string + format: date-time + profile_pk: + type: integer + profile_label: + type: string + displayed_data: + type: array + items: + type: object + required: + - language_code + - name + properties: + language_code: + type: string + name: + type: string + profile_category_pk: + type: integer + responses: + '200': + description: Profile updated successfully + content: + application/json: + schema: + type: object + properties: + profile_pk: + type: integer + '400': + description: Bad request, missing or invalid fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error while updating profile + content: + application/json: + schema: + type: object + properties: + error: + type: string + /purchase: + put: + tags: + - Application + summary: Create an inactive purchase when a Stripe session is opened + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - stripe_session_id + properties: + datetime: + type: string + format: date-time + stripe_session_id: + type: string + version: + type: string + product_stripe_id: + type: string + responses: + '200': + description: Purchase added successfully + content: + application/json: + schema: + type: object + properties: + purchase_pk: + type: integer + '400': + description: Error adding purchase + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - External service + summary: Stripe webhook to activate a purchase when payment is completed + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: { } + responses: + '200': + description: Purchase activated successfully + content: + application/json: + schema: + type: object + properties: + purchase_pk: + type: integer + '400': + description: Purchase session ID does not exist in the database + content: + application/json: + schema: + type: object + properties: + error: + type: string + '409': + description: Error in Stripe webhook validating purchase + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Unhandled event type + content: + application/json: + schema: + type: object + properties: + error: + type: string + get: + tags: + - Application + summary: Get user's active purchases and purchasable products + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + - in: query + name: datetime + required: true + schema: + type: string + format: date-time + responses: + '200': + description: Successfully retrieved purchases and products + content: + application/json: + schema: + type: object + properties: + purchase_status: + type: string + current_product: + type: string + free_plan_remaining_days: + type: integer + purchasable_products: + type: array + items: + type: object + #properties: + # Define the properties of purchasable products here + current_purchases: + type: array + items: + type: object + #properties: + # Define the properties of current purchases here + last_expired_purchase: + type: object + #properties: + # Define the properties of the last expired purchase here + '400': + description: Error getting purchases + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /resource: + put: + tags: + - Application + summary: Create a MojoResource for a user + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - website_url + properties: + datetime: + type: string + format: date-time + website_url: + type: string + responses: + '200': + description: MojoResource created successfully + content: + application/json: + schema: + type: object + properties: + success: + type: string + '400': + description: Error creating MojoResource or website already exists + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Application + summary: Update a MojoResource for a user + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - document_pk + properties: + datetime: + type: string + format: date-time + document_pk: + type: string + edition: + type: string + responses: + '200': + description: MojoResource updated successfully + content: + application/json: + schema: + type: object + properties: + document_pk: + type: string + '400': + description: Error updating MojoResource or document not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Document not found for this user + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + get: + tags: + - Application + summary: Retrieve MojoResources for a user + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + - name: datetime + in: query + required: true + description: The current date and time + schema: + type: string + format: date-time + - name: learned_by_mojo + in: query + required: true + description: Filter for documents learned by Mojo + schema: + type: string + - name: n_resources + in: query + description: The number of resources to retrieve + schema: + type: integer + - name: offset + in: query + description: The offset for pagination + schema: + type: integer + responses: + '200': + description: List of MojoResources retrieved successfully + content: + application/json: + schema: + type: object + properties: + documents: + type: array + items: + type: object + properties: + document_pk: + type: string + document_type: + type: string + name: + type: string + author: + type: string + creation_date: + type: string + format: date-time + last_update_date: + type: string + format: date-time + text: + type: string + '400': + description: Error retrieving documents or missing field + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + delete: + tags: + - Application + summary: Delete a MojoResource for a user + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + - name: datetime + in: query + required: true + description: The current date and time + schema: + type: string + format: date-time + - name: document_pk + in: query + required: true + description: The primary key of the document to delete + schema: + type: string + responses: + '200': + description: MojoResource deleted successfully + content: + application/json: + schema: + type: object + properties: + document_pk: + type: string + '400': + description: Error deleting document or missing field + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Document not found for this user + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + /retrieve_produced_text: + get: + tags: + - Background + summary: Retrieve produced texts based on a query and other parameters + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + description: Secret key for authentication + - in: query + name: datetime + required: true + schema: + type: string + format: date-time + description: Timestamp of the request + - in: query + name: query + required: true + schema: + type: string + description: Query string to search for produced texts + - in: query + name: n_max + required: true + schema: + type: integer + description: Maximum number of produced texts to retrieve + - in: query + name: max_distance + required: true + schema: + type: number + format: float + description: Maximum cosine distance for the nearest neighbor search + - in: query + name: user_id + required: true + schema: + type: string + description: User ID to filter the produced texts + - in: query + name: user_task_execution_pk + required: true + schema: + type: string + description: User task execution primary key to filter the produced texts + - in: query + name: task_name_for_system + required: true + schema: + type: string + description: System name of the task to filter the produced texts + responses: + '200': + description: Successfully retrieved produced texts + content: + application/json: + schema: + type: object + properties: + retrieved_produced_texts: + type: array + items: + type: object + properties: + user_task_execution_pk: + type: string + produced_text_title: + type: string + produced_text: + type: string + task_name: + type: string + task_icon: + type: string + '400': + description: Bad request, missing required parameters + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /session: + put: + tags: + - Application + summary: Create a new session + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - platform + properties: + datetime: + type: string + format: date-time + platform: + type: string + responses: + '200': + description: Session created successfully + '400': + description: Error creating session + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + get: + tags: + - Application + summary: Get list of sessions + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + - name: datetime + in: query + required: true + description: The current date and time + schema: + type: string + format: date-time + - name: n_sessions + in: query + description: The number of sessions to retrieve + schema: + type: integer + - name: offset + in: query + description: The offset for pagination + schema: + type: integer + responses: + '200': + description: List of sessions retrieved successfully + content: + application/json: + schema: + type: object + properties: + sessions: + type: array + items: + type: object + properties: + title: + type: string + session_id: + type: string + '400': + description: Error getting sessions + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + delete: + tags: + - Application + summary: Delete a session + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + - name: datetime + in: query + required: true + description: The current date and time + schema: + type: string + format: date-time + - name: session_id + in: query + required: true + description: The ID of the session to delete + schema: + type: string + responses: + '200': + description: Session deleted successfully + '404': + description: Session not found for this user + '500': + description: Error deleting session + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Background + summary: Edit session (add title) + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - title + - session_id + properties: + datetime: + type: string + format: date-time + title: + type: string + session_id: + type: string + responses: + '200': + description: Session title updated successfully + '400': + description: Error updating session title + '403': + description: Missing Authorization secret in headers + /terms_and_conditions: + put: + tags: + - Application + summary: Record the user's agreement to the terms and conditions + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + properties: + datetime: + type: string + format: date-time + responses: + '200': + description: Terms and conditions agreement added successfully + content: + application/json: + schema: + type: object + properties: + success: + type: boolean + '400': + description: Error adding terms and conditions agreement + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /text_edit_action: + post: + tags: + - Application + summary: Execute text edit actions + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - platform + - produced_text_version_pk + - text_edit_action_pk + properties: + datetime: + type: string + format: date-time + platform: + type: string + produced_text_version_pk: + type: integer + text_edit_action_pk: + type: integer + message_pk: + type: integer + version: + type: string + responses: + '200': + description: Text edit action executed successfully + content: + application/json: + schema: + type: object + properties: + success: + type: string + message_pk: + type: integer + '400': + description: Error executing text edit action + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + /timezone: + post: + tags: + - Application + summary: Update the user's timezone offset + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - timezone_offset + properties: + datetime: + type: string + format: date-time + timezone_offset: + type: integer + format: int32 + description: The timezone offset in minutes from UTC + responses: + '200': + description: Timezone updated successfully + content: + application/json: + schema: + type: object + properties: + success: + type: string + '400': + description: Error in updating timezone + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + /todos_scheduling: + put: + tags: + - Background + summary: Add a new todo scheduling + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - todo_fk + - argument + properties: + datetime: + type: string + format: date-time + todo_fk: + type: integer + argument: + type: string + reschedule_date: + type: string + format: date + responses: + '200': + description: Todo scheduling created successfully + content: + application/json: + schema: + type: object + properties: + todo_pk: + type: integer + todo_scheduling_pk: + type: integer + '400': + description: Invalid request or error creating new todo scheduling + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Todo not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Scheduler + summary: Reschedule todos for users based on timezone and other conditions + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + properties: + datetime: + type: string + format: date-time + responses: + '200': + description: Todos rescheduled successfully + content: + application/json: + schema: + type: object + properties: + todos_pk: + type: array + items: + type: integer + '400': + description: Invalid request or missing datetime in body + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Error running extract todos + content: + application/json: + schema: + type: object + properties: + error: + type: string + /user_message: + put: + tags: + - Application + summary: Receive and process a user message + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + session_id: + type: string + message_id: + type: string + message_pk: + type: string + message_date: + type: string + format: date-time + version: + type: string + platform: + type: string + use_message_placeholder: + type: boolean + use_draft_placeholder: + type: boolean + origin: + type: string + enum: + - home_chat + - task + text: + type: string + file: + type: string + format: binary + required: + - session_id + - message_id + - message_date + - version + - origin + responses: + '200': + description: User message processed successfully + content: + application/json: + schema: + type: object + properties: + text: + type: string + message_pk: + type: string + audio_duration: + type: number + message_id: + type: string + user_task_execution_pk: + type: string + nullable: true + '400': + description: Error in processing user message + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + /user_task: + get: + tags: + - Application + summary: Retrieve tasks associated with a user + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + - name: datetime + in: query + required: true + description: Timestamp of the request + schema: + type: string + format: date-time + - name: platform + in: query + required: false + description: The platform from which the request is made (default is 'webapp') + schema: + type: string + default: webapp + - name: version + in: query + required: false + description: The version of the app making the request (default is '0.0.0') + schema: + type: string + default: "0.0.0" + - name: user_task_pk + in: query + required: false + description: Primary key of a specific user task to retrieve + schema: + type: integer + - name: n_user_tasks + in: query + required: false + description: Number of user tasks to retrieve (default and maximum is 50) + schema: + type: integer + default: 50 + - name: offset + in: query + required: false + description: Offset for pagination of user tasks + schema: + type: integer + default: 0 + responses: + '200': + description: A list of user tasks + content: + application/json: + schema: + type: object + properties: + user_tasks: + type: array + items: + type: object + properties: + user_task_pk: + type: integer + task_pk: + type: integer + task_name: + type: string + task_description: + type: string + task_icon: + type: string + task_type: + type: string + steps: + type: array + items: + type: object + properties: + workflow_step_pk: + type: integer + step_name_for_user: + type: string + step_definition_for_user: + type: string + enabled: + type: boolean + '400': + description: Error due to missing field or invalid user_task_pk + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Error due to invalid platform or other internal errors + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + /user_task_execution: + put: + tags: + - Application + summary: Create a new user task execution + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - user_task_pk + properties: + datetime: + type: string + format: date-time + user_task_pk: + type: integer + platform: + type: string + default: "webapp" + responses: + '200': + description: User task execution created successfully + content: + application/json: + schema: + type: object + properties: + user_task_execution_pk: + type: integer + json_input: + type: array + items: + type: object + actions: + type: array + items: + type: object + text_edit_actions: + type: array + items: + type: object + session_id: + type: string + '400': + description: Bad request, missing or invalid fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '402': + description: No purchase available to create a new task + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + post: + tags: + - Purchase updater + summary: End a user task execution + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - user_task_execution_pk + properties: + datetime: + type: string + format: date-time + user_task_execution_pk: + type: integer + responses: + '200': + description: User task execution ended successfully + content: + application/json: + schema: + type: object + properties: + user_task_execution_pk: + type: integer + '400': + description: Bad request, missing or invalid fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Forbidden, authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + get: + tags: + - Application + summary: Retrieve user task executions or a specific user task execution + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + - name: datetime + in: query + required: true + description: The current datetime + schema: + type: string + format: date-time + - name: user_task_execution_pk + in: query + required: false + description: The primary key of the user task execution to retrieve + schema: + type: integer + - name: n_user_task_executions + in: query + required: false + description: The number of user task executions to retrieve + schema: + type: integer + - name: offset + in: query + required: false + description: The offset for pagination + schema: + type: integer + - name: search_filter + in: query + required: false + description: A search filter to apply to the task executions + schema: + type: string + - name: user_task_pks + in: query + required: false + description: A list of user task primary keys to filter by + schema: + type: string + responses: + '200': + description: User task executions retrieved successfully + content: + application/json: + schema: + type: object + properties: + user_task_executions: + type: array + items: + type: object + '400': + description: Bad request, missing or invalid fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + delete: + tags: + - Application + summary: Delete a user task execution + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + - name: datetime + in: query + required: true + description: The current datetime + schema: + type: string + format: date-time + - name: user_task_execution_pk + in: query + required: true + description: The primary key of the user task execution to delete + schema: + type: integer + responses: + '200': + description: User task execution deleted successfully + content: + application/json: + schema: + type: object + properties: + user_task_execution_pk: + type: integer + '400': + description: Bad request, missing or invalid fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: User task execution not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + /user_task_execution_run: + post: + tags: + - Application + summary: Start a task_execution from a Form (webapp) + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - user_task_execution_pk + - inputs + properties: + datetime: + type: string + format: date-time + user_task_execution_pk: + type: integer + platform: + type: string + default: "webapp" + version: + type: string + inputs: + type: array + items: + type: object + required: + - input_name + - input_value + properties: + input_name: + type: string + input_value: + type: string + use_message_placeholder: + type: boolean + use_draft_placeholder: + type: boolean + responses: + '200': + description: Task execution started successfully + content: + application/json: + schema: + type: object + properties: + success: + type: string + '400': + description: Bad request, missing fields or incorrect data + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + /user_task_execution_summary: + post: + tags: + - Background + summary: Update the summary of a user task execution + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - title + - summary + - user_task_execution_pk + properties: + datetime: + type: string + format: date-time + title: + type: string + summary: + type: string + user_task_execution_pk: + type: integer + responses: + '200': + description: User task execution summary updated successfully + content: + application/json: + schema: + type: object + properties: + success: + type: boolean + '400': + description: Bad request, missing or invalid fields + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error, wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + /vocabulary: + post: + tags: + - Application + summary: Spot special vocabulary in a message + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - message_pk + properties: + datetime: + type: string + format: date-time + message_pk: + type: string + responses: + '200': + description: Special vocabulary spotted successfully + content: + application/json: + schema: + type: object + properties: + tagged_text: + type: string + '400': + description: Bad request, missing fields or request must be JSON + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Message not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + put: + tags: + - Application + summary: Add new vocabulary for a user + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - session_id + - initial_spelling + - corrected_spelling + properties: + datetime: + type: string + format: date-time + session_id: + type: string + initial_spelling: + type: string + corrected_spelling: + type: string + responses: + '200': + description: New vocabulary added successfully + content: + application/json: + schema: + type: object + '400': + description: Bad request, missing fields or request must be JSON + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: No message found for this session and this user + content: + application/json: + schema: + type: object + properties: + error: + type: string + '500': + description: Internal server error + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + /voice: + get: + tags: + - Application + summary: Retrieve a voice message or welcome text audio for a user + parameters: + - in: header + name: Authorization + required: true + schema: + type: string + - in: query + name: datetime + required: true + schema: + type: string + format: date-time + description: Timestamp of the request + - in: query + name: message_pk + required: false + schema: + type: string + description: Primary key of the message + - in: query + name: filename + required: false + schema: + type: string + description: Filename of the welcome text audio + - in: query + name: app_version + required: false + schema: + type: string + description: Version of the application making the request + responses: + '200': + description: Voice message or welcome text audio retrieved successfully + content: + audio/*: + schema: + type: string + format: binary + headers: + Accept-Ranges: + schema: + type: string + '400': + description: Error in retrieving voice message or welcome text audio + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error wrong or missing secret + content: + application/json: + schema: + type: object + properties: + error: + type: string + /associate_free_product: + put: + tags: + - Application + summary: Associate a free product with the user + parameters: + - name: Authorization + in: header + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - product_category_pk + properties: + datetime: + type: string + format: date-time + product_category_pk: + type: integer + responses: + '200': + description: Free product associated successfully + content: + application/json: + schema: + type: object + properties: + purchase_status: + type: string + current_product: + type: string + '400': + description: Error in associating free product + content: + application/json: + schema: + type: object + properties: + error: + type: string + '403': + description: Authentication error + content: + application/json: + schema: + type: object + properties: + error: + type: string + + +components: + schemas: + ProducedText: + type: object + properties: + produced_text_pk: + type: integer + user_task_execution_fk: + type: integer + production: + type: string + title: + type: string + creation_date: + type: string + format: date-time + text_type: + type: string + PurchasableProduct: + type: object + properties: + product_pk: + type: integer + name: + type: string + product_stripe_id: + type: string + product_apple_id: + type: string + n_days_validity: + type: integer + n_tasks_limit: + type: integer + stripe_price: + type: integer + tasks: + type: array + items: + type: string + CurrentPurchase: + type: object + properties: + product_name: + type: string + remaining_days: + type: integer + n_validity_days: + type: integer + n_tasks_limit: + type: integer + n_tasks_consumed: + type: integer + tasks: + type: array + items: + type: string + is_free_product: + type: boolean diff --git a/openAPI/background_api.yaml b/openAPI/background_api.yaml new file mode 100644 index 00000000..11a70447 --- /dev/null +++ b/openAPI/background_api.yaml @@ -0,0 +1,355 @@ +openapi: 3.0.0 +info: + title: Mojodex API Background + version: 1.0.0 +paths: + /events_generation: + post: + summary: Generate various types of events + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - event_type + - data + properties: + datetime: + type: string + format: date-time + event_type: + type: string + enum: + - action_driven_notifications + - daily_notifications + - daily_emails + - todo_daily_emails + - calendar_suggestion_notifications + data: + type: object + responses: + '200': + description: Event generation process started successfully + content: + application/json: + schema: + type: object + properties: + success: + type: string + '400': + description: Invalid inputs provided + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Error generating events + content: + application/json: + schema: + type: object + properties: + error: + type: string + /extract_todos: + post: + summary: Start the process to extract todos from a user task execution + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - user_task_execution_pk + properties: + datetime: + type: string + format: date-time + user_task_execution_pk: + type: integer + responses: + '200': + description: Process to extract todos started successfully + content: + application/json: + schema: + type: object + properties: + success: + type: string + '400': + description: Invalid inputs provided + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Error in extract todos route or user_task_execution not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + /first_session_message: + post: + summary: Start a process to generate a session title based on the first message + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - session_id + - datetime + - sender + - message + properties: + session_id: + type: string + datetime: + type: string + format: date-time + sender: + type: string + message: + type: string + responses: + '200': + description: Process to generate session title started successfully + content: + application/json: + schema: + type: object + properties: + success: + type: string + '400': + description: Invalid input provided + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Session not found or error in first session message + content: + application/json: + schema: + type: object + properties: + error: + type: string + /parse_website: + post: + summary: Parse a website and create a document + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - company_pk + - website_url + - user_id + properties: + datetime: + type: string + format: date-time + company_pk: + type: integer + website_url: + type: string + format: uri + user_id: + type: string + responses: + '200': + description: Website parsing initiated successfully + content: + application/json: + schema: + type: object + properties: + success: + type: string + '400': + description: Invalid input provided + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Error occurred during website parsing or company not found + content: + application/json: + schema: + type: object + properties: + error: + type: string + /reschedule_todo: + post: + summary: Reschedule a todo item + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - todo_pk + properties: + datetime: + type: string + format: date-time + todo_pk: + type: integer + responses: + '200': + description: Process to reschedule todo started successfully + content: + application/json: + schema: + type: object + properties: + success: + type: string + '400': + description: Invalid inputs provided + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Todo not found or error in reschedule todos route + content: + application/json: + schema: + type: object + properties: + error: + type: string + /update_document: + post: + summary: Update a document + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - document_pk + - edition + - user_id + properties: + datetime: + type: string + format: date-time + document_pk: + type: integer + edition: + type: string + user_id: + type: string + responses: + '200': + description: Document updated successfully + content: + application/json: + schema: + type: object + properties: + success: + type: string + '400': + description: Invalid input provided + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Document not found for this user or error updating document + content: + application/json: + schema: + type: object + properties: + error: + type: string + /user_task_execution_title_and_summary: + post: + summary: Start the process for managing user task execution title and summary + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - datetime + - user_task_execution_pk + properties: + datetime: + type: string + format: date-time + user_task_execution_pk: + type: integer + responses: + '200': + description: Process started successfully + content: + application/json: + schema: + type: object + properties: + success: + type: string + '400': + description: Invalid inputs provided + content: + application/json: + schema: + type: object + properties: + error: + type: string + '404': + description: Error in managing user task execution title and summary or user_task_execution not found + content: + application/json: + schema: + type: object + properties: + error: + type: string \ No newline at end of file diff --git a/overrides/home.html b/overrides/home.html new file mode 100644 index 00000000..21024834 --- /dev/null +++ b/overrides/home.html @@ -0,0 +1,104 @@ +{% extends "base.html" %} + +{% block tabs %} + {{ super() }} + + + + +
+
+
+
+

Open Source Digital Assistant Platform for Enterprises

+

The go-to solution to own and deploy digital assistants tailored to your team's need

+ + Get Started + + + Try Live Demo - Free ↗️ + +

Why Mojodex? Motivations & Roadmap ↗️

+
+
+
+
+{% endblock %} \ No newline at end of file diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 00000000..3698097a --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Overview","text":"

Mojodex is a digital assistant that supports professionals by automating text-related tasks.

\ud83c\udf1f Our motivation is to create the open standard on how to create enterprise level agents

"},{"location":"#what-does-it-do","title":"What does it do?","text":""},{"location":"#what-can-companies-do-with-mojodex","title":"What can companies do with Mojodex?","text":"

  • Recruitment Assistance

    Custom Interview Recaps: Teams of 8-10 members use Mojodex to standardize their interview processes, ensuring consistent and well-structured interview summaries.

  • Sales Process Enhancement

    On-the-Go Sales Support: Sales teams utilize Mojodex to streamline their workflow, capturing conversation details directly into their CRM while traveling between meetings.

  • Proprietary Consulting Assistants

    Secure Customer Data Handling: Consulting teams create tailored assistants with Mojodex to manage sensitive customer information on their own secure infrastructure.

  • Customer Relationship Management

    Guided Communication for Newcomers: Customer success teams employ digital assistants to mentor new members, leveraging internal data and established procedures from over 20 years of customer engagement in the sound factory industry.

Beyond those examples: Make it your own

Mojodex is designed to be flexible and adaptable to a wide range of use cases. It can be tailored to fit the specific needs of any business, from small startups to large enterprises.

"},{"location":"#whats-unique-with-mojodex","title":"What's unique with Mojodex?","text":""},{"location":"#not-just-a-chatbot-like-chatgpt","title":"Not Just a Chatbot like ChatGPT","text":"

Mojodex goes beyond reactive chatbot functionality. It proactively guides users, responds proactively, and assists in various tasks, not just instant Q&A.

"},{"location":"#more-than-a-retrieval-augmented-generation-rag-tool","title":"More Than a Retrieval Augmented Generation (RAG) Tool","text":"

Mojodex doesn't merely retrieve information from company data like RAG tools. It collaborates with users, performing tasks and enhancing work processes using the available data.

"},{"location":"#mojodex-is-tasks-oriented","title":"Mojodex is tasks-oriented","text":"

A task for Mojodex is any job activity requiring written content creation.

"},{"location":"#why-an-open-source-digital-assistant-platform-for-enterprises","title":"Why an Open-source Digital Assistant Platform for Enterprises?","text":"

Mojodex was created to foster the adoption of digital assistants in businesses. The reasons for its open-source release are:

  • Enable Enterprises to Building their own AI Assets: To support companies in creating their refined prompts and data wheel pipeline of high quality interaction with experts.
  • On Premise & Tailor-made: Providing an open-source platform for complete control over the software and data, development, hosting, and evolution.
  • Boosting Internal Adoption: Business experts and tech team teamwork to tailor your company's digital assistants, tailored to their needs, fostering adoption.

A highly valuable side effect of implementing a digital assistant platform is Process Optimization. Configuring their own digital assistant implies to optimizing a company's internal processes, promoting long-term development.

"},{"location":"#frequently-asked-questions-faqs","title":"Frequently Asked Questions (FAQs)","text":""},{"location":"#what-makes-the-mojodex-open-source-platform-different-from-other-gpt-chat-platforms-or-copilot-platforms","title":"What makes the Mojodex open-source platform different from other GPT chat platforms or copilot platforms?","text":"

Beyond Chat : Unlike platforms that are solely chat-based, Mojodex is task-oriented, using conversation to achieve the goal of completing tasks and producing deliverables.

"},{"location":"#what-are-the-benefits-of-using-mojodex-over-other-platforms","title":"What are the benefits of using Mojodex over other platforms?","text":"

  • Never Locked: Being open-source, it allows for the creation of custom prompts and working on proprietary processes, rather than sending them to an uncontrolled platform.

  • Ease of Integration: The assistant's API-centric architecture facilitates seamless integration with existing tools.

"},{"location":"#how-about-the-data-privacy-and-security","title":"How about the data privacy and security?","text":"

  • You own your data: Complete control over data flows, especially towards large language models, enabling users to connect their proprietary LLM solutions and fully manage the data stream.

  • As secure as your infrastructure is: For sensitive data, hosting on personal infrastructure provides total control.

"},{"location":"#what-can-i-do-with-the-data-generated-by-mojodex","title":"What can I do with the data generated by Mojodex?","text":"

Users own their data, allowing the construction of interaction datasets at an enterprise scale, which are invaluable for retraining on specific use cases.

"},{"location":"#can-i-use-open-source-llms-with-mojodex","title":"Can I use open-source LLMs with Mojodex?","text":"

Yes, Mojodex is designed to be compatible with open-source LLMs, allowing best of both worlds with the use of proprietary models through APIS and hosted open-source models. This may require some development work.

"},{"location":"getting-started/","title":"Welcome!","text":"

Mojodex is an open-source digital assistant platform to help companies and individuals build their own AI-powered assets.

It's a complete platform to build, deploy and manage your very own digital assistants.

It is designed to be task-oriented, configurable, and personalizable. Mojodex is API-centric, allowing for easy integration with other tools and is available as a web application, mobile application, and Chrome extension.

"},{"location":"getting-started/#quick-start","title":"Quick Start","text":""},{"location":"getting-started/#installation","title":"Installation","text":"

[\ud83e\uddd1\u200d\ud83d\udcbb Tech team]: Install Plaform Core

See the installation video guide here: https://youtu.be/86_S_cXhhTA

  • Optional [\ud83e\uddd1\u200d\ud83d\udcbb Tech team]: Build your local mobile app
"},{"location":"getting-started/#getting-started-easy-steps-to-get-started-with-mojodex","title":"Getting started: Easy steps to get started with Mojodex","text":"

Goal: Get a good understanding of the platform

[\ud83e\uddd1\u200d\ud83e\udd1d\u200d\ud83e\uddd1 Whole Team]: Test the existing examples on the web app and the mobile app

  1. Try the demo on your local install

    • Prepare a meeting recap
    • Write a LinkedIn Post
    • Prepare a sales pitch
    • Build good understanding of the platform

  2. Configure a Sales Assistant Example

    • Configure your own sales assistant using the provided example
    • Define the tasks the assistant will help with
    • Learn how to iterate on the configuration of the platform
"},{"location":"getting-started/#to-go-further-work-on-your-long-term-ai-strategy","title":"To go further: Work on your long term AI strategy","text":"

Goal: Build your company's future-proof investment with AI.

[\ud83d\udc69\u200d\ud83d\udcbc\ud83e\uddd1\u200d\ud83d\udcbc Whole Team]: Define the high level goals and scope of the project \u2013 process optimization, reducing mental load, increase productivity, etc. \u2013 and the User Team

[\ud83d\udc69\u200d\ud83d\udcbc\ud83e\uddd1\u200d\ud83d\udcbc Whole Team]: Define the metrics to measure the success of the project.

[\ud83d\udc69\u200d\ud83d\udcbc\ud83e\uddd1\u200d\ud83d\udcbc Whole Team]: Define the tasks the assistant will help with

Tip

\ud83c\udf1f These steps require teamwork, and boost team ownership and adoption

"},{"location":"getting-started/#key-features","title":"Key Features","text":"

  • Task-Oriented : Mojodex is designed to assist users by completing specific tasks, making it easier for the assistant to understand and fulfill user needs.

  • Configurable : Tailored to various professional uses, allowing for role-specific task configurations (sales, recruitment, personal assistance, etc.).

  • Personalizable : Builds a memory of user interactions and goals to improve task execution.

  • Proactive : Independently manages tasks, freeing users to focus on other activities through a chat-independent architecture.

  • Multiple User Interfaces : Includes a web application in this repository, an open-source mobile application, and a Chrome extension.

  • API-Centric Back-End : Enables easy integration with other tools through a well-defined API exposure.

  • Using OpenAI's GPT-4 Turbo : Accessible directly via OpenAI or through Azure's functionalities.

"},{"location":"motivations/","title":"Why Mojodex?","text":"

\ud83c\udf1f Mojodex, is an Open-source Digital Assistant for Enterprise.

"},{"location":"motivations/#whats-unique","title":"\ud83d\udd0d What's Unique","text":"

  1. Mojodex is highly customizable, allowing enterprises to create text-based tasks that are directly aligned with their business workflows. Go beyond chat-based interfaces; get the work done.

  2. This user-friendly multi-interfaces platform is not just another tool; it's fully customizable for your daily operations. All-in-one, a webapp, a mobile app and a browser extension.

  3. You own it. Mojodex is open-source, meaning you can modify it to fit your needs and keep your data secure. Don't delegate your internal process to a third-party SaaS platform;

"},{"location":"motivations/#why-now","title":"\ud83d\udd52 Why now?","text":"

Companies are looking to invest in their own AI assets \u2013 prompts, workflows, process \u2013 by crafting specialized tasks for their digital assistants.

\ud83d\udca1 Integrating Mojodex is equivalent to creating the AI assets of the company.

Mojodex stands out by turning each interaction into a valuable asset, fueling the data flywheel at the heart of your company's AI-powered processes.

\ud83d\udca1 Using Mojodex means creating the data you need to train your future AI tools

"},{"location":"motivations/#open-source","title":"\ud83d\ude80 Open-source","text":"

What sets Mojodex apart is its full integration of AI-native open-source code and open-weights models.

This synergy creates a first-of-its-kind, future-proof platform for building your company's digital assets.

"},{"location":"motivations/#mojodex-in-your-business-ecosystem","title":"\ud83c\udf10 Mojodex in your Business Ecosystem","text":"

\ud83d\ude80 It's time to elevate your business with an AI assistant that's built for the task at hand and the challenges ahead. Let's embark on this journey together, shaping a future where AI is not only powerful but also a trusted ally in the enterprise software landscape.

"},{"location":"design-principles/products/how_it_works/","title":"How Products work?","text":""},{"location":"design-principles/products/how_it_works/#free-trial","title":"Free trial","text":"

At onboarding, new users are asked to select a product category. This category will define the user's profile and will automatically affect them the free trial product of this category. This allows users to try the product for a limited time or a limited number of tasks through a tailored experience matching their profile.

"},{"location":"design-principles/products/how_it_works/#moving-on-with-other-products","title":"Moving on with other products","text":"

Any time, the user can be affected products: - manually by an admin using Backoffice APIs - automatically by the payment system when buying a product (see below)

This allow users to keep a tailored experience matching their profile and needs.

"},{"location":"design-principles/products/how_it_works/#buying-a-product-using-an-implemented-payment-service","title":"Buying a product using an implemented payment service","text":"

2 payment services have been implemented for now:

"},{"location":"design-principles/products/how_it_works/#stripe","title":"Stripe","text":"

When the user wants to buy a product though Stripe, here is the flow:

  1. A Stripe session is created (webapp/helpers/hooks/useCreateStripeCheckoutSession.ts)
  2. The Backend route PUT /purchase (backend/app/routes/purchase.py) is called specifying the stripe_session_id. This route creates a new purchase that is not active yet.
  3. The user is redirected to the Stripe checkout page
  4. The user pays for the product and is redirected to Mojodex's success page
  5. Stripe uses the new purchase webhook to notify Mojodex that the purchase is successful: POST /purchase (backend/app/routes/purchase.py). This route activates the purchase by:
  6. deactivating any previous active subscription if bought product is a subscription
  7. associating and enabling the product's tasks to the user

If the product bought is a subscription, it will be kept active and no Stripe webhook will be call as long as user's payments are up to date. If a payment fails, Stripe calls a webhook to handle the end of a purchase: POST /subscription_end (backend/app/routes/purchase_end_stripe_webhook.py).

"},{"location":"design-principles/products/how_it_works/#apple-in-app-purchase","title":"Apple in-app purchase","text":"

When the user wants to buy a product though Apple in-app purchase, here is the flow:

  1. The user is redirected to the Apple in-app purchase flow
  2. The user pays for the product and is redirected to Mojodex's success page. Apple calls webhook POST /in_app_apple_purchase (backend/app/routes/inapp_apple_purchase.py). This routes verifies the transaction and created an inactive purchase, not yet associated to a user.
  3. The application calls route PUT /in_app_apple_purchase to confirm the purchase and associate it to the user (backend/app/routes/inapp_apple_purchase.py). This route activates the purchase by:
  4. deactivating any previous active subscription if bought product is a subscription
  5. associating and enabling the product's tasks to the user

On the contrary of Stripe, regarding subscriptions, Apple does call the /in_app_apple_purchase webhook every month at payment renewal providing a new transaction ID. Old subscription purchase is deactived, a new purchase is created and associated to the user. This /in_app_apple_purchase is also used to manage failed renewals, grace period and purchases expirations.

"},{"location":"design-principles/products/whats_a_product/","title":"What's a product?","text":"

Product concept is used in Mojodex not only for billing purposes but also to define group of users depending on their profile and needs. Products and purchase are ways to provide each user with a personalized, adapted experience on Mojodex.

"},{"location":"design-principles/products/whats_a_product/#main-concepts","title":"Main concepts","text":""},{"location":"design-principles/products/whats_a_product/#product","title":"Product","text":"

In Mojodex, a product is set of tasks the user can execute on Mojodex. A product has:

  • a label to identify it
  • some display data to display on the user's interface in their language (name of the product)
  • a status (active or inactive)
  • free boolean status : flag to indicate if it's free or not
  • a limit number of tasks the user can execute using this product
  • a number of days of validity of the product, after which it expires
  • an eventual ID that can be used to identify it in the payment system (Stripe or Apple implemented for now)
  • a product_category to which it belongs

A product is refered as a subscription when: - it has no limit number of tasks - it has no number of days of validity In this case, the business model for this product might be a monthly subscription. The subscription is automatically renewed every month, as long as there is no payment default (specific REST API call, made through dedicated webhook for Stripe and Apple).

A product is refered as a consumable when it is not a subscription.

A product is refered as free trial when it has: - a limit : in number of days of validity OR in number of tasks - a free status

A product category visible by users must have 1 and only 1 free trial product so that the automatic association can be made at onboarding. (see below part Affectation > Free trial)

"},{"location":"design-principles/products/whats_a_product/#product-task","title":"Product Task","text":"

As mentioned above, a product defines a set of tasks the user can execute on Mojodex. A product task is a task that is part of a product. Those associations are stored in the dedicated DB table md_product_task.

"},{"location":"design-principles/products/whats_a_product/#product-category","title":"Product category","text":"

A product category is a category of products. It is used to group products together and suggest tageted products to the user corresponding to their profile. A product category has: - a label to identify it - an emoji to display on the user's interface - some display data to display on the user's interface in their language (name and description) - a visible boolean status : flag to indicate if it's visible or not from the user's interface at the time to choose a category - an implicit goal: This goal will be affected to the user account as their initial goal. This goal is then used in the assistant's prompt to drive the assistance by this goal.

"},{"location":"design-principles/products/whats_a_product/#purchase","title":"Purchase","text":"

A purchase is the relation between a user and a product. It is created when a product is affected to a user, no matter if it's a free trial, a consumable or a subscription. The purchase object contains metadata about the purchase, such as dates, status, ids... The purchase will also be used to tag any user task execution to keep track of the user's activity.

"},{"location":"design-principles/products/whats_a_product/#user-task","title":"User Task","text":"

When a new purchase is created (e.g. a product is affected to a user), the user is granted access to the tasks of the product. This creates an association between the user and each task of the product. This association is stored in the dedicated DB table md_user_task.

"},{"location":"design-principles/products/whats_a_product/#affectation","title":"Affectation","text":""},{"location":"design-principles/products/whats_a_product/#product-category-selection","title":"Product category selection","text":"

When a user creates an account, they go through a process we call \"onboarding\". During this process, the user is asked to select a product category. This category defines the user's profile and will be used to: - define their initial goal - affect them a free trial product - later suggest them adapted products

"},{"location":"design-principles/products/whats_a_product/#free-trial","title":"Free trial","text":"

When a user selects a product category at onboarding, they are automatically affected a free trial product. A product category must have only 1 single free trial product. This free-trial product will be the one associated to the user at onboarding.

"},{"location":"design-principles/products/whats_a_product/#purchase-services","title":"Purchase services","text":"

Later, a user can: - be affected new products manually by an admin using backoffice APIs - buy a product through interface

Important note: A user can't have 2 active subscriptions at the same time. If a user is affected with a new subscription, the previous one is automatically cancelled.

2 payment services have been implemented for now: - Stripe - Apple in-app purchase

"},{"location":"design-principles/profiles/whats_a_profile/","title":"What is a profile?","text":"

Profile concept is used in Mojodex to define a group of users depending on their needs. Profiles and roles are ways to provide each user with a personalized, adapted experience on Mojodex.

"},{"location":"design-principles/profiles/whats_a_profile/#profile-vs-product","title":"Profile VS Product","text":"

The concept of profile has been introduced after notion of product. A profile and a product point exactly to the same object in database. A profile/role is just a vocabulary that matches better to a \"pre-set\" user configuration versus a product/purchase the user would buy on itself. A profile is generally pre-configured by an admin and assigned to a user through a role.

"},{"location":"design-principles/profiles/whats_a_profile/#main-concepts","title":"Main concepts","text":""},{"location":"design-principles/profiles/whats_a_profile/#profile","title":"Profile","text":"

The profile concepts are the same as the product concepts, knowing that: - a profile's \"free\" status is always true - a profile's n_tasks and days_validity limits are always null - product_stripe_id and product_apple_id are always null

Finally, variables of a profile are:

  • a label to identify it
  • some display data to display on the user's interface in their language (name of the profile)
  • a status (active or inactive)
  • a profile_category to which it belongs
"},{"location":"design-principles/profiles/whats_a_profile/#profile-task","title":"Profile Task","text":"

As profile_task defines a set of tasks the user can execute on Mojodex. A profile task is a task that is part of a profile. Those associations are stored in the dedicated DB table md_product_task.

"},{"location":"design-principles/profiles/whats_a_profile/#profile-category","title":"Profile category","text":"

A profile category is a category of profile. It is used to group profiles together. A profile category has: - a label to identify it - an emoji to display on the user's interface - some display data to display on the user's interface in their language (name and description) - a visible boolean status : flag to indicate if it's visible or not from the user's interface at the time to choose a category if onboarding is done by user. - an implicit goal: This goal will be affected to the user account as their initial goal. This goal is then used in the assistant's prompt to drive the assistance by this goal.

"},{"location":"design-principles/profiles/whats_a_profile/#role","title":"Role","text":"

A role is the relation between a user and a profile. It is the equivalent to a purchase when speaking about products. It is created when a profile is affected to a user.

"},{"location":"design-principles/profiles/whats_a_profile/#user-task","title":"User Task","text":"

When a new role is created (e.g. a profile is affected to a user), the user is granted access to the tasks of the profile. This creates an association between the user and each task of the profile. This association is stored in the dedicated DB table md_user_task.

"},{"location":"design-principles/tasks/execute_task/","title":"Instruct Task Execution Workflow in Mojodex","text":"

This document provides an overview of the concept related to the task execution process in the Mojodex platform and describes the sequence of events that occur from the moment a user initiates a new task execution until the task is completed and the result is delivered.

"},{"location":"design-principles/tasks/execute_task/#main-concepts","title":"Main concepts","text":"

The task execution process involves several concepts matching database tables.

"},{"location":"design-principles/tasks/execute_task/#task","title":"Task","text":"
  • Task concept is fully described in this doc. Basically, a task is a some work the assistant can help the user with. A task is fully configurable. A task can be of type \"instruct\" or \"workflow\".

    This documentation

"},{"location":"design-principles/tasks/execute_task/#user-task","title":"User Task","text":"
  • Each user has its own set of tasks it can launch with Mojodex. A user_task stands for the association between a user and a task. Those association are defined by user's product (detailled in a coming doc).
"},{"location":"design-principles/tasks/execute_task/#user-task-execution","title":"User Task Execution","text":"
  • A user_task_execution represents the instance of a task being executed by a user. It captures various details such as the start time and any relevant metadata pertaining to the execution of a specific task by a user.

Note, sometimes refered as task_execution for short.

"},{"location":"design-principles/tasks/execute_task/#session","title":"Session","text":"
  • A session represents an interaction between the user and the assistant. It captures the messages exchanged between the user and the assistant, as well as the state of the conversation at any given time. A user_task_execution always needs a session for the user and its assistant to co-work on the task.

Note: With existing interface, a user_task_execution has 1 session. 1 session can have multiple user_task_execution, for example using a more general chat with routing to specific tasks.

"},{"location":"design-principles/tasks/execute_task/#message","title":"Message","text":"
  • A message represents a single message exchanged between the user and the assistant within a session. It captures the content of the message, sender, timestamp of the message, and other relevant metadata depeding on the type of message. In the database, a json field is used to store the content of the message, allowing high flexibility regarding stored data.
"},{"location":"design-principles/tasks/execute_task/#produced-text","title":"Produced text","text":"
  • A produced_text represents the result of a task execution. It contains all versions of the result as references to produced_text_version
"},{"location":"design-principles/tasks/execute_task/#produced-text-version","title":"Produced text version","text":"
  • A produced_text_version represents a version of the result of a task execution. It contains the content of the result and the date of the version.
"},{"location":"design-principles/tasks/execute_task/#task-execution-workflow","title":"Task execution workflow","text":"

The task execution workflow is a sequence of events that occur from the moment a user initiates a new task execution until the task is completed and the result is delivered. The workflow is described below.

"},{"location":"design-principles/tasks/execute_task/#1-user-task-execution-creation","title":"1. User Task Execution Creation","text":"

Creation of execution is done as soon as the user hits the card of the task they want to create.

This generates a call to PUT /user_task_execution to the backend (backend/app/routes/user_task_execution.py), specifying the user_task the user wants to execute. This call creates a User Task Execution instance in the database and a session if not already exists (which is the case in current Mojodex implementations).

from mojodex_core.entities.db_base_entities import MdUserTaskExecution\n[...]\nclass UserTaskExecution(Resource):\n    [...]\n    def put(self, user_id): \n        [...]\n        session_creation = self.session_creator.create_session(user_id, platform, \"form\")\n        [...]\n        session_id = session_creation[0][\"session_id\"]\n        [...]\n        task_execution = MdUserTaskExecution(user_task_fk=user_task_pk,\n                                                json_input_values=empty_json_input_values, session_id=session_id)\n        db.session.add(task_execution)\n        db.session.commit()\n

This call also returns the input fields to display to the user in the interface so that user have the instructions to start. Those input fields are the one defined in the task's json configuration file as json_input. 

return {**{\"user_task_execution_pk\": task_execution.user_task_execution_pk,\n                     \"json_input\": json_input,\n                     \"actions\": predefined_actions,\n                     \"text_edit_actions\" : recover_text_edit_actions(user_task_pk=user_task_pk)\n                     }, **session_creation[0]}, 200\n

"},{"location":"design-principles/tasks/execute_task/#2-user-task-execution-start","title":"2. User Task Execution Start","text":"

From those instructions, there are 2 ways to start the task:

"},{"location":"design-principles/tasks/execute_task/#21-user-task-execution-start-from-filled-form","title":"2.1. User Task Execution Start from filled form","text":"

This is the method used in the web interface. The user fills the form and submit it. This generates a call to POST /user_task_execution_run to the backend (backend/app/routes/user_task_execution_run.py), specifying the user_task_execution_pk received at previous step and the values of filled form.

Resource associated to the route updates the User Task Execution instance and instanciates a Session(backend/app/models/session/session.py).

Finally, it launches in a parallel thread the start of the task by running session.process_form_input method.

[...]\nclass UserTaskExecutionRun(Resource):\n    [...]\n    def post(self, user_id):\n        [...]\n        user_task_execution.start_date = datetime.now()\n        db.session.commit()\n        [...]\n        from models.assistant.session import Session as SessionModel\n        session = SessionModel(user_task_execution.session_id)\n        def launch_process(session, app_version, platform, user_task_execution_pk, use_message_placeholder, use_draft_placeholder):\n            session.process_form_input( app_version, platform, user_task_execution_pk, use_message_placeholder=use_message_placeholder, use_draft_placeholder=use_draft_placeholder)\n            return\n        [...]\n        server_socket.start_background_task(launch_process, session, app_version, platform, user_task_execution_pk, use_message_placeholder, use_draft_placeholder)\n

The Session is the epicenter of task execution. The function process_form_input() will: - Asynchronously call the Background to ask for a task execution title and summary generation - Prepare first assistant's response to the user.

The Task Manager detailled flow is described in part 3.

"},{"location":"design-principles/tasks/execute_task/#22-user-task-execution-start-from-user-message","title":"2.2. User Task Execution Start from user message","text":"

On the mobile app, the user sees the same instructions as in the web's form but is free to send to the assistant the first message they want.

This first message generates a call to PUT /user_message (backend/app/routes/user_message.py) specifying the user_task_execution_pk received at previous step and the message content.

This route can be called for any user message, at any step in the task execution process to send user's message to backend. If it appears the User Task Execution identified by the user_task_execution_pk is not started, it will start it.

[...]\nclass UserMessage(Resource):\n    [...]\n    def put(self, user_id):\n        [...]\n        user_task_execution = db.session.query(MdUserTaskExecution) \\\n            .join(MdUserTask, MdUserTaskExecution.user_task_fk == MdUserTask.user_task_pk) \\\n            .filter(MdUserTaskExecution.user_task_execution_pk == user_task_execution_pk) \\\n            .filter(MdUserTask.user_id == user_id) \\\n            .first()\n        [...]\n\n        if user_task_execution.start_date is None:\n            user_task_execution.start_date = datetime.now()\n            db.session.commit()\n        [...]\n

Once the User Task Execution is updated, the Resource will instanciate a Session object (backend/app/models/session.py), responsible for managing user and assistant messages exchanges.

Finally, it launched a parallel thread in which it runs method process_chat_message of Session.

[...]\nclass UserMessage(Resource):\n    [...]\n    def put(self, user_id):\n        [...]\n        from models.assistant import Session as SessionModel\n        session = SessionModel(session_id)\n\n        session_message = {\"text\": message.message[\"text\"], \"message_pk\": message.message_pk,\n                            \"audio\": not \"text\" in request.form, \"user_task_execution_pk\":user_task_execution_pk,\n                            \"home_chat_pk\": home_chat.home_chat_pk if home_chat else None,\n                                \"message_date\": message_date.isoformat(),\n                            \"use_message_placeholder\": use_message_placeholder, \"use_draft_placeholder\": use_draft_placeholder}\n\n        server_socket.start_background_task(session.process_chat_message, \"user_message\", session_message)\n        [...]\n

The process_chat_message method will: - Check the message is a task execution message - Instanciate a Task Manager - Call appropriate assistant_response_generator to generate the assistant's response to the user.

[...]\nclass Session:\n    [...]\n    def process_chat_message(self, event_name, message):\n        [...]\n        response_event_name, response_message = self.__manage_task_session(message, app_version)\n        [...]\n\n    def __manage_task_session(self, platform, user_task_execution_pk, use_message_placeholder=False, use_draft_placeholder=False):\n        [...]\n            return self.__manage_instruct_task_session(platform, user_task_execution_pk, use_message_placeholder, use_draft_placeholder)\n        [...]\n\n    def __manage_instruct_task_session(self, platform, user_task_execution_pk, use_message_placeholder=False, use_draft_placeholder=False):\n        [...]\n            tag_proper_nouns = platform == \"mobile\"\n            task_assistant_response_generator = InstructTaskAssistantResponseGenerator(mojo_message_token_stream_callback=self._mojo_message_stream_callback,\n                                                                              draft_token_stream_callback=self._produced_text_stream_callback,\n                                                                              use_message_placeholder=use_message_placeholder,\n                                                                               use_draft_placeholder=use_draft_placeholder,\n                                                                               tag_proper_nouns=tag_proper_nouns,\n                                                                               user=self._get_user(),\n                                                                               session_id=self.id,\n                                                                               user_messages_are_audio= platform==\"mobile\",\n                                                                               running_user_task_execution_pk=user_task_execution_pk)\n\n            response_message = task_assistant_response_generator.generate_message()\n            response_language = task_assistant_response_generator.context.state.current_language\n            return response_message, response_language\n        [...]\n[...]\n

The Task Manager detailled flow is described in part 3.

"},{"location":"design-principles/tasks/execute_task/#3-instructtaskassistantresponsegenerator","title":"3. InstructTaskAssistantResponseGenerator","text":"

The InstructTaskAssistantResponseGenerator is the epicenter of task execution. It is responsible for managing the execution of a task by the user and the assistant. Its inheritance tree is as follows: - AssistantMessageGenerator: responsible for generating the assistant's message to the user - AssistantResponseGenerator: responsible for generating the assistant's response to the user (used in the context of a response) - TaskEnabledAssistantResponseGenerator: Specified in collecting the task execution context - InstructTaskEnabledAssistantResponseGenerator: Holds the prompt and instruct tasks tags management - InstructTaskAssistantResponseGenerator

The core method of those object lies in AssistantMessageGenerator method generate_message.

class AssistantMessageGenerator(ABC):\n    [...]\n    def generate_message(self):\n        [...]\n            placeholder = self._handle_placeholder()\n            if placeholder:\n                return placeholder\n            prompt = self._render_prompt_from_template()\n            llm_output = self._generate_message_from_prompt(prompt)\n            if llm_output:\n                return self._handle_llm_output(llm_output)\n            return None\n[...]\n

Let's break this method down.

Note: We won't deal with placeholders, those are basically useful to return a placeholder instead of a LLM generated message for development purposes.

"},{"location":"design-principles/tasks/execute_task/#31-prompt-preparation","title":"3.1. Prompt preparation","text":"

First, the assistant collects all the data it needs to answer the user's message. Those data will be used to render Jinja2 template and generate the assistant's prompt.

Some data are stored in context, other in KnowledgeManager and some need specific calls to database to be collected.

class InstructTaskEnabledAssistantResponseGeneratorTaskEnabledAssistantResponseGenerator, ABC)::\n    [...]\n    def _render_prompt_from_template(self):\n        try:\n            mojo_knowledge = KnowledgeManager.get_mojo_knowledge()\n            user_datetime_context = KnowledgeManager.get_global_context_knowledge()\n            user_company_knowledge = KnowledgeManager.get_user_company_knowledge(self.context.user_id)\n            available_user_tasks = self.__get_available_user_instruct_tasks()\n            task_specific_instructions = self.__get_specific_task_instructions(self.running_task) if self.running_task else None\n            produced_text_done = self.context.state.get_produced_text_done()\n\n            return self.prompt_template.render(mojo_knowledge=mojo_knowledge,\n                                                    user_datetime_context=user_datetime_context,\n                                                    username=self.context.username,\n                                                    user_company_knowledge=user_company_knowledge,\n                                                    tasks = available_user_tasks,\n                                                    running_task=self.running_task,\n                                                    task_specific_instructions=task_specific_instructions,\n                                                    produced_text_done=produced_text_done,\n                                                    audio_message=self.context.user_messages_are_audio,\n                                                    tag_proper_nouns=self.tag_proper_nouns,\n                                                    language=None\n                                                    )\n        except Exception as e:\n            raise Exception(f\"{InstructTaskEnabledAssistantResponseGenerator.logger_prefix} _render_prompt_from_template :: {e}\")\n\n[...]\n

\ud83d\udca1The advanced prompting strategy used in the Task Manager is described in detail in the following article: Advanced Prompting Strategies for Digital Assistant Development

The Jinja2 prompt is rendered using collecting data. At next step, it will be used as the content of initial system message of list of messages to send to LLM.

"},{"location":"design-principles/tasks/execute_task/#32-llm-call","title":"3.2. LLM call","text":"

The LLM call is provided with various parameters and a stream callback function that will stream assistant's tokens on the go to user's interface.

class AssistantResponseGenerator(AssistantMessageGenerator, ABC):\n    [...]\n    def _generate_message_from_prompt(self, prompt):\n       [...]\n        conversation_list = self.context.state.get_conversation_as_list(self.context.session_id)\n        messages = [{\"role\": \"system\", \"content\": prompt}] + conversation_list\n        responses = model_loader.main_llm.invoke(messages, self.context.user_id,\n                                                    temperature=0,\n                                                    max_tokens=4000,\n                                                    label=\"CHAT\",\n                                                    stream=True, stream_callback=self._token_callback)\n\n        return responses[0].strip() if responses else None\n        [...]\n[...]\n
"},{"location":"design-principles/tasks/execute_task/#33-response-analysis","title":"3.3. Response analysis","text":"

Once LLM call completed, we can analyse the answer.

The prompt asks for the assistant to spot the language used by the user in the first information they provided. This is useful to adapt the assistant's response to the user's language dynamically during the task. To check if the assistant spotted the language, we look for the language tag in the response. If found, we update the session with the language and commit the change.

class AssistantResponseGenerator(AssistantMessageGenerator, ABC):\n[...]\n    def __manage_response_language_tags(self, response):\n        \"\"\"\n        Remove language tags from the response and update the language in the context\n        :param response: response\n        \"\"\"\n        try:\n            if AssistantResponseGenerator.user_language_start_tag in response:\n                try:\n                    self.context.state.current_language = AssistantMessageGenerator.remove_tags_from_text(response, AssistantResponseGenerator.user_language_start_tag,\n                                                                        AssistantResponseGenerator.user_language_end_tag).lower()\n                except Exception as e:\n                    pass\n        except Exception as e:\n            raise Exception(f\"__manage_response_language_tags:: {e}\")\n[...]\n

Then, we check for specific tags that will determine the nature of the response. 

class InstructTaskEnabledAssistantResponseGenerator(TaskEnabledAssistantResponseGenerator, ABC):\n    [...]\n    def _manage_response_task_tags(self, response):\n        [...]\n        if TaskInputsManager.ask_user_input_start_tag in response:\n            return self.task_input_manager.manage_ask_input_text(response)\n        return {\"text\": response}\n        [...]\n\n    def _manage_execution_tags(self, response):\n        [...]\n            if ExecutionManager.execution_start_tag in response:\n                return self.execution_manager.manage_execution_text(response, self.running_task, self.running_task_displayed_data,\n                                          self.running_user_task_execution, self.task_executor,\n                                          use_draft_placeholder=self.use_draft_placeholder)\n        [...]\n\n    def _manage_response_tags(self, response):\n        execution = self._manage_execution_tags(response)\n        if execution:\n            return execution\n        return self._manage_response_task_tags(response)\n

For now, 3 types of responses can be generated. Those 3 types are each handled by a specific object:

"},{"location":"design-principles/tasks/execute_task/#taskinputsmanager","title":"TaskInputsManager","text":"
  • TaskInputsManager handles a response indicating the assistant needs more information from the user to complete the task. In this case, the response format will include a question addressed to the user enclosed in specific tags. 
    [...]\nif TaskInputsManager.ask_user_input_start_tag in response:\n    return self.task_input_manager.manage_ask_input_text(response)\n[...]\n
    Basically, the TaskInputsManager will extract the question addressed to the user from the LLM response by removing the tags so that it can be displayed properly to the user.
"},{"location":"design-principles/tasks/execute_task/#35-response-to-user","title":"3.5. Response to user","text":"

Finally, the method generate_message returns the assistant's message that should be sent to the user (or None if it was a draft_message managed by TaskExecutionManager).

Then, the session will get this message, the associated event_name and the eventual detected language, generate audio version if platform is mobile and send mojo message to the user using socketio.

"},{"location":"design-principles/tasks/execute_task/#4-iterating-on-a-task","title":"4. Iterating on a task","text":"

The task execution process is an iterative process. The user and the assistant exchange messages until the user is satisfied with the produced result.

When the assistant sends a message to ask for any precision or when they want to ask for an edition, the user can send a message through the chat interface to interact with the assistant.

When the user sends a message during a task execution, the message is sent to the backend through a PUT user_message call and the same process as described in part 2.2 is repeated.

"},{"location":"design-principles/tasks/whats_a_task/","title":"What's a task?","text":""},{"location":"design-principles/tasks/whats_a_task/#task","title":"Task","text":"

A task on Mojodex is a discrete piece of work, inspired by the JRC-Eurofound Tasks Framework and O*NET OnLine, representing various skills and specializations required to accomplish it.

"},{"location":"design-principles/tasks/whats_a_task/#why","title":"Why?","text":"

We build this \"task-centric\" assistant to provide the best help to the user, tailored to their needs. Technically, a task is described as a configuration file containing all information the assistant needs. This way, any expert can create a really specific task and the assistant will be able to guide the user through the process of accomplishing it in a conversational, seamless way.

"},{"location":"design-principles/tasks/whats_a_task/#mojodex-usage","title":"Mojodex usage","text":"

A Mojodex user has access to the task corresponding to their profile. This way, the assistant is completely tailored to the user's needs and can provide the best help.

On the web or mobile app interface, the user directly selects the task they want to accomplish. This makes it easy for the user to ask for the help they need without having to think about how to phrase their request. The assistant then guides them through the process, asking questions in a conversational way though a chat interface.

Once the assistant collected all the necessary information, it starts drafting the document resulting from the task. The user can then review and ask for any edit in the chat or directly modify the document.

"},{"location":"design-principles/to-do_list/how_todo_works/","title":"How To-Do works?","text":"

To-dos are stored in the database. Typical technical workflow of a To-Do item is as follow: 1) extracted from a task execution 2) organized later if not achieved 3) reminded to the user 4) cleared by the user

"},{"location":"design-principles/to-do_list/how_todo_works/#1-extract-to-dos-from-achieved-tasks","title":"1. Extract To-Dos from achieved tasks","text":"

Mojodex's scheduler is a python module that triggers routes calls at a certain frequency. See /scheduler/app/main.py

One of its trigger checks every 10 minutes if a task has just been achieved. 

from scheduled_tasks.extract_todos import ExtractTodos\n[...]\nExtractTodos(600) # extract todos every 10 minutes\n[...]\n

A task is considered 'just achieved' if it has an associated produced_text which last version's date is between 10 and 20 minutes ago. See backend/app/routes/extract_todos.py.

Each of those tasks are sent to the background through route /extract_todos for processing. As a reminder, when a background route is called, the data is processed as follow:

class ExtractTodos(Resource):\n    [...]\n    def post(self):\n            [...]\n            extract_todos_cortex = ExtractTodosCortex(user_task_execution)\n\n            def run_extract_todos_cortex(cortex):\n                try:\n                    cortex.extract_todos()\n                except Exception as err:\n                    print(\"\ud83d\udd34\" + str(err))\n\n            executor.submit(run_extract_todos_cortex, extract_todos_cortex)\n            return {\"success\": \"Process started\"}, 200\n    [...]\n

  • A cortex (here background/app/models/cortex/extract_todos_cortex.py) is created. At construction, the cortex collects all database entries needed for further processing. This is done to avoid database connection out of main thread.

  • Then, the main function of the cortex, responsible for processing data (here extract_todos()) is called in an asynchronous way.

The method extract_todos() uses prompt data/prompts/background/todos/extract_todos.txt\u2013 filled with all tasks data to extract To-Dos out of completed task. Notable instructions of this prompt are:

  • Extraction instruction: To define what is a To-Do. 

    [...]\nExtract any todo the user mentioned in the task as next steps they have to take.\nThose todos describes actions the user will have to do in the future. They cannot be passive.\n[...]\n

  • Explicitely-mentioned only instruction: To avoid any hallucination from the agent. 

    [...]\nExtract ONLY next steps the user explicitly mentioned in the task.\n[...]\n

  • Assigned-only instruction: To avoid including To-Dos' that could be assigned to the user's contact in an email task or other participant mentioned in a meeting minutes, for example. 

    [...]\nExtract ONLY next steps assigned to the user.\n[...]\n

The result of the prompt is a json list of dictionnary defining To-Do items. 

{\n    \"todo_definition\": \"<Definition as it will be displayed in the user's todo list.\n        The definition should help the user remember what was the original task.\n        Mention any name, company,... that can help them get the context.>\",\n    \"mentioned_as_todo\": <Did the user explicitly mentioned this as a todo? yes/no>,\n    \"due_date\": \"<Date at which the todo will be displayed in user's todo list. Format yyyy-mm-dd>\"\n}\n

This json is parsed and items are added to the database, related to the task.

"},{"location":"design-principles/to-do_list/how_todo_works/#2-organize","title":"2. Organize","text":"

Another hourly trigger of the scheduler takes care of reorganizing user's To-Do list every night to keep it up-to-date.

from scheduled_tasks.reschedule_todos import RescheduleTodos\n[...]\nRescheduleTodos(3600) # reschedule todos every 1 hour\n[...]\n

This trigger calls Mojodex's backend route /todo_scheduling to retrieve all To-Dos items that: - Belongs to a user whose local time is between 1am and 2am - Has not been deleted, nor completed - Was due for the day before

Each of those To-Dos are sent to the background using route /reschedule_todos for processing.

Here, the route uses cortex backend/app/models/cortex/reschedule_todo_cortex.py to process the data. The main function of the cortex, responsible for processing data is reschedule_todo.

It uses prompt data/prompts/background/todos/reschedule_todo.txt provided with: - related task data - To-Do item along with the number of times it has already been rescheduled and - User's To-Do list in upcoming days

[...]\nRegarding the TASK, TODO ITEM and USER TODO LIST, decide when to reschedule the TODO ITEM for later.\nThe task was currently scheduled for yesterday.\nProvide the new scheduled date.\n[...]\n

This prompt outputs a json answer that can be parsed so that a new scheduling can be added to database.

"},{"location":"design-principles/to-do_list/how_todo_works/#3-remind-the-user","title":"3. Remind the user","text":"

Here comes Mojodex's scheduler again with another hourly trigger.

/scheduler/app/main.py 

from scheduled_tasks.purchase_expiration_checker import PurchasesExpirationChecker\n[...]\nemails = 'AWS_ACCESS_KEY_ID' in os.environ and os.environ['AWS_ACCESS_KEY_ID']\nif emails:\n    [...]\n    SendTodoDailyEmails(3600) # send todo daily emails every 1 hour (filtered by timezone)\n[...] \n

Note that this trigger is only activated if the environment variable AWS_ACCESS_KEY_ID is set. This variable is used to send emails through AWS SES, only emails mechanism implemented in Mojodex for now.

This triggers calls Mojodex's backend route /todo_daily_emails to retrieve all users whose local time is DAILY_TODO_EMAIL_TIME (defined in env vars see: .env.example).

For each of those users, the assistant will collect all To-Dos that are due for the coming day + the re-organization work it has done (cf step 4) and send those data to the background using route events_generation with parameter 'event_type': 'todo_daily_emails'.

The background uses its TodoDailyEmailsGenerator (background/app/models/events/todo_daily_emails_generator.py) with prompt data/prompts/engagement/emails/todo_daily_emails_text_prompt.txt to draft a friendly reminding emails to send to the user from provided data.

Once an email is ready, the background sends it to the backend using route /event with parameters so that the backend sends the email to the user using AWS SES and logs it to the database.

backend/app/routes/event.py 

[...]\nmojo_mail_client.send_email(subject=subject,\n                            recipients=[email],\n                            html_body=body)\n# add notification to db\nemail_event = MdEvent(creation_date=datetime.now(), event_type=event_type,\n                        user_id=user_id,\n                        message=message)\ndb.session.add(email_event)\ndb.session.commit()\n[...]\n

"},{"location":"design-principles/to-do_list/how_todo_works/#4-user-actions","title":"4. User actions","text":"

Users can of course also act on their own To-Dos. For now, they can take 2 actions: - Delete a To-Do item, if it was not relevant to add it or the assistant made any mistake. As any application call, this call is made to the backend and the route is DELETE /todo.

Note: an item is never deleted for real in the database. It is only marked as deleted so that it does not appear in the user's To-Do list anymore. This is to keep track of all the work the assistant has done. backend/app/routes/todo.py 

class Todos(Resource):\n    [...]\n    def delete(self, user_id):\n        [...]\n        todo.deleted_by_user = datetime.now()\n        db.session.commit()\n        [...]\n

  • Mark a To-Do as completed as soon as they don't need it anymore to remember of the work they have to do. As any application call, this call is made to the backend and the route is POST /todo. backend/app/routes/todo.py 
    class Todos(Resource):\n    [...]\n    def post(self, user_id):\n        [...]\n        todo.completed = datetime.now()\n        db.session.commit()\n        [...]\n

Note: find every API specification in the Backend API documentation and the Background API documentation

"},{"location":"design-principles/to-do_list/whats_a_todo/","title":"What's a to-do?","text":""},{"location":"design-principles/to-do_list/whats_a_todo/#to-do","title":"To-Do","text":"

A To-Do item is some work the user has to tackle later.

"},{"location":"design-principles/to-do_list/whats_a_todo/#why","title":"Why?","text":"

This feature was thought to be the sparkle of proactivity in Mojodex. The idea is that your assistant manages your To-Do list seamlessly while you're tackling your task with its help.

The vision of the todo-list feature is to manage itself without you having to think about it.

"},{"location":"design-principles/to-do_list/whats_a_todo/#mojodex-usage","title":"Mojodex usage","text":""},{"location":"design-principles/to-do_list/whats_a_todo/#generating-to-dos-items","title":"Generating to-dos items","text":"

When running a task on Mojodex, user may mention some next steps it has to take regarding this task.

Example: - get in touch in 3 days - send follow-up email - prepare a quote ...

Once the task is done, the assistant will extract any mentionned next step, turn it into a to-do item and organize it in user's to-do list.

"},{"location":"design-principles/to-do_list/whats_a_todo/#to-do-list-extracted-from-achieved-tasks","title":"To-do list extracted from achieved tasks","text":"

This way, in their to-do list, users can access the list of any work to-do mentioned to their assistant while working on tasks. Users can manage their to-do list by deleting items that might not be relevant or marking some as completed as soon as they have worked on it.

Each to-do item comes with a \"scheduled_date\", representing the deadline to achieve this work. This date is defined by the assistant at to-do creation.

"},{"location":"design-principles/to-do_list/whats_a_todo/#proactive-organization-organize-remind-the-user","title":"Proactive organization: Organize & Remind the user","text":"

For users not to forget their pending work, a daily email is sent to them every morning containing:

  • The list of to-do items due for the day
  • An eventual summary of the re-organization work done by the assistant during the night

Re-organization consists in re-scheduling for later any to-do items that should have been achieved by the day before but have not been marked as completed.

"},{"location":"design-principles/to-do_list/whats_a_todo/#user-action","title":"User action","text":"

User keeps control on their To-Do list by: - Deleting items that might not be relevant - Marking some as completed as soon as they have worked on it

"},{"location":"design-principles/to-do_list/whats_a_todo/#to-go-further","title":"To go further","text":"

Learn how the todo-list feature works in the technical documentation

"},{"location":"design-principles/workflows/execute_workflow/","title":"Workflow Execution Workflow in Mojodex","text":"

This document provides an overview of the concept related to the workflow execution process in the Mojodex platform and describes the sequence of events that occur from the moment a user initiates a new workflow execution until the workflow is completed and the result is delivered.

"},{"location":"design-principles/workflows/execute_workflow/#main-concepts","title":"Main concepts","text":"

The workflow execution process involves several concepts matching database tables.

"},{"location":"design-principles/workflows/execute_workflow/#workflow","title":"Workflow","text":"
  • Workflow concept is fully described in this doc. Basically, a worflow is a some complex process the assistant can help the user with. A workflow is fully configurable.
"},{"location":"design-principles/workflows/execute_workflow/#workflow-step","title":"Workflow Step","text":"
  • A workflow_step is a single step in a workflow. It is made of {input specification, execute method, output specification}. The execute method is the core of the step, it is where the step does its job. The input and output specification are used to validate the input and output of the step. A step can be run multiple times in a workflow, with different inputs and outputs.
"},{"location":"design-principles/workflows/execute_workflow/#user-workflow","title":"User Workflow","text":"
  • Each user has its own set of workflows it can launch with Mojodex. A user_workflow stands for the association between a user and a workflow.
"},{"location":"design-principles/workflows/execute_workflow/#user-workflow-execution","title":"User Workflow Execution","text":"
  • A user_workflow_execution represents the instance of a workflow being executed by a user. It captures various details such as the start time and any relevant metadata pertaining to the execution of a specific workflow by a user.

Note, sometimes refered as workflow_execution for short.

"},{"location":"design-principles/workflows/execute_workflow/#user-workflow-execution-step-execution","title":"User Workflow Execution Step Execution","text":"
  • A user_workflow_execution_step_execution represents the instance of a step being executed within a workflow execution.
"},{"location":"design-principles/workflows/execute_workflow/#session","title":"Session","text":"
  • A session represents an interaction between the user and the assistant. It captures the messages exchanged between the user and the assistant, as well as the state of the conversation at any given time. A user_workflow_execution always needs a session for the user and its assistant to co-work on the workflow.
"},{"location":"design-principles/workflows/execute_workflow/#message","title":"Message","text":"
  • A message represents a single message exchanged between the user and the assistant within a session. It captures the content of the message, sender, timestamp of the message, and other relevant metadata depeding on the type of message. In the database, a json field is used to store the content of the message, allowing high flexibility regarding stored data.
"},{"location":"design-principles/workflows/execute_workflow/#workflow-execution-workflow","title":"Workflow execution workflow","text":"

The workflow execution workflow is a sequence of events that occur from the moment a user initiates a new workflow execution until the workflow is completed. The workflow is described below.

"},{"location":"design-principles/workflows/execute_workflow/#1-user-workflow-execution-creation","title":"1. User Workflow Execution Creation","text":"

Creation of execution is done as soon as the user hits the card of the workflow they want to create.

This generates a call to PUT /user_workflow_execution to the backend (backend/app/routes/user_workflow_execution.py), specifying the user_workflow the user wants to execute. This call creates a User Workflow Execution instance in the database and a session if not already exists (which is the case in current Mojodex implementations).

from mojodex_core.entities.db_base_entities import MdUserWorkflowExecution\n[...]\nclass UserWorkflowExecution(Resource):\n    [...]\n    def put(self, user_id): \n        [...]\n        session_creation = self.session_creator.create_session(user_id, platform, \"form\")\n        [...]\n        session_id = session_creation[0][\"session_id\"]\n        [...]\n        db_workflow_execution = MdUserWorkflowExecution(\n                user_workflow_fk=user_workflow_pk,\n                session_id=session_id,\n                json_inputs=empty_json_input_values\n            )\n        db.session.add(db_workflow_execution)\n        db.session.commit()\n

This call also returns a json representation of the workflow, including json_inputs_spec to display to the user in the interface so that user have the instructions to start. Those input fields are the one defined in the workflows's json configuration file as json_inputs_spec.

return {\n           \"workflow_name_for_user\": \"<workflow_name_for_user>\",\n           \"workflow_definition_for_user\": \"<workflow_definition_for_user>\",\n           \"user_workflow_execution_pk\": < pk >,\n\"user_workflow_fk\": < fk >,\n\"steps\": [{\n              \"workflow_step_pk\": < workflow_step_pk >,\n          \"step_name_for_user\": \"<step_name_for_user>\",\n\"step_definition_for_user\": \"<step_definition_for_user>\"\n}, ...],\n\"validated_steps_executions\": [step_execution.to_json() for step_execution in\n                               self.past_accepted_steps_executions],\n\"session_id\": < session_id >,\n\"inputs\": < json_inputs >\n}\n
"},{"location":"design-principles/workflows/execute_workflow/#2-user-workflow-execution-start","title":"2. User Workflow Execution Start","text":"

From those instructions, there are 2 ways to start the workflow:

"},{"location":"design-principles/workflows/execute_workflow/#21-user-workflow-execution-start-from-filled-form","title":"2.1. User Workflow Execution Start from filled form","text":"

This is the method used in the web interface. The user fills the form and submit it. This generates a call to POST /user_workflow_execution to the backend (backend/app/routes/user_workflow_execution.py), specifying the user_workflow_execution_pk received at previous step and the values of filled form.

Resource associated to the route updates the User Workflow Execution instance and instanciate a Python object WorkflowExecution. Finally, it launches in a parallel thread the start of the workflow by running workflow.run method.

[...]\nclass UserWorkflowExecution(Resource):\n    [...]\n    def post(self, user_id):\n        [...]\n        db_workflow_execution.json_inputs = json_inputs\n        flag_modified(db_workflow_execution, \"json_inputs\")\n        db_workflow_execution.start_date = datetime.now()\n        db.session.commit()\n\n        workflow_execution = WorkflowExecution(user_workflow_execution_pk)\n\n        server_socket.start_background_task(workflow_execution.run)\n        [...]\n

The WorkflowExecution is the epicenter of workflow execution. The function run() will: - Determine what is the current step to run with what parameter and create the corresponding step execution object. - Run current step - Ask for user validation once the step is executed

The Workflow Execution detailled flow is described in part 3.

"},{"location":"design-principles/workflows/execute_workflow/#22-user-workflow-execution-start-from-user-message","title":"2.2. User Workflow Execution Start from user message","text":"

TODO - NOT IMPLEMENTED YET

"},{"location":"design-principles/workflows/execute_workflow/#3-workflow-execution","title":"3. Workflow Execution","text":"

A Workflow Execution is a Python object that manages the execution of a workflow. It corresponds to a user_workflow_execution in the database. It has a list of WorkflowStepExecution objects, one for each step of the workflow. The current step to run is determined by the _get_current_step() method.

The entry point of the workflow execution is the run method of the WorkflowExecution class. This method is called in a parallel thread when the user starts the workflow execution or when a step needs to be executed (because of user validation or because of a user instruction to re-execute).

class WorkflowExecution:\n    [...]\n    def run(self):\n        [...]\n        if not self._get_current_step():\n            return\n        self._get_current_step().execute(self.initial_parameters, self._past_validated_steps_results, self.db_object.session_id)\n        self._ask_for_validation()\n    [...]\n
"},{"location":"design-principles/workflows/execute_workflow/#31-determining-current_step","title":"3.1 Determining current_step","text":"

The _get_current_step() method determines the current step to run:

class WorkflowExecution:\n    [...]\n    def _get_current_step(self):\n        [...]\n            if self._current_step: # if current step already determined, return it\n                return self._current_step\n            if not self.validated_steps_executions: # no step validated yet, start from first step\n                self._current_step = self._generate_new_step_execution(self._db_workflow_steps[0], self.initial_parameters) # of first step\n                return self._current_step\n\n            last_validated_step_execution = self.validated_steps_executions[-1]\n\n            if len(self.validated_steps_executions) > 1: # no dependency as it was the first step\n                db_dependency_step = [...]\n                # depency step is the workflow_step of step execution that created last_validated_step_execution inputs\n                # It is the workflow_step ranked just before the last_validated_step_execution's workflow_step in the workflow\n\n                # find last execution of dependency step\n                db_dependency_step_execution = [...]\n\n                # How many parameters have been executed and validated for last_validated_step_execution's workflow_step?\n                current_step_executions_count = [...]\n\n                # have all parameters resulting from db_dependency_step_execution been executed and validated?\n                if current_step_executions_count < len(db_dependency_step_execution.result):\n                    current_parameter = db_dependency_step_execution.result[current_step_executions_count]\n                    self._current_step = self._generate_new_step_execution(last_validated_step_execution.workflow_step, current_parameter)\n                    return self._current_step\n\n            # else, generate new step execution of next step\n            next_step = [...]\n            if next_step is None:\n                return None # end of workflow\n            # else\n            self._current_step=self._generate_new_step_execution(next_step, last_validated_step_execution.result[0])\n            return self._current_step\n            [...]\n
"},{"location":"design-principles/workflows/execute_workflow/#33-executing-a-step","title":"3.3 Executing a step","text":"

Executing a step consists in executing the step on a certain parameter as input. A socketio message is sent to client before starting execution to update the client interface.

class WorkflowExecution:\n    [...]\n    def execute(self, initial_parameter: dict, past_validated_steps_results: List[dict], session_id: str):\n        [...]\n            step_json = self.to_json()\n            step_json[\"session_id\"] = session_id\n            server_socket.emit('workflow_step_execution_started', step_json, to=session_id)\n            self.result = self.workflow_step.execute(self.parameter, self.get_learned_instructions(), initial_parameter, past_validated_steps_results)\n        [...]\n
"},{"location":"design-principles/workflows/execute_workflow/#34-asking-for-validation","title":"3.4 Asking for validation","text":"

Once the step execution is done, the user is asked to validate the result. This is done by sending a socketio message to the client application: 

def _ask_for_validation(self):\n        [...]\n        step_execution_json = self._get_current_step().to_json()\n        step_execution_json[\"session_id\"] = self.db_object.session_id\n        server_socket.emit('workflow_step_execution_ended', step_execution_json, to=self.db_object.session_id)\n        [...]\n

"},{"location":"design-principles/workflows/execute_workflow/#4-user-validation","title":"4. User validation","text":""},{"location":"design-principles/workflows/execute_workflow/#41-user-validates","title":"4.1. User validates","text":"

If the user validates the result of the run, the route POST /user_workflow_execution_step_executionis called with value validated set to True. This route updates the user_workflow_execution_step_execution instance in the database and triggers the next step execution with workflow.run in a dedicated thread. 

class UserWorkflowStepExecution(Resource):\n    [...]\n    def post(self, user_id):\n        [...]\n        workflow_execution = WorkflowExecution(user_workflow_execution.user_workflow_execution_pk)\n        if validated:\n            workflow_execution.validate_step_execution(user_workflow_step_execution_pk)\n            server_socket.start_background_task(workflow_execution.run)\n        [...]\n

"},{"location":"design-principles/workflows/execute_workflow/#42-user-does-not-validate","title":"4.2. User does not validate","text":"

If the user does not validate the result of the run, the route POST /user_workflow_execution_step_executionis called with value validated set to False. This route adds a system message in the workflow execution's session to store a view of the workflow state at this point in the conversation. This message contains the achieved step until current checkpoint and the current steps executions after current checkpoints (steps that can still be re-executed).

Then, the user will send a message using common route PUT user_message. This message will be eventually transcripted if it was audio and transfer to a session through method process_chat_message.

The process chat message will decode the message and send it to WorflowResponseGeneratorlocated in backend/app/models/session/assistant_message_generators. This class will generate the assistant response to user request from on going workflow's conversation (including the system messages).

The goal of the assistant is to capture the new user instruction to re-execute the step with the same input but a new orientation. To do that, the LLM can answer with 3 types of tags:

  • : If the user asked the assistant to edit something in ACHIEVED STEPS, the assistant will explain why it is not possible to edit this past checkpoint steps.
  • : If the user is not clear enough in its request for re-execution, the assistant will ask for clarification until it gets a clear instruction.
  • coming along with : once the assistant caught the user instruction, it will respond by encapsulating the user instruction in a tag and add a message to inform the user that the instruction has been taken into account into tag.

    Once the assistant capture the user instruction, it will: - Invalidate the step - Launch a new run of the workflow in a dedicated thread

    The invalidation method is as follow: 

    class WorkflowExecution:\n    [...]\n    def invalidate_current_step(self, learned_instruction):\n        [...]\n        current_step_in_validation = self._get_last_step_execution() # the step execution we went to invalidate is the last one\n        current_step_in_validation.invalidate(self.db_object.session_id) # set validated to False in database and send socketio message to client\n\n        if current_step_in_validation.workflow_step.is_checkpoint: # if this step is the checkpoint, it is the one that will learn from this failure\n            current_step_in_validation.learn_instruction(learned_instruction)\n            return\n\n        # If the step in validation is not a checkpoint, find the previous one that is a checkpoint\n        checkpoint_step = self._find_checkpoint_step()\n        # for all step in self.validated_steps_executions after checkpoint_step, invalidate them\n        checkpoint_step_index = self.validated_steps_executions.index(checkpoint_step)\n        for validated_step in self.validated_steps_executions[checkpoint_step_index:]:\n            validated_step.invalidate(self.db_object.session_id)\n            # remove from validated_steps_executions\n            self.validated_steps_executions.remove(validated_step)\n\n        # checkpoint_step learns from this failure\n        checkpoint_step.learn_instruction(learned_instruction)\n

    "},{"location":"design-principles/workflows/whats_a_workflow/","title":"TODO","text":""},{"location":"guides/","title":"Getting Started","text":"

    This is a step-by-step guide for teams to get started with Mojodex. It is designed to help you understand the platform and how to use it effectively.

    "},{"location":"guides/#1-set-up-a-small-team","title":"1. Set up a small team","text":"
    • Iterate and try existing pre-configurations of Mojodex
    • Gain a sense of how Mojodex works
    "},{"location":"guides/#2-work-internally-with-company-teams","title":"2. Work internally with company teams","text":"
    • Define jobs and tasks where Mojodex will be most helpful
    • Collaborate with team members to build dedicated tasks
    "},{"location":"guides/#3-deploy-mojodex-in-the-companys-environment","title":"3. Deploy Mojodex in the company's environment","text":"
    • Choose between private cloud, on-premise, or internal servers
    "},{"location":"guides/#4-review-and-improve-tasks-regularly","title":"4. Review and improve tasks regularly","text":"
    • Tweak existing tasks based on team feedback
    • Work with team members to go deeper into task customization
    "},{"location":"guides/#5-create-new-tasks-tailored-to-each-teams-needs","title":"5. Create new tasks tailored to each team's needs","text":"
    • Start with generic tasks (80% of initial Mojodex usage)
    • After 1-2 months, tailored tasks should represent 80% of usage
    "},{"location":"guides/#6-gradually-refine-the-process","title":"6. Gradually refine the process","text":"
    • Continuously improve Mojodex's effectiveness for each team
    • Adapt tasks to better suit the team's requirements
    "},{"location":"guides/#what-level-of-effort-is-required-to-implement-a-digital-assistant-platform","title":"What level of effort is required to implement a digital assistant platform?","text":"

    Here's a breakdown of what is required:

    Effort Team Description Resources Medium Management Define the high level goals and scope of the project \u2013 process optimization, reducing mental load, increase productivity, etc. \u2013 and the User Team See the Guides Medium Management + User Team Define the metrics to measure the success of the project. See the Guides High User Team Define the tasks the assistant will help with. Step by Step Guide for Teamwork Low Tech Team Deploy the Mojodex platform. See install from GitHub in 3 steps Medium Tech Team + User Team Iterate on the configuration of the assistant. See the Sales Assistant Example"},{"location":"guides/azure-deployment/","title":"Azure deployment","text":""},{"location":"guides/azure-deployment/#services","title":"Services","text":"

    To deploy Mojodex on Azure Cloud, here is a list of required services:

    "},{"location":"guides/azure-deployment/#azure-container-registry","title":"Azure Container Registry","text":"

    Your registry will contain the Docker images of Mojodex: - backend - background - webapp

    "},{"location":"guides/azure-deployment/#app-service-plan","title":"App Service Plan","text":"

    The App Service Plan will be useful to create 3 App Services - cf next section.

    "},{"location":"guides/azure-deployment/#app-services","title":"App Services","text":"

    3 App Services will be created: - backend - background - webapp

    "},{"location":"guides/azure-deployment/#container-instances","title":"Container instances","text":"

    A container instance will be created to run the scheduler.

    "},{"location":"guides/azure-deployment/#storage-account-file-share","title":"Storage Account (File Share)","text":"

    A storage account will be used as volume for the backend and background services. It will store data as: - translation files - logs - users dataset

    "},{"location":"guides/azure-deployment/#postgresql-flexible-server","title":"PostgreSQL flexible server","text":"

    A PostgreSQL flexible server will be used for Mojodex database.

    "},{"location":"guides/azure-deployment/#deploying-on-azure-for-the-first-time","title":"Deploying on Azure for the first time","text":""},{"location":"guides/azure-deployment/#pre-requesites","title":"Pre-requesites","text":"
    • Install Azure CLI
    • Login to your Azure account 
      az login\n
    • Set your active subscription 
      az account set --subscription <subscription_id>\n

    To deploy on Azure for the first time, we've made a script for you. Here is the process:

    1. Check environment variables defined in deployment/azure_env_variables files. Set your secrets.
    2. Copy file models.conf.example to models.conf and set your own models providers credentials.
    3. In the script deployment/azure_deployment_script.sh, check that every names and sku fit your needs.
    4. Launch the script from deployment folder 
      cd deployment\nsh azure_deployment_script.sh\n

    You will be prompted for: - DATABASE password - Scheduler secret Other secrets are defined in environment variables files.

    After the script is done, you may have to restart the services from the portal to ensure everything is up and running with full configuration. When everything is up, you can access the webapp from its url.

    "},{"location":"guides/azure-deployment/#updating-the-existing-azure-deployment","title":"Updating the existing Azure deployment","text":"

    The documentation to update your existing Azure deployment is available in deployment/azure-deployment-commands.md once you've run the first deployment script.

    "},{"location":"guides/products/new_product/","title":"Create a new product","text":"

    Read What's a product documentation before creating a new product.

    "},{"location":"guides/products/new_product/#creating-a-product-category","title":"Creating a product category","text":"

    • STEP 1: Create the json file 

      cp ./docs/guides/products/product_category_spec.json ./docs/guides/products/products_json/my_product_category.json\n
      Fill the json values of my_product_category.json with the ones fitting your need for this product category.

    • STEP 2: Add the product category to the database Replace <BACKOFFICE_SECRET> with your actual token and run the following command in your terminal

    curl -X 'PUT' \\\n  'http://localhost:5001/product_category' \\\n  -H 'Authorization: <BACKOFFICE_SECRET>' \\\n  -H 'accept: application/json' \\\n  -H 'Content-Type: application/json' \\\n  -d @./docs/guides/products/products_json/my_product_category.json\n
    "},{"location":"guides/products/new_product/#creating-a-product","title":"Creating a product","text":"
    • STEP 1: Create the json file 
      cp ./docs/guides/products/product_spec.json ./docs/guides/products/products_json/my_product.json\n

    Fill the json values of my_product.json with the ones fitting your need for this product.

    • STEP 2: Add the product to the database Replace <BACKOFFICE_SECRET> and <product_category_pk> with the previously created category pk and run the following command in your terminal:
    curl -X 'PUT' \\\n  'http://localhost:5001/product' \\\n    -H 'Authorization: <BACKOFFICE_SECRET>' \\\n    -H 'accept: application/json' \\\n    -H 'Content-Type: application/json' \\\n    -d @./docs/guides/products/products_json/my_product.json\n

    Remember a product category must have 1 free trial product (as defined in the What's a product documentation). This product will be the one associated by default to users selecting the category at onboarding. If no free trial product is defined, the users will encounter an error at onboarding.

    "},{"location":"guides/products/new_product/#associating-tasks-to-the-product","title":"Associating tasks to the product","text":"

    Now that your product is created, you need to associate the tasks to the product. For each task you want to associate, run the following command in your terminal: 

    curl -X 'PUT' \\\n  'http://localhost:5001/product_task_association' \\\n  -H 'Authorization: <BACKOFFICE_SECRET>' \\\n    -H 'accept: application/json' \\\n    -H 'Content-Type: application/json' \\\n    -d '{\n    \"datetime\": \"2024-02-14T11:00:00.000Z\",\n    \"product_pk\": <product_pk>,\n    \"task_pk\": <task_pk>\n}'\n

    "},{"location":"guides/products/new_product/#affecting-the-product-to-a-user","title":"Affecting the product to a user","text":""},{"location":"guides/products/new_product/#new-user","title":"New user","text":"

    A new user ccreating an account on Mojodex will go through an onboarding process. During this process, the user will be asked to select a product category. This category will define the user's profile and will automatically affect them the free trial product of this category.

    "},{"location":"guides/products/new_product/#existing-user","title":"Existing user","text":""},{"location":"guides/products/new_product/#manually-by-an-admin","title":"Manually by an admin","text":"

    An admin can affect a product to a user using the backoffice APIs. To do so, run the following command in your terminal: 

    curl -X 'PUT' \\\n  'http://localhost:5001/manual_purchase' \\\n  -H 'Authorization: <BACKOFFICE_SECRET>' \\\n  -H 'accept: application/json' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\n  \"datetime\": \"2024-02-14T11:53:58.771Z\",\n  \"user_id\": \"<user_id>\",\n  \"product_pk\": <product_pk>,\n  \"custom_purchase_id\": \"string\"\n}'\n

    Remember, a user can't have 2 active subscriptions at the same time. If a user is affected with a new subscription, the previous one is automatically cancelled.

    "},{"location":"guides/products/new_product/#buying-a-product-using-an-implemented-payment-service","title":"Buying a product using an implemented payment service","text":"

    The user can also buy a product using Stripe or Apple in-app purchase flow, detailed in the How it works documentation.

    "},{"location":"guides/profiles/new_profile/","title":"Create a new profile","text":"

    Read What's a profile documentation before creating a new profile.

    "},{"location":"guides/profiles/new_profile/#creating-a-profile-category","title":"Creating a profile category","text":"

    • STEP 1: Create the json file 

      cp ./docs/guides/profiles/profile_category_spec.json ./docs/guides/profiles/profiles_json/my_profile_category.json\n
      Fill the json values of my_profile_category.json with the ones fitting your need for this profile category.

    • STEP 2: Add the profile category to the database Replace <BACKOFFICE_SECRET> with your actual token and run the following command in your terminal

    curl -X 'PUT' \\\n  'http://localhost:5001/profile_category' \\\n  -H 'Authorization: <BACKOFFICE_SECRET>' \\\n  -H 'accept: application/json' \\\n  -H 'Content-Type: application/json' \\\n  -d @./docs/guides/profiles/profiles_json/my_profile_category.json\n
    "},{"location":"guides/profiles/new_profile/#creating-a-profile","title":"Creating a profile","text":"
    • STEP 1: Create the json file 
      cp ./docs/guides/profiles/profile_spec.json ./docs/guides/profiles/profiles_json/my_profile.json\n

    Fill the json values of my_profile.json with the ones fitting your need for this profile.

    • STEP 2: Add the profile to the database Replace <BACKOFFICE_SECRET> and <profile_category_pk> with the previously created category pk and run the following command in your terminal:
    curl -X 'PUT' \\\n  'http://localhost:5001/profile' \\\n    -H 'Authorization: <BACKOFFICE_SECRET>' \\\n    -H 'accept: application/json' \\\n    -H 'Content-Type: application/json' \\\n    -d @./docs/guides/profiles/profiles_json/my_profile.json\n
    "},{"location":"guides/profiles/new_profile/#associating-tasks-to-the-profile","title":"Associating tasks to the profile","text":"

    Now that your profile is created, you need to associate the tasks to the profile. For each task you want to associate, run the following command in your terminal: 

    curl -X 'PUT' \\\n  'http://localhost:5001/profile_task_association' \\\n  -H 'Authorization: <BACKOFFICE_SECRET>' \\\n    -H 'accept: application/json' \\\n    -H 'Content-Type: application/json' \\\n    -d '{\n    \"datetime\": \"2024-02-14T11:00:00.000Z\",\n    \"profile_pk\": <profile_pk>,\n    \"task_pk\": <task_pk>\n}'\n

    "},{"location":"guides/profiles/new_profile/#affecting-the-profile-to-a-user","title":"Affecting the profile to a user","text":""},{"location":"guides/profiles/new_profile/#manually-by-an-admin","title":"Manually by an admin","text":"

    An admin can affect a profile to a user using the backoffice APIs. To do so, run the following command in your terminal: 

    curl -X 'PUT' \\\n  'http://localhost:5001/manual_purchase' \\\n  -H 'Authorization: <BACKOFFICE_SECRET>' \\\n  -H 'accept: application/json' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\n  \"datetime\": \"2024-02-14T11:53:58.771Z\",\n  \"user_id\": \"<user_id>\",\n  \"profile_pk\": <profile_pk>,\n  \"custom_purchase_id\": \"string\"\n}'\n

    "},{"location":"guides/sales_assistant_example/","title":"Sales Assistant Configuration Example","text":"

    In this documentation, we will go through the process of configuring the Mojodex platform for a specific use case.

    Its adaptability to specific use cases is what makes Mojodex the perfect tool for businesses that want to create a digital assistant tailored to their needs while maintaining control over it.

    To illustrate the process, we will go through the Sales Assistant use case.

    The goal of the Sales Assistant is to help sales people to be more efficient in their daily tasks.

    We will start by defining the scope of the Sales Assistant and then describe the different tasks it can perform.

    "},{"location":"guides/sales_assistant_example/#what-you-will-learn","title":"What you will learn","text":"

    By the end, you will know how to: - lead discussions within your teams to define the Sales Assistant's scope - design the different tasks of the Sales Assistant - implement the configuration in your Mojodex instance - deploy and test the Sales Assistant

    "},{"location":"guides/sales_assistant_example/#1-define-the-sales-assistant-scope","title":"1. Define the Sales Assistant Scope","text":"

    In their job, sales people have to perform a lot of different tasks and work activities, as described in the O*NET OnLine - Sales Representatives \u2013 Detailed Job Description

    We want to select a subset of these tasks to facilitate with the Sales Assistant, to help sales people focus on their core activities.

    "},{"location":"guides/sales_assistant_example/#teamwork-to-define-the-scope","title":"Teamwork to define the scope","text":"

    To define the scope of the Sales Assistant, we will need to work with the sales team to understand their daily tasks and the challenges they face.

    We will need to ask them questions such as: - What are the most repeatable time-consuming tasks? - Where do you spend most of your time out of your core sales activities?

    \ud83d\udcc4 You can use the following template questionnaire to lead the discussion

    Sales Assistant Scope Template

    The result of this teamwork will provide a list of tasks that the team would like to facilitate.

    Assess their feasibility with Mojodex and prioritize them.

    Once you are ready, you can start to implement the Sales Assistant.

    We recommend to start with a few tasks and then iterate on the configuration.

    In the next section, you will find common sales assistant tasks that you can use as a starting point.

    "},{"location":"guides/sales_assistant_example/#starting-point","title":"Starting point","text":"

    We recommend the following tasks which are the most common and time-consuming for sales people:

    • Meeting Recap: The Sales Assistant will help sales people to recap the meetings they had with their leads.
    • Event Conversation Recap: The Sales Assistant will help sales people to recap the conversations they had with leads during events.
    • Follow-up Email: The Sales Assistant will help sales people to write follow-up emails to leads.
    "},{"location":"guides/sales_assistant_example/#2-designing-the-tasks","title":"2. Designing the tasks","text":"

    Now that we have a list of tasks, we want to design how Mojodex will facilitate them.

    For each task, you now have a sentence that describes what the team is expecting the Sales Assistant to do.

    Use the following route to prepare a task in JSON format for each task: 

    curl --location --request POST 'http://localhost:5001/task_json' \\\n--header 'Authorization: backoffice_secret' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\"datetime\": \"2024-02-14T17:49:26.545180\",\n\"task_requirements\": \"<task_description>\"\n}'\n

    You will need those JSON files for the next step: implementation

    "},{"location":"guides/sales_assistant_example/#3-implement-the-sales-assistant-configuration","title":"3. Implement the Sales Assistant Configuration","text":"

    With the scope and tasks designed, we can implement the configuration in Mojodex.

    "},{"location":"guides/sales_assistant_example/#31-setup-the-category","title":"3.1 Setup the category","text":"

    First, we need to setup the category for the Sales Assistant.

    \u2139\ufe0f See the environment setup documentation to get your token: .env.example

    BACKOFFICE_SECRET=<your_token>

    Replace <BACKOFFICE_SECRET> with your actual token and run the following command in your terminal 

    curl -X 'PUT' \\\n  'http://localhost:5001/product_category' \\\n  -H 'Authorization: <BACKOFFICE_SECRET>' \\\n  -H 'accept: application/json' \\\n  -H 'Content-Type: application/json' \\\n  -d '{ \\\n  \"datetime\": \"2024-02-14T10:46:15.283Z\", \\\n  \"label\": \"string\", \\\n  \"displayed_data\": [ \\\n    { \\\n      \"language_code\": \"en\", \\\n      \"name_for_user\": \"Sales\", \\\n      \"description_for_user\": \"Boosting sales? I've got your back!\" \\\n    } \\ \n  ], \\\n  \"emoji\": \"\ud83d\udcbc\", \\\n  \"implicit_goal\": \"Drive revenue growth by mastering sales interactions and fostering lasting client relationships.\" \\\n}'\n

    The terminal will return a response with the product_category_pk. We will need it for the next step.

    "},{"location":"guides/sales_assistant_example/#32-setup-the-product","title":"3.2 Setup the product","text":"

    Then, we need to setup the product for the Sales Assistant.

    Replace <BACKOFFICE_SECRET> and <product_category_pk> with the previously created category pk and run the following command in your terminal:

    curl -X 'PUT' \\\n  'http://localhost:5001/product' \\\n    -H 'Authorization: <BACKOFFICE_SECRET>' \\\n    -H 'accept: application/json' \\\n    -H 'Content-Type: application/json' \\\n    -d '{\n  \"datetime\": \"2024-02-14T10:53:06.502Z\",\n  \"product_label\": \"sales_assistant\",\n  \"displayed_data\": [\n    {\n      \"language_code\": \"en\",\n      \"name\": \"Sales Assistant\"\n    }\n  ],\n  \"product_category_pk\": <product_category_pk>,\n  \"is_free\": true,\n  \"n_days_validity\": 99999,\n  \"n_tasks_limit\": null\n}'\n

    We set a 99999 days (~273 years) duration for the product to avoid any expiration.

    "},{"location":"guides/sales_assistant_example/#33-setup-the-tasks","title":"3.3 Setup the tasks","text":""},{"location":"guides/sales_assistant_example/#331-create-the-tasks","title":"3.3.1 Create the tasks","text":"

    The tasks are described in the tasks folder of the repository. Each task is a JSON file that describes the task and its parameters.

    • Meeting Recap: Meeting Recap
    • Event Conversation Recap: Event Conversation Recap
    • Follow-up Email: Follow-up Email
    for task in tasks/*.json; do\n    curl -X 'PUT' \\\n        'http://localhost:5001/task' \\\n        -H 'Authorization: <BACKOFFICE_SECRET>' \\\n        -H 'accept: application/json' \\\n        -H 'Content-Type: application/json' \\\n        -d \"@$task\"\ndone\n

    The terminal will return a response with the task_pk for each task. We will need it for the next step.

    "},{"location":"guides/sales_assistant_example/#34-associate-the-tasks-to-the-product","title":"3.4 Associate the tasks to the product","text":"

    For each task created, we need to associate it to the product.

    Replace <BACKOFFICE_SECRET> and <task_pk> with each previously created task pk and run the following command in your terminal as many times as necessary:

    curl -X 'PUT' \\\n  'http://localhost:5001/product_task_association' \\\n  -H 'Authorization: <BACKOFFICE_SECRET>' \\\n    -H 'accept: application/json' \\\n    -H 'Content-Type: application/json' \\\n    -d '{\n    \"datetime\": \"2024-02-14T11:00:00.000Z\",\n    \"product_pk\": <product_pk>,\n    \"task_pk\": <task_pk>\n}'\n
    "},{"location":"guides/sales_assistant_example/#4-deploy-and-test-the-sales-assistant","title":"4. Deploy and test the Sales Assistant","text":"

    Now, the final part is to provide access to the Sales Assistant to the sales team.

    "},{"location":"guides/sales_assistant_example/#41-deployment-to-the-existing-users","title":"4.1 Deployment to the existing users","text":"

    To do so, we will provide access the sales team accounts to the Sales Assistant product.

    Run the following command for each user identified by their email:

    In a terminal, run the following command:

    \u2139\ufe0f Replace <BACKOFFICE_SECRET> , <product_pk> and <user_email> with the actual values.

    curl -X 'PUT' \\\n  'http://localhost:5001/manual_purchase' \\\n  -H 'Authorization: <BACKOFFICE_SECRET>' \\\n  -H 'accept: application/json' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\n  \"datetime\": \"2024-02-14T11:53:58.771Z\",\n  \"user_email\": \"demo@example.com\",\n  \"product_pk\": <product_pk>,\n  \"custom_purchase_id\": \"demo\"\n}'\n
    "},{"location":"guides/sales_assistant_example/#42-new-sales-team-members","title":"4.2 New sales team members","text":"

    For new sales team members, during the onboarding process, they will now have to choose the 'Sales Assistant' product, that we just created.

    "},{"location":"guides/sales_assistant_example/#future-work","title":"Future work","text":"
    • Integration with the CRM
    "},{"location":"guides/sales_assistant_example/sales_assistant_scope_template/","title":"Sales Assistant Team Guide","text":""},{"location":"guides/sales_assistant_example/sales_assistant_scope_template/#step-by-step-guide-to-defining-your-sales-assistants-scope","title":"Step-by-Step Guide to Defining Your Sales Assistant's Scope","text":""},{"location":"guides/sales_assistant_example/sales_assistant_scope_template/#introduction","title":"Introduction","text":"

    This guide is designed to help sales teams collaborate effectively to define the scope of their Sales Assistant, ensuring it provides the best possible support by facilitating tasks through assisted work.

    "},{"location":"guides/sales_assistant_example/sales_assistant_scope_template/#step-1-establish-the-teamwork-discussion-goal","title":"Step 1: Establish the Teamwork Discussion Goal","text":"

    Clarify the objective of your discussion with the sales team: to identify tasks that the Sales Assistant can facilitate, enhancing focus on core sales activities.

    "},{"location":"guides/sales_assistant_example/sales_assistant_scope_template/#step-2-prepare-for-the-discussion","title":"Step 2: Prepare for the Discussion","text":"

    Assemble all necessary documents and data to inform the discussion, such as sales performance metrics and current workflow analyses.

    "},{"location":"guides/sales_assistant_example/sales_assistant_scope_template/#step-3-conduct-the-teamwork-discussion","title":"Step 3: Conduct the Teamwork Discussion","text":"

    Facilitate a comprehensive meeting with the sales team to explore their daily activities and pinpoint tasks that could benefit from the support of the Sales Assistant. Utilize the following questions to guide the discussion:

    • \"What are the most repetitive tasks that you encounter daily, and how do you feel about them?\"
    • \"Which non-core sales activities take up a significant portion of your time?\"
    • \"Are there specific tasks during the sales process where you feel overwhelmed or that could be streamlined?\"
    • \"What kind of information do you find yourself repeatedly searching for during your workday?\"
    • \"Can you identify any tasks that, while necessary, distract you from engaging with clients and closing deals?\"
    • \"How much time do you spend on administrative work such as data entry, scheduling meetings, or writing emails?\"
    • \"What are the common bottlenecks in your workflow that slow down the sales process?\"
    • \"Are there any tools or resources you wish you had at your disposal to make your job easier?\"
    • \"Which part of the sales process do you think has the most room for improvement in terms of efficiency?\"
    • \"What are the tasks that you believe require your personal touch, and which ones could potentially be handled by an assistant?\"
    "},{"location":"guides/sales_assistant_example/sales_assistant_scope_template/#step-4-document-the-findings","title":"Step 4: Document the Findings","text":"

    Record all tasks and challenges identified during the discussion, ensuring every team member's input is captured.

    "},{"location":"guides/sales_assistant_example/sales_assistant_scope_template/#step-5-analyze-categorize-and-prioritize-tasks","title":"Step 5: Analyze, Categorize, and Prioritize Tasks","text":"

    Review the documented tasks and categorize them by nature and frequency. Instead of looking for automation opportunities, assess how Mojodex can assist and facilitate these tasks.

    "},{"location":"guides/sales_assistant_example/sales_assistant_scope_template/#step-6-develop-a-prioritization-methodology","title":"Step 6: Develop a Prioritization Methodology","text":"

    Evaluate the facilitation potential of each task using key metrics such as time saved, error reduction, and sales impact. Create a table to visualize the assessment, like the example below:

    Task Frequency Time Saved Error Reduction Sales Impact Facilitation Potential Priority Qualifying Leads Daily High Medium High High 1 Meeting Recap Weekly Medium High Medium High 2 Follow-up Email Daily High Low High Medium 3 Event Conversation Recap Monthly Low Medium Low Medium 4"},{"location":"guides/sales_assistant_example/sales_assistant_scope_template/#step-7-describe-each-task-in-structured-paragraph","title":"Step 7: Describe each task in structured paragraph","text":"

    Now, use the following template to describe each task: 

    You are the sales assistant of the user. The user needs help to (achieve/do/perform) [...]. The user needs this help in the following situation: [...]. You will need the following informations to proceed: [...]. The result of the task is a[{document_type}]\n

    You can add details such as tone, style or format of the document if that's relevant for the task.

    This detailed paragraph is the entry point for the team in charge of the implementation to create the tasks.

    "},{"location":"guides/sales_assistant_example/sales_assistant_scope_template/#step-8-obtain-team-approval-and-finalize-the-scope","title":"Step 8: Obtain Team Approval and Finalize the Scope","text":"

    Present the prioritized list to the sales team for validation and finalize the scope based on their consensus. This finalized scope will direct the configuration of the Sales Assistant within Mojodex.

    By following this structured approach, you will be equipped with all the information to prepare a Sales Assistant that is precisely tailored to support and facilitate their most impactful tasks.

    "},{"location":"guides/tasks/example/","title":"Task creation example","text":"

    Let's say you want to create a specific task for your assistant. Here is an example of how to do it.

    We take a fictional example of a salesperson, Mia, who needs to assistance to refine her sales pitch.

    "},{"location":"guides/tasks/example/#crafting-the-perfect-sales-pitch-with-mojodex","title":"Crafting the Perfect Sales Pitch with Mojodex","text":""},{"location":"guides/tasks/example/#context","title":"Context","text":"

    In the bustling heart of a startup district, I recently crossed paths with Mia, a passionate salesperson navigating the turbulent seas of entrepreneurship. Over coffee and conversations, Mia confided in me her struggles. Amidst the dynamic landscape of ever-evolving offers, she found herself grappling with a persistent dilemma - how to keep her pitch razor-sharp without succumbing to the dreaded \"white page syndrome.\"

    "},{"location":"guides/tasks/example/#understanding-the-process","title":"Understanding the Process","text":"

    As we delved deeper, Mia unveiled the anatomy of her sales pitch:

    • Identifying the Problem: Articulating the core issue her company and product address.

    • Presenting the Solution: Conveying how her offering tackles the identified problem.

    • Highlighting Uniqueness: Showcasing what sets her company and product apart from competitors.

    • Defining the Target Market: Painting a vivid picture of the ideal customer.

    Additionally, Mia emphasized the need for brevity, stressing that her pitch must be succinct yet captivating, always concluding with a compelling question to spark dialogue.

    "},{"location":"guides/tasks/example/#crafting-the-task","title":"Crafting the Task","text":"

    Eager to assist Mia in her quest for the perfect pitch, I set out to create a tailored task on Mojodex. Drawing from our conversation, I meticulously crafted a task specification:

    "},{"location":"guides/tasks/example/#task-specification","title":"Task Specification","text":"
    {\n    \"platforms\": [\n        \"mobile\",\n        \"webapp\"\n    ],\n    \"predefined_actions\": [],\n    \"task_displayed_data\": [\n        {\n            \"language_code\": \"en\",\n            \"name_for_user\": \"1 Minute Pitch\",\n            \"definition_for_user\": \"Prepare a 1 minute pitch to briefly present your company and product\",\n            \"json_input\": [\n                {\n                    \"input_name\": \"company_and_product_informations\",\n                    \"description_for_user\": \"Let's make a great pitch!\",\n                    \"description_for_system\": \"Information about the company and product (ex: company background, product, target market, unique selling points)\",\n                    \"placeholder\": \"What problem are you solving? How do you solve it? What makes you different from other solutions? Who is your ideal customer?\",\n                    \"type\": \"text_area\"\n                }\n            ]\n        }\n    ],\n    \"name_for_system\": \"create_one_minute_pitch\",\n    \"definition_for_system\": \"The user needs assistance to create a 1-minute pitch for presenting their company and product\",\n    \"final_instruction\": \"Write a 1-minute pitch to briefly present the company and product; finish with a question to engage conversation.\",\n    \"output_format_instruction_title\": \"1 MINUTE PITCH - COMPANY NAME\",\n    \"output_format_instruction_draft\": \"PITCH CONTENT\",\n    \"output_type\": \"document\",\n    \"icon\": \"\ud83c\udfa4\",\n    \"infos_to_extract\": [\n        {\n            \"info_name\": \"problem_solved\",\n            \"description\": \"The problem the company and product are solving\"\n        },\n        {\n            \"info_name\": \"solution\",\n            \"description\": \"How the company and product solve the problem\"\n        },\n        {\n            \"info_name\": \"unique_selling_points\",\n            \"description\": \"What makes the company and product different from other solutions\"\n        },\n        {\n            \"info_name\": \"target_market\",\n            \"description\": \"The target market represented by an ideal customer description\"\n        }\n    ]\n}\n

    Note how:

    • The infos_to_extract lists all the information Mia - and now her assistant - needs to craft her pitch.

    • The final_instruction provides a clear directive to the assistant, ensuring the pitch is concise and ends with a question as Mia requested.

    • The user data are clear so that Mia easily finds the task and knows what to expect.

    With this JSON file carefuly crafted, I just need to use the REST API to update the task list in the database.

    \u2139\ufe0f You can see how to do this in the new_task section

    "},{"location":"guides/tasks/example/#tweak-it-until-the-user-love-it","title":"Tweak it until the user love it","text":"

    After a couple tries, Mia and I decided to tweak it a bit. We added a twist to the \"final_instruction\" to fit best with Mia's preferences.

    \u2139\ufe0f To update a task, refer to the backend REST API

    "},{"location":"guides/tasks/example/#conclusion","title":"Conclusion","text":"

    With the task configuration complete, I eagerly shared it with Mia through Mojodex.

    Now armed with a personalized tool perfectly aligned with her needs in her pocket with her Mojodex Mobile, Mia can effortlessly craft compelling pitches, leaving behind the days of writer's block and embracing the art of persuasive communication with confidence.

    "},{"location":"guides/tasks/new_task/","title":"Create a new task","text":""},{"location":"guides/tasks/new_task/#technical-definition","title":"Technical definition","text":"

    A task is a JSON object that contains all necessary information to render it in the app and to guide the assistant through the process of drafting the document resulting from the task. You can find a template of a task in the file task_spec.json in this repository.

    Let's break this specification down with \"meeting_minutes\" task as an example.

    "},{"location":"guides/tasks/new_task/#platforms","title":"Platforms","text":"

    \"platforms\": [\"mobile\"]\n
    Platforms on which the task is available. Can be \"webapp\", \"mobile\" or both.

    "},{"location":"guides/tasks/new_task/#system-information","title":"System information","text":"

    \"name_for_system\": \"prepare_meeting_minutes\",\n\"definition_for_system\": \"The user needs assistance to prepare a meeting minutes\"\n
    These fields are used by the system to defined tasks in prompts. name_for_system should be snake_case.

    "},{"location":"guides/tasks/new_task/#final-instruction","title":"Final instruction","text":"

    \"final_instruction\": \"Write a meeting minutes in the form of bullet points\"\n
    This is the final instruction provided to the assistant prompt. It contains all instruction the assistant will follow to draft the document. It ends with an infinitive verb sentence as if it was an order to the assistant.

    "},{"location":"guides/tasks/new_task/#output-format","title":"Output format","text":"

    \"output_format_instruction_title\": \"SHORT CONTEXT - DATE OF THE DAY\",\n\"output_format_instruction_draft\": \"CONTENT OF THE MEETING MINUTES\"\n
    These fields are used to define the format of the document resulting from the task. The assistant will use these instructions to format the document title and content.

    "},{"location":"guides/tasks/new_task/#output-type","title":"Output type","text":"

    \"output_type\": \"meeting_minutes\"\n
    This field is used to define the type of document resulting from the task. It is used to enable special edition features once the document is ready. The value should match one existing in table 'md_text_type' of your database, if it does not, will be created.

    "},{"location":"guides/tasks/new_task/#icon","title":"Icon","text":"

    \"icon\": \"\ud83d\udcdd\"\n
    The icon displayed in the app to represent the task.

    "},{"location":"guides/tasks/new_task/#task-displayed-data","title":"Task displayed data","text":"

    \"task_displayed_data\": [\n    {\n        \"language_code\": \"en\", \n        \"name_for_user\": \"Meeting Recap\",\n        \"definition_for_user\": \"Get a simple summary and next steps for your meeting\",\n        \"json_input\": [  \n            {\n                \"input_name\": \"meeting_informations\",\n                \"description_for_user\": \"How was your meeting?\",\n                \"description_for_system\": \"Informations the user gave about the meeting (ex: participants, date, key topics, followup actions...)\",\n                \"placeholder\": \"Record a quick summary of what was discussed.\",\n                \"type\": \"text_area\"\n            }\n        ]\n    },\n    {\n        \"language_code\": \"fr\",\n        \"name_for_user\": \"R\u00e9capitulatif de R\u00e9union\",\n        \"definition_for_user\": \"Obtenez un r\u00e9capitulatif simple de votre r\u00e9union\",\n        \"json_input\": [\n            {\n                \"description_for_system\": \"Informations que l'utilisateur a fournies sur la r\u00e9union (ex : participants, date, sujets cl\u00e9s, actions de suivi...)\",\n                \"description_for_user\": \"Comment s'est pass\u00e9e votre r\u00e9union ?\",\n                \"input_name\": \"informations_reunion\",\n                \"placeholder\": \"Enregistrez un bref r\u00e9sum\u00e9 de ce qui a \u00e9t\u00e9 discut\u00e9.\",\n                \"type\": \"text_area\"\n            }\n        ]\n    }\n]\n
    This field contains all data displayed to the user in the app. It is an array of objects, each object representing a language. You can add as many languages as you want but you have to define at least english as it will be used as a fallback if the user's language is not available. The object contains the following fields: - language_code: the language code of the language - name_for_user: the name of the task in the language as it will be displayed to the user - definition_for_user: the definition of the task in the language as it will be displayed to the user - json_input: an array of objects, each object representing an information the user has to provide to the assistant when starting a new task. - On the web app, it will be displayed as a form, one input per object. - On the mobile app, it will be displayed in a chat as questions. Each object contains the following fields: - input_name: the name of the input as it will be used in the assistant prompt - description_for_user: the description of the input as it will be displayed to the user - description_for_system: the description of the input as it will be used in the assistant prompt - placeholder: the placeholder of the input as it will be displayed to the user - type: the type of the input. Can be only \"text_area\" for now.

    Note: For mobile use to remain interface friendly, we recommend to keep the number of inputs to 1. If the assistant needs to ask more than one question, it will do it in a conversational way.

    "},{"location":"guides/tasks/new_task/#infos-to-extract","title":"Infos to extract","text":"

    \"infos_to_extract\": [\n    {\n        \"info_name\": \"key_topics\",\n        \"description\": \"Key topics discussed in the meeting\"\n    },\n    {\n        \"info_name\": \"participants\",\n        \"description\": \"Participants of the meeting\"\n    },\n    {\n        \"info_name\": \"date_of_meeting\",\n        \"description\": \"Date of the meeting\"\n    },\n    {\n        \"info_name\": \"followup_actions\",\n        \"description\": \"Followup actions if any\"\n    }\n]\n
    This field contains all the information the assistant needs to collect from the user before drafting the document. It is an array of objects, each object representing an information. Each object contains the following fields: - info_name: the name of the information as it will be used in the assistant prompt - description: the description of the information as it will be used in the assistant prompt

    "},{"location":"guides/tasks/new_task/#predefined_actions","title":"predefined_actions","text":"

    \"predefined_actions\": []\n
    Predefined actions will be covered in a coming documentation. Let's keep it empty for now.

    "},{"location":"guides/tasks/new_task/#how-to-create-a-new-task","title":"How to create a new task?","text":"

    Let's create your first task on Mojodex.

    From the root of the repository.

    STEP 1: Create the json file 

    cp ./docs/configure_assistant/tasks/task_spec.json ./docs/configure_assistant/tasks/tasks_json/my_task.json\n

    Fill the json values of my_task.json with the ones fitting your need for this task. You can get helped by using the dedicated route so that GPT-4 generates a first json for you from your requirements. 

    curl --location --request POST 'http://localhost:5001/task_json' \\\n--header 'Authorization: backoffice_secret' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\"datetime\": \"2024-02-14T17:49:26.545180\",\n\"task_requirements\": \"You are the sales assistant of the user. The user needs help to (achieve/do/perform) [...]. The user needs this help in the following situation: [...]. You will need the following informations to proceed: [...]. The result of the task is a[{document_type}]\"\n}'\n

    STEP 2: Add the task to the database 

    curl --location --request PUT 'http://localhost:5001/task' \\\n--header 'Authorization: backoffice_secret' \\\n--header 'Content-Type: application/json' \\\n--data @my_task.json\n
    This command calls the backend REST API to create the task in the database and returns the primary key of the task. You will need this primary key in next step.

    STEP 3: Associate the task to your user though a product.

    Default user demo@example.com is associated with default product demo with pk 1. Let's add the task to this product. 

    curl --location --request PUT 'http://localhost:5001/product_task_association' \\\n--header 'Authorization: backoffice_secret' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"datetime\": \"'\"$(date -u +\"%Y-%m-%dT%H:%M:%S.%3NZ\")\"'\",\n \"product_pk\": 1,\n \"task_pk\": <task_pk retrieved from previous command>\n}'\n

    STEP 4: Test your task

    Run your local Mojodex instance and access the web or mobile app.

    You should now see your task in the list of available tasks. If you don't, ensure to reload the app to get rid of any potential cache.

    "},{"location":"guides/users/new_user/","title":"Create a new user","text":"

    There are 2 ways for new users to be created: - Autonomous signup: The user creates an account on the platform using \"Sign up\" button. - Admin creation: An admin creates an account for the user using administration route.

    "},{"location":"guides/users/new_user/#autonomous-signup","title":"Autonomous signup","text":"

    When a user clicks the \"sign up\" button on Mojodex homepage, they are redirected to the sign up page. The user is asked to fill in the following information: - name - email - password

    Once the user has filled in the information, they click the \"sign up\" button and they are redirected to an onboarding process.

    1. They have to accept the terms and conditions if provided, else accept to be respectful when adressing the assistant.

    2. They have to choose a profile category. This will determine their profile and so the tasks they can access. (See docs/design-principles/profiles/whats_a_profile.md)

    3. They can provide their company website for a more personalized experience. This step is optional.

    Once they have completed the onboarding process, they are redirected to the dashboard. Their account is created and associated with a free product associated to the chosen category.

    "},{"location":"guides/users/new_user/#admin-creation","title":"Admin creation","text":"

    An admin can create a new user account by using dedicated administration routes. Here is the process:

    1. Create user account: You can get helped by using the dedicated route so that GPT-4 generates a first json for you from your requirements. 

      curl --location --request PUT 'http://localhost:5001/user' \\\n--header 'Authorization: backoffice_secret' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\"datetime\": \"2024-02-14T17:49:26.545180\",\n\"name\": \"user_name\",\n\"email\": \"user@email.com\",\n\"password\": \"user_temporary_password\",\n\"language_code\": \"en\",\n\"skip_user_validation\": true\n}'\n

    2. Affect a role to the user: 

      curl --location --request PUT 'http://localhost:5001/role' \\\n--header 'Authorization: backoffice_secret' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\"datetime\": \"2024-02-14T17:49:26.545180\",\n\"profile_pk\": 1,\n\"user_email\": \"user_email@email.com\"\n}'\n

    Once this is done, the user can log in with the temporary password and will directly access the dashboard. They can change their password using the \"forget password\" link on the login page.

    Note that this feature is available only if an email service has been set in configuration.

    "},{"location":"guides/workflows/new_workflow/","title":"Create a new workflow","text":""},{"location":"guides/workflows/new_workflow/#technical-definition","title":"Technical definition","text":"

    A workflow is a sequence of steps that the agent must execute one by one. Each step execution then requires a user validation before the agent can proceed to the next step. Compared to the tasks, the workflows are more complex and constrainted, allowing the user to keep more control over the agent's actions.

    "},{"location":"guides/workflows/new_workflow/#how-to-create-a-new-workflow","title":"How to create a new workflow?","text":"

    STEP 1: Create the steps' code In backend>app>models>workflows create a new folder named by your workflow. In this folder, create one file per step in your workflow. In each of those files, implement the crresponding step code. A workflow step is a class that implements the WorkflowStep class.

    An implementation of WorkflowStep looks like this: 

    from models.workflows.step import WorkflowStep        \n\nclass MyWorkflowStep(WorkflowStep):\n\n    @property\n    def definition_for_system(self):\n        return \"This is a definition of the step\" # Definition of the step as used in prompts\n\n    @property\n    def input_keys(self):\n        return ['input_key1', 'input_key2'] # List of keys that must be present in the input parameter\n\n    @property\n    def output_keys(self):\n        return ['output_key1', 'output_key2'] # List of keys that will be present in the output parameter\n\n\n    def _execute(self, parameter: dict, learned_instructions: dict, initial_parameter: dict, history: List[dict],  workflow_conversation: str):\n        try: \n            # parameter contains every input keys\n            return [{'output_key1': <output>, 'output_key2': <output>}] # output contains every output key\n        except Exception as e:\n            raise Exception(f\"execute :: {e}\")\n

    STEP 2: Add your steps to the steps library In backend>app>models>workflows>steps_library.py, add your steps to the STEPS dictionary. The key must be the name of the step and the value must be the class of the step. This is used to dynamically load the steps from their name in the database.

    STEP 3: Create the workflow To create a new workflow, you can use the dedicated route PUT /workflow

    Replace <BACKOFFICE_SECRET> with your actual token and name, steps, icon and description with the actual workflow name, steps, icon and description.

    Careful: steps names must match the ones in the steps library. Careful: steps must be in the right order.

    Then, run the following command in your terminal:

    curl --location --request PUT 'http://localhost:5001/workflow' \\\n--header 'Authorization: <BACKOFFICE_SECRET>' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\"datetime\": \"2024-02-14T17:49:26.545180\",\n    \"name_for_system\": \"<WORKFLOW_NAME_FOR_SYSTEM>\",\n    \"icon\": \"<EMOJI>\",\n    \"definition_for_system\": \"<WORKFLOW_DEFINITION_FOR_SYSTEM>\",\n    \"platforms\": [\"webapp\", \"mobile\"], # List of platforms where the workflow is available\n    \"steps\": [{\n        \"name_for_system\": \"<STEP_NAME_FOR_SYSTEM>\",\n        \"step_displayed_data\":[\n            {\n                \"language_code\": \"<2-LETTERS LANGUAGE-CODE>\",\n                \"name_for_user\": \"<STEP_NAME_FOR_USER>\",\n                \"definition_for_user\": \"<STEP_DEFINITION_FOR_USER>\"\n            },\n            ...\n        ]},\n        ...\n        ],\n    \"workflow_displayed_data\": [\n        {   \n            \"language_code\":\"<2-LETTERS LANGUAGE-CODE>\",\n            \"name_for_user\": <WORKFLOW_NAME_FOR_USER>\",\n            \"definition_for_user\": <WORKFLOW_DEFINITION_FOR_USER>\",\n            \"json_inputs_spec\": [\n                {\"input_name_for_system\": \"<INPUT_NAME_FOR_SYSTEM>\", \"type\": \"text_area\", \"input_name_for_user\":\"<INPUT_NAME_FOR_USER>\"},\n                ...\n               ]\n        },\n         ...\n    ]\n}'\n

    STEP 4: Define workflow checkpoints By default, every step is defined as a checkpoint. This means that at the end of each step_execution_run, if the user does not validate the result, the user will give an instruction and this same step_execution_run will be executed again.

    Example on Qualify Lead workflow: Step 1 is \"Write the query you will use with SERP API to search Google\"

    • Step 1 - Run 1 - Execution 1: parameter: {\"company\": \"Hoomano\"} learned instructions: None step result: \"query: 'Hoomano industry'\" user instruction: \"This query is not specific enough, please add more keywords\"

    • Step 1 - Run 1 - Execution 2: parameter: {\"company\": \"Hoomano\"} learned instructions: \"Make specific queries\" step result: \"query: 'Hoomano company industry trends AI\"

      On the contrary, if a step is not defined as a checkpoint, the user will give an instruction but the last checkpoint step last run will be executed again. Let's keep Qualify Lead workflow example running: Step 2 is \"Check the SERP API results and select the 3 most relevant one\"

      • Step 2 - Run 1 - Execution 1: parameter: {\"query\": \"Hoomano company industry trends AI\"} learned instructions: None step result: \"result 1, result 2, ...\" user instruction: \"This is not relevant, please try again, look for any blog post the company wrote\"

      • Step 1 - Run 1 - Execution 3: parameter: {\"company\": \"Hoomano\"} learned instructions: \"Make specific queries, look for any blog post the company wrote\" step result: \"query: 'Hoomano company AI blog posts\"

      • Step 2 - Run 2 - Execution 1: parameter: {\"query\": \"Hoomano company AI blog posts\"} learned instructions: \"Make specific queries, look for any blog post the company wrote\" step result: \"result 1, result 2, ...\"

        STEP 5: Associate workflow to a user through a product. Replace <BACKOFFICE_SECRET> with your actual token and <user_id> and <workflow_pk> with the actual user id and workflow primary key. Then, run the following command in your terminal:

        Default user demo@example.com is associated with default product demo with pk 1. Let's add the task to this product. 

        curl --location --request PUT 'http://localhost:5001/product_workflow_association' \\\n--header 'Authorization: backoffice_secret' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"datetime\": \"'\"$(date -u +\"%Y-%m-%dT%H:%M:%S.%3NZ\")\"'\",\n \"product_pk\": 1,\n \"workflow_pk\": <workflow_pk retrieved from previous command>\n}'\n

        "},{"location":"technical-architecture/backend/","title":"Backend","text":"

        The Mojodex Backend, inspired by System 1 from cognitive science, is responsible for managing the data and implementing the business logic of the digital assistant.

        "},{"location":"technical-architecture/backend/#functionalities","title":"Functionalities","text":""},{"location":"technical-architecture/backend/#rest-api-for-business-logic","title":"REST API for Business Logic","text":"

        Implemented with Flask, the REST API handles data management and business logic, providing fast and tailored responses to users.

        backend/app/app.py 

        [...]\nfrom flask import Flask\nfrom flask_restful import Api\n\napp = Flask(__name__)\napi = Api(app)\n\nfrom http_routes import *\nHttpRouteManager(api)\n[...]\n

        The API routes are all defined in backend/app/http_routes.py in the HttpRouteManager class, pointing to related Flask Resources in backend/app/routes/.

        Here's the link to the Backend API documentation - Swagger file.

        "},{"location":"technical-architecture/backend/#database-access","title":"Database Access","text":"

        The Backend uses SQLAlchemy to interact with the PostgreSQL database, ensuring efficient data management and storage. It can both read and write from the database.

        backend/app/app.py 

        [...]\nfrom flask_sqlalchemy import SQLAlchemy\n\napp = Flask(__name__)\n\napp.config[\n    \"SQLALCHEMY_DATABASE_URI\"] = f\"postgresql+psycopg2://{os.environ['DBUSER']}:{os.environ['DBPASS']}@{os.environ['DBHOST']}:5432/{os.environ['DBNAME']}\"\n\ndb = SQLAlchemy(app)\n[...]\n

        The database models generated with SQLAcodegen can be found in mojodex_core/entities.py. Those are used by the Backend to interact with the database though sqlalchemy.

        Important Note: Flask-Sqlalchemy manages sessions and closes sessions on its own when a request is done. It is not necessary to manage sessions manually. However, when accessing the database in a thread that is not the main one, it is necessary to close the session manually to avoid any locks on the database. For example, it is the case in backend/app/models/tasks/task_manager.py where the TaskManager.start_task_from_form() method is called in a parallel thread from backend/app/routes/user_task_execution_run.py and closes access to the database at the end of the method: ```python [...] from mojodex_core import * [...] def start_task_from_form(self, app_version, use_message_placeholder=False, use_draft_placeholder=False, tag_proper_nouns=False): try: [...] db.session.close() except Exception as e: db.session.close() [...]

        "},{"location":"technical-architecture/backend/#real-time-interaction-management","title":"Real-Time Interaction Management","text":"

        Using SocketIO through flask_socketio, the Backend enables interactive sessions between the assistant and the user, ensuring instant feedback and dynamic conversation flow.

        backend/app/app.py 

        [...]\nfrom flask_socketio import SocketIO\n\nserver_socket = SocketIO(app, ping_timeout=40, ping_interval=15, logger=False, engineio_logger=False, cors_allowed_origins=\"*\", )\n[...]\n

        "},{"location":"technical-architecture/backend/#reception-of-user-messages","title":"Reception of User Messages","text":"
        • For the web application, user messages in chat are received through socketio user_message event. 
          @server_socket.on('user_message')\ndef handle_message(data):\n    emit(\"user_message_reception\", {\"success\": \"User message has been received\", \"session_id\": data.get(\"session_id\")})\n    socketio_event_callback('user_message', data)\n

          Note that for mobile application, we moved from receiving user messages through socketio to a REST API endpoint for robustness. We will probably do the same for web application in the future.

        "},{"location":"technical-architecture/backend/#emission-of-assistant-messages","title":"Emission of Assistant Messages","text":"

        To separate messages from one user to another, we use Socketio's \"room\" principle along with Mojodex's Session management.

        A Mojodex's Session represents an interaction between the user and the assistant. It contains the list of messages exchanged during this interaction and is identified by a unique session_id.

        The user can resume a Session at any moment, for example when re-opening a task from their history.

        The Session's unique session_id is used to identify Socketio's room for the user and the assistant to exchange messages. In the emission code, this corresponds to the to parameter of the server_socket.emit() method.

        • Assistant partial messages, containing tokens as streamed by the LLM, are sent as soon as received through socketio dedicated events (mojo_token and draft_token). This allow to stream the assistant's response in real-time to the user so that the user can see the assistant's response being built. backend/app/models/session.py 

          [...]\ndef _mojo_token_callback(self, partial_text):\n    try:\n        server_socket.emit('mojo_token', {\"text\": partial_text, 'session_id': self.id}, to=self.id)\n    except Exception as e:\n        raise Exception(f\"_mojo_token_callback :: {e}\")\n[...]\n

        • Assistant messages, whether there are simple messages or containing task's result (produced_text) are sent through socketio using backend/app/socketio_message_sender.py along with a callback. The callback must be called by the frontend to confirm the message has been received (acknowledged), if not, the assistant will send the message again every 5 seconds for 10minutes or until the message is acknowledged. 

          [...]\ndef send_mojo_message_with_ack(self, message, session_id, event_name='mojo_message', remaining_tries=120):\n        [...]\n        server_socket.emit(event_name, message, to=session_id, callback=self._mojo_message_received)\n\n        def waiting_for_acknowledgment():\n            [...]\n\n        # start a timer of 5 seconds, in 5 seconds if it has not been killed, it will resend the message. Use executor to run async\n        if remaining_tries > 0:\n            executor.submit(waiting_for_acknowledgment)\n

        "},{"location":"technical-architecture/backend/#system-1system-2-abstraction","title":"System 1/System 2 Abstraction","text":"

        To draw a parallel with the System 1/System 2 abstraction, Mojodex's Backend functions as the digital counterpart to System 1 thinking.

        It swiftly processes incoming data and orchestrates real-time interactions similar to our intuitive cognitive processes. Operating seamlessly like System 1, the Backend ensures instantaneous feedback and dynamic conversation flows, akin to rapid, non-conscious decision-making.

        "},{"location":"technical-architecture/background/","title":"MOJODEX Background","text":"

        The background backend is responsible for processing data in the background. It is useful for long-running process that would otherwise block the main backend. It is also useful for processing batch data (like sending emails or notifs to a group of users).

        "},{"location":"technical-architecture/background/#structure","title":"Structure","text":"

        The background is a Flask application which routes can only be called by Mojodex's backend.

        The background must be deployed in the same network as the backend so that the backend can call its routes but its routes must not be accessible from the outside.

        background/app/app.py 

        [...]\nfrom flask import Flask\nfrom flask_restful import Api\n\napp = Flask(__name__)\napi = Api(app)\n\nfrom http_routes import *\nHttpRouteManager(api)\n[...]\n

        The API routes are all defined in background/app/http_routes.py in the HttpRouteManager class, pointing to related Flask Resources in background/app/routes/.

        "},{"location":"technical-architecture/background/#usage","title":"Usage","text":"

        When Mojodex's Backend calls Mojodex's Background to manage a process, it sends a request using REST API. Then, the route always process as follow:

        The Cortex are (mainly) located in background/app/models/cortexdirectory (those that are not may be refactored in coming updates). Those Cortex are classes implemented by the requested Flask Resource with 2 objectives:

          1. Load all data needed for the process from the database. This is done synchronously in the constructor of the Cortex. This is to keep database access in the main thread and avoid database lock issues.
          1. Process the data in the main method of the Cortext in a parallel thread launched in the Flask Resource. This main method does not have a consistent name for now and is specific to each process/cortex. An abstract class Cortexshould be added in the future to ensure a consistent structure for all cortexes.

        Note: \"Cortex\" name is a reference to the outer most layer of the brain. The cortex is involved in higher processes in the human brain, including memory, thinking, learning, reasoning, problem-solving, emotions, consciousness and functions related to your senses. Here, this is an abstraction to suggest the autonomy of this technical component regarding its process.

        If any additional data from the database is needed during the process, a request to the Backend will retrieve it.

          1. Finally, if any data needs to be inserted or updated in the database, this is done by calling a Backend API route from the Cortex. This way, we ensure responsability segregation and every data written in the database is done by the Backend.
        class Cortex:\n\n    def __init__(self, user_task_execution):\n        # Load all data needed for the process from the database\n\n\n    def main_method(self):\n        # Run process\n        # Send created or updated data to backend for update in database\n
        "},{"location":"technical-architecture/background/#functionalities","title":"Functionalities","text":"

        For now, Mojodex's Background manages 8 processes:

        "},{"location":"technical-architecture/background/#usertaskexecutiontitleandsummary","title":"UserTaskExecutionTitleAndSummary","text":"
        • Resource: background/app/routes/user_task_execution_title_and_summary.py
        • Cortex: background/app/models/cortex/user_task_execution_title_and_summary_cortex.py
        • Launched from: backend/app/models/tasks/task_manager.py

        This process is called each time the user sends a message to a task. It updates (or creates if not exists) the title and summary of the task from the ongoing conversation.

        "},{"location":"technical-architecture/background/#firstsessionmessage","title":"FirstSessionMessage","text":"
        • Resource: background/app/routes/first_session_message.py
        • Cortex: background/app/models/cortex/first_session_message_cortex.py
        • Launched from: backend/app/models/session.py

        This process is called when a user starts a new session. It generates a session title that could be useful to identify the session later, in a history interface for example.

        "},{"location":"technical-architecture/background/#extracttodos","title":"ExtractTodos","text":"
        • Resource: background/app/routes/extract_todos.py
        • Cortex: background/app/models/cortex/extract_todos_cortex.py
        • Launched from: backend/app/routes/extract_todos.py

        This process is launched at the end of a task to extract any next step the user could have mentioned explictely in the task process and turn those into To-Do items to add to the user's To-Do list.

        "},{"location":"technical-architecture/background/#rescheduletodo","title":"RescheduleTodo","text":"
        • Resource: background/app/routes/reschedule_todo.py
        • Cortex: background/app/models/cortex/reschedule_todo_cortex.py
        • Launched from: backend/app/routes/todo_scheduling.py

        This process is called to reschedule a To-Do item that passed its due date without being deleted or marked as completed.

        "},{"location":"technical-architecture/background/#parsewebsite","title":"ParseWebsite","text":"
        • Resource: background/app/routes/parse_website.py
        • Cortex: background/app/models/document/website_parser.py
        • Launched from: backend/app/routes/company.py && backend/app/routes/resource.py

        This process is called to parse a website, extract its content, cut it into chunks and load it in database as a document. It is used when user provides a new website as resource.

        "},{"location":"technical-architecture/background/#updatedocument","title":"UpdateDocument","text":"
        • Resource: background/app/routes/update_document.py
        • Cortex: background/app/models/document/website_parser.py || background/app/models/document/document_manager.py depending if the update is an edition or addition.
        • Launched from: backend/app/routes/resource.py

        This process is called to update a document in the database when user provides a new version of a resource.

        "},{"location":"technical-architecture/background/#eventsgeneration","title":"EventsGeneration","text":"
        • Resource: background/app/routes/event_generation.py
        • Cortex: background/app/models/events/event_generator.py (abstract class, implementation depends on parameters of request)

        This process is called any time the backend wants to send a notification to the user whether it is a mail, push notification... The Background is only responsible for notification content generation.

        "},{"location":"technical-architecture/background/#system-1system-2-abstraction","title":"System 1/System 2 Abstraction","text":"

        To draw a parallel with the System 1/System 2 abstraction, Mojodex's Background embodies the deliberate nature of System 2 thinking.

        It meticulously manages long-running processes and handles batch data tasks with careful attention, akin to System 2's deliberate memory search and complex computations. This component ensures the smooth functioning of Mojodex's operations, providing the necessary depth and thoroughness to complement the swift responsiveness of the Backend.

        "},{"location":"technical-architecture/database/","title":"Database","text":"

        This directory contains the SQL scripts to initialize the Mojodex database into a Docker container.

        The Mojodex database is a PostgreSQL database using the pg_vector extension to store and query vector data.

        The database is launched as a Docker container and is accessed by the backend and background services. See general documentation for more information.

        "},{"location":"technical-architecture/database/#database-schema","title":"Database schema","text":"

        You can have a look at the database schema at dbdiagram.io: https://dbdiagram.io/d/MojodexDatabase-659d0645ac844320ae85b440

        "},{"location":"technical-architecture/database/#prerequisites","title":"Prerequisites","text":"
        • Docker
        "},{"location":"technical-architecture/database/#installation","title":"Installation","text":"

        Clone the repository and navigate to the pgsql directory:

        git clone\ncd mojodex/pgsql\n
        "},{"location":"technical-architecture/database/#database-configuration","title":"Database configuration","text":"

        The Dockerfile contains default environment variables for the PostgreSQL database. You can modify these variables to suit your environment.

        [...]\nENV POSTGRES_DB=<database_name>\nENV POSTGRES_USER=<username>\nENV POSTGRES_PASSWORD=<password>\n[...]\n

        Note: The POSTGRES_DB, POSTGRES_USER, and POSTGRES_PASSWORD environment variables are required to initialize the database.

        \u26a0\ufe0f Do not forget to change the default values in the Dockerfile before building the Docker container.

        "},{"location":"technical-architecture/database/#initialization-of-mojodex-data","title":"Initialization of Mojodex data","text":"

        The init-mojodex-data.sql file contains the SQL scripts to create the Mojodex schema and data. You can modify this file to add or remove data.

        This will create the following Mojodex config: - user: user@demo.com - password: password - product: demo - task: meeting_recap

        You will be able to use the default user and password to connect to your assistant to check everything is working.

        "},{"location":"technical-architecture/database/#build","title":"Build","text":"

        To build the Docker container, run the following command:

        docker build -t mojodex-db .\n
        "},{"location":"technical-architecture/database/#usage","title":"Usage","text":"

        To initialize the database, run the following command:

        docker run -d --name mojodex-db -p 5432:5432 mojodex-db\n

        This will create a Docker container running a PostgreSQL database with the Mojodex schema and data.

        "},{"location":"technical-architecture/database/#troubleshooting","title":"Troubleshooting","text":"

        To check if the database is running, run the following command:

        psql -h localhost -U <username> -d <database_name>\n

        Then, use your password to connect to the database and look at the tables:

        \\dt\n

        You should see the following tables:

                                    List of relations\n Schema |                   Name                    | Type  |   Owner    \n--------+-------------------------------------------+-------+------------\n public | md_calendar_suggestion                    | table | <your_user>\n public | md_company                                | table | <your_user>\n public | md_device                                 | table | <your_user>\n public | md_document                               | table | <your_user>\n public | md_document_chunk                         | table | <your_user>\n public | md_error                                  | table | <your_user>\n public | md_event                                  | table | <your_user>\n public | md_home_chat                              | table | <your_user>\n public | md_message                                | table | <your_user>\n public | md_platform                               | table | <your_user>\n public | md_predefined_action_displayed_data       | table | <your_user>\n public | md_produced_text                          | table | <your_user>\n public | md_produced_text_version                  | table | <your_user>\n public | md_product                                | table | <your_user>\n public | md_product_category                       | table | <your_user>\n public | md_product_category_displayed_data        | table | <your_user>\n public | md_product_displayed_data                 | table | <your_user>\n public | md_product_task                           | table | <your_user>\n public | md_purchase                               | table | <your_user>\n public | md_session                                | table | <your_user>\n public | md_task                                   | table | <your_user>\n public | md_task_displayed_data                    | table | <your_user>\n public | md_task_platform_association              | table | <your_user>\n public | md_task_predefined_action_association     | table | <your_user>\n public | md_text_edit_action                       | table | <your_user>\n public | md_text_edit_action_displayed_data        | table | <your_user>\n public | md_text_edit_action_text_type_association | table | <your_user>\n public | md_text_type                              | table | <your_user>\n public | md_todo                                   | table | <your_user>\n public | md_todo_scheduling                        | table | <your_user>\n public | md_user                                   | table | <your_user>\n public | md_user_task                              | table | <your_user>\n public | md_user_task_execution                    | table | <your_user>\n public | md_user_vocabulary                        | table | <your_user>\n
        "},{"location":"technical-architecture/database/#entities","title":"Entities","text":"

        Each table is represented as a python class in mojodex_code/entities.py. This file is generated using sqlacodegentool: 

        sqlacodegen postgresql+psycopg2://$DBUSER:$DBPASS@localhost:5432/$DBNAME --outfile mojodex_core/entities/db_base_entities.py\n

        \u26a0\ufe0f Be sure to install sqlacodegen with the appropriate pg_vector features: 

        python3 -m pip install git+https://github.com/hoomano/sqlacodegen.git@feature-pgvector\n

        "},{"location":"technical-architecture/database/#go-further","title":"Go further","text":"

        You can use the Mojodex API to create new users, products, tasks, etc. See the Mojodex API documentation for more information.

        "},{"location":"technical-architecture/overview/","title":"Global Architecture","text":""},{"location":"technical-architecture/overview/#principles","title":"Principles","text":"

        Mojodex Architecture is built upon the foundational principles of System 1/System 2 abstraction, a concept derived from cognitive psychology.

        • System 1 represents fast, intuitive, and unconscious thinking.
        • System 2 embodies slower, deliberate, and analytical thought processes.

        By integrating these cognitive frameworks into its design, Mojodex aims to create a digital assistant system that combines the rapid responsiveness of System 1 with the careful decision-making of System 2.

        This documentation provides an overview of Mojodex's architecture, exploring how these cognitive principles inform its structure and functionality.

        Learn more about the System 1/System 2 abstraction

        "},{"location":"technical-architecture/overview/#architecture-overview","title":"Architecture Overview","text":""},{"location":"technical-architecture/overview/#components","title":"Components","text":"Component Role Documentation Link Backend Communication hub for real-time dialogue and management of application business logic. Mojodex's Backend serves as the digital counterpart to System 1 thinking. Backend Documentation Background Handles intensive tasks behind-the-scenes. Useful for Long-Running Processes and Batch Data Processing. Mojodex's Background embodies the deliberate nature of System 2 thinking. Background Documentation Scheduler Executes code at specific times/intervals. Mojodex's Scheduler embodies a proactive aspect akin to System 2 thinking Scheduler Documentation Database Stores and manages data Database Documentation Mobile App Interface for mobile devices Mobile App Documentation Web App Interface for web browsers Web App Documentation Next Proxy Manages and authenticates requests from the webapp interface to the backend. Next Proxy Documentation"},{"location":"technical-architecture/scheduler/","title":"Scheduler","text":"

        The scheduler is responsible for running tasks at specific times or intervals. It is useful for running tasks that are not directly related to a user's request, like sending emails or notifs to a group of users. It is also useful for proactivity, to let Mojo work on something by checking state of a user or a task at a certain frequency and act accordingly.

        "},{"location":"technical-architecture/scheduler/#functionalities","title":"Functionalities","text":"

        Mojodex's Scheduler has 2 main directory containing:

        • Scheduled tasks scheduler/app/scheduled_tasks
        • Time based tasks scheduler/app/time_based_tasks

        Those tasks are run thanks to the scheduler/app/main.py file that keeps the scheduler running and checks for tasks to run using the schedule library.

        while True:\n    schedule.run_pending()\n    time.sleep(1)\n
        "},{"location":"technical-architecture/scheduler/#scheduled-tasks","title":"Scheduled tasks","text":"

        Scheduled tasks contains code that are run at a specific frequency. 

        ### Abstract class named ScheduledTask that has a method job() and a constructor that runs  schedule.every(X).seconds.do(job), X being the number of seconds between executions (param)\nfrom abc import ABC, abstractmethod\nimport schedule\n\nclass ScheduledTask(ABC):\n\n    def __init__(self, n_seconds):\n        schedule.every(n_seconds).seconds.do(self.job)\n\n    @abstractmethod\n    def job(self):\n        \"\"\"Method that will be executed every n_seconds seconds\"\"\"\n        pass\n

        As Mojodex's Scheduler does not have database access, Scheduled tasks jobs are Backend API calls. Performed at a regular interval, they are useful for checking the state of a user or a task and act accordingly.

        The Scheduled tasks are implemented in the scheduler/app/main.py file.

        [...]\n# Scheduled tasks\nPurchasesExpirationChecker(3600) # check ended free_plan every 1 hour\nExtractTodos(600) # extract todos every 10 minutes\nRescheduleTodos(3600) # reschedule todos every 1 hour\nif push_notifications:\n    CalendarSuggestionNotificationSender(600) # send calendar suggestion notifications every 10 minutes\n    SendDailyNotifications(3600) # send daily notifications every 1 hour (filtered by timezone)\nif emails:\n    #SendDailyEmails(3600) # send daily emails every 1 hour (filtered by timezone)\n    SendTodoDailyEmails(3600) # send todo daily emails every 1 hour (filtered by timezone)\n    CheckDisengagedFreeTrialUsers(86400)  # check disengaged free trial users every day\nFirstHomeChatOfWeek(3600)\n[...]\n
        "},{"location":"technical-architecture/scheduler/#time-based-tasks","title":"Time based tasks","text":"

        Time based tasks contains code that are run at a specific time of the day. 

        from abc import ABC, abstractmethod\nimport schedule\n\n\nclass TimeBasedTask(ABC):\n\n    def __init__(self, hour=10, minute=0, second=0, weekday=None,):\n        if weekday is not None:\n            schedule.every().monday.at(f\"{hour}:{minute}:{second}\").do(self.job) if weekday == 0 else None\n            schedule.every().tuesday.at(f\"{hour}:{minute}:{second}\").do(self.job) if weekday == 1 else None\n            schedule.every().wednesday.at(f\"{hour}:{minute}:{second}\").do(self.job) if weekday == 2 else None\n            schedule.every().thursday.at(f\"{hour}:{minute}:{second}\").do(self.job) if weekday == 3 else None\n            schedule.every().friday.at(f\"{hour}:{minute}:{second}\").do(self.job) if weekday == 4 else None\n            schedule.every().saturday.at(f\"{hour}:{minute}:{second}\").do(self.job) if weekday == 5 else None\n            schedule.every().sunday.at(f\"{hour}:{minute}:{second}\").do(self.job) if weekday == 6 else None\n        else:\n            schedule.every().day.at(f\"{hour}:{minute}:{second}\").do(self.job)\n\n\n    @abstractmethod\n    def job(self):\n        \"\"\"Method that will be executed at the specified time\"\"\"\n        pass\n

        For now, Mojodex Scheduler doesn't have any time based tasks. Indeed, when running code for a user at a specific time, it is often more relevant to adapt to the user's timezone (for example, to process To-Do rescheduling while user is sleeping). Therefore, a Scheduled task is more appropriate to trigger a backend call every hour and filter the concerned users by timezone.

        "},{"location":"technical-architecture/scheduler/#system-1system-2-abstraction","title":"System 1/System 2 Abstraction","text":"

        In alignment with the System 1/System 2 framework, Mojodex's Scheduler embodies a proactive aspect akin to System 2 thinking.

        It functions as the deliberate planner within Mojodex, orchestrating scheduled code execution and empowering the assistant to take preemptive actions based on predefined criteria. Just as System 2 engages in deliberate planning and decision-making, the Scheduler ensures the efficient and effective operation of Mojodex by executing tasks at specific times or intervals, optimizing the assistant's performance in a systematic and thoughtful manner.

        "},{"location":"technical-architecture/webapp/","title":"Web App","text":"

        The Mojodex web app is a web application that allows you to interact with the Mojodex API.

        "},{"location":"technical-architecture/integration/hubspot/","title":"Hubspot integration","text":"

        Hubspot integration stands as a demonstration of how to integrate a third-party service with the platform. The integration is implemented as an action on task result to export a produced text directly to Hubspot.

        "},{"location":"technical-architecture/integration/hubspot/#configuration","title":"Configuration","text":"

        Using Hubspot integration requires setting an HUBSPOT_ACCESS_TOKEN variable in the .env file of Mojodex project. The access token can be obtained from the Hubspot account settings.

        For the \"export to Hubspot\" button to be display in mobile application, ensure the HUBSPOT_BUTTON variable is set to \"true\" in the .env file of the mobile application.

        "},{"location":"technical-architecture/integration/hubspot/#export-task-result","title":"Export task result","text":""},{"location":"technical-architecture/integration/hubspot/#backend","title":"Backend","text":"

        On the backend side, the integration is implemented as 2 routes. Resources can be found in backend/app/routes/integrations/hubspot.py file.

        • GET route: retrieves n_results from search_type ('companies', 'contacts' or 'deals') which name starts with search_string. This route is used for user to browse their Hubspot account and select the entity to which the text will be exported.

        • POST route: exports the task result associated with produced_text_version_pk as an engagement_type (among 'notes', 'emails', 'calls' and 'meetings') to associated_object_id of associated_object_type (among 'companies', 'contacts' or 'deals').

        "},{"location":"technical-architecture/integration/hubspot/#frontend","title":"Frontend","text":"

        On frontend side, only mobile application supports Hubspot integration for now. The integration is implemented as an export button in the task result details view.

        The button opens a modal with a form to select the entity to which the text will be exported.

        "},{"location":"technical-architecture/integration/hubspot/#future-work-hubspot-as-third-party-tool","title":"Future work - Hubspot as third party tool","text":"
        • Implement a tool to browse Hubspot entities past notes
        • Use this tool to create a background task Pre-call Brief: Create a concise summary of past interactions with the individual prior to initiating a business-oriented phone call.
        "},{"location":"technical-architecture/llm-features/","title":"Large Language Models in Mojodex","text":"

        As an AI agent, Mojodex uses cognitive functions powered by LLMs.

        "},{"location":"technical-architecture/llm-features/#providers","title":"Providers","text":"
        • OpenAI GPT-4 Turbo
        • Azure Open AI Services
        • Mistral mistral-medium & mistral-large
        "},{"location":"technical-architecture/llm-features/#features-coverage","title":"Features coverage","text":"

        As of 2024-03-05, the following features are supported by the providers:

        Feature GPT-4 Turbo mistral-large mistral-medium mistral-tiny ANSWER_USER \u2705 \u2705 ~ \u274c CALENDAR_SUGGESTION_GENERATOR \u2705 \u2705 TBD TBD CALENDAR_SUGGESTION_NOTIFICATION \u2705 \u2705 TBD TBD CALENDAR_SUGGESTION_WAITING_TEXT \u2705 \u2705 TBD TBD CHIT_CHAT \u2705 \u2705 TBD TBD CORRECT_COMPANY_INFO_FROM_FEEDBACK \u2705 \u2705 TBD TBD DAILY_EMAIL_GENERATOR \u2705 \u2705 TBD TBD DAILY_NOTIFICATION \u2705 \u2705 TBD TBD DOCUMENT_EMBEDDING \u2705 \u2705 TBD TBD EXTRACT_COMPANY_INFO_FROM_WEBSITE \u2705 \u2705 TBD TBD GENERATE_SESSION_TITLE \u2705 \u2705 TBD TBD GENERATE_TASK_JSON \u2705 \u2705 TBD TBD GET_LANGUAGE \u2705 \u2705 TBD TBD HOME_CHAT \u2705 \u2705 TBD TBD INTERNAL_MEMORY_INFORMATION_EXTRACTOR \u2705 \u2705 TBD TBD IS_EDITION_WRITING \u2705 \u2705 TBD TBD PRODUCED_TEXT_EMBEDDER \u2705 \u2705 TBD TBD PRODUCED_TEXT_QUERY_EMBEDDER \u2705 \u2705 TBD TBD SPELLING_CORRECTOR \u2705 \u2705 TBD TBD TASK_CLASSIFICATION \u2705 \u2705 TBD TBD TASK_EXECUTION_SUMMARIZER \u2705 \u2705 TBD TBD TASK_TOOL_EXECUTION_MESSAGE_WRITER \u2705 \u2705 TBD TBD TASK_TOOL_NOTIFICATION \u2705 \u2705 TBD TBD TEXT_EDIT_EXECUTOR \u2705 \u2705 TBD TBD TEXT_TYPE_DEDUCER \u2705 \u2705 TBD TBD TODOS_EXTRACTOR \u2705 \u2705 TBD TBD TODOS_RESCHEDULER \u2705 \u2705 TBD TBD TOOL_PARAMS_GENERATOR \u2705 \u2705 TBD TBD WEBSITE_CHUNK_VALIDATOR \u2705 \u2705 TBD TBD WEB_SCRAPPER \u2705 \u2705 TBD TBD"},{"location":"technical-architecture/llm-features/azure/","title":"Azure Open AI Services","text":"

        Setup the configuration keys in your models.conf file:

        GPT4_AZURE_OPENAI_DEPLOYMENT_ID=<your-deployment-id>\nGPT4_AZURE_OPENAI_API_BASE=<your-api-base>\nGPT4_AZURE_OPENAI_API_VERSION=<your-api-version>\nGPT4_AZURE_OPENAI_KEY=<your-key>\n
        "},{"location":"technical-architecture/llm-features/azure/#coverage","title":"Coverage","text":"

        GPT4-Turbo has been used to develop the entire Mojodex platform. The coverage is complete.

        "},{"location":"technical-architecture/llm-features/mistral/","title":"Mistral AI","text":"

        To use Mistral AI, 2 ways:

        • \u261d\ufe0f > \ud83d\udd0c Mistral AI Platform: create a Mistral AI account and an API key.

        Configure your .env with Mistral API key

        # Mistral API\nMISTRAL_API_KEY=your-api-key\n
        • \u270c\ufe0f > \ud83d\udcd6 Azure Mistral AI: create an Azure account and an API key.

        Azure Mistral API

        # Azure Mistral API\nMISTRAL_AZURE_API_BASE=<your-azure-api-endpoint>\nMISTRAL_AZURE_API_KEY=<your-azure-api-key>\n
        "},{"location":"technical-architecture/llm-features/mistral/#coverage","title":"Coverage","text":"

        For the assessment, mistral models have been tested on the most challenging feature: \"ANSWER_USER\" on the Mojodex platform.

        See blog post for a better understanding of the challenge: Advanced Prompting Strategies for Digital Assistant Development

        "},{"location":"technical-architecture/llm-features/mistral/#mistral-large","title":"mistral-large \u2705","text":"

        \ud83c\udf89 full coverage

        mistral-large has been tested on all features and provides a full coverage of the Mojodex cognitive functions.

        "},{"location":"technical-architecture/llm-features/mistral/#mistral-medium","title":"mistral-medium \ud83d\udea7","text":"

        The results are promising, but the full coverage is not yet available.

        Some results so far

        Overall mistral-medium gets the idea behind the data/prompts/tasks/run.txt with the following limitations observed:

        • \ud83d\udc4d Straightforward implementation of the API
        • \ud83d\udc4d Follows the overall logic of the prompt
        • \ud83d\ude15 Big variations between runs in interpretation
        • \ud83d\ude15 Not reliably steerable to defined in the prompt"},{"location":"technical-architecture/llm-features/mistral/#work-in-progress","title":"Work in progress","text":"
          • Prepare the Mistral AI provider implementation
          • Run basic tests with existing prompts
          • Complete the assessment on all features for mistral-large
          • Complete the assessment on all features for mistral-medium
          • Prompt Tuning: mojodex_core/prompts/* has been crafted for GPT-4 and GPT-4 Turbo. We need to craft prompts for Mistral AI more specifically.
          • Explore guardrailing strategies to steer the model to the desired output
          • For non-supported features, we can explore fine-tuning the model on our own data gathered in /data/prompts_dataset
          "},{"location":"technical-architecture/llm-features/mpt/","title":"Mojodex Prompt Template (MPT) File Format","text":""},{"location":"technical-architecture/llm-features/mpt/#introduction","title":"Introduction","text":"

          This document introduces the Mojodex Prompt Template (.mpt) file format, a new standard designed to streamline and enhance the process of generating inputs for large language models (LLMs) within our development workflows. The .mpt format is a composition of jinja2 templating, HTML-like custom tagging for document formatting, and unstructured pseudo-code, enabling a flexible, powerful approach to crafting LLM prompts.

          "},{"location":"technical-architecture/llm-features/mpt/#key-principles","title":"Key Principles","text":"
          1. Prompting is coding: jinja2 templating and pseudo-code for dynamic, complex prompts.
          2. Divide and conquer: unified prompting library for easy multi-LLM architecture strategy.
          3. Token poor: reduce the token size of the prompt to optimize the LLM input.
          "},{"location":"technical-architecture/llm-features/mpt/#motivation","title":"Motivation","text":"

          As our reliance on LLMs increases, the complexity and variety of prompts we need to generate have grown. Traditional methods of prompt creation often involve a cumbersome, error-prone process of manually editing and formatting text, lacking standardization and efficiency. The .mpt format aims to address these challenges by providing:

          • Standardization: A unified file format allows for consistent prompt creation across different projects and teams.
          • Efficiency: The use of jinja2 templating and custom tags streamlines the process of generating dynamic, complex prompts.
          • Flexibility: Support for unstructured pseudo-code and custom tags ensures that developers can express a wide range of logic and formatting requirements.
          • Version Control: A dash bang style header in each .mpt file specifies the LLM model version, author, and additional metadata, facilitating better management and compatibility of prompt templates over time.
          "},{"location":"technical-architecture/llm-features/mpt/#mpt-file-format-specification","title":".mpt File Format Specification","text":""},{"location":"technical-architecture/llm-features/mpt/#header","title":"Header","text":"

          The .mpt file begins with a dash bang style header that includes essential metadata:

          #! gpt4-turbo/2023-03-15-preview\n#! gpt-4-turbo-preview\n
          "},{"location":"technical-architecture/llm-features/mpt/#body","title":"Body","text":"

          The body of the .mpt file contains a mix of jinja2 templates, custom HTML-like tags, and pseudo-code:

          <template>\n    <title>\n        Hello, {{ name }}! This is a sample template.   \n    </title>    \n    <content>\n        <if not all informations required display a special message, otherwise do something>\n    </custom_logic>\n</template>\n
          "},{"location":"technical-architecture/llm-features/mpt/#advanced-templating-techniques","title":"Advanced Templating Techniques","text":"

          To accommodate the unique requirements and capabilities of different LLM models within a single MPT file, advanced templating techniques are employed. This approach allows developers to specify model-specific prompts and logic, ensuring optimal interaction with each model's unique interpretation and response characteristics.

          "},{"location":"technical-architecture/llm-features/mpt/#example-of-model-specific-templating","title":"Example of Model-Specific Templating","text":"

          Consider a scenario where different models, such as mistral-medium, gpt-4-turbo, and mistral-large, require tailored prompts to achieve the same task. The .mpt file can contain directives (shebangs) and conditional templating to customize the prompt for each model:

          #! mistral:instruct\n#! mistral-medium\n#! gpt4-turbo/2023-03-15-preview\n#! gpt-4-turbo-preview\n#! mistral-large\n\nYOUR CONTEXT\n{{mojo_knowledge}}\n\nGLOBAL CONTEXT\n{{user_datetime_context}}\n\nUSER NAME\n{{username}}\n\n{% if user_company_knowledge %}USER'S COMPANY KNOWLEDGE\n{{user_company_knowledge}}{% endif %}\n\nHere is the task achieved by your user.\n-------\nTASK TO ACCOMPLISH\n{{task_name}}: {{task_definition}}\n\nUSER INPUTS\n{{ user_task_inputs | tojson(indent=4) }}\n\n{% if user_messages_conversation %}CONVERSATION\n{{ user_messages_conversation }}{% endif %}\n-------\n\n{# fewshot for small models like mistral7b, i.e. mistral:instruct with ollama #}\n{% if model in [\"mistral:instruct\"] %}\nEXAMPLES OF GOOD EXECUTIONS OF THE TASK SUMMARIZATION:\n\nEXAMPLE 1:\n------\nTASK TO ACCOMPLISH\nstructure_ideas_into_doc: The user needs assistance to turn ideas into a structured written doc\n\nUSER INPUTS:\npr\\\\u00e9pare une note de musique\n\nTASK RESULT:\n<title>Structuration d'une Note de Musique</title>\n<summary>Assistance fournie pour transformer des id\\u00e9es en un document structur\\u00e9. Le sujet principal \\u00e9tait la pr\\u00e9paration d'une note de musique. Le processus a impliqu\\u00e9 la transcription et l'organisation des id\\u00e9es fournies.</summary>\n------\n{% endif %}\n\nGive a title to this task execution so that the user can remember what the task was about. Give important information in the title such as names, subjects...\nMake a summary of this task execution so that the user can remember what the task was about.\nSummary is addressed to the user. No need to call them.\n10 words max for the title and 3 sentences max for the summary.\nFormat:\n<title>TITLE</title>\n<summary>SUMMARY</summary>\n\nUse the same language as the user.\nNo talk, just title and summary.\n

          This example showcases how to define complex logic and conditionally include content based on the model being used, offering unparalleled flexibility in crafting prompts for diverse LLMs.

          "},{"location":"technical-architecture/llm-features/mpt/#mpt-workflow","title":"MPT Workflow","text":"

          Developers create .mpt files following the format specification. The runtime sequence involves:

          graph LR\n    A[Cleaning\\nDashbang] --> B[Jinja2\\nResolution]\n    B --> C[Generate\\nLLM Input]\n    C --> D[\"(soon) Compression\"]
          1. Cleaning Dashbang: The header is cleaned from the processing input to the LLM.
          2. Jinja2 Resolution: Templates are processed to substitute variables and expressions with actual values.
          3. Generate LLM Input: The cleaned, resolved template serves as the input for the appropriate LLM.
          4. (soon) Compression: Optimize the LLM input with compression algorithms to reduce the token size \u2013 this is optional and depends on the LLM model & tokenizer.
          "},{"location":"technical-architecture/llm-features/mpt/#example","title":"Example","text":"

          file translation.mpt

          ```

          "},{"location":"technical-architecture/llm-features/mpt/#gpt4-turbo2023-03-15-preview","title":"! gpt4-turbo/2023-03-15-preview","text":""},{"location":"technical-architecture/llm-features/mpt/#gpt-4-turbo-preview","title":"! gpt-4-turbo-preview","text":"
          #! mistral-large\n\nTranslate this text to {{language}}:\n<text_start>\n{{text}}\n<text_end>\nIf text is already in {{language}}, return it as is.\nNo talk, just translation.\nDo not include tags in response.\n\n\n```\n

          Code

          >>> mpt = MPT('translation.mpt', text='hello', language='english')\n>>> print(mpt)\nMPT: translation.mpt\n\n>>> print(mpt.prompt)\nTranslate this text to english:\n<text_start>\nhello\n<text_end>\nIf text is already in english, return it as is.\nNo talk, just translation.\nDo not include tags in response.\n\n\n\n>>> print(mpt.dashbangs)\n[{'model_name': 'gpt-4-turbo', 'version': '2023-03-15-preview'}, {'model_name': 'mistral-large', 'version': 'latest'}]\n\n>>> print(mpt.models)\n['gpt-4-turbo', 'mistral-large']\n\n>>> print(mpt.tags) \n['<text_start>', '<text_end>']   \n
          "},{"location":"technical-architecture/llm-features/mpt/#implementation-plan","title":"Implementation Plan","text":"

          The implementation involves developing a VSCode extension that supports the .mpt file format, including syntax highlighting, linting, and integration with LLM runtime processes.

          "},{"location":"technical-architecture/llm-features/openai/","title":"Open AI","text":"

          Setup the API key in your models.conf file:

          OPENAI_API_KEY=your-api-key\n
          You can specify the provider to use as a backup in case the main provider reaches its rate limit by configuring the appropriate section in the models.conf file.

          "},{"location":"technical-architecture/llm-features/openai/#coverage","title":"Coverage","text":"

          GPT4-Turbo has been used to develop the entire Mojodex platform. The coverage is complete.

          "}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 00000000..df5b1ef1 --- /dev/null +++ b/sitemap.xml @@ -0,0 +1,173 @@ + + + + https://hoomano.github.io/mojodex/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/getting-started/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/motivations/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/design-principles/products/how_it_works/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/design-principles/products/whats_a_product/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/design-principles/profiles/whats_a_profile/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/design-principles/tasks/execute_task/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/design-principles/tasks/whats_a_task/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/design-principles/to-do_list/how_todo_works/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/design-principles/to-do_list/whats_a_todo/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/design-principles/workflows/execute_workflow/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/design-principles/workflows/whats_a_workflow/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/guides/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/guides/azure-deployment/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/guides/products/new_product/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/guides/profiles/new_profile/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/guides/sales_assistant_example/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/guides/sales_assistant_example/sales_assistant_scope_template/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/guides/tasks/example/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/guides/tasks/new_task/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/guides/users/new_user/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/guides/workflows/new_workflow/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/technical-architecture/backend/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/technical-architecture/background/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/technical-architecture/database/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/technical-architecture/overview/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/technical-architecture/scheduler/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/technical-architecture/webapp/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/technical-architecture/integration/hubspot/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/technical-architecture/llm-features/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/technical-architecture/llm-features/azure/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/technical-architecture/llm-features/mistral/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/technical-architecture/llm-features/mpt/ + 2024-07-01 + daily + + + https://hoomano.github.io/mojodex/technical-architecture/llm-features/openai/ + 2024-07-01 + daily + + \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz new file mode 100644 index 00000000..9a9648cf Binary files /dev/null and b/sitemap.xml.gz differ diff --git a/stylesheets/extra.css b/stylesheets/extra.css new file mode 100644 index 00000000..75e7cda7 --- /dev/null +++ b/stylesheets/extra.css @@ -0,0 +1,150 @@ +:root, +[data-md-color-scheme="default"] { + --md-default-bg-color: rgb(250, 250, 250); + --md-primary-fg-color: rgb(255, 255, 255); + --md-primary-fg-color--light: #3763E7; + --md-primary-fg-color--dark: #3763E7; + --md-primary-bg-color: rgba(0, 0, 0, .75); + --md-primary-bg-color--light: rgba(0, 0, 0, .54); + --md-accent-fg-color: #1D52BF; + --pg-light-border: #3763E7; + --hb-hero-color: #1F2937; +} + +:root, +[data-md-color-scheme="slate"] { + --md-default-bg-color: #1F2937; + --md-primary-fg-color: rgb(15, 15, 15); + --md-primary-fg-color--light: #3763E7; + --md-primary-fg-color--dark: #86ADFF; + --md-primary-bg-color: rgba(0, 0, 0, .75); + --md-primary-bg-color--light: rgba(0, 0, 0, .54); + --md-accent-fg-color: #3763E7; + --pg-light-border: rgb(47, 47, 47); + --hb-hero-color: #F3F4F6; + +} + +.md-typeset h1 { + font-weight: 700; + color: var(--md-typeset-a-color); +} + +/* Better contrast link colors */ +[data-md-color-scheme="default"]>* { + --md-typeset-a-color: #3763E7; +} + +[data-md-color-scheme="slate"]>* { + --md-typeset-a-color: #86ADFF; +} + +/* Wide card grids */ +.md-typeset .grid.wide { + grid-template-columns: repeat(2, 1fr); +} + +@media (max-width: 768px) { + .md-typeset .grid.wide { + grid-template-columns: repeat(1, 1fr); + } +} + +/* Custom header + nav */ +.md-header>*, +.md-tabs { + background: none; +} + +[data-md-color-scheme="slate"] .md-header>*, +[data-md-color-scheme="slate"] .md-tabs { + color: #fff; +} + +.md-header__button { + color: var(--md-default-fg-color--light); +} + +.md-header, +.md-tabs { + /* firefox fallback */ + background-color: rgba(255, 255, 255, .95); +} + +[data-md-color-scheme="slate"] .md-header, +[data-md-color-scheme="slate"] .md-tabs { + /* firefox fallback */ + background-color: rgba(9, 9, 9, 0.95); +} + +@supports ((-webkit-backdrop-filter: none) or (backdrop-filter: none)) { + + .md-header, + .md-tabs { + background-color: rgba(255, 255, 255, .6); + -webkit-backdrop-filter: blur(12px); + backdrop-filter: blur(12px); + } + + [data-md-color-scheme="slate"] .md-header, + [data-md-color-scheme="slate"] .md-tabs { + background-color: rgba(0, 0, 0, 0.5); + -webkit-backdrop-filter: blur(12px); + backdrop-filter: blur(12px); + } +} + +[data-md-color-scheme="slate"] .md-nav--primary .md-nav__title[for="__drawer"] { + color: var(--md-typeset-a-color) +} + +header[class="md-header md-header--shadow"], +nav[class="md-tabs"] { + border-bottom: 1px solid var(--pg-light-border); +} + + +@media screen and (min-width: 60em) { + .md-search__overlay { + background-color: transparent; + } + + .md-search__form { + border: 1px solid var(--pg-light-border); + background-color: var(--md-primary-fg-color) !important; + box-shadow: rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0.02) 0px 1px 3px 0px, rgba(0, 0, 0, 0.02) 0px 1px 2px -1px; + border-radius: 6px; + height: 1.4rem; + } + + [data-md-toggle="search"]:checked~.md-header .md-search__form { + border-radius: 6px 6px 0 0; + } + + [dir="ltr"] .md-search__output { + top: initial; + border-radius: 0 0 6px 6px; + } + + [data-md-toggle="search"]:checked~.md-header .md-search__output { + box-shadow: 0 0 .6rem rgba(0, 0, 0, .07); + } + + .md-search__input { + font-size: .6rem; + } + + .md-search__options { + top: .05rem; + } + + .md-search__icon, + .md-search__input::placeholder { + color: var(--md-default-fg-color--light) !important; + } + + .md-search__icon svg { + width: .75rem; + height: .75rem; + } +} \ No newline at end of file diff --git a/technical-architecture/backend/index.html b/technical-architecture/backend/index.html new file mode 100644 index 00000000..a2623a80 --- /dev/null +++ b/technical-architecture/backend/index.html @@ -0,0 +1,2079 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Backend - Mojodex - Open Source Enterprise Digital Assistant Platform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + +
          + + + + +
          + + +
          + +
          + + + + + + + + + +
          +
          + + + +
          +
          +
          + + + + + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          + + + + +

          Backend

          +

          The Mojodex Backend, inspired by System 1 from cognitive science, is responsible for managing the data and implementing the business logic of the digital assistant.

          +

          Functionalities

          +

          REST API for Business Logic

          +

          Implemented with Flask, the REST API handles data management and business logic, providing fast and tailored responses to users.

          +

          backend/app/app.py +

          [...]
+from flask import Flask
+from flask_restful import Api
+
+app = Flask(__name__)
+api = Api(app)
+
+from http_routes import *
+HttpRouteManager(api)
+[...]
+

          +

          The API routes are all defined in backend/app/http_routes.py in the HttpRouteManager class, pointing to related Flask Resources in backend/app/routes/.

          +

          Here's the link to the Backend API documentation - Swagger file.

          +

          Database Access

          +

          The Backend uses SQLAlchemy to interact with the PostgreSQL database, ensuring efficient data management and storage. It can both read and write from the database.

          +

          backend/app/app.py +

          [...]
+from flask_sqlalchemy import SQLAlchemy
+
+app = Flask(__name__)
+
+app.config[
+    "SQLALCHEMY_DATABASE_URI"] = f"postgresql+psycopg2://{os.environ['DBUSER']}:{os.environ['DBPASS']}@{os.environ['DBHOST']}:5432/{os.environ['DBNAME']}"
+
+db = SQLAlchemy(app)
+[...]
+

          +

          The database models generated with SQLAcodegen can be found in mojodex_core/entities.py. Those are used by the Backend to interact with the database though sqlalchemy.

          +
          +

          Important Note: Flask-Sqlalchemy manages sessions and closes sessions on its own when a request is done. It is not necessary to manage sessions manually. However, when accessing the database in a thread that is not the main one, it is necessary to close the session manually to avoid any locks on the database. +For example, it is the case in backend/app/models/tasks/task_manager.py where the TaskManager.start_task_from_form() method is called in a parallel thread from backend/app/routes/user_task_execution_run.py and closes access to the database at the end of the method: +```python +[...] +from mojodex_core import * +[...] +def start_task_from_form(self, app_version, use_message_placeholder=False, use_draft_placeholder=False, tag_proper_nouns=False): + try: + [...] + db.session.close() + except Exception as e: + db.session.close() +[...]

          +
          +

          Real-Time Interaction Management

          +

          Using SocketIO through flask_socketio, the Backend enables interactive sessions between the assistant and the user, ensuring instant feedback and dynamic conversation flow.

          +

          backend/app/app.py +

          [...]
+from flask_socketio import SocketIO
+
+server_socket = SocketIO(app, ping_timeout=40, ping_interval=15, logger=False, engineio_logger=False, cors_allowed_origins="*", )
+[...]
+

          +

          Reception of User Messages

          +
            +
          • For the web application, user messages in chat are received through socketio user_message event. +
            @server_socket.on('user_message')
+def handle_message(data):
+    emit("user_message_reception", {"success": "User message has been received", "session_id": data.get("session_id")})
+    socketio_event_callback('user_message', data)
+
            +

            Note that for mobile application, we moved from receiving user messages through socketio to a REST API endpoint for robustness. We will probably do the same for web application in the future.

            +
            +
            • +
          +

          Emission of Assistant Messages

          +

          To separate messages from one user to another, we use Socketio's "room" principle along with Mojodex's Session management.

          +

          A Mojodex's Session represents an interaction between the user and the assistant. It contains the list of messages exchanged during this interaction and is identified by a unique session_id.

          +

          The user can resume a Session at any moment, for example when re-opening a task from their history.

          +

          The Session's unique session_id is used to identify Socketio's room for the user and the assistant to exchange messages. In the emission code, this corresponds to the to parameter of the server_socket.emit() method.

          +
            +
          • +

            Assistant partial messages, containing tokens as streamed by the LLM, are sent as soon as received through socketio dedicated events (mojo_token and draft_token). This allow to stream the assistant's response in real-time to the user so that the user can see the assistant's response being built. +backend/app/models/session.py +

            [...]
+def _mojo_token_callback(self, partial_text):
+    try:
+        server_socket.emit('mojo_token', {"text": partial_text, 'session_id': self.id}, to=self.id)
+    except Exception as e:
+        raise Exception(f"_mojo_token_callback :: {e}")
+[...]
+

            +
            • +
          • +

            Assistant messages, whether there are simple messages or containing task's result (produced_text) are sent through socketio using backend/app/socketio_message_sender.py along with a callback. The callback must be called by the frontend to confirm the message has been received (acknowledged), if not, the assistant will send the message again every 5 seconds for 10minutes or until the message is acknowledged. +

            [...]
+def send_mojo_message_with_ack(self, message, session_id, event_name='mojo_message', remaining_tries=120):
+        [...]
+        server_socket.emit(event_name, message, to=session_id, callback=self._mojo_message_received)
+
+        def waiting_for_acknowledgment():
+            [...]
+
+        # start a timer of 5 seconds, in 5 seconds if it has not been killed, it will resend the message. Use executor to run async
+        if remaining_tries > 0:
+            executor.submit(waiting_for_acknowledgment)
+
            +receving_messages

            +
            • +
          +

          System 1/System 2 Abstraction

          +

          To draw a parallel with the System 1/System 2 abstraction, Mojodex's Backend functions as the digital counterpart to System 1 thinking.

          +

          It swiftly processes incoming data and orchestrates real-time interactions similar to our intuitive cognitive processes. Operating seamlessly like System 1, the Backend ensures instantaneous feedback and dynamic conversation flows, akin to rapid, non-conscious decision-making.

          + + + + + + + + + + + + + +
          +
          + + + +
          + +
          + + + +
          +
          +
          +
          + + + + + + + + + + \ No newline at end of file diff --git a/technical-architecture/background/index.html b/technical-architecture/background/index.html new file mode 100644 index 00000000..84c93c99 --- /dev/null +++ b/technical-architecture/background/index.html @@ -0,0 +1,2142 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Background - Mojodex - Open Source Enterprise Digital Assistant Platform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + +
          + + + + +
          + + +
          + +
          + + + + + + + + + +
          +
          + + + +
          +
          +
          + + + + + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          + + + + +

          MOJODEX Background

          +

          The background backend is responsible for processing data in the background. +It is useful for long-running process that would otherwise block the main backend. +It is also useful for processing batch data (like sending emails or notifs to a group of users).

          +

          Structure

          +

          The background is a Flask application which routes can only be called by Mojodex's backend.

          +
          +

          The background must be deployed in the same network as the backend so that the backend can call its routes but its routes must not be accessible from the outside.

          +
          +

          background/app/app.py +

          [...]
+from flask import Flask
+from flask_restful import Api
+
+app = Flask(__name__)
+api = Api(app)
+
+from http_routes import *
+HttpRouteManager(api)
+[...]
+

          +

          The API routes are all defined in background/app/http_routes.py in the HttpRouteManager class, pointing to related Flask Resources in background/app/routes/.

          +

          Usage

          +

          When Mojodex's Backend calls Mojodex's Background to manage a process, it sends a request using REST API. Then, the route always process as follow:

          +

          The Cortex are (mainly) located in background/app/models/cortexdirectory (those that are not may be refactored in coming updates). Those Cortex are classes implemented by the requested Flask Resource with 2 objectives:

          +
            +
          • +
              +
            1. Load all data needed for the process from the database. This is done synchronously in the constructor of the Cortex. This is to keep database access in the main thread and avoid database lock issues.
              2. +
            +
            • +
          • +
              +
            1. Process the data in the main method of the Cortext in a parallel thread launched in the Flask Resource. This main method does not have a consistent name for now and is specific to each process/cortex. An abstract class Cortexshould be added in the future to ensure a consistent structure for all cortexes.
              2. +
            +
            • +
          +
          +

          Note: "Cortex" name is a reference to the outer most layer of the brain. The cortex is involved in higher processes in the human brain, including memory, thinking, learning, reasoning, problem-solving, emotions, consciousness and functions related to your senses. Here, this is an abstraction to suggest the autonomy of this technical component regarding its process.

          +
          +

          If any additional data from the database is needed during the process, a request to the Backend will retrieve it.

          +
            +
          • +
              +
            1. Finally, if any data needs to be inserted or updated in the database, this is done by calling a Backend API route from the Cortex. This way, we ensure responsability segregation and every data written in the database is done by the Backend.
              2. +
            +
            • +
          +
          class Cortex:
+
+    def __init__(self, user_task_execution):
+        # Load all data needed for the process from the database
+
+
+    def main_method(self):
+        # Run process
+        # Send created or updated data to backend for update in database
+
          +

          Functionalities

          +

          For now, Mojodex's Background manages 8 processes:

          +

          UserTaskExecutionTitleAndSummary

          +
            +
          • Resource: background/app/routes/user_task_execution_title_and_summary.py
            • +
          • Cortex: background/app/models/cortex/user_task_execution_title_and_summary_cortex.py
            • +
          • Launched from: backend/app/models/tasks/task_manager.py
            • +
          +

          This process is called each time the user sends a message to a task. It updates (or creates if not exists) the title and summary of the task from the ongoing conversation.

          +

          FirstSessionMessage

          +
            +
          • Resource: background/app/routes/first_session_message.py
            • +
          • Cortex: background/app/models/cortex/first_session_message_cortex.py
            • +
          • Launched from: backend/app/models/session.py
            • +
          +

          This process is called when a user starts a new session. It generates a session title that could be useful to identify the session later, in a history interface for example.

          +

          ExtractTodos

          +
            +
          • Resource: background/app/routes/extract_todos.py
            • +
          • Cortex: background/app/models/cortex/extract_todos_cortex.py
            • +
          • Launched from: backend/app/routes/extract_todos.py
            • +
          +

          This process is launched at the end of a task to extract any next step the user could have mentioned explictely in the task process and turn those into To-Do items to add to the user's To-Do list.

          +

          RescheduleTodo

          +
            +
          • Resource: background/app/routes/reschedule_todo.py
            • +
          • Cortex: background/app/models/cortex/reschedule_todo_cortex.py
            • +
          • Launched from: backend/app/routes/todo_scheduling.py
            • +
          +

          This process is called to reschedule a To-Do item that passed its due date without being deleted or marked as completed.

          +

          ParseWebsite

          +
            +
          • Resource: background/app/routes/parse_website.py
            • +
          • Cortex: background/app/models/document/website_parser.py
            • +
          • Launched from: backend/app/routes/company.py && backend/app/routes/resource.py
            • +
          +

          This process is called to parse a website, extract its content, cut it into chunks and load it in database as a document. It is used when user provides a new website as resource.

          +

          UpdateDocument

          +
            +
          • Resource: background/app/routes/update_document.py
            • +
          • Cortex: background/app/models/document/website_parser.py || background/app/models/document/document_manager.py depending if the update is an edition or addition.
            • +
          • Launched from: backend/app/routes/resource.py
            • +
          +

          This process is called to update a document in the database when user provides a new version of a resource.

          +

          EventsGeneration

          +
            +
          • Resource: background/app/routes/event_generation.py
            • +
          • Cortex: background/app/models/events/event_generator.py (abstract class, implementation depends on parameters of request)
            • +
          +

          This process is called any time the backend wants to send a notification to the user whether it is a mail, push notification... The Background is only responsible for notification content generation.

          +

          System 1/System 2 Abstraction

          +

          To draw a parallel with the System 1/System 2 abstraction, Mojodex's Background embodies the deliberate nature of System 2 thinking.

          +

          It meticulously manages long-running processes and handles batch data tasks with careful attention, akin to System 2's deliberate memory search and complex computations. This component ensures the smooth functioning of Mojodex's operations, providing the necessary depth and thoroughness to complement the swift responsiveness of the Backend.

          + + + + + + + + + + + + + +
          +
          + + + +
          + +
          + + + +
          +
          +
          +
          + + + + + + + + + + \ No newline at end of file diff --git a/technical-architecture/database/index.html b/technical-architecture/database/index.html new file mode 100644 index 00000000..ab21c983 --- /dev/null +++ b/technical-architecture/database/index.html @@ -0,0 +1,2102 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Database - Mojodex - Open Source Enterprise Digital Assistant Platform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + +
          + + + + +
          + + +
          + +
          + + + + + + + + + +
          +
          + + + +
          +
          +
          + + + + + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          + + + + +

          Database

          +

          This directory contains the SQL scripts to initialize the Mojodex database into a Docker container.

          +

          The Mojodex database is a PostgreSQL database using the pg_vector extension to store and query vector data.

          +

          The database is launched as a Docker container and is accessed by the backend and background services. See general documentation for more information.

          +

          Database schema

          +

          You can have a look at the database schema at dbdiagram.io: +https://dbdiagram.io/d/MojodexDatabase-659d0645ac844320ae85b440

          +

          Prerequisites

          +
            +
          • Docker
            • +
          +

          Installation

          +

          Clone the repository and navigate to the pgsql directory:

          +
          git clone
+cd mojodex/pgsql
+
          +

          Database configuration

          +

          The Dockerfile contains default environment variables for the PostgreSQL database. You can modify these variables to suit your environment.

          +
          [...]
+ENV POSTGRES_DB=<database_name>
+ENV POSTGRES_USER=<username>
+ENV POSTGRES_PASSWORD=<password>
+[...]
+
          +
          +

          Note: The POSTGRES_DB, POSTGRES_USER, and POSTGRES_PASSWORD environment variables are required to initialize the database.

          +

          ⚠️ Do not forget to change the default values in the Dockerfile before building the Docker container.

          +
          +

          Initialization of Mojodex data

          +

          The init-mojodex-data.sql file contains the SQL scripts to create the Mojodex schema and data. You can modify this file to add or remove data.

          +

          This will create the following Mojodex config: +- user: user@demo.com +- password: password +- product: demo +- task: meeting_recap

          +

          You will be able to use the default user and password to connect to your assistant to check everything is working.

          +

          Build

          +

          To build the Docker container, run the following command:

          +
          docker build -t mojodex-db .
+
          +

          Usage

          +

          To initialize the database, run the following command:

          +
          docker run -d --name mojodex-db -p 5432:5432 mojodex-db
+
          +

          This will create a Docker container running a PostgreSQL database with the Mojodex schema and data.

          +

          Troubleshooting

          +

          To check if the database is running, run the following command:

          +
          psql -h localhost -U <username> -d <database_name>
+
          +

          Then, use your password to connect to the database and look at the tables:

          +
          \dt
+
          +

          You should see the following tables:

          +
                                      List of relations
+ Schema |                   Name                    | Type  |   Owner    
+--------+-------------------------------------------+-------+------------
+ public | md_calendar_suggestion                    | table | <your_user>
+ public | md_company                                | table | <your_user>
+ public | md_device                                 | table | <your_user>
+ public | md_document                               | table | <your_user>
+ public | md_document_chunk                         | table | <your_user>
+ public | md_error                                  | table | <your_user>
+ public | md_event                                  | table | <your_user>
+ public | md_home_chat                              | table | <your_user>
+ public | md_message                                | table | <your_user>
+ public | md_platform                               | table | <your_user>
+ public | md_predefined_action_displayed_data       | table | <your_user>
+ public | md_produced_text                          | table | <your_user>
+ public | md_produced_text_version                  | table | <your_user>
+ public | md_product                                | table | <your_user>
+ public | md_product_category                       | table | <your_user>
+ public | md_product_category_displayed_data        | table | <your_user>
+ public | md_product_displayed_data                 | table | <your_user>
+ public | md_product_task                           | table | <your_user>
+ public | md_purchase                               | table | <your_user>
+ public | md_session                                | table | <your_user>
+ public | md_task                                   | table | <your_user>
+ public | md_task_displayed_data                    | table | <your_user>
+ public | md_task_platform_association              | table | <your_user>
+ public | md_task_predefined_action_association     | table | <your_user>
+ public | md_text_edit_action                       | table | <your_user>
+ public | md_text_edit_action_displayed_data        | table | <your_user>
+ public | md_text_edit_action_text_type_association | table | <your_user>
+ public | md_text_type                              | table | <your_user>
+ public | md_todo                                   | table | <your_user>
+ public | md_todo_scheduling                        | table | <your_user>
+ public | md_user                                   | table | <your_user>
+ public | md_user_task                              | table | <your_user>
+ public | md_user_task_execution                    | table | <your_user>
+ public | md_user_vocabulary                        | table | <your_user>
+
          +

          Entities

          +

          Each table is represented as a python class in mojodex_code/entities.py. This file is generated using sqlacodegentool: +

          sqlacodegen postgresql+psycopg2://$DBUSER:$DBPASS@localhost:5432/$DBNAME --outfile mojodex_core/entities/db_base_entities.py
+

          +

          ⚠️ Be sure to install sqlacodegen with the appropriate pg_vector features: +

          python3 -m pip install git+https://github.com/hoomano/sqlacodegen.git@feature-pgvector
+

          +

          Go further

          +

          You can use the Mojodex API to create new users, products, tasks, etc. +See the Mojodex API documentation for more information.

          + + + + + + + + + + + + + +
          +
          + + + +
          + +
          + + + +
          +
          +
          +
          + + + + + + + + + + \ No newline at end of file diff --git a/technical-architecture/integration/hubspot/index.html b/technical-architecture/integration/hubspot/index.html new file mode 100644 index 00000000..c1468bf8 --- /dev/null +++ b/technical-architecture/integration/hubspot/index.html @@ -0,0 +1,1954 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Hubspot - Mojodex - Open Source Enterprise Digital Assistant Platform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + +
          + + + + +
          + + +
          + +
          + + + + + + + + + +
          +
          + + + +
          +
          +
          + + + + + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          + + + + +

          Hubspot integration

          +

          Hubspot integration stands as a demonstration of how to integrate a third-party service with the platform. The integration is implemented as an action on task result to export a produced text directly to Hubspot.

          +

          Configuration

          +

          Using Hubspot integration requires setting an HUBSPOT_ACCESS_TOKEN variable in the .env file of Mojodex project. The access token can be obtained from the Hubspot account settings.

          +

          For the "export to Hubspot" button to be display in mobile application, ensure the HUBSPOT_BUTTON variable is set to "true" in the .env file of the mobile application.

          +

          Export task result

          +

          Backend

          +

          On the backend side, the integration is implemented as 2 routes. Resources can be found in backend/app/routes/integrations/hubspot.py file.

          +
            +
          • +

            GET route: retrieves n_results from search_type ('companies', 'contacts' or 'deals') which name starts with search_string. This route is used for user to browse their Hubspot account and select the entity to which the text will be exported.

            +
            • +
          • +

            POST route: exports the task result associated with produced_text_version_pk as an engagement_type (among 'notes', 'emails', 'calls' and 'meetings') to associated_object_id of associated_object_type (among 'companies', 'contacts' or 'deals').

            +
            • +
          +

          Frontend

          +

          On frontend side, only mobile application supports Hubspot integration for now. The integration is implemented as an export button in the task result details view.

          +

          The button opens a modal with a form to select the entity to which the text will be exported.

          +

          Hubspot form 1 +Hubspot form 2 +Hubspot form 3 +Hubspot form 4 +Hubspot form 5

          +

          Future work - Hubspot as third party tool

          +
            +
          • Implement a tool to browse Hubspot entities past notes
            • +
          • Use this tool to create a background task Pre-call Brief: Create a concise summary of past interactions with the individual prior to initiating a business-oriented phone call.
            • +
          + + + + + + + + + + + + + +
          +
          + + + +
          + +
          + + + +
          +
          +
          +
          + + + + + + + + + + \ No newline at end of file diff --git a/technical-architecture/llm-features/azure/index.html b/technical-architecture/llm-features/azure/index.html new file mode 100644 index 00000000..536cebcb --- /dev/null +++ b/technical-architecture/llm-features/azure/index.html @@ -0,0 +1,1850 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Azure OpenAI Services - Mojodex - Open Source Enterprise Digital Assistant Platform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + +
          + + + + +
          + + +
          + +
          + + + + + + + + + +
          +
          + + + +
          +
          +
          + + + + + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          + + + + +

          Azure Open AI Services

          +

          Setup the configuration keys in your models.conf file:

          +
          GPT4_AZURE_OPENAI_DEPLOYMENT_ID=<your-deployment-id>
+GPT4_AZURE_OPENAI_API_BASE=<your-api-base>
+GPT4_AZURE_OPENAI_API_VERSION=<your-api-version>
+GPT4_AZURE_OPENAI_KEY=<your-key>
+
          +

          Coverage

          +

          GPT4-Turbo has been used to develop the entire Mojodex platform. The coverage is complete.

          + + + + + + + + + + + + + +
          +
          + + + +
          + +
          + + + +
          +
          +
          +
          + + + + + + + + + + \ No newline at end of file diff --git a/technical-architecture/llm-features/index.html b/technical-architecture/llm-features/index.html new file mode 100644 index 00000000..ef99def4 --- /dev/null +++ b/technical-architecture/llm-features/index.html @@ -0,0 +1,2092 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Overview - Mojodex - Open Source Enterprise Digital Assistant Platform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + +
          + + + + +
          + + +
          + +
          + + + + + + + + + +
          +
          + + + +
          +
          +
          + + + + + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          + + + + +

          Large Language Models in Mojodex

          +

          As an AI agent, Mojodex uses cognitive functions powered by LLMs.

          +

          Providers

          + +

          Features coverage

          +

          As of 2024-03-05, the following features are supported by the providers:

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          FeatureGPT-4 Turbomistral-largemistral-mediummistral-tiny
          ANSWER_USER✅✅~❌
          CALENDAR_SUGGESTION_GENERATOR✅✅TBDTBD
          CALENDAR_SUGGESTION_NOTIFICATION✅✅TBDTBD
          CALENDAR_SUGGESTION_WAITING_TEXT✅✅TBDTBD
          CHIT_CHAT✅✅TBDTBD
          CORRECT_COMPANY_INFO_FROM_FEEDBACK✅✅TBDTBD
          DAILY_EMAIL_GENERATOR✅✅TBDTBD
          DAILY_NOTIFICATION✅✅TBDTBD
          DOCUMENT_EMBEDDING✅✅TBDTBD
          EXTRACT_COMPANY_INFO_FROM_WEBSITE✅✅TBDTBD
          GENERATE_SESSION_TITLE✅✅TBDTBD
          GENERATE_TASK_JSON✅✅TBDTBD
          GET_LANGUAGE✅✅TBDTBD
          HOME_CHAT✅✅TBDTBD
          INTERNAL_MEMORY_INFORMATION_EXTRACTOR✅✅TBDTBD
          IS_EDITION_WRITING✅✅TBDTBD
          PRODUCED_TEXT_EMBEDDER✅✅TBDTBD
          PRODUCED_TEXT_QUERY_EMBEDDER✅✅TBDTBD
          SPELLING_CORRECTOR✅✅TBDTBD
          TASK_CLASSIFICATION✅✅TBDTBD
          TASK_EXECUTION_SUMMARIZER✅✅TBDTBD
          TASK_TOOL_EXECUTION_MESSAGE_WRITER✅✅TBDTBD
          TASK_TOOL_NOTIFICATION✅✅TBDTBD
          TEXT_EDIT_EXECUTOR✅✅TBDTBD
          TEXT_TYPE_DEDUCER✅✅TBDTBD
          TODOS_EXTRACTOR✅✅TBDTBD
          TODOS_RESCHEDULER✅✅TBDTBD
          TOOL_PARAMS_GENERATOR✅✅TBDTBD
          WEBSITE_CHUNK_VALIDATOR✅✅TBDTBD
          WEB_SCRAPPER✅✅TBDTBD
          + + + + + + + + + + + + + +
          +
          + + + +
          + +
          + + + +
          +
          +
          +
          + + + + + + + + + + \ No newline at end of file diff --git a/technical-architecture/llm-features/mistral/index.html b/technical-architecture/llm-features/mistral/index.html new file mode 100644 index 00000000..3454d0f0 --- /dev/null +++ b/technical-architecture/llm-features/mistral/index.html @@ -0,0 +1,1960 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Mistral AI - Mojodex - Open Source Enterprise Digital Assistant Platform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + +
          + + + + +
          + + +
          + +
          + + + + + + + + + +
          +
          + + + +
          +
          +
          + + + + + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          + + + + +

          Mistral AI

          +

          To use Mistral AI, 2 ways:

          + +
          +

          Configure your .env with Mistral API key

          +
          # Mistral API
+MISTRAL_API_KEY=your-api-key
+
          +
          + +
          +

          Azure Mistral API

          +
          # Azure Mistral API
+MISTRAL_AZURE_API_BASE=<your-azure-api-endpoint>
+MISTRAL_AZURE_API_KEY=<your-azure-api-key>
+
          +
          +

          Coverage

          +
          +

          For the assessment, mistral models have been tested on the most challenging feature: "ANSWER_USER" on the Mojodex platform.

          +

          See blog post for a better understanding of the challenge: Advanced Prompting Strategies for Digital Assistant Development

          +
          +

          mistral-large ✅

          +
          +

          🎉 full coverage

          +

          mistral-large has been tested on all features and provides a full coverage of the Mojodex cognitive functions.

          +
          +

          mistral-medium 🚧

          +

          The results are promising, but the full coverage is not yet available.

          +
          +

          Some results so far

          +

          Overall mistral-medium gets the idea behind the data/prompts/tasks/run.txt with the following limitations observed:

          +
            +
          • 👍 Straightforward implementation of the API
            • +
          • 👍 Follows the overall logic of the prompt
            • +
          • 😕 Big variations between runs in interpretation
            • +
          • 😕 Not reliably steerable to defined in the prompt
            • +
          +
          +

          Work in progress

          +
            +
          • Prepare the Mistral AI provider implementation
            • +
          • Run basic tests with existing prompts
            • +
          • Complete the assessment on all features for mistral-large
            • +
          • Complete the assessment on all features for mistral-medium
            • +
          • Prompt Tuning: mojodex_core/prompts/* has been crafted for GPT-4 and GPT-4 Turbo. We need to craft prompts for Mistral AI more specifically.
            • +
          • Explore guardrailing strategies to steer the model to the desired output
            • +
          • For non-supported features, we can explore fine-tuning the model on our own data gathered in /data/prompts_dataset
            • +
          + + + + + + + + + + + + + +
          +
          + + + +
          + +
          + + + +
          +
          +
          +
          + + + + + + + + + + \ No newline at end of file diff --git a/technical-architecture/llm-features/mpt/index.html b/technical-architecture/llm-features/mpt/index.html new file mode 100644 index 00000000..ad69c75d --- /dev/null +++ b/technical-architecture/llm-features/mpt/index.html @@ -0,0 +1,2186 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Mojodex Prompt Template - Mojodex - Open Source Enterprise Digital Assistant Platform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + +
          + + + + +
          + + +
          + +
          + + + + + + + + + +
          +
          + + + +
          +
          +
          + + + + + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          + + + + +

          Mojodex Prompt Template (MPT) File Format

          +

          Introduction

          +

          This document introduces the Mojodex Prompt Template (.mpt) file format, a new standard designed to streamline and enhance the process of generating inputs for large language models (LLMs) within our development workflows. The .mpt format is a composition of jinja2 templating, HTML-like custom tagging for document formatting, and unstructured pseudo-code, enabling a flexible, powerful approach to crafting LLM prompts.

          +

          Key Principles

          +
            +
          1. Prompting is coding: jinja2 templating and pseudo-code for dynamic, complex prompts.
            2. +
          2. Divide and conquer: unified prompting library for easy multi-LLM architecture strategy.
            3. +
          3. Token poor: reduce the token size of the prompt to optimize the LLM input.
            4. +
          +

          Motivation

          +

          As our reliance on LLMs increases, the complexity and variety of prompts we need to generate have grown. Traditional methods of prompt creation often involve a cumbersome, error-prone process of manually editing and formatting text, lacking standardization and efficiency. The .mpt format aims to address these challenges by providing:

          +
            +
          • Standardization: A unified file format allows for consistent prompt creation across different projects and teams.
            • +
          • Efficiency: The use of jinja2 templating and custom tags streamlines the process of generating dynamic, complex prompts.
            • +
          • Flexibility: Support for unstructured pseudo-code and custom tags ensures that developers can express a wide range of logic and formatting requirements.
            • +
          • Version Control: A dash bang style header in each .mpt file specifies the LLM model version, author, and additional metadata, facilitating better management and compatibility of prompt templates over time.
            • +
          +

          .mpt File Format Specification

          + +

          The .mpt file begins with a dash bang style header that includes essential metadata:

          +
          #! gpt4-turbo/2023-03-15-preview
+#! gpt-4-turbo-preview
+
          +

          Body

          +

          The body of the .mpt file contains a mix of jinja2 templates, custom HTML-like tags, and pseudo-code:

          +
          <template>
+    <title>
+        Hello, {{ name }}! This is a sample template.   
+    </title>    
+    <content>
+        <if not all informations required display a special message, otherwise do something>
+    </custom_logic>
+</template>
+
          +

          Advanced Templating Techniques

          +

          To accommodate the unique requirements and capabilities of different LLM models within a single MPT file, advanced templating techniques are employed. This approach allows developers to specify model-specific prompts and logic, ensuring optimal interaction with each model's unique interpretation and response characteristics.

          +

          Example of Model-Specific Templating

          +

          Consider a scenario where different models, such as mistral-medium, gpt-4-turbo, and mistral-large, require tailored prompts to achieve the same task. The .mpt file can contain directives (shebangs) and conditional templating to customize the prompt for each model:

          +
          #! mistral:instruct
+#! mistral-medium
+#! gpt4-turbo/2023-03-15-preview
+#! gpt-4-turbo-preview
+#! mistral-large
+
+YOUR CONTEXT
+{{mojo_knowledge}}
+
+GLOBAL CONTEXT
+{{user_datetime_context}}
+
+USER NAME
+{{username}}
+
+{% if user_company_knowledge %}USER'S COMPANY KNOWLEDGE
+{{user_company_knowledge}}{% endif %}
+
+Here is the task achieved by your user.
+-------
+TASK TO ACCOMPLISH
+{{task_name}}: {{task_definition}}
+
+USER INPUTS
+{{ user_task_inputs | tojson(indent=4) }}
+
+{% if user_messages_conversation %}CONVERSATION
+{{ user_messages_conversation }}{% endif %}
+-------
+
+{# fewshot for small models like mistral7b, i.e. mistral:instruct with ollama #}
+{% if model in ["mistral:instruct"] %}
+EXAMPLES OF GOOD EXECUTIONS OF THE TASK SUMMARIZATION:
+
+EXAMPLE 1:
+------
+TASK TO ACCOMPLISH
+structure_ideas_into_doc: The user needs assistance to turn ideas into a structured written doc
+
+USER INPUTS:
+pr\\u00e9pare une note de musique
+
+TASK RESULT:
+<title>Structuration d'une Note de Musique</title>
+<summary>Assistance fournie pour transformer des id\u00e9es en un document structur\u00e9. Le sujet principal \u00e9tait la pr\u00e9paration d'une note de musique. Le processus a impliqu\u00e9 la transcription et l'organisation des id\u00e9es fournies.</summary>
+------
+{% endif %}
+
+Give a title to this task execution so that the user can remember what the task was about. Give important information in the title such as names, subjects...
+Make a summary of this task execution so that the user can remember what the task was about.
+Summary is addressed to the user. No need to call them.
+10 words max for the title and 3 sentences max for the summary.
+Format:
+<title>TITLE</title>
+<summary>SUMMARY</summary>
+
+Use the same language as the user.
+No talk, just title and summary.
+
          +

          This example showcases how to define complex logic and conditionally include content based on the model being used, offering unparalleled flexibility in crafting prompts for diverse LLMs.

          +

          MPT Workflow

          +

          Developers create .mpt files following the format specification. The runtime sequence involves:

          +
          graph LR
+    A[Cleaning\nDashbang] --> B[Jinja2\nResolution]
+    B --> C[Generate\nLLM Input]
+    C --> D["(soon) Compression"]
          +
            +
          1. Cleaning Dashbang: The header is cleaned from the processing input to the LLM.
            2. +
          2. Jinja2 Resolution: Templates are processed to substitute variables and expressions with actual values.
            3. +
          3. Generate LLM Input: The cleaned, resolved template serves as the input for the appropriate LLM.
            4. +
          4. (soon) Compression: Optimize the LLM input with compression algorithms to reduce the token size – this is optional and depends on the LLM model & tokenizer.
            5. +
          +

          Example

          +
          +

          file translation.mpt

          +

          ```

          +

          ! gpt4-turbo/2023-03-15-preview

          +
          +

          ! gpt-4-turbo-preview

          +
          #! mistral-large
+
+Translate this text to {{language}}:
+<text_start>
+{{text}}
+<text_end>
+If text is already in {{language}}, return it as is.
+No talk, just translation.
+Do not include tags in response.
+
+
+```
+
          +
          +

          Code

          +
          >>> mpt = MPT('translation.mpt', text='hello', language='english')
+>>> print(mpt)
+MPT: translation.mpt
+
+>>> print(mpt.prompt)
+Translate this text to english:
+<text_start>
+hello
+<text_end>
+If text is already in english, return it as is.
+No talk, just translation.
+Do not include tags in response.
+
+
+
+>>> print(mpt.dashbangs)
+[{'model_name': 'gpt-4-turbo', 'version': '2023-03-15-preview'}, {'model_name': 'mistral-large', 'version': 'latest'}]
+
+>>> print(mpt.models)
+['gpt-4-turbo', 'mistral-large']
+
+>>> print(mpt.tags) 
+['<text_start>', '<text_end>']   
+
          +
          +

          Implementation Plan

          +

          The implementation involves developing a VSCode extension that supports the .mpt file format, including syntax highlighting, linting, and integration with LLM runtime processes.

          + + + + + + + + + + + + + +
          +
          + + + +
          + +
          + + + +
          +
          +
          +
          + + + + + + + + + + \ No newline at end of file diff --git a/technical-architecture/llm-features/openai/index.html b/technical-architecture/llm-features/openai/index.html new file mode 100644 index 00000000..9aa6bb65 --- /dev/null +++ b/technical-architecture/llm-features/openai/index.html @@ -0,0 +1,1848 @@ + + + + + + + + + + + + + + + + + + + + + + + + + OpenAI - Mojodex - Open Source Enterprise Digital Assistant Platform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + +
          + + + + +
          + + +
          + +
          + + + + + + + + + +
          +
          + + + +
          +
          +
          + + + + + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          + + + + +

          Open AI

          +

          Setup the API key in your models.conf file:

          +

          OPENAI_API_KEY=your-api-key
+
          +You can specify the provider to use as a backup in case the main provider reaches its rate limit by configuring the appropriate section in the models.conf file.

          +

          Coverage

          +

          GPT4-Turbo has been used to develop the entire Mojodex platform. The coverage is complete.

          + + + + + + + + + + + + + +
          +
          + + + +
          + +
          + + + +
          +
          +
          +
          + + + + + + + + + + \ No newline at end of file diff --git a/technical-architecture/overview/index.html b/technical-architecture/overview/index.html new file mode 100644 index 00000000..cf9bdd4f --- /dev/null +++ b/technical-architecture/overview/index.html @@ -0,0 +1,1934 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Overview - Mojodex - Open Source Enterprise Digital Assistant Platform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + +
          + + + + +
          + + +
          + +
          + + + + + + + + + +
          +
          + + + +
          +
          +
          + + + + + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          + + + + +

          Global Architecture

          +

          Principles

          +

          Mojodex Architecture is built upon the foundational principles of System 1/System 2 abstraction, a concept derived from cognitive psychology.

          +
            +
          • System 1 represents fast, intuitive, and unconscious thinking.
            • +
          • System 2 embodies slower, deliberate, and analytical thought processes.
            • +
          +

          By integrating these cognitive frameworks into its design, Mojodex aims to create a digital assistant system that combines the rapid responsiveness of System 1 with the careful decision-making of System 2.

          +

          This documentation provides an overview of Mojodex's architecture, exploring how these cognitive principles inform its structure and functionality.

          +

          Learn more about the System 1/System 2 abstraction

          +

          Architecture Overview

          +

          Architecture Overview

          +

          Components

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          ComponentRoleDocumentation Link
          BackendCommunication hub for real-time dialogue and management of application business logic. Mojodex's Backend serves as the digital counterpart to System 1 thinking.Backend Documentation
          BackgroundHandles intensive tasks behind-the-scenes. Useful for Long-Running Processes and Batch Data Processing. Mojodex's Background embodies the deliberate nature of System 2 thinking.Background Documentation
          SchedulerExecutes code at specific times/intervals. Mojodex's Scheduler embodies a proactive aspect akin to System 2 thinkingScheduler Documentation
          DatabaseStores and manages dataDatabase Documentation
          Mobile AppInterface for mobile devicesMobile App Documentation
          Web AppInterface for web browsersWeb App Documentation
          Next ProxyManages and authenticates requests from the webapp interface to the backend.Next Proxy Documentation
          + + + + + + + + + + + + + +
          +
          + + + +
          + +
          + + + +
          +
          +
          +
          + + + + + + + + + + \ No newline at end of file diff --git a/technical-architecture/scheduler/index.html b/technical-architecture/scheduler/index.html new file mode 100644 index 00000000..364aa6b3 --- /dev/null +++ b/technical-architecture/scheduler/index.html @@ -0,0 +1,1984 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Scheduler - Mojodex - Open Source Enterprise Digital Assistant Platform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + +
          + + + + +
          + + +
          + +
          + + + + + + + + + +
          +
          + + + +
          +
          +
          + + + + + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          + + + + +

          Scheduler

          +

          The scheduler is responsible for running tasks at specific times or intervals. +It is useful for running tasks that are not directly related to a user's request, like sending emails or notifs to a group of users. +It is also useful for proactivity, to let Mojo work on something by checking state of a user or a task at a certain frequency and act accordingly.

          +

          Functionalities

          +

          Mojodex's Scheduler has 2 main directory containing:

          +
            +
          • Scheduled tasks scheduler/app/scheduled_tasks
            • +
          • Time based tasks scheduler/app/time_based_tasks
            • +
          +

          Those tasks are run thanks to the scheduler/app/main.py file that keeps the scheduler running and checks for tasks to run using the schedule library.

          +
          while True:
+    schedule.run_pending()
+    time.sleep(1)
+
          +

          Scheduled tasks

          +

          Scheduled tasks contains code that are run at a specific frequency. +

          ### Abstract class named ScheduledTask that has a method job() and a constructor that runs  schedule.every(X).seconds.do(job), X being the number of seconds between executions (param)
+from abc import ABC, abstractmethod
+import schedule
+
+class ScheduledTask(ABC):
+
+    def __init__(self, n_seconds):
+        schedule.every(n_seconds).seconds.do(self.job)
+
+    @abstractmethod
+    def job(self):
+        """Method that will be executed every n_seconds seconds"""
+        pass
+

          +

          As Mojodex's Scheduler does not have database access, Scheduled tasks jobs are Backend API calls. Performed at a regular interval, they are useful for checking the state of a user or a task and act accordingly.

          +

          The Scheduled tasks are implemented in the scheduler/app/main.py file.

          +
          [...]
+# Scheduled tasks
+PurchasesExpirationChecker(3600) # check ended free_plan every 1 hour
+ExtractTodos(600) # extract todos every 10 minutes
+RescheduleTodos(3600) # reschedule todos every 1 hour
+if push_notifications:
+    CalendarSuggestionNotificationSender(600) # send calendar suggestion notifications every 10 minutes
+    SendDailyNotifications(3600) # send daily notifications every 1 hour (filtered by timezone)
+if emails:
+    #SendDailyEmails(3600) # send daily emails every 1 hour (filtered by timezone)
+    SendTodoDailyEmails(3600) # send todo daily emails every 1 hour (filtered by timezone)
+    CheckDisengagedFreeTrialUsers(86400)  # check disengaged free trial users every day
+FirstHomeChatOfWeek(3600)
+[...]
+
          +

          Time based tasks

          +

          Time based tasks contains code that are run at a specific time of the day. +

          from abc import ABC, abstractmethod
+import schedule
+
+
+class TimeBasedTask(ABC):
+
+    def __init__(self, hour=10, minute=0, second=0, weekday=None,):
+        if weekday is not None:
+            schedule.every().monday.at(f"{hour}:{minute}:{second}").do(self.job) if weekday == 0 else None
+            schedule.every().tuesday.at(f"{hour}:{minute}:{second}").do(self.job) if weekday == 1 else None
+            schedule.every().wednesday.at(f"{hour}:{minute}:{second}").do(self.job) if weekday == 2 else None
+            schedule.every().thursday.at(f"{hour}:{minute}:{second}").do(self.job) if weekday == 3 else None
+            schedule.every().friday.at(f"{hour}:{minute}:{second}").do(self.job) if weekday == 4 else None
+            schedule.every().saturday.at(f"{hour}:{minute}:{second}").do(self.job) if weekday == 5 else None
+            schedule.every().sunday.at(f"{hour}:{minute}:{second}").do(self.job) if weekday == 6 else None
+        else:
+            schedule.every().day.at(f"{hour}:{minute}:{second}").do(self.job)
+
+
+    @abstractmethod
+    def job(self):
+        """Method that will be executed at the specified time"""
+        pass
+

          +

          For now, Mojodex Scheduler doesn't have any time based tasks. Indeed, when running code for a user at a specific time, it is often more relevant to adapt to the user's timezone (for example, to process To-Do rescheduling while user is sleeping). +Therefore, a Scheduled task is more appropriate to trigger a backend call every hour and filter the concerned users by timezone.

          +

          System 1/System 2 Abstraction

          +

          In alignment with the System 1/System 2 framework, Mojodex's Scheduler embodies a proactive aspect akin to System 2 thinking.

          +

          It functions as the deliberate planner within Mojodex, orchestrating scheduled code execution and empowering the assistant to take preemptive actions based on predefined criteria. Just as System 2 engages in deliberate planning and decision-making, the Scheduler ensures the efficient and effective operation of Mojodex by executing tasks at specific times or intervals, optimizing the assistant's performance in a systematic and thoughtful manner.

          + + + + + + + + + + + + + +
          +
          + + + +
          + +
          + + + +
          +
          +
          +
          + + + + + + + + + + \ No newline at end of file diff --git a/technical-architecture/webapp/index.html b/technical-architecture/webapp/index.html new file mode 100644 index 00000000..c3bcabef --- /dev/null +++ b/technical-architecture/webapp/index.html @@ -0,0 +1,1785 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Webapp - Mojodex - Open Source Enterprise Digital Assistant Platform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + +
          + + + + +
          + + +
          + +
          + + + + + + + + + +
          +
          + + + +
          +
          +
          + + + + + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          + + + + +

          Web App

          +

          The Mojodex web app is a web application that allows you to interact with the Mojodex API.

          + + + + + + + + + + + + + +
          +
          + + + +
          + +
          + + + +
          +
          +
          +
          + + + + + + + + + + \ No newline at end of file