From cbf9a74663cde6776cc25db930bb69dc1bbb2ded Mon Sep 17 00:00:00 2001 From: Eugen Neuber <eugen.neuber@tugraz.at> Date: Fri, 25 Sep 2020 15:17:28 +0200 Subject: [PATCH] Add a provider web component plus demo See issue #31 --- packages/provider/LICENSE | 502 ++++++++++++++++++ packages/provider/README.md | 35 ++ packages/provider/assets/favicon.ico | Bin 0 -> 2550 bytes packages/provider/assets/index.html.ejs | 24 + packages/provider/i18next-scanner.config.js | 15 + packages/provider/karma.conf.js | 23 + packages/provider/package.json | 46 ++ packages/provider/rollup.config.js | 104 ++++ packages/provider/src/dbp-provider-demo.js | 338 ++++++++++++ packages/provider/src/dbp-provider.js | 4 + packages/provider/src/demo.js | 1 + packages/provider/src/i18n.js | 6 + .../provider/src/i18n/de/translation.json | 5 + .../provider/src/i18n/en/translation.json | 5 + packages/provider/src/index.js | 3 + packages/provider/src/provider.js | 87 +++ 16 files changed, 1198 insertions(+) create mode 100644 packages/provider/LICENSE create mode 100644 packages/provider/README.md create mode 100644 packages/provider/assets/favicon.ico create mode 100644 packages/provider/assets/index.html.ejs create mode 100644 packages/provider/i18next-scanner.config.js create mode 100644 packages/provider/karma.conf.js create mode 100644 packages/provider/package.json create mode 100644 packages/provider/rollup.config.js create mode 100644 packages/provider/src/dbp-provider-demo.js create mode 100644 packages/provider/src/dbp-provider.js create mode 100644 packages/provider/src/demo.js create mode 100644 packages/provider/src/i18n.js create mode 100644 packages/provider/src/i18n/de/translation.json create mode 100644 packages/provider/src/i18n/en/translation.json create mode 100644 packages/provider/src/index.js create mode 100644 packages/provider/src/provider.js diff --git a/packages/provider/LICENSE b/packages/provider/LICENSE new file mode 100644 index 00000000..4362b491 --- /dev/null +++ b/packages/provider/LICENSE @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + <one line to give the library's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + <signature of Ty Coon>, 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/packages/provider/README.md b/packages/provider/README.md new file mode 100644 index 00000000..6ad4dd38 --- /dev/null +++ b/packages/provider/README.md @@ -0,0 +1,35 @@ +# Provider Web Component + +[GitLab Repository](git@gitlab.tugraz.at:dbp/web-components/toolkit.git) + +## Usage + +```html +<provider></provider> +``` + +## Attributes + +- `init` (optional): set your vars to values + - example `<provider init="foo=bar"></provider>` +- `id` (optional): set an id, useful for debugging + - example `<provider id="p-1"></provider>` + +## Local development + +```bash +# get the source +git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git +cd toolkit/packages/provider + +# install dependencies (make sure you have npm version 4+ installed, so symlinks to the git submodules are created automatically) +yarn install + +# constantly build dist/bundle.js and run a local web-server on port 8002 +yarn run watch + +# run tests +yarn test +``` + +Jump to <http://localhost:8002> and you should get a demo page. diff --git a/packages/provider/assets/favicon.ico b/packages/provider/assets/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..f6cf22d1afc22f071d2b64c7779bc5214c3adae5 GIT binary patch literal 2550 zcmeH{J!@1^5Qg9Qfi}@C1S=tFL@SHw1R=k|!X_wkl3I{dku4;hA_M{lL{exWVu~Os z1S^fr9!$4EB!X-a459`s0v5+-W+QHv-9Sty-ek_b^WOP*?wq?<8qpCo8sdCX)5oRr z(yl+I>0{D;v<t3bW0=SJF)<RS?$UEzYelP?S6lT<(cAVnwKq5Q;OTQ@<6gotRwQ?g z#n24RTqEB@5_;kyp(pf&?r9l4qi39qp3ym}pcnLlUJwd;#jp6aMA=G1qqtGXNHRDb z$zU)T3<iV2U<f1_3<iV2U@#a069$99U@#aAhCqkGU@#aA27|$9U~m{5796$vctMi5 z&RD_F{gGiwG*2{26iu+i7`U0ZNU$VWVk~eZI1(HQjs!=H3XTLrf+4}+qf2lk7!nM{ zpPMyCNT2Q>evH?r0~Nh9Q88+IXP7cgGYv9KnckV3nIf6qnclG-(Houqnf{snzD1e- znb~9*G7Opb#J7#9#M7g2X7z1k28DhFwgN|?Uu>;&FoOa|aSk3Vwwt5^OM#^TQD_*i z04#;XLQp{{u<(yjhdn8<6rV@1_}k#SfCfW_p~6sMs4!F*;&p<dz))eRFccUlgAory zg`vVwVW2dI4nu{Z!cYOI^e+^vBvyhFH4=V;qeg9yNgCG^O-@c~W@binb8}i)SWv6g z((>}M*4Njyv9X~}r=zW{Ep2aaYiDOi-+xv;UR+eO*<`x@8}JkL!t=WBRy}G@sd4mn z*v(Pt!_taYX0PkU*(t3qz1IAzdA*#yrz<B$_5Rc|T|0M2FK(UD)yp6C?%`L>uKv*H zOH*2FtjRhnYF&IoheIDnIC_ih_1%j@zADy!zenswML;)xxAGnbt>5njILLK(wlVIQ z^CxEQ)*SEJUA~iU_4KaAUi^vQ`<)$&))Rb#{~!BJpnvN7#SXgnxB2~fgM9DTum5J~ r*9Z9r$sZIutmdHDLE3)#9zX2p&l?suOh0V?u)6<--anm#erJ9GA@oeM literal 0 HcmV?d00001 diff --git a/packages/provider/assets/index.html.ejs b/packages/provider/assets/index.html.ejs new file mode 100644 index 00000000..0ce3cd32 --- /dev/null +++ b/packages/provider/assets/index.html.ejs @@ -0,0 +1,24 @@ +<!doctype html> +<html> +<head> + <meta charset="UTF-8"> + <script type="module" src="dbp-provider-demo.js"></script> + <!-- + This is for debugging only: + - requests no provider can answer bubble up to the top + - unhandled requests are logged in the console + --> + <script> + window.addEventListener('inherit', e => console.log('window eventListener("inherit",..) name "' + e.detail.name + '" not found.')); + window.addEventListener('subscribe', e => console.log('window eventListener("subscribe",..) name "' + e.detail.name + '" not found.')); + window.addEventListener('unsubscribe', e => console.log('window eventListener("unsubscribe",..) name "' + e.detail.name + '" not found.')); + </script> +</head> + +<body> + +<dbp-provider-demo lang="de"></dbp-provider-demo> + +<p>version: <span style="color: white; background-color: black;"><%= buildInfo.info %></span></p> +</body> +</html> diff --git a/packages/provider/i18next-scanner.config.js b/packages/provider/i18next-scanner.config.js new file mode 100644 index 00000000..8c277798 --- /dev/null +++ b/packages/provider/i18next-scanner.config.js @@ -0,0 +1,15 @@ +module.exports = { + input: [ + 'src/*.js', + ], + output: './', + options: { + debug: false, + removeUnusedKeys: true, + lngs: ['en','de'], + resource: { + loadPath: 'src/i18n/{{lng}}/{{ns}}.json', + savePath: 'src/i18n/{{lng}}/{{ns}}.json' + }, + }, +} diff --git a/packages/provider/karma.conf.js b/packages/provider/karma.conf.js new file mode 100644 index 00000000..6a646f5e --- /dev/null +++ b/packages/provider/karma.conf.js @@ -0,0 +1,23 @@ +// Trick to use the auto-downloaded puppeteer chrome binary +process.env.CHROME_BIN = require('puppeteer').executablePath(); + +module.exports = function(config) { + config.set({ + basePath: 'dist', + frameworks: ['mocha', 'chai'], + files: [ + {pattern: './*.js', included: true, watched: true, served: true, type: 'module'}, + {pattern: './**/*', included: false, watched: true, served: true}, + ], + autoWatch: true, + browsers: ['ChromeHeadlessNoSandbox'], + customLaunchers: { + ChromeHeadlessNoSandbox: { + base: 'ChromeHeadless', + flags: ['--no-sandbox'] + } + }, + singleRun: false, + logLevel: config.LOG_ERROR + }); +} diff --git a/packages/provider/package.json b/packages/provider/package.json new file mode 100644 index 00000000..12108dc2 --- /dev/null +++ b/packages/provider/package.json @@ -0,0 +1,46 @@ +{ + "name": "dbp-provider", + "version": "1.0.0", + "main": "src/index.js", + "license": "LGPL-2.1-or-later", + "private": true, + "devDependencies": { + "@rollup/plugin-commonjs": "^14.0.0", + "@rollup/plugin-json": "^4.1.0", + "@rollup/plugin-node-resolve": "^8.1.0", + "@rollup/plugin-url": "^5.0.1", + "chai": "^4.2.0", + "i18next-scanner": "^2.10.2", + "karma": "^5.1.0", + "karma-chai": "^0.1.0", + "karma-chrome-launcher": "^3.0.0", + "karma-mocha": "^2.0.1", + "mocha": "^8.0.1", + "puppeteer": "^2.1.1", + "rollup": "^2.19.0", + "rollup-plugin-consts": "^1.0.1", + "rollup-plugin-copy": "^3.1.0", + "rollup-plugin-delete": "^2.0.0", + "rollup-plugin-serve": "^1.0.1", + "rollup-plugin-terser": "^6.1.0" + }, + "dependencies": { + "@open-wc/scoped-elements": "^1.1.1", + "lit-element": "^2.3.1", + "dbp-auth": "^1.0.0", + "dbp-common": "^1.0.0" + }, + "scripts": { + "clean": "rm dist/*", + "build-local": "rollup -c", + "build-dev": "rollup -c --environment BUILD:development", + "build-prod": "rollup -c --environment BUILD:production", + "build-demo": "rollup -c --environment BUILD:demo", + "build-test": "rollup -c --environment BUILD:test", + "i18next": "i18next-scanner", + "watch": "rollup -c --watch", + "watch-local": "yarn run watch", + "watch-dev": "rollup -c --watch --environment BUILD:development", + "test": "rollup -c --environment BUILD:test && karma start --singleRun" + } +} diff --git a/packages/provider/rollup.config.js b/packages/provider/rollup.config.js new file mode 100644 index 00000000..469b12bc --- /dev/null +++ b/packages/provider/rollup.config.js @@ -0,0 +1,104 @@ +import glob from 'glob'; +import resolve from '@rollup/plugin-node-resolve'; +import commonjs from '@rollup/plugin-commonjs'; +import copy from 'rollup-plugin-copy'; +import {terser} from "rollup-plugin-terser"; +import json from '@rollup/plugin-json'; +import serve from 'rollup-plugin-serve'; +import url from "@rollup/plugin-url"; +import consts from 'rollup-plugin-consts'; +import del from 'rollup-plugin-delete'; +import emitEJS from 'rollup-plugin-emit-ejs' +import {getPackagePath} from '../../rollup.utils.js'; + +const pkg = require('./package.json'); +const build = (typeof process.env.BUILD !== 'undefined') ? process.env.BUILD : 'local'; +console.log("build: " + build); + +function getBuildInfo() { + const child_process = require('child_process'); + const url = require('url'); + + let remote = child_process.execSync('git config --get remote.origin.url').toString().trim(); + let commit = child_process.execSync('git rev-parse --short HEAD').toString().trim(); + + let parsed = url.parse(remote); + // convert git urls + if (parsed.protocol === null) { + parsed = url.parse('git://' + remote.replace(":", "/")); + parsed.protocol = 'https:'; + } + let newPath = parsed.path.slice(0, parsed.path.lastIndexOf('.')); + let newUrl = parsed.protocol + '//' + parsed.host + newPath + '/commit/' + commit; + + return { + info: commit, + url: newUrl, + time: new Date().toISOString(), + env: build + } +} + +export default (async () => { + return { + input: (build != 'test') ? ['src/dbp-provider.js', 'src/dbp-provider-demo.js'] : glob.sync('test/**/*.js'), + output: { + dir: 'dist', + entryFileNames: '[name].js', + chunkFileNames: 'shared/[name].[hash].[format].js', + format: 'esm', + sourcemap: true + }, + onwarn: function (warning, warn) { + // keycloak bundled code uses eval + if (warning.code === 'EVAL') { + return; + } + warn(warning); + }, + plugins: [ + del({ + targets: 'dist/*' + }), + consts({ + environment: build, + buildInfo: getBuildInfo(), + }), + emitEJS({ + src: 'assets', + include: ['**/*.ejs', '**/.*.ejs'], + data: { + getUrl: (p) => { + return url.resolve(basePath, p); + }, + getPrivateUrl: (p) => { + return url.resolve(`${basePath}local/${pkg.name}/`, p); + }, + name: pkg.name, + environment: build, + buildInfo: getBuildInfo() + } + }), + resolve(), + commonjs(), + url({ + limit: 0, + include: [ + await getPackagePath('select2', '**/*.css'), + ], + emitFiles: true, + fileName: 'shared/[name].[hash][extname]' + }), + json(), + (build !== 'local' && build !== 'test') ? terser() : false, + copy({ + targets: [ + {src: 'assets/index.html', dest: 'dist'}, + {src: await getPackagePath('dbp-common', 'assets/icons/*.svg'), dest: 'dist/local/dbp-common/icons'}, + {src: 'assets/favicon.ico', dest:'dist'}, + ], + }), + (process.env.ROLLUP_WATCH === 'true') ? serve({contentBase: 'dist', host: '127.0.0.1', port: 8002}) : false + ] + }; +})(); \ No newline at end of file diff --git a/packages/provider/src/dbp-provider-demo.js b/packages/provider/src/dbp-provider-demo.js new file mode 100644 index 00000000..b11ddd90 --- /dev/null +++ b/packages/provider/src/dbp-provider-demo.js @@ -0,0 +1,338 @@ +import {i18n} from './i18n.js'; +import {css, html, LitElement} from 'lit-element'; +import {ScopedElementsMixin} from '@open-wc/scoped-elements'; +import {AuthKeycloak, LoginButton} from 'dbp-auth'; +import * as commonUtils from 'dbp-common/utils'; +import * as commonStyles from 'dbp-common/styles'; +import {Provider} from 'dbp-provider'; + + +class ProviderDemo extends ScopedElementsMixin(LitElement) { + + constructor() { + super(); + this.lang = 'de'; + } + + static get scopedElements() { + return { + 'dbp-auth-keycloak': AuthKeycloak, + 'dbp-login-button': LoginButton, + 'dbp-provider': Provider, + 'dbp-consumer': DemoConsumer, + }; + } + + static get properties() { + return { + lang: { type: String }, + }; + } + + connectedCallback() { + super.connectedCallback(); + i18n.changeLanguage(this.lang); + } + + static get styles() { + // language=css + return [ + commonStyles.getThemeCSS(), + commonStyles.getGeneralCSS(), + css` + h1.title {margin-bottom: 1em;} + div.container {margin-bottom: 1.5em; padding-left:20px;} + ` + ]; + } + + render() { + return html` + <section class="section"> + <p>Provider <em>"root"</em> is the top most in hirachy:</p> + <dbp-provider id="root" + init="availability=global" + ></dbp-provider> +<pre> +<dbp-provider id="root" init="availability=global" ></dbp-provider> +</pre> + <div class="container"> + <h1 class="title">Provider-Demo</h1> + </div> + <div class="container"> + <dbp-auth-keycloak lang="${this.lang}" url="https://auth-dev.tugraz.at/auth" realm="tugraz" client-id="auth-dev-mw-frontend-local" load-person try-login></dbp-auth-keycloak> + <dbp-login-button lang="${this.lang}" show-image></dbp-login-button> + </div> + <div class="container"> + <h2>Provider</h2> + <p>Provider <em>"demo"</em> has only <em>border-color</em> to offer:</p> + <dbp-provider id="demo" + init="bc=blue" + ></dbp-provider> +<pre> +<dbp-provider id="demo" init="bc=blue" ></dbp-provider> +</pre> + <p>Provider <em>"foo-bar"</em> has some values in its store:</p> + <dbp-provider id="foo-bar" + init="foo=9,bar=20" + ></dbp-provider> +<pre> +<dbp-provider id="foo-bar" init="foo=9,bar=20" ></dbp-provider> +</pre> + <h2>Consumer</h2> + <p>Consumer <em>"c1"</em> will only subscribe to <em>border-color</em></p> +<pre> +<dbp-consumer id="c1" subscribe="bc:border-color" ></dbp-consumer> +</pre> + <dbp-consumer id="c1" + subscribe="bc:border-color" + ></dbp-consumer> + <p>Consumer <em>"c2"</em> subscribes to <em>foo</em></p> +<pre> +<dbp-consumer id="c2" subscribe="foo:foo" ></dbp-consumer> +</pre> + <dbp-consumer id="c2" + subscribe="foo:foo" + ></dbp-consumer> + <p>Consumer <em>"c3"</em> subscribes for <em>status</em> wich is provided as <em>availability</em></p> +<pre> +<dbp-consumer id="c3" subscribe="availability:status" border-color="orange" ></dbp-consumer> +</pre> + <dbp-consumer id="c3" + subscribe="availability:status" + border-color="orange" + ></dbp-consumer> + <p>Consumer <em>"c4"</em> subscribes for <em>status</em> wich is provided as <em>unknown-name</em> which does not exist...</p> +<pre> +<dbp-consumer id="c4" subscribe="unknown-name:status" border-color="darkgray" ></dbp-consumer> +</pre> + <dbp-consumer id="c4" + subscribe="unknown-name:status" + border-color="darkgray" + ></dbp-consumer> + </div> + </section> + `; + } +} + +commonUtils.defineCustomElement('dbp-provider-demo', ProviderDemo); + +// ======================================================= + +class Consumer extends HTMLElement { + constructor() { + super(); + this.connected = false; + this.deferInherited = false; + this.deferSubscribe = false; + this.deferUnSubscribe = false; + + // default values + this.inherit = ''; + this.subscribe = ''; + this.unsubscribe = ''; + + this.attachShadow({mode: 'open'}); + console.log('Consumer constructor()'); + } + + connectedCallback() { + console.log('Consumer(' + this.id() + ') connectedCallback()'); + + if (this.deferInherited) { + const attrs = this.inherit.split(','); + attrs.forEach(element => this.askProviderFor(element)); + this.deferInherited = false; + } + if (this.deferUnSubscribe) { + const attrs = this.unsubscribe.split(','); + attrs.forEach(element => this.subscribeProviderFor(element)); + this.deferSubscribe = false; + this.unsubscribe = ''; + } + if (this.deferSubscribe) { + const attrs = this.subscribe.split(','); + attrs.forEach(element => this.subscribeProviderFor(element)); + this.deferSubscribe = false; + } + this.connected = true; + } + + static get observedAttributes() { + return ['inherit', 'subscribe']; + } + + attributeChangedCallback(name, oldValue, newValue) { + console.log('Consumer(' + this.id() + ') attributeChangesCallback( ' + name + ', ' + oldValue + ', ' + newValue + ')'); + switch(name) { + case 'inherit': + this.inherit = newValue; + if (this.connected && typeof newValue === 'string') { + const attrs = newValue.split(','); + attrs.forEach(element => this.askProviderFor(element)); + } else { + this.deferInherited = newValue.length > 0; + } + break; + case 'subscribe': + if (this.subscribe && this.subscribe.length > 0) { + if (this.connected) { + const attrs = this.subscribe.split(','); + attrs.forEach(element => this.unSubscribeProviderFor(element)); + } else { + this.deferUnSubscribe = this.subscribe.length > 0; + this.unsubscribe = this.subscribe; + } + } + if (newValue !== null) { + this.subscribe = newValue; + if (this.connected) { + const attrs = newValue.split(','); + attrs.forEach(element => this.subscribeProviderFor(element)); + } else { + this.deferSubscribe = newValue && newValue.length > 0; + } + } + break; + default: + console.log('unknown attribute "' + name + '".'); + } + } + + id() { + return this.getAttribute('id'); + } + + render() {} + + askProviderFor(element) { + console.log('Consumer(' + this.id() + ') askProviderFor( ' + element + ' )'); + const pair = element.trim().split(':'); + const global = pair[0]; + const local = pair[1]; + const that = this; + const event = new CustomEvent('inherit', + { + bubbles: true, + detail: { + name: global, + callback: (value) => { + console.log('Consumer(' + that.id() + ') ask/Callback ' + global + ' -> ' + local + ' = ' + value); + this.attributeChangedCallback(local, that[local], value); + } + } + }); + this.parentElement.dispatchEvent(event); + //console.dir(event); + } + + subscribeProviderFor(element) { + console.log('Consumer(' + this.id() + ') subscribeProviderFor( ' + element + ' )'); + const pair = element.trim().split(':'); + const global = pair[0]; + const local = pair[1]; + const that = this; + const event = new CustomEvent('subscribe', + { + bubbles: true, + detail: { + name: global, + callback: (value) => { + console.log('Consumer(' + that.id() + ') sub/Callback ' + global + ' -> ' + local + ' = ' + value); + this.attributeChangedCallback(local, that[local], value); + }, + sender: this, + } + }); + this.parentElement.dispatchEvent(event); + } + + unSubscribeProviderFor(element) { + console.log('Consumer(' + this.id() + ') unSubscribeProviderFor( ' + element + ' )'); + const pair = element.trim().split(':'); + const global = pair[0]; + const event = new CustomEvent('unsubscribe', + { + bubbles: true, + detail: { + name: global, + sender: this, + } + }); + this.parentElement.dispatchEvent(event); + } +} + +class DemoConsumer extends Consumer +{ + constructor() { + super(); + + // default values + this.foo = 100; + this.bar = 900; + this.ping = 0; + this['border-color'] = 'green'; + + this.status = 'local'; + + console.log('DemoConsumer constructor()'); + } + + connectedCallback() { + super.connectedCallback(); + console.log('DemoConsumer(' + this.id() + ') connectedCallback()'); + this.render(); + } + + static get observedAttributes() { + return [ ...Consumer.observedAttributes, 'foo', 'bar', 'gong', 'border-color', 'ping']; + } + + attributeChangedCallback(name, oldValue, newValue) { + console.log('DemoConsumer(' + this.id() + ') attributeChangesCallback( ' + name + ', ' + oldValue + ', ' + newValue + ')'); + switch(name) { + case 'foo': + this.foo = parseInt(newValue); + break; + case 'bar': + this.bar = parseInt(newValue); + break; + case 'status': + this.status = newValue; + break; + case 'border-color': + this['border-color'] = newValue; + break; + default: + super.attributeChangedCallback(name, oldValue, newValue); + } + this.render(); + } + + render() { + if (! this.connected) { + return; + } + console.log('DemoConsumer(' + this.id() + ') render()'); + + const sum = this.foo + this.bar; + this.shadowRoot.innerHTML = ` + <div style="border: ${this['border-color']} dotted; padding: 10px;"> + <table style="width:200px;"> + <tr style="background-color: #aaa;"> + <th style="text-align: left;">Item</th> + <th style="text-align: right;">Price</th> + </tr> + <tr><td>foo</td><td style="text-align: right;">${this.foo}</td></tr> + <tr><td>bar</td><td style="text-align: right;">${this.bar}</td></tr> + <tr><td>sum</td><td style="text-align: right;">${sum}</td></tr> + </table> + <p>Status: <b>${this.status}</b></p> + </div> + `; + } +} + +customElements.define('dbp-consumer', DemoConsumer); diff --git a/packages/provider/src/dbp-provider.js b/packages/provider/src/dbp-provider.js new file mode 100644 index 00000000..ea220fe5 --- /dev/null +++ b/packages/provider/src/dbp-provider.js @@ -0,0 +1,4 @@ +import * as commonUtils from 'dbp-common/utils'; +import {Provider} from './provider.js'; + +commonUtils.defineCustomElement('dbp-provider', Provider); diff --git a/packages/provider/src/demo.js b/packages/provider/src/demo.js new file mode 100644 index 00000000..8425d88d --- /dev/null +++ b/packages/provider/src/demo.js @@ -0,0 +1 @@ +import './dbp-provider-demo.js'; \ No newline at end of file diff --git a/packages/provider/src/i18n.js b/packages/provider/src/i18n.js new file mode 100644 index 00000000..3fb3a1af --- /dev/null +++ b/packages/provider/src/i18n.js @@ -0,0 +1,6 @@ +import {createInstance} from 'dbp-common/i18next.js'; + +import de from './i18n/de/translation.json'; +import en from './i18n/en/translation.json'; + +export const i18n = createInstance({en: en, de: de}, 'de', 'en'); \ No newline at end of file diff --git a/packages/provider/src/i18n/de/translation.json b/packages/provider/src/i18n/de/translation.json new file mode 100644 index 00000000..e41d874c --- /dev/null +++ b/packages/provider/src/i18n/de/translation.json @@ -0,0 +1,5 @@ +{ + "provider": { + + } +} \ No newline at end of file diff --git a/packages/provider/src/i18n/en/translation.json b/packages/provider/src/i18n/en/translation.json new file mode 100644 index 00000000..e41d874c --- /dev/null +++ b/packages/provider/src/i18n/en/translation.json @@ -0,0 +1,5 @@ +{ + "provider": { + + } +} \ No newline at end of file diff --git a/packages/provider/src/index.js b/packages/provider/src/index.js new file mode 100644 index 00000000..34bdc9a6 --- /dev/null +++ b/packages/provider/src/index.js @@ -0,0 +1,3 @@ +import {Provider} from './provider.js'; + +export {Provider}; \ No newline at end of file diff --git a/packages/provider/src/provider.js b/packages/provider/src/provider.js new file mode 100644 index 00000000..99066cf2 --- /dev/null +++ b/packages/provider/src/provider.js @@ -0,0 +1,87 @@ +export class Provider extends HTMLElement { + constructor() { + super(); + this.callbackStore = []; + + console.log('Provider constructor()'); + } + + static get observedAttributes() { + return ['init']; + } + + attributeChangedCallback(name, oldValue, newValue) { + console.log('Provider(' + this.id() + ') attribute "' + name + '" changed from "' + oldValue + '" to "' + newValue + '".'); + switch(name) { + case 'init': + this.init = newValue; + if (newValue) { + const attrs = newValue.split(','); + attrs.forEach(element => { + const pair = element.trim().split('='); + const name = pair[0].trim(); + const value = pair[1].trim().replace('"', '').replace("'", ''); + if (name.length > 0) { + this[name] = value; + this.callbackStore.forEach(item => { + if (item.name === name) { + item.callback(value); + } + }); + } + }); + } + break; + default: + console.log('unknown attribute "' + name + '".'); + } + } + + + connectedCallback() { + console.log('Provider(' + this.id() + ') connectedCallback()'); + + const that = this; + const parent = this.parentElement; + parent.addEventListener('inherit', function (e) { + if (that[e.detail.name]) { + console.log('Provider(' + that.id() + ') eventListener("inherit",..) name "' + e.detail.name + '" found.'); + //console.dir(e.detail); + e.detail.callback(that[e.detail.name]); + e.stopPropagation(); + } + }, false); + + parent.addEventListener('subscribe', function (e) { + const name = e.detail.name; + if (that[name]) { + console.log('Provider(' + that.id() + ') eventListener("subscribe",..) name "' + name + '" found.'); + that.callbackStore.push({name: name, callback: e.detail.callback, sender: e.detail.sender}); + + e.detail.callback(that[name]); + e.stopPropagation(); + } + }, false); + + parent.addEventListener('unsubscribe', function (e) { + const name = e.detail.name; + const sender = e.detail.sender; + if (that[name]) { + console.log('Provider(' + that.id() + ') eventListener("unsubscribe",..) name "' + name + '" found.'); + that.callbackStore.forEach(item => { + if (item.sender === sender && item.name === name) { + const index = that.callbackStore.indexOf(item); + that.callbackStore.splice(index, 1); + console.log('Provider(' + that.id() + ') eventListener for name "' + name + '" removed.') + } + }); + + e.stopPropagation(); + } + }, false); + } + + id() { + return this.getAttribute('id'); + } +} -- GitLab