diff --git a/packages/fetch/package.json b/packages/fetch/package.json index 54651c71..141fa46b 100644 --- a/packages/fetch/package.json +++ b/packages/fetch/package.json @@ -74,6 +74,7 @@ "dependencies": { "@alwatr/delay": "workspace:^", "@alwatr/global-this": "workspace:^", + "@alwatr/http-primer": "workspace:^", "@alwatr/logger": "workspace:^", "@alwatr/package-tracer": "workspace:^", "@alwatr/parse-duration": "workspace:^" diff --git a/packages/fetch/src/core.ts b/packages/fetch/src/core.ts index 8a2bfda6..317df084 100644 --- a/packages/fetch/src/core.ts +++ b/packages/fetch/src/core.ts @@ -1,5 +1,6 @@ import {delay} from '@alwatr/delay'; import {getGlobalThis} from '@alwatr/global-this'; +import {HttpStatusCodes, MimeTypes} from '@alwatr/http-primer'; import {createLogger} from '@alwatr/logger'; import {packageTracer} from '@alwatr/package-tracer'; import {parseDuration} from '@alwatr/parse-duration'; @@ -60,14 +61,14 @@ export function processOptions_(options: FetchOptions): Required { if (options.bodyJson !== undefined) { options.body = JSON.stringify(options.bodyJson); - options.headers['Content-Type'] = 'application/json'; + options.headers['content-type'] = MimeTypes.JSON; } if (options.bearerToken !== undefined) { - options.headers.Authorization = `Bearer ${options.bearerToken}`; + options.headers.authorization = `Bearer ${options.bearerToken}`; } else if (options.alwatrAuth !== undefined) { - options.headers.Authorization = `Alwatr ${options.alwatrAuth.userId}:${options.alwatrAuth.userToken}`; + options.headers.authorization = `Alwatr ${options.alwatrAuth.userId}:${options.alwatrAuth.userToken}`; } return options as Required; @@ -208,7 +209,7 @@ export async function handleRetryPattern_(options: Required): Prom try { const response = await handleTimeout_(options); - if (response.status < 500) { + if (response.status < HttpStatusCodes.Error_Server_500_Internal_Server_Error) { return response; } // else diff --git a/packages/fetch/src/main.ts b/packages/fetch/src/main.ts index 9c1798bb..846a893f 100644 --- a/packages/fetch/src/main.ts +++ b/packages/fetch/src/main.ts @@ -1,3 +1,5 @@ +import {HttpStatusCodes, type HttpStatusCode} from '@alwatr/http-primer'; + import {handleCacheStrategy_, logger_, processOptions_, cacheSupported} from './core.js'; import type {FetchOptions, ResponseError, ResponseSuccess} from './type.js'; @@ -39,13 +41,13 @@ export async function fetchJson(options: FetchOptions): Pr responseText = await response.text(); responseJson = JSON.parse(responseText) as ResponseSuccess; responseJson.ok = true; - responseJson.statusCode = response.status; + responseJson.statusCode = response.status as HttpStatusCode; return responseJson; } catch (error) { const responseError: ResponseError = { ok: false, - statusCode: response?.status ?? 500, + statusCode: (response?.status as HttpStatusCode) ?? HttpStatusCodes.Error_Server_500_Internal_Server_Error, errorCode: (responseJson?.errorCode as string) ?? (error as Error).message, errorMessage: (responseJson?.errorMessage as string) ?? (error as Error).message, responseText, diff --git a/packages/fetch/src/type.ts b/packages/fetch/src/type.ts index 6af0c3c1..fae19655 100644 --- a/packages/fetch/src/type.ts +++ b/packages/fetch/src/type.ts @@ -1,10 +1,6 @@ +import type {HttpMethod, HttpRequestHeaders, HttpStatusCode} from '@alwatr/http-primer'; import type {Duration} from '@alwatr/parse-duration'; -/** - * Represents the available HTTP methods. - */ -export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS' | 'HEAD' | 'CONNECT' | 'TRACE'; - /** * Represents a dictionary of query parameters. * The keys are strings and the values can be strings, numbers, or booleans. @@ -51,7 +47,7 @@ export interface FetchOptions extends RequestInit { /** * A Headers object to set the request's headers. */ - headers?: DictionaryReq; + headers?: Record & HttpRequestHeaders; /** * A timeout for the fetch request. @@ -139,12 +135,12 @@ export interface FetchOptions extends RequestInit { export type ResponseSuccess = T & { ok: true; - statusCode: number; + statusCode: HttpStatusCode; }; export type ResponseError = { ok: false; - statusCode: number; + statusCode: HttpStatusCode; errorCode: string; errorMessage: string; responseText?: string; diff --git a/packages/fetch/tsconfig.json b/packages/fetch/tsconfig.json index cdc8eb71..51432178 100644 --- a/packages/fetch/tsconfig.json +++ b/packages/fetch/tsconfig.json @@ -13,6 +13,7 @@ {"path": "../logger"}, {"path": "../global-this"}, {"path": "../delay"}, - {"path": "../parse-duration"} + {"path": "../parse-duration"}, + {"path": "../http-primer"}, ] } diff --git a/packages/http-primer/LICENSE b/packages/http-primer/LICENSE new file mode 100644 index 00000000..0ad25db4 --- /dev/null +++ b/packages/http-primer/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/packages/http-primer/README.md b/packages/http-primer/README.md new file mode 100644 index 00000000..48f9be1f --- /dev/null +++ b/packages/http-primer/README.md @@ -0,0 +1,57 @@ +# HTTP Primer + +Essential HTTP utilities for TypeScript, including types for HTTP methods, status codes, and headers. + +## Installation + +```bash +npm install @alwatr/http-primer +``` + +## Usage + +### HTTP Methods + +```typescript +import { HttpMethods } from '@alwatr/http-primer'; + +const method = HttpMethods.GET; +``` + +### HTTP Status Codes + +```typescript +import { HttpStatusCodes } from '@alwatr/http-primer'; + +const statusCode = HttpStatusCodes.Success_200_OK; +``` + +### HTTP Headers + +```typescript +import { HttpRequestHeaders, HttpResponseHeaders } from '@alwatr/http-primer'; + +const requestHeaders: HttpRequestHeaders = { + accept: 'application/json', + authorization: 'Bearer my-token', +}; + +const responseHeaders: HttpResponseHeaders = { + 'content-type': 'application/json', + 'content-length': 1234, +}; +``` + +## Sponsors + +The following companies, organizations, and individuals support Nanolib ongoing maintenance and development. Become a Sponsor to get your logo on our README and website. + +[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com) + +### Contributing + +Contributions are welcome! Please read our [contribution guidelines](https://github.com/Alwatr/.github/blob/next/CONTRIBUTING.md) before submitting a pull request. + +### License + +This project is licensed under the [AGPL-3.0 License](LICENSE). diff --git a/packages/http-primer/package.json b/packages/http-primer/package.json new file mode 100644 index 00000000..60518d05 --- /dev/null +++ b/packages/http-primer/package.json @@ -0,0 +1,82 @@ +{ + "name": "@alwatr/http-primer", + "version": "1.0.0-0", + "description": "Essential HTTP utilities for TypeScript, including types for HTTP methods, status codes, and headers.", + "author": "S. Ali Mihandoost ", + "keywords": [ + "http", + "http-primer", + "status-codes", + "status", + "headers-types", + "http-headers", + "cross-platform", + "ECMAScript", + "typescript", + "javascript", + "node", + "nodejs", + "browser", + "esm", + "module", + "utility", + "util", + "utils", + "nanolib", + "alwatr" + ], + "type": "module", + "main": "./dist/main.cjs", + "module": "./dist/main.mjs", + "types": "./dist/main.d.ts", + "exports": { + ".": { + "types": "./dist/main.d.ts", + "import": "./dist/main.mjs", + "require": "./dist/main.cjs" + } + }, + "license": "AGPL-3.0-only", + "files": [ + "**/*.{js,mjs,cjs,map,d.ts,html,md,LEGAL.txt}", + "LICENSE", + "!demo/**/*" + ], + "publishConfig": { + "access": "public" + }, + "repository": { + "type": "git", + "url": "https://github.com/Alwatr/nanolib", + "directory": "packages/http-primer" + }, + "homepage": "https://github.com/Alwatr/nanolib/tree/next/packages/http-primer#readme", + "bugs": { + "url": "https://github.com/Alwatr/nanolib/issues" + }, + "prettier": "@alwatr/prettier-config", + "scripts": { + "b": "yarn run build", + "w": "yarn run watch", + "c": "yarn run clean", + "cb": "yarn run clean && yarn run build", + "d": "yarn run build:es && yarn node --enable-source-maps --trace-warnings", + "build": "yarn run build:ts && yarn run build:es", + "build:es": "nano-build --preset=module", + "build:ts": "tsc --build", + "watch": "yarn run watch:ts & yarn run watch:es", + "watch:es": "yarn run build:es --watch", + "watch:ts": "yarn run build:ts --watch --preserveWatchOutput", + "clean": "rm -rfv dist *.tsbuildinfo" + }, + "dependencies": { + "@alwatr/package-tracer": "workspace:^" + }, + "devDependencies": { + "@alwatr/nano-build": "workspace:^", + "@alwatr/prettier-config": "workspace:^", + "@alwatr/tsconfig-base": "workspace:^", + "@alwatr/type-helper": "workspace:^", + "typescript": "^5.6.3" + } +} diff --git a/packages/http-primer/src/constant.ts b/packages/http-primer/src/constant.ts new file mode 100644 index 00000000..85765946 --- /dev/null +++ b/packages/http-primer/src/constant.ts @@ -0,0 +1,530 @@ +/** + * Object representing standard HTTP methods. + */ +export const HttpMethods = /* #__PURE__ */ { + /** + * GET: Requests a representation of the specified resource. + */ + GET: 'GET', + + /** + * HEAD: Asks for a response identical to that of a GET request, but without the response body. + */ + HEAD: 'HEAD', + + /** + * POST: Submits data to be processed (e.g., from an HTML form) to the identified resource. + */ + POST: 'POST', + + /** + * PUT: Uploads a representation of the specified URI. + */ + PUT: 'PUT', + + /** + * DELETE: Deletes the specified resource. + */ + DELETE: 'DELETE', + + /** + * CONNECT: Establishes a tunnel to the server identified by the target resource. + */ + CONNECT: 'CONNECT', + + /** + * OPTIONS: Describes the communication options for the target resource. + */ + OPTIONS: 'OPTIONS', + + /** + * TRACE: Performs a message loop-back test along the path to the target resource. + */ + TRACE: 'TRACE', + + /** + * PATCH: Applies partial modifications to a resource. + */ + PATCH: 'PATCH', +} as const; + +/** + * Object representing standard HTTP status codes. + */ +export const HttpStatusCodes = /* #__PURE__ */ { + /** + * 100 Continue: The server has received the request headers and the client should proceed to send the request body. + */ + Info_100_Continue: 100, + + /** + * 101 Switching Protocols: The server understands and is willing to comply with the clients request to switch protocols. + */ + Info_101_Switching_Protocols: 101, + + /** + * 102 Processing: The server has received and is processing the request, but no response is available yet. + */ + Info_102_Processing: 102, + + /** + * 103 Early Hints: The server is sending some response headers before the final HTTP message. + */ + Info_103_Early_Hints: 103, + + /** + * 200 OK: The request has succeeded. + */ + Success_200_OK: 200, + + /** + * 201 Created: The request has been fulfilled and resulted in a new resource being created. + */ + Success_201_Created: 201, + + /** + * 202 Accepted: The request has been accepted for processing, but the processing has not been completed. + */ + Success_202_Accepted: 202, + + /** + * 203 Non-Authoritative Information: The server is a transforming proxy that received a 200 OK + * from the origin server but is returning a modified version of the origins response. + */ + Success_203_Non_Authoritative_Information: 203, + + /** + * 204 No Content: The server successfully processed the request and is not returning any content. + */ + Success_204_No_Content: 204, + + /** + * 205 Reset Content: The server successfully processed the request, + * asks that the client reset its document view, and is not returning any content. + */ + Success_205_Reset_Content: 205, + + /** + * 206 Partial Content: The server is delivering only part of the resource due to a range header sent by the client. + */ + Success_206_Partial_Content: 206, + + /** + * 207 Multi-Status: The message body that follows is an XML message + * and can contain a number of separate response codes, depending on how many sub-requests were made. + */ + Success_207_Multi_Status: 207, + + /** + * 208 Already Reported: The members of a DAV binding have already been enumerated + * in a preceding part of the (multi-status) response, and are not being included again. + */ + Success_208_Already_Reported: 208, + + /** + * 226 IM Used: The server has fulfilled a request for the resource, and the response is a representation + * of the result of one or more instance-manipulations applied to the current instance. + */ + Success_226_IM_Used: 226, + + /** + * 300 Multiple Choices: The request has more than one possible response. + */ + Redirect_300_Multiple_Choices: 300, + + /** + * 301 Moved Permanently: The URL of the requested resource has been changed permanently. + */ + Redirect_301_Moved_Permanently: 301, + + /** + * 302 Found: The URL of the requested resource has been changed temporarily. + */ + Redirect_302_Found: 302, + + /** + * 303 See Other: The response to the request can be found under another URI using a GET method. + */ + Redirect_303_See_Other: 303, + + /** + * 304 Not Modified: The resource has not been modified since the version specified + * by the request headers If-Modified-Since or If-None-Match. + */ + Redirect_304_Not_Modified: 304, + + /** + * 305 Use Proxy: The requested resource is only available through a proxy, the address for which is provided in the response. + */ + Redirect_305_Use_Proxy: 305, + + /** + * 306 Switch Proxy: No longer used. Originally meant "Subsequent requests should use the specified proxy." + */ + Redirect_306_Switch_Proxy: 306, + + /** + * 307 Temporary Redirect: The server sends this response to direct the client + * to get the requested resource at another URI with the same method that was used in the prior request. + */ + Redirect_307_Temporary_Redirect: 307, + + /** + * 308 Permanent Redirect: This means that the resource is now permanently located at another URI, + * specified by the Location: HTTP Response header. + */ + Redirect_308_Permanent_Redirect: 308, + + /** + * 400 Bad Request: The server cannot or will not process the request due to something that is perceived to be a client error. + */ + Error_Client_400_Bad_Request: 400, + + /** + * 401 Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource. + */ + Error_Client_401_Unauthorized: 401, + + /** + * 402 Payment Required: Reserved for future use. + */ + Error_Client_402_Payment_Required: 402, + + /** + * 403 Forbidden: The client does not have access rights to the content, so the server is refusing to give the requested resource. + */ + Error_Client_403_Forbidden: 403, + + /** + * 404 Not Found: The server can not find the requested resource. + */ + Error_Client_404_Not_Found: 404, + + /** + * 405 Method Not Allowed: The request method is known by the server but is not supported by the target resource. + */ + Error_Client_405_Method_Not_Allowed: 405, + + /** + * 406 Not Acceptable: The target resource does not have a current representation that would be acceptable + * to the user agent, according to the proactive negotiation header fields received in the request, + * and the server is unwilling to supply a default representation. + */ + Error_Client_406_Not_Acceptable: 406, + + /** + * 407 Proxy Authentication Required: Similar to 401 Unauthorized, + * but it indicates that the client needs to authenticate itself in order to use a proxy. + */ + Error_Client_407_Proxy_Authentication_Required: 407, + + /** + * 408 Request Timeout: The server timed out waiting for the request. + */ + Error_Client_408_Request_Timeout: 408, + + /** + * 409 Conflict: The request could not be processed because of conflict in the request, such as an edit conflict. + */ + Error_Client_409_Conflict: 409, + + /** + * 410 Gone: The requested resource is no longer available and will not be available again. + */ + Error_Client_410_Gone: 410, + + /** + * 411 Length Required: The server refuses to accept the request without a defined Content-Length header. + */ + Error_Client_411_Length_Required: 411, + + /** + * 412 Precondition Failed: One or more conditions given in the request header fields evaluated to false when tested on the server. + */ + Error_Client_412_Precondition_Failed: 412, + + /** + * 413 Payload Too Large: The server is refusing to process a request because the request payload is larger + * than the server is willing or able to process. + */ + Error_Client_413_Payload_Too_Large: 413, + + /** + * 414 URI Too Long: The server is refusing to service the request because the URI is longer than the server is willing to interpret. + */ + Error_Client_414_URI_Too_Long: 414, + + /** + * 415 Unsupported Media Type: The server is refusing to service the request + * because the entity of the request is in a format not supported by the requested resource for the requested method. + */ + Error_Client_415_Unsupported_Media_Type: 415, + + /** + * 416 Range Not Satisfiable: The client has asked for a portion of the file, but the server cannot supply that portion. + */ + Error_Client_416_Range_Not_Satisfiable: 416, + + /** + * 417 Expectation Failed: The server cannot meet the requirements of the Expect request-header field. + */ + Error_Client_417_Expectation_Failed: 417, + + /** + * 421 Misdirected Request: The request was directed at a server that is not able to produce a response. + */ + Error_Client_421_Misdirected_Request: 421, + + /** + * 422 Unprocessable Entity: The request was well-formed but was unable to be followed due to semantic errors. + */ + Error_Client_422_Unprocessable_Entity: 422, + + /** + * 423 Locked: The resource that is being accessed is locked. + */ + Error_Client_423_Locked: 423, + + /** + * 424 Failed Dependency: The request failed due to a failure of a previous request. + */ + Error_Client_424_Failed_Dependency: 424, + + /** + * 425 Too Early: The server is unwilling to risk processing a request that might be replayed. + */ + Error_Client_425_Too_Early: 425, + + /** + * 426 Upgrade Required: The server refuses to perform the request using the current protocol + * but might be willing to do so after the client upgrades to a different protocol. + */ + Error_Client_426_Upgrade_Required: 426, + + /** + * 428 Precondition Required: The origin server requires the request to be conditional. + */ + Error_Client_428_Precondition_Required: 428, + + /** + * 429 Too Many Requests: The user has sent too many requests in a given amount of time ("rate limiting"). + */ + Error_Client_429_Too_Many_Requests: 429, + + /** + * 431 Request Header Fields Too Large: The server is unwilling to process the request because its header fields are too large. + */ + Error_Client_431_Request_Header_Fields_Too_Large: 431, + + /** + * 451 Unavailable For Legal Reasons: The user requests an illegal resource, such as a web page censored by a government. + */ + Error_Client_451_Unavailable_For_Legal_Reasons: 451, + + /** + * 500 Internal Server Error: A generic error message, given when no more specific message is suitable. + */ + Error_Server_500_Internal_Server_Error: 500, + + /** + * 501 Not Implemented: The server either does not recognize the request method, or it lacks the ability to fulfill the request. + */ + Error_Server_501_Not_Implemented: 501, + + /** + * 502 Bad Gateway: The server was acting as a gateway or proxy and received an invalid response from the upstream server. + */ + Error_Server_502_Bad_Gateway: 502, + + /** + * 503 Service Unavailable: The server is currently unavailable (because it is overloaded or down for maintenance). + */ + Error_Server_503_Service_Unavailable: 503, + + /** + * 504 Gateway Timeout: The server was acting as a gateway or proxy and did not receive a timely response from the upstream server. + */ + Error_Server_504_Gateway_Timeout: 504, + + /** + * 505 HTTP Version Not Supported: The server does not support the HTTP protocol version used in the request. + */ + Error_Server_505_HTTP_Version_Not_Supported: 505, + + /** + * 506 Variant Also Negotiates: Transparent content negotiation for the request results in a circular reference. + */ + Error_Server_506_Variant_Also_Negotiates: 506, + + /** + * 507 Insufficient Storage: The server is unable to store the representation needed to complete the request. + */ + Error_Server_507_Insufficient_Storage: 507, + + /** + * 508 Loop Detected: The server detected an infinite loop while processing the request. + */ + Error_Server_508_Loop_Detected: 508, + + /** + * 510 Not Extended: Further extensions to the request are required for the server to fulfill it. + */ + Error_Server_510_Not_Extended: 510, + + /** + * 511 Network Authentication Required: The client needs to authenticate to gain network access. + */ + Error_Server_511_Network_Authentication_Required: 511, +} as const; + +/** + * Object representing standard HTTP status messages. + */ +export const HttpStatusMessages = /* #__PURE__ */ { + 100: 'Continue', + 101: 'Switching Protocols', + 102: 'Processing', + 103: 'Early Hints', + 200: 'OK', + 201: 'Created', + 202: 'Accepted', + 203: 'Non-Authoritative Information', + 204: 'No Content', + 205: 'Reset Content', + 206: 'Partial Content', + 207: 'Multi-Status', + 208: 'Already Reported', + 226: 'IM Used', + 300: 'Multiple Choices', + 301: 'Moved Permanently', + 302: 'Found', + 303: 'See Other', + 304: 'Not Modified', + 305: 'Use Proxy', + 307: 'Temporary Redirect', + 308: 'Permanent Redirect', + 400: 'Bad Request', + 401: 'Unauthorized', + 402: 'Payment Required', + 403: 'Forbidden', + 404: 'Not Found', + 405: 'Method Not Allowed', + 406: 'Not Acceptable', + 407: 'Proxy Authentication Required', + 408: 'Request Timeout', + 409: 'Conflict', + 410: 'Gone', + 411: 'Length Required', + 412: 'Precondition Failed', + 413: 'Payload Too Large', + 414: 'URI Too Long', + 415: 'Unsupported Media Type', + 416: 'Range Not Satisfiable', + 417: 'Expectation Failed', + 418: "I'm a Teapot", + 421: 'Misdirected Request', + 422: 'Unprocessable Entity', + 423: 'Locked', + 424: 'Failed Dependency', + 425: 'Too Early', + 426: 'Upgrade Required', + 428: 'Precondition Required', + 429: 'Too Many Requests', + 431: 'Request Header Fields Too Large', + 451: 'Unavailable For Legal Reasons', + 500: 'Internal Server Error', + 501: 'Not Implemented', + 502: 'Bad Gateway', + 503: 'Service Unavailable', + 504: 'Gateway Timeout', + 505: 'HTTP Version Not Supported', + 506: 'Variant Also Negotiates', + 507: 'Insufficient Storage', + 508: 'Loop Detected', + 509: 'Bandwidth Limit Exceeded', + 510: 'Not Extended', + 511: 'Network Authentication Required', +}; + +/** + * Type representing standard HTTP status codes. + */ +export type HttpStatusCode = keyof typeof HttpStatusMessages; + +/** + * Object representing standard MIME types. + */ +export const MimeTypes = /* #__PURE__ */ { + AAC: 'audio/aac', + ABW: 'application/x-abiword', + ARC: 'application/x-freearc', + AVI: 'video/x-msvideo', + AZW: 'application/vnd.amazon.ebook', + BIN: 'application/octet-stream', + BMP: 'image/bmp', + BZ: 'application/x-bzip', + BZ2: 'application/x-bzip2', + CSH: 'application/x-csh', + CSS: 'text/css', + CSV: 'text/csv', + DOC: 'application/msword', + DOCX: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', + EOT: 'application/vnd.ms-fontobject', + EPUB: 'application/epub+zip', + GZ: 'application/gzip', + GIF: 'image/gif', + HTML: 'text/html', + ICO: 'image/vnd.microsoft.icon', + ICS: 'text/calendar', + JAR: 'application/java-archive', + JPEG: 'image/jpeg', + JS: 'text/javascript', + JSON: 'application/json', + JSONLD: 'application/ld+json', + MID: 'audio/midi', + MIDI: 'audio/midi', + MJS: 'text/javascript', + MP3: 'audio/mpeg', + MP4: 'video/mp4', + MPEG: 'video/mpeg', + MPKG: 'application/vnd.apple.installer+xml', + ODP: 'application/vnd.oasis.opendocument.presentation', + ODS: 'application/vnd.oasis.opendocument.spreadsheet', + ODT: 'application/vnd.oasis.opendocument.text', + OGA: 'audio/ogg', + OGV: 'video/ogg', + OGX: 'application/ogg', + OPUS: 'audio/opus', + OTF: 'font/otf', + PNG: 'image/png', + PDF: 'application/pdf', + PHP: 'application/x-httpd-php', + PPT: 'application/vnd.ms-powerpoint', + PPTX: 'application/vnd.openxmlformats-officedocument.presentationml.presentation', + RAR: 'application/vnd.rar', + RTF: 'application/rtf', + SH: 'application/x-sh', + SVG: 'image/svg+xml', + SWF: 'application/x-shockwave-flash', + TAR: 'application/x-tar', + TIFF: 'image/tiff', + TS: 'video/mp2t', + TTF: 'font/ttf', + TXT: 'text/plain', + VS: 'application/x-sh', + WAV: 'audio/wav', + WEBA: 'audio/webm', + WEBM: 'video/webm', + WEBP: 'image/webp', + WOFF: 'font/woff', + WOFF2: 'font/woff2', + XHTML: 'application/xhtml+xml', + XLS: 'application/vnd.ms-excel', + XLSX: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', + XML: 'application/xml', + XUL: 'application/vnd.mozilla.xul+xml', + ZIP: 'application/zip', + '3GP': 'video/3gpp', + '3G2': 'video/3gpp2', + '7Z': 'application/x-7z-compressed', +} as const; diff --git a/packages/http-primer/src/main.ts b/packages/http-primer/src/main.ts new file mode 100644 index 00000000..3e800da8 --- /dev/null +++ b/packages/http-primer/src/main.ts @@ -0,0 +1,6 @@ +import {packageTracer} from '@alwatr/package-tracer'; + +__dev_mode__: packageTracer.add(__package_name__, __package_version__); + +export * from './constant.js'; +export type * from './type.js'; diff --git a/packages/http-primer/src/type.ts b/packages/http-primer/src/type.ts new file mode 100644 index 00000000..ff2ee5ff --- /dev/null +++ b/packages/http-primer/src/type.ts @@ -0,0 +1,879 @@ +export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS' | 'HEAD' | 'CONNECT' | 'TRACE'; + +/** + * Represents the collection of HTTP response headers. + */ +export interface HttpResponseHeaders { + /** + * Indicates if the server supports range requests for the target resource. + */ + 'accept-ranges'?: string; + + /** + * Specifies the time in seconds the object has been in a proxy cache. + */ + age?: string; + + /** + * Lists the set of HTTP methods supported by the resource identified by the Request-URI. + */ + allow?: string; + + /** + * Specifies caching directives for both requests and responses. + */ + 'cache-control'?: string; + + /** + * Controls whether the network connection stays open after the current transaction. + */ + connection?: string; + + /** + * Suggests a filename for the downloaded resource or how the content should be displayed. + */ + 'content-disposition'?: string; + + /** + * Indicates what content encodings have been applied to the entity-body. + */ + 'content-encoding'?: string; + + /** + * Describes the natural language(s) of the intended audience for the enclosed entity. + */ + 'content-language'?: string; + + /** + * Indicates the size of the entity-body, in bytes, sent to the recipient. + */ + 'content-length'?: string | number; + + /** + * Indicates an alternate location for the returned data. + */ + 'content-location'?: string; + + /** + * Indicates where in a full body message a partial message belongs. + */ + 'content-range'?: string; + + /** + * Indicates the media type of the entity-body sent to the recipient. + */ + 'content-type'?: string; + + /** + * Indicates the date and time at which the message was originated. + */ + date?: string; + + /** + * Provides the current value of the entity tag for the requested variant. + */ + etag?: string; + + /** + * Gives the date/time after which the response is considered stale. + */ + expires?: string; + + /** + * Indicates the date and time at which the origin server believes the variant was last modified. + */ + 'last-modified'?: string; + + /** + * Provides a list of URIs associated with the resource. + */ + link?: string; + + /** + * Used in redirection, or when a new resource has been created. + */ + location?: string; + + /** + * Used for backward compatibility with HTTP/1.0 caches. + */ + pragma?: string; + + /** + * Requests authentication information from the client for a proxy server. + */ + 'proxy-authenticate'?: string; + + /** + * Indicates how long the user agent should wait before making a follow-up request. + */ + 'retry-after'?: string; + + /** + * Contains information about the software used by the origin server to handle the request. + */ + server?: string; + + /** + * Used to send cookies from the server to the user agent. + */ + 'set-cookie'?: string[]; + + /** + * Tells browsers to access the server using HTTPS only. + */ + 'strict-transport-security'?: string; + + /** + * Allows the sender to include additional fields at the end of chunked messages. + */ + trailer?: string; + + /** + * Specifies the form of encoding used to safely transfer the entity to the user. + */ + 'transfer-encoding'?: string; + + /** + * Determines how to match future request headers to decide whether a cached response + * can be used rather than requesting a fresh one from the origin server. + */ + vary?: string; + + /** + * Lists all intermediate proxies the message has traversed + */ + via?: string; + + /** + * Contains additional information about the status or transformation of a message that might not be reflected in the status code. + */ + warning?: string; + + /** + * Indicates the authentication scheme that should be used to access the requested entity. + */ + 'www-authenticate'?: string; + + // Additional headers can be added here as needed + [headerName: Lowercase]: string | string[] | number | undefined; +} + +/** + * Represents the collection of all HTTP Request headers. + */ +export interface HttpRequestHeaders { + /** + * Content-Types that are acceptable for the response. + * + * Example: `accept: 'text/html,application/xhtml+xml,application/xml;q=0.9,*\/*;q=0.8'` + */ + accept?: string; + + /** + * Character sets that are acceptable. + * + * Example: `accept-charset: 'utf-8, iso-8859-1;q=0.5'` + */ + 'accept-charset'?: string; + + /** + * List of acceptable encodings. + * + * Example: `accept-encoding: 'gzip, deflate, br'` + */ + 'accept-encoding'?: string; + + /** + * List of acceptable languages for the response. + * + * Example: `accept-language: 'en-US,en;q=0.5'` + */ + 'accept-language'?: string; + + /** + * Authentication credentials for HTTP authentication. + * + * Example: `authorization: 'Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='` + */ + authorization?: string; + + /** + * Used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. + * + * Example: `cache-control: 'no-cache'` + */ + 'cache-control'?: string; + + /** + * The type of encoding used on the data. + * + * Example: `content-encoding: 'gzip'` + */ + 'content-encoding'?: string; + + /** + * The natural language or languages of the intended audience for the enclosed content. + * + * Example: `content-language: 'en-US'` + */ + 'content-language'?: string; + + /** + * The length of the request body in octets (8-bit bytes). + * + * Example: `content-length: '1234'` + */ + 'content-length'?: string; + + /** + * An alternate location for the returned data (like a redirect). + * + * Example: `content-location: '/index.html'` + */ + 'content-location'?: string; + + /** + * A Base64-encoded binary MD5 sum of the content of the request body. + * + * Example: `content-md5: 'Q2hlY2sgSW50ZWdyaXR5IQ=='` + */ + 'content-md5'?: string; + + /** + * The MIME type of the body of the request (used with POST and PUT requests). + * + * Example: `content-type: 'application/x-www-form-urlencoded'` + */ + 'content-type'?: string; + + /** + * An HTTP cookie previously sent by the server with `Set-Cookie`. + * + * Example: `cookie: 'sessionid=38afes7a8'` + */ + cookie?: string; + + /** + * The date and time that the message was originated (in "HTTP-date" format as defined by RFC 7231). + * + * Example: `date: 'Sun, 06 Nov 1994 08:49:37 GMT'` + */ + date?: string; + + /** + * The email address of the user making the request. + * + * Example: `from: 'user@example.com'` + */ + from?: string; + + /** + * The domain name of the server (for virtual hosting), and the TCP port number on which the server is listening. + * The port number may be omitted if the port is the standard port for the service requested. + * + * Example: `host: 'en.wikipedia.org:8080'` + */ + host?: string; + + /** + * Only send the response if the entity has not been modified since a specific time. + * + * Example: `if-modified-since: 'Sat, 29 Oct 1994 19:43:31 GMT'` + */ + 'if-modified-since'?: string; + + /** + * Allows a 304 Not Modified to be returned if content is unchanged. + * + * Example: `if-none-match: '"737060cd8c284d8af7ad3082f209582d"'` + */ + 'if-none-match'?: string; + + /** + * If the entity is unchanged, send me the part(s) that I am missing; otherwise, send me the entire new entity. + * + * Example: `if-range: '"737060cd8c284d8af7ad3082f209582d"'` + */ + 'if-range'?: string; + + /** + * Only send the response if the entity has been modified since a specific time. + * + * Example: `if-unmodified-since: 'Sat, 29 Oct 1994 19:43:31 GMT'` + */ + 'if-unmodified-since'?: string; + + /** + * Limit the number of times the message can be forwarded through proxies or gateways. + * + * Example: `max-forwards: '10'` + */ + 'max-forwards'?: string; + + /** + * Implementation-specific headers that may have various effects anywhere along the request-response chain. + * + * Example: `pragma: 'no-cache'` + */ + pragma?: string; + + /** + * Authorization credentials for connecting to a proxy. + * + * Example: `proxy-authorization: 'Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='` + */ + 'proxy-authorization'?: string; + + /** + * Request only part of an entity. Bytes are numbered from 0. + * + * Example: `range: 'bytes=500-999'` + */ + range?: string; + + /** + * This is the address of the previous web page from which a link to the currently requested page was followed. + * (The word "referrer" is misspelled in the RFC as well as in most implementations.) + * + * Example: `referer: 'https://en.wikipedia.org/wiki/Main_Page'` + */ + referer?: string; + + /** + * The user agent string of the user agent. + * + * Example: `user-agent: 'Mozilla/5.0 (X11; Linux x86_64; rv:12.0) Gecko/20100101 Firefox/21.0'` + */ + 'user-agent'?: string; + + /** + * Ask the server to upgrade to another protocol. + * + * Example: `upgrade: 'h2c, HTTPS/1.3, IRC/6.9, RTA/x11, websocket'` + */ + upgrade?: string; + + /** + * Informs the server of proxies through which the request was sent. + * + * Example: `via: '1.0 fred, 1.1 example.com (Apache/1.1)'` + */ + via?: string; + + /** + * A general warning about possible problems with the entity body. + * + * Example: `warning: '199 Miscellaneous warning'` + */ + warning?: string; + + /** + * Tells all caching mechanisms from server to client whether they may cache this object. + * It is similar to Cache-Control: no-cache, but only applies to proxies and does not apply to private caches. + * + * Example: `age: '12'` + */ + age?: string; + + /** + * Appends " trailers " to the list of acceptable transfer encodings in the `TE` header. + * + * Example: `allow: 'GET, HEAD'` + */ + allow?: string; + + /** + * What partial content range types this server supports via the `Range` header. + * + * Example: `a-im: 'feed'` + */ + 'a-im'?: string; + + /** + * Alternative addresses (e-mail) to reply to for user agents that support multiple reply addresses + * in the `From` header field + * + * Example: `alt-svc: 'h3-29=":443"; ma=86400, h3-T051=":443"; ma=86400, h3-Q050=":443"; ma=86400, + * h3-Q046=":443"; ma=86400, h3-Q043=":443"; ma=86400, quic=":443"; ma=86400; v="43,46"'` + */ + 'alt-used'?: string; + + /** + * Authentication credentials for HTTP authentication + * + * Example: `apply-to-redirect-ref: 'false'` + */ + 'apply-to-redirect-ref'?: string; + + /** + * Used in redirection, or when a new resource has been created. This refresh redirects after 5 seconds. + * This is a proprietary, non-standard header extension introduced by Netscape and supported by most web browsers. + * + * Example: `authentication-control: 'max-age=3600'` + */ + 'authentication-info'?: string; + + /** + * An HTTP cookie previously sent by the server with `Set-Cookie` (sent when connecting to a proxy) + * + * Example: `connection: 'keep-alive'` + */ + connection?: string; + + /** + * The MIME type of the body of the request (used with POST and PUT requests) + * + * Example: `content-range: 'bytes 200-1000/67589'` + */ + 'content-range'?: string; + + /** + * The date and time that the message was sent (in "HTTP-date" format as defined by RFC 7231) + * + * Example: `content-security-policy: 'default-src 'self'; img-src *'` + */ + 'content-security-policy'?: string; + + /** + * Control options for the current connection and list of hop-by-hop response fields. + * + * Example: `content-security-policy-report-only: 'default-src 'self'; report-uri /csp-violation-report-endpoint/'` + */ + 'content-security-policy-report-only'?: string; + + /** + * An identifier for a specific dialog in the browser (for cross-document communication), such as prompting the user + * for a username and password + * + * Example: `cross-origin-embedder-policy: 'require-corp'` + */ + 'cross-origin-embedder-policy'?: string; + + /** + * An optional token returned by an origin in response to a preflight request + * that includes the `Access-Control-Request-Headers` to indicate that the actual request can include + * those headers. + * + * Example: `cross-origin-opener-policy: 'same-origin'` + */ + 'cross-origin-opener-policy'?: string; + + /** + * The destination of a message (e-mail) + * + * Example: `cross-origin-resource-policy: 'cross-origin'` + */ + 'cross-origin-resource-policy'?: string; + + /** + * Requests HTTP Public Key Pinning (HPKP) to associate a specific cryptographic public key with a certain web server + * to decrease the risk of MITM attacks with forged certificates. Deprecated and removed from Browsers + * + * Example: `device-memory: '0.25'` + */ + 'device-memory'?: string; + + /** + * Used to identify the protocol at the application layer of the OSI model + * + * Example: `dnt: '1'` + */ + dnt?: string; + + /** + * The `Expect` HTTP header indicates expectations that need to be fulfilled by the server in order to properly + * handle the request. + * + * Example: `downlink: '10'` + */ + downlink?: string; + + /** + * Specifies the effective connection type the user agent has to the network. + * + * Example: `ect: '4g'` + */ + ect?: string; + + /** + * The `Early-Data` header indicates a request that includes an Early Data body + * + * Example: `early-data: '1'` + */ + 'early-data'?: string; + + /** + * The `Expect-CT` header is used by a server to indicate that browsers should evaluate connections to the host + * for Certificate Transparency compliance and report failures to the specified URI. Deprecated and removed from browsers. + * + * Example: `expect: '100-continue'` + */ + 'expect-ct'?: string; + + /** + * Additional information about the client or user agent, typically for statistical purposes + * or for determining the capabilities of the client software + * + * Example: `expect-ct: 'max-age=86400, report-uri="https://report-uri.example.com/report"'` + */ + forwarded?: string; + + /** + * The `Keep-Alive` general header allows the sender to hint about how the connection may be used to + * set a timeout and a maximum amount of requests. + * + * Example: `keep-alive: 'timeout=5, max=1000'` + */ + 'keep-alive'?: string; + + /** + * Specifies the preferred maximum estimated round trip time (rtt) of the connection + * + * Example: `large-allocation: '1'` + */ + 'large-allocation'?: string; + + /** + * The `Last-Event-ID` header identifies the last event ID processed by the client. + * + * Example: `last-event-id: '123'` + */ + 'last-event-id'?: string; + + /** + * An arbitrary, opaque byte sequence used for linking multiple requests together + * + * Example: `link: '; rel="alternate"'` + */ + link?: string; + + /** + * Used with the Location response header to indicate the identifier of the payload body sent in the request + * + * Example: `location: '/new/document'` + */ + origin?: string; + + /** + * The `Ping-From` header specifies a URI where a pong response may be sent. + * + * Example: `ping-from: 'https://example.com/pong'` + */ + 'ping-from'?: string; + + /** + * The `Ping-To` header specifies a URI that will accept a pong response. + * + * Example: `ping-to: 'https://example.com/pong'` + */ + 'ping-to'?: string; + + // ... (Previous headers from the previous response) ... + + /** + * Initiates an HTTP 2 Server Push. This is a request for the server to push the given resources to the client in + * anticipation of their use. + * + * Example: `push-policy: 'push_critical_resources_first'` + */ + 'push-policy'?: string; + + /** + * The `Purpose` header is used to indicate the purpose of the present request + * (such as prefetch, prerender, or an actual browse). + * + * Example: `purpose: 'prefetch'` + */ + purpose?: string; + + /** + * Used to indicate the part of a document to return. + * + * Example: `referrer-policy: 'no-referrer'` + */ + 'referrer-policy'?: string; + + /** + * The `Retry-After` response HTTP header indicates how long the user agent should wait + * before making a follow-up request. + * + * Example: `retry-after: '3600'` + */ + 'retry-after'?: string; + + /** + * The `Save-Data` client hint request header indicates the user's preference for reduced data usage. + * + * Example: `save-data: 'on'` + */ + 'save-data'?: string; + + /** + * The `Sec-Fetch-Dest` header indicates the request's destination. It can be one of the following values: + * - audio: An audio file. + * - audioworklet: An audio worklet. + * - document: A document. + * - embed: An embedded resource. + * - empty: An empty response (e.g., in response to a HEAD request). + * - font: A font file. + * - frame: An iframe. + * - image: An image file. + * - manifest: A manifest file. + * - object: An object or an EMBED element. + * - paintworklet: A paint worklet. + * - report: A report. + * - script: A script. + * - serviceworker: A service worker. + * - sharedworker: A shared worker. + * - style: A stylesheet. + * - track: A track file. + * - video: A video file. + * - worker: A dedicated worker. + * - xslt: An XSLT stylesheet. + * + * Example: `sec-fetch-dest: 'image'` + */ + 'sec-fetch-dest'?: string; + + /** + * The `Sec-Fetch-Mode` header indicates how the resource was fetched. + * It can be one of the following values: + * - cors: A cross-origin request using the CORS protocol. + * - navigate: A navigation request. + * - nested-navigate: A nested navigation request. + * - no-cors: A simple cross-origin request that does not use CORS. + * - same-origin: A same-origin request. + * - websocket: A WebSocket request. + * + * Example: `sec-fetch-mode: 'cors'` + */ + 'sec-fetch-mode'?: string; + + /** + * The `Sec-Fetch-Site` header indicates the relationship between the site + * making the request and the site hosting the resource. + * It can be one of the following values: + * - cross-site: The request is made to a different site than the one the request + * originated from, including when the first-party and third-party sites have the same owner. + * - same-origin: The request is made to the same site (the same scheme, host, and port). + * - same-site: The request is made to a different site, but both sites share the same + * registered domain name (eTLD+1). + * - none: The request is made to a data URL or Blob URL. + * + * Example: `sec-fetch-site: 'cross-site'` + */ + 'sec-fetch-site'?: string; + + /** + * The `Sec-Fetch-User` header indicates whether the resource request was initiated by a user gesture or not. + * It can be one of the following values: + * - ?1: The request was initiated by a user gesture. + * - ?0: The request was not initiated by a user gesture. + * + * Example: `sec-fetch-user: '?1'` + */ + 'sec-fetch-user'?: string; + + /** + * The `Sec-GPC` HTTP header is a signal that the user prefers a Global Privacy Control setting + * of 1, meaning "Do Not Sell or Share My Personal Information." + * + * Example: `sec-gpc: '1'` + */ + 'sec-gpc'?: string; + + /** + * The `Sec-WebSocket-Accept` header field is used in the WebSocket opening handshake. + * It is sent from the server to the client to confirm that the server is willing to initiate a WebSocket connection. + * + * Example: `sec-websocket-accept: 's3pPLMBiTxaQ9kYGzzhZRbK+xOo='` + */ + 'sec-websocket-accept'?: string; + + // ... (Previous headers from the previous response) ... + + /** + * The `Sec-WebSocket-Extensions` header field is used in the WebSocket opening handshake. + * It is sent from the client to the server to indicate which extensions it would like to use, + * and from the server to the client to indicate which extensions the server is willing to use. + * + * Example: `sec-websocket-extensions: 'permessage-deflate; client_max_window_bits'` + */ + 'sec-websocket-extensions'?: string; + + /** + * The `Sec-WebSocket-Key` header field is used in the WebSocket opening handshake. + * It is sent from the client to the server to provide a random value that the server + * will use to generate the `Sec-WebSocket-Accept` header field. + * + * Example: `sec-websocket-key: 'dGhlIHNhbXBsZSBub25jZQ=='` + */ + 'sec-websocket-key'?: string; + + /** + * The `Sec-WebSocket-Protocol` header field is used in the WebSocket opening handshake. + * It is sent from the client to the server to indicate which subprotocols it would like to use, + * and from the server to the client to indicate which subprotocol the server has selected. + * + * Example: `sec-websocket-protocol: 'chat, superchat'` + */ + 'sec-websocket-protocol'?: string; + + /** + * The `Sec-WebSocket-Version` header field is used in the WebSocket opening handshake. + * It is sent from the client to the server to indicate which version of the WebSocket protocol it is using. + * + * Example: `sec-websocket-version: '13'` + */ + 'sec-websocket-version'?: string; + + /** + * The `Server` header field contains information about the software used by the origin server + * to handle the request. + * + * Example: `server: 'Apache/2.4.1 (Unix)'` + */ + server?: string; + + /** + * The `Service-Worker-Navigation-Preload` header is used to control the behavior of + * service worker navigation preloads. + * + * Example: `service-worker-navigation-preload: 'true'` + */ + 'service-worker-navigation-preload'?: string; + + /** + * The `SourceMap` or `X-SourceMap` HTTP header links a generated code file (such as a JavaScript or CSS file) + * to an original source code file, enabling developers to debug the generated code + * in the context of the original source code. + * + * Example: `sourcemap: '/path/to/file.js.map'` + */ + sourcemap?: string; + + /** + * The `Strict-Transport-Security` (HSTS) response header informs browsers that a website + * should only be accessed using HTTPS, and that any future attempts to access it using HTTP should automatically + * be converted to HTTPS. + * + * Example: `strict-transport-security: 'max-age=31536000; includeSubDomains'` + */ + 'strict-transport-security'?: string; + + /** + * The `TE` header specifies the transfer encodings that the user agent is willing to accept + * in the response and indicates a preference for chunked transfer encoding if the server supports it. + * + * Example: `te: 'trailers, deflate'` + */ + te?: string; + + /** + * The `Timing-Allow-Origin` response header specifies origins that are allowed to see values of attributes + * retrieved via features of the Resource Timing API, which would otherwise be reported as zero due to cross-origin restrictions. + * + * Example: `timing-allow-origin: 'https://www.example.com'` + */ + 'timing-allow-origin'?: string; + + /** + * The `Trailer` general header indicates that the given set of header fields + * will be present in the trailer of a message encoded with chunked transfer encoding. + * + * Example: `trailer: 'Expires'` + */ + trailer?: string; + + /** + * The `Transfer-Encoding` header field lists the transfer encodings applied to the message body + * in order to ensure safe and proper transfer of the message. + * + * Example: `transfer-encoding: 'chunked'` + */ + 'transfer-encoding'?: string; + + /** + * The `Upgrade-Insecure-Requests` header sends a signal to the server expressing the client’s preference + * for an encrypted and authenticated response, and that it can successfully handle the upgrade-insecure-requests CSP directive. + * + * Example: `upgrade-insecure-requests: '1'` + */ + 'upgrade-insecure-requests'?: string; + + /** + * The `Want-Digest` header field specifies one or more digest algorithms that the client would like to + * receive applied to the message body of a response. + * + * Example: `want-digest: 'SHA-256'` + */ + 'want-digest'?: string; + + /** + * The `X-Content-Type-Options` response HTTP header indicates whether or not the browser should sniff (determine) + * the MIME type of a file. + * + * Example: `x-content-type-options: 'nosniff'` + */ + 'x-content-type-options'?: string; + + /** + * The `X-DNS-Prefetch-Control` HTTP header controls DNS prefetching, a feature by which browsers proactively + * perform domain name resolution on both links that the user may choose to follow as well as URLs for items referenced + * by the document, including images, scripts, and style sheets. + * + * Example: `x-dns-prefetch-control: 'off'` + */ + 'x-dns-prefetch-control'?: string; + + /** + * The `X-Forwarded-For` (XFF) header is a de-facto standard header for identifying the originating IP address + * of a client connecting to a web server through an HTTP proxy or a load balancer. + * + * Example: `x-forwarded-for: 'client1, proxy1, proxy2'` + */ + 'x-forwarded-for'?: string; + + /** + * The `X-Forwarded-Host` (XFH) header is a de-facto standard header for identifying the original host requested by the client + * in the Host HTTP request header, since the Host header is usually overwritten by proxies. + * + * Example: `x-forwarded-host: 'en.wikipedia.org'` + */ + 'x-forwarded-host'?: string; + + /** + * The `X-Forwarded-Proto` (XFP) header is a de-facto standard header for identifying the protocol (HTTP or HTTPS) that a client + * used to connect to your proxy or load balancer. + * + * Example: `x-forwarded-proto: 'https'` + */ + 'x-forwarded-proto'?: string; + + /** + * The `X-Frame-Options` HTTP response header can be used to indicate whether or not a browser should be allowed + * to render a page in a ``, `