diff --git a/packages/location-select/.gitignore b/packages/location-select/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..e62f92aa809c7345cb05914d7143b0322ab6d725 --- /dev/null +++ b/packages/location-select/.gitignore @@ -0,0 +1,5 @@ +dist +node_modules +.idea +npm-debug.log +package-lock.json diff --git a/packages/location-select/LICENSE b/packages/location-select/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..4362b49151d7b34ef83b3067a8f9c9f877d72a0e --- /dev/null +++ b/packages/location-select/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/location-select/README.md b/packages/location-select/README.md new file mode 100644 index 0000000000000000000000000000000000000000..cf4a3647d19f567daa67bfd248687c8b5bb55097 --- /dev/null +++ b/packages/location-select/README.md @@ -0,0 +1,49 @@ +# Location Select Web Component + +[GitLab Repository](https://gitlab.tugraz.at/dbp/web-components/LocationSelect) + +## Usage + +```html +<dbp-location-select></dbp-location-select> +``` + +## Attributes + +- `lang` (optional, default: `de`): set to `de` or `en` for German or English + - example `<dbp-location-select lang="de"></dbp-location-select>` +- `entry-point-url` (optional, default is the TU Graz entry point url): entry point url to access the api + - example `<dbp-location-select entry-point-url="http://127.0.0.1:8000"></dbp-location-select>` +- `value` (optional): api path of location to preload the selector with + - example `<dbp-location-select value="Besprechungsraum"></dbp-location-select>` + - the `value` will also be set automatically when a location is chosen in the selector +- `data-object` (read-only): when a location is selected the location object will be set as json string + - example `<dbp-location-select data-object="{"@id":"id", "@type":"http://schema.org/Place", "identifier":"id", "name":"Besprechungsraum", "maximumPhysicalAttendeeCapacity":"50"}"></dbp-location-select>` +- `show-capacity` (optional): also shows the capacity of the locations + - example `<dbp-location-select show-capacity></dbp-location-select>` +- `show-reload-button` (optional): if set a reload button will be viewed next to the select box + - the button triggers a `change` event on the web component + - the button is disabled if no location is selected + - example `<dbp-location-select show-reload-button></dbp-location-select>` +- `reload-button-title` (optional): sets a title text on the reload button + - example `<dbp-location-select show-reload-button reload-button-text="Reload result list"></dbp-location-select>` + +## Local development + +```bash +# get the source +git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git +cd toolkit/packages/location-select +git submodule update --init + +# 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-local + +# run tests +yarn test +``` + +Jump to <http://localhost:8002> and you should get a Single Sign On login page. diff --git a/packages/location-select/assets/index.html b/packages/location-select/assets/index.html new file mode 100644 index 0000000000000000000000000000000000000000..437004d2cdf00bcf76e08dd9636737cc9a594ecc --- /dev/null +++ b/packages/location-select/assets/index.html @@ -0,0 +1,12 @@ +<!doctype html> +<html> +<head> + <meta charset="UTF-8"> + <script type="module" src="dbp-location-select-demo.js"></script> +</head> + +<body> + +<dbp-location-select-demo lang="de"></dbp-location-select-demo> +</body> +</html> diff --git a/packages/location-select/i18next-scanner.config.js b/packages/location-select/i18next-scanner.config.js new file mode 100644 index 0000000000000000000000000000000000000000..8c277798414be902846c6eb4f0e95a19750cda39 --- /dev/null +++ b/packages/location-select/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/location-select/karma.conf.js b/packages/location-select/karma.conf.js new file mode 100644 index 0000000000000000000000000000000000000000..4b99e08adee238067dc7df307582333977129c4f --- /dev/null +++ b/packages/location-select/karma.conf.js @@ -0,0 +1,24 @@ +// Trick to use the auto-downloaded puppeteer chrome binary +process.env.CHROME_BIN = require('puppeteer').executablePath(); +const pkg = require('./package.json'); + +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/location-select/package.json b/packages/location-select/package.json new file mode 100644 index 0000000000000000000000000000000000000000..87ab016f9118b835e874e6458e21378f2b7d7afc --- /dev/null +++ b/packages/location-select/package.json @@ -0,0 +1,51 @@ +{ + "name": "dbp-location-select", + "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-replace": "^2.3.3", + "@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", + "jquery": "^3.4.1", + "keycloak-js": "^10.0.2", + "lit-element": "^2.3.1", + "select2": "^4.0.10", + "dbp-auth": "^1.0.0", + "dbp-common": "^1.0.0" + }, + "scripts": { + "clean": "rm dist/*", + "build": "npm run build-local", + "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": "npm run watch-local", + "watch-local": "rollup -c --watch", + "watch-dev": "rollup -c --watch --environment BUILD:development", + "test": "npm run build-test && karma start --singleRun" + } +} diff --git a/packages/location-select/rollup.config.js b/packages/location-select/rollup.config.js new file mode 100644 index 0000000000000000000000000000000000000000..dfe015bd1b7692788cb2c69b3dd405b3b6f486bf --- /dev/null +++ b/packages/location-select/rollup.config.js @@ -0,0 +1,61 @@ +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 {getPackagePath} from '../../rollup.utils.js'; + +const build = (typeof process.env.BUILD !== 'undefined') ? process.env.BUILD : 'local'; +console.log("build: " + build); + +export default (async () => { + return { + input: (build != 'test') ? ['src/dbp-location-select.js', 'src/dbp-location-select-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, + }), + 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'}, + ], + }), + (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/location-select/src/dbp-location-select-demo.js b/packages/location-select/src/dbp-location-select-demo.js new file mode 100644 index 0000000000000000000000000000000000000000..87da57ef68d0c5c0000f990c4fca5aa824146a13 --- /dev/null +++ b/packages/location-select/src/dbp-location-select-demo.js @@ -0,0 +1,88 @@ +import {i18n} from './i18n.js'; +import {css, html, LitElement} from 'lit-element'; +import {ScopedElementsMixin} from '@open-wc/scoped-elements'; +import {LocationSelect} from './location-select.js'; +import {AuthKeycloak, LoginButton} from 'dbp-auth'; +import * as commonUtils from 'dbp-common/utils'; +import * as commonStyles from 'dbp-common/styles'; + +class LocationSelectDemo extends ScopedElementsMixin(LitElement) { + constructor() { + super(); + this.lang = 'de'; + this.noAuth = false; + } + + static get scopedElements() { + return { + 'dbp-auth-keycloak': AuthKeycloak, + 'dbp-login-button': LoginButton, + 'dbp-location-select': LocationSelect, + }; + } + + static get properties() { + return { + lang: { type: String }, + noAuth: { type: Boolean, attribute: 'no-auth' }, + }; + } + + connectedCallback() { + super.connectedCallback(); + i18n.changeLanguage(this.lang); + + this.updateComplete.then(()=>{ + }); + } + + static get styles() { + // language=css + return [ + commonStyles.getThemeCSS(), + commonStyles.getGeneralCSS(), + css` + h1.title {margin-bottom: 1em;} + div.container {margin-bottom: 1.5em;} + ` + ]; + } + + getAuthComponentHtml() { + return this.noAuth ? html`` : html` + <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> + `; + } + + render() { + return html` + <section class="section"> + <div class="container"> + <h1 class="title">Location-Select-Demo</h1> + </div> + ${this.getAuthComponentHtml()} + <div class="container"> + <form> + <div class="field"> + <label class="label">Location 1</label> + <div class="control"> + <dbp-location-select lang="${this.lang}" entry-point-url="${commonUtils.getAPiUrl()}"></dbp-location-select> + </div> + </div> + <div class="field"> + <label class="label">Location 2</label> + <div class="control"> + <dbp-location-select lang="${this.lang}" entry-point-url="${commonUtils.getAPiUrl()}" show-reload-button reload-button-title="Click me"></dbp-location-select> + </div> + </div> + </form> + </div> + </section> + `; + } +} + +commonUtils.defineCustomElement('dbp-location-select-demo', LocationSelectDemo); diff --git a/packages/location-select/src/dbp-location-select.js b/packages/location-select/src/dbp-location-select.js new file mode 100644 index 0000000000000000000000000000000000000000..44f98c1e0e1b9658c8ffe0f99e9be865330dc16a --- /dev/null +++ b/packages/location-select/src/dbp-location-select.js @@ -0,0 +1,4 @@ +import * as commonUtils from 'dbp-common/utils'; +import {LocationSelect} from './location-select.js'; + +commonUtils.defineCustomElement('dbp-location-select', LocationSelect); diff --git a/packages/location-select/src/demo.js b/packages/location-select/src/demo.js new file mode 100644 index 0000000000000000000000000000000000000000..a6661deb4507beade4dc71a0d6eaf9e5ece40c2b --- /dev/null +++ b/packages/location-select/src/demo.js @@ -0,0 +1 @@ +import './dbp-location-select-demo.js'; diff --git a/packages/location-select/src/i18n.js b/packages/location-select/src/i18n.js new file mode 100644 index 0000000000000000000000000000000000000000..3fb3a1afd97f502121cf5f938fa17ae4ae5bcbef --- /dev/null +++ b/packages/location-select/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/location-select/src/i18n/de/select2.js b/packages/location-select/src/i18n/de/select2.js new file mode 100644 index 0000000000000000000000000000000000000000..487734d315bddea78931e81907b44033bceb504e --- /dev/null +++ b/packages/location-select/src/i18n/de/select2.js @@ -0,0 +1,46 @@ +/** + * Content from https://github.com/select2/select2/blob/master/src/js/select2/i18n/de.js + */ +export default function () { + // German + return { + errorLoading: function () { + return 'Die Ergebnisse konnten nicht geladen werden.'; + }, + inputTooLong: function (args) { + var overChars = args.input.length - args.maximum; + + return 'Bitte ' + overChars + ' Zeichen weniger eingeben'; + }, + inputTooShort: function (args) { + var remainingChars = args.minimum - args.input.length; + + return 'Bitte ' + remainingChars + ' Zeichen mehr eingeben, es kann nach mehreren Teilen von Namen gesucht werden'; + }, + loadingMore: function () { + return 'Lade mehr Ergebnisse…'; + }, + maximumSelected: function (args) { + var message = 'Sie können nur ' + args.maximum + ' Eintr'; + + if (args.maximum === 1) { + message += 'ag'; + } else { + message += 'äge'; + } + + message += ' auswählen'; + + return message; + }, + noResults: function () { + return 'Keine Übereinstimmungen gefunden'; + }, + searching: function () { + return 'Suche…'; + }, + removeAllItems: function () { + return 'Entferne alle Gegenstände'; + } + }; +}; diff --git a/packages/location-select/src/i18n/de/translation.json b/packages/location-select/src/i18n/de/translation.json new file mode 100644 index 0000000000000000000000000000000000000000..eae30547657aaf92157c0f284c13c192a9e08d95 --- /dev/null +++ b/packages/location-select/src/i18n/de/translation.json @@ -0,0 +1,7 @@ +{ + "location-select": { + "placeholder": "Bitte wählen Sie einen Ort aus", + "error-summary": "Ein Fehler ist aufgetreten", + "login-required": "Anmeldung erforderlich" + } +} diff --git a/packages/location-select/src/i18n/en/select2.js b/packages/location-select/src/i18n/en/select2.js new file mode 100644 index 0000000000000000000000000000000000000000..12ba14cc3c6a8af6a9c24a7366aef7ca739f3509 --- /dev/null +++ b/packages/location-select/src/i18n/en/select2.js @@ -0,0 +1,50 @@ +/** + * Content from https://github.com/select2/select2/blob/master/src/js/select2/i18n/en.js + */ +export default function () { + // English + return { + errorLoading: function () { + return 'The results could not be loaded.'; + }, + inputTooLong: function (args) { + var overChars = args.input.length - args.maximum; + + var message = 'Please delete ' + overChars + ' character'; + + if (overChars != 1) { + message += 's'; + } + + return message; + }, + inputTooShort: function (args) { + var remainingChars = args.minimum - args.input.length; + + var message = 'Please enter ' + remainingChars + ' or more characters, you can also search for multiple parts of names'; + + return message; + }, + loadingMore: function () { + return 'Loading more results…'; + }, + maximumSelected: function (args) { + var message = 'You can only select ' + args.maximum + ' item'; + + if (args.maximum != 1) { + message += 's'; + } + + return message; + }, + noResults: function () { + return 'No results found'; + }, + searching: function () { + return 'Searching…'; + }, + removeAllItems: function () { + return 'Remove all items'; + } + }; +}; diff --git a/packages/location-select/src/i18n/en/translation.json b/packages/location-select/src/i18n/en/translation.json new file mode 100644 index 0000000000000000000000000000000000000000..c1f2d7b6ae95f4cfd1bfa6a8a5c9235b833c6a66 --- /dev/null +++ b/packages/location-select/src/i18n/en/translation.json @@ -0,0 +1,7 @@ +{ + "location-select": { + "placeholder": "Please select a location", + "error-summary": "An error occurred", + "login-required": "Login required" + } +} diff --git a/packages/location-select/src/index.js b/packages/location-select/src/index.js new file mode 100644 index 0000000000000000000000000000000000000000..93b98e9f6d8dc6bff7879fe6b336020d617af8ba --- /dev/null +++ b/packages/location-select/src/index.js @@ -0,0 +1,3 @@ +import {LocationSelect} from './location-select.js'; + +export {LocationSelect}; \ No newline at end of file diff --git a/packages/location-select/src/location-select.js b/packages/location-select/src/location-select.js new file mode 100644 index 0000000000000000000000000000000000000000..4d76ed226edf92d9d13e3b4b7a1a178618939035 --- /dev/null +++ b/packages/location-select/src/location-select.js @@ -0,0 +1,361 @@ +import $ from 'jquery'; +import {findObjectInApiResults} from './utils.js'; +import select2 from 'select2'; +import select2LangDe from './i18n/de/select2' +import select2LangEn from './i18n/en/select2' +import JSONLD from 'dbp-common/jsonld'; +import {css, html, LitElement} from 'lit-element'; +import {ScopedElementsMixin} from '@open-wc/scoped-elements'; +import {i18n} from './i18n.js'; +import {Icon} from 'dbp-common'; +import * as commonUtils from 'dbp-common/utils'; +import * as commonStyles from 'dbp-common/styles'; +import select2CSSPath from 'select2/dist/css/select2.min.css'; +import * as errorUtils from "dbp-common/error"; + + +const locationContext = { + "@id": "@id", + "name": "http://schema.org/name", + "maximumPhysicalAttendeeCapacity": "http://schema.org/maximumPhysicalAttendeeCapacity" +}; + +select2(window, $); + +export class LocationSelect extends ScopedElementsMixin(LitElement) { + + constructor() { + super(); + this.lang = 'de'; + this.entryPointUrl = commonUtils.getAPiUrl(); + this.jsonld = null; + this.$select = null; + this.active = false; + // For some reason using the same ID on the whole page twice breaks select2 (regardless if they are in different custom elements) + this.selectId = 'location-select-' + commonUtils.makeId(24); + this.value = ''; + this.object = null; + this.ignoreValueUpdate = false; + this.isSearching = false; + this.lastResult = {}; + this.showReloadButton = false; + this.reloadButtonTitle = ''; + this.showCapacity = false; + } + + static get scopedElements() { + return { + 'dbp-icon': Icon, + }; + } + + $(selector) { + return $(this.shadowRoot.querySelector(selector)); + } + + static get properties() { + return { + lang: { type: String }, + active: { type: Boolean, attribute: false }, + entryPointUrl: { type: String, attribute: 'entry-point-url' }, + value: { type: String }, + object: { type: Object, attribute: false }, + showReloadButton: { type: Boolean, attribute: 'show-reload-button' }, + reloadButtonTitle: { type: String, attribute: 'reload-button-title' }, + showBirthDate: { type: Boolean, attribute: 'show-capacity' }, + }; + } + + clear() { + this.object = null; + $(this).attr("data-object", ""); + $(this).data("object", null); + this.$select.val(null).trigger('change').trigger('select2:unselect'); + } + + connectedCallback() { + super.connectedCallback(); + const that = this; + + this.updateComplete.then(()=>{ + that.$select = that.$('#' + that.selectId); + + // close the selector on blur of the web component + $(that).blur(() => { + // the 500ms delay is a workaround to actually get an item selected when clicking on it, + // because the blur gets also fired when clicking in the selector + setTimeout(() => { + if (this.select2IsInitialized()) { + that.$select.select2('close'); + } + }, 500); + }); + + // try an init when user-interface is loaded + that.initJSONLD(); + }); + } + + initJSONLD(ignorePreset = false) { + const that = this; + + JSONLD.initialize(this.entryPointUrl, function (jsonld) { + that.jsonld = jsonld; + that.active = true; + + // we need to poll because maybe the user interface isn't loaded yet + // Note: we need to call initSelect2() in a different function so we can access "this" inside initSelect2() + commonUtils.pollFunc(() => { return that.initSelect2(ignorePreset); }, 10000, 100); + }, {}, this.lang); + } + + /** + * Initializes the Select2 selector + */ + initSelect2(ignorePreset = false) { + const that = this; + const $this = $(this); + + if (this.jsonld === null) { + return false; + } + + // find the correct api url for a location + const apiUrl = this.jsonld.getApiUrlForIdentifier("http://schema.org/Place"); + // const apiUrl = this.jsonld.getApiUrlForEntityName("CheckInPlace"); + + if (this.$select === null) { + return false; + } + + // we need to destroy Select2 and remove the event listeners before we can initialize it again + if (this.$select && this.$select.hasClass('select2-hidden-accessible')) { + this.$select.select2('destroy'); + this.$select.off('select2:select'); + this.$select.off('select2:closing'); + } + + this.$select.select2({ + width: '100%', + language: this.lang === "de" ? select2LangDe() : select2LangEn(), + minimumInputLength: 2, + placeholder: i18n.t('location-select.placeholder'), + dropdownParent: this.$('#location-select-dropdown'), + ajax: { + delay: 500, + url: apiUrl, + contentType: "application/ld+json", + beforeSend: function (jqXHR) { + jqXHR.setRequestHeader('Authorization', 'Bearer ' + window.DBPAuthToken); + that.isSearching = true; + }, + data: function (params) { + return { + search: params.term.trim(), + }; + }, + processResults: function (data) { + that.lastResult = data; + let transformed = that.jsonld.transformMembers(data, locationContext); //TODO + const results = []; + transformed.forEach((place) => { + results.push({id: place["@id"], text: that.generateOptionText(place)}); + }); + + return { + results: results + }; + }, + error: errorUtils.handleXhrError, + complete: (jqXHR, textStatus) => { + that.isSearching = false; + } + } + }).on("select2:select", function (e) { + // set custom element attributes + const identifier = e.params.data.id; + that.object = findObjectInApiResults(identifier, that.lastResult); + + $this.attr("data-object", JSON.stringify(that.object)); + $this.data("object", that.object); + + if ($this.attr("value") !== identifier) { + that.ignoreValueUpdate = true; + $this.attr("value", identifier); + + // fire a change event + that.dispatchEvent(new CustomEvent('change', { + detail: { + value: identifier, + }, + bubbles: true + })); + } + }).on("select2:closing", (e) => { + if (that.isSearching) { + e.preventDefault(); + } + }); + + // TODO: doesn't work here + // this.$('.select2-selection__arrow').click(() => { + // console.log("click"); + // }); + + // preset a place + if (!ignorePreset && this.value !== '') { + const apiUrl = this.entryPointUrl + this.value; + + fetch(apiUrl, { + headers: { + 'Content-Type': 'application/ld+json', + 'Authorization': 'Bearer ' + window.DBPAuthToken, + }, + }) + .then(result => { + if (!result.ok) throw result; + return result.json(); + }) + .then((place) => { + that.object = place; + const transformed = that.jsonld.compactMember(that.jsonld.expandMember(place), locationContext); + const identifier = transformed["@id"]; + + const option = new Option(that.generateOptionText(transformed), identifier, true, true); + $this.attr("data-object", JSON.stringify(place)); + $this.data("object", place); //TODO the object is changed here + that.$select.append(option).trigger('change'); + + // fire a change event + that.dispatchEvent(new CustomEvent('change', { + detail: { + value: identifier, + }, + bubbles: true + })); + }).catch((e) => { + console.log(e); + that.clear(); + }); + } + + return true; + } + + generateOptionText(place) { + let text = place["name"]; + + // add maximum capacity to location if present + if (this.showCapacity && (place["maximumPhysicalAttendeeCapacity"] !== undefined) && (place["maximumPhysicalAttendeeCapacity"] !== null)) { + let capacity = place["maximumPhysicalAttendeeCapacity"]; + text += ` (${capacity})`; + } + + return text; + } + + update(changedProperties) { + changedProperties.forEach((oldValue, propName) => { + switch (propName) { + case "lang": + i18n.changeLanguage(this.lang); + + if (this.select2IsInitialized()) { + // no other way to set an other language at runtime did work + this.initSelect2(true); + } + break; + case "value": + if (!this.ignoreValueUpdate && this.select2IsInitialized()) { + this.initSelect2(); + } + + this.ignoreValueUpdate = false; + break; + case "entryPointUrl": + // we don't need to preset the selector if the entry point url changes + this.initJSONLD(true); + break; + } + }); + + super.update(changedProperties); + } + + select2IsInitialized() { + return this.$select !== null && this.$select.hasClass("select2-hidden-accessible"); + } + + reloadClick() { + if (this.object === null) { + return; + } + + // fire a change event + this.dispatchEvent(new CustomEvent('change', { + detail: { + value: this.value, + }, + bubbles: true + })); + } + + static get styles() { + return [ + commonStyles.getThemeCSS(), + commonStyles.getGeneralCSS(), + commonStyles.getButtonCSS(), + commonStyles.getFormAddonsCSS(), + commonStyles.getSelect2CSS(), + css` + .select2-control.control { + width: 100%; + } + + .field .button.control { + display: flex; + align-items: center; + justify-content: center; + border: 1px solid #aaa; + -moz-border-radius-topright: var(--dbp-border-radius); + -moz-border-radius-bottomright: var(--dbp-border-radius); + line-height: 100%; + } + + .field .button.control dbp-icon { + top: 0; + } + ` + ]; + } + + render() { + const select2CSS = commonUtils.getAssetURL(select2CSSPath); + return html` + <link rel="stylesheet" href="${select2CSS}"> + <style> + #${this.selectId} { + width: 100%; + } + </style> + + <div class="select"> + <div class="field has-addons"> + <div class="select2-control control"> + <!-- https://select2.org--> + <select id="${this.selectId}" name="location" class="select" ?disabled=${!this.active}>${!this.active ? html`<option value="" disabled selected>${ i18n.t('location-select.login-required')}</option>` : ''}</select> + </div> + <a class="control button" + id="reload-button" + ?disabled=${this.object === null} + @click="${this.reloadClick}" + style="display: ${this.showReloadButton ? "flex" : "none"}" + title="${this.reloadButtonTitle}"> + <dbp-icon name="reload"></dbp-icon> + </a> + </div> + <div id="location-select-dropdown"></div> + </div> + `; + } +} \ No newline at end of file diff --git a/packages/location-select/src/utils.js b/packages/location-select/src/utils.js new file mode 100644 index 0000000000000000000000000000000000000000..97d072d913ec7441ed76a704dc8658458ca0773b --- /dev/null +++ b/packages/location-select/src/utils.js @@ -0,0 +1,21 @@ + +/** + * Finds an object in a JSON result by identifier + * + * @param identifier + * @param results + * @param identifierAttribute + */ +export const findObjectInApiResults = (identifier, results, identifierAttribute = "@id") => { + const members = results["hydra:member"]; + + if (members === undefined) { + return; + } + + for (const object of members){ + if (object[identifierAttribute] === identifier) { + return object; + } + } +}; diff --git a/packages/location-select/test/unit.js b/packages/location-select/test/unit.js new file mode 100644 index 0000000000000000000000000000000000000000..139e1c05f05960710f163d03d0de1caedc63cfe9 --- /dev/null +++ b/packages/location-select/test/unit.js @@ -0,0 +1,38 @@ +import '../src/dbp-location-select.js'; +import '../src/demo.js'; + +describe('dbp-location-select basics', () => { + let node; + + beforeEach(async () => { + node = document.createElement('dbp-location-select'); + document.body.appendChild(node); + await node.updateComplete; + }); + + afterEach(() => { + node.remove(); + }); + + it('should render', () => { + expect(node).to.have.property('shadowRoot'); + }); +}); + +describe('dbp-location-select-demo basics', () => { + let node; + + beforeEach(async () => { + node = document.createElement('dbp-location-select-demo'); + document.body.appendChild(node); + await node.updateComplete; + }); + + afterEach(() => { + node.remove(); + }); + + it('should render', () => { + expect(node).to.have.property('shadowRoot'); + }); +});