From b7e62a1c7eaaa31d0e2e27d6207f7a771834709b Mon Sep 17 00:00:00 2001 From: smouillour Date: Wed, 2 Oct 2024 11:02:26 +0200 Subject: [PATCH] fix: extract query-client (tql) from faceted-search --- packages/faceted-search-query-client/LICENSE | 201 ++++++++++++++++++ .../faceted-search-query-client/README.md | 18 ++ .../faceted-search-query-client/package.json | 67 ++++++ .../src}/index.js | 0 .../src}/tql.js | 9 +- .../src}/tql.test.js | 0 packages/faceted-search/README.md | 18 +- packages/faceted-search/src/index.js | 19 +- yarn.lock | 44 +--- 9 files changed, 315 insertions(+), 61 deletions(-) create mode 100644 packages/faceted-search-query-client/LICENSE create mode 100644 packages/faceted-search-query-client/README.md create mode 100644 packages/faceted-search-query-client/package.json rename packages/{faceted-search/src/queryClient => faceted-search-query-client/src}/index.js (100%) rename packages/{faceted-search/src/queryClient => faceted-search-query-client/src}/tql.js (96%) rename packages/{faceted-search/src/queryClient => faceted-search-query-client/src}/tql.test.js (100%) diff --git a/packages/faceted-search-query-client/LICENSE b/packages/faceted-search-query-client/LICENSE new file mode 100644 index 00000000000..8dada3edaf5 --- /dev/null +++ b/packages/faceted-search-query-client/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/faceted-search-query-client/README.md b/packages/faceted-search-query-client/README.md new file mode 100644 index 00000000000..76e7cae05af --- /dev/null +++ b/packages/faceted-search-query-client/README.md @@ -0,0 +1,18 @@ +# @talend/react-faceted-search-query-client + +## Installation + +Add npm package + +`yarn add @talend/react-faceted-search-query-client` + +## General + +react-faceted-search-query-client is there to manage advanced search with @talend/react-faceted-search + +## Usage + +``` +import { createTqlQuery } from '@talend/react-faceted-search-query-client' +const tqlQuery = createTqlQuery(facetedSubmitOutput); +``` diff --git a/packages/faceted-search-query-client/package.json b/packages/faceted-search-query-client/package.json new file mode 100644 index 00000000000..7ddcb32179b --- /dev/null +++ b/packages/faceted-search-query-client/package.json @@ -0,0 +1,67 @@ +{ + "name": "@talend/react-faceted-search-query-client", + "version": "0.0.1", + "description": "Faceted search Query client", + "main": "lib/index.js", + "module": "./lib-esm/index.js", + "exports": { + "./lib/*": { + "import": "./lib-esm/*", + "require": "./lib/*" + }, + ".": { + "import": "./lib-esm/index.js", + "require": "./lib/index.js" + } + }, + "license": "Apache-2.0", + "scripts": { + "build:dev": "talend-scripts build --umd --dev", + "build:prod": "talend-scripts build --umd --prod", + "pre-release": "yarn build:dev && yarn build:prod", + "build:lib": "talend-scripts build", + "build:lib:esm": "talend-scripts build --esm", + "test": "cross-env TZ=UTC talend-scripts test", + "test:watch": "cross-env TZ=UTC talend-scripts test --watch", + "test:cov": "cross-env TZ=UTC talend-scripts test --coverage", + "lint": "talend-scripts lint ./src/**/*.js ./stories/**/*.js ./.storybook/**/*.js", + "extract-i18n": "i18next-scanner --config i18next-scanner.config.js" + }, + "keywords": [ + "react", + "talend", + "faceted-search", + "query-client", + "tql" + ], + "author": "Talend Frontend ", + "homepage": "https://github.com/Talend/ui/tree/master/packages/faceted-search-query-client#readme", + "bugs": { + "url": "https://github.com/Talend/ui/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/Talend/ui.git" + }, + "dependencies": { + "@talend/daikon-tql-client": "^1.3.1", + "lodash": "^4.17.21" + }, + "devDependencies": { + "@talend/eslint-config": "^13.2.1", + "@talend/eslint-plugin": "^1.3.1", + "@talend/react-faceted-search": "20.0.2", + "@talend/scripts-core": "^16.5.1", + "@talend/scripts-config-babel": "^13.5.0", + "@talend/scripts-config-jest": "^14.1.0", + "@talend/scripts-config-react-webpack": "^16.8.1", + "@talend/scripts-config-typescript": "^11.3.0", + "cross-env": "^7.0.3" + }, + "peerDependencies": { + "@talend/react-faceted-search": "^20.0.2" + }, + "publishConfig": { + "access": "public" + } +} diff --git a/packages/faceted-search/src/queryClient/index.js b/packages/faceted-search-query-client/src/index.js similarity index 100% rename from packages/faceted-search/src/queryClient/index.js rename to packages/faceted-search-query-client/src/index.js diff --git a/packages/faceted-search/src/queryClient/tql.js b/packages/faceted-search-query-client/src/tql.js similarity index 96% rename from packages/faceted-search/src/queryClient/tql.js rename to packages/faceted-search-query-client/src/tql.js index 27f5ad7a955..0bf3440aa81 100644 --- a/packages/faceted-search/src/queryClient/tql.js +++ b/packages/faceted-search-query-client/src/tql.js @@ -1,7 +1,10 @@ -import { Query } from '@talend/daikon-tql-client'; -import isEmpty from 'lodash/isEmpty'; import flow from 'lodash/flow'; -import { operatorNames } from '../dictionary/operator.dictionary'; +import isEmpty from 'lodash/isEmpty'; + +import { Query } from '@talend/daikon-tql-client'; +import facetedSearch from '@talend/react-faceted-search'; + +const { operatorNames } = facetedSearch.helpers; const getBadgeQueryValues = ({ properties }) => [ properties.attribute, diff --git a/packages/faceted-search/src/queryClient/tql.test.js b/packages/faceted-search-query-client/src/tql.test.js similarity index 100% rename from packages/faceted-search/src/queryClient/tql.test.js rename to packages/faceted-search-query-client/src/tql.test.js diff --git a/packages/faceted-search/README.md b/packages/faceted-search/README.md index 802774c1288..e85262c30e7 100644 --- a/packages/faceted-search/README.md +++ b/packages/faceted-search/README.md @@ -8,8 +8,8 @@ Add npm package ## General -Faceted has two mode, Basic and Advanced. -You have to import the component FacetedSearch in your app. +Faceted has two mode, Basic and Advanced. +You have to import the component FacetedSearch in your app. If you are using the two modes the implementation should look like this : ``` @@ -36,7 +36,7 @@ Each mode take its own onSubmit callback if you need different behavior. ## Basic search The BasicSearch search will only handle for you the badges management (CRUD). -You have to provide the onSubmit callback, which return the current badges. +You have to provide the onSubmit callback, which return the current badges. Be aware that onSubmit is trigger on each change of local state badges, even if this one is empty. A badge is defined by a 'badgeDefinition' : @@ -62,7 +62,7 @@ A badge is defined by a 'badgeDefinition' : badgesDefinitions={badgesDefinitions} /> -If you need to save the badges in the local storage or the store you will have to handle the badges synchronization. +If you need to save the badges in the local storage or the store you will have to handle the badges synchronization. Your parent component must passed badgesFaceted (to restore the saved badges) and a setBadgesFaceted props callback which will be trigger every time a badge will change and sync it with your parent (CRUD). ``` @@ -76,17 +76,17 @@ Your parent component must passed badgesFaceted (to restore the saved badges) an ## Advanced search -The advanced search is a free text input. +The advanced search is a free text input. To send the request the user have to press enter or to click on the validate icon. ## Tql -There is no coupling between the output's data send in the submit callback and the request send to the backend api. -You will receive the current badges state. -If you want to use tql (Talend query language) you should use the function given in the tql file +There is no coupling between the output's data send in the submit callback and the request send to the backend api. +You will receive the current badges state. +If you want to use tql (Talend query language) you should add `@talend/react-faceted-search-query-client` in your project and use the function given in the tql file ``` -import { createTqlQuery } from './tql.js' +import { createTqlQuery } from '@talend/react-faceted-search-query-client' const tqlQuery = createTqlQuery(facetedSubmitOutput); ``` diff --git a/packages/faceted-search/src/index.js b/packages/faceted-search/src/index.js index 680c6e625c8..61b0f4aff93 100644 --- a/packages/faceted-search/src/index.js +++ b/packages/faceted-search/src/index.js @@ -1,18 +1,18 @@ +import * as constants from './constants'; import { - FacetedSearch as Faceted, AdvancedSearch, - BasicSearch, - badgeDefinitionTypes, - BadgeText, - BadgeSlider, - BadgeOverlay, BadgeCheckboxes, BadgeCheckboxesForm, + badgeDefinitionTypes, BadgeFaceted, + BadgeOverlay, + BadgeSlider, + BadgeText, + BasicSearch, + FacetedSearch as Faceted, } from './components'; -import * as constants from './constants'; import dictionaryHelpers from './dictionary/helpers.dictionary'; -import * as queryClient from './queryClient'; +import { operatorNames } from './dictionary/operator.dictionary'; const components = { Faceted, @@ -28,6 +28,7 @@ const components = { const helpers = { dictionary: dictionaryHelpers, + operatorNames, }; -export default { ...components, badgeDefinitionTypes, constants, helpers, queryClient }; +export default { ...components, badgeDefinitionTypes, constants, helpers }; diff --git a/yarn.lock b/yarn.lock index 5e52cd5f9d2..bbfd8145ba4 100644 --- a/yarn.lock +++ b/yarn.lock @@ -11027,18 +11027,7 @@ html-tags@^3.1.0, html-tags@^3.3.1: tapable "^1.1.3" util.promisify "1.0.0" -"html-webpack-plugin-5@npm:html-webpack-plugin@^5": - version "5.6.0" - resolved "https://registry.yarnpkg.com/html-webpack-plugin/-/html-webpack-plugin-5.6.0.tgz#50a8fa6709245608cb00e811eacecb8e0d7b7ea0" - integrity sha512-iwaY4wzbe48AfKLZ/Cc8k0L+FKG6oSNRaZ8x5A/T/IVDGyXcbHncM9TdDa93wn0FsSm82FhTKW7f3vS61thXAw== - dependencies: - "@types/html-minifier-terser" "^6.0.0" - html-minifier-terser "^6.0.2" - lodash "^4.17.21" - pretty-error "^4.0.0" - tapable "^2.0.0" - -html-webpack-plugin@^5.5.0, html-webpack-plugin@^5.6.0: +"html-webpack-plugin-5@npm:html-webpack-plugin@^5", html-webpack-plugin@^5.5.0, html-webpack-plugin@^5.6.0: version "5.6.0" resolved "https://registry.yarnpkg.com/html-webpack-plugin/-/html-webpack-plugin-5.6.0.tgz#50a8fa6709245608cb00e811eacecb8e0d7b7ea0" integrity sha512-iwaY4wzbe48AfKLZ/Cc8k0L+FKG6oSNRaZ8x5A/T/IVDGyXcbHncM9TdDa93wn0FsSm82FhTKW7f3vS61thXAw== @@ -17838,16 +17827,7 @@ string-replace-loader@^2.3.0: loader-utils "^1.2.3" schema-utils "^2.6.5" -"string-width-cjs@npm:string-width@^4.2.0": - version "4.2.3" - resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" - integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== - dependencies: - emoji-regex "^8.0.0" - is-fullwidth-code-point "^3.0.0" - strip-ansi "^6.0.1" - -"string-width@^1.0.2 || 2 || 3 || 4", string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3: +"string-width-cjs@npm:string-width@^4.2.0", "string-width@^1.0.2 || 2 || 3 || 4", string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3: version "4.2.3" resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== @@ -17963,7 +17943,7 @@ stringify-entities@^4.0.0: character-entities-html4 "^2.0.0" character-entities-legacy "^3.0.0" -"strip-ansi-cjs@npm:strip-ansi@^6.0.1": +"strip-ansi-cjs@npm:strip-ansi@^6.0.1", strip-ansi@^6.0.0, strip-ansi@^6.0.1: version "6.0.1" resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== @@ -17977,13 +17957,6 @@ strip-ansi@^3.0.1: dependencies: ansi-regex "^2.0.0" -strip-ansi@^6.0.0, strip-ansi@^6.0.1: - version "6.0.1" - resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" - integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== - dependencies: - ansi-regex "^5.0.1" - strip-ansi@^7.0.1, strip-ansi@^7.1.0: version "7.1.0" resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-7.1.0.tgz#d5b6568ca689d8561370b0707685d22434faff45" @@ -19921,7 +19894,7 @@ wordwrap@^1.0.0: resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-1.0.0.tgz#27584810891456a4171c8d0226441ade90cbcaeb" integrity sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q== -"wrap-ansi-cjs@npm:wrap-ansi@^7.0.0": +"wrap-ansi-cjs@npm:wrap-ansi@^7.0.0", wrap-ansi@^7.0.0: version "7.0.0" resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== @@ -19939,15 +19912,6 @@ wrap-ansi@^6.0.1, wrap-ansi@^6.2.0: string-width "^4.1.0" strip-ansi "^6.0.0" -wrap-ansi@^7.0.0: - version "7.0.0" - resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" - integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== - dependencies: - ansi-styles "^4.0.0" - string-width "^4.1.0" - strip-ansi "^6.0.0" - wrap-ansi@^8.1.0: version "8.1.0" resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-8.1.0.tgz#56dc22368ee570face1b49819975d9b9a5ead214"