{"_id":"@aprendizap/aws-lambda-responses","_rev":"2-246425cc6ad2dde06efbaa6a6c1c4440","name":"@aprendizap/aws-lambda-responses","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"@aprendizap/aws-lambda-responses","version":"1.0.0","keywords":["aws","lambda"],"author":{"name":"Flavio Cunha"},"license":"MIT","_id":"@aprendizap/aws-lambda-responses@1.0.0","maintainers":[{"name":"flaugusto","email":"augustof.cunha@outlook.com"}],"homepage":"https://github.com/Fundacao-1Bi/aws-lambda-response#readme","bugs":{"url":"https://github.com/Fundacao-1Bi/aws-lambda-response/issues"},"dist":{"shasum":"5130cc6b3726889d526b7f01eba1da41b7d905ea","tarball":"https://registry.npmjs.org/@aprendizap/aws-lambda-responses/-/aws-lambda-responses-1.0.0.tgz","fileCount":13,"integrity":"sha512-oZJ8tMVTzyMdh6wzfRQCx3hH2YvhnD6yg7xEtM5t2DNaHXb+7Ml59Igm5czOgVvZRsQQfKpPT9WRx3dQYgSX8w==","signatures":[{"sig":"MEQCIC40n8PD2YpKY+Vq4Fr/qDzEUOLst9BhMIrPWvPPkV4iAiAP5y38HZN5SpUzmFtRhFnZaKnOocrxIFVOfCvjWt/Urw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":23102},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"708ce79c11c63d5576a75319630cce357be8013f","scripts":{"test":"jest","build":"tsc","clean":"rm -rf dist","prepublish":"npm run clean && npm run build"},"_npmUser":{"name":"flaugusto","email":"augustof.cunha@outlook.com"},"repository":{"url":"git+https://github.com/Fundacao-1Bi/aws-lambda-response.git","type":"git"},"_npmVersion":"9.6.7","description":"This module contains some wrappers to create the response object for AWS Lambda functions.","directories":{},"_nodeVersion":"18.17.0","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","ts-jest":"^29.1.1","ts-node":"^10.9.1","typescript":"^5.3.2","@types/jest":"^29.5.10"},"_npmOperationalInternal":{"tmp":"tmp/aws-lambda-responses_1.0.0_1700894222822_0.7391235055207781","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@aprendizap/aws-lambda-responses","version":"1.0.1","keywords":["aws","lambda"],"author":{"name":"Flavio Cunha"},"license":"MIT","_id":"@aprendizap/aws-lambda-responses@1.0.1","maintainers":[{"name":"flaugusto","email":"augustof.cunha@outlook.com"}],"homepage":"https://github.com/Fundacao-1Bi/aws-lambda-response#readme","bugs":{"url":"https://github.com/Fundacao-1Bi/aws-lambda-response/issues"},"dist":{"shasum":"26433fc64274f724160dc89970b6f71995574d21","tarball":"https://registry.npmjs.org/@aprendizap/aws-lambda-responses/-/aws-lambda-responses-1.0.1.tgz","fileCount":13,"integrity":"sha512-ZOlhs47reBxOZgO6Nu4bPY/xxGjVgfc7WzCd9HdyBqQ6HHyuIgpABSYH8LCM17QySPFYeheeQvtxTBH/CyDkgg==","signatures":[{"sig":"MEUCIFyaP2qLef22MQ7VjfQSElkGzxPeYon8wlygyj0pbDc7AiEApoWPxJRGU5SkBUVe8gG7CGTGVBMeDJ1KfzXoOax9/Wk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":24981},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"2d59dd8ec237184588ab7060417f72d2d54391fd","scripts":{"test":"jest","build":"tsc","clean":"rm -rf dist","prepublish":"npm run clean && npm run build"},"_npmUser":{"name":"flaugusto","email":"augustof.cunha@outlook.com"},"repository":{"url":"git+https://github.com/Fundacao-1Bi/aws-lambda-response.git","type":"git"},"_npmVersion":"9.6.7","description":"This module contains some wrappers to create the response object for AWS Lambda functions.","directories":{},"_nodeVersion":"18.17.0","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","ts-jest":"^29.1.1","ts-node":"^10.9.1","typescript":"^5.3.2","@types/jest":"^29.5.10"},"_npmOperationalInternal":{"tmp":"tmp/aws-lambda-responses_1.0.1_1702990760746_0.8834366245269265","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@aprendizap/aws-lambda-responses","version":"1.0.2","description":"This module contains some wrappers to create the response object for AWS Lambda functions.","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"test":"jest","build":"tsc","clean":"rm -rf dist","prepublish":"npm run clean && npm run build"},"keywords":["aws","lambda"],"author":{"name":"Flavio Cunha"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/Fundacao-1Bi/aws-lambda-response.git"},"bugs":{"url":"https://github.com/Fundacao-1Bi/aws-lambda-response/issues"},"homepage":"https://github.com/Fundacao-1Bi/aws-lambda-response#readme","devDependencies":{"@types/jest":"^29.5.10","jest":"^29.7.0","ts-jest":"^29.1.1","ts-node":"^10.9.1","typescript":"^5.3.2"},"_id":"@aprendizap/aws-lambda-responses@1.0.2","gitHead":"c6118f37a15f4561275a6c573946aa83f73ec9f8","_nodeVersion":"20.11.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-6VTXCCe/F/WFOGJZvAnq1oe2U+P8DRXFCT/FZOjj1S9fkdd9WjYOwRMU2p7dTXSR+v4B8c5xoEKNY5tFbJba/g==","shasum":"211c72ba028fa7908872eefbfbf9a76d7ecae2e6","tarball":"https://registry.npmjs.org/@aprendizap/aws-lambda-responses/-/aws-lambda-responses-1.0.2.tgz","fileCount":13,"unpackedSize":27633,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDI8eV6Uam6se7DZQoCl3cNMdf6VbOntb3WL0OLpZuVXQIhANEUxEZ4Fp/zuJ7yMzXEdFiG6y+EcG/6B3tMJ03lUcYp"}]},"_npmUser":{"name":"flaugusto","email":"augustof.cunha@outlook.com"},"directories":{},"maintainers":[{"name":"flaugusto","email":"augustof.cunha@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/aws-lambda-responses_1.0.2_1736801141263_0.07692845801006132"},"_hasShrinkwrap":false}},"time":{"created":"2023-11-25T06:37:02.702Z","modified":"2025-01-13T20:45:41.675Z","1.0.0":"2023-11-25T06:37:03.046Z","1.0.1":"2023-12-19T12:59:20.900Z","1.0.2":"2025-01-13T20:45:41.466Z"},"bugs":{"url":"https://github.com/Fundacao-1Bi/aws-lambda-response/issues"},"author":{"name":"Flavio Cunha"},"license":"MIT","homepage":"https://github.com/Fundacao-1Bi/aws-lambda-response#readme","keywords":["aws","lambda"],"repository":{"type":"git","url":"git+https://github.com/Fundacao-1Bi/aws-lambda-response.git"},"description":"This module contains some wrappers to create the response object for AWS Lambda functions.","maintainers":[{"name":"flaugusto","email":"augustof.cunha@outlook.com"}],"readme":"# @aprendizap/aws-lambda-responses\n\nUm pequeno pacote para facilitar a criação de respostas para funções lambda.\nRetorna a saída em string com headers para compatibilidade com CORS.\n\n## Instalação\n\n```bash\nnpm install @aprendizap/aws-lambda-responses\n```\n\n## Uso\n\nImporte o módulo e utilize a função correspondente ao código para gerar a saída da sua função lambda.\n\n```typescript\nimport Responses from '@aprendizap/aws-lambda-responses';\n\nexports.handler = async (event) => {\n  return Responses._200({ message: 'Hello World!' });\n};\n// output: {\n//   headers: {\n//     'Content-Type': 'application/json',\n//     'Access-Control-Allow-Origin': '*',\n//     'Access-Control-Allow-Methods': '*',\n//     'Access-Control-Allow-Credentials': true\n//   },\n//   statusCode: 200,\n//   body: '{\"error\":false,\"message\":\"Hello World!\"}'\n// }\n```\n\nFunciona também como um módulo CommonJS:\n\n```javascript\nconst Responses = require('@aprendizap/aws-lambda-responses');\n\nexport const handler = async (event) => {\n  return Responses._200({ message: 'Hello World!' });\n};\n```\n\nVocê pode passar mensagens de erro para os métodos que implementam o código de status 4xx:\n\n```javascript\nimport Responses from '@aprendizap/aws-lambda-responses';\n\nexport const handler = async (event) => {\n  return Responses._400('My bad!');\n};\n//output: {\n//   headers: {\n//     'Content-Type': 'application/json',\n//     'Access-Control-Allow-Origin': '*',\n//     'Access-Control-Allow-Methods': '*',\n//     'Access-Control-Allow-Credentials': true\n//   },\n//   statusCode: 400,\n//   body: '{\"error\":true,\"message\":\"My bad!\"}'\n// }\n```\n\n## Métodos disponíveis\n\nOs métodos disponíveis e suas respectivas mensagens padrão são:\n\n- \\_200 -> (sem mensagem)\n- \\_303 -> (sem mensagem)\n- \\_400 -> There are missing or invalid parameters.\n- \\_429 -> Too many requests.\n- \\_403 -> Forbidden.\n- \\_404 -> Resource not found.\n- \\_500 -> Internal server error occurred.\n\n### 200\n\nO método aceita 2 tipos de parâmetros:\n\n- Arrays: que serão emitidos na propriedade 'items'\n- Objetos: que serão emitidos diretamente no objeto de resposta\n\nA propriedade error é sempre false.\n\n```javascript\nResponses._200(); // Padrão sem mensagem\nResponses._200({ message: 'Hello World!' }); // Objeto com propriedades\nResponses._200(['Hello', 'World']); // Array\n```\n\n### Erros\n\nOs métodos de erro aceitam strings para substituir a mensagem padrão e dados para serem adicionados ao body final.\n\n```javascript\nResponses._400(); // Padrão sem mensagem\nResponses._400('My bad!'); // Substitui a mensagem padrão 'There are missing or invalid parameters'\nResponses._400('My bad!', { foo: 'bar' }); // Adiciona a propriedade foo ao body\n```\n\nAs outras respostas de erro funcionam da mesma forma.\n","readmeFilename":"README.md"}