From 60defd69ed1f098e85d11bf19b863662e88d5c7d Mon Sep 17 00:00:00 2001 From: arashagp Date: Sun, 8 Dec 2024 08:40:02 +0330 Subject: [PATCH 01/18] feat(store): initialize of store package --- packages/store/LICENSE | 661 ++++++++++++++++++ packages/store/README.md | 60 ++ packages/store/package.json | 79 +++ packages/store/src/main.ts | 3 + .../store/src/store-modules/base-store.ts | 14 + .../src/store-modules/store-with-backup.ts | 135 ++++ packages/store/src/store-modules/store.ts | 12 + packages/store/src/type.ts | 1 + packages/store/tsconfig.json | 12 + yarn.lock | 78 +++ 10 files changed, 1055 insertions(+) create mode 100644 packages/store/LICENSE create mode 100644 packages/store/README.md create mode 100644 packages/store/package.json create mode 100644 packages/store/src/main.ts create mode 100644 packages/store/src/store-modules/base-store.ts create mode 100644 packages/store/src/store-modules/store-with-backup.ts create mode 100644 packages/store/src/store-modules/store.ts create mode 100644 packages/store/src/type.ts create mode 100644 packages/store/tsconfig.json diff --git a/packages/store/LICENSE b/packages/store/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/packages/store/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + 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 +them 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey 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; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + 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. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +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. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + 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 +state 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 Affero General Public License as published + by the Free Software Foundation, either version 3 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/packages/store/README.md b/packages/store/README.md new file mode 100644 index 0000000..b3a6845 --- /dev/null +++ b/packages/store/README.md @@ -0,0 +1,60 @@ +# @nexim/element + +![NPM Version](https://img.shields.io/npm/v/%40nexim%2Felement) +![npm bundle size](https://img.shields.io/bundlephobia/min/%40nexim%2Felement) +![Build & Lint & Test](https://github.com/the-nexim/nanolib/actions/workflows/build-lint-test.yaml/badge.svg) +![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Felement) +![NPM License](https://img.shields.io/npm/l/%40nexim%2Felement) + +## Overview + +`@nexim/element` is a collection of utility functions and mixins for building high-performance, maintainable web components using Lit. + +## Installation + +```sh +npm install @nexim/element + +# Or using yarn +yarn add @nexim/element +``` + +## API + +### LoggerMixin + +The LoggerMixin adds logging capabilities to your LitElement components. It logs lifecycle methods and measures update times. + +```ts +import {LitElement, html} from 'lit'; +import {LoggerMixin} from '@nexim/element'; + +class MyElement extends LoggerMixin(LitElement) { + protected override render() { + super.render(); // must call super method to logger work + + return html`

Hello, world!

`; + } +} +``` + +### LightDomMixin + +The LightDomMixin enables light DOM rendering and style encapsulation for LitElement components. + +```ts +import {LitElement, html, css} from 'lit'; +import {LightDomMixin} from '@nexim/element'; + +class MyLightDomElement extends LightDomMixin(LitElement) { + static styles = css` + p { + color: blue; + } + `; + + protected override render() { + return html`

Hello, light DOM!

