diff --git a/packages/spacecat-shared-http-utils/.jsdoc.json b/packages/spacecat-shared-http-utils/.jsdoc.json new file mode 100644 index 00000000..405090f4 --- /dev/null +++ b/packages/spacecat-shared-http-utils/.jsdoc.json @@ -0,0 +1,17 @@ +{ + "plugins": [], + "recurseDepth": 10, + "source": { + "includePattern": ".+\\.js(doc|x)?$", + "excludePattern": "(^|\\/|\\\\)_" + }, + "sourceType": "module", + "tags": { + "allowUnknownTags": true, + "dictionaries": ["jsdoc","closure"] + }, + "templates": { + "cleverLinks": false, + "monospaceLinks": false + } +} \ No newline at end of file diff --git a/packages/spacecat-shared-http-utils/.mocha-multi.json b/packages/spacecat-shared-http-utils/.mocha-multi.json new file mode 100644 index 00000000..aa2be2a2 --- /dev/null +++ b/packages/spacecat-shared-http-utils/.mocha-multi.json @@ -0,0 +1,6 @@ +{ + "reporterEnabled": "spec,xunit", + "xunitReporterOptions": { + "output": "junit/test-results.xml" + } +} diff --git a/packages/spacecat-shared-http-utils/.npmignore b/packages/spacecat-shared-http-utils/.npmignore new file mode 100644 index 00000000..868317d2 --- /dev/null +++ b/packages/spacecat-shared-http-utils/.npmignore @@ -0,0 +1,9 @@ +coverage/ +node_modules/ +junit/ +test/ +docs/ +logs/ +test-results.xml +renovate.json +.* diff --git a/packages/spacecat-shared-http-utils/.nycrc.json b/packages/spacecat-shared-http-utils/.nycrc.json new file mode 100644 index 00000000..78e7a0b1 --- /dev/null +++ b/packages/spacecat-shared-http-utils/.nycrc.json @@ -0,0 +1,10 @@ +{ + "reporter": [ + "lcov", + "text" + ], + "check-coverage": true, + "lines": 100, + "branches": 97, + "statements": 100 +} diff --git a/packages/spacecat-shared-http-utils/LICENSE.txt b/packages/spacecat-shared-http-utils/LICENSE.txt new file mode 100644 index 00000000..883ab098 --- /dev/null +++ b/packages/spacecat-shared-http-utils/LICENSE.txt @@ -0,0 +1,264 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + +APACHE JACKRABBIT SUBCOMPONENTS + +Apache Jackrabbit includes parts with separate copyright notices and license +terms. Your use of these subcomponents is subject to the terms and conditions +of the following licenses: + + XPath 2.0/XQuery 1.0 Parser: + http://www.w3.org/2002/11/xquery-xpath-applets/xgrammar.zip + + Copyright (C) 2002 World Wide Web Consortium, (Massachusetts Institute of + Technology, European Research Consortium for Informatics and Mathematics, + Keio University). All Rights Reserved. + + This work is distributed under the W3C(R) Software License 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. + + W3C(R) SOFTWARE NOTICE AND LICENSE + http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231 + + This work (and included software, documentation such as READMEs, or + other related items) is being provided by the copyright holders under + the following license. By obtaining, using and/or copying this work, + you (the licensee) agree that you have read, understood, and will comply + with the following terms and conditions. + + Permission to copy, modify, and distribute this software and its + documentation, with or without modification, for any purpose and + without fee or royalty is hereby granted, provided that you include + the following on ALL copies of the software and documentation or + portions thereof, including modifications: + + 1. The full text of this NOTICE in a location viewable to users + of the redistributed or derivative work. + + 2. Any pre-existing intellectual property disclaimers, notices, + or terms and conditions. If none exist, the W3C Software Short + Notice should be included (hypertext is preferred, text is + permitted) within the body of any redistributed or derivative code. + + 3. Notice of any changes or modifications to the files, including + the date changes were made. (We recommend you provide URIs to the + location from which the code is derived.) + + THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT + HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, + INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS + FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR + DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, + TRADEMARKS OR OTHER RIGHTS. + + COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL + OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR + DOCUMENTATION. + + The name and trademarks of copyright holders may NOT be used in + advertising or publicity pertaining to the software without specific, + written prior permission. Title to copyright in this software and + any associated documentation will at all times remain with + copyright holders. diff --git a/packages/spacecat-shared-http-utils/README.md b/packages/spacecat-shared-http-utils/README.md new file mode 100644 index 00000000..87c7ba31 --- /dev/null +++ b/packages/spacecat-shared-http-utils/README.md @@ -0,0 +1,87 @@ +# Response Helper Functions. + +A set of TypeScript functions for creating HTTP responses with standardized formats. + +## Table of Contents + +- [Introduction](#introduction) +- [Installation](#installation) +- [Usage](#usage) +- [API](#api) +- [Contributing](#contributing) +- [License](#license) + +## Introduction + +This library provides a collection of functions related to http to be used in Spacecat development. The functions are designed to create responses with standardized formats, making it easier to maintain a consistent structure across different parts of your application. + +## Installation + +Install the package using npm or yarn: + +```bash +npm install @adobe/spacecat-shared-http-utils +``` + +or + +```bash +yarn add @adobe/spacecat-shared-http-utils +``` + +## Usage + +Import the functions in your TypeScript file and use them to generate HTTP responses. Here's an example: + +```typescript +import { + ok, + noContent, + badRequest, + notFound, + internalServerError, +} from '@adobe/spacecat-shared-http-utils'; + +// Example usage +const successResponse: Response = ok('Request was successful'); + +const emptyResponse: Response = noContent(); + +const errorResponse: Response = badRequest('Invalid input'); + +const notFoundResponse: Response = notFound('Resource not found'); + +const serverErrorResponse: Response = internalServerError('Something went wrong'); +``` + +## API + +### `ok(body?: string): Response` + +Creates a successful response with an optional body. + +### `noContent(headers?: Headers): Response` + +Creates a response with no content and optional headers. + +### `badRequest(message: string, headers?: Headers): Response` + +Creates a response for a bad request with an error message and optional headers. + +### `notFound(message: string, headers?: Headers): Response` + +Creates a response for a not found scenario with an error message and optional headers. + +### `internalServerError(message: string, headers?: Headers): Response` + +Creates a response for an internal server error with an error message and optional headers. + + +## Contributing + +Feel free to contribute by opening issues or creating pull requests. Please follow the existing coding style and include tests when adding new features. + +## License + +This project is licensed under the Apache 2.0 - see the [LICENSE](LICENSE) file for details. + diff --git a/packages/spacecat-shared-http-utils/package.json b/packages/spacecat-shared-http-utils/package.json new file mode 100644 index 00000000..d4db2e92 --- /dev/null +++ b/packages/spacecat-shared-http-utils/package.json @@ -0,0 +1,37 @@ +{ + "name": "@adobe/spacecat-shared-http-utils", + "version": "1.0.0", + "description": "Shared modules of the Spacecat Services - HTTP Utils", + "type": "module", + "main": "src/index.js", + "types": "src/index.d.ts", + "scripts": { + "test": "c8 mocha", + "lint": "eslint .", + "clean": "rm -rf package-lock.json node_modules" + }, + "mocha": { + "reporter": "mocha-multi-reporters", + "reporter-options": "configFile=.mocha-multi.json", + "spec": "test/*.test.js" + }, + "repository": { + "type": "git", + "url": "https://github.com/adobe-rnd/spacecat-shared.git" + }, + "author": "", + "license": "Apache-2.0", + "bugs": { + "url": "https://github.com/adobe-rnd/spacecat-shared/issues" + }, + "homepage": "https://github.com/adobe-rnd/spacecat-shared#readme", + "publishConfig": { + "access": "public" + }, + "dependencies": { + "@adobe/fetch": "4.1.1" + }, + "devDependencies": { + "chai": "4.3.10" + } +} diff --git a/packages/spacecat-shared-http-utils/src/index.d.ts b/packages/spacecat-shared-http-utils/src/index.d.ts new file mode 100644 index 00000000..d7a89a5c --- /dev/null +++ b/packages/spacecat-shared-http-utils/src/index.d.ts @@ -0,0 +1,22 @@ +/* + * Copyright 2021 Adobe. All rights reserved. + * This file is licensed to you under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. You may obtain a copy + * of the License at http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under + * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS + * OF ANY KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. + */ +import { Response } from '@adobe/fetch'; + +export declare function ok(body?: string): Response; + +export declare function noContent(headers?: object): Response; + +export declare function badRequest(message?: string, headers?: object): Response; + +export declare function notFound(message?: string, headers?: object): Response; + +export declare function internalServerError(message?: string, headers?: object): Response; diff --git a/packages/spacecat-shared-utils/src/http-utils.js b/packages/spacecat-shared-http-utils/src/index.js similarity index 69% rename from packages/spacecat-shared-utils/src/http-utils.js rename to packages/spacecat-shared-http-utils/src/index.js index c6ed9df3..a69a721e 100644 --- a/packages/spacecat-shared-utils/src/http-utils.js +++ b/packages/spacecat-shared-http-utils/src/index.js @@ -21,31 +21,38 @@ import { Response } from '@adobe/fetch'; */ export function createResponse(body, status = 200, headers = {}) { return new Response( - JSON.stringify(body), + body === '' ? '' : JSON.stringify(body), { headers: { 'content-type': 'application/json; charset=utf-8', ...headers }, status, }, ); } -export function ok(body) { +export function ok(body = '') { return createResponse(body, 200); } -export function noContent(headers) { +export function noContent(headers = {}) { return createResponse('', 204, headers); } -export function badRequest(message) { - return createResponse({ message }, 400); +export function badRequest(message = 'bad request', headers = {}) { + return createResponse({ message }, 400, { + 'x-error': message, + ...headers, + }); } -export function notFound(message) { - return createResponse({ message }, 404); +export function notFound(message = 'not found', headers = {}) { + return createResponse({ message }, 404, { + 'x-error': message, + ...headers, + }); } -export function internalServerError(message) { +export function internalServerError(message = 'internal server error', headers = {}) { return createResponse({ message }, 500, { - 'x-error': `internal server error: ${message}`, + 'x-error': message, + ...headers, }); } diff --git a/packages/spacecat-shared-http-utils/test/index.test.js b/packages/spacecat-shared-http-utils/test/index.test.js new file mode 100644 index 00000000..31fe500c --- /dev/null +++ b/packages/spacecat-shared-http-utils/test/index.test.js @@ -0,0 +1,98 @@ +/* + * Copyright 2023 Adobe. All rights reserved. + * This file is licensed to you under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. You may obtain a copy + * of the License at http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under + * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS + * OF ANY KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. + */ +/* eslint-env mocha */ +import { expect } from 'chai'; +import { + ok, badRequest, notFound, internalServerError, noContent, +} from '../src/index.js'; + +describe('HTTP Response Functions', () => { + it('ok should return a 200 OK response with default body', async () => { + const response = await ok(); + expect(response.status).to.equal(200); + const responseBody = await response.text(); + expect(responseBody).to.equal(''); + }); + + it('ok should return a 200 OK response with custom body', async () => { + const response = await ok({ success: true }); + expect(response.status).to.equal(200); + const responseBody = await response.json(); + expect(responseBody).to.deep.equal({ success: true }); + }); + + it('noContent should return a 204 No Content response with default headers', async () => { + const response = await noContent(); + expect(response.status).to.equal(204); + expect(response.headers.get('content-type')).to.equal('application/json; charset=utf-8'); + const responseBody = await response.text(); + expect(responseBody).to.equal(''); + }); + + it('noContent should return a 204 No Content response with custom headers', async () => { + const response = await noContent({ 'custom-header': 'value' }); + expect(response.status).to.equal(204); + const responseBody = await response.text(); + expect(responseBody).to.equal(''); + }); + + it('badRequest should return a 400 Bad Request response with default message and headers', async () => { + const response = await badRequest(); + expect(response.status).to.equal(400); + expect(response.headers.get('x-error')).to.equal('bad request'); + const responseBody = await response.json(); + expect(responseBody).to.deep.equal({ message: 'bad request' }); + }); + + it('badRequest should return a 400 Bad Request response with custom message and headers', async () => { + const response = await badRequest('Invalid input', { 'custom-header': 'value' }); + expect(response.status).to.equal(400); + expect(response.headers.get('x-error')).to.equal('Invalid input'); + expect(response.headers.get('custom-header')).to.equal('value'); + const responseBody = await response.json(); + expect(responseBody).to.deep.equal({ message: 'Invalid input' }); + }); + + it('notFound should return a 404 Not Found response with default message and headers', async () => { + const response = await notFound(); + expect(response.status).to.equal(404); + expect(response.headers.get('x-error')).to.equal('not found'); + const responseBody = await response.json(); + expect(responseBody).to.deep.equal({ message: 'not found' }); + }); + + it('notFound should return a 404 Not Found response with custom message and headers', async () => { + const response = await notFound('Resource not found', { 'custom-header': 'value' }); + expect(response.status).to.equal(404); + expect(response.headers.get('x-error')).to.equal('Resource not found'); + expect(response.headers.get('custom-header')).to.equal('value'); + const responseBody = await response.json(); + expect(responseBody).to.deep.equal({ message: 'Resource not found' }); + }); + + it('internalServerError should return a 500 Internal Server Error response with default message and headers', async () => { + const response = await internalServerError(); + expect(response.status).to.equal(500); + expect(response.headers.get('x-error')).to.equal('internal server error'); + const responseBody = await response.json(); + expect(responseBody).to.deep.equal({ message: 'internal server error' }); + }); + + it('internalServerError should return a 500 Internal Server Error response with custom message and headers', async () => { + const response = await internalServerError('Server error occurred', { 'custom-header': 'value' }); + expect(response.status).to.equal(500); + expect(response.headers.get('x-error')).to.equal('Server error occurred'); + expect(response.headers.get('custom-header')).to.equal('value'); + const responseBody = await response.json(); + expect(responseBody).to.deep.equal({ message: 'Server error occurred' }); + }); +}); diff --git a/packages/spacecat-shared-utils/README.md b/packages/spacecat-shared-utils/README.md index 3dfb186a..8734f467 100644 --- a/packages/spacecat-shared-utils/README.md +++ b/packages/spacecat-shared-utils/README.md @@ -45,13 +45,6 @@ The library includes the following utility functions: - `hasText(str)`: Checks if the given string is not empty. - `dateAfterDays(number)`: Calculates the date after a specified number of days from the current date. -The library includes the following http utility functions to create `Response` objects: - -- `ok(body)`: Creates a 200 response with a JSON body. -- `badRequest(message)`: Creates a 400 response with a JSON body. -- `notFound(message)`: Creates a 404 response with a JSON body. -- `internalServerError(message)`: Creates a 500 response with a JSON body. - ## Testing This library includes a comprehensive test suite to ensure the reliability of the utility functions. To run the tests, use the following command: diff --git a/packages/spacecat-shared-utils/src/index.d.ts b/packages/spacecat-shared-utils/src/index.d.ts index 26147e79..0aaa36d9 100644 --- a/packages/spacecat-shared-utils/src/index.d.ts +++ b/packages/spacecat-shared-utils/src/index.d.ts @@ -36,33 +36,3 @@ export function toBoolean(value: unknown): boolean; export function isValidUrl(urlString: string): boolean; export function dateAfterDays(days: string): Date; - -/** HTTP UTILS */ - -/** - * Creates a 200 response with a JSON body. - * @param {object} body - JSON body. - * @return {Response} Response. - */ -export function ok(body: object): Response; - -/** - * Creates a 400 response with a JSON body. - * @param {string} message - Error message. - * @return {Response} Response. - */ -export function badRequest(message: string): Response; - -/** - * Creates a 404 response with a JSON body. - * @param {string} message - Error message. - * @return {Response} Response. - */ -export function notFound(message: string): Response; - -/** - * Creates a 500 response with a JSON body. - * @param {string} message - Error message. - * @return {Response} Response. - */ -export function internalServerError(message: string): Response; diff --git a/packages/spacecat-shared-utils/src/index.js b/packages/spacecat-shared-utils/src/index.js index a7c8036a..1378686b 100644 --- a/packages/spacecat-shared-utils/src/index.js +++ b/packages/spacecat-shared-utils/src/index.js @@ -27,12 +27,4 @@ export { dateAfterDays, } from './functions.js'; -export { - ok, - noContent, - badRequest, - notFound, - internalServerError, -} from './http-utils.js'; - export { resolveSecretsName } from './helpers.js'; diff --git a/packages/spacecat-shared-utils/test/http-utils.test.js b/packages/spacecat-shared-utils/test/http-utils.test.js deleted file mode 100644 index ff36167a..00000000 --- a/packages/spacecat-shared-utils/test/http-utils.test.js +++ /dev/null @@ -1,62 +0,0 @@ -/* - * Copyright 2023 Adobe. All rights reserved. - * This file is licensed to you under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. You may obtain a copy - * of the License at http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software distributed under - * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS - * OF ANY KIND, either express or implied. See the License for the specific language - * governing permissions and limitations under the License. - */ -/* eslint-env mocha */ -import { expect } from 'chai'; -import { - ok, badRequest, notFound, internalServerError, noContent, -} from '../src/http-utils.js'; - -describe('http-utils', () => { - it('ok should return a 200 response with JSON body', async () => { - const body = { key: 'value' }; - const response = ok(body); - expect(response.status).to.equal(200); - expect(response.headers.get('content-type')).to.equal('application/json; charset=utf-8'); - const respJson = await response.json(); - expect(respJson).to.eql(body); - }); - - it('ok should return a 204 response with JSON body', async () => { - const headers = { key: 'value' }; - const response = noContent(headers); - expect(response.status).to.equal(204); - expect(response.headers.get('content-type')).to.equal('application/json; charset=utf-8'); - expect(response.headers.get('key')).to.equal('value'); - const respJson = await response.json(); - expect(respJson).to.eql(''); - }); - - it('badRequest should return a 400 response with JSON body', async () => { - const response = badRequest('Bad Request'); - expect(response.status).to.equal(400); - expect(response.headers.get('content-type')).to.equal('application/json; charset=utf-8'); - const respJson = await response.json(); - expect(respJson).to.eql({ message: 'Bad Request' }); - }); - - it('notFound return a 404 response with JSON body', async () => { - const response = notFound('Not Found'); - expect(response.status).to.equal(404); - expect(response.headers.get('content-type')).to.equal('application/json; charset=utf-8'); - const respJson = await response.json(); - expect(respJson).to.eql({ message: 'Not Found' }); - }); - - it('internalServerError should return a 500 response with JSON body', async () => { - const response = internalServerError('uh oh'); - expect(response.status).to.equal(500); - expect(response.headers.get('content-type')).to.equal('application/json; charset=utf-8'); - expect(response.headers.get('x-error')).to.equal('internal server error: uh oh'); - const respJson = await response.json(); - expect(respJson).to.eql({ message: 'uh oh' }); - }); -}); diff --git a/packages/spacecat-shared-utils/test/index.test.js b/packages/spacecat-shared-utils/test/index.test.js index 3f7bc8da..e6333939 100644 --- a/packages/spacecat-shared-utils/test/index.test.js +++ b/packages/spacecat-shared-utils/test/index.test.js @@ -32,11 +32,6 @@ describe('Index Exports', () => { 'isValidUrl', 'resolveSecretsName', 'dateAfterDays', - 'ok', - 'noContent', - 'badRequest', - 'notFound', - 'internalServerError', ]; it('exports all expected functions', () => {