@digitraffic/common 2023.1.23-2 → 2023.1.26-1

package/dist/aws/infra/api/response.d.ts

@@ -12,6 +12,14 @@ import { IModel } from "aws-cdk-lib/aws-apigateway/lib/model";
  * If fileName is set, then Content-Disposition-header will be set to use it
  */
 export declare const RESPONSE_DEFAULT_LAMBDA = "#set($inputRoot = $input.path('$'))\n$util.base64Decode($inputRoot.body)\n#if ($inputRoot.status != 200)\n#set ($context.responseOverride.status = $inputRoot.status)\n#set ($context.responseOverride.header.Content-Type = 'text/plain')\n#end\n#set ($context.responseOverride.header.Access-Control-Allow-Origin = '*')\n#if (\"$!inputRoot.fileName\" != \"\")\n#set ($disposition = 'attachment; filename=\"FN\"')\n#set ($context.responseOverride.header.Content-Disposition = $disposition.replaceAll('FN', $inputRoot.fileName))\n#end\n";
+/**
+ * Use this for deprecated integrations.
+ * Will add HTTP headers Deprecation and Sunset to response.
+ * Example:
+ *  Deprecation: true
+ *  Sunset: Tue, 20 Dec 2022 00:00:00 GMT
+ * @param sunset Sunset date as string in ISO 8601 date-time format (YYYY-MM-DD)
+ */
 export declare const getDeprecatedDefaultLambdaResponse: (sunset: string) => string;
 export declare const MessageModel: {
     contentType: MediaType;

package/dist/aws/infra/api/response.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DigitrafficMethodResponse = exports.createResponses = exports.InternalServerErrorResponseTemplate = exports.XmlResponseTemplate = exports.NotFoundResponseTemplate = exports.BadRequestResponseTemplate = exports.NotFoundResponse = exports.MessageModel = exports.getDeprecatedDefaultLambdaResponse = exports.RESPONSE_DEFAULT_LAMBDA = void 0;
 const mediatypes_1 = require("../../types/mediatypes");
 const aws_apigateway_1 = require("aws-cdk-lib/aws-apigateway");
+const date_utils_1 = require("../../../utils/date-utils");
 /**
  * This is velocity-script, that assumes the response to be LambdaResponse(status and body).
  * It will always return the body and status, but if status in something else than 200 OK the content-type
@@ -25,9 +26,17 @@ $util.base64Decode($inputRoot.body)
 #set ($context.responseOverride.header.Content-Disposition = $disposition.replaceAll('FN', $inputRoot.fileName))
 #end
 `;
+/**
+ * Use this for deprecated integrations.
+ * Will add HTTP headers Deprecation and Sunset to response.
+ * Example:
+ *  Deprecation: true
+ *  Sunset: Tue, 20 Dec 2022 00:00:00 GMT
+ * @param sunset Sunset date as string in ISO 8601 date-time format (YYYY-MM-DD)
+ */
 const getDeprecatedDefaultLambdaResponse = (sunset) => {
     const setDeprecationHeaders = `#set ($context.responseOverride.header.Deprecation = 'true')
-#set ($context.responseOverride.header.Sunset = '${sunset}')`;
+#set ($context.responseOverride.header.Sunset = '${(0, date_utils_1.dateFromIsoString)(sunset).toUTCString()}')`;
     return exports.RESPONSE_DEFAULT_LAMBDA.concat(setDeprecationHeaders);
 };
 exports.getDeprecatedDefaultLambdaResponse = getDeprecatedDefaultLambdaResponse;
@@ -81,9 +90,13 @@ class DigitrafficMethodResponse {
                 [mediaType]: model,
             },
             responseParameters: {
-                "method.response.header.Access-Control-Allow-Origin": !disableCors,
-                "method.response.header.Deprecation": deprecation,
-                "method.response.header.Sunset": deprecation,
+                ...(!disableCors && {
+                    "method.response.header.Access-Control-Allow-Origin": true,
+                }),
+                ...(deprecation && {
+                    "method.response.header.Deprecation": true,
+                    "method.response.header.Sunset": true,
+                }),
             },
         };
     }

