From 49bdfff54580cb220427d140d8d6cbef9ef749fc Mon Sep 17 00:00:00 2001 From: Guido Scialfa Date: Thu, 15 Feb 2024 16:24:02 +0100 Subject: [PATCH] Add Documentation Introduce base documentation for developers #17 --- LICENSE | 339 ++++++++++++++++++ README.md | 20 ++ docs/api.md | 68 ++++ docs/components.md | 201 +++++++++++ docs/development.md | 53 +++ docs/hooks.md | 92 +++++ docs/installation.md | 18 + docs/logging.md | 27 ++ docs/storage.md | 15 + sources/client/src/api/fetch.ts | 3 + .../components/composite-entities-by-kind.tsx | 6 + .../src/hooks/use-entities-options-storage.ts | 7 +- .../client/src/hooks/use-entity-records.ts | 2 +- sources/client/src/hooks/use-search.ts | 10 + .../src/storage/entities/initial-state.ts | 4 + .../client/src/storage/entities/reducer.ts | 5 + sources/server/src/Modules/Logging/Module.php | 4 + 17 files changed, 872 insertions(+), 2 deletions(-) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 docs/api.md create mode 100644 docs/components.md create mode 100644 docs/development.md create mode 100644 docs/hooks.md create mode 100644 docs/installation.md create mode 100644 docs/logging.md create mode 100644 docs/storage.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 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. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, 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 or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +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 give any other recipients of the Program a copy of this License +along with the Program. + +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 Program or any portion +of it, thus forming a work based on the Program, 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) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +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 Program, 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 Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) 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; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, 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 executable. However, as a +special exception, the source code 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. + +If distribution of executable or 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 counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program 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. + + 5. 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 Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program 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 to +this License. + + 7. 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 Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program 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 Program. + +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. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program 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. + + 9. The Free Software Foundation may publish revised and/or new versions +of the 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 Program +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 Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, 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 + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "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 PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. 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 PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), 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 Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. 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. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program 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 General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; 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. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8f88829 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# WordPress Entities Search + +This package is a library exposing reusable Components and Utilities to help you build Entities searching and storage. + +At it's core it permits to build components and reuse the WordPress Rest API to search for Posts associated to one or +more Post Types but also, to search for Terms belonging to one or more Taxonomies. + +## Table of Content + +1. [Installation](./docs/installation.md) +2. [Development](./docs/development.md) +3. [Api](./docs/api.md) +4. [Components](./docs/components.md) +5. [Hooks](./docs/hooks.md) +6. [Logging](./docs/logging.md) +7. [Storage](./docs/storage.md) + +## License + +This software is released under the ["GNU General Public License v2.0 or later"](./LICENSE) license. diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..0bcc07b --- /dev/null +++ b/docs/api.md @@ -0,0 +1,68 @@ +# Api + +The `api` define a `fetch` function which is there to hide the WordPress Fetch API. The reason behind this decision lies on the fact that we might want to add middlewares to the request in the future or introducing some global data manipulation. + +The package provide then the following functions to interact with the WordPress API: + +## `searchEntities` + +This function is a wrapper for the Search Endpoint of the WordPress API. It will return a `Set` of entities matching the search query. + +The possible query arguments are specified by the `EntitiesSearch.QueryArguments` type, an interface you can expand to add more arguments. + +This function is not directly consumed by the components, and it is not intended to be used internally. The idea is to follow the Tell don't Ask principle and let the consumer specify how to search the Entities. + +Below a possible example of its usage related to a component: + +```tsx +// my-component.tsx +type Search = EntitiesSearch.SearchEntitiesFunction; +type Props = { + search: Search +} + +const MyComponent (props: Props) => { + const [entities, setEntities] = useState(new Set()); + + useEffect(() => { + props + .search( + 'my search phrase', + 'post', + new Set(['page']), + { + per_page: 10, + _fields: ['slug', 'title'] + } + ) + .then(setEntities); + }, []); + + // Do something with the entities +} + +// index.tsx +import {searchEntities} from 'wp-entities-search'; + +root.render(); +``` + +### Parameters + +The function accept four parameters + +- `type` - The root type. We have two built-int supported types `post`, `term`. +- `subtype` - The subtype of the entity. For example, if the `type` is `post`, the `subtype` can be `page`, `post`, etc. WordPress exclude automatically the `attachment` subtype. +- `phrase` - The search phrase. This becomes the `s` parameter for the Search Endpoint. +- `queryArguments` - All the supported and extra query arguments. The `EntitiesSearch.QueryArguments` type is an interface you can expand to add more arguments. + +### Return + +The function return an immutable `Set` of entities. + +NOTE: The function does not handle possible request exceptions. + +### Aborting Requests + +The `searchEntities` will automatically abort the requests with the same parameters if a new request is made before the previous one is completed. + diff --git a/docs/components.md b/docs/components.md new file mode 100644 index 0000000..c29add6 --- /dev/null +++ b/docs/components.md @@ -0,0 +1,201 @@ +# Components + +The Wp Entities Search provides a set of components you can use to build your search UI. + +We have to distinguish between two types of components: + +- **Base Components**: These are the basic building blocks of the search UI. They are the smallest components and are + used to build more complex components. +- **Composite Components**: These are more complex components that are built using the base ones. + +The _Composite Component_ does not have a direct dependency on the _Base Components_, indeed a composite component +encapsulate the logic +that deal with the state management of the data and pass it down to the base components in form of properties via +the `children` function. + +In a nutshell, a _Composite Component_ is configured from the external via props, dialog with the Rest API and pass the +data down to the _Base Components_. + +## Base Components + +- `PluralSelectControl` - A select control that allows multiple selections. +- `SingleSelectControl` - A select control that allows a single selection. +- `SearchControl` - An input control that allows the user to enter a search query. +- `ToggleControl` - A multi selection control that allows the user to toggle between multiple options. +- `RadioControl` - A single selection control that allows the user to select a single option. + +## Composite Components + +- `CompositeEntitiesByKind` - A composite component that displays a list of entities by kind. In this context _kind_ + is `post` or `term` and _entity_ is the entity type of the content e.g. a `page` or a `category` term. + +## Composite Entities by Kind + +The `CompositeEntitiesByKind` is a _generic_ component that can be used to display a list of entities by kind. It acts +as a controller that fetches the data from the Rest API using a given function and pass it down to one or more _Base +Components_. +It is up to you how to consume the data given to the children. Note, even if you consume just one part of the given +data, +the component will fetch all the data necessary to render the UI. + +This component is intended to fulfill a scenario where the user is looking for some entities belonging to a certain +_kind_, +for instance, selecting the `page` _kind_ will return a list of the available pages and to filter the result further it +is +possible to use a search function in conjunction with a `search` field. + +An example of its usage is: + +```jsx +import { CompositeEntitiesByKind } from 'wp-entities-search'; + +export function MyComponent(props) { + return convertEntitiesToControlOptions( + await searchEntities('post', kind, phrase, queryArguments), + 'title', + 'id' + ) + } + entities={{ + value: new Set([13, 24, 55]), + onChange: (value) => { + // Do something with the selected entities + // Notice, here you'll receive the value as a string Set. + } + }} + kind={{ + value: new Set(['page']), + options: [ + { label: 'Pages', value: 'page' }, + { label: 'Posts', value: 'post' }, + ], + onChange={(value) => { + // Do something with the selected kind + }} + }} + > + {({ entities, kind, search }) => ( + <> + + + + + )} + ; +} +``` + +In the example above we are passing a `searchEntities` function that will be used to fetch the entities from the Rest +API. This function is documented in the [api](./api.md) section. + +What's important to know is that the `queryArguments` do not include the `_fields` property because it's not a concern +of the component decide which fields to retrieve, it's up to the consumer to decide which fields to retrieve. Anyhow, +you can still override the given configuration, but you have to be aware this might produce an incorrect result if not +done correctly. The component might pass arguments necessary to guarantee the consistency of the Set of the entities and +the kind. + +In the following example we require `title` and `slug` fields to be retrieved from the Rest API. + +```typescript + async (phrase, kind, queryArguments) => { + const fields = ['title', 'slug']; + return convertEntitiesToControlOptions( + await searchEntities('post', kind, phrase, {...queryArguments, fields}), + ...fields + ) + } +``` + +The `entities` and `kind` properties are the initial configuration, they'll change depending on what happen within the +respective `onChange` functions. + +The `children` function will receive the `entities`, `kind` and `search` properties; notice the `search` is a function, +and it's up to the `SearchControl` to maintain the status of the value, the composite does hold the search value +internally, but it does not share it outside. + +You're not forced to consume all the properties given to the `children`, you can remove the `SearchControl` +and let the user select only the retrieved entities. Moreover, you can also not have the Kind control at all and just +allow the search for one single kind. + +In the example below we only allow to select the entities belonging to the `page` or `landing-page` kind not permitting +the user to switch between them. + +```jsx +import { CompositeEntitiesByKind } from 'wp-entities-search'; + +export function MyComponent(props) { + return convertEntitiesToControlOptions( + await searchEntities('post', kind, phrase, queryArguments), + 'title', + 'id' + ) + } + entities={{ + value: new Set([13, 24, 55]), + onChange: (value) => { + // Do something with the selected entities + } + }} + kind={{ + value: new Set(['page', 'landing-page']), + options: Set([]), + onChange={() => {}} + }} + > + {({ entities, _, search }) => ( + <> + + + + )} + ; +} +``` + +Obviously depending on what you want to achieve you can use different _Base Components_ or create new ones, as mentioned +above the package comes with a set of _Base Components_ that can be used out of the box. + +## About Singular Base Components + +The _Composite Component_ always give a collection of Entities and Kind even though you are consuming a Single* _Base Component_. + +The Singular Components always get a single value, therefore you have to consider to extract the first element out of the `Set`. + +```jsx +import { CompositeEntitiesByKind } from 'wp-entities-search'; + +export function MyComponent(props) { + return + {({ entities, kind, search }) => ( + <> + + /* ... */ + + )} + ; +} +``` diff --git a/docs/development.md b/docs/development.md new file mode 100644 index 0000000..66e35c4 --- /dev/null +++ b/docs/development.md @@ -0,0 +1,53 @@ +# Development + +The first thing to do is to clone the repository and install the dependencies: + +```bash +$ git clone git@github.com:widoz/wp-entities-search.git +$ cd wp-entities-search +$ composer install +$ yarn install +``` + +After we have installed the dependencies we need to build the assets: + +```bash +$ yarn build +``` + +or alternatively we can run the dev script to compile the assets with source maps: + +```bash +$ yarn build:dev +``` + +## The Environment + +The project is making use of `@wordress/env` as a local environment to develop the solution. + +To start the environment we need to run the following command: + +```bash +$ yarn wp-env start +``` + +This will install WordPress and will set the current project as a plugin. The package contain a E2E module used by the plugin to help with the development. The module register two blocks; one for the Custom Post Type and one for the Custom Taxonomy. + +The WordPress installation is provided without content. To add some we can run the following commands from the root of the project: + +```bash +./scripts/create-posts.sh --num 20 --title Post --type post +./scripts/create-posts.sh --num 20 --title Page --type page +./scripts/create-terms.sh --num 20 --name Category --taxonomy category +./scripts/create-terms.sh --num 20 --name Tag --taxonomy post_tag +``` + +## Basic Concepts + +The package implement a Value Object to handle immutability called `Set`. This is the main implementation used by the package to work with external data. Whenever a data is fetched from the WordPress API it will be wrapped in a `Set` object, but also all components and functions deal with this implementation. In a summary, every data entering the package will be wrapped in a `Set` object. + +Another commonly used data structure is the `ControlOption` which is not directly consumed but define the type of the `Set`. It should not be consumed directly but through the `Set` api. + +## Usage Examples + +As mentioned above the package have a E2E module which register two blocks to test the functionality. The first block is a Custom Post Type and the second one is a Custom Taxonomy. The two blocks are using the same component to render the results, you can get some insight about the usage from them. diff --git a/docs/hooks.md b/docs/hooks.md new file mode 100644 index 0000000..f4ebb55 --- /dev/null +++ b/docs/hooks.md @@ -0,0 +1,92 @@ +# Hooks + +The Wp Entities Search expose some hooks to help you to work with the search and the rest calls. + +- `useEntitiesOptionsStorage` +- `useEntitiesRecords` +- `useQueryViewablePostTypes` +- `useQueryViewableTaxonomies` +- `useSearch` + +## `useEntitiesOptionsStorage` + +This hook is used to initialize the option's storage. It gets passed a partial `initialState` and the `searchEntities` +function. + +The partial `initialState` includes the initial values for the `entities` and the `kind`. The `searchEntities` function +is used to search for the entities and store the results in the state. + +The returned value is the readonly `state` and the `dispatch` function to update it. + +```jsx +const [state, dispatch] = useEntitiesOptionsStorage( + { + entities: props.entities, // Set([12, 43, 112]) + kind: props.kind, // Set(['page']) + }, + props.searchEntities +); +``` + +## `useEntitiesRecords` + +This hook represent the main api to get the entities records from the server. + +This is different from the search api in the sense that, the search api is used to search for the entities belonging +to one or more kinds by a phrase. The records api is used to retrieve the entities belonging to a specific kind. Both +solutions +customize the query by additional arguments. + +In the future the two api might be merged into one. + +The current situation is due the fact the `useEntityRecords` does not allow more than one `kind` and the `useSearch` is +not +capable of retrieving the entities **kinds**. + +This hook is a decorator of the WordPress `useEntityRecords` hook, and it augment the original hook with some methods +for an easy consumption. + +- `records()` - The records of the entities. +- `isResolving()` - A boolean to check if the records are resolving. +- `errored()` - A boolean to check if the request failed. +- `succeed()` - A boolean to check if the request succeed. + +Regarding the parameters, along with the `kind` and the `name` (entity name) it accept additional arguments to +customize the query. The accepted arguments are the same arguments accepted by the respective WordPress Rest API +endpoint. + +The following example is retrieving the list of the `postType`s from the server. + +```ts +const entitiesRecords = useEntityRecords>( + 'root', + 'postType', + { per_page: -1 } +); +``` + +Even if publicly available this hook is not intended to be consumed from within any component. Instead, it meant to be +used by other hooks to return a specific set of entities based on their configuration. + +## `useQueryViewablePostTypes` + +This hook is a subset of the `useEntitiesRecords` hook. It is used to retrieve the list of the viewable post types. + +## `useQueryViewableTaxonomies` + +This hook is a subset of the `useEntitiesRecords` hook. It is used to retrieve the list of the viewable taxonomies. +Differently than the post types the taxonomies does not have a `viewable` property, in this case we query +the `visibility.publicly_queryable` prop. + +## `useSearch` + +This hook will return a throttled function to search for the entities. In-fact it's more a _factory hook_. The returned +function get one single parameter the `phrase`. This is convenient because we do not have to pass multiple props down +the components three or use a context / state. + +It requires a function `searchEntities` to perform the search to the server, the `kind` and `entities` to correctly +query for the new entities values. In the future there'll be the possibility to reuse the storage directly from within +the hook reducing the amount of parameters, and for last the `dispatch`, necessary to update the shared state. + +When the state update fail for any reason an action `wp-entities-search.on-search.error` is fired. You can hook into it +and consume the given `error` instance. More on this in the [logging](./logging.md) documentation. diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..99b9dad --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,18 @@ +# Installation + +This package is available as a composer library and as a npm package. + +You're not forced to use both, you can use only one of them. The php implementation is using [Modularity](https://github.com/inpsyde/modularity) a modular [PSR-11](https://github.com/php-fig/container) implementation for WordPress Plugins, Themes and Libraries. +The JavaScript implementation is composed of a set of utilities and React components to help you build your own UI. + +## Composer + +To install the package as part of the composer dependencies of your project, run the following command: + +```bash +composer require widoz/wp-entities-search +``` + +## NPM + +Not Ready Yet diff --git a/docs/logging.md b/docs/logging.md new file mode 100644 index 0000000..3d1cc6b --- /dev/null +++ b/docs/logging.md @@ -0,0 +1,27 @@ +# Logging + +The project make use of some WordPress Actions in contexts where the logic flow might fail for some reason, for instance +when there's a REST request that fails to be processed. In these cases, the project will fire an action. + +The logging is part of an additional Modularity module called _Logging_. This module only boot when the env is set in +debugging mode. + +The client part of the module consist in a simple file hooking in those actions and writing the logs to the console. + +For instance, below you can see an example of one of the actions error logging. + +```ts +addAction( + 'wp-entities-search.on-change-entities.error', + 'wp-entities-search/wp-on-change-entities.error', + (error) => { + console.error( + `Composite Entities by Kind - on Change Entities: ${ + new Error(error).message + }` + ); + } +); +``` + +Obviously the actions fired by the code are not solely for logging, you can use them however you want. diff --git a/docs/storage.md b/docs/storage.md new file mode 100644 index 0000000..44e5df9 --- /dev/null +++ b/docs/storage.md @@ -0,0 +1,15 @@ +# Storage + +You won't interact directly with the store but as mentioned in [hooks](./hooks.md), you can use the `useEntitiesOptionsStorage`. + +The hook return the `state` and the `dispatch` but you have to configure it first. + +The storage is not directly accessible because the intent of the project is to provide high level components that act as a bridge +between the configuration you need to provide and the components you want to use. Hence, it does not make sense to expose the storage api directly. + +There are circumstances where you want to create your own high level component, and you need to use the storage. +In that case, you can use the `useEntitiesOptionsStorage` hook. + +For more information please read the [component](./components.md) section, or, alternatively have a look at the +[CompositeEntitiesByKind](../sources/client/src/components/composite-entities-by-kind.tsx) component. + diff --git a/sources/client/src/api/fetch.ts b/sources/client/src/api/fetch.ts index 01ba003..c7f419f 100644 --- a/sources/client/src/api/fetch.ts +++ b/sources/client/src/api/fetch.ts @@ -1,3 +1,6 @@ import apiFetch from '@wordpress/api-fetch'; +/** + * @internal + */ export const fetch = apiFetch; diff --git a/sources/client/src/components/composite-entities-by-kind.tsx b/sources/client/src/components/composite-entities-by-kind.tsx index 41f9bf5..8519b89 100644 --- a/sources/client/src/components/composite-entities-by-kind.tsx +++ b/sources/client/src/components/composite-entities-by-kind.tsx @@ -9,6 +9,12 @@ import { orderSelectedOptionsAtTheTop } from '../utils/order-selected-options-at import { uniqueControlOptions } from '../utils/unique-control-options'; import { Set } from '../vo/set'; +/** + * A composite component that provides a way to search for entities by kind. + * + * @public + * @param props The component props. + */ export function CompositeEntitiesByKind( props: EntitiesSearch.CompositeEntitiesKinds ): JSX.Element { diff --git a/sources/client/src/hooks/use-entities-options-storage.ts b/sources/client/src/hooks/use-entities-options-storage.ts index 62bcb55..4963642 100644 --- a/sources/client/src/hooks/use-entities-options-storage.ts +++ b/sources/client/src/hooks/use-entities-options-storage.ts @@ -12,8 +12,13 @@ type _Reducer = Reducer< EntitiesSearch.StoreAction >; +/** + * @public + * @param initialState The initial state configuration + * @param searchEntities The function that will search the entities + */ export function useEntitiesOptionsStorage( - initialState: Partial>, + initialState: Pick, 'entities' | 'kind'>, searchEntities: EntitiesSearch.SearchEntitiesFunction ): Readonly< [ diff --git a/sources/client/src/hooks/use-entity-records.ts b/sources/client/src/hooks/use-entity-records.ts index ee1296b..655dee9 100644 --- a/sources/client/src/hooks/use-entity-records.ts +++ b/sources/client/src/hooks/use-entity-records.ts @@ -15,7 +15,7 @@ enum ResolveStatus { * This is to guarantee a better flow in the data manipulation, therefore do not count on the data returned by the * `records()` as an indicator of the hook status. * - * @internal + * @public * @param kind The kind of entity to fetch. E.g. 'root', 'postType', 'taxonomy', etc. * @param name The name of the entity to fetch. E.g. 'post', 'page', 'category', etc. * @param queryArgs The query args to pass to the entity fetch. E.g. { per_page: 100 } diff --git a/sources/client/src/hooks/use-search.ts b/sources/client/src/hooks/use-search.ts index 7b1e9c6..6ee1462 100644 --- a/sources/client/src/hooks/use-search.ts +++ b/sources/client/src/hooks/use-search.ts @@ -9,6 +9,16 @@ import { Set } from '../vo/set'; type SearchPhrase = Parameters[0]; type SearchFunc = (phrase: SearchPhrase) => void; +/** + * Build a function to search the entities by a phrase + * + * @public + * @param setSearchPhrase A function to set the search phrase + * @param searchEntities The function that will search the entities + * @param kind The kind of entities to search + * @param entities The entities to exclude from the search + * @param dispatch The dispatch function to update the state + */ export function useSearch( searchEntities: EntitiesSearch.SearchEntitiesFunction, kind: EntitiesSearch.Kind, diff --git a/sources/client/src/storage/entities/initial-state.ts b/sources/client/src/storage/entities/initial-state.ts index c928e99..934d92c 100644 --- a/sources/client/src/storage/entities/initial-state.ts +++ b/sources/client/src/storage/entities/initial-state.ts @@ -4,6 +4,10 @@ import { Set } from '../../vo/set'; type Options = EntitiesSearch.ControlOption; +/** + * @internal + * @param initialState The initial state to merge with the default state + */ export function makeInitialState( initialState: Partial> ): EntitiesSearch.EntitiesState { diff --git a/sources/client/src/storage/entities/reducer.ts b/sources/client/src/storage/entities/reducer.ts index 9925b89..0d1f34b 100644 --- a/sources/client/src/storage/entities/reducer.ts +++ b/sources/client/src/storage/entities/reducer.ts @@ -2,6 +2,11 @@ import EntitiesSearch from '@types'; import { Set } from '../../vo/set'; +/** + * @internal + * @param state The state of the reducer + * @param action The action to be performed + */ export function reducer( state: EntitiesSearch.EntitiesState, action: EntitiesSearch.StoreAction diff --git a/sources/server/src/Modules/Logging/Module.php b/sources/server/src/Modules/Logging/Module.php index d5d46a7..37249c0 100644 --- a/sources/server/src/Modules/Logging/Module.php +++ b/sources/server/src/Modules/Logging/Module.php @@ -25,6 +25,10 @@ final private function __construct() public function run(Container\ContainerInterface $container): bool { + if (!$container->get(Modularity\Package::PROPERTIES)->isDebug()) { + return false; + } + \add_action('init', static function () use ($container) { /** @var Modularity\Properties\Properties $properties */ $properties = $container->get(Modularity\Package::PROPERTIES);