From 3367f1dcd726bb3aa03492c907e976ea6be2e5ba Mon Sep 17 00:00:00 2001 From: Laurent Stukkens Date: Tue, 22 Oct 2024 19:04:52 +0200 Subject: [PATCH] 18.0 [ADD] web_hierarchy_list --- web_hierarchy_list/__init__.py | 0 web_hierarchy_list/__manifest__.py | 24 +++ web_hierarchy_list/pyproject.toml | 3 + .../static/description/icon.png | Bin 0 -> 9455 bytes .../src/hierarchy_list_arch_parser.esm.js | 10 ++ .../src/hierarchy_list_arch_utils.esm.js | 163 ++++++++++++++++++ .../src/hierarchy_list_breadcrumb.esm.js | 15 ++ .../static/src/hierarchy_list_breadcrumb.xml | 29 ++++ .../src/hierarchy_list_breadcrumb_item.esm.js | 14 ++ .../src/hierarchy_list_breadcrumb_item.xml | 14 ++ .../src/hierarchy_list_controller.esm.js | 45 +++++ .../static/src/hierarchy_list_controller.xml | 15 ++ .../static/src/hierarchy_list_model.esm.js | 18 ++ .../static/src/hierarchy_list_renderer.esm.js | 104 +++++++++++ .../static/src/hierarchy_list_renderer.scss | 12 ++ .../static/src/hierarchy_list_renderer.xml | 64 +++++++ .../static/src/hierarchy_list_view.esm.js | 16 ++ .../src/hierarchy_list_x2many_field.esm.js | 151 ++++++++++++++++ .../src/hierarchy_list_x2many_field.xml | 19 ++ 19 files changed, 716 insertions(+) create mode 100644 web_hierarchy_list/__init__.py create mode 100644 web_hierarchy_list/__manifest__.py create mode 100644 web_hierarchy_list/pyproject.toml create mode 100644 web_hierarchy_list/static/description/icon.png create mode 100644 web_hierarchy_list/static/src/hierarchy_list_arch_parser.esm.js create mode 100644 web_hierarchy_list/static/src/hierarchy_list_arch_utils.esm.js create mode 100644 web_hierarchy_list/static/src/hierarchy_list_breadcrumb.esm.js create mode 100644 web_hierarchy_list/static/src/hierarchy_list_breadcrumb.xml create mode 100644 web_hierarchy_list/static/src/hierarchy_list_breadcrumb_item.esm.js create mode 100644 web_hierarchy_list/static/src/hierarchy_list_breadcrumb_item.xml create mode 100644 web_hierarchy_list/static/src/hierarchy_list_controller.esm.js create mode 100644 web_hierarchy_list/static/src/hierarchy_list_controller.xml create mode 100644 web_hierarchy_list/static/src/hierarchy_list_model.esm.js create mode 100644 web_hierarchy_list/static/src/hierarchy_list_renderer.esm.js create mode 100644 web_hierarchy_list/static/src/hierarchy_list_renderer.scss create mode 100644 web_hierarchy_list/static/src/hierarchy_list_renderer.xml create mode 100644 web_hierarchy_list/static/src/hierarchy_list_view.esm.js create mode 100644 web_hierarchy_list/static/src/hierarchy_list_x2many_field.esm.js create mode 100644 web_hierarchy_list/static/src/hierarchy_list_x2many_field.xml diff --git a/web_hierarchy_list/__init__.py b/web_hierarchy_list/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/web_hierarchy_list/__manifest__.py b/web_hierarchy_list/__manifest__.py new file mode 100644 index 000000000000..9e8aa7b6e858 --- /dev/null +++ b/web_hierarchy_list/__manifest__.py @@ -0,0 +1,24 @@ +# Copyright 2024 ACSONE SA/NV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +{ + "name": "Web Hierarchy List", + "summary": """ + This modules adds the hierarchy list view, which consist of a list view + and a breadcrumb. + """, + "version": "18.0.1.0.0", + "license": "AGPL-3", + "author": "ACSONE SA/NV,Odoo Community Association (OCA)", + "website": "https://github.com/OCA/web", + "depends": [ + "web", + ], + "assets": { + "web.assets_backend": [ + "web_hierarchy_list/static/src/**/*", + ], + }, + "data": [], + "demo": [], +} diff --git a/web_hierarchy_list/pyproject.toml b/web_hierarchy_list/pyproject.toml new file mode 100644 index 000000000000..4231d0cccb3d --- /dev/null +++ b/web_hierarchy_list/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/web_hierarchy_list/static/description/icon.png b/web_hierarchy_list/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 diff --git a/web_hierarchy_list/static/src/hierarchy_list_arch_parser.esm.js b/web_hierarchy_list/static/src/hierarchy_list_arch_parser.esm.js new file mode 100644 index 000000000000..5ef69bdb059c --- /dev/null +++ b/web_hierarchy_list/static/src/hierarchy_list_arch_parser.esm.js @@ -0,0 +1,10 @@ +import {ListArchParser} from "@web/views/list/list_arch_parser"; +import {treatHierarchyListArch} from "./hierarchy_list_arch_utils.esm"; + +export class HierarchyListArchParser extends ListArchParser { + parse(xmlDoc, models, modelName) { + const archInfo = super.parse(...arguments); + treatHierarchyListArch(archInfo, modelName, models[modelName].fields); + return archInfo; + } +} diff --git a/web_hierarchy_list/static/src/hierarchy_list_arch_utils.esm.js b/web_hierarchy_list/static/src/hierarchy_list_arch_utils.esm.js new file mode 100644 index 000000000000..7a91921039f6 --- /dev/null +++ b/web_hierarchy_list/static/src/hierarchy_list_arch_utils.esm.js @@ -0,0 +1,163 @@ +const isParentFieldOptionsName = "isParentField"; +const isChildrenFieldOptionsName = "isChildrenField"; +const isNameFieldOptionsName = "isNameField"; + +function _handleIsParentFieldOption(archInfo, modelName, fields, column) { + if (archInfo.parentFieldColumn) { + throw new Error( + `The ${isParentFieldOptionsName} field option is already present in the view definition.` + ); + } + if (fields[column.name].type !== "many2one") { + throw new Error( + `Invalid field for ${isParentFieldOptionsName} field option, it should be a Many2One field.` + ); + } else if (fields[column.name].relation !== modelName) { + throw new Error( + `Invalid field for ${isParentFieldOptionsName} field option, the co-model should be same model than the current one (expected: ${modelName}).` + ); + } + if ("drillDownCondition" in column.options) { + archInfo.drillDownCondition = column.options.drillDownCondition; + } + if ("drillDownIcon" in column.options) { + archInfo.drillDownIcon = column.options.drillDownIcon; + } + archInfo.parentFieldColumn = column; +} + +function _handleIsChildrenFieldOption(archInfo, modelName, fields, column) { + if (archInfo.childrenFieldColumn) { + throw new Error( + `The ${isChildrenFieldOptionsName} field option is already present in the view definition.` + ); + } + if (fields[column.name].type !== "one2many") { + throw new Error( + `Invalid field for ${isChildrenFieldOptionsName} field option, it should be a One2Many field.` + ); + } else if (fields[column.name].relation !== modelName) { + throw new Error( + `Invalid field for ${isChildrenFieldOptionsName} field option, the co-model should be same model than the current one (expected: ${modelName}).` + ); + } + archInfo.childrenFieldColumn = column; +} + +function _handleIsNameFieldOption(archInfo, modelName, fields, column) { + if (archInfo.nameFieldColumn) { + throw new Error( + `The ${isNameFieldOptionsName} field option is already present in the view definition.` + ); + } + archInfo.nameFieldColumn = column; +} + +function _handleParentFieldColumnFallback(archInfo, modelName, fields, columnDict) { + const parentIdFieldName = "parent_id"; + if (!archInfo.parentFieldColumn) { + if ( + parentIdFieldName in fields && + fields[parentIdFieldName].type === "many2one" && + fields[parentIdFieldName].relation === modelName + ) { + _handleIsParentFieldOption( + archInfo, + modelName, + fields, + columnDict[parentIdFieldName] + ); + } else { + throw new Error( + `Neither ${parentIdFieldName} field is present in the view fields, nor is ${isParentFieldOptionsName} field option defined on a field.` + ); + } + } +} + +function _handleChildrenFieldColumnFallback(archInfo, modelName, fields, columnDict) { + const childIdsFieldName = "child_ids"; + if (!archInfo.childrenFieldColumn) { + if ( + childIdsFieldName in fields && + fields[childIdsFieldName].type === "one2many" && + fields[childIdsFieldName].relation === modelName + ) { + archInfo.childrenFieldColumn = columnDict[childIdsFieldName]; + } + } +} + +function _handleNameFieldColumnFallback(archInfo, modelName, fields, columnDict) { + const displayNameFieldName = "display_name"; + if (!archInfo.nameFieldColumn) { + if (displayNameFieldName in fields) { + archInfo.nameFieldColumn = columnDict[displayNameFieldName]; + } else { + throw new Error( + `Neither ${displayNameFieldName} field is present in the view fields, nor is ${isNameFieldOptionsName} field option defined on a field.` + ); + } + } +} + +function _handleDrillDownConditionFallback(archInfo) { + if (!archInfo.drillDownCondition && archInfo.childrenFieldColumn) { + archInfo.drillDownCondition = `${archInfo.childrenFieldColumn.name}.length > 0`; + } +} + +function _handleParentFieldColumnVisibility(archInfo) { + if (archInfo.parentFieldColumn) { + // The column tagged as parent field is made invisible, except id explicitly set otherwise. + if ( + !["invisible", "column_invisible"].some( + (value) => + ![null, undefined].includes(archInfo.parentFieldColumn[value]) + ) + ) { + archInfo.parentFieldColumn.column_invisible = "1"; + } + } +} + +function _handleChildrenFieldColumnVisibility(archInfo) { + if (archInfo.childrenFieldColumn) { + // The column tagged as children field is made invisible, except id explicitly set otherwise. + if ( + !["invisible", "column_invisible"].some( + (value) => + ![null, undefined].includes(archInfo.childrenFieldColumn[value]) + ) + ) { + archInfo.childrenFieldColumn.column_invisible = "1"; + } + } +} + +export function treatHierarchyListArch(archInfo, modelName, fields) { + const columnDict = {}; + + for (const column of archInfo.columns) { + columnDict[column.name] = column; + if (column.options) { + if (column.options[isParentFieldOptionsName]) { + _handleIsParentFieldOption(archInfo, modelName, fields, column); + } + if (column.options[isChildrenFieldOptionsName]) { + _handleIsChildrenFieldOption(archInfo, modelName, fields, column); + } + if (column.options[isNameFieldOptionsName]) { + _handleIsNameFieldOption(archInfo, modelName, fields, column); + } + } + } + _handleParentFieldColumnFallback(archInfo, modelName, fields, columnDict); + _handleChildrenFieldColumnFallback(archInfo, modelName, fields, columnDict); + _handleNameFieldColumnFallback(archInfo, modelName, fields, columnDict); + _handleDrillDownConditionFallback(archInfo); + _handleParentFieldColumnVisibility(archInfo); + _handleChildrenFieldColumnVisibility(archInfo); + // Inline Edition is not supported (yet?) + archInfo.activeActions.edit = false; +} diff --git a/web_hierarchy_list/static/src/hierarchy_list_breadcrumb.esm.js b/web_hierarchy_list/static/src/hierarchy_list_breadcrumb.esm.js new file mode 100644 index 000000000000..474558398e46 --- /dev/null +++ b/web_hierarchy_list/static/src/hierarchy_list_breadcrumb.esm.js @@ -0,0 +1,15 @@ +import {Component} from "@odoo/owl"; +import {HierarchyListBreadcrumbItem} from "./hierarchy_list_breadcrumb_item.esm"; + +export class HierarchyListBreadcrumb extends Component { + static components = { + HierarchyListBreadcrumbItem, + }; + static props = { + parentRecords: {type: Array, element: Object}, + getDisplayName: Function, + navigate: Function, + reset: Function, + }; + static template = "web_hierarchy_list.Breadcrumb"; +} diff --git a/web_hierarchy_list/static/src/hierarchy_list_breadcrumb.xml b/web_hierarchy_list/static/src/hierarchy_list_breadcrumb.xml new file mode 100644 index 000000000000..594e1aa47926 --- /dev/null +++ b/web_hierarchy_list/static/src/hierarchy_list_breadcrumb.xml @@ -0,0 +1,29 @@ + + + + +
+ +
+ + + diff --git a/web_hierarchy_list/static/src/hierarchy_list_breadcrumb_item.esm.js b/web_hierarchy_list/static/src/hierarchy_list_breadcrumb_item.esm.js new file mode 100644 index 000000000000..907896899d1f --- /dev/null +++ b/web_hierarchy_list/static/src/hierarchy_list_breadcrumb_item.esm.js @@ -0,0 +1,14 @@ +import {Component} from "@odoo/owl"; + +export class HierarchyListBreadcrumbItem extends Component { + static props = { + record: Object, + getDisplayName: Function, + navigate: Function, + }; + static template = "web_hierarchy_list.BreadcrumbItem"; + + onGlobalClick() { + this.props.navigate(this.props.record); + } +} diff --git a/web_hierarchy_list/static/src/hierarchy_list_breadcrumb_item.xml b/web_hierarchy_list/static/src/hierarchy_list_breadcrumb_item.xml new file mode 100644 index 000000000000..d09568471ed8 --- /dev/null +++ b/web_hierarchy_list/static/src/hierarchy_list_breadcrumb_item.xml @@ -0,0 +1,14 @@ + + + + +
  • + +
    • +     + +     diff --git a/web_hierarchy_list/static/src/hierarchy_list_controller.esm.js b/web_hierarchy_list/static/src/hierarchy_list_controller.esm.js new file mode 100644 index 000000000000..e1b1c3146198 --- /dev/null +++ b/web_hierarchy_list/static/src/hierarchy_list_controller.esm.js @@ -0,0 +1,45 @@ +import {onWillUnmount, useChildSubEnv} from "@odoo/owl"; +import {ListController} from "@web/views/list/list_controller"; + +export class HierarchyListController extends ListController { + static template = "web_hierarchy_list.HierarchyListView"; + + setup() { + super.setup(...arguments); + this.parentRecord = false; + // Initializing breadcrumbState to an empty array is important as the HierarchyListRender + // persists the breadcrumb state in the global state only if the environment variable + // is set. This restriction is put in place in order not to persist the state when + // the HierarchyListRender is mounted on a x2Many Field. + useChildSubEnv({ + breadcrumbState: this.props.globalState?.breadcrumbState || [], + }); + onWillUnmount(this.onWillUnmount); + } + + async onWillUnmount() { + delete this.actionService.currentController.action.context[ + `default_${this.archInfo.parentFieldColumn.name}` + ]; + } + + async onParentRecordUpdate(parentRecord) { + if (parentRecord) { + this.actionService.currentController.action.context[ + `default_${this.archInfo.parentFieldColumn.name}` + ] = parentRecord.resId; + } else { + delete this.actionService.currentController.action.context[ + `default_${this.archInfo.parentFieldColumn.name}` + ]; + } + const hierarchyListParentIdDomain = [ + [this.props.archInfo.parentFieldColumn.name, "=", parentRecord.resId], + ]; + await this.model.load({hierarchyListParentIdDomain}); + } + + async onBreadcrumbReset() { + await this.env.searchModel._notify(); + } +} diff --git a/web_hierarchy_list/static/src/hierarchy_list_controller.xml b/web_hierarchy_list/static/src/hierarchy_list_controller.xml new file mode 100644 index 000000000000..7bc32f444fc0 --- /dev/null +++ b/web_hierarchy_list/static/src/hierarchy_list_controller.xml @@ -0,0 +1,15 @@ + + + + + + onParentRecordUpdate + onBreadcrumbReset + + + + diff --git a/web_hierarchy_list/static/src/hierarchy_list_model.esm.js b/web_hierarchy_list/static/src/hierarchy_list_model.esm.js new file mode 100644 index 000000000000..094b866b8357 --- /dev/null +++ b/web_hierarchy_list/static/src/hierarchy_list_model.esm.js @@ -0,0 +1,18 @@ +import {RelationalModel} from "@web/model/relational_model/relational_model"; + +export class HierarchyListModel extends RelationalModel { + /** + * @param {*} currentConfig + * @param {*} params + * @returns {Config} + */ + _getNextConfig(currentConfig, params) { + const nextConfig = super._getNextConfig(...arguments); + // As we need to display records according to the drill-down, we need a way to pass + // the info to the model, which is performed through the use of the hierarchyListParentIdDomain + if ("hierarchyListParentIdDomain" in params) { + nextConfig.domain = params.hierarchyListParentIdDomain; + } + return nextConfig; + } +} diff --git a/web_hierarchy_list/static/src/hierarchy_list_renderer.esm.js b/web_hierarchy_list/static/src/hierarchy_list_renderer.esm.js new file mode 100644 index 000000000000..c79d924db5e1 --- /dev/null +++ b/web_hierarchy_list/static/src/hierarchy_list_renderer.esm.js @@ -0,0 +1,104 @@ +import {onWillStart, useState} from "@odoo/owl"; +import {HierarchyListBreadcrumb} from "./hierarchy_list_breadcrumb.esm"; +import {ListRenderer} from "@web/views/list/list_renderer"; +import {evaluateBooleanExpr} from "@web/core/py_js/py"; +import {useSetupAction} from "@web/search/action_hook"; + +export class HierarchyListRenderer extends ListRenderer { + static components = { + ...ListRenderer.components, + HierarchyListBreadcrumb, + }; + static props = [...ListRenderer.props, "onParentRecordUpdate", "onBreadcrumbReset"]; + static template = "web_hierarchy_list.HierarchyListRenderer"; + static rowsTemplate = "web_hierarchy_list.HierarchyListRenderer.Rows"; + static recordRowTemplate = "web_hierarchy_list.HierarchyListRenderer.RecordRow"; + setup() { + super.setup(); + useSetupAction({ + getGlobalState: () => { + // We only persist the breadcrumb state in the global state if it was provided + // by the environment. Indeed, the environment variable is created by the + // HierarchyListController, which ensures that the state is only persisted there + // and not when the renderer is used in a x2Many field. + if ( + !this.env.breadcrumbState || + this.state.breadcrumbState.length === 0 + ) { + return {}; + } + return { + breadcrumbState: this._getBreadcrumbState(), + }; + }, + }); + // As the breadcrumb state is not provided when the renderer is mounted into a x2Many + // field, we need to have a fallback value. + this.state = useState({ + breadcrumbState: this.env.breadcrumbState || [], + }); + onWillStart(this.willStart); + } + + async willStart() { + if (this.state.breadcrumbState.length > 0) { + this.navigate( + this.state.breadcrumbState[this.state.breadcrumbState.length - 1] + ); + } + } + + _getBreadcrumbState() { + return this.state.breadcrumbState.map((parentRecord) => + this._getParentRecord(parentRecord) + ); + } + + getDisplayName(record) { + if (this.props.archInfo.nameFieldColumn.fieldType === "many2one") { + return record.data[this.props.archInfo.nameFieldColumn.name][1]; + } + return record.data[this.props.archInfo.nameFieldColumn.name]; + } + + _getParentRecord(record) { + const data = {}; + data[this.props.archInfo.nameFieldColumn.name] = + record.data[this.props.archInfo.nameFieldColumn.name]; + return {resId: record.resId, data}; + } + + _updateBreadcrumbState(record) { + const existingRecordIndex = this.state.breadcrumbState + .map((r) => r.resId) + .indexOf(record.resId); + if (existingRecordIndex >= 0) + this.state.breadcrumbState = this.state.breadcrumbState.slice( + 0, + existingRecordIndex + 1 + ); + else { + this.state.breadcrumbState.push(this._getParentRecord(record)); + } + } + + canDrillDown(record) { + if (!this.props.archInfo.drillDownCondition) { + return true; + } + return evaluateBooleanExpr( + this.props.archInfo.drillDownCondition, + record.evalContextWithVirtualIds + ); + } + + async navigate(parent) { + this._updateBreadcrumbState(parent); + await this.props.onParentRecordUpdate(parent); + } + + async reset() { + this.state.breadcrumbState.length = 0; + await this.props.onBreadcrumbReset(); + } +} diff --git a/web_hierarchy_list/static/src/hierarchy_list_renderer.scss b/web_hierarchy_list/static/src/hierarchy_list_renderer.scss new file mode 100644 index 000000000000..92aa1974088f --- /dev/null +++ b/web_hierarchy_list/static/src/hierarchy_list_renderer.scss @@ -0,0 +1,12 @@ +$hierarchy_list_drill_down_width: 24px; + +.o_hierarchy_list_drill_down_column_header { + min-width: $hierarchy_list_drill_down_width; + max-width: $hierarchy_list_drill_down_width; +} + +.o_hierarchy_list_drill_down_column { + // We do not want the left padding rule of bootstrap for the first col to be applied. + // Indeed as the column width is forced, this would result in having the icon overflowing. + padding: 0.5rem 0.3rem !important; +} diff --git a/web_hierarchy_list/static/src/hierarchy_list_renderer.xml b/web_hierarchy_list/static/src/hierarchy_list_renderer.xml new file mode 100644 index 000000000000..700eda9ce2f0 --- /dev/null +++ b/web_hierarchy_list/static/src/hierarchy_list_renderer.xml @@ -0,0 +1,64 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/web_hierarchy_list/static/src/hierarchy_list_view.esm.js b/web_hierarchy_list/static/src/hierarchy_list_view.esm.js new file mode 100644 index 000000000000..a9c0102c67cc --- /dev/null +++ b/web_hierarchy_list/static/src/hierarchy_list_view.esm.js @@ -0,0 +1,16 @@ +import {HierarchyListArchParser} from "./hierarchy_list_arch_parser.esm"; +import {HierarchyListController} from "./hierarchy_list_controller.esm"; +import {HierarchyListModel} from "./hierarchy_list_model.esm"; +import {HierarchyListRenderer} from "./hierarchy_list_renderer.esm"; +import {listView} from "@web/views/list/list_view"; +import {registry} from "@web/core/registry"; + +export const hierarchyListView = { + ...listView, + ArchParser: HierarchyListArchParser, + Controller: HierarchyListController, + Model: HierarchyListModel, + Renderer: HierarchyListRenderer, +}; + +registry.category("views").add("hierarchy_list", hierarchyListView); diff --git a/web_hierarchy_list/static/src/hierarchy_list_x2many_field.esm.js b/web_hierarchy_list/static/src/hierarchy_list_x2many_field.esm.js new file mode 100644 index 000000000000..c7587358f4e7 --- /dev/null +++ b/web_hierarchy_list/static/src/hierarchy_list_x2many_field.esm.js @@ -0,0 +1,151 @@ +import {X2ManyField, x2ManyField} from "@web/views/fields/x2many/x2many_field"; +import {HierarchyListRenderer} from "./hierarchy_list_renderer.esm"; +import {RelationalModel} from "@web/model/relational_model/relational_model"; +import {evaluateExpr} from "@web/core/py_js/py"; +import {extractFieldsFromArchInfo} from "@web/model/relational_model/utils"; +import {registry} from "@web/core/registry"; +import {treatHierarchyListArch} from "./hierarchy_list_arch_utils.esm"; +import {useService} from "@web/core/utils/hooks"; +import {useState} from "@odoo/owl"; + +export class HierarchyListX2manyField extends X2ManyField { + static components = { + ...X2ManyField.components, + HierarchyListRenderer, + }; + static template = "web_hierarchy_list.X2ManyField"; + + setup() { + super.setup(); + treatHierarchyListArch( + this.archInfo, + this.field.relation, + this.archInfo.fields + ); + + // Creation and deletion of records is not supported (yet?) + this.archInfo.activeActions.create = false; + this.archInfo.activeActions.link = false; + this.archInfo.activeActions.delete = false; + + this.parentRecord = false; + + const services = {}; + for (const key of RelationalModel.services) { + services[key] = useService(key); + } + services.orm = services.orm || useService("orm"); + this.childrenModel = useState( + new RelationalModel(this.env, this.modelParams, services) + ); + } + + get modelParams() { + const {rawExpand} = this.archInfo; + const {activeFields, fields} = extractFieldsFromArchInfo( + this.archInfo, + this.archInfo.fields + ); + + const modelConfig = { + resModel: this.field.relation, + orderBy: this.archInfo.defaultOrderBy || [], + groupBy: false, + fields, + activeFields, + openGroupsByDefault: rawExpand + ? evaluateExpr(rawExpand, this.props.record.model.context) + : false, + }; + + return { + config: modelConfig, + state: this.props.state?.modelState, + groupByInfo: {}, + defaultGroupBy: false, + defaultOrderBy: this.archInfo.defaultOrder, + limit: this.archInfo.limit || this.props.limit, + countLimit: this.archInfo.countLimit, + hooks: {}, + }; + } + + get rendererProps() { + let props = {}; + if (this.parentRecord) { + props = { + archInfo: this.archInfo, + list: this.childrenModel.root, + openRecord: this.openRecord.bind(this), + activeActions: this.archInfo.activeActions, + onOpenFormView: this.switchToForm.bind(this), + }; + } else { + props = super.rendererProps; + } + props.activeActions = this.archInfo.activeActions; + return props; + } + + get pagerProps() { + if (!this.parentRecord) { + return super.pagerProps; + } + + const list = this.childrenModel.root; + return { + offset: list.offset, + limit: list.limit, + total: list.count, + onUpdate: async ({offset, limit}) => { + const initialLimit = this.list.limit; + const leaved = await list.leaveEditMode(); + if (leaved) { + let adjustment_due_to_limit = 0; + if ( + initialLimit === limit && + initialLimit === this.list.limit + 1 + ) { + // Unselecting the edited record might have abandonned it. If the page + // size was reached before that record was created, the limit was temporarily + // increased to keep that new record in the current page, and abandonning it + // decreased this limit back to it's initial value, so we keep this into + // account in the offset/limit update we're about to do. + adjustment_due_to_limit -= 1; + } + await list.load({ + limit: limit + adjustment_due_to_limit, + offset: offset + adjustment_due_to_limit, + }); + } + }, + withAccessKey: false, + }; + } + + async onParentRecordUpdate(parentRecord) { + this.parentRecord = parentRecord; + const context = {...this.archInfo.context}; + context[`default_${this.archInfo.parentFieldColumn.name}`] = + this.parentRecord.resId; + const params = { + context, + domain: [ + [this.archInfo.parentFieldColumn.name, "=", this.parentRecord.resId], + ], + }; + await this.childrenModel.load(params); + } + + async onBreadcrumbReset() { + this.parentRecord = false; + this.render(); + } +} + +export const hierarchyListX2manyField = { + ...x2ManyField, + component: HierarchyListX2manyField, +}; + +registry.category("fields").add("one2many_hierarchy_list", hierarchyListX2manyField); diff --git a/web_hierarchy_list/static/src/hierarchy_list_x2many_field.xml b/web_hierarchy_list/static/src/hierarchy_list_x2many_field.xml new file mode 100644 index 000000000000..d6cd7130a99b --- /dev/null +++ b/web_hierarchy_list/static/src/hierarchy_list_x2many_field.xml @@ -0,0 +1,19 @@ + + + + + + + + + +