diff --git a/README.md b/README.md index 8d6eabc19..9426c4d41 100644 --- a/README.md +++ b/README.md @@ -102,9 +102,10 @@ export OPENFN_ADAPTORS_REPO=~/repo/openfn/adaptors ```json { "configuration": { //Your salesforce credentials}, - "data": { - "company_name": "Example Inc.", - "industry": "Software" + "data": { + "company_name": "Example Inc.", + "industry": "Software" + } } } ``` diff --git a/packages/sahara/.eslintrc.json b/packages/sahara/.eslintrc.json new file mode 100644 index 000000000..f7a0ddac8 --- /dev/null +++ b/packages/sahara/.eslintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "../../.eslintrc.json" +} \ No newline at end of file diff --git a/packages/sahara/CHANGELOG.md b/packages/sahara/CHANGELOG.md new file mode 100644 index 000000000..bf54bcaa4 --- /dev/null +++ b/packages/sahara/CHANGELOG.md @@ -0,0 +1 @@ +# @openfn/language-sahara diff --git a/packages/sahara/LICENSE b/packages/sahara/LICENSE new file mode 100644 index 000000000..94a9ed024 --- /dev/null +++ b/packages/sahara/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/sahara/LICENSE.LESSER b/packages/sahara/LICENSE.LESSER new file mode 100644 index 000000000..65c5ca88a --- /dev/null +++ b/packages/sahara/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/sahara/README.md b/packages/sahara/README.md new file mode 100644 index 000000000..35c225891 --- /dev/null +++ b/packages/sahara/README.md @@ -0,0 +1,123 @@ +# language-sahara + +An OpenFn **_adaptor_** for the Sahara (Intron Health) voice transcription and AI-powered clinical documentation API. + +## Documentation + +View the [docs site](https://docs.voice.intron.io) for full technical documentation. + +### Configuration + +See [configuration-schema.json](configuration-schema.json) for required and optional `configuration` properties. + +```json +{ + "apiKey": "your-sahara-api-key", + "baseUrl": "https://infer.voice.intron.io" +} +``` + +Optional URL validation (when using signed URLs for `audio_file_blob`): `validateUploadUrl`, `allowedUrlDomains`, `allowedUrlExtensions`, `requireExpiryParam`—see the schema. + +For local testing with the integration examples, see [examples/integration/README.md](examples/integration/README.md). In production, configure credentials via the platform's credential management. + +## Usage + +- Upload audio **by URL** (e.g. signed S3 or SharePoint links) for transcription. +- Retrieve results with medical/clinical post-processing. +- Use cases: telehealth, call centers, legal, meetings, procedures. + +### Audio input: URL only + +**`audio_file_blob`** must be a **URL** (string or `{ url: "..." }`). File paths and Buffers are not supported (OpenFn/Lightning has no filesystem). Store audio in external storage, get a signed or public URL, and pass it in state (e.g. `state.data.signedUrl`). Optional URL validation: set `configuration.validateUploadUrl: true` (see schema). + +### Basic example + +```js +uploadAudioFile({ + audio_file_name: 'patient_consultation_001', + audio_file_blob: state.data.signedUrl, +}); + +getFileStatus(state.data.file_id); +``` + +### File status + +`getFileStatus()` returns a `processing_status` (e.g. `FILE_QUEUED`, `FILE_PROCESSING`, `FILE_TRANSCRIBED`, or error statuses). See the [Sahara API docs](https://docs.voice.intron.io) for the full list. `uploadAndWaitForTranscription()` polls until `FILE_TRANSCRIBED` or an error. + +### Telehealth example + +```js +uploadAudioFile({ + audio_file_name: 'dr_smith_patient_john_doe', + audio_file_blob: state.data.signedUrl, + use_category: 'file_category_telehealth', + get_soap_note: 'TRUE', + get_summary: 'TRUE', + get_icd_codes: 'TRUE', +}); +``` + +### Upload and wait + +```js +uploadAndWaitForTranscription( + { + audio_file_name: 'chw_field_visit', + audio_file_blob: state.data.signedUrl, + use_category: 'file_category_telehealth', + get_soap_note: 'TRUE', + get_summary: 'TRUE', + }, + { pollInterval: 5000, maxAttempts: 60 } +); +``` + +### Other categories + +For call center or meeting notes, use `file_category_call_center` or `file_category_meeting_notes` with the corresponding `get_*` options. Categories include `file_category_general`, `file_category_telehealth`, `file_category_procedure`, `file_category_legal`. Optional: `use_diarization: 'TRUE'`, `use_template_id: 'template-uuid'`. See the [Sahara docs](https://docs.voice.intron.io) for the complete list. + +### URL validation + +When `configuration.validateUploadUrl` is `true`, the adaptor runs in-memory checks (HTTPS only, no IP/internal hosts, optional domain allowlist and extension hint). See [configuration-schema.json](configuration-schema.json). + +## Operations + +- **`uploadAudioFile()`** – Upload by URL with post-processing options +- **`getFileStatus()`** – Get transcription status and results +- **`uploadAndWaitForTranscription()`** – Upload and poll until complete +- **`get()`**, **`post()`** – Generic requests + +Uploads use undici via language-common; `audio_file_blob` is sent as a URL and the Sahara backend fetches the file. + +## Testing + +Unit tests mock HTTP with `enableMockClient` (undici). Integration examples in [examples/integration/](examples/integration/) call the live API. From repo root: + +```bash +openfn packages/sahara/examples/integration/1-test-basic-upload.js \ + -ma sahara \ + -s packages/sahara/tmp/sahara-state.json \ + -o packages/sahara/tmp/output.json +``` + +See [examples/integration/README.md](examples/integration/README.md) for state keys and script list. + +### Webhook pattern + +Common production flow: app POSTs audio to Sahara → Sahara webhook sends `file_id` to OpenFn → workflow calls `getFileStatus(state.data.file_id)` then sends results to OpenMRS/DHIS2. + +## Retry and limits + +The adaptor retries on 429 and 5xx with exponential backoff (default: 3 retries, 1s initial delay). Pass `maxRetries`, `retryDelay`, `retryOn429` in the options argument to customize. No retry on 401, 400, 404. + +API limits: 100MB max file size, 10 minutes max duration, 60 uploads/min, 100 status checks/min. + +## Development + +Clone the [adaptors monorepo](https://github.com/OpenFn/adaptors). Then: `pnpm build`, `pnpm test` (or `pnpm run test:watch`). + +## About Sahara + +Sahara (Intron Health) provides AI-powered voice transcription and clinical documentation. [Intron Health](https://intron.io) diff --git a/packages/sahara/assets/rectangle.png b/packages/sahara/assets/rectangle.png new file mode 100644 index 000000000..46abbb3a4 Binary files /dev/null and b/packages/sahara/assets/rectangle.png differ diff --git a/packages/sahara/assets/square.png b/packages/sahara/assets/square.png new file mode 100644 index 000000000..47ff65c0f Binary files /dev/null and b/packages/sahara/assets/square.png differ diff --git a/packages/sahara/ast.json b/packages/sahara/ast.json new file mode 100644 index 000000000..7f985657b --- /dev/null +++ b/packages/sahara/ast.json @@ -0,0 +1,1161 @@ +{ + "operations": [ + { + "name": "uploadAudioFile", + "params": [ + "uploadData", + "options" + ], + "docs": { + "description": "Upload an audio file for transcription. audio_file_blob must be a URL (string or { url }).", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "param", + "description": "Upload options and any post-processing flags", + "type": { + "type": "NameExpression", + "name": "UploadOptions" + }, + "name": "uploadData" + }, + { + "title": "param", + "description": "Retry options: maxRetries, retryDelay, retryOn429", + "type": { + "type": "OptionalType", + "expression": { + "type": "NameExpression", + "name": "object" + } + }, + "name": "options" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Operation" + } + }, + { + "title": "state", + "description": "{SaharaState}" + } + ] + }, + "valid": true + }, + { + "name": "getFileStatus", + "params": [ + "fileId", + "options" + ], + "docs": { + "description": "Get transcription status and results for a file.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "param", + "description": "File ID from upload response", + "type": { + "type": "NameExpression", + "name": "string" + }, + "name": "fileId" + }, + { + "title": "param", + "description": "Optional query (e.g. get_structured_post_processing) and retry options", + "type": { + "type": "OptionalType", + "expression": { + "type": "NameExpression", + "name": "object" + } + }, + "name": "options" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Operation" + } + }, + { + "title": "state", + "description": "{SaharaState}" + } + ] + }, + "valid": true + }, + { + "name": "uploadAndWaitForTranscription", + "params": [ + "uploadData", + "waitOptions" + ], + "docs": { + "description": "Upload and poll until transcription completes.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "param", + "description": "Same as uploadAudioFile", + "type": { + "type": "NameExpression", + "name": "UploadOptions" + }, + "name": "uploadData" + }, + { + "title": "param", + "description": "pollInterval (ms), maxAttempts", + "type": { + "type": "OptionalType", + "expression": { + "type": "NameExpression", + "name": "object" + } + }, + "name": "waitOptions" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Operation" + } + }, + { + "title": "state", + "description": "{SaharaState}" + } + ] + }, + "valid": true + }, + { + "name": "get", + "params": [ + "path", + "options" + ], + "docs": { + "description": "GET request to the API.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "param", + "description": "Path to resource", + "type": { + "type": "NameExpression", + "name": "string" + }, + "name": "path" + }, + { + "title": "param", + "description": "Optional request/retry options", + "type": { + "type": "OptionalType", + "expression": { + "type": "NameExpression", + "name": "object" + } + }, + "name": "options" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Operation" + } + }, + { + "title": "state", + "description": "{SaharaState}" + } + ] + }, + "valid": true + }, + { + "name": "post", + "params": [ + "path", + "body", + "options" + ], + "docs": { + "description": "POST request to the API.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "param", + "description": "Path to resource", + "type": { + "type": "NameExpression", + "name": "string" + }, + "name": "path" + }, + { + "title": "param", + "description": "Request body", + "type": { + "type": "NameExpression", + "name": "object" + }, + "name": "body" + }, + { + "title": "param", + "description": "Optional request/retry options", + "type": { + "type": "OptionalType", + "expression": { + "type": "NameExpression", + "name": "object" + } + }, + "name": "options" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Operation" + } + }, + { + "title": "state", + "description": "{SaharaState}" + } + ] + }, + "valid": true + } + ], + "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": "function", + "description": null, + "name": null + }, + { + "title": "example", + "description": "fn(state => {\n // do some things to state\n return state;\n});" + }, + { + "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": "fnIf", + "params": [ + "condition", + "operation" + ], + "docs": { + "description": "Execute a function only when the condition returns true", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "example", + "description": "fnIf((state) => state?.data?.name, get(\"https://example.com\"));" + }, + { + "title": "param", + "description": "The condition that returns true", + "type": { + "type": "NameExpression", + "name": "Boolean" + }, + "name": "condition" + }, + { + "title": "param", + "description": "The operation needed to be executed.", + "type": { + "type": "NameExpression", + "name": "Operation" + }, + "name": "operation" + }, + { + "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": "function", + "description": null, + "name": null + }, + { + "title": "example", + "description": "sourceValue('$.key')" + }, + { + "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": "function", + "description": null, + "name": null + }, + { + "title": "example", + "description": "dataPath('key')" + }, + { + "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": "function", + "description": null, + "name": null + }, + { + "title": "example", + "description": "dataValue('key')" + }, + { + "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": "function", + "description": null, + "name": null + }, + { + "title": "example", + "description": "lastReferenceValue('key')" + }, + { + "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": "Iterates over an array of items and invokes an operation upon each one, where the state\nobject is _scoped_ so that state.data is the item under iteration.\nThe rest of the state object is untouched and can be referenced as usual.\nYou can pass an array directly, or use lazy state or a JSONPath string to\nreference a slice of state.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "example", + "description": "each(\n $.data,\n // Inside the callback operation, `$.data` is scoped to the item under iteration\n insert(\"patient\", {\n patient_name: $.data.properties.case_name,\n patient_id: $.data.case_id,\n })\n);", + "caption": "Using lazy state ($) to iterate over items in state.data and pass each into an \"insert\" operation" + }, + { + "title": "example", + "description": "each(\n $.data,\n insert(\"patient\", (state) => ({\n patient_id: state.data.case_id,\n ...state.data\n }))\n);", + "caption": "Iterate over items in state.data and pass each one into an \"insert\" operation" + }, + { + "title": "example", + "description": "each(\n \"$.data[*]\",\n insert(\"patient\", (state) => ({\n patient_name: state.data.properties.case_name,\n patient_id: state.data.case_id,\n }))\n);", + "caption": "Using JSON path to iterate over items in state.data and pass each one into an \"insert\" operation" + }, + { + "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": "combine", + "params": [ + "operations" + ], + "docs": { + "description": "Combines two operations into one", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "example", + "description": "combine(\n create('foo'),\n delete('bar')\n)" + }, + { + "title": "param", + "description": "Operations to be performed.", + "type": { + "type": "NameExpression", + "name": "Operations" + }, + "name": "operations" + }, + { + "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": "function", + "description": null, + "name": null + }, + { + "title": "example", + "description": "field('destination_field_name__c', 'value')" + }, + { + "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": "function", + "description": null, + "name": null + }, + { + "title": "example", + "description": "fields(list_of_fields)" + }, + { + "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": "public", + "description": null, + "type": 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 + }, + { + "name": "group", + "params": [ + "arrayOfObjects", + "keyPath", + "callback" + ], + "docs": { + "description": "Groups an array of objects by a specified key path.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "example", + "description": "const users = [\n { name: 'Alice', age: 25, city: 'New York' },\n { name: 'Bob', age: 30, city: 'San Francisco' },\n { name: 'Charlie', age: 25, city: 'New York' },\n { name: 'David', age: 30, city: 'San Francisco' }\n];\ngroup(users, 'city');\n// state is { data: { 'New York': [/Alice, Charlie/], 'San Francisco': [ /Bob, David / ] }" + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "param", + "description": "The array of objects to be grouped.", + "type": { + "type": "TypeApplication", + "expression": { + "type": "NameExpression", + "name": "Array" + }, + "applications": [ + { + "type": "NameExpression", + "name": "Object" + } + ] + }, + "name": "arrayOfObjects" + }, + { + "title": "param", + "description": "The key path to group by.", + "type": { + "type": "NameExpression", + "name": "string" + }, + "name": "keyPath" + }, + { + "title": "param", + "description": "(Optional) Callback function", + "type": { + "type": "NameExpression", + "name": "function" + }, + "name": "callback" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Operation" + } + } + ] + }, + "valid": true + }, + { + "name": "scrubEmojis", + "params": [ + "text", + "replacementChars" + ], + "docs": { + "description": "Replaces emojis in a string.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "example", + "description": "scrubEmojis('Dove🕊️⭐ 29')" + }, + { + "title": "param", + "description": "String that needs to be cleaned", + "type": { + "type": "NameExpression", + "name": "string" + }, + "name": "text" + }, + { + "title": "param", + "description": "Characters that replace the emojis", + "type": { + "type": "NameExpression", + "name": "string" + }, + "name": "replacementChars" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "string" + } + } + ] + }, + "valid": true + }, + { + "name": "cursor", + "params": [ + "value", + "options" + ], + "docs": { + "description": "Sets a cursor property on state.\nSupports natural language dates like `now`, `today`, `yesterday`, `n hours ago`, `n days ago`, and `start`,\nwhich will be converted relative to the environment (ie, the Lightning or CLI locale). Custom timezones\nare not yet supported.\nYou can provide a formatter to customise the final cursor value, which is useful for normalising\ndifferent inputs. The custom formatter runs after natural language date conversion.\nSee the usage guide at {@link https://docs.openfn.org/documentation/jobs/job-writing-guide#using-cursors}", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "example", + "description": "cursor($.cursor, { defaultValue: 'today' })", + "caption": "Use a cursor from state if present, or else use the default value" + }, + { + "title": "example", + "description": "cursor(22)", + "caption": "Use a pagination cursor" + }, + { + "title": "param", + "description": "the cursor value. Usually an ISO date, natural language date, or page number", + "type": { + "type": "NameExpression", + "name": "any" + }, + "name": "value" + }, + { + "title": "param", + "description": "options to control the cursor.", + "type": { + "type": "NameExpression", + "name": "object" + }, + "name": "options" + }, + { + "title": "param", + "description": "set the cursor key. Will persist through the whole run.", + "type": { + "type": "NameExpression", + "name": "string" + }, + "name": "options.key" + }, + { + "title": "param", + "description": "the value to use if value is falsy", + "type": { + "type": "NameExpression", + "name": "any" + }, + "name": "options.defaultValue" + }, + { + "title": "param", + "description": "custom formatter for the final cursor value", + "type": { + "type": "NameExpression", + "name": "Function" + }, + "name": "options.format" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Operation" + } + } + ] + }, + "valid": false + }, + { + "name": "as", + "params": [ + "key", + "operation" + ], + "docs": { + "description": "Run an operation and save the result to a custom key in state instead of overwriting state.data.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "example", + "description": "as('cceData', collections.get('cce-data-dhis2', { key: `*:*:${$.syncedAt}*` }));", + "caption": "Fetch cce-data from collections and store them under state.cceData" + }, + { + "title": "param", + "description": "The state key to assign the result of the operation to.", + "type": { + "type": "NameExpression", + "name": "string" + }, + "name": "key" + }, + { + "title": "param", + "description": " An operation that returns a new state object with a `data` property", + "type": { + "type": "NameExpression", + "name": "function" + }, + "name": "operation" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "Operation" + } + } + ] + }, + "valid": true + }, + { + "name": "map", + "params": {}, + "docs": { + "description": "Iterates over a collection of items and returns a new array of mapped values,\nlike Javascript's `Array.map()` function.\n\nEach item in the source array will be passed into the callback function. The returned value\nwill be added to the new array. The callback is passed the original item, the current index\nin the source array (ie, the nth item number), and the state object.\n\nWrites a new array to `state.data` with transformed values.c array.", + "tags": [ + { + "title": "public", + "description": null, + "type": null + }, + { + "title": "function", + "description": null, + "name": null + }, + { + "title": "example", + "description": "map($.items', (data, index, state) => {\n return {\n id: index + 1,\n name: data.name,\n createdAt: state.cursor,\n };\n});", + "caption": "Transform an array of items in state" + }, + { + "title": "example", + "description": "map($.items, async (data, index, state) => {\n const userInfo = await fetchUserInfo(data.userId);\n return {\n id: index + 1,\n name: data.name,\n extra: userInfo,\n };\n});", + "caption": "Map items asynchronously (e.g. fetch extra info)" + }, + { + "title": "param", + "description": "An array of items or a a JSONPath string which points to an array of items.", + "type": { + "type": "UnionType", + "elements": [ + { + "type": "NameExpression", + "name": "string" + }, + { + "type": "NameExpression", + "name": "Array" + } + ] + }, + "name": "path" + }, + { + "title": "param", + "description": "The mapping function, invoked with `(data, index, state)` for each item in the array.", + "type": { + "type": "NameExpression", + "name": "function" + }, + "name": "callback" + }, + { + "title": "returns", + "description": null, + "type": { + "type": "NameExpression", + "name": "State" + } + } + ] + }, + "valid": false + } + ] +} \ No newline at end of file diff --git a/packages/sahara/configuration-schema.json b/packages/sahara/configuration-schema.json new file mode 100644 index 000000000..885eb329a --- /dev/null +++ b/packages/sahara/configuration-schema.json @@ -0,0 +1,49 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "properties": { + "baseUrl": { + "title": "Base URL", + "type": "string", + "description": "The Sahara API base URL", + "format": "uri", + "minLength": 1, + "default": "https://infer.voice.intron.io", + "examples": ["https://infer.voice.intron.io"] + }, + "apiKey": { + "title": "API Key", + "type": "string", + "description": "Your Sahara API key for authentication", + "writeOnly": true, + "minLength": 1, + "examples": ["your-api-key-here"] + }, + "validateUploadUrl": { + "title": "Validate upload URL", + "type": "boolean", + "description": "When true, validate audio_file_blob URLs: HTTPS-only, valid format, no IP or internal hosts, and optional domain allowlist. No network or file I/O.", + "default": false + }, + "allowedUrlDomains": { + "title": "Allowed URL domains", + "type": "array", + "items": { "type": "string" }, + "description": "Allowed hostnames for URL uploads (e.g. s3.amazonaws.com). Used only when validateUploadUrl is true. Subdomains match (e.g. bucket.s3.amazonaws.com matches s3.amazonaws.com)." + }, + "allowedUrlExtensions": { + "title": "Allowed URL extensions", + "type": "array", + "items": { "type": "string" }, + "description": "Weak hint only: URL pathname must end with one of these (e.g. .wav, .mp3). Does not verify actual file content; backend validates type when processing." + }, + "requireExpiryParam": { + "title": "Require expiry parameter", + "type": "boolean", + "description": "When true (and validateUploadUrl is true), URL must include an expiry query parameter (e.g. X-Amz-Expires, Expires).", + "default": false + } + }, + "type": "object", + "additionalProperties": true, + "required": ["apiKey"] +} diff --git a/packages/sahara/examples/integration/1-test-basic-upload.js b/packages/sahara/examples/integration/1-test-basic-upload.js new file mode 100644 index 000000000..ee7986b2d --- /dev/null +++ b/packages/sahara/examples/integration/1-test-basic-upload.js @@ -0,0 +1,22 @@ +/** + * Test 1: Basic File Upload (URL-based) + * + * Uploads an audio file to Sahara using a URL (e.g. signed S3 or SharePoint link). + * Set the URL in your state file under data.signedUrlBasic. + * + * Expected output: + * - file_id in state.data + * - status: "Ok" + * - message: "file queued for processing" + */ + +uploadAudioFile({ + audio_file_name: 'test_basic_upload', + audio_file_blob: state.data.signedUrlBasic, + use_category: 'file_category_general', + get_summary: 'TRUE' +}); + +// After this runs, inspect the output file you passed via -o (e.g. tmp/sahara-outputs/1-basic-upload.json). +// Grab the file_id from that JSON if you want to run 2-test-file-status.js next. + diff --git a/packages/sahara/examples/integration/2-test-file-status.js b/packages/sahara/examples/integration/2-test-file-status.js new file mode 100644 index 000000000..1e4cbe2cf --- /dev/null +++ b/packages/sahara/examples/integration/2-test-file-status.js @@ -0,0 +1,19 @@ +/** + * Test 2: Get File Status + * + * This test retrieves the transcription status and results. + * Replace 'YOUR_FILE_ID_HERE' with the file_id from Test 1. + * + * Expected output when complete: + * - processing_status: "FILE_TRANSCRIBED" + * - audio_transcript: "..." (the transcribed text) + * - transcript_summary: "..." (if get_summary was used) + */ + +getFileStatus('YOUR_FILE_ID_HERE', { + // Optional: Get structured JSON output instead of markdown + get_structured_post_processing: 't' +}); + +// If status is "PROCESSING" or "QUEUED", wait a few seconds and try again + diff --git a/packages/sahara/examples/integration/3-test-telehealth-full.js b/packages/sahara/examples/integration/3-test-telehealth-full.js new file mode 100644 index 000000000..9bb5201ef --- /dev/null +++ b/packages/sahara/examples/integration/3-test-telehealth-full.js @@ -0,0 +1,40 @@ +/** + * Test 3: Healthcare/Telehealth Full Workflow + * + * This test demonstrates uploading a medical consultation audio + * with comprehensive post-processing for healthcare use cases. + * + * Useful for: Doctor consultations, patient visits, clinical documentation + */ + +uploadAndWaitForTranscription({ + audio_file_name: 'doctor_patient_consultation', + audio_file_blob: state.data.signedUrlTelehealth, + use_category: 'file_category_telehealth', + + // Request all medical post-processing features + get_summary: 'TRUE', // Brief summary + get_soap_note: 'TRUE', // SOAP note (Subjective, Objective, Assessment, Plan) + get_entity_list: 'TRUE', // Medical entities (symptoms, medications, etc.) + get_treatment_plan: 'TRUE', // Treatment recommendations + get_clerking: 'TRUE', // Medical clerking notes + get_icd_codes: 'TRUE', // ICD-11/SNOMED/CPT billing codes + get_suggestions: 'TRUE', // Important questions/instructions for patient + get_differential_diagnosis: 'TRUE', // Possible diagnoses to consider + get_followup_instructions: 'TRUE', // Follow-up care instructions + get_practice_guidelines: 'TRUE' // Relevant medical guidelines +}, { + pollInterval: 5000, + maxAttempts: 300 +}); + +// Expected output structure (when you check status later): +// { +// "processing_status": "FILE_TRANSCRIBED", +// "audio_transcript": "Full transcript...", +// "transcript_soap_note": "SOAP Note:\n\nSubjective:\n...", +// "transcript_icd_codes": "ICD-11: ...", +// "transcript_summary": "Patient presented with...", +// ... +// } + diff --git a/packages/sahara/examples/integration/4-test-with-diarization.js b/packages/sahara/examples/integration/4-test-with-diarization.js new file mode 100644 index 000000000..fff557708 --- /dev/null +++ b/packages/sahara/examples/integration/4-test-with-diarization.js @@ -0,0 +1,28 @@ +/** + * Test 4: Speaker Diarization + * + * This test enables speaker diarization to identify different speakers + * in the audio (e.g., doctor vs patient, multiple participants) + */ + +uploadAndWaitForTranscription({ + audio_file_name: 'multi_speaker_conversation', + audio_file_blob: state.data.signedUrlDiarization, + use_category: 'file_category_call_center', + use_diarization: 'TRUE', + get_summary: 'TRUE', + get_call_center_sentiment: 'TRUE' +}, { + pollInterval: 5000, + maxAttempts: 300, + + // Retry configuration for the upload + maxRetries: 3, + retryDelay: 2000 +}); + +// When you check the status later, the audio_transcript will be formatted like: +// "SPEAKER_01: Hello, how are you feeling today? +// SPEAKER_02: I've been having some headaches. +// SPEAKER_01: How long have you had these headaches?" + diff --git a/packages/sahara/examples/integration/5-test-call-center.js b/packages/sahara/examples/integration/5-test-call-center.js new file mode 100644 index 000000000..681de20a7 --- /dev/null +++ b/packages/sahara/examples/integration/5-test-call-center.js @@ -0,0 +1,34 @@ +/** + * Test 5: Call Center Analytics + * + * This test demonstrates call center audio processing with + * agent scoring, sentiment analysis, and compliance checks. + */ + +uploadAndWaitForTranscription({ + audio_file_name: `call_center_analysis_${Date.now()}`, + audio_file_blob: state.data.signedUrlCallCenter, + use_category: 'file_category_call_center', + + // Call center specific post-processing + get_summary: 'TRUE', + get_call_center_results: 'TRUE', // Call resolution details + get_call_center_agent_score: 'TRUE', // Agent performance score + get_call_center_agent_score_category: 'TRUE', // Performance assessment + get_call_center_product_info: 'TRUE', // Products discussed + get_call_center_product_insights: 'TRUE', // Customer feedback + get_call_center_compliance: 'TRUE', // Compliance verification + get_call_center_feedback: 'TRUE', // Agent feedback + get_call_center_sentiment: 'TRUE' // Caller sentiment +}, { + pollInterval: 5000, + maxAttempts: 300 +}); + +// Expected output includes: +// - Agent score (numerical + categorical) +// - Call resolution status +// - Compliance check results +// - Customer sentiment analysis +// - Product feedback and insights + diff --git a/packages/sahara/examples/integration/6-test-meeting-notes.js b/packages/sahara/examples/integration/6-test-meeting-notes.js new file mode 100644 index 000000000..0a1a55865 --- /dev/null +++ b/packages/sahara/examples/integration/6-test-meeting-notes.js @@ -0,0 +1,30 @@ +/** + * Test 6: Meeting Notes + * + * This test extracts structured meeting notes including + * participants, decisions, and action items. + */ + +uploadAndWaitForTranscription({ + audio_file_name: `meeting_notes_${Date.now()}`, + audio_file_blob: state.data.signedUrlMeeting, + use_category: 'file_category_meeting_notes', + + // Meeting-specific post-processing + get_summary: 'TRUE', + get_meeting_notes_participants: 'TRUE', // List of participants and roles + get_meeting_notes_decisions: 'TRUE', // Key decisions made + get_meeting_notes_action_items: 'TRUE', // Action items with owners + get_meeting_notes_key_topics: 'TRUE', // Main topics discussed + get_meeting_notes_next_steps: 'TRUE' // Follow-up steps +}, { + pollInterval: 5000, + maxAttempts: 300 +}); + +// Perfect for: +// - Team meetings +// - Board meetings +// - Project planning sessions +// - Stakeholder updates + diff --git a/packages/sahara/examples/integration/7-test-procedure.js b/packages/sahara/examples/integration/7-test-procedure.js new file mode 100644 index 000000000..53d9325dd --- /dev/null +++ b/packages/sahara/examples/integration/7-test-procedure.js @@ -0,0 +1,19 @@ +/** + * Test 7: Procedure Category (Upload & Wait) + * Uploads a surgical procedure recording and waits until processing finishes. + */ + +uploadAndWaitForTranscription({ + audio_file_name: `procedure_report_${Date.now()}`, + audio_file_blob: state.data.signedUrlProcedure, + use_category: 'file_category_procedure', + get_summary: 'TRUE', + get_entity_list: 'TRUE', + get_op_note: 'TRUE', + get_icd_codes: 'TRUE', + get_treatment_plan: 'TRUE', + get_suggestions: 'TRUE' +}, { + pollInterval: 5000, + maxAttempts: 300 +}); diff --git a/packages/sahara/examples/integration/8-test-legal.js b/packages/sahara/examples/integration/8-test-legal.js new file mode 100644 index 000000000..3ac087eec --- /dev/null +++ b/packages/sahara/examples/integration/8-test-legal.js @@ -0,0 +1,15 @@ +/** + * Test 8: Legal Category (Upload & Wait) + * Uploads a legal/court hearing recording and waits for transcription. + */ + +uploadAndWaitForTranscription({ + audio_file_name: `legal_hearing_${Date.now()}`, + audio_file_blob: state.data.signedUrlLegal, + use_category: 'file_category_legal', + get_summary: 'TRUE', + get_legal_court_hearing: 'TRUE' +}, { + pollInterval: 5000, + maxAttempts: 300 +}); diff --git a/packages/sahara/examples/integration/README.md b/packages/sahara/examples/integration/README.md new file mode 100644 index 000000000..174fcd531 --- /dev/null +++ b/packages/sahara/examples/integration/README.md @@ -0,0 +1,84 @@ +# Sahara – Integration Scripts + +Runnable jobs that call the live Sahara API (URL-based uploads, polling, categories). Use your own credentials and audio URLs. + +## Setup + +1. **Create a local state file** (from repo root): + ```bash + mkdir -p packages/sahara/tmp + cp packages/sahara/examples/integration/state.template.json packages/sahara/tmp/sahara-state.json + ``` + Edit _the copy_ at `packages/sahara/tmp/sahara-state.json` (not the template): replace `YOUR_SAHARA_API_KEY` with your real API key, and set the **URL** for each scenario you want to run. The state template has one key per script: + - `signedUrlBasic` → 1-test-basic-upload.js + - `signedUrlTelehealth` → 3-test-telehealth-full.js + - `signedUrlDiarization` → 4-test-with-diarization.js + - `signedUrlCallCenter` → 5-test-call-center.js + - `signedUrlMeeting` → 6-test-meeting-notes.js + - `signedUrlProcedure` → 7-test-procedure.js + - `signedUrlLegal` → 8-test-legal.js + Use signed HTTPS URLs. Supported formats include WAV, MP3, MP4, M4A, OGG, WebM, and FLAC (up to 100 MB, ~10 min). + +2. Optional: `mkdir -p packages/sahara/tmp/sahara-outputs` for output files. + +## Run + +From repo root (so `-ma sahara` loads the local adaptor): + +```bash +openfn packages/sahara/examples/integration/1-test-basic-upload.js \ + -ma sahara \ + -s packages/sahara/tmp/sahara-state.json \ + -o packages/sahara/tmp/sahara-outputs/1-basic-upload.json + +# Jobs that poll until transcription completes often need a longer timeout +openfn packages/sahara/examples/integration/3-test-telehealth-full.js \ + -ma sahara \ + -s packages/sahara/tmp/sahara-state.json \ + -o packages/sahara/tmp/sahara-outputs/3-telehealth.json \ + --timeout 1200000 +``` + +Output goes to the file passed with `-o`. Inspect with `jq`: + +```bash +jq . packages/sahara/tmp/sahara-outputs/3-telehealth.json +``` + +## Script Catalog + +| File | Focus | Typical Scenario | +| --- | --- | --- | +| `1-test-basic-upload.js` | Upload + summary | Smoke test / general | +| `2-test-file-status.js` | Poll a known `file_id` | Recheck previous uploads | +| `3-test-telehealth-full.js` | `uploadAndWaitForTranscription` with SOAP note | Telehealth consult | +| `4-test-with-diarization.js` | Multi-speaker diarization | Panel interview / group visit | +| `5-test-call-center.js` | Sentiment + agent scoring | Call centre QA | +| `6-test-meeting-notes.js` | Meeting action items | Team/board meetings | +| `7-test-procedure.js` | Operation note (`get_op_note`) | Surgical documentation | +| `8-test-legal.js` | Court hearing format | Legal / compliance reviews | +| `check-latest-upload.js` | Fetch most recent file | Handy when testing outside OpenFn | + +- **Two-step**: Run script 1, get `file_id` from output, then run script 2 with that ID. +- **One-step**: Scripts 3–8 use `uploadAndWaitForTranscription` (upload + poll until `FILE_TRANSCRIBED`). + +## Output Cheatsheet + +- `data.file_id`: UUID returned immediately after a successful upload. +- `data.processing_status`: `QUEUED`, `PROCESSING`, or `FILE_TRANSCRIBED`. +- Category-specific fields: + - Telehealth: `transcript_soap_note`, `transcript_icd_codes`, `transcript_treatment_plan`, etc. + - Call centre: `transcript_call_center_*` metrics. + - Meetings: `transcript_meeting_notes_*` sections. + - Legal: `transcript_legal_court_hearing`. + - Procedure: `transcript_op_note`. + +## Troubleshooting + +- **401**: Check API key in your state file. +- **413**: File over 100 MB; trim or compress. +- **429**: Adaptor retries with backoff. +- **Polling timeout**: Increase the CLI timeout (for example `--timeout 1800000` for 30 minutes). + +See `packages/sahara/README.md` and [Sahara docs](https://docs.voice.intron.io). + diff --git a/packages/sahara/examples/integration/check-latest-upload.js b/packages/sahara/examples/integration/check-latest-upload.js new file mode 100644 index 000000000..e6eb73c70 --- /dev/null +++ b/packages/sahara/examples/integration/check-latest-upload.js @@ -0,0 +1,5 @@ +// Check status of the file you just uploaded +getFileStatus('YOUR_FILE_ID_HERE', { + get_structured_post_processing: 't' +}); + diff --git a/packages/sahara/examples/integration/state.template.json b/packages/sahara/examples/integration/state.template.json new file mode 100644 index 000000000..e51c30d61 --- /dev/null +++ b/packages/sahara/examples/integration/state.template.json @@ -0,0 +1,15 @@ +{ + "configuration": { + "apiKey": "YOUR_SAHARA_API_KEY", + "baseUrl": "https://infer.voice.intron.io" + }, + "data": { + "signedUrlBasic": "https://example.com/audio-basic.wav", + "signedUrlTelehealth": "https://example.com/audio-telehealth.wav", + "signedUrlDiarization": "https://example.com/audio-diarization.wav", + "signedUrlCallCenter": "https://example.com/audio-call-center.wav", + "signedUrlMeeting": "https://example.com/audio-meeting.wav", + "signedUrlProcedure": "https://example.com/audio-procedure.wav", + "signedUrlLegal": "https://example.com/audio-legal.wav" + } +} diff --git a/packages/sahara/package.json b/packages/sahara/package.json new file mode 100644 index 000000000..598f81c32 --- /dev/null +++ b/packages/sahara/package.json @@ -0,0 +1,47 @@ +{ + "name": "@openfn/language-sahara", + "version": "1.0.0", + "description": "OpenFn sahara adaptor", + "type": "module", + "exports": { + ".": { + "import": "./dist/index.js", + "types": "./types/index.d.ts", + "require": "./dist/index.cjs" + }, + "./package.json": "./package.json" + }, + "scripts": { + "build": "pnpm clean && build-adaptor sahara", + "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:*", + "undici": "6.20.1" + }, + "devDependencies": { + "assertion-error": "2.0.0", + "chai": "4.3.6", + "deep-eql": "4.1.1", + "mocha": "^10.7.3", + "rimraf": "3.0.2" + }, + "repository": { + "type": "git", + "url": "https://github.com/openfn/adaptors.git" + }, + "types": "types/index.d.ts", + "main": "dist/index.cjs" +} diff --git a/packages/sahara/src/Adaptor.js b/packages/sahara/src/Adaptor.js new file mode 100644 index 000000000..44278a82c --- /dev/null +++ b/packages/sahara/src/Adaptor.js @@ -0,0 +1,324 @@ +import { expandReferences } from '@openfn/language-common/util'; +import * as util from './Utils.js'; +import { validateUploadUrl } from './validateUrl.js'; + +/** + * State object + * @typedef {Object} SaharaState + * @property data - the parsed response body + * @property response - the response from the HTTP server, including headers, statusCode, body, etc + * @property references - an array of all previous data objects used in the Job + **/ + +/** + * @typedef {Object} UploadOptions + * @property {string} audio_file_name - Name for the uploaded file (required) + * @property {string|{url: string}} audio_file_blob - URL or { url } (required). See Sahara docs for post-processing options. + */ + +/** + * Upload an audio file for transcription. audio_file_blob must be a URL (string or { url }). + * @public + * @function + * @param {UploadOptions} uploadData - Upload options and any post-processing flags + * @param {object} [options] - Retry options: maxRetries, retryDelay, retryOn429 + * @returns {Operation} + * @state {SaharaState} + */ +export function uploadAudioFile(uploadData, options = {}) { + return async state => { + const [resolvedUploadData, resolvedOptions] = expandReferences( + state, + uploadData, + options + ); + + const { + audio_file_name, + audio_file_blob, + ...uploadOptions + } = resolvedUploadData; + + if (!audio_file_name) { + throw new Error('audio_file_name is required'); + } + + if (!audio_file_blob) { + throw new Error('audio_file_blob is required'); + } + + // Normalize to URL string only (no file paths or Buffers — OpenFn/Lightning compatible) + const urlString = + typeof audio_file_blob === 'string' + ? audio_file_blob + : audio_file_blob && typeof audio_file_blob.url === 'string' + ? audio_file_blob.url + : null; + + if ( + !urlString || + (!urlString.startsWith('http://') && !urlString.startsWith('https://')) + ) { + throw new Error( + 'audio_file_blob must be a URL string (http:// or https://) or an object with a url property (e.g. { url: state.data.signedUrl }). File paths and Buffers are not supported.' + ); + } + + if (state.configuration?.validateUploadUrl === true) { + validateUploadUrl(urlString, state.configuration || {}); + } + + const urlPreview = + urlString.slice(0, 60) + (urlString.length > 60 ? '...' : ''); + console.log(`Uploading audio file: ${audio_file_name} (blob: ${urlPreview})`); + + const formData = { + audio_file_name, + audio_file_blob: urlString, + ...uploadOptions, + }; + + const retryOptions = { + maxRetries: resolvedOptions.maxRetries, + retryDelay: resolvedOptions.retryDelay, + retryOn429: resolvedOptions.retryOn429, + }; + + const response = await util.uploadFile( + state.configuration, + '/file/v1/upload', + formData, + retryOptions + ); + + console.log( + `File queued successfully. File ID: ${response.body?.data?.file_id}` + ); + + return util.prepareNextState(state, response); + }; +} + +/** + * Get transcription status and results for a file. + * @public + * @function + * @param {string} fileId - File ID from upload response + * @param {object} [options] - Optional query (e.g. get_structured_post_processing) and retry options + * @returns {Operation} + * @state {SaharaState} + */ +export function getFileStatus(fileId, options = {}) { + return async state => { + const [resolvedFileId, resolvedOptions] = expandReferences( + state, + fileId, + options + ); + + if (!resolvedFileId) { + throw new Error('fileId is required'); + } + + console.log(`Fetching status for file ID: ${resolvedFileId}`); + + const queryParams = {}; + if (resolvedOptions.get_structured_post_processing) { + queryParams.get_structured_post_processing = + resolvedOptions.get_structured_post_processing; + } + + const response = await util.request( + state.configuration, + 'GET', + `/file/v1/status/${resolvedFileId}`, + { + query: queryParams, + } + ); + + const processingStatus = response.body?.data?.processing_status; + console.log(`File processing status: ${processingStatus}`); + + if (processingStatus === 'FILE_QUEUED') { + console.log('⏳ File is queued for processing'); + } else if (processingStatus === 'FILE_PENDING') { + console.log('⏳ File is pending processing'); + } else if (processingStatus === 'FILE_PROCESSING') { + console.log('⏳ File is still being processed'); + } else if (processingStatus === 'FILE_TRANSCRIBED') { + console.log('✓ Transcription completed successfully'); + } else if (processingStatus === 'FILE_INVALID') { + console.log('✗ File is invalid'); + } else if (processingStatus === 'FILE_INVALID_SIZE') { + console.log('✗ File size is invalid'); + } else if (processingStatus === 'FILE_INVALID_DURATION') { + console.log('✗ File duration is invalid'); + } else if (processingStatus === 'FILE_PROCESSING_FAILED') { + console.log('✗ File processing failed'); + } else if (processingStatus === 'FILE_PROCESSING_TIMEOUT') { + console.log('✗ File processing timed out'); + } else if (processingStatus === 'FILE_PROCESSING_CANCELLED') { + console.log('✗ File processing was cancelled'); + } + + return util.prepareNextState(state, response); + }; +} + +/** + * Upload and poll until transcription completes. + * @public + * @function + * @param {UploadOptions} uploadData - Same as uploadAudioFile + * @param {object} [waitOptions] - pollInterval (ms), maxAttempts + * @returns {Operation} + * @state {SaharaState} + */ +export function uploadAndWaitForTranscription(uploadData, waitOptions = {}) { + return async state => { + const { pollInterval = 3000, maxAttempts = 100 } = waitOptions; + + // First upload the file + const uploadState = await uploadAudioFile(uploadData)(state); + + const fileId = uploadState.data?.data?.file_id || uploadState.data?.file_id; + + if (!fileId) { + console.error('Upload state structure:', JSON.stringify(uploadState.data, null, 2)); + throw new Error('Failed to get file_id from upload response'); + } + + console.log(`Waiting for transcription to complete (polling every ${pollInterval}ms)...`); + + // Poll for completion + let attempts = 0; + let completed = false; + let finalState = uploadState; + + while (!completed && attempts < maxAttempts) { + attempts++; + + // Wait before polling + await new Promise(resolve => setTimeout(resolve, pollInterval)); + + // Check status + const statusState = await getFileStatus(fileId)(finalState); + const processingStatus = + statusState.data?.data?.processing_status ?? + statusState.data?.processing_status; + + if (processingStatus === 'FILE_TRANSCRIBED') { + console.log(`✓ Transcription completed after ${attempts} attempts`); + completed = true; + finalState = statusState; + } else if ( + processingStatus === 'FILE_INVALID' || + processingStatus === 'FILE_INVALID_SIZE' || + processingStatus === 'FILE_INVALID_DURATION' || + processingStatus === 'FILE_PROCESSING_FAILED' || + processingStatus === 'FILE_PROCESSING_TIMEOUT' || + processingStatus === 'FILE_PROCESSING_CANCELLED' + ) { + throw new Error(`Transcription failed with status: ${processingStatus}`); + } else { + // Continue polling for any other status (FILE_QUEUED, FILE_PENDING, FILE_PROCESSING, or unknown) + finalState = statusState; + console.log( + `Attempt ${attempts}/${maxAttempts}: Status is ${processingStatus || 'UNKNOWN'}` + ); + } + } + + if (!completed) { + throw new Error( + `Transcription did not complete within ${maxAttempts} attempts (${(maxAttempts * pollInterval) / 1000}s)` + ); + } + + return finalState; + }; +} + +/** + * GET request to the API. + * @public + * @function + * @param {string} path - Path to resource + * @param {object} [options] - Optional request/retry options + * @returns {Operation} + * @state {SaharaState} + */ +export function get(path, options) { + return async state => { + const [resolvedPath, resolvedOptions] = expandReferences( + state, + path, + options + ); + + const response = await util.request( + state.configuration, + 'GET', + resolvedPath, + resolvedOptions + ); + + return util.prepareNextState(state, response); + }; +} + +/** + * POST request to the API. + * @public + * @function + * @param {string} path - Path to resource + * @param {object} body - Request body + * @param {object} [options] - Optional request/retry options + * @returns {Operation} + * @state {SaharaState} + */ +export function post(path, body, options) { + return async state => { + const [resolvedPath, resolvedBody, resolvedOptions] = expandReferences( + state, + path, + body, + options + ); + + const response = await util.request( + state.configuration, + 'POST', + resolvedPath, + { + body: resolvedBody, + ...resolvedOptions, + } + ); + + return util.prepareNextState(state, response); + }; +} + +// Export common functions from language-common +export { + as, + combine, + cursor, + dataPath, + dataValue, + dateFns, + each, + field, + fields, + fn, + fnIf, + group, + lastReferenceValue, + map, + merge, + scrubEmojis, + sourceValue, + util, +} from '@openfn/language-common'; diff --git a/packages/sahara/src/Utils.js b/packages/sahara/src/Utils.js new file mode 100644 index 000000000..d308e47f6 --- /dev/null +++ b/packages/sahara/src/Utils.js @@ -0,0 +1,248 @@ +import { composeNextState } from '@openfn/language-common'; +import { + request as commonRequest, +} from '@openfn/language-common/util'; +import nodepath from 'node:path'; +import { FormData } from 'undici'; + +const sleep = ms => new Promise(resolve => setTimeout(resolve, ms)); + +export const prepareNextState = (state, response) => { + const { body, ...responseWithoutBody } = response; + + if (!state.references) { + state.references = []; + } + + return { + ...composeNextState(state, response.body), + response: responseWithoutBody, + }; +}; + +/** + * Authenticated request with retries (undici via language-common). + * @param {object} configuration - apiKey, baseUrl, optional tls + * @param {string} method - HTTP method + * @param {string} path - API path + * @param {object} [options] - Request options; maxRetries (3), retryDelay (1000), retryOn429 (true) + */ +export const request = async ( + configuration = {}, + method, + path, + options = {} +) => { + const { + baseUrl = 'https://infer.voice.intron.io', + apiKey, + tls = {} + } = configuration; + + if (!apiKey) { + throw new Error('apiKey is required in configuration'); + } + + const { + maxRetries = 3, + retryDelay = 1000, + retryOn429 = true, + ...requestOptions + } = options; + + const authHeader = { + Authorization: `Bearer ${apiKey}`, + }; + + const errors = { + 400: 'Bad Request - Invalid parameters', + 401: 'Unauthorized - Invalid API key', + 404: 'Resource not found', + 429: 'Rate limit exceeded - Please retry after a delay', + 500: 'Internal server error', + 502: 'Bad Gateway', + 503: 'Service Unavailable', + }; + + const opts = { + parseAs: 'json', + errors, + baseUrl, + ...requestOptions, + headers: { + ...authHeader, + ...requestOptions.headers, + }, + }; + + if (tls && Object.keys(tls).length > 0) { + opts.tls = tls; + } + + const safePath = nodepath.join(path); + + // Retry logic + let lastError; + for (let attempt = 0; attempt <= maxRetries; attempt++) { + try { + const response = await commonRequest(method, safePath, opts); + + if (attempt > 0) { + console.log(`✓ Request succeeded after ${attempt} retry attempt(s)`); + } + + return response; + } catch (error) { + lastError = error; + const shouldRetry = + attempt < maxRetries && + ((error.statusCode === 429 && retryOn429) || + error.statusCode >= 500 || + error.code === 'ECONNRESET' || + error.code === 'ETIMEDOUT' || + error.code === 'ENOTFOUND'); + + if (shouldRetry) { + const delay = retryDelay * Math.pow(2, attempt); + console.warn( + `Request failed (${error.statusCode || error.code}). Retrying in ${delay}ms... (attempt ${attempt + 1}/${maxRetries})` + ); + await sleep(delay); + } else { + throw error; + } + } + } + + throw lastError; +}; + +/** + * Upload form (multipart) to Sahara; audio_file_blob is sent as URL string. Uses undici via language-common. + * @param {object} configuration - apiKey, baseUrl, optional tls + * @param {string} path - e.g. /file/v1/upload + * @param {object} formData - audio_file_name, audio_file_blob (URL), other post-processing fields + * @param {object} [options] - maxRetries (3), retryDelay (2000), retryOn429 (true) + */ +export const uploadFile = async ( + configuration = {}, + path, + formData, + options = {} +) => { + const { + baseUrl = 'https://infer.voice.intron.io', + apiKey, + tls = {}, + } = configuration; + + if (!apiKey) { + throw new Error('apiKey is required in configuration'); + } + + const { + maxRetries = 3, + retryDelay = 2000, + retryOn429 = true, + } = options; + + const errorMessages = { + 400: 'Bad Request - Invalid file or parameters', + 401: 'Unauthorized - Invalid API key', + 413: 'File too large - Maximum 100MB', + 429: 'Rate limit exceeded - Maximum 30 requests per minute', + 500: 'Internal server error', + 502: 'Bad Gateway', + 503: 'Service Unavailable', + }; + + const form = new FormData(); + + if (!formData.audio_file_name) { + throw new Error('audio_file_name is required'); + } + form.append('audio_file_name', formData.audio_file_name); + + if (formData.audio_file_blob) { + const urlString = formData.audio_file_blob; + if ( + typeof urlString !== 'string' || + (!urlString.startsWith('http://') && !urlString.startsWith('https://')) + ) { + throw new Error( + 'audio_file_blob must be a URL string (http:// or https://). File paths and Buffers are not supported.' + ); + } + form.append('audio_file_blob', urlString); + } else { + throw new Error('audio_file_blob is required'); + } + + // Add other optional post-processing fields + for (const [key, value] of Object.entries(formData)) { + if (key !== 'audio_file_name' && key !== 'audio_file_blob') { + form.append(key, value); + } + } + + const url = `${baseUrl}${path}`; + const startTime = Date.now(); + + const requestOptions = { + baseUrl, + body: form, + headers: { + Authorization: `Bearer ${apiKey}`, + }, + errors: errorMessages, + timeout: 300000, // 5 minutes + parseAs: 'json', + }; + if (tls && Object.keys(tls).length > 0) { + requestOptions.tls = tls; + } + + let lastError; + for (let attempt = 0; attempt <= maxRetries; attempt++) { + try { + const response = await commonRequest('POST', path, requestOptions); + const duration = Date.now() - startTime; + if (attempt > 0) { + console.log(`✓ File upload succeeded after ${attempt} retry attempt(s)`); + } + console.log(`POST ${url} - ${response.statusCode} in ${duration}ms`); + return { + statusCode: response.statusCode, + statusMessage: response.statusMessage, + headers: response.headers, + body: response.body, + url, + method: 'POST', + duration, + }; + } catch (error) { + lastError = error; + const statusCode = error.statusCode; + const shouldRetry = + attempt < maxRetries && + ((statusCode === 429 && retryOn429) || + (statusCode >= 500) || + error.code === 'ECONNRESET' || + error.code === 'ETIMEDOUT' || + error.code === 'ENOTFOUND'); + + if (shouldRetry) { + const delay = retryDelay * Math.pow(2, attempt); + console.warn( + `File upload failed (${statusCode ?? error.code}). Retrying in ${delay}ms... (attempt ${attempt + 1}/${maxRetries})` + ); + await sleep(delay); + } else { + throw error; + } + } + } + + throw lastError; +}; + diff --git a/packages/sahara/src/index.js b/packages/sahara/src/index.js new file mode 100644 index 000000000..a013b3648 --- /dev/null +++ b/packages/sahara/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/sahara/src/validateUrl.js b/packages/sahara/src/validateUrl.js new file mode 100644 index 000000000..f0a675d31 --- /dev/null +++ b/packages/sahara/src/validateUrl.js @@ -0,0 +1,130 @@ +/** + * Lightweight URL validation for audio_file_blob upload URLs. + * Sync, in-memory only — no network or file I/O. Used when configuration.validateUploadUrl is true. + * @see plan: Sahara lightweight URL validation (validateUrl.js) + */ + +const MAX_URL_LENGTH = 2048; + +/** IPv4 octet pattern; full match implies valid dotted quad */ +const IPV4_REGEX = /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/; + +function isIPv4(hostname) { + const m = hostname.match(IPV4_REGEX); + if (!m) return false; + return m.slice(1, 5).every(octet => { + const n = parseInt(octet, 10); + return n >= 0 && n <= 255; + }); +} + +function isIPv6(hostname) { + return hostname.includes(':'); +} + +function isPrivateIPv4(hostname) { + const m = hostname.match(IPV4_REGEX); + if (!m) return false; + const [a, b, c] = m.slice(1, 5).map(s => parseInt(s, 10)); + if (a === 10) return true; + if (a === 172 && b >= 16 && b <= 31) return true; + if (a === 192 && b === 168) return true; + return false; +} + +function isInternalHost(hostname) { + const lower = hostname.toLowerCase(); + if (lower === 'localhost') return true; + if (lower === '127.0.0.1' || lower === '0.0.0.0' || lower === '[::1]') return true; + if (lower.endsWith('.local')) return true; + if (isIPv4(hostname) && isPrivateIPv4(hostname)) return true; + return false; +} + +function hostnameMatchesAllowlist(hostname, allowedDomains) { + const lower = hostname.toLowerCase(); + for (const domain of allowedDomains) { + const d = domain.toLowerCase().trim(); + if (!d) continue; + if (lower === d) return true; + if (lower.endsWith('.' + d)) return true; + } + return false; +} + +function pathnameEndsWithExtension(pathname, allowedExtensions) { + const lower = pathname.toLowerCase(); + for (const ext of allowedExtensions) { + const e = ext.startsWith('.') ? ext.toLowerCase() : '.' + ext.toLowerCase(); + if (lower.endsWith(e)) return true; + } + return false; +} + +/** + * Validate an upload URL when configuration.validateUploadUrl is true. + * Throws on failure; no return value on success. + * @param {string} urlString - The URL to validate (e.g. audio_file_blob value) + * @param {object} configuration - Adaptor configuration (validateUploadUrl, allowedUrlDomains, etc.) + * @throws {Error} When URL is invalid or fails any check + */ +export function validateUploadUrl(urlString, configuration = {}) { + if (configuration.validateUploadUrl !== true) { + return; + } + + const trimmed = typeof urlString === 'string' ? urlString.trim() : String(urlString ?? '').trim(); + if (!trimmed) { + throw new Error('audio_file_blob URL is required when passing a URL'); + } + + if (trimmed.length > MAX_URL_LENGTH) { + throw new Error(`audio_file_blob URL must not exceed ${MAX_URL_LENGTH} characters`); + } + + let parsed; + try { + parsed = new URL(trimmed); + } catch (_) { + throw new Error('audio_file_blob must be a valid URL format'); + } + + if (parsed.protocol !== 'https:') { + throw new Error('audio_file_blob URL must use HTTPS'); + } + + const hostname = parsed.hostname; + if (isIPv4(hostname) || isIPv6(hostname)) { + throw new Error('IP-based URLs are not allowed'); + } + + if (isInternalHost(hostname)) { + throw new Error('Internal or private URLs are not allowed'); + } + + const allowedDomains = configuration.allowedUrlDomains; + if (Array.isArray(allowedDomains) && allowedDomains.length > 0) { + if (!hostnameMatchesAllowlist(hostname, allowedDomains)) { + throw new Error('URL host is not in the allowed list'); + } + } + + const allowedExtensions = configuration.allowedUrlExtensions; + if (Array.isArray(allowedExtensions) && allowedExtensions.length > 0) { + if (!pathnameEndsWithExtension(parsed.pathname, allowedExtensions)) { + throw new Error( + `URL path must end with one of: ${allowedExtensions.join(', ')} (weak hint only; actual file type is validated by the backend)` + ); + } + } + + if (configuration.requireExpiryParam === true) { + const hasExpiry = + parsed.searchParams.has('X-Amz-Expires') || + parsed.searchParams.has('Expires') || + parsed.searchParams.has('expires'); + if (!hasExpiry) { + throw new Error('URL must include an expiry parameter (e.g. X-Amz-Expires or Expires)'); + } + } +} diff --git a/packages/sahara/test/Adaptor.test.js b/packages/sahara/test/Adaptor.test.js new file mode 100644 index 000000000..8d4f73324 --- /dev/null +++ b/packages/sahara/test/Adaptor.test.js @@ -0,0 +1,286 @@ +import { expect } from 'chai'; +import { enableMockClient } from '@openfn/language-common/util'; + +import { + uploadAudioFile, + getFileStatus, + get, + post, +} from '../src/Adaptor.js'; + +const testServer = enableMockClient('https://infer.voice.intron.io'); + +describe('Sahara Adaptor', () => { + const baseState = { + configuration: { + baseUrl: 'https://infer.voice.intron.io', + apiKey: 'test-api-key-12345', + }, + data: {}, + }; + + const validAudioUrl = 'https://example.com/audio.wav'; + + describe('uploadAudioFile', () => { + it('uploads from URL string and returns file_id', async () => { + testServer + .intercept({ path: '/file/v1/upload', method: 'POST' }) + .reply(200, { + status: 'Ok', + message: 'file queued for processing', + data: { + file_id: '12a9760f-b165-4404-91d0-a65d4cdt78fs', + }, + }, { headers: { 'content-type': 'application/json' } }); + + const state = { ...baseState }; + + const finalState = await uploadAudioFile({ + audio_file_name: 'test_audio', + audio_file_blob: validAudioUrl, + })(state); + + expect(finalState.data.data).to.have.property('file_id'); + expect(finalState.data.data.file_id).to.equal( + '12a9760f-b165-4404-91d0-a65d4cdt78fs' + ); + }); + + it('uploads from object with url property', async () => { + testServer + .intercept({ path: '/file/v1/upload', method: 'POST' }) + .reply(200, { + status: 'Ok', + message: 'file queued for processing', + data: { file_id: 'from-url-obj-uuid' }, + }, { headers: { 'content-type': 'application/json' } }); + + const state = { + ...baseState, + data: { signedUrl: 'https://bucket.s3.amazonaws.com/path/file.wav' }, + }; + + const finalState = await uploadAudioFile({ + audio_file_name: 'from_url_obj', + audio_file_blob: { url: state.data.signedUrl }, + })(state); + + expect(finalState.data.data.file_id).to.equal('from-url-obj-uuid'); + }); + + it('uploads with telehealth category and post-processing options', async () => { + testServer + .intercept({ path: '/file/v1/upload', method: 'POST' }) + .reply(200, { + status: 'Ok', + message: 'file queued for processing', + data: { + file_id: 'telehealth-file-uuid', + }, + }, { headers: { 'content-type': 'application/json' } }); + + const state = { ...baseState }; + + const finalState = await uploadAudioFile({ + audio_file_name: 'patient_consultation', + audio_file_blob: validAudioUrl, + use_category: 'file_category_telehealth', + get_soap_note: 'TRUE', + get_summary: 'TRUE', + get_icd_codes: 'TRUE', + })(state); + + expect(finalState.data.data.file_id).to.equal('telehealth-file-uuid'); + }); + + it('throws when audio_file_blob is Buffer (URL-only)', async () => { + const state = { + ...baseState, + data: { audioFile: Buffer.from('mock audio') }, + }; + try { + await uploadAudioFile({ + audio_file_name: 'test', + audio_file_blob: state.data.audioFile, + })(state); + expect.fail('Should have thrown'); + } catch (error) { + expect(error.message).to.include('must be a URL string'); + expect(error.message).to.include('not supported'); + } + }); + + it('throws when audio_file_blob is file path string', async () => { + const state = { ...baseState }; + try { + await uploadAudioFile({ + audio_file_name: 'test', + audio_file_blob: '/tmp/audio.wav', + })(state); + expect.fail('Should have thrown'); + } catch (error) { + expect(error.message).to.include('must be a URL string'); + } + }); + + it('when validateUploadUrl is true and URL is HTTP, throws before request', async () => { + const state = { + ...baseState, + configuration: { + ...baseState.configuration, + validateUploadUrl: true, + }, + }; + try { + await uploadAudioFile({ + audio_file_name: 'test', + audio_file_blob: 'http://example.com/audio.wav', + })(state); + expect.fail('Should have thrown'); + } catch (error) { + expect(error.message).to.include('must use HTTPS'); + } + }); + + it('when validateUploadUrl is true and URL is valid HTTPS, proceeds to upload', async () => { + testServer + .intercept({ path: '/file/v1/upload', method: 'POST' }) + .reply(200, { + status: 'Ok', + message: 'file queued for processing', + data: { file_id: 'validated-url-uuid' }, + }, { headers: { 'content-type': 'application/json' } }); + + const state = { + ...baseState, + configuration: { + ...baseState.configuration, + validateUploadUrl: true, + }, + }; + + const finalState = await uploadAudioFile({ + audio_file_name: 'validated', + audio_file_blob: 'https://example.com/audio.wav', + })(state); + + expect(finalState.data.data.file_id).to.equal('validated-url-uuid'); + }); + + it('throws error when audio_file_name is missing', async () => { + const state = { ...baseState }; + try { + await uploadAudioFile({ + audio_file_blob: validAudioUrl, + })(state); + expect.fail('Should have thrown an error'); + } catch (error) { + expect(error.message).to.include('audio_file_name is required'); + } + }); + + it('throws error when audio_file_blob is missing', async () => { + const state = { ...baseState }; + try { + await uploadAudioFile({ + audio_file_name: 'test', + })(state); + expect.fail('Should have thrown an error'); + } catch (error) { + expect(error.message).to.include('audio_file_blob is required'); + } + }); + + it('handles 429 rate limit error', async () => { + testServer + .intercept({ path: '/file/v1/upload', method: 'POST' }) + .reply(429, { message: 'Rate limit exceeded' }, { headers: { 'content-type': 'application/json' } }); + + const state = { ...baseState }; + try { + await uploadAudioFile( + { + audio_file_name: 'test', + audio_file_blob: validAudioUrl, + }, + { maxRetries: 0 } + )(state); + expect.fail('Should have thrown an error'); + } catch (error) { + expect(error.message).to.include('Rate limit'); + } + }); + + it('handles 400 bad request error', async () => { + testServer + .intercept({ path: '/file/v1/upload', method: 'POST' }) + .reply(400, { message: 'Invalid file format' }, { headers: { 'content-type': 'application/json' } }); + + const state = { ...baseState }; + try { + await uploadAudioFile( + { + audio_file_name: 'test', + audio_file_blob: validAudioUrl, + }, + { maxRetries: 0 } + )(state); + expect.fail('Should have thrown an error'); + } catch (error) { + expect(error.message).to.include('Bad Request'); + } + }); + + it('handles 413 file too large error', async () => { + testServer + .intercept({ path: '/file/v1/upload', method: 'POST' }) + .reply(413, { message: 'File exceeds 100MB limit' }, { headers: { 'content-type': 'application/json' } }); + + const state = { ...baseState }; + try { + await uploadAudioFile( + { + audio_file_name: 'large_file', + audio_file_blob: validAudioUrl, + }, + { maxRetries: 0 } + )(state); + expect.fail('Should have thrown an error'); + } catch (error) { + expect(error.message).to.include('File too large'); + } + }); + }); + + describe('getFileStatus', () => { + it('throws error when fileId is missing', async () => { + const state = { ...baseState }; + + try { + await getFileStatus()(state); + expect.fail('Should have thrown an error'); + } catch (error) { + expect(error.message).to.include('fileId is required'); + } + }); + }); + + describe('authentication', () => { + it('throws error when apiKey is missing', async () => { + const state = { + configuration: { + baseUrl: 'https://infer.voice.intron.io', + }, + data: {}, + }; + + try { + await get('/file/v1/status/test')(state); + expect.fail('Should have thrown an error'); + } catch (error) { + expect(error.message).to.include('apiKey is required'); + } + }); + }); +}); + diff --git a/packages/sahara/test/README.md b/packages/sahara/test/README.md new file mode 100644 index 000000000..77f7a1c84 --- /dev/null +++ b/packages/sahara/test/README.md @@ -0,0 +1,18 @@ +# Sahara Adaptor Tests + +## Summary +- `pnpm test` runs 30 unit tests that cover URL-based uploads, URL validation, error handling, and parameter guards for `getFileStatus` and `get`/`post`. All currently pass. +- End-to-end coverage for polling and transcript retrieval lives in `examples/integration/`, which ships runnable jobs that call the real Sahara API once you add your credentials and audio samples. + +## Mocking Strategy +- Upload and other HTTP requests are mocked via `enableMockClient` (undici) to cover success and common failure responses without hitting the network. +- Integration examples (`examples/integration/`) verify behaviour against the real Sahara API. + +## Test Output + +``` +pnpm test +# ⇒ 30 passing (≈14 ms) +``` + +When you need full-system assurance, run the category-specific scripts in `examples/integration/` after supplying valid credentials and audio files. We recommend keeping your local state/output files under `tmp/` (ignored by git) so secrets never end up in commits. diff --git a/packages/sahara/test/validateUrl.test.js b/packages/sahara/test/validateUrl.test.js new file mode 100644 index 000000000..c8cc58502 --- /dev/null +++ b/packages/sahara/test/validateUrl.test.js @@ -0,0 +1,182 @@ +import { expect } from 'chai'; +import { validateUploadUrl } from '../src/validateUrl.js'; + +describe('validateUploadUrl', () => { + describe('when validateUploadUrl is not true', () => { + it('returns without validating', () => { + expect(() => + validateUploadUrl('http://evil.local/foo', {}) + ).to.not.throw(); + expect(() => + validateUploadUrl('', { validateUploadUrl: false }) + ).to.not.throw(); + }); + }); + + describe('when validateUploadUrl is true', () => { + const config = { validateUploadUrl: true }; + + it('throws on empty URL', () => { + expect(() => validateUploadUrl('', config)).to.throw( + 'audio_file_blob URL is required when passing a URL' + ); + expect(() => validateUploadUrl(' ', config)).to.throw( + 'audio_file_blob URL is required when passing a URL' + ); + }); + + it('throws when URL exceeds max length', () => { + const long = 'https://example.com/' + 'a'.repeat(2048); + expect(() => validateUploadUrl(long, config)).to.throw( + 'must not exceed 2048 characters' + ); + }); + + it('throws on invalid URL format', () => { + expect(() => validateUploadUrl('not-a-url', config)).to.throw( + 'valid URL format' + ); + expect(() => validateUploadUrl('https://', config)).to.throw( + 'valid URL format' + ); + }); + + it('throws on HTTP (requires HTTPS)', () => { + expect(() => + validateUploadUrl('http://example.com/audio.wav', config) + ).to.throw('must use HTTPS'); + }); + + it('throws on IP-based hostname (IPv4)', () => { + expect(() => + validateUploadUrl('https://192.168.1.1/audio.wav', config) + ).to.throw('IP-based URLs are not allowed'); + expect(() => + validateUploadUrl('https://8.8.8.8/file.wav', config) + ).to.throw('IP-based URLs are not allowed'); + }); + + it('throws on IP-based hostname (IPv6)', () => { + expect(() => + validateUploadUrl('https://[::1]/audio.wav', config) + ).to.throw('IP-based URLs are not allowed'); + }); + + it('throws on internal/private hostnames (non-IP)', () => { + expect(() => + validateUploadUrl('https://localhost/audio.wav', config) + ).to.throw('Internal or private URLs are not allowed'); + expect(() => + validateUploadUrl('https://myserver.local/audio.wav', config) + ).to.throw('Internal or private URLs are not allowed'); + }); + + it('throws on IP hostnames (IPv4; checked before internal)', () => { + expect(() => + validateUploadUrl('https://127.0.0.1/audio.wav', config) + ).to.throw('IP-based URLs are not allowed'); + expect(() => + validateUploadUrl('https://0.0.0.0/audio.wav', config) + ).to.throw('IP-based URLs are not allowed'); + expect(() => + validateUploadUrl('https://10.0.0.1/audio.wav', config) + ).to.throw('IP-based URLs are not allowed'); + expect(() => + validateUploadUrl('https://172.16.0.1/audio.wav', config) + ).to.throw('IP-based URLs are not allowed'); + }); + + it('does not throw on valid HTTPS URL with public hostname', () => { + expect(() => + validateUploadUrl('https://example.com/audio.wav', config) + ).to.not.throw(); + expect(() => + validateUploadUrl('https://bucket.s3.amazonaws.com/path/file.wav', config) + ).to.not.throw(); + }); + + it('throws when allowedUrlDomains is set and host not in list', () => { + const withAllowlist = { + ...config, + allowedUrlDomains: ['s3.amazonaws.com', 'sharepoint.com'], + }; + expect(() => + validateUploadUrl('https://evil.com/audio.wav', withAllowlist) + ).to.throw('URL host is not in the allowed list'); + expect(() => + validateUploadUrl('https://example.com/audio.wav', withAllowlist) + ).to.throw('URL host is not in the allowed list'); + }); + + it('does not throw when host matches allowlist (exact or subdomain)', () => { + const withAllowlist = { + ...config, + allowedUrlDomains: ['s3.amazonaws.com', 'sharepoint.com'], + }; + expect(() => + validateUploadUrl('https://s3.amazonaws.com/bucket/file.wav', withAllowlist) + ).to.not.throw(); + expect(() => + validateUploadUrl( + 'https://my-bucket.s3.amazonaws.com/path/file.wav', + withAllowlist + ) + ).to.not.throw(); + expect(() => + validateUploadUrl('https://sharepoint.com/site/file.wav', withAllowlist) + ).to.not.throw(); + }); + + it('throws when allowedUrlExtensions is set and path does not end with one', () => { + const withExt = { + ...config, + allowedUrlExtensions: ['.wav', '.mp3'], + }; + expect(() => + validateUploadUrl('https://example.com/audio.mp4', withExt) + ).to.throw('URL path must end with one of'); + expect(() => + validateUploadUrl('https://example.com/audio', withExt) + ).to.throw('URL path must end with one of'); + }); + + it('does not throw when path ends with allowed extension (case-insensitive)', () => { + const withExt = { + ...config, + allowedUrlExtensions: ['.wav', '.mp3'], + }; + expect(() => + validateUploadUrl('https://example.com/audio.wav', withExt) + ).to.not.throw(); + expect(() => + validateUploadUrl('https://example.com/audio.WAV', withExt) + ).to.not.throw(); + expect(() => + validateUploadUrl('https://example.com/audio.mp3', withExt) + ).to.not.throw(); + }); + + it('throws when requireExpiryParam is true and URL has no expiry param', () => { + const withExpiry = { ...config, requireExpiryParam: true }; + expect(() => + validateUploadUrl('https://example.com/audio.wav', withExpiry) + ).to.throw('expiry parameter'); + }); + + it('does not throw when requireExpiryParam is true and URL has expiry param', () => { + const withExpiry = { ...config, requireExpiryParam: true }; + expect(() => + validateUploadUrl( + 'https://example.com/audio.wav?X-Amz-Expires=3600', + withExpiry + ) + ).to.not.throw(); + expect(() => + validateUploadUrl( + 'https://example.com/audio.wav?Expires=1234567890', + withExpiry + ) + ).to.not.throw(); + }); + }); +}); diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index f07c15e44..c2452b227 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -2401,6 +2401,40 @@ importers: specifier: ^1.12.0 version: 1.12.0 + packages/sahara: + dependencies: + '@openfn/language-common': + specifier: workspace:* + version: link:../common + axios: + specifier: ^1.13.1 + version: 1.13.1 + form-data: + specifier: ^4.0.4 + version: 4.0.4 + devDependencies: + 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 + mocha: + specifier: ^10.7.3 + version: 10.8.2 + nock: + specifier: ^14.0.10 + version: 14.0.10 + rimraf: + specifier: 3.0.2 + version: 3.0.2 + undici: + specifier: 6.20.1 + version: 6.20.1 + packages/salesforce: dependencies: '@jsforce/jsforce-node': @@ -5597,8 +5631,14 @@ packages: axios@0.27.2: resolution: {integrity: sha512-t+yRIyySRTp/wua5xEr+z1q60QmLq8ABsS5O9Me1AsE5dfKqgnCFzwiCZZ/cGNd1lq4/7akDWMxdhVlucjmnOQ==} - axios@1.13.5: - resolution: {integrity: sha512-cz4ur7Vb0xS4/KUN0tPWe44eqxrIu31me+fbang3ijiNscE129POzipJJA6zniq2C/Z6sJCjMimjS8Lc/GAs8Q==} + axios@1.12.2: + resolution: {integrity: sha512-vMJzPewAlRyOgxV2dU0Cuz2O8zzzx9VYtbJOaBgXFeLc4IV/Eg50n4LowmehOOR61S8ZMpc2K5Sa7g6A4jfkUw==} + + axios@1.13.1: + resolution: {integrity: sha512-hU4EGxxt+j7TQijx1oYdAjw4xuIp1wRQSsbMFwSthCWeBQur1eF+qJ5iQ5sN3Tw8YRzQNKb8jszgBdMDVqwJcw==} + + axios@1.8.2: + resolution: {integrity: sha512-ls4GYBm5aig9vWx8AWDSGLpnpDQRtWAfrjU+EuytuODrFBkqesN2RkOQCBzrA1RQNHw1SmRMSDDDSwzNAYQ6Rg==} babel-cli@6.26.0: resolution: {integrity: sha512-wau+BDtQfuSBGQ9PzzFL3REvR9Sxnd4LKwtcHAiPjhugA7K/80vpHXafj+O5bAqJOuSefjOx5ZJnNSR2J1Qw6Q==} @@ -10592,6 +10632,9 @@ packages: strict-event-emitter@0.5.1: resolution: {integrity: sha512-vMgjE/GGEPEFnhFub6pa4FmJBRBVOLpIII2hvCZ8Kzb7K0hlHo7mQv6xYrBvCL2LtAIBwFUK8wvuJgTVSQ5MFQ==} + string-escape@0.3.0: + resolution: {integrity: sha512-AM292mtfvJCPzoKBbL3YQaZ+xwaWOlYfejTADVDfL0QM/cFEZ2LoU2M8XuEZkuRxqtv9ZTjfCj+OX+rlfFWeTg==} + string-width@1.0.2: resolution: {integrity: sha512-0XsVpQLnVCXHJfyEs8tC0zpTVIr5PKKsQtkT29IwupnPTjtPmQ3xT/4yCREF9hYkV/3M3kzcUTSAZT6a6h81tw==} engines: {node: '>=0.10.0'} @@ -11118,10 +11161,18 @@ packages: resolution: {integrity: sha512-raqeBD6NQK4SkWhQzeYKd1KmIG6dllBOTt55Rmkt4HtI9mwdWtJljnrXjAFUBLTSN67HWrOIZ3EPF4kjUw80Bg==} engines: {node: '>=14.0'} + undici@6.20.1: + resolution: {integrity: sha512-AjQF1QsmqfJys+LXfGTNum+qw4S88CojRInG/6t31W/1fk6G59s92bnAvGz5Cmur+kQv2SURXEvvudLmbrE8QA==} + engines: {node: '>=18.17'} + undici@7.12.0: resolution: {integrity: sha512-GrKEsc3ughskmGA9jevVlIOPMiiAHJ4OFUtaAH+NhfTUSiZ1wMPIQqQvAJUrJspFXJt3EBWgpAeoHEDVT1IBug==} engines: {node: '>=20.18.1'} + undici@7.16.0: + resolution: {integrity: sha512-QEg3HPMll0o3t2ourKwOeUAZ159Kn9mx5pnzHRQO8+Wixmh88YdZRiIwat0iNzNNXn0yoEtXJqFpyW7eM8BV7g==} + engines: {node: '>=20.18.1'} + undici@7.19.2: resolution: {integrity: sha512-4VQSpGEGsWzk0VYxyB/wVX/Q7qf9t5znLRgs0dzszr9w9Fej/8RVNQ+S20vdXSAyra/bJ7ZQfGv6ZMj7UEbzSg==} engines: {node: '>=20.18.1'} @@ -14400,7 +14451,23 @@ snapshots: axios@1.13.5: dependencies: follow-redirects: 1.15.11 - form-data: 4.0.5 + form-data: 4.0.4 + proxy-from-env: 1.1.0 + transitivePeerDependencies: + - debug + + axios@1.13.1: + dependencies: + follow-redirects: 1.15.11 + form-data: 4.0.4 + proxy-from-env: 1.1.0 + transitivePeerDependencies: + - debug + + axios@1.8.2: + dependencies: + follow-redirects: 1.15.11 + form-data: 4.0.4 proxy-from-env: 1.1.0 transitivePeerDependencies: - debug @@ -20304,6 +20371,8 @@ snapshots: strict-event-emitter@0.5.1: {} + strict-event-emitter@0.5.1: {} + string-width@1.0.2: dependencies: code-point-at: 1.1.0 @@ -21021,6 +21090,8 @@ snapshots: dependencies: '@fastify/busboy': 2.1.1 + undici@6.20.1: {} + undici@7.12.0: {} undici@7.19.2: {}