@digitraffic/common 2023.1.23-1 → 2023.1.23-3

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

@@ -10,7 +10,8 @@ export declare class DigitrafficIntegration {
     readonly lambda: IFunction;
     readonly mediaType: MediaType;
     readonly parameters: ApiParameter[];
-    constructor(lambda: IFunction, mediaType?: MediaType);
+    readonly sunset?: string;
+    constructor(lambda: IFunction, mediaType?: MediaType, sunset?: string);
     addPathParameter(...names: string[]): this;
     addQueryParameter(...names: string[]): this;
     build(): LambdaIntegration;

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

@@ -5,10 +5,11 @@ const aws_apigateway_1 = require("aws-cdk-lib/aws-apigateway");
 const mediatypes_1 = require("../../types/mediatypes");
 const digitraffic_integration_response_1 = require("../../runtime/digitraffic-integration-response");
 class DigitrafficIntegration {
-    constructor(lambda, mediaType = mediatypes_1.MediaType.TEXT_PLAIN) {
+    constructor(lambda, mediaType = mediatypes_1.MediaType.TEXT_PLAIN, sunset) {
         this.parameters = [];
         this.lambda = lambda;
         this.mediaType = mediaType;
+        this.sunset = sunset;
     }
     addPathParameter(...names) {
         names.forEach((name) => this.parameters.push({ type: "path", name }));
@@ -49,7 +50,7 @@ class DigitrafficIntegration {
         };
     }
     createResponses() {
-        return [digitraffic_integration_response_1.DigitrafficIntegrationResponse.ok(this.mediaType)];
+        return [digitraffic_integration_response_1.DigitrafficIntegrationResponse.ok(this.mediaType, this.sunset)];
     }
 }
 exports.DigitrafficIntegration = DigitrafficIntegration;

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

@@ -12,6 +12,15 @@ 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;
     modelName: string;
@@ -24,7 +33,7 @@ export declare const XmlResponseTemplate: Record<string, string>;
 export declare const InternalServerErrorResponseTemplate: Record<string, string>;
 export declare function createResponses<T>(key: MediaType, value: T): Record<string, T>;
 export declare class DigitrafficMethodResponse {
-    static response(statusCode: string, model: IModel, mediaType: MediaType, disableCors?: boolean): MethodResponse;
+    static response(statusCode: string, model: IModel, mediaType: MediaType, disableCors?: boolean, deprecation?: boolean): MethodResponse;
     static response200(model: IModel, mediaType?: MediaType): MethodResponse;
     static response500(model?: IModel, mediaType?: MediaType): MethodResponse;
     static response400(model?: IModel, mediaType?: MediaType): MethodResponse;

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

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DigitrafficMethodResponse = exports.createResponses = exports.InternalServerErrorResponseTemplate = exports.XmlResponseTemplate = exports.NotFoundResponseTemplate = exports.BadRequestResponseTemplate = exports.NotFoundResponse = exports.MessageModel = exports.RESPONSE_DEFAULT_LAMBDA = void 0;
+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,6 +26,20 @@ $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 = '${(0, date_utils_1.dateFromIsoString)(sunset).toUTCString()}')`;
+    return exports.RESPONSE_DEFAULT_LAMBDA.concat(setDeprecationHeaders);
+};
+exports.getDeprecatedDefaultLambdaResponse = getDeprecatedDefaultLambdaResponse;
 const BODY_FROM_INPUT_PATH = "$input.path('$').body";
 /// @deprecated
 const messageSchema = {
@@ -68,17 +83,17 @@ function createResponses(key, value) {
 }
 exports.createResponses = createResponses;
 class DigitrafficMethodResponse {
-    static response(statusCode, model, mediaType, disableCors = false) {
+    static response(statusCode, model, mediaType, disableCors = false, deprecation = false) {
         return {
             statusCode,
             responseModels: {
                 [mediaType]: model,
             },
-            responseParameters: disableCors
-                ? {}
-                : {
-                    "method.response.header.Access-Control-Allow-Origin": true,
-                },
+            responseParameters: {
+                "method.response.header.Access-Control-Allow-Origin": !disableCors,
+                "method.response.header.Deprecation": deprecation,
+                "method.response.header.Sunset": deprecation,
+            },
         };
     }
     static response200(model, mediaType = mediatypes_1.MediaType.APPLICATION_JSON) {

package/dist/aws/runtime/digitraffic-integration-response.d.ts

@@ -1,8 +1,8 @@
 import { IntegrationResponse } from "aws-cdk-lib/aws-apigateway";
 import { MediaType } from "../types/mediatypes";
 export declare abstract class DigitrafficIntegrationResponse {
-    static ok(mediaType: MediaType): IntegrationResponse;
+    static ok(mediaType: MediaType, sunset?: string): IntegrationResponse;
     static badRequest(mediaType?: MediaType): IntegrationResponse;
     static notImplemented(mediaType?: MediaType): IntegrationResponse;
-    static create(statusCode: string, mediaType: MediaType): IntegrationResponse;
+    static create(statusCode: string, mediaType: MediaType, sunset?: string): IntegrationResponse;
 }

package/dist/aws/runtime/digitraffic-integration-response.js

@@ -4,8 +4,8 @@ exports.DigitrafficIntegrationResponse = void 0;
 const mediatypes_1 = require("../types/mediatypes");
 const response_1 = require("../infra/api/response");
 class DigitrafficIntegrationResponse {
-    static ok(mediaType) {
-        return this.create("200", mediaType);
+    static ok(mediaType, sunset) {
+        return this.create("200", mediaType, sunset);
     }
     static badRequest(mediaType) {
         return this.create("400", mediaType ?? mediatypes_1.MediaType.TEXT_PLAIN);
@@ -13,11 +13,13 @@ class DigitrafficIntegrationResponse {
     static notImplemented(mediaType) {
         return this.create("501", mediaType ?? mediatypes_1.MediaType.TEXT_PLAIN);
     }
-    static create(statusCode, mediaType) {
+    static create(statusCode, mediaType, sunset) {
         return {
             statusCode,
             responseTemplates: {
-                [mediaType]: response_1.RESPONSE_DEFAULT_LAMBDA,
+                [mediaType]: sunset
+                    ? (0, response_1.getDeprecatedDefaultLambdaResponse)(sunset)
+                    : response_1.RESPONSE_DEFAULT_LAMBDA,
             },
         };
     }

package/package.json

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

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

@@ -17,12 +17,17 @@ interface ApiParameter {
 export class DigitrafficIntegration {
     readonly lambda: IFunction;
     readonly mediaType: MediaType;
-
     readonly parameters: ApiParameter[] = [];
+    readonly sunset?: string;
 
-    constructor(lambda: IFunction, mediaType = MediaType.TEXT_PLAIN) {
+    constructor(
+        lambda: IFunction,
+        mediaType = MediaType.TEXT_PLAIN,
+        sunset?: string
+    ) {
         this.lambda = lambda;
         this.mediaType = mediaType;
+        this.sunset = sunset;
     }
 
     addPathParameter(...names: string[]): this {
@@ -84,6 +89,6 @@ export class DigitrafficIntegration {
     }
 
     createResponses(): IntegrationResponse[] {
-        return [DigitrafficIntegrationResponse.ok(this.mediaType)];
+        return [DigitrafficIntegrationResponse.ok(this.mediaType, this.sunset)];
     }
 }

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

@@ -1,12 +1,7 @@
-import { MediaType } from "../../types/mediatypes";
-import {
-    JsonSchemaType,
-    JsonSchemaVersion,
-    JsonSchema,
-    MethodResponse,
-    Model,
-} from "aws-cdk-lib/aws-apigateway";
-import { IModel } from "aws-cdk-lib/aws-apigateway/lib/model";
+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).
@@ -31,6 +26,21 @@ $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 = '${dateFromIsoString(sunset).toUTCString()}')`;
+    return RESPONSE_DEFAULT_LAMBDA.concat(setDeprecationHeaders);
+};
+
 const BODY_FROM_INPUT_PATH = "$input.path('$').body";
 
 /// @deprecated
@@ -100,19 +110,19 @@ export class DigitrafficMethodResponse {
         statusCode: string,
         model: IModel,
         mediaType: MediaType,
-        disableCors = false
+        disableCors = false,
+        deprecation = false
     ): MethodResponse {
         return {
             statusCode,
             responseModels: {
                 [mediaType]: model,
             },
-            responseParameters: disableCors
-                ? {}
-                : {
-                      "method.response.header.Access-Control-Allow-Origin":
-                          true,
-                  },
+            responseParameters: {
+                "method.response.header.Access-Control-Allow-Origin": !disableCors,
+                "method.response.header.Deprecation": deprecation,
+                "method.response.header.Sunset": deprecation,
+            },
         };
     }
 

package/src/aws/runtime/digitraffic-integration-response.ts

@@ -1,11 +1,13 @@
-import {IntegrationResponse} from "aws-cdk-lib/aws-apigateway";
-import {MediaType} from "../types/mediatypes";
-import {RESPONSE_DEFAULT_LAMBDA} from "../infra/api/response";
+import { IntegrationResponse } from "aws-cdk-lib/aws-apigateway";
+import { MediaType } from "../types/mediatypes";
+import {
+    getDeprecatedDefaultLambdaResponse,
+    RESPONSE_DEFAULT_LAMBDA,
+} from "../infra/api/response";
 
 export abstract class DigitrafficIntegrationResponse {
-
-    static ok(mediaType: MediaType): IntegrationResponse {
-        return this.create("200", mediaType);
+    static ok(mediaType: MediaType, sunset?: string): IntegrationResponse {
+        return this.create("200", mediaType, sunset);
     }
 
     static badRequest(mediaType?: MediaType): IntegrationResponse {
@@ -16,13 +18,18 @@ export abstract class DigitrafficIntegrationResponse {
         return this.create("501", mediaType ?? MediaType.TEXT_PLAIN);
     }
 
-    static create(statusCode: string, mediaType: MediaType): IntegrationResponse {
+    static create(
+        statusCode: string,
+        mediaType: MediaType,
+        sunset?: string
+    ): IntegrationResponse {
         return {
             statusCode,
             responseTemplates: {
-                [mediaType]: RESPONSE_DEFAULT_LAMBDA,
+                [mediaType]: sunset
+                    ? getDeprecatedDefaultLambdaResponse(sunset)
+                    : RESPONSE_DEFAULT_LAMBDA,
             },
         };
     }
 }
-