package/dist/aws/infra/canaries/url-checker.d.ts

@@ -34,7 +34,7 @@ export declare class ContentChecker {
     static checkResponse(fn: (body: string, res: IncomingMessage) => void): CheckerFunction;
 }
 export declare class ContentTypeChecker {
-    static checkContentType(contentType: MediaType): (res: IncomingMessage) => void;
+    static checkContentType(contentType: MediaType): CheckerFunction;
 }
 export declare class GeoJsonChecker {
     static validFeatureCollection(fn?: (json: FeatureCollection) => void): CheckerFunction;

package/dist/aws/infra/canaries/url-checker.js

@@ -233,6 +233,7 @@ class ContentTypeChecker {
                 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 `Wrong content-type ${res.headers["content-type"]}`);
             }
+            return Promise.resolve();
         };
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitraffic/common",
-  "version": "2023.01.23-2",
+  "version": "2023.01.26-1",
   "description": "",
   "repository": {
     "type": "git",

package/src/aws/infra/api/response.ts

@@ -1,6 +1,7 @@
 import {MediaType} from "../../types/mediatypes";
 import {JsonSchema, JsonSchemaType, JsonSchemaVersion, MethodResponse, Model,} from "aws-cdk-lib/aws-apigateway";
 import {IModel} from "aws-cdk-lib/aws-apigateway/lib/model";
+import {dateFromIsoString} from "../../../utils/date-utils";
 
 /**
  * This is velocity-script, that assumes the response to be LambdaResponse(status and body).
@@ -25,9 +26,18 @@ $util.base64Decode($inputRoot.body)
 #end
 `;
 
+/**
+ * Use this for deprecated integrations.
+ * Will add HTTP headers Deprecation and Sunset to response.
+ * Example:
+ *  Deprecation: true
+ *  Sunset: Tue, 20 Dec 2022 00:00:00 GMT
+ * @param sunset Sunset date as string in ISO 8601 date-time format (YYYY-MM-DD)
+ */
+
 export const getDeprecatedDefaultLambdaResponse = (sunset: string) => {
     const setDeprecationHeaders = `#set ($context.responseOverride.header.Deprecation = 'true')
-#set ($context.responseOverride.header.Sunset = '${sunset}')`;
+#set ($context.responseOverride.header.Sunset = '${dateFromIsoString(sunset).toUTCString()}')`;
     return RESPONSE_DEFAULT_LAMBDA.concat(setDeprecationHeaders);
 };
 
@@ -109,9 +119,13 @@ export class DigitrafficMethodResponse {
                 [mediaType]: model,
             },
             responseParameters: {
-                "method.response.header.Access-Control-Allow-Origin": !disableCors,
-                "method.response.header.Deprecation": deprecation,
-                "method.response.header.Sunset": deprecation,
+                ...(!disableCors && {
+                    "method.response.header.Access-Control-Allow-Origin": true,
+                }),
+                ...(deprecation && {
+                    "method.response.header.Deprecation": true,
+                    "method.response.header.Sunset": true,
+                }),
             },
         };
     }

package/src/aws/infra/canaries/url-checker.ts

@@ -318,7 +318,7 @@ export class ContentChecker {
 }
 
 export class ContentTypeChecker {
-    static checkContentType(contentType: MediaType) {
+    static checkContentType(contentType: MediaType): CheckerFunction {
         return (res: IncomingMessage) => {
             if (!res.statusCode) {
                 throw new Error("statusCode missing");
@@ -339,6 +339,8 @@ export class ContentTypeChecker {
                     `Wrong content-type ${res.headers["content-type"]!}`
                 );
             }
+
+            return Promise.resolve();
         };
     }
 }