`; + } +} +``` diff --git a/packages/store/package.json b/packages/store/package.json new file mode 100644 index 0000000..65ed9ae --- /dev/null +++ b/packages/store/package.json @@ -0,0 +1,79 @@ +{ + "name": "@nexim/store", + "version": "1.0.0", + "description": "Utility functions and mixins for building high-performance web components with Lit.", + "keywords": [ + "lit", + "web-components", + "mixins", + "logger", + "light-dom", + "typescript", + "nexim" + ], + "homepage": "https://github.com/the-nexim/nanolib/tree/next/packages/element#readme", + "bugs": { + "url": "https://github.com/the-nexim/nanolib/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/the-nexim/nanolib", + "directory": "packages/element" + }, + "license": "AGPL-3.0-only", + "author": "S. Amir Mohammad Najafi (www.njfamirm.ir)", + "contributors": [ + "Arash Ghardashpoor (https://www.agpagp.ir)" + ], + "type": "module", + "exports": { + ".": { + "types": "./dist/main.d.ts", + "import": "./dist/main.mjs", + "require": "./dist/main.cjs" + } + }, + "main": "./dist/main.cjs", + "module": "./dist/main.mjs", + "types": "./dist/main.d.ts", + "files": [ + "**/*.{js,mjs,cjs,map,d.ts,html,md,LEGAL.txt}", + "LICENSE", + "!**/*.test.js", + "!demo/**/*" + ], + "scripts": { + "b": "yarn run build", + "build": "yarn run build:ts && yarn run build:es", + "build:es": "nano-build --preset=module", + "build:ts": "tsc --build", + "c": "yarn run clean", + "cb": "yarn run clean && yarn run build", + "clean": "rm -rfv dist *.tsbuildinfo", + "d": "yarn run build:es && yarn node --enable-source-maps --trace-warnings", + "t": "yarn run test", + "test": "NODE_OPTIONS=\"$NODE_OPTIONS --enable-source-maps --experimental-vm-modules\" ava", + "w": "yarn run watch", + "watch": "yarn run watch:ts & yarn run watch:es", + "watch:es": "yarn run build:es --watch", + "watch:ts": "yarn run build:ts --watch --preserveWatchOutput" + }, + "dependencies": { + "@alwatr/local-storage": "^5.0.0", + "@alwatr/logger": "^5.0.0", + "@alwatr/package-tracer": "^5.0.0", + "@alwatr/parse-duration": "^5.0.0", + "@alwatr/type-helper": "^5.0.0", + "alpinejs": "^3.14.7" + }, + "devDependencies": { + "@alwatr/nano-build": "^5.0.0", + "@nexim/typescript-config": "workspace:^", + "@types/alpinejs": "^3", + "ava": "^6.2.0", + "typescript": "^5.6.3" + }, + "publishConfig": { + "access": "public" + } +} diff --git a/packages/store/src/main.ts b/packages/store/src/main.ts new file mode 100644 index 0000000..d0851aa --- /dev/null +++ b/packages/store/src/main.ts @@ -0,0 +1,3 @@ +export * from './store-modules/store-with-backup.js'; +export * from './store-modules/store.js'; +export * from './store-modules/base-store.js'; diff --git a/packages/store/src/store-modules/base-store.ts b/packages/store/src/store-modules/base-store.ts new file mode 100644 index 0000000..719621b --- /dev/null +++ b/packages/store/src/store-modules/base-store.ts @@ -0,0 +1,14 @@ +import alpine from 'alpinejs'; + +export class BaseStore { + store: T; + + constructor(config_: {name: string; defaultStore: T}) { + alpine.store(config_.name, config_.defaultStore); + + /** + * Must set the store to change proxy in class. + */ + this.store = alpine.store(config_.name) as T; + } +} diff --git a/packages/store/src/store-modules/store-with-backup.ts b/packages/store/src/store-modules/store-with-backup.ts new file mode 100644 index 0000000..4a8f59d --- /dev/null +++ b/packages/store/src/store-modules/store-with-backup.ts @@ -0,0 +1,135 @@ +import {localJsonStorage} from '@alwatr/local-storage'; +import {parseDuration, type Duration} from '@alwatr/parse-duration'; + +import {Store} from './store.js'; + +import type {EmptyObject} from '../type.js'; + +export type StoreWithBackupType = { + // eslint-disable-next-line @typescript-eslint/no-explicit-any + data: DictionaryReq | null; +}; + +export type StoreWithBackupConfig = { + name: string; + version: number; + defaultStore: T; + expireDuration?: Duration; +}; + +/** + * StoreWithBackup class extends the Store class to provide backup and restore functionality + * with local storage support and expiration handling. + */ +export class StoreWithBackup extends Store { + /** + * Keys for storing data and expireTime in local storage. + */ + private localStorageKey__ = { + data: `[store.v2]:${this.config__.name}`, + expireTime: `[store.v2]:${this.config__.name}-expire-time`, + }; + + /** + * Constructor to initialize the StoreWithBackup instance. + * @param config__ - Configuration object containing name, version, defaultStore, and optional expireDuration. + */ + constructor(private config__: StoreWithBackupConfig) { + super(config__); + + this.handleExpireDuration__(); + this.load__(); + } + + /** + * Saves the current data to local storage. If the data is null, it clears the stored data. + * Updates the expiration time. + */ + save(): void { + this.logger_.logMethodArgs?.('save', this.store.data); + if (this.store.data === null) { + this.clear(); + return; + } + + localJsonStorage.setItem(this.localStorageKey__.data, this.store.data, this.config__.version); + this.updateExpireTime__(); + } + + /** + * Clears the stored data, and expiration time from local storage. + */ + clear(): void { + this.logger_.logMethod?.('clear'); + + localJsonStorage.removeItem(this.localStorageKey__.data, this.config__.version); + localJsonStorage.removeItem(this.localStorageKey__.expireTime, this.config__.version); + } + + /** + * Resets the data to the default store configuration and clears the stored data. + */ + resetDataToDefault(): void { + this.logger_.logMethod?.('resetDataToDefault'); + this.store = this.config__.defaultStore; + this.clear(); + } + + /** + * Handles the expiration duration by checking if the stored data has expired. + * If expired, it clears the stored data. + */ + private handleExpireDuration__(): void { + if (this.config__.expireDuration == null) return; + this.logger_.logMethod?.('handleExpireDuration__'); + + const expireDuration = localJsonStorage.getItem<{time: number}>( + this.localStorageKey__.expireTime, + {time: 0}, + this.config__.version, + ).time; + + if (expireDuration < Date.now()) { + this.clear(); + } + } + + /** + * Updates the expiration time in local storage to the current time plus the configured expiration duration. + */ + private updateExpireTime__(): void { + if (this.config__.expireDuration == null) return; + this.logger_.logMethod?.('updateExpireTime__'); + + const newExpireTime = Date.now() + parseDuration(this.config__.expireDuration); + localJsonStorage.setItem(this.localStorageKey__.expireTime, {time: newExpireTime}, this.config__.version); + + this.logger_.logOther?.('updated_expire_time', {newExpireTime}); + } + + /** + * Loads data from local storage and updates the store's data. + * + * This method attempts to retrieve data from local storage using the specified key and version. + * If the retrieved data is empty, it checks the raw value in local storage. + * If the raw value is either an empty object or null, it logs that no data was found and returns. + * If an error occurs during parsing, it logs the error. + */ + private load__(): void { + this.logger_.logMethod?.('load__'); + + const newData = localJsonStorage.getItem(this.localStorageKey__.data, {}, this.config__.version); + if (Object.keys(newData).length === 0) { + const rawValue = localStorage.getItem(localJsonStorage.key_(this.localStorageKey__.data, this.config__.version)); + if (rawValue === '{}' || rawValue === null) { + this.logger_.logOther?.('no_data'); + return; + } + + this.logger_.error('load__', 'data_not_parsed', {localStorageKey: this.localStorageKey__}); + return; + } + + this.store.data = newData; + } +} diff --git a/packages/store/src/store-modules/store.ts b/packages/store/src/store-modules/store.ts new file mode 100644 index 0000000..1a8f1a0 --- /dev/null +++ b/packages/store/src/store-modules/store.ts @@ -0,0 +1,12 @@ +import {createLogger, type AlwatrLogger} from '@alwatr/logger'; + +import {BaseStore} from './base-store.js'; + +export class Store extends BaseStore { + protected logger_: AlwatrLogger; + + constructor(config_: {name: string; defaultStore: T}) { + super(config_); + this.logger_ = createLogger(`store.${config_.name}`); + } +} diff --git a/packages/store/src/type.ts b/packages/store/src/type.ts new file mode 100644 index 0000000..2a2111e --- /dev/null +++ b/packages/store/src/type.ts @@ -0,0 +1 @@ +export type EmptyObject = DictionaryReq; diff --git a/packages/store/tsconfig.json b/packages/store/tsconfig.json new file mode 100644 index 0000000..76415b4 --- /dev/null +++ b/packages/store/tsconfig.json @@ -0,0 +1,12 @@ +{ + "extends": "@nexim/typescript-config/tsconfig.json", + "compilerOptions": { + "rootDir": "src", + "outDir": "dist", + "emitDeclarationOnly": true, + "composite": true, + "types": ["@alwatr/type-helper"] + }, + "include": ["src/**/*.ts"], + "references": [] +} diff --git a/yarn.lock b/yarn.lock index ad7fa10..288f6bb 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5,6 +5,24 @@ __metadata: version: 8 cacheKey: 10c0 +"@alwatr/is-number@npm:^5.0.0": + version: 5.0.0 + resolution: "@alwatr/is-number@npm:5.0.0" + dependencies: + "@alwatr/package-tracer": "npm:^5.0.0" + checksum: 10c0/13d0115a14c4896a7e27741e2eb4f3acb95249b6835c66f010f094e2ffa61cbd7eb730fd7614401339090b1e1eb2866f00fecde2182d726facffe3bffca50852 + languageName: node + linkType: hard + +"@alwatr/local-storage@npm:^5.0.0": + version: 5.0.0 + resolution: "@alwatr/local-storage@npm:5.0.0" + dependencies: + "@alwatr/package-tracer": "npm:^5.0.0" + checksum: 10c0/af35d96be5305dfcd1c5f47c3dede94f6915f27a61e59845a6f92fdfc031d30198ae80361eb1e2f01721bf4a1bc96e76a9a06a80ebd8c346d37c186b13bf46f8 + languageName: node + linkType: hard + "@alwatr/logger@npm:^5.0.0": version: 5.0.0 resolution: "@alwatr/logger@npm:5.0.0" @@ -33,6 +51,16 @@ __metadata: languageName: node linkType: hard +"@alwatr/parse-duration@npm:^5.0.0": + version: 5.0.0 + resolution: "@alwatr/parse-duration@npm:5.0.0" + dependencies: + "@alwatr/is-number": "npm:^5.0.0" + "@alwatr/package-tracer": "npm:^5.0.0" + checksum: 10c0/c4fd3ba095d92d0faf413ac0a68e81b2b92c5a2ba373370d167df1d86319afe7eb360e230c59c29ac9965713f59be9469d0a29312197060673259524dd2cdb90 + languageName: node + linkType: hard + "@alwatr/platform-info@npm:^5.0.0": version: 5.0.0 resolution: "@alwatr/platform-info@npm:5.0.0" @@ -740,6 +768,24 @@ __metadata: languageName: unknown linkType: soft +"@nexim/store@workspace:packages/store": + version: 0.0.0-use.local + resolution: "@nexim/store@workspace:packages/store" + dependencies: + "@alwatr/local-storage": "npm:^5.0.0" + "@alwatr/logger": "npm:^5.0.0" + "@alwatr/nano-build": "npm:^5.0.0" + "@alwatr/package-tracer": "npm:^5.0.0" + "@alwatr/parse-duration": "npm:^5.0.0" + "@alwatr/type-helper": "npm:^5.0.0" + "@nexim/typescript-config": "workspace:^" + "@types/alpinejs": "npm:^3" + alpinejs: "npm:^3.14.7" + ava: "npm:^6.2.0" + typescript: "npm:^5.6.3" + languageName: unknown + linkType: soft + "@nexim/typescript-config@workspace:^, @nexim/typescript-config@workspace:packages/typescript-config": version: 0.0.0-use.local resolution: "@nexim/typescript-config@workspace:packages/typescript-config" @@ -1225,6 +1271,13 @@ __metadata: languageName: node linkType: hard +"@types/alpinejs@npm:^3": + version: 3.13.11 + resolution: "@types/alpinejs@npm:3.13.11" + checksum: 10c0/181dcff0af59211043e4121f68548bc2efabe74f71ac397bc20aac7a497f76344e8f327745e621ec5db5b4991d12834b88840ad87e7a28c4a1554930b9e32ad6 + languageName: node + linkType: hard + "@types/estree@npm:^1.0.0": version: 1.0.6 resolution: "@types/estree@npm:1.0.6" @@ -1416,6 +1469,22 @@ __metadata: languageName: node linkType: hard +"@vue/reactivity@npm:~3.1.1": + version: 3.1.5 + resolution: "@vue/reactivity@npm:3.1.5" + dependencies: + "@vue/shared": "npm:3.1.5" + checksum: 10c0/1c38aeb73725b3825bea793194334b232388236f0b06b04471508a77cb55d71841e3eb2f345ab6812c76569918aa8f019e4cdf59ec9cefbab7625bb2bc26eb58 + languageName: node + linkType: hard + +"@vue/shared@npm:3.1.5": + version: 3.1.5 + resolution: "@vue/shared@npm:3.1.5" + checksum: 10c0/197aa5bdd370177d26ca7a178bb3d3d2332cee2c8e67000bd2bb91b1ffc571d5489fab3a65f38a32e941dc8182d1cd6c6af6e294bb9ea13e01eafdde475319ea + languageName: node + linkType: hard + "JSONStream@npm:^1.3.5": version: 1.3.5 resolution: "JSONStream@npm:1.3.5" @@ -1525,6 +1594,15 @@ __metadata: languageName: node linkType: hard +"alpinejs@npm:^3.14.7": + version: 3.14.7 + resolution: "alpinejs@npm:3.14.7" + dependencies: + "@vue/reactivity": "npm:~3.1.1" + checksum: 10c0/658e0627280aa8908e40951edc0e20a98889723677b0dea242f7d7af028c7079c6f79e9709fc9c7d59485a49b6abade2dacaeca535f6e7ce623d720c19245836 + languageName: node + linkType: hard + "ansi-escapes@npm:^4.3.2": version: 4.3.2 resolution: "ansi-escapes@npm:4.3.2" From 04a905727ad911edb5346d279ad1c7a57d73963b Mon Sep 17 00:00:00 2001 From: arashagp Date: Sun, 8 Dec 2024 10:12:39 +0330 Subject: [PATCH 02/18] refactor(store): integrate package tracer and enhance logging in StoreWithBackup --- packages/store/src/main.ts | 4 ++++ .../src/store-modules/store-with-backup.ts | 21 +++++++++++-------- yarn.lock | 2 +- 3 files changed, 17 insertions(+), 10 deletions(-) diff --git a/packages/store/src/main.ts b/packages/store/src/main.ts index d0851aa..0d5d4d6 100644 --- a/packages/store/src/main.ts +++ b/packages/store/src/main.ts @@ -1,3 +1,7 @@ +import { packageTracer } from '@alwatr/package-tracer'; + +__dev_mode__: packageTracer.add(__package_name__, __package_version__); + export * from './store-modules/store-with-backup.js'; export * from './store-modules/store.js'; export * from './store-modules/base-store.js'; diff --git a/packages/store/src/store-modules/store-with-backup.ts b/packages/store/src/store-modules/store-with-backup.ts index 4a8f59d..45456c1 100644 --- a/packages/store/src/store-modules/store-with-backup.ts +++ b/packages/store/src/store-modules/store-with-backup.ts @@ -17,6 +17,8 @@ export type StoreWithBackupConfig = { expireDuration?: Duration; }; +const localStorageKey = '[nexim.store.v1]' + /** * StoreWithBackup class extends the Store class to provide backup and restore functionality * with local storage support and expiration handling. @@ -26,8 +28,8 @@ export class StoreWithBackup extends Store { * Keys for storing data and expireTime in local storage. */ private localStorageKey__ = { - data: `[store.v2]:${this.config__.name}`, - expireTime: `[store.v2]:${this.config__.name}-expire-time`, + data: `${localStorageKey}:${this.config__.name}`, + expireTime: `${localStorageKey}:${this.config__.name}-expire-time`, }; /** @@ -46,7 +48,8 @@ export class StoreWithBackup extends Store { * Updates the expiration time. */ save(): void { - this.logger_.logMethodArgs?.('save', this.store.data); + this.logger_.logMethodArgs?.(`${__package_name__}.save`, this.store.data); + if (this.store.data === null) { this.clear(); return; @@ -60,7 +63,7 @@ export class StoreWithBackup extends Store { * Clears the stored data, and expiration time from local storage. */ clear(): void { - this.logger_.logMethod?.('clear'); + this.logger_.logMethod?.(`${__package_name__}.clear`); localJsonStorage.removeItem(this.localStorageKey__.data, this.config__.version); localJsonStorage.removeItem(this.localStorageKey__.expireTime, this.config__.version); @@ -70,7 +73,7 @@ export class StoreWithBackup extends Store { * Resets the data to the default store configuration and clears the stored data. */ resetDataToDefault(): void { - this.logger_.logMethod?.('resetDataToDefault'); + this.logger_.logMethod?.(`${__package_name__}.resetDataToDefault`); this.store = this.config__.defaultStore; this.clear(); } @@ -81,7 +84,7 @@ export class StoreWithBackup extends Store { */ private handleExpireDuration__(): void { if (this.config__.expireDuration == null) return; - this.logger_.logMethod?.('handleExpireDuration__'); + this.logger_.logMethod?.(`${__package_name__}.handleExpireDuration__`); const expireDuration = localJsonStorage.getItem<{time: number}>( this.localStorageKey__.expireTime, @@ -99,12 +102,12 @@ export class StoreWithBackup extends Store { */ private updateExpireTime__(): void { if (this.config__.expireDuration == null) return; - this.logger_.logMethod?.('updateExpireTime__'); + this.logger_.logMethod?.(`${__package_name__}.updateExpireTime__`); const newExpireTime = Date.now() + parseDuration(this.config__.expireDuration); localJsonStorage.setItem(this.localStorageKey__.expireTime, {time: newExpireTime}, this.config__.version); - this.logger_.logOther?.('updated_expire_time', {newExpireTime}); + this.logger_.logOther?.(`${__package_name__}.updated_expire_time`, {newExpireTime}); } /** @@ -126,7 +129,7 @@ export class StoreWithBackup extends Store { return; } - this.logger_.error('load__', 'data_not_parsed', {localStorageKey: this.localStorageKey__}); + this.logger_.error(`${__package_name__}.load__`, 'data_not_parsed', {localStorageKey: this.localStorageKey__}); return; } diff --git a/yarn.lock b/yarn.lock index 288f6bb..b4d8cae 100644 --- a/yarn.lock +++ b/yarn.lock @@ -40,7 +40,7 @@ __metadata: esbuild: "npm:^0.24.0" bin: nano-build: ./nano-build.cjs - checksum: 10c0/fccfbcb55559571b158e79553cbbd9c44c06492aab91c47071e467b2ea0d40a87142d49acb938af60a708c5ad56b6f6854df6220ec1c088af5cf6fbd7ab0255c + checksum: 10c0/58f4d1b24d628712943f26e8688392dc7d74cd4eda86205284481ea22d681758715c254d416091dde8d52b86f743c8b6cdec3741c8b6fc6e1627c476b73d8094 languageName: node linkType: hard From 4e9a640d58508ce0af16f29492f35ec08fa0165f Mon Sep 17 00:00:00 2001 From: arashagp Date: Sun, 8 Dec 2024 10:43:48 +0330 Subject: [PATCH 03/18] chore(store): update README --- packages/store/README.md | 71 +++++++++++++++++++++------------------- 1 file changed, 37 insertions(+), 34 deletions(-) diff --git a/packages/store/README.md b/packages/store/README.md index b3a6845..f25f788 100644 --- a/packages/store/README.md +++ b/packages/store/README.md @@ -1,60 +1,63 @@ -# @nexim/element +# @nexim/store -![NPM Version](https://img.shields.io/npm/v/%40nexim%2Felement) -![npm bundle size](https://img.shields.io/bundlephobia/min/%40nexim%2Felement) +![NPM Version](https://img.shields.io/npm/v/%40nexim%2Fstore) +![npm bundle size](https://img.shields.io/bundlephobia/min/%40nexim%2Fstore) ![Build & Lint & Test](https://github.com/the-nexim/nanolib/actions/workflows/build-lint-test.yaml/badge.svg) -![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Felement) -![NPM License](https://img.shields.io/npm/l/%40nexim%2Felement) +![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Fstore) +![NPM License](https://img.shields.io/npm/l/%40nexim%2Fstore) ## Overview -`@nexim/element` is a collection of utility functions and mixins for building high-performance, maintainable web components using Lit. +`@nexim/store` is a collection of utility functions and mixins for building high-performance, maintainable web components using Lit. ## Installation ```sh -npm install @nexim/element +npm install @nexim/store # Or using yarn -yarn add @nexim/element +yarn add @nexim/store ``` ## API -### LoggerMixin +### Store -The LoggerMixin adds logging capabilities to your LitElement components. It logs lifecycle methods and measures update times. +The `Store` class provides a base store implementation with logging capabilities. ```ts -import {LitElement, html} from 'lit'; -import {LoggerMixin} from '@nexim/element'; +import { Store } from '@nexim/store'; -class MyElement extends LoggerMixin(LitElement) { - protected override render() { - super.render(); // must call super method to logger work +const store = new Store({ + name: 'myStore', + defaultStore: { key: 'value' } +}); +``` + +### StoreWithBackup + +The `StoreWithBackup` class extends `Store` to add backup and restore functionality with local storage support and expiration handling. - return html`

Hello, world!

`; - } -} +```ts +import { StoreWithBackup } from '@nexim/store'; + +const storeWithBackup = new StoreWithBackup({ + name: 'myStoreWithBackup', + version: 1, + defaultStore: { data: null }, + expireDuration: '1d' +}); ``` -### LightDomMixin +### BaseStore -The LightDomMixin enables light DOM rendering and style encapsulation for LitElement components. +The `BaseStore` class is a base class for creating stores with Alpine.js state management. ```ts -import {LitElement, html, css} from 'lit'; -import {LightDomMixin} from '@nexim/element'; - -class MyLightDomElement extends LightDomMixin(LitElement) { - static styles = css` - p { - color: blue; - } - `; - - protected override render() { - return html`

Hello, light DOM!

`; - } -} +import { BaseStore } from '@nexim/store'; + +const baseStore = new BaseStore({ + name: 'myBaseStore', + defaultStore: { key: 'value' } +}); ``` From 49031ddb652eb7f063104f587071bad3371431cc Mon Sep 17 00:00:00 2001 From: arashagp Date: Sun, 8 Dec 2024 10:56:03 +0330 Subject: [PATCH 04/18] chore(store): update package.json --- packages/store/package.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/store/package.json b/packages/store/package.json index 65ed9ae..bbb4df6 100644 --- a/packages/store/package.json +++ b/packages/store/package.json @@ -1,7 +1,7 @@ { "name": "@nexim/store", "version": "1.0.0", - "description": "Utility functions and mixins for building high-performance web components with Lit.", + "description": "A state management library using Alpine Store, and integrated with our custom logger and FSM for client-side logic.", "keywords": [ "lit", "web-components", @@ -11,14 +11,14 @@ "typescript", "nexim" ], - "homepage": "https://github.com/the-nexim/nanolib/tree/next/packages/element#readme", + "homepage": "https://github.com/the-nexim/nanolib/tree/next/packages/store#readme", "bugs": { "url": "https://github.com/the-nexim/nanolib/issues" }, "repository": { "type": "git", "url": "https://github.com/the-nexim/nanolib", - "directory": "packages/element" + "directory": "packages/store" }, "license": "AGPL-3.0-only", "author": "S. Amir Mohammad Najafi (www.njfamirm.ir)", From dbf7f59d1b52e7210cd388e2a1ca826c1421a9e2 Mon Sep 17 00:00:00 2001 From: arashagp Date: Sun, 8 Dec 2024 10:57:24 +0330 Subject: [PATCH 05/18] chore(store): update `tsconfig.json` --- packages/store/tsconfig.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/store/tsconfig.json b/packages/store/tsconfig.json index 76415b4..0522cb6 100644 --- a/packages/store/tsconfig.json +++ b/packages/store/tsconfig.json @@ -5,7 +5,7 @@ "outDir": "dist", "emitDeclarationOnly": true, "composite": true, - "types": ["@alwatr/type-helper"] + "types": ["@alwatr/nano-build","@alwatr/type-helper"] }, "include": ["src/**/*.ts"], "references": [] From 709b0ab15e920694dd14c19f9c670c6cef6648a6 Mon Sep 17 00:00:00 2001 From: arashagp Date: Sun, 8 Dec 2024 11:00:16 +0330 Subject: [PATCH 06/18] chore(store): update keywords `package.json` --- packages/store/package.json | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/packages/store/package.json b/packages/store/package.json index bbb4df6..ca24264 100644 --- a/packages/store/package.json +++ b/packages/store/package.json @@ -3,11 +3,13 @@ "version": "1.0.0", "description": "A state management library using Alpine Store, and integrated with our custom logger and FSM for client-side logic.", "keywords": [ - "lit", - "web-components", - "mixins", + "alpinejs", + "store", "logger", - "light-dom", + "fsm", + "state management", + "client-side", + "logic", "typescript", "nexim" ], From 82d8aa5f5de84da59c1804cb40ce5852dcff6cb9 Mon Sep 17 00:00:00 2001 From: arashagp Date: Sun, 8 Dec 2024 11:37:35 +0330 Subject: [PATCH 07/18] chore(store): add test file --- packages/store/src/main.test.js | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 packages/store/src/main.test.js diff --git a/packages/store/src/main.test.js b/packages/store/src/main.test.js new file mode 100644 index 0000000..e839043 --- /dev/null +++ b/packages/store/src/main.test.js @@ -0,0 +1,6 @@ +import test from 'ava'; + +// empty test +test('empty test', (test) => { + test.pass(); +}); From 61dfffc540991c7a352a703b6a99bf8abf86c958 Mon Sep 17 00:00:00 2001 From: arashagp Date: Sun, 8 Dec 2024 11:40:46 +0330 Subject: [PATCH 08/18] lint: Make Happy :) --- packages/store/README.md | 14 +++++++------- packages/store/src/main.ts | 2 +- .../store/src/store-modules/store-with-backup.ts | 2 +- packages/store/tsconfig.json | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/packages/store/README.md b/packages/store/README.md index f25f788..aa04a1d 100644 --- a/packages/store/README.md +++ b/packages/store/README.md @@ -26,11 +26,11 @@ yarn add @nexim/store The `Store` class provides a base store implementation with logging capabilities. ```ts -import { Store } from '@nexim/store'; +import {Store} from '@nexim/store'; const store = new Store({ name: 'myStore', - defaultStore: { key: 'value' } + defaultStore: {key: 'value'}, }); ``` @@ -39,13 +39,13 @@ const store = new Store({ The `StoreWithBackup` class extends `Store` to add backup and restore functionality with local storage support and expiration handling. ```ts -import { StoreWithBackup } from '@nexim/store'; +import {StoreWithBackup} from '@nexim/store'; const storeWithBackup = new StoreWithBackup({ name: 'myStoreWithBackup', version: 1, - defaultStore: { data: null }, - expireDuration: '1d' + defaultStore: {data: null}, + expireDuration: '1d', }); ``` @@ -54,10 +54,10 @@ const storeWithBackup = new StoreWithBackup({ The `BaseStore` class is a base class for creating stores with Alpine.js state management. ```ts -import { BaseStore } from '@nexim/store'; +import {BaseStore} from '@nexim/store'; const baseStore = new BaseStore({ name: 'myBaseStore', - defaultStore: { key: 'value' } + defaultStore: {key: 'value'}, }); ``` diff --git a/packages/store/src/main.ts b/packages/store/src/main.ts index 0d5d4d6..d642d2d 100644 --- a/packages/store/src/main.ts +++ b/packages/store/src/main.ts @@ -1,4 +1,4 @@ -import { packageTracer } from '@alwatr/package-tracer'; +import {packageTracer} from '@alwatr/package-tracer'; __dev_mode__: packageTracer.add(__package_name__, __package_version__); diff --git a/packages/store/src/store-modules/store-with-backup.ts b/packages/store/src/store-modules/store-with-backup.ts index 45456c1..dc0f126 100644 --- a/packages/store/src/store-modules/store-with-backup.ts +++ b/packages/store/src/store-modules/store-with-backup.ts @@ -17,7 +17,7 @@ export type StoreWithBackupConfig = { expireDuration?: Duration; }; -const localStorageKey = '[nexim.store.v1]' +const localStorageKey = '[nexim.store.v1]'; /** * StoreWithBackup class extends the Store class to provide backup and restore functionality diff --git a/packages/store/tsconfig.json b/packages/store/tsconfig.json index 0522cb6..b23f79c 100644 --- a/packages/store/tsconfig.json +++ b/packages/store/tsconfig.json @@ -5,7 +5,7 @@ "outDir": "dist", "emitDeclarationOnly": true, "composite": true, - "types": ["@alwatr/nano-build","@alwatr/type-helper"] + "types": ["@alwatr/nano-build", "@alwatr/type-helper"] }, "include": ["src/**/*.ts"], "references": [] From c02c411f49b96fb4f86420542a67c7f222dbb3b3 Mon Sep 17 00:00:00 2001 From: "S. Amir Mohammad Najafi" Date: Tue, 10 Dec 2024 07:57:17 +0330 Subject: [PATCH 09/18] chore(yarn): comment out checksumBehavior setting --- .yarnrc.yml | 2 +- yarn.lock | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.yarnrc.yml b/.yarnrc.yml index 9431c9a..dfe2f9c 100644 --- a/.yarnrc.yml +++ b/.yarnrc.yml @@ -1,4 +1,4 @@ -checksumBehavior: update +# checksumBehavior: update enableTelemetry: false diff --git a/yarn.lock b/yarn.lock index b4d8cae..288f6bb 100644 --- a/yarn.lock +++ b/yarn.lock @@ -40,7 +40,7 @@ __metadata: esbuild: "npm:^0.24.0" bin: nano-build: ./nano-build.cjs - checksum: 10c0/58f4d1b24d628712943f26e8688392dc7d74cd4eda86205284481ea22d681758715c254d416091dde8d52b86f743c8b6cdec3741c8b6fc6e1627c476b73d8094 + checksum: 10c0/fccfbcb55559571b158e79553cbbd9c44c06492aab91c47071e467b2ea0d40a87142d49acb938af60a708c5ad56b6f6854df6220ec1c088af5cf6fbd7ab0255c languageName: node linkType: hard From 58c127eeb486c15c7a480a5d315bbe0a379e25e6 Mon Sep 17 00:00:00 2001 From: "S. Amir Mohammad Najafi" Date: Tue, 10 Dec 2024 08:20:28 +0330 Subject: [PATCH 10/18] chore: rename package --- packages/{store => alpine}/LICENSE | 0 packages/{store => alpine}/README.md | 18 ++++----- packages/{store => alpine}/package.json | 20 ++++------ packages/{store => alpine}/src/main.test.js | 0 packages/alpine/src/main.ts | 7 ++++ .../src/store}/base-store.ts | 2 +- .../src/store}/store-with-backup.ts | 10 ++--- packages/alpine/src/store/store.ts | 13 +++++++ packages/{store => alpine}/src/type.ts | 0 packages/{store => alpine}/tsconfig.json | 0 packages/store/src/main.ts | 7 ---- packages/store/src/store-modules/store.ts | 12 ------ tsconfig.json | 16 +++++++- yarn.lock | 38 +++++++++---------- 14 files changed, 76 insertions(+), 67 deletions(-) rename packages/{store => alpine}/LICENSE (100%) rename packages/{store => alpine}/README.md (70%) rename packages/{store => alpine}/package.json (90%) rename packages/{store => alpine}/src/main.test.js (100%) create mode 100644 packages/alpine/src/main.ts rename packages/{store/src/store-modules => alpine/src/store}/base-store.ts (83%) rename packages/{store/src/store-modules => alpine/src/store}/store-with-backup.ts (92%) create mode 100644 packages/alpine/src/store/store.ts rename packages/{store => alpine}/src/type.ts (100%) rename packages/{store => alpine}/tsconfig.json (100%) delete mode 100644 packages/store/src/main.ts delete mode 100644 packages/store/src/store-modules/store.ts diff --git a/packages/store/LICENSE b/packages/alpine/LICENSE similarity index 100% rename from packages/store/LICENSE rename to packages/alpine/LICENSE diff --git a/packages/store/README.md b/packages/alpine/README.md similarity index 70% rename from packages/store/README.md rename to packages/alpine/README.md index aa04a1d..7547397 100644 --- a/packages/store/README.md +++ b/packages/alpine/README.md @@ -1,27 +1,27 @@ -# @nexim/store +# @nexim/alpine -![NPM Version](https://img.shields.io/npm/v/%40nexim%2Fstore) -![npm bundle size](https://img.shields.io/bundlephobia/min/%40nexim%2Fstore) +![NPM Version](https://img.shields.io/npm/v/%40nexim%2Falpine-context) +![npm bundle size](https://img.shields.io/bundlephobia/min/%40nexim%2Falpine-context) ![Build & Lint & Test](https://github.com/the-nexim/nanolib/actions/workflows/build-lint-test.yaml/badge.svg) -![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Fstore) -![NPM License](https://img.shields.io/npm/l/%40nexim%2Fstore) +![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Falpine-context) +![NPM License](https://img.shields.io/npm/l/%40nexim%2Falpine-context) ## Overview -`@nexim/store` is a collection of utility functions and mixins for building high-performance, maintainable web components using Lit. +An collection of utility functions and mixins for building high-performance, maintainable web components using Lit. ## Installation ```sh -npm install @nexim/store +npm install @nexim/alpine # Or using yarn -yarn add @nexim/store +yarn add @nexim/alpine ``` ## API -### Store +### Alpine-context The `Store` class provides a base store implementation with logging capabilities. diff --git a/packages/store/package.json b/packages/alpine/package.json similarity index 90% rename from packages/store/package.json rename to packages/alpine/package.json index ca24264..917cd52 100644 --- a/packages/store/package.json +++ b/packages/alpine/package.json @@ -1,26 +1,22 @@ { - "name": "@nexim/store", - "version": "1.0.0", + "name": "@nexim/alpine", + "version": "0.0.0", "description": "A state management library using Alpine Store, and integrated with our custom logger and FSM for client-side logic.", "keywords": [ "alpinejs", - "store", - "logger", - "fsm", - "state management", - "client-side", - "logic", + "alpine", + "context", "typescript", "nexim" ], - "homepage": "https://github.com/the-nexim/nanolib/tree/next/packages/store#readme", + "homepage": "https://github.com/the-nexim/nanolib/tree/next/packages/alpine-context#readme", "bugs": { "url": "https://github.com/the-nexim/nanolib/issues" }, "repository": { "type": "git", "url": "https://github.com/the-nexim/nanolib", - "directory": "packages/store" + "directory": "packages/alpine-context" }, "license": "AGPL-3.0-only", "author": "S. Amir Mohammad Najafi (www.njfamirm.ir)", @@ -65,13 +61,13 @@ "@alwatr/logger": "^5.0.0", "@alwatr/package-tracer": "^5.0.0", "@alwatr/parse-duration": "^5.0.0", - "@alwatr/type-helper": "^5.0.0", "alpinejs": "^3.14.7" }, "devDependencies": { "@alwatr/nano-build": "^5.0.0", + "@alwatr/type-helper": "^5.0.0", "@nexim/typescript-config": "workspace:^", - "@types/alpinejs": "^3", + "@types/alpinejs": "^3.13.11", "ava": "^6.2.0", "typescript": "^5.6.3" }, diff --git a/packages/store/src/main.test.js b/packages/alpine/src/main.test.js similarity index 100% rename from packages/store/src/main.test.js rename to packages/alpine/src/main.test.js diff --git a/packages/alpine/src/main.ts b/packages/alpine/src/main.ts new file mode 100644 index 0000000..b1cda3d --- /dev/null +++ b/packages/alpine/src/main.ts @@ -0,0 +1,7 @@ +import {packageTracer} from '@alwatr/package-tracer'; + +__dev_mode__: packageTracer.add(__package_name__, __package_version__); + +export * from './store/base-store.js'; +export * from './store/store.js'; +export * from './store/store-with-backup.js'; diff --git a/packages/store/src/store-modules/base-store.ts b/packages/alpine/src/store/base-store.ts similarity index 83% rename from packages/store/src/store-modules/base-store.ts rename to packages/alpine/src/store/base-store.ts index 719621b..c05449c 100644 --- a/packages/store/src/store-modules/base-store.ts +++ b/packages/alpine/src/store/base-store.ts @@ -1,6 +1,6 @@ import alpine from 'alpinejs'; -export class BaseStore { +export class AlpineBaseStore { store: T; constructor(config_: {name: string; defaultStore: T}) { diff --git a/packages/store/src/store-modules/store-with-backup.ts b/packages/alpine/src/store/store-with-backup.ts similarity index 92% rename from packages/store/src/store-modules/store-with-backup.ts rename to packages/alpine/src/store/store-with-backup.ts index dc0f126..812efa4 100644 --- a/packages/store/src/store-modules/store-with-backup.ts +++ b/packages/alpine/src/store/store-with-backup.ts @@ -1,16 +1,16 @@ import {localJsonStorage} from '@alwatr/local-storage'; import {parseDuration, type Duration} from '@alwatr/parse-duration'; -import {Store} from './store.js'; +import {AlpineStore} from './store.js'; import type {EmptyObject} from '../type.js'; -export type StoreWithBackupType = { +export type AlpineStoreWithBackupType = { // eslint-disable-next-line @typescript-eslint/no-explicit-any data: DictionaryReq | null; }; -export type StoreWithBackupConfig = { +export type AlpineStoreWithBackupConfig = { name: string; version: number; defaultStore: T; @@ -23,7 +23,7 @@ const localStorageKey = '[nexim.store.v1]'; * StoreWithBackup class extends the Store class to provide backup and restore functionality * with local storage support and expiration handling. */ -export class StoreWithBackup extends Store { +export class AlpineStoreWithBackup extends AlpineStore { /** * Keys for storing data and expireTime in local storage. */ @@ -36,7 +36,7 @@ export class StoreWithBackup extends Store { * Constructor to initialize the StoreWithBackup instance. * @param config__ - Configuration object containing name, version, defaultStore, and optional expireDuration. */ - constructor(private config__: StoreWithBackupConfig) { + constructor(private config__: AlpineStoreWithBackupConfig) { super(config__); this.handleExpireDuration__(); diff --git a/packages/alpine/src/store/store.ts b/packages/alpine/src/store/store.ts new file mode 100644 index 0000000..74f13e4 --- /dev/null +++ b/packages/alpine/src/store/store.ts @@ -0,0 +1,13 @@ +import {createLogger, type AlwatrLogger} from '@alwatr/logger'; + +import {AlpineBaseStore} from './base-store.js'; + +export class AlpineStore extends AlpineBaseStore { + protected logger_: AlwatrLogger; + + constructor(config_: {name: string; defaultStore: T}) { + super(config_); // pass name and default store to set in the alpine store + + this.logger_ = createLogger(`[${__package_name__}:${config_.name}]`); + } +} diff --git a/packages/store/src/type.ts b/packages/alpine/src/type.ts similarity index 100% rename from packages/store/src/type.ts rename to packages/alpine/src/type.ts diff --git a/packages/store/tsconfig.json b/packages/alpine/tsconfig.json similarity index 100% rename from packages/store/tsconfig.json rename to packages/alpine/tsconfig.json diff --git a/packages/store/src/main.ts b/packages/store/src/main.ts deleted file mode 100644 index d642d2d..0000000 --- a/packages/store/src/main.ts +++ /dev/null @@ -1,7 +0,0 @@ -import {packageTracer} from '@alwatr/package-tracer'; - -__dev_mode__: packageTracer.add(__package_name__, __package_version__); - -export * from './store-modules/store-with-backup.js'; -export * from './store-modules/store.js'; -export * from './store-modules/base-store.js'; diff --git a/packages/store/src/store-modules/store.ts b/packages/store/src/store-modules/store.ts deleted file mode 100644 index 1a8f1a0..0000000 --- a/packages/store/src/store-modules/store.ts +++ /dev/null @@ -1,12 +0,0 @@ -import {createLogger, type AlwatrLogger} from '@alwatr/logger'; - -import {BaseStore} from './base-store.js'; - -export class Store extends BaseStore { - protected logger_: AlwatrLogger; - - constructor(config_: {name: string; defaultStore: T}) { - super(config_); - this.logger_ = createLogger(`store.${config_.name}`); - } -} diff --git a/tsconfig.json b/tsconfig.json index 5f01420..9db64f6 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -2,9 +2,21 @@ "extends": "@nexim/typescript-config/tsconfig.json", "compilerOptions": { "noEmit": true, - "types": ["node"] + "types": [ + "node" + ] }, "files": [], "exclude": [], - "references": [{"path": "./packages/element"}, {"path": "./packages/typescript-config"}] + "references": [ + { + "path": "./packages/element" + }, + { + "path": "./packages/typescript-config" + }, + { + "path": "./packages/alpine" + } + ] } diff --git a/yarn.lock b/yarn.lock index 288f6bb..f9dfbb6 100644 --- a/yarn.lock +++ b/yarn.lock @@ -722,6 +722,24 @@ __metadata: languageName: node linkType: hard +"@nexim/alpine@workspace:packages/alpine": + version: 0.0.0-use.local + resolution: "@nexim/alpine@workspace:packages/alpine" + dependencies: + "@alwatr/local-storage": "npm:^5.0.0" + "@alwatr/logger": "npm:^5.0.0" + "@alwatr/nano-build": "npm:^5.0.0" + "@alwatr/package-tracer": "npm:^5.0.0" + "@alwatr/parse-duration": "npm:^5.0.0" + "@alwatr/type-helper": "npm:^5.0.0" + "@nexim/typescript-config": "workspace:^" + "@types/alpinejs": "npm:^3.13.11" + alpinejs: "npm:^3.14.7" + ava: "npm:^6.2.0" + typescript: "npm:^5.6.3" + languageName: unknown + linkType: soft + "@nexim/element@workspace:packages/element": version: 0.0.0-use.local resolution: "@nexim/element@workspace:packages/element" @@ -768,24 +786,6 @@ __metadata: languageName: unknown linkType: soft -"@nexim/store@workspace:packages/store": - version: 0.0.0-use.local - resolution: "@nexim/store@workspace:packages/store" - dependencies: - "@alwatr/local-storage": "npm:^5.0.0" - "@alwatr/logger": "npm:^5.0.0" - "@alwatr/nano-build": "npm:^5.0.0" - "@alwatr/package-tracer": "npm:^5.0.0" - "@alwatr/parse-duration": "npm:^5.0.0" - "@alwatr/type-helper": "npm:^5.0.0" - "@nexim/typescript-config": "workspace:^" - "@types/alpinejs": "npm:^3" - alpinejs: "npm:^3.14.7" - ava: "npm:^6.2.0" - typescript: "npm:^5.6.3" - languageName: unknown - linkType: soft - "@nexim/typescript-config@workspace:^, @nexim/typescript-config@workspace:packages/typescript-config": version: 0.0.0-use.local resolution: "@nexim/typescript-config@workspace:packages/typescript-config" @@ -1271,7 +1271,7 @@ __metadata: languageName: node linkType: hard -"@types/alpinejs@npm:^3": +"@types/alpinejs@npm:^3.13.11": version: 3.13.11 resolution: "@types/alpinejs@npm:3.13.11" checksum: 10c0/181dcff0af59211043e4121f68548bc2efabe74f71ac397bc20aac7a497f76344e8f327745e621ec5db5b4991d12834b88840ad87e7a28c4a1554930b9e32ad6 From 8a7129edbef39c080acedae7ef75a9be16b05a03 Mon Sep 17 00:00:00 2001 From: "S. Amir Mohammad Najafi" Date: Tue, 10 Dec 2024 10:54:53 +0330 Subject: [PATCH 11/18] refactor(alpine): review and enhance Co-authored-by: arashagp --- packages/alpine/src/main.ts | 2 +- packages/alpine/src/store/base-store.ts | 14 --- packages/alpine/src/store/store-generator.ts | 50 ++++++++++ .../alpine/src/store/store-with-backup.ts | 93 ++++++++++--------- packages/alpine/src/store/store.ts | 49 ++++++++-- tsconfig.json | 4 +- 6 files changed, 146 insertions(+), 66 deletions(-) delete mode 100644 packages/alpine/src/store/base-store.ts create mode 100644 packages/alpine/src/store/store-generator.ts diff --git a/packages/alpine/src/main.ts b/packages/alpine/src/main.ts index b1cda3d..66efdae 100644 --- a/packages/alpine/src/main.ts +++ b/packages/alpine/src/main.ts @@ -2,6 +2,6 @@ import {packageTracer} from '@alwatr/package-tracer'; __dev_mode__: packageTracer.add(__package_name__, __package_version__); -export * from './store/base-store.js'; +export * from './store/store-generator.js'; export * from './store/store.js'; export * from './store/store-with-backup.js'; diff --git a/packages/alpine/src/store/base-store.ts b/packages/alpine/src/store/base-store.ts deleted file mode 100644 index c05449c..0000000 --- a/packages/alpine/src/store/base-store.ts +++ /dev/null @@ -1,14 +0,0 @@ -import alpine from 'alpinejs'; - -export class AlpineBaseStore { - store: T; - - constructor(config_: {name: string; defaultStore: T}) { - alpine.store(config_.name, config_.defaultStore); - - /** - * Must set the store to change proxy in class. - */ - this.store = alpine.store(config_.name) as T; - } -} diff --git a/packages/alpine/src/store/store-generator.ts b/packages/alpine/src/store/store-generator.ts new file mode 100644 index 0000000..ee4ee23 --- /dev/null +++ b/packages/alpine/src/store/store-generator.ts @@ -0,0 +1,50 @@ +import {createLogger} from '@alwatr/logger'; +import alpine from 'alpinejs'; + +const logger = createLogger(__package_name__); + +/** + * Options for creating an Alpine store. + * + * @template T - The type of the default value. + * @property {string} name - The name of the store. + * @property {T} defaultValue - The default value of the store. + */ +export type AlpineStoreGeneratorOptions = { + name: string; + defaultValue: T; +}; + +/** + * Generates an Alpine.js store with default value. + * + * @template T - The type of the data. + * @param {AlpineStoreGeneratorOptions} config - The configuration object for the store. + * @returns {T} - The initialized store instance. + * + * @see https://alpinejs.dev/globals/alpine-store + * + * @example + * // Create a store with a default state + * const store = alpineStoreGenerator({ + * name: 'user', + * defaultValue: {type: 'root'}, + * }); + * + * console.log(store.type); // Output: value + * + * @description + * This function uses Alpine.js to create a reactive store with a default value. + * The store is identified by a unique name and can be accessed and manipulated + * throughout the application. Alpine.js stores provide a simple way to manage + * state in your application, making it easy to keep your UI in sync with your data. + */ +export function alpineStoreGenerator(config: AlpineStoreGeneratorOptions): T { + logger.logMethodArgs?.('alpineStoreGenerator', config); + + alpine.store(config.name, config.defaultValue); + + // Get store Proxy + const store = alpine.store(config.name) as T; + return store; +} diff --git a/packages/alpine/src/store/store-with-backup.ts b/packages/alpine/src/store/store-with-backup.ts index 812efa4..6f225c0 100644 --- a/packages/alpine/src/store/store-with-backup.ts +++ b/packages/alpine/src/store/store-with-backup.ts @@ -5,41 +5,44 @@ import {AlpineStore} from './store.js'; import type {EmptyObject} from '../type.js'; -export type AlpineStoreWithBackupType = { - // eslint-disable-next-line @typescript-eslint/no-explicit-any - data: DictionaryReq | null; +export type AlpineStoreWithBackupType = { + data: T | null; }; -export type AlpineStoreWithBackupConfig = { +export type AlpineStoreWithBackupConfig, TData extends DictionaryReq> = { name: string; version: number; - defaultStore: T; + defaultValue: TBase; expireDuration?: Duration; }; -const localStorageKey = '[nexim.store.v1]'; +/** + * Schema version `sv` that's change just when the schema changes. + */ +const schemaVersion = 1; /** * StoreWithBackup class extends the Store class to provide backup and restore functionality * with local storage support and expiration handling. */ -export class AlpineStoreWithBackup extends AlpineStore { +export class AlpineStoreWithBackup, TData extends DictionaryReq> extends AlpineStore { /** * Keys for storing data and expireTime in local storage. */ private localStorageKey__ = { - data: `${localStorageKey}:${this.config__.name}`, - expireTime: `${localStorageKey}:${this.config__.name}-expire-time`, + data: `[@nexim/alpine:data:sv${schemaVersion}]:${this.config__.name}`, + expireTime: `[@nexim/alpine:expire-time:sv${schemaVersion}]:${this.config__.name}`, }; /** - * Constructor to initialize the StoreWithBackup instance. - * @param config__ - Configuration object containing name, version, defaultStore, and optional expireDuration. + * AlpineStoreWithBackup Constructor. + * + * @param {AlpineStoreWithBackupConfig} config__ - Configuration object. */ - constructor(private config__: AlpineStoreWithBackupConfig) { + constructor(private config__: AlpineStoreWithBackupConfig) { super(config__); - this.handleExpireDuration__(); + this.handleDataExpiration__(); this.load__(); } @@ -48,7 +51,7 @@ export class AlpineStoreWithBackup extends * Updates the expiration time. */ save(): void { - this.logger_.logMethodArgs?.(`${__package_name__}.save`, this.store.data); + this.logger_.logMethodArgs?.('save', {data: this.store.data}); if (this.store.data === null) { this.clear(); @@ -60,31 +63,32 @@ export class AlpineStoreWithBackup extends } /** - * Clears the stored data, and expiration time from local storage. + * Resets the data to the default store configuration and clears the stored data. */ - clear(): void { - this.logger_.logMethod?.(`${__package_name__}.clear`); + resetDataToDefault(): void { + this.logger_.logMethod?.('resetDataToDefault'); - localJsonStorage.removeItem(this.localStorageKey__.data, this.config__.version); - localJsonStorage.removeItem(this.localStorageKey__.expireTime, this.config__.version); + this.store = this.config__.defaultValue; + this.clear(); } /** - * Resets the data to the default store configuration and clears the stored data. + * Clears the stored data, and expiration time from local storage. */ - resetDataToDefault(): void { - this.logger_.logMethod?.(`${__package_name__}.resetDataToDefault`); - this.store = this.config__.defaultStore; - this.clear(); + clear(): void { + this.logger_.logMethod?.('clear'); + + localJsonStorage.removeItem(this.localStorageKey__.data, this.config__.version); + localJsonStorage.removeItem(this.localStorageKey__.expireTime, this.config__.version); } /** * Handles the expiration duration by checking if the stored data has expired. * If expired, it clears the stored data. */ - private handleExpireDuration__(): void { + private handleDataExpiration__(): void { if (this.config__.expireDuration == null) return; - this.logger_.logMethod?.(`${__package_name__}.handleExpireDuration__`); + this.logger_.logMethod?.('handleDataExpiration__'); const expireDuration = localJsonStorage.getItem<{time: number}>( this.localStorageKey__.expireTime, @@ -97,19 +101,6 @@ export class AlpineStoreWithBackup extends } } - /** - * Updates the expiration time in local storage to the current time plus the configured expiration duration. - */ - private updateExpireTime__(): void { - if (this.config__.expireDuration == null) return; - this.logger_.logMethod?.(`${__package_name__}.updateExpireTime__`); - - const newExpireTime = Date.now() + parseDuration(this.config__.expireDuration); - localJsonStorage.setItem(this.localStorageKey__.expireTime, {time: newExpireTime}, this.config__.version); - - this.logger_.logOther?.(`${__package_name__}.updated_expire_time`, {newExpireTime}); - } - /** * Loads data from local storage and updates the store's data. * @@ -121,18 +112,36 @@ export class AlpineStoreWithBackup extends private load__(): void { this.logger_.logMethod?.('load__'); - const newData = localJsonStorage.getItem(this.localStorageKey__.data, {}, this.config__.version); + const newData = localJsonStorage.getItem(this.localStorageKey__.data, {}, this.config__.version); + if (Object.keys(newData).length === 0) { + // empty object const rawValue = localStorage.getItem(localJsonStorage.key_(this.localStorageKey__.data, this.config__.version)); if (rawValue === '{}' || rawValue === null) { this.logger_.logOther?.('no_data'); + + this.resetDataToDefault(); return; } - this.logger_.error(`${__package_name__}.load__`, 'data_not_parsed', {localStorageKey: this.localStorageKey__}); + this.logger_.error('load__', 'data_not_parsed', {localStorageKey: this.localStorageKey__}); return; } + // else: data is not empty + + this.store.data = newData as TData; + } + + /** + * Updates the expiration time in local storage to the current time plus the configured expiration duration. + */ + private updateExpireTime__(): void { + if (this.config__.expireDuration == null) return; + this.logger_.logMethod?.('updateExpireTime__'); + + const newExpireTime = Date.now() + parseDuration(this.config__.expireDuration); + localJsonStorage.setItem(this.localStorageKey__.expireTime, {time: newExpireTime}, this.config__.version); - this.store.data = newData; + this.logger_.logOther?.('updated_expire_time', {newExpireTime}); } } diff --git a/packages/alpine/src/store/store.ts b/packages/alpine/src/store/store.ts index 74f13e4..30fef3c 100644 --- a/packages/alpine/src/store/store.ts +++ b/packages/alpine/src/store/store.ts @@ -1,13 +1,50 @@ import {createLogger, type AlwatrLogger} from '@alwatr/logger'; -import {AlpineBaseStore} from './base-store.js'; +import {alpineStoreGenerator} from './store-generator.js'; -export class AlpineStore extends AlpineBaseStore { - protected logger_: AlwatrLogger; +/** + * Options for creating an Alpine store. + * + * @template T - The type of the default value. + * @property {string} name - The name of the store. + * @property {T} defaultValue - The default state of the store. + */ +export type AlpineStoreOptions = { + name: string; + defaultValue: T; +}; - constructor(config_: {name: string; defaultStore: T}) { - super(config_); // pass name and default store to set in the alpine store +/** + * Class representing an Alpine store. + * + * @template T - The type of the store's state. + * @description This class provides a simple way to create and manage a store with a default state and logging capabilities. + * + * @example + * const storeOptions = { + * name: 'exampleStore', + * defaultValue: { key: 'value' } + * }; + * const store = new AlpineStore(storeOptions); + * + * console.log(store.store); // Output: { key: 'value' } + * + * @description + * The AlpineStore class leverages Alpine.js to create a reactive store that holds a default value. + * Each store is uniquely identified by a name and can be accessed and manipulated throughout the application. + * This class simplifies state management, ensuring that your UI remains in sync with the underlying data. + */ +export class AlpineStore { + store: T; + protected logger_: AlwatrLogger; - this.logger_ = createLogger(`[${__package_name__}:${config_.name}]`); + /** + * Create an Alpine store. + * + * @param {AlpineStoreOptions} config - The configuration options for the store. + */ + constructor(config: AlpineStoreOptions) { + this.store = alpineStoreGenerator(config); + this.logger_ = createLogger(`[${__package_name__}:${config.name}]`); } } diff --git a/tsconfig.json b/tsconfig.json index 9db64f6..8f04e05 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -2,9 +2,7 @@ "extends": "@nexim/typescript-config/tsconfig.json", "compilerOptions": { "noEmit": true, - "types": [ - "node" - ] + "types": ["node"] }, "files": [], "exclude": [], From fe97c64386bf5ed9198c318b834fc8f18fbc0401 Mon Sep 17 00:00:00 2001 From: "S. Amir Mohammad Najafi" Date: Tue, 10 Dec 2024 11:28:54 +0330 Subject: [PATCH 12/18] chore: enhance descriptions --- README.md | 6 +++++- packages/eslint-config/package.json | 2 +- packages/prettier-config/package.json | 2 +- packages/typescript-config/package.json | 2 +- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 098d632..8aa16be 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,11 @@ This repository contains numerous small utility packages. These packages serve v Here is a brief overview of the included libraries: -1. [`element`](./packages/element#readme): Lit based utils. +1. [`element`](./packages/element): Utility functions and mixins for building high-performance web components with Lit. +1. [`alpine`](./packages/alpine): Utility functions to enhance Alpine.js usage with backup support. +2. [`typescript-config`](./packages/typescript-config): Base TypeScript configuration for Nexim projects. +3. [`prettier-config`](./packages/prettier-config): Base Prettier configuration for Nexim projects. +4. [`eslint-config`](./packages/eslint-config): Base Eslint configuration for Nexim projects. For more detailed information and guidelines on how to use each package, please refer to each package's README. diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json index ac4b1d7..93ce484 100644 --- a/packages/eslint-config/package.json +++ b/packages/eslint-config/package.json @@ -1,7 +1,7 @@ { "name": "@nexim/eslint-config", "version": "1.0.0", - "description": "Nexim ECMAScript Style Guide as a ESLint shareable configurations.", + "description": "Base Eslint configuration for Nexim projects.", "keywords": [ "eslint", "eslint-config", diff --git a/packages/prettier-config/package.json b/packages/prettier-config/package.json index d06e127..b2cda69 100644 --- a/packages/prettier-config/package.json +++ b/packages/prettier-config/package.json @@ -1,7 +1,7 @@ { "name": "@nexim/prettier-config", "version": "1.0.0", - "description": "Nexim's shareable configurations for Prettier.", + "description": "Base Prettier configuration for Nexim projects.", "keywords": [ "prettier", "config", diff --git a/packages/typescript-config/package.json b/packages/typescript-config/package.json index 1d0032a..2b9c229 100644 --- a/packages/typescript-config/package.json +++ b/packages/typescript-config/package.json @@ -1,7 +1,7 @@ { "name": "@nexim/typescript-config", "version": "1.0.0", - "description": "This is a base TypeScript configuration for Nexim projects.", + "description": "Base TypeScript configuration for Nexim projects.", "keywords": [ "typescript", "tsconfig", From ce848d9a408ec0b5ece160df223ce039b2113af1 Mon Sep 17 00:00:00 2001 From: "S. Amir Mohammad Najafi" Date: Tue, 10 Dec 2024 11:29:33 +0330 Subject: [PATCH 13/18] chore(github/workflow): add release --- .github/workflows/release.yaml | 75 ++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 .github/workflows/release.yaml diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 0000000..2f49188 --- /dev/null +++ b/.github/workflows/release.yaml @@ -0,0 +1,75 @@ +# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json + +name: Build & Lint & Test & Release + +on: + workflow_dispatch: + +env: + NODE_VERSION: lts/* + GPG_KEY_ID: ${{ vars.GPG_KEY_ID }} + +jobs: + main: + name: Build & Lint & Test & Release + runs-on: ubuntu-latest + + permissions: + contents: write + + steps: + - name: ‡️ Checkout repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: πŸ™‚β€β†”οΈ Import GPG key + run: | + echo "${{ secrets.GPG_PRIVATE_KEY }}" | gpg --batch --import + echo -e "5\ny\n" | gpg --batch --yes --command-fd 0 --edit-key ${{ env.GPG_KEY_ID }} trust quit + env: + GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }} + + - name: 🫑 Setup Git + run: | + git config --global user.name "njfamirm-bot" + git config --global user.email "bot@njfamirm.ir" + git config --global user.signingkey ${{ env.GPG_KEY_ID }} + git config --global commit.gpgsign true + + - name: πŸ— Setup nodejs + uses: actions/setup-node@v4 + with: + node-version: ${{ env.NODE_VERSION }} + + - name: πŸ— Setup nodejs corepack + run: corepack enable + + - name: πŸ— Get yarn config + id: yarn_config + run: echo "cache_folder=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT + + - name: πŸ— Cache Layer + uses: actions/cache@v4 + with: + path: ${{ steps.yarn_config.outputs.cache_folder }} + key: ${{ runner.os }}-yarn-${{ hashFiles('yarn.lock') }} + restore-keys: | + ${{ runner.os }}-yarn- + + - name: πŸ— Install dependencies + run: yarn install --immutable + + - name: πŸš€ Build Typescript + run: yarn build + + - name: πŸš€ Run ESLint + run: yarn lint + + - name: πŸ§ͺ Run Test + run: yarn test + + - name: πŸ€– Get Release + run: yarn release -y + env: + GITHUB_TOKEN: ${{ secrets.BOT_TOKEN }} From 941c68e58edd1b0147136eac5f070768e2824ca9 Mon Sep 17 00:00:00 2001 From: "S. Amir Mohammad Najafi" Date: Tue, 10 Dec 2024 11:51:34 +0330 Subject: [PATCH 14/18] docs(alpine): add jsdoc and enhance readme --- packages/alpine/README.md | 72 ++++++++++++------- packages/alpine/package.json | 2 +- packages/alpine/src/store/store-generator.ts | 7 +- .../alpine/src/store/store-with-backup.ts | 7 +- packages/alpine/src/store/store.ts | 28 ++++++-- 5 files changed, 73 insertions(+), 43 deletions(-) diff --git a/packages/alpine/README.md b/packages/alpine/README.md index 7547397..32221ad 100644 --- a/packages/alpine/README.md +++ b/packages/alpine/README.md @@ -1,14 +1,14 @@ # @nexim/alpine -![NPM Version](https://img.shields.io/npm/v/%40nexim%2Falpine-context) -![npm bundle size](https://img.shields.io/bundlephobia/min/%40nexim%2Falpine-context) +![NPM Version](https://img.shields.io/npm/v/%40nexim%2Falpine) +![npm bundle size](https://img.shields.io/bundlephobia/min/%40nexim%2Falpine) ![Build & Lint & Test](https://github.com/the-nexim/nanolib/actions/workflows/build-lint-test.yaml/badge.svg) -![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Falpine-context) -![NPM License](https://img.shields.io/npm/l/%40nexim%2Falpine-context) +![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Falpine) +![NPM License](https://img.shields.io/npm/l/%40nexim%2Falpine) ## Overview -An collection of utility functions and mixins for building high-performance, maintainable web components using Lit. +`@nexim/alpine` is a versatile library designed to enhance your Alpine.js experience with a suite of utility functions and mixins. It provides robust solutions for Data management, including logging capabilities and backup functionalities with local storage support. This library aims to streamline the development of high-performance, ensuring your projects are both efficient and scalable. ## Installation @@ -21,43 +21,61 @@ yarn add @nexim/alpine ## API -### Alpine-context +### alpineStoreGenerator -The `Store` class provides a base store implementation with logging capabilities. +Generates an Alpine.js store with default value. ```ts -import {Store} from '@nexim/store'; +import {alpineStoreGenerator} from '@nexim/alpine'; -const store = new Store({ - name: 'myStore', - defaultStore: {key: 'value'}, +const store = alpineStoreGenerator({ + name: 'user', + defaultValue: {type: 'root'}, }); + +console.log(store.type); // Output: root ``` -### StoreWithBackup +### AlpineStore -The `StoreWithBackup` class extends `Store` to add backup and restore functionality with local storage support and expiration handling. +Provides a Alpine.js store implementation with logging capabilities in the class. ```ts -import {StoreWithBackup} from '@nexim/store'; - -const storeWithBackup = new StoreWithBackup({ - name: 'myStoreWithBackup', - version: 1, - defaultStore: {data: null}, - expireDuration: '1d', -}); +import {AlpineStore} from '@nexim/alpine'; + +interface StoreType { + name: 'user', + defaultValue: { + type: 'root' | 'user'; + // Add more properties here + }, +} + +class UserProfile extends AlpineStore { + constructor() { + super({ + name: 'user', + defaultStore: { + type: 'root' + } + }) + + console.log(this.store.type) // output: root + } +} ``` -### BaseStore +### AlpineStoreWithBackup -The `BaseStore` class is a base class for creating stores with Alpine.js state management. +The `AlpineStoreWithBackup` class extends `AlpineStore` to add backup and restore functionality with local storage support and expiration handling. ```ts -import {BaseStore} from '@nexim/store'; +import {AlpineStoreWithBackup} from '@nexim/alpine'; -const baseStore = new BaseStore({ - name: 'myBaseStore', - defaultStore: {key: 'value'}, +const storeWithBackup = new AlpineStoreWithBackup({ + name: 'myStoreWithBackup', + version: 1, + defaultValue: {data: null}, + expireDuration: '1d', }); ``` diff --git a/packages/alpine/package.json b/packages/alpine/package.json index 917cd52..3662385 100644 --- a/packages/alpine/package.json +++ b/packages/alpine/package.json @@ -1,7 +1,7 @@ { "name": "@nexim/alpine", "version": "0.0.0", - "description": "A state management library using Alpine Store, and integrated with our custom logger and FSM for client-side logic.", + "description": "Utility functions to enhance Alpine.js usage with backup support.", "keywords": [ "alpinejs", "alpine", diff --git a/packages/alpine/src/store/store-generator.ts b/packages/alpine/src/store/store-generator.ts index ee4ee23..ec3440b 100644 --- a/packages/alpine/src/store/store-generator.ts +++ b/packages/alpine/src/store/store-generator.ts @@ -4,7 +4,7 @@ import alpine from 'alpinejs'; const logger = createLogger(__package_name__); /** - * Options for creating an Alpine store. + * alpineStoreGenerator Options. * * @template T - The type of the default value. * @property {string} name - The name of the store. @@ -25,19 +25,18 @@ export type AlpineStoreGeneratorOptions = { * @see https://alpinejs.dev/globals/alpine-store * * @example - * // Create a store with a default state * const store = alpineStoreGenerator({ * name: 'user', * defaultValue: {type: 'root'}, * }); * - * console.log(store.type); // Output: value + * console.log(store.type); // Output: root * * @description * This function uses Alpine.js to create a reactive store with a default value. * The store is identified by a unique name and can be accessed and manipulated * throughout the application. Alpine.js stores provide a simple way to manage - * state in your application, making it easy to keep your UI in sync with your data. + * data in your application, making it easy to keep your UI in sync with your data. */ export function alpineStoreGenerator(config: AlpineStoreGeneratorOptions): T { logger.logMethodArgs?.('alpineStoreGenerator', config); diff --git a/packages/alpine/src/store/store-with-backup.ts b/packages/alpine/src/store/store-with-backup.ts index 6f225c0..0557835 100644 --- a/packages/alpine/src/store/store-with-backup.ts +++ b/packages/alpine/src/store/store-with-backup.ts @@ -22,12 +22,11 @@ export type AlpineStoreWithBackupConfig, TData extends DictionaryReq> extends AlpineStore { /** - * Keys for storing data and expireTime in local storage. + * Keys for storing data and expire time in local storage. */ private localStorageKey__ = { data: `[@nexim/alpine:data:sv${schemaVersion}]:${this.config__.name}`, @@ -35,7 +34,7 @@ export class AlpineStoreWithBackup = { }; /** - * Class representing an Alpine store. + * Provides a Alpine.js store implementation with logging capabilities in the class. * * @template T - The type of the store's state. * @description This class provides a simple way to create and manage a store with a default state and logging capabilities. * * @example - * const storeOptions = { - * name: 'exampleStore', - * defaultValue: { key: 'value' } - * }; - * const store = new AlpineStore(storeOptions); * - * console.log(store.store); // Output: { key: 'value' } + * interface StoreType { + * name: 'user', + * defaultValue: { + * type: 'root' | 'user'; + * // Add more properties here + * }, + * } + * + * class UserProfile extends AlpineStore { + * constructor() { + * super({ + * name: 'user', + * defaultStore: { + * type: 'root' + * } + * }) + * + * console.log(this.store.type) // output: root + * } + * } * * @description * The AlpineStore class leverages Alpine.js to create a reactive store that holds a default value. From 7010dc3eb17310b22f40de50b7abaadb2f7bde4a Mon Sep 17 00:00:00 2001 From: "S. Amir Mohammad Najafi" Date: Tue, 10 Dec 2024 13:31:15 +0330 Subject: [PATCH 15/18] docs(copilot): improve clarity and consistency in instructions Co-authored-by: arashagp --- .github/copilot-instruction.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/.github/copilot-instruction.md b/.github/copilot-instruction.md index a185ef5..a0da4b8 100644 --- a/.github/copilot-instruction.md +++ b/.github/copilot-instruction.md @@ -20,7 +20,7 @@ As an advanced web developer, prioritize code maintainability, readability, and - Utilize in-ecosystem packages developed by our team. - Use the NoSQL database developed by our team. - Alpine Store for state management. -- Use FSM for state machines by our team for many part of client-side logics. +- Use FSM for state machines by our team for many parts of client-side logic. - Use logger for logging by our team for each function. ## Commenting @@ -34,11 +34,21 @@ As an advanced web developer, prioritize code maintainability, readability, and 7. Include links to external references where helpful. 8. Add comments when fixing bugs. 9. Use comments to mark incomplete implementations. -10. minimize usage of jsdoc comments. +10. Minimize usage of JSDoc comments. ## Other -1. call me `bro`. +1. Call me `bro`. 2. Please consider the logic and if my opinion is against your opinion, please don't accept it immediately and just check it again and give reasons. -3. Do not speak too formally and sloppily, Feel like you're talking to your friend. -4. Explain with simple english. +3. Do not speak too formally and sloppily, feel like you're talking to your friend. +4. Explain with simple English. + +## Document Rules + +1. **Be Concise**: Write documents that are to the point, clear, and concise. Avoid unnecessary details or fluff. +2. **Structure the Document Well**: Use headings, subheadings, bullet points, and numbered lists to organize information logically. Make it easy to navigate. +3. **Clarity and Simplicity**: The document should be understandable by anyone, even those unfamiliar with the specific topic. Use simple language and define technical terms. +4. **Include Examples**: Provide practical examples wherever possible. Show how things are done rather than just explaining concepts. +5. **Focus on the Audience**: Tailor the document to the intended audience. If it’s for developers, focus on technical details. If it’s for a broader audience, simplify the language and provide context. +6. **Be Consistent**: Ensure consistency in style, format, and terminology throughout the document. Follow a specific style guide if applicable. +7. **Document Limitations and Known Issues**: Be transparent about any known limitations or issues. This helps set expectations and avoids confusion. From a62f07be7649daa5380e2c0ad03cf33a9861c129 Mon Sep 17 00:00:00 2001 From: "S. Amir Mohammad Najafi" Date: Tue, 10 Dec 2024 13:32:02 +0330 Subject: [PATCH 16/18] refactor: review and enhance --- packages/alpine/README.md | 37 +----- packages/alpine/src/main.ts | 1 - packages/alpine/src/store/store-generator.ts | 4 +- .../alpine/src/store/store-with-backup.ts | 105 +++++++++--------- packages/alpine/src/store/store.ts | 64 ----------- packages/alpine/src/type.ts | 1 - 6 files changed, 58 insertions(+), 154 deletions(-) delete mode 100644 packages/alpine/src/store/store.ts delete mode 100644 packages/alpine/src/type.ts diff --git a/packages/alpine/README.md b/packages/alpine/README.md index 32221ad..abf8fe0 100644 --- a/packages/alpine/README.md +++ b/packages/alpine/README.md @@ -8,10 +8,12 @@ ## Overview -`@nexim/alpine` is a versatile library designed to enhance your Alpine.js experience with a suite of utility functions and mixins. It provides robust solutions for Data management, including logging capabilities and backup functionalities with local storage support. This library aims to streamline the development of high-performance, ensuring your projects are both efficient and scalable. +`@nexim/alpine` is a versatile library designed to enhance your Alpine.js experience with a suite of utility functions and mixins. It provides robust solutions for data management, including logging capabilities and backup functionalities with local storage support. This library aims to streamline the development of high-performance projects, ensuring efficiency and scalability. ## Installation +Install the package using npm or yarn: + ```sh npm install @nexim/alpine @@ -23,7 +25,7 @@ yarn add @nexim/alpine ### alpineStoreGenerator -Generates an Alpine.js store with default value. +Generates an Alpine.js store with a default value. ```ts import {alpineStoreGenerator} from '@nexim/alpine'; @@ -36,38 +38,9 @@ const store = alpineStoreGenerator({ console.log(store.type); // Output: root ``` -### AlpineStore - -Provides a Alpine.js store implementation with logging capabilities in the class. - -```ts -import {AlpineStore} from '@nexim/alpine'; - -interface StoreType { - name: 'user', - defaultValue: { - type: 'root' | 'user'; - // Add more properties here - }, -} - -class UserProfile extends AlpineStore { - constructor() { - super({ - name: 'user', - defaultStore: { - type: 'root' - } - }) - - console.log(this.store.type) // output: root - } -} -``` - ### AlpineStoreWithBackup -The `AlpineStoreWithBackup` class extends `AlpineStore` to add backup and restore functionality with local storage support and expiration handling. +Extends `AlpineStore` to add backup and restore functionality with local storage support and expiration handling. ```ts import {AlpineStoreWithBackup} from '@nexim/alpine'; diff --git a/packages/alpine/src/main.ts b/packages/alpine/src/main.ts index 66efdae..743ef27 100644 --- a/packages/alpine/src/main.ts +++ b/packages/alpine/src/main.ts @@ -3,5 +3,4 @@ import {packageTracer} from '@alwatr/package-tracer'; __dev_mode__: packageTracer.add(__package_name__, __package_version__); export * from './store/store-generator.js'; -export * from './store/store.js'; export * from './store/store-with-backup.js'; diff --git a/packages/alpine/src/store/store-generator.ts b/packages/alpine/src/store/store-generator.ts index ec3440b..6d9f71a 100644 --- a/packages/alpine/src/store/store-generator.ts +++ b/packages/alpine/src/store/store-generator.ts @@ -22,8 +22,6 @@ export type AlpineStoreGeneratorOptions = { * @param {AlpineStoreGeneratorOptions} config - The configuration object for the store. * @returns {T} - The initialized store instance. * - * @see https://alpinejs.dev/globals/alpine-store - * * @example * const store = alpineStoreGenerator({ * name: 'user', @@ -37,6 +35,8 @@ export type AlpineStoreGeneratorOptions = { * The store is identified by a unique name and can be accessed and manipulated * throughout the application. Alpine.js stores provide a simple way to manage * data in your application, making it easy to keep your UI in sync with your data. + * + * @see https://alpinejs.dev/globals/alpine-store */ export function alpineStoreGenerator(config: AlpineStoreGeneratorOptions): T { logger.logMethodArgs?.('alpineStoreGenerator', config); diff --git a/packages/alpine/src/store/store-with-backup.ts b/packages/alpine/src/store/store-with-backup.ts index 0557835..33d4dc9 100644 --- a/packages/alpine/src/store/store-with-backup.ts +++ b/packages/alpine/src/store/store-with-backup.ts @@ -1,53 +1,78 @@ import {localJsonStorage} from '@alwatr/local-storage'; +import {type AlwatrLogger, createLogger} from '@alwatr/logger'; import {parseDuration, type Duration} from '@alwatr/parse-duration'; -import {AlpineStore} from './store.js'; - -import type {EmptyObject} from '../type.js'; - -export type AlpineStoreWithBackupType = { - data: T | null; +/** + * Type for the store's data to extends from them. + */ +export type AlpineStoreWithBackupType = { + // eslint-disable-next-line @typescript-eslint/no-explicit-any + data: DictionaryReq | null; }; -export type AlpineStoreWithBackupConfig, TData extends DictionaryReq> = { +/** + * AlpineStoreWithBackup Options. + * + * @template T - The type of the store value. + * @param {string} name - The name of the store. + * @param {number} version - The version of the store. + * @param {T} defaultValue - The default value of the store. + * @param {Duration} [expireDuration] - Optional. The duration after which the store expires. + */ +export type AlpineStoreWithBackupOptions = { name: string; version: number; - defaultValue: TBase; + defaultValue: T; expireDuration?: Duration; }; /** - * Schema version `sv` that's change just when the schema changes. + * Version of the schema for storing data in local storage. + * + * Change when this schema changes. */ const schemaVersion = 1; /** - * Provides a Alpine.js store implementation with backup, expiration and logging capabilities. + * Provides a Alpine.js store implementation with backup and expiration. */ -export class AlpineStoreWithBackup, TData extends DictionaryReq> extends AlpineStore { +export class AlpineStoreWithBackup { + /** + * The store's data. + */ + store: T; + + protected logger_: AlwatrLogger; + /** - * Keys for storing data and expire time in local storage. + * Keys for storing data and expire time in local storage with version. */ private localStorageKey__ = { - data: `[@nexim/alpine:data:sv${schemaVersion}]:${this.config__.name}`, - expireTime: `[@nexim/alpine:expire-time:sv${schemaVersion}]:${this.config__.name}`, + data: `[${__package_name__}:data:sv${schemaVersion}]:${this.config__.name}`, + expireTime: `[${__package_name__}:expire-time:sv${schemaVersion}]:${this.config__.name}`, }; /** - * Provides a Alpine.js store implementation with backup, expiration and logging capabilities. + * Provides a Alpine.js store implementation with backup and expiration. * - * @param {AlpineStoreWithBackupConfig} config__ - Configuration object. + * @param {AlpineStoreWithBackupOptions} config__ - Configuration object. */ - constructor(private config__: AlpineStoreWithBackupConfig) { - super(config__); + constructor(private config__: AlpineStoreWithBackupOptions) { + this.logger_ = createLogger(`[${__package_name__}]:${config__.name}`); + this.logger_.logMethodArgs?.('constructor', config__); + + this.store = config__.defaultValue; - this.handleDataExpiration__(); + if (this.config__.expireDuration !== null) { + this.handleDataExpiration__(); + } this.load__(); } /** * Saves the current data to local storage. If the data is null, it clears the stored data. - * Updates the expiration time. + * + * Also updates the expiration time. */ save(): void { this.logger_.logMethodArgs?.('save', {data: this.store.data}); @@ -62,23 +87,15 @@ export class AlpineStoreWithBackup( @@ -103,32 +119,13 @@ export class AlpineStoreWithBackup(this.localStorageKey__.data, {}, this.config__.version); - - if (Object.keys(newData).length === 0) { - // empty object - const rawValue = localStorage.getItem(localJsonStorage.key_(this.localStorageKey__.data, this.config__.version)); - if (rawValue === '{}' || rawValue === null) { - this.logger_.logOther?.('no_data'); - - this.resetDataToDefault(); - return; - } - - this.logger_.error('load__', 'data_not_parsed', {localStorageKey: this.localStorageKey__}); - return; - } - // else: data is not empty - - this.store.data = newData as TData; + const newData = localJsonStorage.getItem(this.localStorageKey__.data, this.config__.defaultValue, this.config__.version); + this.store.data = newData.data; } /** diff --git a/packages/alpine/src/store/store.ts b/packages/alpine/src/store/store.ts deleted file mode 100644 index 715be75..0000000 --- a/packages/alpine/src/store/store.ts +++ /dev/null @@ -1,64 +0,0 @@ -import {createLogger, type AlwatrLogger} from '@alwatr/logger'; - -import {alpineStoreGenerator} from './store-generator.js'; - -/** - * Options for creating an Alpine store. - * - * @template T - The type of the default value. - * @property {string} name - The name of the store. - * @property {T} defaultValue - The default state of the store. - */ -export type AlpineStoreOptions = { - name: string; - defaultValue: T; -}; - -/** - * Provides a Alpine.js store implementation with logging capabilities in the class. - * - * @template T - The type of the store's state. - * @description This class provides a simple way to create and manage a store with a default state and logging capabilities. - * - * @example - * - * interface StoreType { - * name: 'user', - * defaultValue: { - * type: 'root' | 'user'; - * // Add more properties here - * }, - * } - * - * class UserProfile extends AlpineStore { - * constructor() { - * super({ - * name: 'user', - * defaultStore: { - * type: 'root' - * } - * }) - * - * console.log(this.store.type) // output: root - * } - * } - * - * @description - * The AlpineStore class leverages Alpine.js to create a reactive store that holds a default value. - * Each store is uniquely identified by a name and can be accessed and manipulated throughout the application. - * This class simplifies state management, ensuring that your UI remains in sync with the underlying data. - */ -export class AlpineStore { - store: T; - protected logger_: AlwatrLogger; - - /** - * Create an Alpine store. - * - * @param {AlpineStoreOptions} config - The configuration options for the store. - */ - constructor(config: AlpineStoreOptions) { - this.store = alpineStoreGenerator(config); - this.logger_ = createLogger(`[${__package_name__}:${config.name}]`); - } -} diff --git a/packages/alpine/src/type.ts b/packages/alpine/src/type.ts deleted file mode 100644 index 2a2111e..0000000 --- a/packages/alpine/src/type.ts +++ /dev/null @@ -1 +0,0 @@ -export type EmptyObject = DictionaryReq; From f96e7d26336392ef7f7b016478d98b11a7589564 Mon Sep 17 00:00:00 2001 From: "S. Amir Mohammad Najafi" Date: Tue, 10 Dec 2024 13:45:43 +0330 Subject: [PATCH 17/18] docs(alpine): all function document --- lerna.json | 3 +- packages/alpine/README.md | 30 ++++++++++++++++++- packages/alpine/package.json | 4 +-- .../alpine/src/store/store-with-backup.ts | 18 +++++++++++ 4 files changed, 51 insertions(+), 4 deletions(-) diff --git a/lerna.json b/lerna.json index 6ad8b94..264524b 100644 --- a/lerna.json +++ b/lerna.json @@ -37,7 +37,8 @@ }, { "type": "chore", - "section": "Miscellaneous Chores" + "section": "Miscellaneous Chores", + "hidden": true }, { "type": "docs", diff --git a/packages/alpine/README.md b/packages/alpine/README.md index abf8fe0..8f51505 100644 --- a/packages/alpine/README.md +++ b/packages/alpine/README.md @@ -5,6 +5,7 @@ ![Build & Lint & Test](https://github.com/the-nexim/nanolib/actions/workflows/build-lint-test.yaml/badge.svg) ![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Falpine) ![NPM License](https://img.shields.io/npm/l/%40nexim%2Falpine) +![Code Coverage](https://img.shields.io/codecov/c/github/the-nexim/nanolib) ## Overview @@ -27,6 +28,8 @@ yarn add @nexim/alpine Generates an Alpine.js store with a default value. +#### Example Usage + ```ts import {alpineStoreGenerator} from '@nexim/alpine'; @@ -42,13 +45,38 @@ console.log(store.type); // Output: root Extends `AlpineStore` to add backup and restore functionality with local storage support and expiration handling. +#### Constructor + +Creates an instance of `AlpineStoreWithBackup`. + +- **config**: The configuration object for the store. + - **name**: The name of the store. + - **version**: The version of the store. + - **defaultValue**: The default value of the store. + - **expireDuration**: Optional. The duration after which the store expires. + +#### Methods + +- **save()**: Saves the current data to local storage. If the data is null, it clears the stored data. Also updates the expiration time. +- **clear()**: Clears the local storage and set default value to store. + +#### Example Usage + ```ts import {AlpineStoreWithBackup} from '@nexim/alpine'; const storeWithBackup = new AlpineStoreWithBackup({ name: 'myStoreWithBackup', version: 1, - defaultValue: {data: null}, + defaultValue: {data: 'root'}, expireDuration: '1d', }); + +storeWithBackup.store.data = 'user'; + +storeWithBackup.save(); +console.log(storeWithBackup.store.data); // Output: { data: 'user' } + +storeWithBackup.clear(); +console.log(storeWithBackup.store.data); // Output: { data: 'root' } ``` diff --git a/packages/alpine/package.json b/packages/alpine/package.json index 3662385..e817670 100644 --- a/packages/alpine/package.json +++ b/packages/alpine/package.json @@ -9,14 +9,14 @@ "typescript", "nexim" ], - "homepage": "https://github.com/the-nexim/nanolib/tree/next/packages/alpine-context#readme", + "homepage": "https://github.com/the-nexim/nanolib/tree/next/packages/alpine#readme", "bugs": { "url": "https://github.com/the-nexim/nanolib/issues" }, "repository": { "type": "git", "url": "https://github.com/the-nexim/nanolib", - "directory": "packages/alpine-context" + "directory": "packages/alpine" }, "license": "AGPL-3.0-only", "author": "S. Amir Mohammad Najafi (www.njfamirm.ir)", diff --git a/packages/alpine/src/store/store-with-backup.ts b/packages/alpine/src/store/store-with-backup.ts index 33d4dc9..a9152be 100644 --- a/packages/alpine/src/store/store-with-backup.ts +++ b/packages/alpine/src/store/store-with-backup.ts @@ -56,6 +56,24 @@ export class AlpineStoreWithBackup { * Provides a Alpine.js store implementation with backup and expiration. * * @param {AlpineStoreWithBackupOptions} config__ - Configuration object. + * + * @example + * import {AlpineStoreWithBackup} from '@nexim/alpine'; + * + * const storeWithBackup = new AlpineStoreWithBackup({ + * name: 'myStoreWithBackup', + * version: 1, + * defaultValue: {data: 'root'}, + * expireDuration: '1d', + * }); + * + * storeWithBackup.store.data = 'user'; + * + * storeWithBackup.save(); + * console.log(storeWithBackup.store.data); // Output: { data: 'user' } + * + * storeWithBackup.clear(); + * console.log(storeWithBackup.store.data); // Output: { data: 'root' } */ constructor(private config__: AlpineStoreWithBackupOptions) { this.logger_ = createLogger(`[${__package_name__}]:${config__.name}`); From 4c384afadf9d858553b4af1962c996923922d523 Mon Sep 17 00:00:00 2001 From: "S. Amir Mohammad Najafi" Date: Tue, 10 Dec 2024 13:47:36 +0330 Subject: [PATCH 18/18] docs: add badge to all --- README.md | 8 ++++---- packages/alpine/README.md | 1 - packages/eslint-config/README.md | 6 ++++++ packages/prettier-config/README.md | 6 ++++++ packages/typescript-config/README.md | 6 ++++++ 5 files changed, 22 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8aa16be..d43421b 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,10 @@ This repository contains numerous small utility packages. These packages serve v Here is a brief overview of the included libraries: 1. [`element`](./packages/element): Utility functions and mixins for building high-performance web components with Lit. -1. [`alpine`](./packages/alpine): Utility functions to enhance Alpine.js usage with backup support. -2. [`typescript-config`](./packages/typescript-config): Base TypeScript configuration for Nexim projects. -3. [`prettier-config`](./packages/prettier-config): Base Prettier configuration for Nexim projects. -4. [`eslint-config`](./packages/eslint-config): Base Eslint configuration for Nexim projects. +2. [`alpine`](./packages/alpine): Utility functions to enhance Alpine.js usage with backup support. +3. [`typescript-config`](./packages/typescript-config): Base TypeScript configuration for Nexim projects. +4. [`prettier-config`](./packages/prettier-config): Base Prettier configuration for Nexim projects. +5. [`eslint-config`](./packages/eslint-config): Base Eslint configuration for Nexim projects. For more detailed information and guidelines on how to use each package, please refer to each package's README. diff --git a/packages/alpine/README.md b/packages/alpine/README.md index 8f51505..86a3f0e 100644 --- a/packages/alpine/README.md +++ b/packages/alpine/README.md @@ -5,7 +5,6 @@ ![Build & Lint & Test](https://github.com/the-nexim/nanolib/actions/workflows/build-lint-test.yaml/badge.svg) ![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Falpine) ![NPM License](https://img.shields.io/npm/l/%40nexim%2Falpine) -![Code Coverage](https://img.shields.io/codecov/c/github/the-nexim/nanolib) ## Overview diff --git a/packages/eslint-config/README.md b/packages/eslint-config/README.md index 1b3875b..3b7fb64 100644 --- a/packages/eslint-config/README.md +++ b/packages/eslint-config/README.md @@ -1,5 +1,11 @@ # Nexim's ESLint Configurations +![NPM Version](https://img.shields.io/npm/v/%40nexim%2Feslint-config) +![npm bundle size](https://img.shields.io/bundlephobia/min/%40nexim%2Feslint-config) +![Build & Lint & Test](https://github.com/the-nexim/nanolib/actions/workflows/build-lint-test.yaml/badge.svg) +![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Feslint-config) +![NPM License](https://img.shields.io/npm/l/%40nexim%2Feslint-config) + Alwatr ECMAScript Style Guide as a ESLint [shareable configurations](http://eslint.org/docs/developer-guide/shareable-configs.html). ## Installation diff --git a/packages/prettier-config/README.md b/packages/prettier-config/README.md index e9f2049..0902b8d 100644 --- a/packages/prettier-config/README.md +++ b/packages/prettier-config/README.md @@ -1,5 +1,11 @@ # Nexim's Prettier Configurations +![NPM Version](https://img.shields.io/npm/v/%40nexim%2Fprettier-config) +![npm bundle size](https://img.shields.io/bundlephobia/min/%40nexim%2Fprettier-config) +![Build & Lint & Test](https://github.com/the-nexim/nanolib/actions/workflows/build-lint-test.yaml/badge.svg) +![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Fprettier-config) +![NPM License](https://img.shields.io/npm/l/%40nexim%2Fprettier-config) + Nexim's [shareable configurations](https://prettier.io/docs/en/configuration.html#sharing-configurations) for [Prettier](https://prettier.io/). ## Installation diff --git a/packages/typescript-config/README.md b/packages/typescript-config/README.md index 2ef14db..812d632 100644 --- a/packages/typescript-config/README.md +++ b/packages/typescript-config/README.md @@ -1,5 +1,11 @@ # Nexim TypeScript Config +![NPM Version](https://img.shields.io/npm/v/%40nexim%2Ftypescript-config) +![npm bundle size](https://img.shields.io/bundlephobia/min/%40nexim%2Ftypescript-config) +![Build & Lint & Test](https://github.com/the-nexim/nanolib/actions/workflows/build-lint-test.yaml/badge.svg) +![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Ftypescript-config) +![NPM License](https://img.shields.io/npm/l/%40nexim%2Ftypescript-config) + This is a base TypeScript configuration for Nexim projects. ## installation