diff --git a/package.json b/package.json index b91750a11..1875bb095 100644 --- a/package.json +++ b/package.json @@ -28,4 +28,4 @@ "@openfn/simple-ast": "0.4.1", "eslint": "8.26.0" } -} +} \ No newline at end of file diff --git a/packages/odoo/.eslintrc.json b/packages/odoo/.eslintrc.json new file mode 100644 index 000000000..f7a0ddac8 --- /dev/null +++ b/packages/odoo/.eslintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "../../.eslintrc.json" +} \ No newline at end of file diff --git a/packages/odoo/CHANGELOG.md b/packages/odoo/CHANGELOG.md new file mode 100644 index 000000000..086b896d0 --- /dev/null +++ b/packages/odoo/CHANGELOG.md @@ -0,0 +1,104 @@ +# @openfn/language-template + +## 3.0.1 + +### Patch Changes + +- Update lock files +- Updated dependencies + - @openfn/language-common@1.8.1 + +## 3.0.0 + +### Major Changes + +- 2c1d603: Remove parameter reassignment to ensure proper functioning inside an + `each` block; add eslint + + The packages receiving a major bump here exposed functions that didn't work as + expected inside `each` blocks. Users were previously wrapping these functions + inside their own custom `fn` blocks, and this change will ensure that they can + be used inside a standard each. + + See https://github.com/OpenFn/adaptors/issues/275 for more details. + +### Patch Changes + +- Updated dependencies [2c1d603] + - @openfn/language-common@1.8.0 + +## 2.0.0 + +### Major Changes + +- 779596f: Use native fetch (undici) in template and add icons in openfn + +### Minor Changes + +- 1af9cd5: Better docs and resource names + +## 1.7.8 + +### Patch Changes + +- 14f481e: mark execute as private +- Updated dependencies [2b4c61a] + - @openfn/language-common@1.7.6 + +## 1.7.7 + +### Patch Changes + +- f7ebd3c: remove sample configuration + +## 1.7.6 + +### Patch Changes + +- f2aed32: add examples + +## 1.7.5 + +### Patch Changes + +- 6d8de03: change @constructor to @function and remove /\*_ @module Adaptor _/ + +## 1.7.4 + +### Patch Changes + +- f2a91a4: Update package exports +- Updated dependencies [f2a91a4] + - @openfn/language-common@1.7.5 + +## 1.7.3 + +### Patch Changes + +- 8566b26: Fix typings +- b3d45ff: Fix CJS export of npm package. +- b5eb665: Adjusted docs for common and built to markdown +- ecf5d30: remove sinon since it was not being used +- Updated dependencies [8566b26] +- Updated dependencies [b3d45ff] +- Updated dependencies [b5eb665] +- Updated dependencies [ecf5d30] + - @openfn/language-common@1.7.4 + +## 1.7.2 + +### Patch Changes + +- f4b3dd6: remove travis build url + +## 1.7.1 + +### Patch Changes + +- Fixed package.json for template adaptor + +## 1.7.0 + +### Minor Changes + +- 554e905: Migrated to monorepo diff --git a/packages/odoo/LICENSE b/packages/odoo/LICENSE new file mode 100644 index 000000000..94a9ed024 --- /dev/null +++ b/packages/odoo/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 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 General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is 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. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +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. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + 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 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. Use with the GNU Affero General Public License. + + 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 Affero 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 special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 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 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 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 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + 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 GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/packages/odoo/LICENSE.LESSER b/packages/odoo/LICENSE.LESSER new file mode 100644 index 000000000..65c5ca88a --- /dev/null +++ b/packages/odoo/LICENSE.LESSER @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 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. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/packages/odoo/README.md b/packages/odoo/README.md new file mode 100644 index 000000000..df030b864 --- /dev/null +++ b/packages/odoo/README.md @@ -0,0 +1,32 @@ +# language-odoo + +An OpenFn **_adaptor_** for building integration jobs for use with the \_\_\_\_ +API. + +## Documentation + +View the [docs site](https://docs.openfn.org/adaptors/packages/odoo-docs) for +full technical documentation. + +### Configuration + +View the +[configuration-schema](https://docs.openfn.org/adaptors/packages/odoo-configuration-schema/) +for required and optional `configuration` properties. + +### A example expression using the `create` function + +```js +create('patient', { name: 'Bukayo' }); +``` + +## Development + +Clone the [adaptors monorepo](https://github.com/OpenFn/adaptors). Follow the +"Getting Started" guide inside to get set up. + +Run tests using `pnpm run test` or `pnpm run test:watch` + +Build the project using `pnpm build`. + +To build _only_ the docs run `pnpm build docs`. diff --git a/packages/odoo/assets/rectangle.png b/packages/odoo/assets/rectangle.png new file mode 100644 index 000000000..5fb8b66e0 Binary files /dev/null and b/packages/odoo/assets/rectangle.png differ diff --git a/packages/odoo/assets/square.png b/packages/odoo/assets/square.png new file mode 100644 index 000000000..60f00c1f3 Binary files /dev/null and b/packages/odoo/assets/square.png differ diff --git a/packages/odoo/ast.json b/packages/odoo/ast.json new file mode 100644 index 000000000..6856b0f79 --- /dev/null +++ b/packages/odoo/ast.json @@ -0,0 +1,460 @@ +{ + "operations": [ + { + "name": "createLead", + "params": [ + "model", + "params", + "externalId" + ], + "docs": { + "description": "Create a lead in Odoo", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "example", + "description": "createLead(\"res.partner\", { name: \"Kool Keith\" });" + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Operation" + } + } + ] + }, + "valid": false + } + ], + "exports": [], + "common": [ + { + "name": "fn", + "params": [ + "func" + ], + "docs": { + "description": "Creates a custom step (or operation) for more flexible job writing.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "example", + "description": "fn(state => {\n // do some things to state\n return state;\n});" + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "param", + "description": "is the function", + "type": { + "type": "NameExpression", + "name": "Function" + }, + "name": "func" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Operation" + } + } + ] + }, + "valid": true + }, + { + "name": "sourceValue", + "params": [ + "path" + ], + "docs": { + "description": "Picks out a single value from source data.\nIf a JSONPath returns more than one value for the reference, the first\nitem will be returned.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "example", + "description": "sourceValue('$.key')" + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "param", + "description": "JSONPath referencing a point in `state`.", + "type": { + "type": "NameExpression", + "name": "String" + }, + "name": "path" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Operation" + } + } + ] + }, + "valid": true + }, + { + "name": "dataPath", + "params": [ + "path" + ], + "docs": { + "description": "Ensures a path points at the data.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "example", + "description": "dataPath('key')" + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "param", + "description": "JSONPath referencing a point in `data`.", + "type": { + "type": "NameExpression", + "name": "string" + }, + "name": "path" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "string" + } + } + ] + }, + "valid": true + }, + { + "name": "dataValue", + "params": [ + "path" + ], + "docs": { + "description": "Picks out a single value from the source data object—usually `state.data`.\nIf a JSONPath returns more than one value for the reference, the first\nitem will be returned.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "example", + "description": "dataValue('key')" + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "param", + "description": "JSONPath referencing a point in `data`.", + "type": { + "type": "NameExpression", + "name": "String" + }, + "name": "path" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Operation" + } + } + ] + }, + "valid": true + }, + { + "name": "lastReferenceValue", + "params": [ + "path" + ], + "docs": { + "description": "Picks out the last reference value from source data.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "example", + "description": "lastReferenceValue('key')" + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "param", + "description": "JSONPath referencing a point in `references`.", + "type": { + "type": "NameExpression", + "name": "String" + }, + "name": "path" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Operation" + } + } + ] + }, + "valid": true + }, + { + "name": "each", + "params": [ + "dataSource", + "operation" + ], + "docs": { + "description": "Scopes an array of data based on a JSONPath.\nUseful when the source data has `n` items you would like to map to\nan operation.\nThe operation will receive a slice of the data based of each item\nof the JSONPath provided.\n\nIt also ensures the results of an operation make their way back into\nthe state's references.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "example", + "description": "each(\"$.[*]\",\n create(\"SObject\",\n field(\"FirstName\", sourceValue(\"$.firstName\"))\n )\n)" + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "param", + "description": "JSONPath referencing a point in `state`.", + "type": { + "type": "NameExpression", + "name": "DataSource" + }, + "name": "dataSource" + }, + { + "title": "param", + "description": "The operation needed to be repeated.", + "type": { + "type": "NameExpression", + "name": "Operation" + }, + "name": "operation" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Operation" + } + } + ] + }, + "valid": true + }, + { + "name": "field", + "params": [ + "key", + "value" + ], + "docs": { + "description": "Returns a key, value pair in an array.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "example", + "description": "field('destination_field_name__c', 'value')" + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "param", + "description": "Name of the field", + "type": { + "type": "NameExpression", + "name": "string" + }, + "name": "key" + }, + { + "title": "param", + "description": "The value itself or a sourceable operation.", + "type": { + "type": "NameExpression", + "name": "Value" + }, + "name": "value" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Field" + } + } + ] + }, + "valid": true + }, + { + "name": "fields", + "params": [ + "fields" + ], + "docs": { + "description": "Zips key value pairs into an object.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "example", + "description": "fields(list_of_fields)" + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "param", + "description": "a list of fields", + "type": { + "type": "NameExpression", + "name": "Fields" + }, + "name": "fields" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Object" + } + } + ] + }, + "valid": true + }, + { + "name": "merge", + "params": [ + "dataSource", + "fields" + ], + "docs": { + "description": "Merges fields into each item in an array.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "example", + "description": "merge(\n \"$.books[*]\",\n fields(\n field( \"publisher\", sourceValue(\"$.publisher\") )\n )\n)" + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "param", + "description": null, + "type": { + "type": "NameExpression", + "name": "DataSource" + }, + "name": "dataSource" + }, + { + "title": "param", + "description": "Group of fields to merge in.", + "type": { + "type": "NameExpression", + "name": "Object" + }, + "name": "fields" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "DataSource" + } + } + ] + }, + "valid": true + } + ] +} \ No newline at end of file diff --git a/packages/odoo/configuration-schema.json b/packages/odoo/configuration-schema.json new file mode 100644 index 000000000..33ff22e14 --- /dev/null +++ b/packages/odoo/configuration-schema.json @@ -0,0 +1,59 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "properties": { + "baseUrl": { + "title": "Base URL", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The base URL (http://www.example.com)", + "format": "uri", + "minLength": 1, + "default": "http://localhost", + "examples": [ + "https://dev.newlogic-demo.com" + ] + }, + "username": { + "title": "Username", + "type": "string", + "description": "Username", + "default": "admin", + "examples": [ + "test@openfn.org" + ] + }, + "password": { + "title": "Password", + "type": "string", + "description": "Password", + "default": "admin", + "writeOnly": true, + "examples": [ + "@some(!)Str0ngp4ss0w0rd" + ] + }, + "database": { + "title": "Database Name", + "type": "string", + "default": "devel", + "description": "Database Name", + "examples": [ + "devel" + ] + } + }, + "type": "object", + "additionalProperties": true, + "required": [ + "password", + "username", + "database", + "baseUrl" + ] +} \ No newline at end of file diff --git a/packages/odoo/package.json b/packages/odoo/package.json new file mode 100644 index 000000000..95307505a --- /dev/null +++ b/packages/odoo/package.json @@ -0,0 +1,50 @@ +{ + "name": "@openfn/language-odoo", + "version": "3.0.1", + "description": "The standard odoo for building OpenFn adaptors", + "type": "module", + "exports": { + ".": { + "import": "./dist/index.js", + "require": "./dist/index.cjs" + }, + "./package.json": "./package.json" + }, + "scripts": { + "build": "pnpm clean && build-adaptor odoo", + "test": "mocha --experimental-specifier-resolution=node --no-warnings", + "test:watch": "mocha -w --experimental-specifier-resolution=node --no-warnings", + "clean": "rimraf dist types docs", + "pack": "pnpm pack --pack-destination ../../dist", + "lint": "eslint src" + }, + "author": "Open Function Group", + "license": "LGPLv3", + "files": [ + "dist/", + "types/", + "ast.json", + "configuration-schema.json" + ], + "dependencies": { + "@openfn/language-common": "^1.8.1", + "odoo-await": "^3.4.1" + }, + "devDependencies": { + "@openfn/buildtools": "workspace:^1.0.2", + "@openfn/simple-ast": "0.4.1", + "assertion-error": "2.0.0", + "chai": "4.3.6", + "deep-eql": "4.1.1", + "esno": "^0.16.3", + "mocha": "9.2.2", + "rimraf": "3.0.2", + "undici": "^5.22.1" + }, + "repository": { + "type": "git", + "url": "https://github.com/openfn/adaptors.git" + }, + "types": "types/index.d.ts", + "main": "dist/index.cjs" +} \ No newline at end of file diff --git a/packages/odoo/src/Adaptor.js b/packages/odoo/src/Adaptor.js new file mode 100644 index 000000000..acd32cc7e --- /dev/null +++ b/packages/odoo/src/Adaptor.js @@ -0,0 +1,94 @@ +import { + execute as commonExecute, + composeNextState, +} from '@openfn/language-common'; +import { expandReferences } from '@openfn/language-common/util'; + +import pkg from 'odoo-await'; +const Odoo = pkg; + +let odooConn = null; + +/** + * Execute a sequence of operations. + * Wraps `language-common/execute` to make working with this API easier. + * @example + * execute( + * create('foo'), + * delete('bar') + * )(state) + * @private + * @param {Operations} operations - Operations to be performed. + * @returns {Operation} + */ +export function execute(...operations) { + const initialState = { + references: [], + data: null, + }; + + return state => { + return commonExecute(login, ...operations)({ ...initialState, ...state }); + }; +} + +/** + * Logs in to OpenSpp, gets a session token. + * @example + * login(state) + * @private + * @param {State} state - Runtime state. + * @returns {State} + */ +async function login(state) { + const { baseUrl, username, password, database } = state.configuration; + odooConn = new Odoo({ + baseUrl: baseUrl, + db: database, + username: username, + password: password, + }); + try { + await odooConn.connect(); + } catch (err) { + console.log(`✗ Error: ${err}`); + odooConn = null; + } + return state; +} +/** + * Create a lead in Odoo + * @public + * @example + * createLead("res.partner", { name: "Kool Keith" }); + * @function + * @returns {Operation} + */ +export function createLead(model, params, externalId) { + return async state => { + const [resolvedModel, resolvedParams, resolvedExternalId] = + expandReferences(state, model, params, externalId); + + console.log(resolvedModel, resolvedParams, resolvedExternalId); + let lead = await odooConn.create( + resolvedModel, + resolvedParams, + resolvedExternalId + ); + console.log(lead); + }; +} + +export { + dataPath, + dataValue, + dateFns, + each, + field, + fields, + fn, + http, + lastReferenceValue, + merge, + sourceValue, +} from '@openfn/language-common'; diff --git a/packages/odoo/src/index.js b/packages/odoo/src/index.js new file mode 100644 index 000000000..a013b3648 --- /dev/null +++ b/packages/odoo/src/index.js @@ -0,0 +1,4 @@ +import * as Adaptor from './Adaptor'; +export default Adaptor; + +export * from './Adaptor'; \ No newline at end of file diff --git a/packages/odoo/test/Adaptor.test.js b/packages/odoo/test/Adaptor.test.js new file mode 100644 index 000000000..d5205b139 --- /dev/null +++ b/packages/odoo/test/Adaptor.test.js @@ -0,0 +1,104 @@ +import { expect } from 'chai'; +import { execute, create, dataValue } from '../src/Adaptor.js'; + +import MockAgent from './mockAgent.js'; +import { setGlobalDispatcher } from 'undici'; + +setGlobalDispatcher(MockAgent); + +describe('execute', () => { + it('executes each operation in sequence', done => { + const state = {}; + const operations = [ + state => { + return { counter: 1 }; + }, + state => { + return { counter: 2 }; + }, + state => { + return { counter: 3 }; + }, + ]; + + execute(...operations)(state) + .then(finalState => { + expect(finalState).to.eql({ counter: 3 }); + }) + .then(done) + .catch(done); + }); + + it('assigns references, data to the initialState', () => { + const state = {}; + + execute()(state).then(finalState => { + expect(finalState).to.eql({ references: [], data: null }); + }); + }); +}); + +describe('create', () => { + it('makes a post request to the right endpoint', async () => { + const state = { + configuration: { + baseUrl: 'https://fake.server.com', + username: 'hello', + password: 'there', + }, + data: { + fullName: 'Mamadou', + gender: 'M', + }, + }; + + const finalState = await execute( + create('patients', { + name: dataValue('fullName')(state), + gender: dataValue('gender')(state), + }) + )(state); + + expect(finalState.data).to.eql({ + fullName: 'Mamadou', + gender: 'M', + id: 7, + }); + }); + + it('throws an error for a 404', async () => { + const state = { + configuration: { + baseUrl: 'https://fake.server.com', + username: 'hello', + password: 'there', + }, + }; + + const error = await execute(create('noAccess', { name: 'taylor' }))( + state + ).catch(error => { + return error; + }); + + expect(error.message).to.eql('Page not found'); + }); + + it('handles and throws different kinds of errors', async () => { + const state = { + configuration: { + baseUrl: 'https://fake.server.com', + username: 'hello', + password: 'there', + }, + }; + + const error = await execute( + create('!@#$%^&*', { name: 'taylor' }) + )(state).catch(error => { + return error; + }); + + expect(error.message).to.eql('Server error'); + }); +}); diff --git a/packages/odoo/test/mockAgent.js b/packages/odoo/test/mockAgent.js new file mode 100644 index 000000000..b245ba226 --- /dev/null +++ b/packages/odoo/test/mockAgent.js @@ -0,0 +1,43 @@ +import { MockAgent } from 'undici'; + +const mockAgent = new MockAgent(); + +const mockPool = mockAgent.get('https://fake.server.com'); + +mockPool + .intercept({ + path: '/api/patients', + method: 'POST', + headers: { + 'content-type': 'application/json', + Authorization: 'Basic aGVsbG86dGhlcmU=', + }, + }) + .reply(200, { + data: { id: 7, fullName: 'Mamadou', gender: 'M' }, + status: 'success', + }); + +mockPool + .intercept({ + path: '/api/noAccess', + method: 'POST', + }) + .reply(404, { + message: 'Not found', + status: 'error', + code: 404, + }); + +mockPool + .intercept({ + path: '/api/!@#$%^&*', + method: 'POST', + }) + .reply(500, { + message: 'Server error', + status: 'error', + code: 500, + }); + +export default mockAgent; diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e34a9cb16..0d33cffcc 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1293,6 +1293,43 @@ importers: specifier: ^5.22.1 version: 5.22.1 + packages/odoo: + dependencies: + '@openfn/language-common': + specifier: ^1.8.1 + version: link:../common + odoo-await: + specifier: ^3.4.1 + version: 3.4.1 + devDependencies: + '@openfn/buildtools': + specifier: workspace:^1.0.2 + version: link:../../tools/build + '@openfn/simple-ast': + specifier: 0.4.1 + version: 0.4.1 + assertion-error: + specifier: 2.0.0 + version: 2.0.0 + chai: + specifier: 4.3.6 + version: 4.3.6 + deep-eql: + specifier: 4.1.1 + version: 4.1.1 + esno: + specifier: ^0.16.3 + version: 0.16.3 + mocha: + specifier: 9.2.2 + version: 9.2.2 + rimraf: + specifier: 3.0.2 + version: 3.0.2 + undici: + specifier: ^5.22.1 + version: 5.24.0 + packages/openfn: dependencies: '@openfn/language-common': @@ -2048,6 +2085,60 @@ importers: specifier: 17.6.0 version: 17.6.0 + tools/generate: + specifiers: + '@openfn/simple-ast': 0.4.1 + '@types/node': 18.17.5 + esno: 0.16.3 + jsdoc-to-markdown: 8.0.0 + ts-node: 10.9.1 + tsup: 6.3.0 + typescript: 4.8.4 + yargs: 17.6.0 + dependencies: + '@openfn/simple-ast': 0.4.1 + '@types/node': 18.17.5 + esno: 0.16.3 + jsdoc-to-markdown: 8.0.0 + ts-node: 10.9.1_7swnjmbetjjvp57ulnvp6cv344 + tsup: 6.3.0_mwhvu7sfp6vq5ryuwb6hlbjfka + typescript: 4.8.4 + yargs: 17.6.0 + + tools/generate/template: + dependencies: + '@openfn/language-common': + specifier: ^1.12.0 + version: link:../../../packages/common + devDependencies: + '@openfn/buildtools': + specifier: workspace:^1.0.2 + version: link:../../build + '@openfn/simple-ast': + specifier: 0.4.1 + version: 0.4.1 + assertion-error: + specifier: 2.0.0 + version: 2.0.0 + chai: + specifier: 4.3.6 + version: 4.3.6 + deep-eql: + specifier: 4.1.1 + version: 4.1.1 + esno: + specifier: ^0.16.3 + version: 0.16.3 + mocha: + specifier: 9.2.2 + version: 9.2.2 + rimraf: + specifier: 3.0.2 + version: 3.0.2 + undici: + specifier: ^5.22.1 + version: 5.23.0 + tools/generate: dependencies: '@openfn/simple-ast': @@ -3181,10 +3272,6 @@ packages: resolution: {integrity: sha512-dSYZh7HhCDtCKm4QakX0xFpsRDqjjtZf/kjI/v3T3Nwt5r8/qz/M19F9ySyOqU94SXBmeG9ttTul+YnR4LOxFA==} engines: {node: '>=6.0.0'} - /@jridgewell/set-array@1.1.2: - resolution: {integrity: sha512-xnkseuNADM0gt2bs+BvhO0p78Mk762YnZdsuzFV018NoG1Sj1SCQvpSqa7XUaTam5vAGasABV9qXASMKnFMwMw==} - engines: {node: '>=6.0.0'} - /@jridgewell/sourcemap-codec@1.4.15: resolution: {integrity: sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==} @@ -5054,6 +5141,17 @@ packages: set-function-length: 1.2.2 dev: false + /call-bind@1.0.7: + resolution: {integrity: sha512-GHTSNSYICQ7scH7sZ+M2rFopRoLh8t2bLSW6BbgrtLsahOIB5iyAVJf9GjWK3cYTDaMj4XdBpM1cA6pIS0Kv2w==} + engines: {node: '>= 0.4'} + dependencies: + es-define-property: 1.0.0 + es-errors: 1.3.0 + function-bind: 1.1.2 + get-intrinsic: 1.2.4 + set-function-length: 1.2.2 + dev: false + /callsites@3.1.0: resolution: {integrity: sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==} engines: {node: '>=6'} @@ -5218,6 +5316,11 @@ packages: engines: {node: ^12.17.0 || ^14.13 || >=16.0.0} dev: false + /chalk@5.3.0: + resolution: {integrity: sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w==} + engines: {node: ^12.17.0 || ^14.13 || >=16.0.0} + dev: false + /chardet@0.7.0: resolution: {integrity: sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==} @@ -5926,6 +6029,15 @@ packages: gopd: 1.0.1 dev: false + /define-data-property/1.1.4: + resolution: {integrity: sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==} + engines: {node: '>= 0.4'} + dependencies: + es-define-property: 1.0.0 + es-errors: 1.3.0 + gopd: 1.0.1 + dev: false + /define-lazy-prop@2.0.0: resolution: {integrity: sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og==} engines: {node: '>=8'} @@ -6302,6 +6414,17 @@ packages: engines: {node: '>= 0.4'} dev: false + /es-set-tostringtag@2.0.1: + resolution: {integrity: sha512-g3OMbtlwY3QewlqAiMLI47KywjWZoEytKr8pf6iTC8uJq5bIAH52Z9pnQ8pVL6whrCto53JZDuUIsifGeLorTg==} + engines: {node: '>= 0.4'} + dependencies: + get-intrinsic: 1.2.4 + + /es-errors@1.3.0: + resolution: {integrity: sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==} + engines: {node: '>= 0.4'} + dev: false + /es-set-tostringtag@2.0.1: resolution: {integrity: sha512-g3OMbtlwY3QewlqAiMLI47KywjWZoEytKr8pf6iTC8uJq5bIAH52Z9pnQ8pVL6whrCto53JZDuUIsifGeLorTg==} engines: {node: '>= 0.4'} @@ -7478,6 +7601,25 @@ packages: hasown: 2.0.2 dev: false + /get-intrinsic@1.2.1: + resolution: {integrity: sha512-2DcsyfABl+gVHEfCOaTrWgyt+tb6MSEGmKq+kI5HwLbIYgjgmMcV8KQ41uaKz1xxUcn9tJtgFbQUEVcEbd0FYw==} + dependencies: + function-bind: 1.1.1 + has: 1.0.3 + has-proto: 1.0.1 + has-symbols: 1.0.3 + + /get-intrinsic@1.2.4: + resolution: {integrity: sha512-5uYhsJH8VJBTv7oslg4BznJYhDoRI6waYCxMmCdnTrcCrHA/fCFKoTFz2JKKE0HdDFUF7/oQuhzumXJK7paBRQ==} + engines: {node: '>= 0.4'} + dependencies: + es-errors: 1.3.0 + function-bind: 1.1.2 + has-proto: 1.0.1 + has-symbols: 1.0.3 + hasown: 2.0.2 + dev: false + /get-port@3.2.0: resolution: {integrity: sha512-x5UJKlgeUiNT8nyo/AcnwLnZuZNcSjSw0kogRB+Whd1fjjFq4B1hySFxSFWWSn4mIBzg3sRNUDFYc4g5gjPoLg==} engines: {node: '>=4'} @@ -7781,6 +7923,12 @@ packages: es-define-property: 1.0.0 dev: false + /has-property-descriptors@1.0.2: + resolution: {integrity: sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==} + dependencies: + es-define-property: 1.0.0 + dev: false + /has-proto@1.0.1: resolution: {integrity: sha512-7qE+iP+O+bgF9clE5+UoBFzE65mlBiVj3tKCrlNQ0Ogwm0BjpT/gK4SlLYDMybDh5I3TCTKnPPa0oMG7JDYrhg==} engines: {node: '>= 0.4'} diff --git a/tools/generate/template/package.json b/tools/generate/template/package.json new file mode 100644 index 000000000..0aff16521 --- /dev/null +++ b/tools/generate/template/package.json @@ -0,0 +1,47 @@ +{ + "name": "@openfn/language-{{TEMPLATE}}", + "version": "1.0.0", + "description": "The standard template for building OpenFn adaptors", + "type": "module", + "exports": { + ".": { + "import": "./dist/index.js", + "require": "./dist/index.cjs" + }, + "./package.json": "./package.json" + }, + "scripts": { + "build": "pnpm clean && build-adaptor {{TEMPLATE}}", + "test": "mocha --experimental-specifier-resolution=node --no-warnings", + "test:watch": "mocha -w --experimental-specifier-resolution=node --no-warnings", + "clean": "rimraf dist types docs", + "pack": "pnpm pack --pack-destination ../../dist", + "lint": "eslint src" + }, + "author": "Open Function Group", + "license": "LGPLv3", + "files": [ + "dist/", + "types/", + "ast.json", + "configuration-schema.json" + ], + "dependencies": { + "@openfn/language-common": "workspace:*" + }, + "devDependencies": { + "assertion-error": "2.0.0", + "chai": "4.3.6", + "deep-eql": "4.1.1", + "esno": "^0.16.3", + "mocha": "9.2.2", + "rimraf": "3.0.2", + "undici": "^5.22.1" + }, + "repository": { + "type": "git", + "url": "https://github.com/openfn/adaptors.git" + }, + "types": "types/index.d.ts", + "main": "dist/index.cjs" +}