All files / src HttpTypes.ts

100% Statements 18/18
100% Branches 5/5
100% Functions 8/8
100% Lines 18/18

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101                                        2x     2x       2x   7x 7x 7x           2x 2x       1x                           1x               1x       1x                           2x 4x   4x 4x 4x       1x                  
/* 
  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  
  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.
*/
 
// APIGatewayProxyResult has all the fields that is needed for a BasicHTTPResponse type.
// re-export as a generic type
import { APIGatewayProxyResult } from "aws-lambda";
 
const jsonContentTypeHeader = {
  "Content-Type": "application/json",
};
const textContentTypeHeader = {
  "Content-Type": "text/plain",
};
 
export class BasicHttpResponse implements APIGatewayProxyResult {
  constructor(
    public statusCode: number,
    public body: string = "",
    public headers?: Record<string, boolean | number | string>
  ) {}
 
  addHeaders(
    headers: Record<string, boolean | number | string>
  ): BasicHttpResponse {
    this.headers = Object.assign(this.headers || {}, headers);
    return this;
  }
 
  static ofError(error: BasicHttpError): BasicHttpResponse {
    return new BasicHttpResponse(
      error.statusCode,
      JSON.stringify({
        error: error.message,
        retryable: error.retryable,
      }),
      jsonContentTypeHeader
    );
  }
 
  static ofRecord(
    statusCode: number,
    data: Record<string, unknown>
  ): BasicHttpResponse {
    return new BasicHttpResponse(
      statusCode,
      JSON.stringify(data),
      jsonContentTypeHeader
    );
  }
 
  static ofString(statusCode: number, message: string): BasicHttpResponse {
    return new BasicHttpResponse(statusCode, message, textContentTypeHeader);
  }
 
  static ofObject<T>(statusCode: number, value: T): BasicHttpResponse {
    return new BasicHttpResponse(
      statusCode,
      JSON.stringify(value),
      jsonContentTypeHeader
    );
  }
}
 
export interface PaginatedResults<T> {
  results: T[];
  nextToken?: string;
}
 
// Basic runtime error
export class BasicHttpError implements Error {
  public name = "BasicHttpError";
  constructor(
    public statusCode: number,
    public message: string = "",
    public retryable: boolean = false
  ) {}
 
  static internalServerError(message: string): BasicHttpError {
    return new BasicHttpError(500, message, false);
  }
}
 
// Paginated results for API
export interface PaginatedResults<T> {
  results: T[];
  nextToken?: string;
}